Class UrlSelectorComponent

Namespace

Kentico.Xperience.Admin.Websites.Forms

Assembly

Kentico.Xperience.Admin.Websites.dll

Represents URL selector form component.

[ComponentAttribute(typeof(UrlSelectorComponentAttribute))]
public sealed class UrlSelectorComponent : FormComponent<FormComponentProperties, UrlSelectorClientProperties, string>, IFormComponent, IFormItem<IFormComponentClientProperties>, IFormItem

Inheritance

object

FormComponent<FormComponentProperties, UrlSelectorClientProperties, string>

UrlSelectorComponent

Implements

IFormComponent

IFormItem<IFormComponentClientProperties>

IFormItem

Inherited Members

FormComponent<FormComponentProperties, UrlSelectorClientProperties, string>.ClientComponentName

FormComponent<FormComponentProperties, UrlSelectorClientProperties, string>.Properties

FormComponent<FormComponentProperties, UrlSelectorClientProperties, string>.FormContext

FormComponent<FormComponentProperties, UrlSelectorClientProperties, string>.Name

FormComponent<FormComponentProperties, UrlSelectorClientProperties, string>.Guid

FormComponent<FormComponentProperties, UrlSelectorClientProperties, string>.Required

FormComponent<FormComponentProperties, UrlSelectorClientProperties, string>.HasDependencies

FormComponent<FormComponentProperties, UrlSelectorClientProperties, string>.ValidationRules

FormComponent<FormComponentProperties, UrlSelectorClientProperties, string>.VisibilityConditions

FormComponent<FormComponentProperties, UrlSelectorClientProperties, string>.AdditionalActions

FormComponent<FormComponentProperties, UrlSelectorClientProperties, string>.AddValidationRule(IValidationRule)

FormComponent<FormComponentProperties, UrlSelectorClientProperties, string>.AddAdditionalAction(IAdditionalAction)

FormComponent<FormComponentProperties, UrlSelectorClientProperties, string>.AddVisibilityCondition(IVisibilityCondition)

FormComponent<FormComponentProperties, UrlSelectorClientProperties, string>.GetValue()

FormComponent<FormComponentProperties, UrlSelectorClientProperties, string>.SetValue(string)

FormComponent<FormComponentProperties, UrlSelectorClientProperties, string>.GetClientProperties()

FormComponent<FormComponentProperties, UrlSelectorClientProperties, string>.BindContext(IFormContext)

Extension Methods

FormItemExtensions.IsValid(IFormItem)

FormItemExtensions.IsVisible(IFormItem)

DataExtensions.With<T>(T, Action<T>)

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Constructors

UrlSelectorComponent(ILocalizationService)

Initializes a new instance of UrlSelectorComponent.

public UrlSelectorComponent(ILocalizationService localizationService)

Parameters

localizationService ILocalizationService

Localization service.

Fields

IDENTIFIER

Represents the UrlSelectorComponent identifier.

public const string IDENTIFIER = "Kentico.Administration.UrlSelector"

Field Value

string

Properties

ClientComponentName

Represents the client component name.

public override string ClientComponentName { get; }

Property Value

string

Methods

ConfigureClientProperties(UrlSelectorClientProperties)

Configures the form component client properties.

protected override Task ConfigureClientProperties(UrlSelectorClientProperties clientProperties)

Parameters

clientProperties UrlSelectorClientProperties

The current instance of the form component client properties.

Returns

Task

Remarks

Override this method in order to configure form component client properties.

LoadFilteredTree(LoadFilteredTreeDataCommandArguments, CancellationToken)

Loads filtered tree for component.

public Task<ICommandResponse<LoadTreeDataResult>> LoadFilteredTree(LoadFilteredTreeDataCommandArguments args, CancellationToken cancellationToken = default)

Parameters

args LoadFilteredTreeDataCommandArguments

Load filtered tree data arguments.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task<ICommandResponse<LoadTreeDataResult>>

LoadLevelWebPagePanelTree(LoadTreeDataCommandArguments, CancellationToken)

Returns child nodes for a given node.

public Task<ICommandResponse<LoadTreeDataResult>> LoadLevelWebPagePanelTree(LoadTreeDataCommandArguments args, CancellationToken cancellationToken = default)

Parameters

args LoadTreeDataCommandArguments

Subtree parameters.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse<LoadTreeDataResult>>

LoadWebPageLinks(LoadWebPageLinkItemsCommandArguments, CancellationToken)

Returns page links for given identifiers.

public Task<ICommandResponse<LoadWebPageLinkItemsResult>> LoadWebPageLinks(LoadWebPageLinkItemsCommandArguments args, CancellationToken cancellationToken)

Parameters

args LoadWebPageLinkItemsCommandArguments

Links parameters.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse<LoadWebPageLinkItemsResult>>

LoadWebPagePanelItems(LoadWebPagePanelItemsCommandArguments, CancellationToken)

Returns page panel items for a given node.

public Task<ICommandResponse<LoadWebPagePanelItemsResult>> LoadWebPagePanelItems(LoadWebPagePanelItemsCommandArguments args, CancellationToken cancellationToken)

Parameters

args LoadWebPagePanelItemsCommandArguments

Level parameters.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse<LoadWebPagePanelItemsResult>>

LoadWebPagePanelTree(LoadTreeDataCommandArguments, CancellationToken)

Returns child pages for a given node.

public Task<ICommandResponse<LoadTreeDataResult>> LoadWebPagePanelTree(LoadTreeDataCommandArguments args, CancellationToken cancellationToken)

Parameters

args LoadTreeDataCommandArguments

Subtree parameters.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse<LoadTreeDataResult>>