Class WebPageSelectorComponent

Namespace

Kentico.Xperience.Admin.Websites

Assembly

Kentico.Xperience.Admin.Websites.dll

Represents webPage selector form component.

[ComponentAttribute(typeof(WebPageSelectorComponentAttribute))]
public sealed class WebPageSelectorComponent : FormComponent<WebPageSelectorProperties, WebPageSelectorClientProperties, IEnumerable<WebPageRelatedItem>>, IFormComponent, IFormItem<IFormComponentClientProperties>, IFormItem

Inheritance

object

FormComponent<WebPageSelectorProperties, WebPageSelectorClientProperties, IEnumerable<WebPageRelatedItem>>

WebPageSelectorComponent

Implements

IFormComponent

IFormItem<IFormComponentClientProperties>

IFormItem

Inherited Members

FormComponent<WebPageSelectorProperties, WebPageSelectorClientProperties, IEnumerable<WebPageRelatedItem>>.ClientComponentName

FormComponent<WebPageSelectorProperties, WebPageSelectorClientProperties, IEnumerable<WebPageRelatedItem>>.Properties

FormComponent<WebPageSelectorProperties, WebPageSelectorClientProperties, IEnumerable<WebPageRelatedItem>>.FormContext

FormComponent<WebPageSelectorProperties, WebPageSelectorClientProperties, IEnumerable<WebPageRelatedItem>>.Name

FormComponent<WebPageSelectorProperties, WebPageSelectorClientProperties, IEnumerable<WebPageRelatedItem>>.Guid

FormComponent<WebPageSelectorProperties, WebPageSelectorClientProperties, IEnumerable<WebPageRelatedItem>>.Required

FormComponent<WebPageSelectorProperties, WebPageSelectorClientProperties, IEnumerable<WebPageRelatedItem>>.HasDependencies

FormComponent<WebPageSelectorProperties, WebPageSelectorClientProperties, IEnumerable<WebPageRelatedItem>>.ValidationRules

FormComponent<WebPageSelectorProperties, WebPageSelectorClientProperties, IEnumerable<WebPageRelatedItem>>.VisibilityConditions

FormComponent<WebPageSelectorProperties, WebPageSelectorClientProperties, IEnumerable<WebPageRelatedItem>>.AdditionalActions

FormComponent<WebPageSelectorProperties, WebPageSelectorClientProperties, IEnumerable<WebPageRelatedItem>>.AddValidationRule(IValidationRule)

FormComponent<WebPageSelectorProperties, WebPageSelectorClientProperties, IEnumerable<WebPageRelatedItem>>.AddAdditionalAction(IAdditionalAction)

FormComponent<WebPageSelectorProperties, WebPageSelectorClientProperties, IEnumerable<WebPageRelatedItem>>.AddVisibilityCondition(IVisibilityCondition)

FormComponent<WebPageSelectorProperties, WebPageSelectorClientProperties, IEnumerable<WebPageRelatedItem>>.GetValue()

FormComponent<WebPageSelectorProperties, WebPageSelectorClientProperties, IEnumerable<WebPageRelatedItem>>.SetValue(IEnumerable<WebPageRelatedItem>)

FormComponent<WebPageSelectorProperties, WebPageSelectorClientProperties, IEnumerable<WebPageRelatedItem>>.GetClientProperties()

FormComponent<WebPageSelectorProperties, WebPageSelectorClientProperties, IEnumerable<WebPageRelatedItem>>.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

WebPageSelectorComponent(ILocalizationService, IWebPagePanelItemModifierActivator, IContentLanguageRetriever, IEventLogService, IInfoProvider<ChannelInfo>, IInfoProvider<WebsiteChannelInfo>)

Initializes a new instance of WebPageSelectorComponent.

public WebPageSelectorComponent(ILocalizationService localizationService, IWebPagePanelItemModifierActivator webPagePanelItemModifierActivator, IContentLanguageRetriever contentLanguageRetriever, IEventLogService eventLogService, IInfoProvider<ChannelInfo> channelInfoProvider, IInfoProvider<WebsiteChannelInfo> websiteChannelInfoProvider)

Parameters

localizationService ILocalizationService

webPagePanelItemModifierActivator IWebPagePanelItemModifierActivator

contentLanguageRetriever IContentLanguageRetriever

eventLogService IEventLogService

channelInfoProvider IInfoProvider<ChannelInfo>

websiteChannelInfoProvider IInfoProvider<WebsiteChannelInfo>

Fields

IDENTIFIER

Represents the WebPageSelectorComponent identifier.

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

Field Value

string

Properties

ClientComponentName

Represents the client component name.

public override string ClientComponentName { get; }

Property Value

string

Methods

ConfigureClientProperties(WebPageSelectorClientProperties)

Configures the form component client properties.

protected override Task ConfigureClientProperties(WebPageSelectorClientProperties clientProperties)

Parameters

clientProperties WebPageSelectorClientProperties

The current instance of the form component client properties.

Returns

Task

Remarks

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

ConfigureComponent()

Configures the form component. This method is called when all form component properties are set.

protected override void ConfigureComponent()

Remarks

Override this method to set component inner state, like additional component validation rules.

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)

Loads child nodes for parent node.

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

Parameters

args LoadTreeDataCommandArguments

Load tree data arguments.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task<ICommandResponse<LoadTreeDataResult>>

LoadSelectedWebPages(LoadSelectedWebPagesCommandArguments, CancellationToken)

Returns selected webPages for given webPage identifiers.

public Task<ICommandResponse<LoadSelectedWebPagesResult>> LoadSelectedWebPages(LoadSelectedWebPagesCommandArguments args, CancellationToken cancellationToken = default)

Parameters

args LoadSelectedWebPagesCommandArguments

Identifiers model of selected webPages.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse<LoadSelectedWebPagesResult>>

LoadWebPagePanelItems(LoadWebPagePanelItemsCommandArguments, CancellationToken)

Returns webPage panel items for a given node.

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

Parameters

args LoadWebPagePanelItemsCommandArguments

Level parameters.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse<LoadWebPagePanelItemsResult>>

LoadWebPagePanelTree(LoadTreeDataCommandArguments, CancellationToken)

Returns child webPages for a given node.

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

Parameters

args LoadTreeDataCommandArguments

Subtree parameters.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse<LoadTreeDataResult>>

LoadWebsiteChannelOptions(CancellationToken)

Returns web page panel website channel options.

public Task<ICommandResponse<LoadWebsiteChannelOptionsResult>> LoadWebsiteChannelOptions(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse<LoadWebsiteChannelOptionsResult>>