Class FormSubmissionsTab

Namespace

Kentico.Xperience.Admin.DigitalMarketing.UIPages

Assembly

Kentico.Xperience.Admin.DigitalMarketing.dll

Represents "Submissions" tab in forms application.

public sealed class FormSubmissionsTab : ListingPage, IPage

Inheritance

object

Page<ListingTemplateClientProperties>

ListingPageBase<InfoObjectListingConfiguration, ListingTemplateClientProperties>

ListingPage<ListingTemplateClientProperties>

ListingPage

FormSubmissionsTab

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()

Extension Methods

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

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Constructors

FormSubmissionsTab(IFormSubmissionsExportService, IUIPermissionEvaluator)

Initializes a new instance of the FormSubmissionsTab class.

public FormSubmissionsTab(IFormSubmissionsExportService formSubmissionsExportService, IUIPermissionEvaluator uiPermissionEvaluator)

Parameters

formSubmissionsExportService IFormSubmissionsExportService

Service providing the export of the listed submissions.

uiPermissionEvaluator IUIPermissionEvaluator

Evaluator of the UI permissions of the current user.

Properties

FormId

ID of the selected form.

[PageParameter(typeof(IntPageModelBinder), typeof(FormEditSection))]
public int FormId { get; set; }

Property Value

int

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

ConfigurePage()

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

public override Task ConfigurePage()

Returns

Task

ConfigureTemplateProperties(ListingTemplateClientProperties)

Gets the object representing client side template properties.

public override Task<ListingTemplateClientProperties> ConfigureTemplateProperties(ListingTemplateClientProperties properties)

Parameters

properties ListingTemplateClientProperties

Initialized properties object.

Returns

Task<ListingTemplateClientProperties>

Delete(int)

Deletes listing item specified by the id parameter.

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

Parameters

id int

Returns

Task<ICommandResponse<RowActionResult>>

ExportListingData(ListingExportCommandArguments, CancellationToken)

Exports the listed form submissions corresponding to the current listing state described by the args (filter, search term, sorting) into a file downloaded by the client.

[PageCommand(Permission = "Export")]
public Task<ICommandResponse<ListingExportResult>> ExportListingData(ListingExportCommandArguments args, CancellationToken cancellationToken)

Parameters

args ListingExportCommandArguments

Export command arguments provided by the client.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse<ListingExportResult>>

Remarks

This API supports the framework infrastructure and is not intended to be used directly from your code.