Class ConsentTextEdit

Namespace

Kentico.Xperience.Admin.DigitalMarketing.UIPages

Assembly

Kentico.Xperience.Admin.DigitalMarketing.dll

Texts tab of the consent's edit page.

public sealed class ConsentTextEdit : InfoEditPage<ConsentInfo>, IPage

Inheritance

object

Page<EditTemplateClientProperties>

EditPageBase

InfoEditPageBase<ConsentInfo>

InfoEditPage<ConsentInfo>

ConsentTextEdit

Implements

IPage

Inherited Members

InfoEditPageBase<ConsentInfo>.ConfigureTemplateProperties(EditTemplateClientProperties)

InfoEditPageBase<ConsentInfo>.ValidatePage()

InfoEditPageBase<ConsentInfo>.RegisterMacroField(MacroField)

EditPageBase.PageConfiguration

EditPageBase.ComponentCommand(FormComponentCommandModel, CancellationToken)

EditPageBase.Change(FormChangeCommandArguments)

EditPageBase.Submit(FormSubmissionCommandArguments)

Extension Methods

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

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Constructors

ConsentTextEdit(IFormComponentMapper, IFormDataBinder, IContentLanguageModelRetriever)

Initializes a new instance of the ConsentTextEdit class.

public ConsentTextEdit(IFormComponentMapper formComponentMapper, IFormDataBinder formDataBinder, IContentLanguageModelRetriever contentLanguageModelRetriever)

Parameters

formComponentMapper IFormComponentMapper

formDataBinder IFormDataBinder

contentLanguageModelRetriever IContentLanguageModelRetriever

Properties

ContentLanguageIdentifier

Content language identifier.

[PageParameter(typeof(ContentLanguageModelBinder), typeof(DataProtectionContentLanguage))]
public ContentLanguageUrlIdentifier ContentLanguageIdentifier { get; set; }

Property Value

ContentLanguageUrlIdentifier

ObjectId

ID of the consent.

[PageParameter(typeof(IntPageModelBinder), typeof(ConsentEditSection))]
public override int ObjectId { get; set; }

Property Value

int

RefetchAll

Indicates whether to refetch all templates on edit.

protected override bool RefetchAll { get; }

Property Value

bool

Methods

ConfigurePage()

Set up page's configuration. Configures the submit action.

public override Task ConfigurePage()

Returns

Task

GetFormItems()

Prepares form items for editing object of the specified ObjectType.

protected override Task<ICollection<IFormItem>> GetFormItems()

Returns

Task<ICollection<IFormItem>>

Returns the collection of form items.

GetFormItemsClientProperties()

Returns properties describing client form components for editing object.

protected override Task<IEnumerable<IFormItemClientProperties>> GetFormItemsClientProperties()

Returns

Task<IEnumerable<IFormItemClientProperties>>

Exceptions

InvalidOperationException

Thrown when object instance is null or data class info for ObjectType was not found.

SetFormData(ConsentInfo, IFormFieldValueProvider)

Sets the infoObject.

protected override Task SetFormData(ConsentInfo infoObject, IFormFieldValueProvider fieldValueProvider)

Parameters

infoObject ConsentInfo

Info object to be set.

fieldValueProvider IFormFieldValueProvider

Provider of form field values.

Returns

Task