Table of Contents

Class SettingsDetailsPageBase

Namespace
Kentico.Xperience.Admin.Base.UIPages
Assembly
Kentico.Xperience.Admin.Base.dll

Base page for settings details and search pages.

[UINavigation(false)]
public abstract class SettingsDetailsPageBase : Page<SettingsDetailTemplateClientProperties>, IPage
Inheritance
object
SettingsDetailsPageBase
Implements
Derived
Inherited Members
Extension Methods

Constructors

SettingsDetailsPageBase(IFormDataBinder, IFormComponentCommandInvoker)

Creates a new instance of the SettingsDetailsPageBase.

protected SettingsDetailsPageBase(IFormDataBinder formDataBinder, IFormComponentCommandInvoker formComponentCommandInvoker)

Parameters

formDataBinder IFormDataBinder
formComponentCommandInvoker IFormComponentCommandInvoker

Properties

CategoryId

Id of selected node in settings tree.

public virtual int CategoryId { get; set; }

Property Value

int

Methods

ComponentCommand(FormComponentCommandModel, CancellationToken)

Handles the form component command invocation.

public Task<object> ComponentCommand(FormComponentCommandModel commandModel, CancellationToken cancellationToken)

Parameters

commandModel FormComponentCommandModel

Form component command arguments.

cancellationToken CancellationToken

The cancellation instruction.

Returns

Task<object>

Returns the form component command result.

Save(SaveKeysArguments)

Performs a validation of incoming settings values and if valid updates the changed settings.

public Task<ICommandResponse<SaveKeysResult>> Save(SaveKeysArguments args)

Parameters

args SaveKeysArguments

Settings values from current page

Returns

Task<ICommandResponse<SaveKeysResult>>

Returns result of the settings' update.