Skip to main content

EditingCapability

Description

A group of APIs to access EditingCapability.

APIs belonging to the area

NameDescription
IEditingCapabilityProviderThe base interface for providers.
IEditingCapabilityProviderRegistryA registry of providers that provide editing support.

- This registry has the same life cycle as the project.
IModelCreationProviderA model creation provider.
If you want to customize the options available when creating a model, register an implementation object of this interface in the registry.
IModelInitializationProviderA model instance initialization provider.
If you want to customize model instance initialization, register an implementation object of this interface in the registry.
IModelInitializationProviderInitializationContextThe context in which IModelInitializationProvider registers the metamodel it targets.
IModelEditorSelectionProviderThe editor selection provider.
If you want to customize the sub-editor inspectors that can be displayed for a model, register an implementation object of this interface in the registry.
IModelReferenceProviderThe model association provider.
If you want to customize the selection targets when associating models and whether or not they can be associated, register an implementation object of this interface in the registry.
ModelCreatableParamsParameters for determining the selection targets when creating a model.
ModelCreatableResultAn object that represents the result of the selection targets when creating a model.

Next Design uses this result object to construct the selection targets.

*Even if you set CapabilityResults.Fail to this result, it will not result in an error, and the selection targets when creating a model will be empty.
ModelInitializationParamsParameters that provide the initialization target for the model instance.
ModelEditorCategoriesParamsParameters to obtain editor category information.
ModelEditorCategoriesResultObject that represents the result of obtaining editor category information.

*Setting CapabilityResults.Fail to this result will not result in an error, and will be treated the same as CapabilityResults.Ignore.
ModelEditorCategoryCategory information for the editor.
ModelEditorSelectionParamsParameters for acquiring the model to be displayed for the selection of category information.
ModelEditorSelectionResultObject that represents the model acquisition result to be displayed for the selection of category information.

*Setting CapabilityResults.Fail to this result will not result in an error, and will be treated the same as CapabilityResults.Ignore.
ModelReferableParamsParameters for determining what is selected when referencing a model.
ModelReferableResultObject that represents the result of what is selected when referencing a model.

Next Design uses this result object to construct what is selected.
ModelRelateParamsParameters for determining whether or not a model can be associated.
ModelRelateResultAn object that represents the result of whether or not a model can be related.

Next Design uses this result object to determine whether or not a relationship can be related.

*Even if you set this result to CapabilityResults.Fail, it will not result in an error, and will be treated the same as CapabilityResults.Ignore.
ParamsBaseThis is the base class for the result object used by the edit assistance function.
ResultBaseThis is the base class for the parameter object used by the edit assistance function.