Skip to main content

IEditorPage Interface

Namespace: NextDesign.Desktop

Description

Provides access to the editor UI.

Area

NameDescription
User InterfaceA set of APIs for accessing UI elements such as editors and navigators.

Inherit Base

NameDescription
IUIElementProvides access to UI elements.

Property

NameDescription
ActiveInfoWindow[Obsolete]
Active page of the information pane
- "Output" : Output
- "Error" : Error
- "SearchResult" : Search results
ActiveInspectorActive inspector of the inspector pane
- "Property" : Property
- "Relationship" : Relationship
- "ViewDefinition" : Can be obtained or set in the following inspectors.
- Diagram definition
- Shape definition
- Node
- Port
- Connector
- Lifeline
- Note
- Composite fragment
- Message
- Note anchor
- Execution specification
- Discard
- Message end
- Form definition
- Form element
- Text
- Combo box
- Checkbox
- Rich text
- Model reference control
- Group
- Grid
- List
- Row definition
- Tree grid row
- "Metamodel": Can be obtained or set in the following inspector.
- Package
- Metamodel
- Class
- Related Class
- Field
- Enumeration
ActiveNavigatorActive navigator in the navigator pane
- "Model" : Model navigator
- "ProductLine" : Product line navigator
- "Scm" : Configuration management navigator
- "Project" : Project navigator
- "Profile" : Profile navigator
ActivePaletteActive palette in the palette pane
- "Editor" : Toolbox
- "Reference" : Reference
- "Derive" : Input
- "Feature" : Feature palette
- "ProductSelector" : Product selector
- "Class" : Class Toolbox
CurrentEditorViewCurrently active editor view of the active tab
CurrentInfoView[Obsolete]
Currently active displayed page in the Info pane
CurrentModelCurrently selected model (in the Model Navigator)
CurrentNavigatorCurrently active navigator
CurrentOutputCategory[Obsolete]
Current category of Output in the Info pane
IsAgentiqsPaneVisible
IsDiffHighlightVisibleChange Difference Comparison Mode
IsDiffViewVisibleDiff View Display State
IsErrorCardVisibleError Card Display State
IsFeatureMarkVisibleFeature Mark Display State
IsIndicatorVisibleIndicator Display State
IsInformationPaneVisible[Obsolete]
Information Pane Display State
IsInspectorPaneVisibleInspector Pane Visibility
IsNavigatorPaneVisibleNavigator Pane Visibility
IsSubEditorVisibleSub-Editor Visibility of Active Tab
IsTraceLineVisibleInter-Editor Trace Visibility
MainEditorViewMain Editor View of Active Tab
SubEditorModeSub-Editor Display Mode of Active Tab
SubEditorModeNameDisplay mode name of the active tab's sub-editor

If SubEditorMode is "Custom", it will be in the format Custom.\{ModelEditorCategory.Id\}.
SubEditorViewSub-editor view of the active tab

Method

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