Class FormList

Namespace

Kentico.Xperience.Admin.DigitalMarketing.UIPages

Assembly

Kentico.Xperience.Admin.DigitalMarketing.dll

Forms listing page.

public sealed class FormList : ListingPage, IPage

Inheritance

object

Page<ListingTemplateClientProperties>

ListingPageBase<InfoObjectListingConfiguration, ListingTemplateClientProperties>

ListingPage<ListingTemplateClientProperties>

ListingPage

FormList

Implements

IPage

Inherited Members

ListingPage<ListingTemplateClientProperties>.PageConfiguration

ListingPageBase<InfoObjectListingConfiguration, ListingTemplateClientProperties>.LoadData(LoadDataCommandArguments, CancellationToken)

ListingPageBase<InfoObjectListingConfiguration, ListingTemplateClientProperties>.ComponentCommand(FormComponentCommandModel, CancellationToken)

ListingPageBase<InfoObjectListingConfiguration, ListingTemplateClientProperties>.ConfigureTemplateProperties(ListingTemplateClientProperties)

ListingPageBase<InfoObjectListingConfiguration, ListingTemplateClientProperties>.Change(FormSubmissionCommandArguments, CancellationToken)

ListingPageBase<InfoObjectListingConfiguration, ListingTemplateClientProperties>.PageConfiguration

Page<ListingTemplateClientProperties>.ValidatePage()

Page<ListingTemplateClientProperties>.ConfigureTemplateProperties(ListingTemplateClientProperties)

Extension Methods

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

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Constructors

FormList(IPageLinkGenerator, IOptions<ContentSynchronizationOptions>, IUIPermissionEvaluator, IAuthenticatedUserAccessor)

Initializes an instance of the FormList class.

public FormList(IPageLinkGenerator pageLinkGenerator, IOptions<ContentSynchronizationOptions> synchronizationOptions, IUIPermissionEvaluator permissionEvaluator, IAuthenticatedUserAccessor userAccessor)

Parameters

pageLinkGenerator IPageLinkGenerator

synchronizationOptions IOptions<ContentSynchronizationOptions>

permissionEvaluator IUIPermissionEvaluator

userAccessor IAuthenticatedUserAccessor

Properties

ObjectType

Type of the info objects that are listed. Corresponds to the OBJECT_TYPE property of the info object or PredefinedObjectType.

protected override string ObjectType { get; }

Property Value

string

Methods

ChangePublishForm(FormSubmissionCommandArguments, CancellationToken)

Routes the command to the Kentico.Xperience.Admin.Base.ISynchronizationCommandManager.GetOrChangeFormItemsForContentSynchronizationConfiguration(Kentico.Xperience.Admin.Base.FormSubmissionCommandArguments, Kentico.Xperience.Admin.Base.ContentSynchronizationTypeEnum, Kentico.Membership.AdminApplicationUser, System.Threading.CancellationToken) method.

[PageCommand(Permission = "Synchronize")]
public Task<ICommandResponse> ChangePublishForm(FormSubmissionCommandArguments args, CancellationToken cancellationToken)

Parameters

args FormSubmissionCommandArguments

cancellationToken CancellationToken

Returns

Task<ICommandResponse>

ConfigurePage()

Allows configure and share page specific values prior invocation of the ConfigureTemplateProperties(TClientProperties) or command method.

public override Task ConfigurePage()

Returns

Task

Create()

Creates a new form and redirects to form builder page.

[PageCommand(Permission = "Create")]
public Task<ICommandResponse> Create()

Returns

Task<ICommandResponse>

CreateContentSynchronization(ContentSynchronizationCreateArguments, CancellationToken)

Creates a content synchronization for the specified forms.

[PageCommand(Permission = "Synchronize")]
public Task<ICommandResponse> CreateContentSynchronization(ContentSynchronizationCreateArguments args, CancellationToken cancellationToken)

Parameters

args ContentSynchronizationCreateArguments

Content synchronization create arguments.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse>

Delete(int)

Deletes listing item specified by the id parameter.

[PageCommand(Permission = "Delete")]
public override Task<ICommandResponse<RowActionResult>> Delete(int id)

Parameters

id int

Returns

Task<ICommandResponse<RowActionResult>>

GetContentSynchronizationProgress(ContentSynchronizationGetProgressArguments, CancellationToken)

Routes the command to the GetContentSynchronizationProgress(ContentSynchronizationGetProgressArguments, CancellationToken) method.

[PageCommand(Permission = "Synchronize")]
public Task<ICommandResponse> GetContentSynchronizationProgress(ContentSynchronizationGetProgressArguments args, CancellationToken cancellationToken)

Parameters

args ContentSynchronizationGetProgressArguments

cancellationToken CancellationToken

Returns

Task<ICommandResponse>

GetPublishForm(CancellationToken)

Routes the command to the Kentico.Xperience.Admin.Base.ISynchronizationCommandManager.GetOrChangeFormItemsForContentSynchronizationConfiguration(Kentico.Xperience.Admin.Base.FormSubmissionCommandArguments, Kentico.Xperience.Admin.Base.ContentSynchronizationTypeEnum, Kentico.Membership.AdminApplicationUser, System.Threading.CancellationToken) method.

[PageCommand(Permission = "Synchronize")]
public Task<ICommandResponse> GetPublishForm(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

Returns

Task<ICommandResponse>

LoadSynchronizationContentItems(LoadSynchronizationTableItemsCommandArguments, CancellationToken)

Returns rows of content items for content synchronization.

[PageCommand(Permission = "Synchronize")]
public Task<ICommandResponse<LoadDataResult>> LoadSynchronizationContentItems(LoadSynchronizationTableItemsCommandArguments args, CancellationToken cancellationToken)

Parameters

args LoadSynchronizationTableItemsCommandArguments

Load data command arguments.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse<LoadDataResult>>