Interface IFrame

Namespace: CADability
Assembly: CADability.dll
Syntax
public interface IFrame

Properties

| Improve this Doc View Source

ActionStack

Declaration
ActionStack ActionStack { get; }
Property Value
Type Description
ActionStack
| Improve this Doc View Source

ActiveAction

Returns the currently active action. Call GetID() to find out more about that action.

Declaration
Action ActiveAction { get; }
Property Value
Type Description
Action
| Improve this Doc View Source

ActiveView

Returns the currently active view

Declaration
IView ActiveView { get; set; }
Property Value
Type Description
IView
| Improve this Doc View Source

AllViews

Returns an array of all views currently open in the frame

Declaration
IView[] AllViews { get; }
Property Value
Type Description
IView[]
| Improve this Doc View Source

CommandHandler

Update and execute menus with this command handler

Declaration
ICommandHandler CommandHandler { get; }
Property Value
Type Description
ICommandHandler
| Improve this Doc View Source

ContextMenuSource

Declaration
IPropertyEntry ContextMenuSource { get; set; }
Property Value
Type Description
IPropertyEntry
| Improve this Doc View Source

ControlCenter

Declaration
IControlCenter ControlCenter { get; }
Property Value
Type Description
IControlCenter
| Improve this Doc View Source

CurrentMenuId

Returns the menu id of the currently running action

Declaration
string CurrentMenuId { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

GlobalSettings

Returns the global settings

Declaration
Settings GlobalSettings { get; set; }
Property Value
Type Description
Settings
| Improve this Doc View Source

Project

Returns the project that is open in this frame

Declaration
Project Project { get; }
Property Value
Type Description
Project
| Improve this Doc View Source

SelectedObjects

Gets or sets the selected objects. There must be no other action running when this property is used. If there is another action running, nothing will be set and the get property returns null

Declaration
GeoObjectList SelectedObjects { get; set; }
Property Value
Type Description
GeoObjectList
| Improve this Doc View Source

SnapMode

Gets or sets the current SnapPointFinder.SnapModes

Declaration
SnapPointFinder.SnapModes SnapMode { get; set; }
Property Value
Type Description
SnapPointFinder.SnapModes
| Improve this Doc View Source

SolidModellingMode

When Solid objects get inserted into a model, this is how it will be handeled

Declaration
Make3D.SolidModellingMode SolidModellingMode { get; set; }
Property Value
Type Description
Make3D.SolidModellingMode
| Improve this Doc View Source

UIService

Declaration
IUIService UIService { get; }
Property Value
Type Description
IUIService

Methods

| Improve this Doc View Source

AssureModelView()

If the ActiveView is not a ModelView then the first ModelView of the current Project will be displayed

Declaration
void AssureModelView()
| Improve this Doc View Source

GetActivePropertyDisplay()

Returtns the name of the currently selected property page of the control center

Declaration
string GetActivePropertyDisplay()
Returns
Type Description
System.String
| Improve this Doc View Source

GetBooleanSetting(String, Boolean)

Gets the boolen setting for the Name. If not found Default will be returned. GetSetting(String)

Declaration
bool GetBooleanSetting(string Name, bool Default)
Parameters
Type Name Description
System.String Name
System.Boolean Default
Returns
Type Description
System.Boolean
| Improve this Doc View Source

GetColorSetting(String, Color)

Gets the color setting for the Name. If not found Default will be returned. GetSetting(String)

Declaration
Color GetColorSetting(string Name, Color Default)
Parameters
Type Name Description
System.String Name
System.Drawing.Color Default
Returns
Type Description
System.Drawing.Color
| Improve this Doc View Source

GetDoubleSetting(String, Double)

Gets the double setting for the Name. If not found Default will be returned. GetSetting(String)

Declaration
double GetDoubleSetting(string Name, double Default)
Parameters
Type Name Description
System.String Name
System.Double Default
Returns
Type Description
System.Double
| Improve this Doc View Source

GetIntSetting(String, Int32)

Gets the integer setting for the Name. If not found Default will be returned. GetSetting(String)

Declaration
int GetIntSetting(string Name, int Default)
Parameters
Type Name Description
System.String Name
System.Int32 Default
Returns
Type Description
System.Int32
| Improve this Doc View Source

GetPropertyDisplay(String)

Declaration
IPropertyPage GetPropertyDisplay(string Name)
Parameters
Type Name Description
System.String Name
Returns
Type Description
IPropertyPage
| Improve this Doc View Source

GetSetting(String)

Gets the Settings for the provided Name. First the Projects settings are checked, if it is not defined there, the global settings will be queried.

Declaration
object GetSetting(string Name)
Parameters
Type Name Description
System.String Name
Returns
Type Description
System.Object
| Improve this Doc View Source

GetStringSetting(String, String)

Gets the string setting for the Name. If not found Default will be returned. GetSetting(String)

Declaration
string GetStringSetting(string Name, string Default)
Parameters
Type Name Description
System.String Name
System.String Default
Returns
Type Description
System.String
| Improve this Doc View Source

ProcessContextMenu(ICommandHandler, String, ref Boolean)

Declaration
void ProcessContextMenu(ICommandHandler target, string MenuId, ref bool Processed)
Parameters
Type Name Description
ICommandHandler target
System.String MenuId
System.Boolean Processed
| Improve this Doc View Source

RaiseActionStartedEvent(Action)

Declaration
void RaiseActionStartedEvent(Action Action)
Parameters
Type Name Description
Action Action
| Improve this Doc View Source

RaiseActionTerminatedEvent(Action)

Declaration
void RaiseActionTerminatedEvent(Action Action)
Parameters
Type Name Description
Action Action
| Improve this Doc View Source

RemoveActiveAction()

Removes the active action froom the action stack. Usually actions terminate themselves by calling RemoveThisAction().

Declaration
void RemoveActiveAction()
| Improve this Doc View Source

SetAction(Action)

Starts the provided action. The currently active action will either be aborted or pushed down on the action stack until the provided action terminates.

Declaration
void SetAction(Action Action)
Parameters
Type Name Description
Action Action
| Improve this Doc View Source

SetControlCenterFocus(String, String, Boolean, Boolean)

Sets the focus to a given entry in a given tabpage of the controlcenter. The names of the standard tabpgaes are: "Action","Project","Global","View","Symbol". If resourceId is null only the specified tabpage is selected.

Declaration
bool SetControlCenterFocus(string tabPageName, string resourceId, bool openEntry, bool popupCOntextMenu)
Parameters
Type Name Description
System.String tabPageName

Name of a tabpage
System.String resourceId

resource id of an entry or null
System.Boolean openEntry

the subentries of this entry should be opened
System.Boolean popupCOntextMenu

the context menu of this entry should be displayed
Returns
Type Description
System.Boolean
| Improve this Doc View Source

ShowPropertyDisplay(String)

Brings the property page with the Name to front (in the tab control)

Declaration
void ShowPropertyDisplay(string Name)
Parameters
Type Name Description
System.String Name
| Improve this Doc View Source

UpdateContextMenu(ICommandHandler, String, CommandState, ref Boolean)

Declaration
void UpdateContextMenu(ICommandHandler target, string MenuId, CommandState CommandState, ref bool Processed)
Parameters
Type Name Description
ICommandHandler target
System.String MenuId
CommandState CommandState
System.Boolean Processed
| Improve this Doc View Source

UpdateMRUMenu(String[])

Declaration
void UpdateMRUMenu(string[] mruFiles)
Parameters
Type Name Description
System.String[] mruFiles

Events

| Improve this Doc View Source

ActionStartedEvent

Notification that a Action started

Declaration
event ActionStartedDelegate ActionStartedEvent
Event Type
Type Description
ActionStartedDelegate
| Improve this Doc View Source

ActionTerminatedEvent

Notification that a Action terminated

Declaration
event ActionTerminatedDelegate ActionTerminatedEvent
Event Type
Type Description
ActionTerminatedDelegate
| Improve this Doc View Source

ControlCenterCreatedEvent

This event will raised when the ControlCenter has been created. You can use the method ControlCenter.HideEntry to suppress entries in the ControlCenter

Declaration
event ControlCenterCreatedDelegate ControlCenterCreatedEvent
Event Type
Type Description
ControlCenterCreatedDelegate
| Improve this Doc View Source

ProcessCommandEvent

Provide a event handler if you want to be notified on command routed through this frame or to execute command handlers for some routed commands-

Declaration
event ProcessCommandDelegate ProcessCommandEvent
Event Type
Type Description
ProcessCommandDelegate
| Improve this Doc View Source

ProcessContextMenuEvent

Provide a event handler if you want to be notified on contex menue commands routed through this frame or to execute command handlers for some routed commands-

Declaration
event ProcessContextMenuDelegate ProcessContextMenuEvent
Event Type
Type Description
ProcessContextMenuDelegate
| Improve this Doc View Source

ProjectClosedEvent

Provide a event handler if you want to be notified when a project is beeing closed.

Declaration
event ProjectClosedDelegate ProjectClosedEvent
Event Type
Type Description
ProjectClosedDelegate
| Improve this Doc View Source

ProjectOpenedEvent

Provide a event handler if you want to be notified when a project is opened.

Declaration
event ProjectOpenedDelegate ProjectOpenedEvent
Event Type
Type Description
ProjectOpenedDelegate
| Improve this Doc View Source

SettingChangedEvent

Register here to get notified when a setting has changed

Declaration
event SettingChangedDelegate SettingChangedEvent
Event Type
Type Description
SettingChangedDelegate
| Improve this Doc View Source

UpdateCommandEvent

Provide a event handler if you want to control the appearnce of commands in the menu or toolbar (set the enabled and check flags).

Declaration
event UpdateCommandDelegate UpdateCommandEvent
Event Type
Type Description
UpdateCommandDelegate
| Improve this Doc View Source

UpdateContextMenuEvent

Provide a event handler if you want to control the appearance of commands in a context the menu (set the enabled and check flags).

Declaration
event UpdateContextMenuDelegate UpdateContextMenuEvent
Event Type
Type Description
UpdateContextMenuDelegate
| Improve this Doc View Source

ViewsChangedEvent

Provide a event handler if you want to be notified when new views are created or views are closed.

Declaration
event ViewsChangedDelegate ViewsChangedEvent
Event Type
Type Description
ViewsChangedDelegate