ViewXtMdiSubWindow
Inheritance
The ViewXtMdiSubWindow object is derived from the MdiSubWindow object.
Usage locations
The ViewXtMdiSubWindow object can be accessed from the following locations:
Property List
- DisplayMode
- The view display mode properties. (Read/Write ViewDisplayMode)
- Height
- The height of the view window. (Read/Write number)
- Label
- The object label. (Read/Write string)
- Type
- The object type string. (Read only string)
- Width
- The width of the view window. (Read/Write number)
- WindowActive
- True if this window is the active window. (Read only boolean)
- XPosition
- The X position of the view window. (Read/Write number)
- YPosition
- The Y position of the view window. (Read/Write number)
Property List (internal only)
- Axes
- (Read/Write View3DAxesFormat)
- CablePathsVisible
- (Read/Write boolean)
- FDTDBoundaryVisible
- (Read/Write boolean)
- Geometry
- (Read/Write View3DGeometryVisibilityFormat)
- MeshingRulesVisible
- (Read/Write boolean)
- ModelMesh
- (Read/Write View3DMeshVisibilityFormat)
- NamedPointsVisible
- (Read/Write boolean)
- PBCPlanesVisible
- (Read/Write boolean)
- Path
- (Read only string)
- PortAnnotationsVisible
- (Read/Write boolean)
- PortsVisible
- (Read/Write boolean)
- Rendering
- (Read/Write ViewRenderingOptions)
- SimulationMesh
- (Read/Write View3DMeshVisibilityFormat)
- SolutionEntitiesVisible
- (Read/Write boolean)
- SymmetryPlanesVisible
- (Read/Write boolean)
- ViewWindow
- (Read only ViewXtWindow)
- Voxels
- (Read/Write View3DVoxelVisibilityFormat)
- Workplanes
- (Read/Write View3DWorkplanesFormat)
Method List
- Delete ()
- Deletes the entity.
- Duplicate ()
- Duplicates the entity. (Returns a Object object.)
- GetProperties ()
- Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step. (Returns a table object.)
- Maximise ()
- Maximise the view window.
- Minimise ()
- Minimise the view window.
- Restore ()
- Restore the view window.
- SetPosition (xposition number, yposition number)
- Sets the view position. Note that the view is restored when this function is called.
- SetProperties (properties Object)
- Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.
- SetSize (imagewidth number, imageheight number)
- Sets the view window size. Note that the view is restored when this function is called.
- Show ()
- Shows the view window.
Static Function List
- GetDefaultProperties ()
- Creates a table containing the default settings to create an object. (Returns a table object.)
Property Details
- DisplayMode
- The view display mode properties.
- Type
- ViewDisplayMode
- Access
- Read/Write
- Height
- The height of the view window.
- Type
- number
- Access
- Read/Write
- Label
- The object label.
- Type
- string
- Access
- Read/Write
- Type
- The object type string.
- Type
- string
- Access
- Read only
- Width
- The width of the view window.
- Type
- number
- Access
- Read/Write
- WindowActive
- True if this window is the active window.
- Type
- boolean
- Access
- Read only
- XPosition
- The X position of the view window.
- Type
- number
- Access
- Read/Write
- YPosition
- The Y position of the view window.
- Type
- number
- Access
- Read/Write
Property Details (internal only)
- Axes
- Type
- View3DAxesFormat
- Access
- Read/Write
- CablePathsVisible
- Type
- boolean
- Access
- Read/Write
- FDTDBoundaryVisible
- Type
- boolean
- Access
- Read/Write
- Geometry
- Type
- View3DGeometryVisibilityFormat
- Access
- Read/Write
- MeshingRulesVisible
- Type
- boolean
- Access
- Read/Write
- ModelMesh
- Type
- View3DMeshVisibilityFormat
- Access
- Read/Write
- NamedPointsVisible
- Type
- boolean
- Access
- Read/Write
- PBCPlanesVisible
- Type
- boolean
- Access
- Read/Write
- Path
- Type
- string
- Access
- Read only
- PortAnnotationsVisible
- Type
- boolean
- Access
- Read/Write
- PortsVisible
- Type
- boolean
- Access
- Read/Write
- Rendering
- Type
- ViewRenderingOptions
- Access
- Read/Write
- SimulationMesh
- Type
- View3DMeshVisibilityFormat
- Access
- Read/Write
- SolutionEntitiesVisible
- Type
- boolean
- Access
- Read/Write
- SymmetryPlanesVisible
- Type
- boolean
- Access
- Read/Write
- ViewWindow
- Type
- ViewXtWindow
- Access
- Read only
- Voxels
- Type
- View3DVoxelVisibilityFormat
- Access
- Read/Write
- Workplanes
- Type
- View3DWorkplanesFormat
- Access
- Read/Write
Method Details
- Delete ()
- Deletes the entity.
- Duplicate ()
- Duplicates the entity.
- Return
- Object
- The new (duplicated) entity.
- GetProperties ()
- Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step.
- Return
- table
- A table defining the properties.
- Maximise ()
- Maximise the view window.
- Minimise ()
- Minimise the view window.
- Restore ()
- Restore the view window.
- SetPosition (xposition number, yposition number)
- Sets the view position. Note that the view is restored when this function is called.
- SetProperties (properties Object)
- Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.
- Input Parameters
- properties(Object)
- A table of properties defining the new state of the object.
- SetSize (imagewidth number, imageheight number)
- Sets the view window size. Note that the view is restored when this function is called.
- Show ()
- Shows the view window.
Static Function Details
- GetDefaultProperties ()
- Creates a table containing the default settings to create an object.
- Return
- table
- A table containing the default properties.