Class ContentItemSelectorComponentBase<TProperties>
A base class for content item selector form components.
public abstract class ContentItemSelectorComponentBase<TProperties> : FormComponentWithNestedComponents<TProperties, ContentItemSelectorClientProperties, IEnumerable<ContentItemReference>>, IFormComponent, IFormItem<IFormComponentClientProperties>, IFormItem where TProperties : ContentItemSelectorBaseProperties, new()Type Parameters
TProperties
- Inheritance
-
objectFormComponentWithNestedComponents<TProperties, ContentItemSelectorClientProperties, IEnumerable<ContentItemReference>>ContentItemSelectorComponentBase<TProperties>
- Implements
- Derived
- Inherited Members
- Extension Methods
Remarks
This API supports the framework infrastructure and is not intended to be used directly from your code.
Constructors
ContentItemSelectorComponentBase(IFormComponentCommandInvoker, IFormDataBinder, IAuthenticatedUserAccessor, IContentItemManagerFactory, ILocalizationService, IEventLogService, IFormItemCollectionProvider, IContentLanguageRetriever, IContentItemDisplayNameValidator, IContentItemCommonDataInfoRetriever, IContentItemSelectorItemProvider)
Initializes a new instance of ContentItemSelectorComponentBase<TProperties>.
[Obsolete("Method was not intended for public use and will be removed in the next version.")]
public ContentItemSelectorComponentBase(IFormComponentCommandInvoker formComponentCommandInvoker, IFormDataBinder formDataBinder, IAuthenticatedUserAccessor userAccessor, IContentItemManagerFactory contentItemManagerFactory, ILocalizationService localizationService, IEventLogService eventLogService, IFormItemCollectionProvider formItemCollectionProvider, IContentLanguageRetriever contentLanguageRetriever, IContentItemDisplayNameValidator contentItemDisplayNameValidator, IContentItemCommonDataInfoRetriever contentItemCommonDataInfoRetriever, IContentItemSelectorItemProvider selectorItemProvider)Parameters
formComponentCommandInvokerIFormComponentCommandInvokerformDataBinderIFormDataBinderuserAccessorIAuthenticatedUserAccessorcontentItemManagerFactoryIContentItemManagerFactorylocalizationServiceILocalizationServiceeventLogServiceIEventLogServiceformItemCollectionProviderIFormItemCollectionProvidercontentLanguageRetrieverIContentLanguageRetrievercontentItemDisplayNameValidatorIContentItemDisplayNameValidatorcontentItemCommonDataInfoRetrieverIContentItemCommonDataInfoRetrieverselectorItemProviderIContentItemSelectorItemProvider
Methods
ChangeEditContentItemPanelForm(FormChangeCommandArguments, CancellationToken)
Handles the form change command. The command is invoked whenever visibility conditions of the form need to be reevaluated to re-render the form.
[FormComponentCommand]
public Task<ICommandResponse<FormChangeResult>> ChangeEditContentItemPanelForm(FormChangeCommandArguments args, CancellationToken cancellationToken = default)Parameters
argsFormChangeCommandArgumentsForm change arguments.
cancellationTokenCancellationTokenCancellation instruction.
Returns
- Task<ICommandResponse<FormChangeResult>>
Returns the form change result.
ConfigureClientProperties(ContentItemSelectorClientProperties)
Configures the form component client properties.
protected override Task ConfigureClientProperties(ContentItemSelectorClientProperties clientProperties)Parameters
clientPropertiesContentItemSelectorClientPropertiesThe 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.
ConfirmSelection(ContentItemSubmissionCommandArguments, CancellationToken)
Confirms the selection of content item creation parameters.
[FormComponentCommand]
public Task<ICommandResponse> ConfirmSelection(ContentItemSubmissionCommandArguments args, CancellationToken cancellationToken)Parameters
argsContentItemSubmissionCommandArgumentsConfirm selection form command arguments.
cancellationTokenCancellationTokenCancellation instruction.
Returns
- Task<ICommandResponse>
Create(ContentItemSubmissionCommandArguments, CancellationToken)
Creates a content item based on args and returns a created content item data.
[FormComponentCommand]
public Task<ICommandResponse> Create(ContentItemSubmissionCommandArguments args, CancellationToken cancellationToken)Parameters
argsContentItemSubmissionCommandArgumentsSubmission arguments.
cancellationTokenCancellationTokenCancellation instruction.
Returns
- Task<ICommandResponse>
CreateContentItem(ContentItemSubmissionCommandArguments, string, VersionStatus, ContentItemData, CancellationToken)
Creates a reusable content item based on provided parameters.
protected virtual Task<int> CreateContentItem(ContentItemSubmissionCommandArguments args, string languageName, VersionStatus versionStatus, ContentItemData data, CancellationToken cancellationToken)Parameters
argsContentItemSubmissionCommandArgumentsSubmission arguments.
languageNamestringLanguage code name.
versionStatusVersionStatusVersion status.
dataContentItemDataContent item data retrieved from form.
cancellationTokenCancellationTokenCancellation instruction.
Returns
- Task<int>
Content item identifier of newly created item.
Remarks
Method creates a reusable content item. If you want to create specific content type item you need to override this method.
GetContentTypeSelectionModel()
Returns the model object for the content type selection form.
protected abstract object GetContentTypeSelectionModel()Returns
- object
GetNestedFormItems()
Returns the form items that are used within the nested form.
protected override Task<ICollection<IFormItem>> GetNestedFormItems()Returns
- Task<ICollection<IFormItem>>
GetSelectionModel()
Returns model class for the form.
[Obsolete("Method was not intended for public use and will be removed in the next version.")]
protected virtual object GetSelectionModel()Returns
- object
InitializeNestedContext()
Initializes form context within the nested form.
protected override Task<IFormContext> InitializeNestedContext()Returns
- Task<IFormContext>
LoadContentItemPanelItems(LoadContentItemPanelItemsCommandArguments, CancellationToken)
Loads content item panel items.
[FormComponentCommand]
public Task<ICommandResponse<LoadContentItemPanelItemsResult>> LoadContentItemPanelItems(LoadContentItemPanelItemsCommandArguments args, CancellationToken cancellationToken)Parameters
argsLoadContentItemPanelItemsCommandArgumentscancellationTokenCancellationToken
Returns
LoadFormItems(ContentItemCommandParameters, CancellationToken)
Loads create content item form items.
[FormComponentCommand]
public Task<ICommandResponse> LoadFormItems(ContentItemCommandParameters args, CancellationToken cancellationToken)Parameters
argsContentItemCommandParameterscancellationTokenCancellationToken
Returns
- Task<ICommandResponse>
Publish(ContentItemSubmissionCommandArguments, CancellationToken)
Publishes the content item.
[FormComponentCommand]
public Task<ICommandResponse> Publish(ContentItemSubmissionCommandArguments args, CancellationToken cancellationToken)Parameters
argsContentItemSubmissionCommandArgumentsPublish content item command arguments.
cancellationTokenCancellationTokenCancellation instruction.
Returns
- Task<ICommandResponse>
ValidateDisplayName(RenameCommandArguments)
Validates the content item display name.
[FormComponentCommand]
public Task<ICommandResponse<RenameCommandResult>> ValidateDisplayName(RenameCommandArguments args)Parameters
argsRenameCommandArgumentsRename command arguments.