IProject Interface
Namespace: NextDesign.Core
Description
Provides access to project information.
Belonging Area
| Name | Description |
|---|---|
| Workspace Project | A set of APIs to access the application workspace and projects open in the application. |
Inherit Base
| Name | Description |
|---|---|
| IModel | Provides access to NextDesign design model information. |
Property
| Name | Description |
|---|---|
| CanRedo | Checks if a redo operation can be performed. |
| CanUndo | Checks if an undo operation can be performed. |
| DesignModel | Design model root (root model in model navigator) |
| EditingCapabilityProviderRegistry | Editing support function registry |
| IsProductLineSupported | Whether product line development is supported in this project |
| OutputModelPaths | Whether to output the path of the referenced model when persisting |
| Path | Project path This will be null for a newly created project. |
| ProductLineModel | Product line development support model |
| Profile | Profile used in the project |
| UnitManager | Project unit information manager |
Method
| Name | Description |
|---|---|
| AddNewRootModel(IPackage,string,bool) | Adds a new model of the specified class to the project. The specified class is identified from the package specified in the scope. Even if the specified class is an abstract class, instantiation is allowed and it is added as the last element of the corresponding field. The added model is held as an element under the project node (directly under the project) displayed on the model navigator. When using fuzzy matching, if there are multiple matching classes, an instance of the first type-compatible class found will be added. Also, you can add it even if the specified class's "Can be placed directly under the project" is not checked. |
| AddNewRootModel(string,bool) | Adds a new model of the specified class to the project. Even if the specified class is an abstract class, instantiation is allowed and it is added as the last element of the relevant field. The added model is stored as an element under the project node (directly under the project) displayed in the model navigator. When using fuzzy matching, if there are multiple matching classes, an instance of the first type-compatible class found will be added. Also, you can add it even if the specified class's "Can be placed directly under the project" is not checked. |
| BeginUndoTransaction | Start editing and generate an undo transaction. Edits made within an undo transaction will be subject to a single undo/redo operation. |
| CreateModelAccessPolicy | Create a model access policy. The policy settings will be applied to access to a model made within the scope in which the policy is effective. |
| CreateProductLineModel | Create a product line development support model in this project to enable product line development. Creating a product line development support model will generate the following model. - Product line development support model - Empty feature model - Empty configuration model If this project already supports product line development, the call to this method will be ignored. |
| GetModelById | Gets a model with the specified identifier from this project. If the specified model is not found, it returns null. Note that this call cannot get relationships. To get relationships, use GetRelationshipById(). This call also targets models that were deleted after the project was loaded. Evaluate IModel.IsDeleted to see if the retrieved model has been deleted. |
| GetModelByPath(string,string) | Gets a model with the specified relative path from the model with the specified base element identifier. If there is no model with the specified model hierarchy path, it returns null. If there are multiple matching model hierarchy paths, the first model found will be returned. |
| GetModelByPath(string) | Gets a model with the specified model hierarchy path from this project. If there is no model with the specified model hierarchy path, null will be returned. If there are multiple matching model hierarchy paths, the first model found will be returned. You can also use a string specified in ModelPath of IModel as the model hierarchy path to specify. |
| GetRelationshipById | Gets a relationship with the specified identifier from this project. If the specified relationship is not found, null will be returned. This call also includes relationships that were deleted after the project was loaded. Evaluate IRelationship.IsDeleted to see if the retrieved relationship has been deleted. |
| GetUndoSuspendScope | Gets the scope in which to suspend undo. Editing operations performed within this scope will not be recorded in the undo stack. |
| HasUnsavedChanges | Checks whether there are any unsaved changes. Unlike IsDirty, returns False if the project is dirty but the changes are not to be saved. |
| ImportProfile | Imports the profile at the specified path. |
| Redo | Redoes the most recently undone editing operation. If there was no most recently undone editing operation, does nothing. |
| Undo | Undoes the most recent edit operation. If there is no most recent edit operation, does nothing. |
Extension Methods
| Name | Description |
|---|---|
| GetRootChildren | Gets a list of children of the design model root (the root model in the model navigator). |