Skip to main content

IEditorPage Interface

Namespace: NextDesign.Desktop

Description

Provides access to the editor UI.

Belonging Area

NameDescription
User InterfaceA group of APIs to access UIs such as editors and navigators.

Inherit Base

NameDescription
IUIElementProvides access to UI elements.

Property

NameDescription
ActiveInfoWindow[Obsolete]
Active page in info pane
- "Output" : Output
- "Error" : Error
- "SearchResult" : Search result
ActiveInspectorActive inspector in inspector pane
- "Property" : Property
- "Relationship" : Relationship
- "ViewDefinition" : Can be obtained or set in the inspector below.
- Diagram Definition
- Shape Definition
- Node
- Port
- Connector
- Lifeline
- Note
- Combined Fragment
- Message
- Note Anchor
- Execution Specification
- Destroy
- Message End
- Form Definition
- Form Element
- Text
- Combo Box
- Check Box
- Rich Text
- Model Reference Control
- Group
- Grid
- List
- Row Definition
- Tree Grid Row
- "Metamodel" : Can be got or set in the Inspector below.
- Package
- Metamodel
- Class
- Association Class
- Field
- Enumerations
ActiveNavigatorThe active navigator in the Navigator pane
- "Model" : Model Navigator
- "ProductLine" : Product Line Navigator
- "Scm" : Configuration Management Navigator
- "Project" : Project Navigator
- "Profile" : Profile Navigator
ActivePaletteThe active palette in the Palette pane
- "Editor" : Toolbox
- "Reference" : Reference
- "Derive" : Input
- "Feature" : Feature Palette
- "ProductSelector" : Product Selector
- "Class" : Class Toolbox
CurrentEditorViewCurrently active editor view in the active tab
CurrentInfoView[Obsolete]
Currently active display page in the info window
CurrentModelCurrently selected model (in the Model Navigator)
CurrentNavigatorCurrently active navigator
CurrentOutputCategory[Obsolete]
Current category of Output in the info pane
IsDiffHighlightVisibleChange diff comparison mode
IsDiffViewVisibleDiff view visibility state
IsErrorCardVisibleError card visibility state
IsFeatureMarkVisibleFeature mark visibility state
IsIndicatorVisibleIndicator visibility state
IsInformationPaneVisible[Obsolete]
Information pane visibility state
[IsInspectorPaneVisible](pr operties/IsInspectorPaneVisible.md)Inspector pane visibility state
IsNavigatorPaneVisibleNavigator pane visibility state
IsSubEditorVisibleSubeditor visibility state of the active tab
IsTraceLineVisibleInter-editor trace visibility state
MainEditorViewMain editor view of the active tab
SubEditorModeSubeditor visibility mode of the active tab
SubEditorModeNameDisplay mode name of the subeditor of the active tab

If SubEditorMode is "Custom", the format is Custom.\{ModelEditorCategory.Id\}.
SubEditorViewSubeditor view of the active tab

Method

NameDescription
IsMainEditorDetermines whether the specified custom editor is currently displayed in the main editor of the active tab.
Custom editor initialization process ICustomUI.OnInitialized() Cannot be determined correctly at execution time and always returns false.
IsSubEditorDetermines whether the specified custom editor is currently displayed in the subeditor of the active tab.
Custom editor initialization process ICustomUI.OnInitialized() cannot be determined correctly when executed and always returns false.
SetSubEditorMode(string,IModel)Specifies the display mode of the subeditor of the active tab as a string type.
SetSubEditorMode(SubEditorMode,IModel)Specifies the display mode of the subeditor of the active tab as an enumeration type.
UpdateEditorsUpdates this editor page to the latest version.
Refreshes both the main editor and sub-editors of all tabs at the same time.
However, if you have edited the position or style of shapes or connectors in the editor to be refreshed, those edits will be lost.