Class vdDocument

Namespace: VectorDraw.Professional.vdObjects

Assembly: VectorDraw.Professional.dll

Represents the main document object in VectorDraw Professional.

This sealed class manages drawing data, layouts, entities, rendering, undo/redo, and user interactions.

It is created by the vdDocumentComponent Component

public sealed class vdDocument : vdBaseObject, IVDSerialise, IBaseObject, IDisposable, ISupportObjectSnaps

Inheritance: object

BaseObject

vdBaseObject

vdDocument

Implements: IVDSerialise

IBaseObject

IDisposable

ISupportObjectSnaps

Inherited Members: vdBaseObject.Register()

vdBaseObject.SetUnRegisterDocument(vdDocument)

vdBaseObject.InternalSetOwner(vdBaseObject)

vdBaseObject.RaiseOnAfterModify(string)

vdBaseObject.RaiseOnBeforeModify(string, object)

vdBaseObject.AddHistory(string, object)

vdBaseObject.AddHistoryEx(string, object)

vdBaseObject.IsDocumentRegister

vdBaseObject._TypeName

vdBaseObject.Owner

vdBaseObject.SupportUndoWrite

vdBaseObject.DocProperties

vdBaseObject.OnAfterModifyObjectEx

vdBaseObject.OnBeforeModifyObjectEx

BaseObject.GetHashCode()

BaseObject.Id

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetType()

Examples

See vdPrint examples for document model and layout with viewports management, according to the desired print scale of the design

Remarks

This class is the central hub for all drawing-related operations in VectorDraw Professional.

It manages collections of layers, blocks, dimensions, text styles, line types, and other drawing elements.

The class provides extensive support for rendering, view management, coordinate system transformations, and user actions.

It also handles file I/O operations, external references (Xrefs), undo/redo history, and event handling.

Fields

ClipboardVDMLBytesFormat: Specifies a vdml byte array Clipboard format

ClipboardVDMLFormat: Specifies a vdml Memory stream Clipboard format

EMPTYFILENAME: "Empty FileName" string value.

FILENOTFOUND: "File not found" string value.

GENERICIOERROR: "Generic IO Error" string value. This error is used for errors occuring inside methods and is a general error message.

LOCKENTITYMODIFYERROR: "Cannot modify lock entities." string value.

MISSINGLIBRARIES: "Missing Libraries" string value.

UNSUPPORTEDFORMAT: "Unsupported File Format" string value.

UNSUPPORTEDVERSION: "Usupported file version" string value.

Properties

ActionControl: Get/Set the Control window associated with the document object.

ActionLayout

Get the layout of the document that the user input actions is taking place.

The action layout is either the ActiveLayOut(model or a layout) or the default Model layout if a vdViewport is active in a layout.

ActionScaleMode: Get/Set the way that user scale action is applied, when user run the CmdScale or CmdInsert commands

ActionUtility: Get the Action Utility of the active layout of the document.Used to beging some common user actions.

Activator: Get the Activator that creates all object types of the document.Used to add new custom object types.

ActiveActionControl: Return the active control used for rendering and interaction with mouse and keyboard events, for this document. Usually is the same control with the ActionControl property.

ActiveActionRender: Get the vdRender object where the active user action is rendered. Depends on the ActiveLayOut and ActiveViewPort.

ActiveDimStyle: Get/Set the active vdDimstyle of the document. vdDimension objects assign this dimstyle as default when the setDocumentDefaults() method is called.

ActiveHatchProperties: Get/Set the active vdHatchProperties properties of the document. vdPolyhatch, vdRect, vdPolyline, vdEllipse, vdCircle and vdArc and all vdFigure objects that implement the IvdHatchFigure assign these properties as default when the setDocumentDefaults() method is called."/>

ActiveLayOut: Get/Set the active layout(model or a layout) of the document.

ActiveLayer: Get/Set the active vdLayer of the document.

ActiveLineType: Get/Set the active vdLineType of the document.

ActiveLineWeight: Get/Set the active VdConstLineWeight of the document. all vdFigure objects assign this line weight as default when the setDocumentDefaults() method is called.

ActiveMTextLineSpacing: Get/Set the active Mtext LineSpacing for all new Mtexts.

ActiveMTextLineSpacingFactor: Get/Set a value adjusting the space between the lines of all new Mtexts.

ActiveMultiLineStyle: Get/Set the active vdMultilineStyle of the document.

ActivePenColor: Get/Set the vdColor pen color of the document. all vdFigure objects assign this color as default pen color when the setDocumentDefaults() method is called.

ActivePenWidth: Get/Set the active penwidth of the document in Drawing Units. all vdFigure objects assign this pen weight as default when the setDocumentDefaults() method is called.

ActiveRender: Get the vdRender object where the document will be rendered. Depends on the ActiveLayOut and ActiveViewPort.

ActiveRenderingView: Returns the ActiveViewPort if exist or ActiveLayOut as VectorDraw.Professional.vdPrimaries.IvdRenderingView type

ActiveTextHorJustify: Get/Set the active text VdConstHorJust of the document.

ActiveTextStyle: Get/Set the active vdTextstyle of the document. vdText, vdMText, vdAttrib , vdAttribDef objects assign this style as default when the setDocumentDefaults() method is called.

ActiveTextVerJustify: Get/Set the active text VdConstVerJust of the document.

ActiveThickness: Get/Set the active thickness of the document in Drawing Units. all vdCurve objects assign this thickness as default when the setDocumentDefaults() method is called.

ActiveView: Get/Set the active vdView for the document.

AltTTFFont: Return or set the default Font that is used for style names when a vdTextstyle object first created.

AngBase: Returns and sets where the direction start angle is in radians.

Angdir: Get/Set the VdConstAngDir type for angle direction.

Background: Get/Set the color used for background.

BackupOnSave: Get/Set a boolean value representing if a backup file will be kept before saving an existing file.

BasePoint: Get/Set the base point of the document.It is used when you insert a drawing in a document as a block.

BhatchAutoDetectTexts: This value controls a variable used in the bhatch dialog.If true then bhatch will detect Texts inside the selected curves from the user and exclude them from the polyhatch creation.Check article 70001823.

BlockColorOper: Get/Set the vdDocument.BlockColorOperEnum method used for the color of entities inside block belongs in Layer 0 and with it's color equals to ByLayer.

BlockStdLayerOper: Get/Set the vdDocument.BlockStdLayerOperFlag method used for the PenColor, LineType, LineWeight of entities set to layer 0 ,inside block

Blocks: Get the vdBlocks collection of the document.

ChamferSettings: Get/Set the default settings used in chamfer command. These values change as the user use the cmdChamfer command.

CloudDistance: Get/Set the Distance in drawing units that will be used as default value for the Cloud command.

ColorPalette: Get/Set the output Color palette of ActiveViewPort (if exist) or the ActiveLayOut (model or a layout)

CommandAction: Get the vdCommandAction object of the document.

DimStyles: Get the vdDimstyles collection of the document.

DisableExternalReferencesLoad: Enable/Disable load of External References.

DisableRedraw: Get/Set a boolean value which disables or enables drawing methods to the control window.

DisableShowPrinterPaper: Get/Set if the default paper printer will be drawn at the active layout.

DisableXrefToolTips: Get/Set a boolean value representing if the objects that belong to external references of the document will show their tooltip.

DisableZoomOnResize: Get/Set a boolean value which disables or enables zoom change when the control is resized.

Document: Gets the vdDocument that the object belongs.

EdgeColor: Get/Set the display color for edges of all faces when rendering in 3d.(when RenderMode is Wire3d ,Hide or ShadeOn)

EdgeEffect: Get/Set the EdgeEffect.

EdgeExtendTrim: Get/Set the default settings used in Extend and Trim command. These values change as the user use the cmdTrim and cmdExtend command. If this is True then the trim or extend is applied using the extension of the bound entities

EdgePenWidth: Get/Set the EdgeEffect.

EnableActiveLayerFrozen: Get/Set a boolean value representing if the active layer ocan be Frozen.

EnableAutoFocus: Get/Set a boolean value representing if the mouse enters the control automatically will set the focus to the control.

EnableAutoGripOn: A boolean value representing if the mouse click will show the grips of the entities and also if the window Select command will start when the user click's to the control and there is no Entity below.

EnableDimTextHeightOverride: Enable/Disable The dimension's Text Height override based on the TextStyle's Height property.

EnableFullCircleArc: Get/Set a static value representing if a vdArc object that has equal start and end angle it will be drawn as vdCircle.

EnableToolTips: Get/Set a value representing if the tooltips of the objects will be shown.

EnableUrls: Get/Set a value representing if the URL of the objects will be opened.

EntitySelectMode: Get/Set the PickEntityMode method used for single entity picking operation.

ExplodeCustomObjectsOnSave: A boolean value that represents if custom objects will be exploded when saved in vdml/vdcl format.

ExternalReferences: Get the vdDocuments collection containing all External References of the Document.

ExtraGrips: Controls the behaviour of some extra grips for vdText , vdMtext , vdRect , vdImage , vdEllipse , vdInsert figures.

FileName: Get/Set the filename of the file opened to the document.

FileProperties: Get the vdFileProperties object of the document.

FilletRadius: Get/Set the Distance in drawing units that will be used as default value for the FilletRadius command.

FocalLength: Get/Set the focal length of the ActiveViewPort (if exist) or the ActiveLayOut(model or a layout).

FreezeActions: Get/Set a boolean value representing if the user actions are enabled or not.

FreezeActionsStack: A stack to enable/disable using push,pop the user actions.

FreezeEntityDrawEvents: A stack to enable/disable using push,pop the OnDrawFigure , OnDrawAfterFigure , GetDimensionText , OnFigureDrawGrips events.

FreezeGridEvents: Get/Set a value that represents if the vdPropertyGrid control events are going to be fired.Default value is True and events are not fired. It is required to set this value to False in order to use the vdPropertyGrid.SelectedObjectChange event of the vdPropertyGrid control.

FreezeModifyEvents: A stack to enable/disable using push,pop the OnAfterAddItem, OnAddItem, OnEraseObject, OnBeforeModifyObject, OnAfterModifyObject events.

GlobalRenderProperties: Get the vdRenderGlobalProperties object of the document.

GridMeasure: Get the GridMeasured object of the ActiveViewPort (if exist) or the ActiveLayOut (model or a layout).

GridMode: Get/Set a boolean value that specifies if the ActiveLayOut grid is drawn or not.

GridSpaceX: Get/Set the distance (dx) of the dots of the ActiveLayOut grid in drawing units.

GridSpaceY: Get/Set the distance (dy) of the dots of the ActiveLayOut grid in drawing units.

GridStyle: Get/Set the vdRender.GridDrawingStyle style that used to draw the grid on the active ActiveLayOut.

GripBlock: Get/Set a vdDocument.VdConstGripBlock value that controls the display of the grips of the vdInsert object.

GripMoveInVisibleTypes: Get/Set a string value representing the entity type names for which the original position will be invisible while moving grip points.

GripSnap: Get/Set a value representing if the mouse is locked in the center of the grip rectangle when the mouse pointer enters the grip rectangle.

GroupGrips: Controls The behaviour of the grips when an entity belongs to a group.

Groups: Get the vdGroups collection of the document.

HandleCurrent: Returns the last handle id used from the document.

HandleTableGuid: Returns the table that Keep all Vdraw Objects assigned with a unique Guid . In order to work the vdDocument.FileProperties.UseGuidHandleTable must be set to true.

HatchPatterns: Get the vdHatchPatterns of hatch patterns of the document.

IgnoreLockLayers: Get/Set a value representing if the lock layers are taken into consideration.

ImageSaveJPGQuality: Get/Set the default image quality (0=lowest to 100=highest) when saving in a raster JPG image using the SaveAs(string, Image) method and the vdPrint to export to image.

ImageSaveSize: Get/Set the default image size (height pixels) when saving in a raster image(BMP,EMF etc...) using the SaveAs(string, Image) method.

Images: Get the vdImages collection of the document that contains all Images used by this vdDocument object.

Initialized: Returns true if object is properly initialized

InsUnits: Get/Set a value of vdDocument.InsUnitsEnum type used for scaling when inserting blocks from a drawing or attach ExternalReferences.

IsDisposed: Returns if this object is Disposed, usually after Dispose() call

IsModified: Get/Set if a document is modified.

IsTopMostDocumet: Returns true if this document object is reference equal to TopMostDocumet

KeepAttributeHeight: Get/Set a value representing if an attribute inserted to a scaled block will get the tranformation of the insert or will keep it's height.

LastPoint: Get the last picked point, from user actions.

LayOuts: Get the vdLayouts collection of the document.

Layers: Get the vdLayers collection of the document.

LensAngle: Get/Set lhe lens angle in degrees of the ActiveViewPort(if exist) or the ActiveLayOut(model or a layout).

LicVal: Get/Set the license to use the control in a webpage.

Lights: Get the vdLights collection of the document.

Limits: Get/Set the lower-left and upper-right limits of the ActionLayout used for grid displaying in UCS as Box object type.

LineTypeScale: Get/Set the active linetype scale of the document used to draw vdFigure entities referenced to a vdLineType.

LineTypes: Get the vdLineTypes collection of the document.

LineWeight: Get/Set the VdConstLineWeight value of the document. This value is used when a vdFigure object has LW_DOCUMENTDEFAULT as lineweight.

LineWeightDisplay: Get/Set a boolean value representing if the line weights of the objects will be displayed or not.

LineWeightDisplayScale: Get/Set the scale factor for displaying line weights on screen for model space only.

LockLayerFadeEffect: Get/Set the color Fading effect percentage for all objects on locked layers, close to the background color of output rendering.

LockLayerMethod: Get/Set a vdDocument.LockLayerMethodEnum value representing how entities in Lock layers are used in methods.

LockLayerMethodStack: A stack for using push,pop to modify the LockLayerMethod.

MatchXproperties: Returns the active vdDocument.MatchXpropertiesFlag logic.

MeterProgress: Get the ProgressMeter object of the document.

MirrorText: Controls how the CmdMirror(object, object, object, object) command reflects vdText entity.

Model: Gets the document's model layout.

MouseElevation: Get/Set a value in Drawing Units used to add a Zvalue to mouse position relative to Current UCS.

MouseLogic: Gets or sets the vdDocument.MouseLogicEnum of mouse button clicks.

MouseWheelZoomScale: Get/Set the zooming scale used when zooming with the mouse wheel.Set this value under 1.0 to inverse the mouse wheel operation.

MultilineStyles: Get the vdMultilineStyles instance representing the multiline styles defined in the document.

NamedUCSs: Get the vdNamedUCSs collection instance representing the named UCS definitions contained in the document.

OffsetDistance: Get/Set the Distance in drawing units that will be used as default value for the Offset command.

Openflags: Get/Set the vdDocument.OpenFlagsEnum when opening a file to the document.

OrbitActionKey: Get/Set a combination of a key stroke and a mouse button value of type vdDocument.KeyWithMouseStroke , used to begin a 3d orbit command.

OrthoMode: Get/Set the orthomode property of the document used when the OverAllActiveAction is waiting for a user point referenced by an other one. If true Constrains cursor movement to the perpendicular.

OrthoModeAxis: Defines the axis where the Ortho is limited on when OrthoMode is true.

OsnapCrossMarksCount: Get/Set the number of temporary cross Osnaps that are added to the active action list. Default value is 20. If items reach the maximum number of temporary cross Osnaps then the first added temporary cross Osnap is removed from the list when a new temporary cross Osnap is added.
This property is static and applies to all documents of the application.

OsnapCrossPointsAddvalue: Represents a value that controls if the extra cross-help type of OsnapPoints will be added.

OsnapDialogButton: Get/Set a MouseButtons value used in combination with OsnapDialogKey to show the OsnapDialog.

OsnapDialogKey: Get/Set a Keys value used in combination with OsnapDialogButton to show the OsnapDialog.

OsnapExtensionLockKey: Get/set the keyboard modifier key that lock/unlock the current Osnap Extension.
Default value is SHIFT for no lock extension lock. It is used durring the user action of selecting an Osnap by moving the cursor over objects and when the
Osnap or PolarTrack or OsnapTrack or Ortho is activated then by holding down this key the user can lock this track line and all result osnaps are projective to this locked track line.
The user can select this snap by pressing the mouse button Releasing the locked button key, the track line is unlocked and the osnaps are not projective to it anymore. This property is static and applies to all documents of the application.

OsnapExtensionMarksCount: Get/Set the number of extension temporary cross Osnaps that are added to the active action list.

OsnapMarksClearKey: Get/Set the keyboard modifier key that clears the temporary cross Osnaps.
Default value is CONTROL + SHIFT. It is used durring the user action of selecting an Osnap By moving the cursor over objects and when an Osnap is find it saved in the temporary cross Osnaps list and they are drawn as crosses, this is used to help the user to find the Osnap points when the cursor is close to them.
This property is used to give the user the ability to clear these temporary cross Osnaps by pressing a key combination on the keyboard.
This property is static and applies to all documents of the application.
Alternatively the user can clear the temporary cross Osnaps by calling ActiveLayOut.OverAllActiveAction.ClearTemporaryOsnaps().

OsnapModePreserve: Get/set a boolean value that represents the behaviour of the osnapmode.

OsnapModeVisibilty: Get/set the osnaps that will excluded if they are not visible in 3d.

OsnapTrack: Controls how the Object Snap Tracking works.

OsnapTrakingMarksMarksCount: Get/Set the number of tracking Osnaps that are added to the active action tracking list.

PLineDrawFlag: Get/Set a value that represents how Widths are drawn.

Palette: Get the vdPalette collection of standard colors for the document.

PanMouseButton: Get/Set a vdDocument.PanMouseButtons value to start the pan action.

PenCapsSquare: Get/Set a static value which represents if the lines with width ends with square or round cap.

PerspectiveMod: Get/Set the perspective mode as vdRender.VdConstPerspectiveMod of the ActiveViewPort (if exist) or the ActiveLayOut (model or a layout).

Pixel2ViewMatrix: Get the Matrix used for transformations between pixels and view coordinates of the ActiveViewPort(if exist) or the ActiveLayOut(model or a layout).

PointStyleMode: Get/Set the point style mode of the document used to draw a vdPoint entity.

PointStyleSize: Get/Set the point style size of the document used to draw vdPoint entity.

PolarTrack: Enable/disable the polar track behaviour of the document.Also PolarTrackAngle must be specified.

PolarTrackActionFlag: Get/Set additional flags that controls the PolarTrack with user actions.

PolarTrackAngle: Get/Set the polar track angle of the document in radians.

PolarTrackDispProps: Get the PolarTrack tooltip window display properties as ToolTipDisplayProps.

PolarTrackInfinityLineDraw: Get/Set the draw of the infinity line. If true the infinity line will be rendered.

PolarTrackLock: Get/Set the polar track lock property .If true constrains cursor movement only to the PolarTrackAngle direction.

PrimaryCount: Get the number of all vdPrimary objects of the document.

ProjectionTrimExtend: This is a system variable (it is not saved with the Document) and controls how trim and extend commands work.Intersections between objects are controled by this variable.

ProxyClasses: Gets vdProxyClasses collection of the document used for custom objects.

RenderMode: Get/Set the vdRender.Mode render mode of the active viewport(if exist) or the active layout(model or a layout) of the document.

RenderingFilter: Represents the filter effect that will be applied to the active view after the rendering results.

RenderingQuality: Specifies the vdRender.RenderingQualityMode quality.

SelectActionKey: Get/Set a key value used in combination with mouse-down to add or remove selected item(s) from a selection.

SelectionPreviewDownKey: Get/Set a keyboard key value , used to circle through highlighted entities.

SelectionPreviewUpKey: Get/Set a keyboard key value , used to circle through highlighted entities.

Selections: Get the vdSelections collection of the document.

ShareLists: Get/Set a value of vdDocument.ShareListsEnum that controls the sharing of opengl lists between model entities and viewports.

ShowHatches: Get/Set a boolean value representing if the hatches of filled object will be shown.Default value is true. ShowHatches

ShowHidenEdges: Get/Set a boolean value representing if the edges of the 3dFace object will be shown.

ShowUCSAxis: Get/Set a value representing if the axis for all layouts or viewports will be drawn.

SketchDistance: Get/Set the Distance in drawing units that will be used as default value for the sketch command.

SmoothAngle: Get/Set the angle in degrees between 0 and 90 used to calculate normals for each vertex in each face when rendering a polyface object. Defines the maximun angle which is compared with the angles between the planes of neighboring faces in order to filter out the normals of the planes that will added in the average calculation.

SnapAngle: Get/Set the snap and grid angle in radians for the active ActiveLayOut. Default value 0.0.

SnapBase: Get/Set the snap and grid base point in World Coordinate System(WCS) for the active ActiveLayOut.

SnapIso: Get/Set the vdRender.VdConstSnapIso style that used to draw the grid on the active ActiveLayOut.

SnapMode: Get/Set a value for active ActiveLayOut that enables/disables the cursor to move only over the grid dots.

SnapModeAffect: Get/Set a value that defines how Snap affects mouse movements for active ActiveLayOut .

SnapSpaceX: Get/Set the snap distance (dx) in Drawing Units for the active ActiveLayOut.

SnapSpaceY: Get/Set the snap distance (dy) in Drawing Units for the active ActiveLayOut.

SnapStyle: Get/Set the vdRender.VdConstSnapStyle style that used to draw the grid on the active ActiveLayOut.

SortGripWindowSelection: Defines if the user Window or Crossing Grip Selection will be sorted according to the EntitySelectMode Default value is false in order entities to be added in the Grip selection according to the order of their owner list.

SortSelection: Defines if the user Window or Crossing Selection will be sorted according to the EntitySelectMode Default value is false in order entities to be added in the selection according to the order of their owner list.

SupportPath: Get/Set the support path of the document.

TextStyles: Get the vdTextstyles collection of the document.

TimerInterval: Gets or sets the time, in milliseconds, before the OnTimer event is raised relative to the last occurrence of the OnTimer event

ToolTipDispProps: Get the ToolTip window dispaly properties as ToolTipDisplayProps type.

ToolTipText: Get/Set a string representing the Tooltip of the object.

TopMostDocumet: Gets the vdDocument that this object belongs to.

UndoHistory: Maintains the stack of redo and undo logs.

UrlActionKey: Get/Set a Keys value used in combination with mouse-down to execute the URL.

UrlActionMouse: Get/Set a value used to control how URLs of vdFigure objects will open. Default value is SingleClick. If DoubleClick is selected then there is no need to press the UrlActionKey on the keyboard.

User2WorldMatrix: Get the Matrix used for transformations between user and world coordinate system of the ActiveViewPort(if exist) or the ActiveLayOut(model or a layout).

UserTables: Get the user defined table collection of vdTables type. Used to store application specific user data as vdXProperties

Version: Get/Set the version of the file opened to the document.

View2PixelMatrix: Get the Matrix used for transformations between view coordinates into pixels of the ActiveViewPort(if exist) or the ActiveLayOut(model or a layout).

View2WorldMatrix: Get the Matrix used for transformations between view and world coordinates of the ActiveViewPort(if exist) or the ActiveLayOut(model or a layout).

ViewCenter: Get/Set the coordinates of the center point of ActiveViewPort (if exist) or the ActiveLayOut (model or a layout) in Display Coordinate System.

ViewCube: Returns the vdViewCube object that manage the View 3d cube over the screen.

ViewSize: Get/Set the viewsize in Drawing Units of the ActiveLayOut (model or a layout) of the document or the ActiveViewPort (if exist) of active layout.

ViewportLTScale: Controls the scaling of linetypes drawn inside a viewport of ActiveLayOut object.

Views: Get the vdViews collection of the document.

WalkThroughKeys: Get/Set a vdDocument.WalkThroughKeysClass class which contains the keys used for Walkthrough action.

World2PixelMatrix: Get the Matrix used for transformations between world coordinates into pixels of the ActiveViewPort(if exist) or the ActiveLayOut(model or a layout).

World2UserMatrix: Get the Matrix used for tranformations between world and user coordinate system of the ActiveViewPort(if exist) or the ActiveLayOut(model or a layout).

World2ViewMatrix: Get/Set the Matrix used for transformations between World Coordinate System(WCS) and View Coordinate System(VCS) for ActiveViewPort (if exist) or ActiveLayOut.

XrefFadeEffect: Get/Set the color Fading effect percentage for all External reference drawings, close to the background color of output rendering.

XrefUndo: Get/Set a boolean value representing if ExternalReferences documents uses this Document UndoHistory .

Xrefs: Get a collection of vdDocuments types containing all External References of the Document.
Typically this collection is updated by setting a ExternalReferencePath.of a vdBlock to an existing drawing file.

aunits: Get/Set the AUnits angular units used to the document.

lunits: Get/Set the LUnits linear units used to the document.

osnapMode: Get/set the active object OsnapMode type snap modes.

Methods

ActionAdd(BaseAction): Adds the specified VectorDraw.Actions.BaseAction to the current active layout (model or layout).

ActionDrawFigure(vdFigure): Draw a vdFigure object in ActiveRender and in ScreenRender

ActionDrawFigure(vdFigure, bool): Draw a vdFigure object in ActiveRender and in ScreenRender

ActionOsnapMode(object): Internally used. Returns the osnap mode used by the passed BaseAction object.

ActionRemoveAll(bool): Remove all actions from the model,all layouts and all viewports.

ActionRemoveAll(bool, bool): Remove all actions from the model,all layouts and all viewports.

ActionRemoveLast(bool): Removes the last action submitted to the ActiveViewPort(if exist) or the ActiveLayOut(model or any layout).

AddCurentZoomToHistory(): Add the current zoom (ViewCenter , ViewSize and World2ViewMatrix) in object zoom history in order to reset it with ZoomPrevious() method

AddObjectHandleToTable(vdObject): Creates a new handle for the object(if it's handle is 0) and registeres this object to the document.

CCS_CursorPos(): Get the cursor's porition in active User Coordinate System.

ClearAll(): Clears everything (tables , active properties , entities collections etc...) from the document. Call EnsureDefaults() method to initialize the document again.

ClearEraseItems(): Clears the undo history and all primary items marked as deleted from their collections.

ClearLayoutEntities(vdLayout): Removes ALL the entities from a layout. Also clears the undo history.

ClearPassWord(string): Remove the password of the passed drawing from the password store

Compare(vdDocument): Compares this document's Model Entities with the passed document.

CreateFromSelection(vdSelection): Creates and returns a new vdDocument contaning all vdFigure objects from a vdSelection object.

CreateNewHandle(): Creates and returns a new handle taken into consideration the current maximum handle of the document.The HandleCurrent is taking the return value.

CursorPos(Point): Get the cursor's position in World Coordinate System.

CursorPosCCS(Point): Get the cursor's position in active User Coordinate System.

DeSerialize(DeSerializer, string, object): This Function is called foreach field name of the vdDocument object when opening in vdml format.

DeleteUnusedTables(vdLayers, vdBlocks, vdDimstyles, vdLineTypes, vdTextstyles, vdImages, vdHatchPatterns): This method should be used in order to delete multiple primaries objects. It is much faster than setting Deleted = true to the primary directly.

Dispose(): Performs tasks associated with freeing, releasing, or resetting the necessary memory objects. After calling this method the vdDocument object is not available.

DrawScreenTemporary(vdSelection): Temporary draw entities on the screen. It is not necessary to add to the document Layout Entities collection the vdFigures that are passed to this method.

EnsureDefaults(): Ensures the existance of the necessary objects for the Document.

ExportDistributionFiles(ref StringArray, string, string, string, bool): Saves and returns all the necessary file dependecies of the drawing.(Images,FontFiles,External reference drawings).

ExportDistributionFiles(ref StringArray, string, string, string, RasterImageType, bool): Saves and returns all the necessary file dependecies of the drawing.(Images,FontFiles,External reference drawings).

ExportMultiPagePDF(vdPrintArray, string): This method can be used in order to create multi page PDF files.

ExportScript(string, bool, string[], object[], out string[]): Converts and exports the document to the appropriate format in order to be opened by the vdWeb library.

ExportScript(string, object, object): Converts and exports the document to the appropriate format in order to be opened by the vdWeb library.

ExportScript(string, string[], object[]): Converts and exports the document to the appropriate format in order to be opened by the vdWeb library.

ExportScript(string, ExportScriptFlags, uint, char[], int, vdPrimariesList): Converts and exports the document to the appropriate format in order to be opened by the vdWeb library.

ExportScriptAsMemoryStream(): Export the document as .vds web format into a MemoryStream

ExportToFile(string): Saves the current drawing to the specified filename.

~vdDocument(): object de-constructor

FindFile(string, bool, out string): Finds the specified filename and returns the path where the file is.

FindFile(string, out string): Finds the specified filename and returns the path where the file is.

FindFromHandle(vdHandle, Type): Finds a vdObject belonging to the Document from a specified Handle.

FromScriptData(string): Load this vdDocument from the passed string data that represents the contents of a VDS file.ToScriptData(ExportScriptFlags, uint, char[], int, vdPrimariesList)

GarbageCollector(): Clears the memory from the garbage objects.

GetActiveSections(): Returns a new collection of vdSectionClip that applied to the active rendering context and contains at maximum limited the first MAX_SECTIONS enabled Section Clips.

GetAllXpropertiesNames(): Searches all Xproperty names from all vdPrimary objects of the document.

GetBigSHXFonts(): Get all big SHX fonts existing in the SupportPath directory.

GetEnvironmentVariable(string): Retrieves the value of an environment variable from the current process.

GetExternalReferences(): Gets the external references of the document.

GetFileActivator(string): Gets the Activator of a (vdml or vdcl) supported file.

GetFileProperties(string): Gets the FileProperties of a (vdml or vdcl) supported file.

GetGripFromPoint(gPoint, ref int): Gets the grip point from an entity at a specified location.

GetGripSelection(): Returns a selection with all visible entities that have ShowGrips property true.

GetImageFromFile(string): Get the preview of a file.The file can be either an supported image(JPG,BMP etc...) or vdml,vdcl.

GetModel2dProjection(gPoint, Vector, double): returns a collection of line segments that represents the 2d projection of the clipping for all objects in the Model Layout.

GetNextValidHandle(): Returns the Next handle that is going to be generated from CreateNewHandle()

GetOpenFileNameDlg(short, string, short): Displays the OpenFile dialog with a preview image.

GetOpenFileNameDlg(short, string, short, Control): Displays the OpenFile dialog with a preview image.

GetOpenImageFileDlg(): Displayes The OpenFile dialog to select the supported image raster formats.

GetPrimaries(bool): Get all vdPrimary objects from the document.

GetSHXFonts(): Get all SHX fonts existing in the SupportPath directory.

GetSaveFileNameDlg(string, out string): Displays the SaveFile dialog so the user can pick a filename.

GetSortedHandleTable(): Returns a copy of handle table in ascending order

GetTTFFileName(string, Dictionary<string, string>): Returns the font file for a specific TTF Font name.

GetTTFFileNames(): Returns a dictionary containing TrueType Font names and their .ttf fontfile

GetTTFFontName(string, Dictionary<string, string>): Returns the font name for a specific TTF Filename.

GetTTFFonts(): Gets all TTF fonts installed to the system in a StringArray collection.

GetTableDependecies(vdTableDependeciesArgs): Fills the passed vdTableDependeciesArgs args with all the table (vdLayer, vdBlock, vdDimstyle, vdLineType, vdTextstyle, vdImageDef, vdHatchPattern etc) that have references at least to one object .

GetUnUsedTables(vdLayers, vdBlocks, vdDimstyles, vdLineTypes, vdTextstyles, vdImages, vdHatchPatterns): Fills the passed parameters collections with the unused items of the document of each type.

GetUnUsedTables(vdTableDependeciesArgs): Fills the passed vdTableDependeciesArgs args with all the table (vdLayer, vdBlock, vdDimstyle, vdLineType, vdTextstyle, vdImageDef, vdHatchPattern etc) that have no references.

GetUsedBlocks(): Get all vdBlock objects that are used in the document.

GetUsedDimStyles(): Get all vdDimstyle objects that are used in the document.

GetUsedImages(): Get all vdImageDef objects that are used in the document.

GetUsedLayers(): Get all vdLayer objects that are used in the document.

GetUsedLineTypes(): Get all vdLineType objects that are used in the document.

GetUsedMultiLineStyles(): Get all vdMultilineStyle objects that are used in the document.

GetUsedPatterns(): Get all vdHatchPattern objects that are used in the document.

GetUsedTables(vdLayers, vdBlocks, vdDimstyles, vdLineTypes, vdTextstyles, vdImages, vdHatchPatterns): Fills the passed parameters collections with the used items of the document of each type.

GetUsedTables(vdTableDependeciesArgs): Fills the passed vdTableDependeciesArgs args with all the table (vdLayer, vdBlock, vdDimstyle, vdLineType, vdTextstyle, vdImageDef, vdHatchPattern etc) that have references at least to one object .

GetUsedTextStyles(): Get all vdTextstyle objects that are used in the document.

GetVisibleArea(vdEntities, Vector, double): Get the visible area of passed entities at the specified view direction

GetVisibleArea(vdEntities, vdSelection, Vector, double): Get the visible area of passed entities at the specified view direction

GetVisibleAreas(vdEntities, vdSelection, double): Create a PrimitivesExport.VisibleAreas object that is used to get the visible areas of passed entities at any view direction

GetVisibleAreas(vdEntities, vdSelection, double, int): Create a PrimitivesExport.VisibleAreas object that is used to get the visible areas of passed entities at any view direction

ImportFromFile(string): Imports the specified file into this vdDocument.

ImportScript(string): Import a .vds web format

ImportScriptFromStream(Stream): Import a .vds web format from a Stream

ImportWebScriptCommands(string, string): Imports commands that was saved by VectorDraw JavaScript web control

InitBaseAction(object, ref BaseAction): Fires the OnInitBaseAction event.

InternalSetMeterProgress(ProgressMeter): Internally used only by VectorDraw FrameWork. Temporary change the refence of MeterProgress

Invalidate(): Post a refresh in the bounding area of the control.

Invalidate(Rectangle): Post a refresh in a given rectangle of the control.

Invalidate(Box): Post a refresh in the bounding area of the specified box.

Invalidate(Box, double): Post a refresh in the bounding area of the specified box.

IsObjectDependOn(vdBaseObject, vdPrimary): Checks if a vdPrimary object is used-depended in a vdBaseObject.

IsTableObjectDependOn(vdPrimary): Checks if a vdPrimary is depended-used in the document.

IsvalidOpenFormat(string): Checks if the filename extension is supported for open in VectorDraw.

IsvalidOpenRasterFormat(string): Checks if an image is supported from VectorDraw.

IsvalidSaveFormat(string): Checks if the filename extension is supported for save in VectorDraw.

LoadFromClipboard(): Loads a Document from Clipboard data.

LoadFromDataBuffer(ref byte[], int, int, string): Load the drawing from the passed bytes array data

LoadFromMemory(Stream): Loads a Document from a stream.

LoadFromMemory(Stream, bool): Loads a Document from a stream.

LoadFromStream(Stream, string): Load the drawing from the passed stream

MergeSelection(vdSelection): Add a copy of the entities and all table dependecies of the selection in ActiveLayout

MergeTables(vdDocument, bool, bool): Merges all tables (table objects like layers, blocks, textstyles etc.) from another document to this document.

MergeTables(vdDocument, bool, MergeTablesFlags): Merges all tables (table objects like layers, blocks, textstyles etc.) from another document to this document.

New(): Clears the Document and initializes default values.

Open(string): Opens the given supported file into this document. Can be a VDML, VDCL, DWG, DGN, DXF, IFC, DWF, STEP OBJ PLY SKP STA STL , image formats (bmp jpg tiff png), PDF, RTF, LAS/PointCloud, metafile or a supported script/web format.

PopMatchXproperties(): Restore previous PushMatchXproperties(MatchXpropertiesFlag) change.

PostCommandActionString(Control, string): Posts a string which will be translated by the given Control and will be parsed by the active Action.

Prompt(string): Adds a new string to the prompt stack.

Purge(): Deletes all unused table objects such as vdLayer, vdBlock, vdDimstyle, vdLineType, vdTextstyle, vdImageDef and vdHatchPattern objects from the document.

PushMatchXproperties(MatchXpropertiesFlag): Select a different MatchXproperties logic as active.

RaiseActionEnd(string): Raises the ActionEnd event with passed action command name

RaiseActionError(string): Raises the ActionError event with passed action command name

RaiseActionStart(string): Raises the ActionStart event with passed action command name

RaiseExportedExtraFiles(string, string[]): Raise OnExportedExtraFiles when saving to file types that also export additional files

RaiseGenericError(string, string): Raise the GenericError event.

RaiseGetPassWord(string, ref string): Opens a dialog to request a password for a password protected file.

RaiseLoadUnknownObjects(LoadUnknownObjectsEventArgs): Raise the LoadUnknownObjects event.

RaiseOnAfterNewDocument(vdDocument): Raise the OnAfterNewDocument

RaiseOnAfterOpenDocument(vdDocument): Raise the OnAfterOpenDocument

RaiseProgress(long, string): Raise the OnProgress

RaiseProgressEx(int, string): Internally used only.Raise the OnProgress

Redraw(bool): Redraws the client area of the active control window.

RegisterObjectHandle(vdObject, vdHandle): Registeres a handle to an object.

ReloadExternalReferences(): Reloads all external References of the Drawing from their existing path.

ResolveHandles(): This method will reset all handles of the drawing and also set it's maximum handle. This method should be used if the maximum handle of the drawing becomes very big. Every change of handle will raise OnObjectHandleChanged event so the user can handle this change if there is a handle connection somewhere else.

SaveAs(string): Saves the current document to the specified file path.

SaveAs(string, Image): Saves the document to the specified file path. Optionally embeds a preview image into the saved file. The method supports native VectorDraw serialized formats (".vdml" and ".vdcl") and other export formats (dwg dgn dxf vds pdf ifc skp stl dwf dae obj ply svg hpg wmf emf jpg bmp png) via ExportToFile(string).

SaveAs(string, Image, string): Saves the document to the specified fileName using the provided preview image and forcing the specified version for the save operation.

SaveToDataBuffer(string): Exports the document to a byte array using the file format defined by the passed fileTypeExtension.

SaveToMemoryStream(string): Exports the document to a memory stream using the file format defined by the passed fileTypeExtension.

ScrollActiveActionRenderView(double, double, bool): Scrolls the view of the Active Action Render by cx and cy.

Select3d(Point, int): Selects entities at a given point and a given box size.Returning items are sorted depend of their depth form current eye view from nearest to farest.

Select3d(Point, int, bool): Selects entities at a given point and a given box size.Returning items are sorted depend of their depth form current eye view from nearest to farest.

SelectActivelayout(vdLayout): Select the ActiveLayOut for the Document object.

SendCommandActionString(string): The ActiveAction of the ActiveLayOut parses the given string immediately.

Serialize(Serializer): This Function is called when saving the vdDocument object to vdml format.

SetActiveHatchProperties(vdHatchProperties): Set the ActiveHatchProperties property with a new value and returns the old one.

SetActiveLayer(vdLayer): Set the ActiveLayer property with a new value and returns the old one.

SetActiveLineType(vdLineType): Set the ActiveLineType property with a new value and returns the old one.

SetActiveLineWeight(VdConstLineWeight): Set the ActiveLineWeight property with a new value and returns the old one.

SetActivePenColor(vdColor): Set the ActivePenColor property with a new value and returns the old one.

SetActivePenWidth(double): Set the ActivePenWidth property with a new value and returns the old one.

SetActiveTextStyle(vdTextstyle): Set the ActiveTextStyle property with a new value and returns the old one.

SetCurrentHandle(ulong): Sets the current handle to be used to the next inserted object.

SetXrefLayerProperties(string, bool, bool, bool, vdLineType, vdColor, VdConstLineWeight): Change the properties of an External Reference Layer.

ShowToolTip(bool): Shows/Hide the the tooltip from the screen.

ToScriptData(ExportScriptFlags, uint, char[], int, vdPrimariesList): Save the document to a string that represents the contents of a VDS file in order to be opened by the vdWeb library.

ToStream(): Saves and returns a Memory Stream containing all objects of the document.

ToStream(bool): Saves and returns a Memory Stream containing all objects of the document.

ToString(): Gets a System.String that represents the type name of this object and the FileName property.

TryOpen(string): Opens the file into a temporary document object and if succesfull then loads this temporary document to the current.

UCS(string): Sets the user coordinate system of the active layout.

UCS(Matrix): Sets the user coordinate system of the active layout.

UCS(gPoint, gPoint, gPoint): Sets the user coordinate system of the active layout.

UCSPrevious(): Seta to the active layout the previous User Coordinate System(UCS).

Update(): Updates the objects and collections of the vdDocument object after change of properties.

WndProc(MSG): This is used internally for translating windows messages.

XrefAttach(string, gPoint, vdEntities): Inserts a new External Reference Block.

ZoomAll(): Zooms all drawing area including the Limits of the active layout.

ZoomExtents(): Zooms the drawing area of the active layout so all drawing extends are visible.

ZoomPrevious(): Zooms the drawing area to the previous used zoom of the active layout.

ZoomScale(double): Zooms the drawing area using a given scale factor of the active layout.

ZoomWindow(gPoint, gPoint): Zooms the drawing area to a specified window of the active layout.

Events

ActionAdded: Fires just after a BaseAction is added to active actions stack.

ActionEnd: Fires when a command action is finished.

ActionError: Fires when an command action is canceled with an error.

ActionFinish: Fires when a BaseAction is finished.

ActionLayoutActivated: Fires after ActiveLayOut property is changed.

ActionLayoutBeforeDeActivated: Fires before ActiveLayOut property is de-activated.

ActionParse: Fires before a user string is parsed from the active action.

ActionStart: Fires before a command action is started.

FilterActionPoint: Fires after an action waiting a point is finished.

GenericError: Fires when an error occurs in a method or property.

GetDimensionText: Fires before the dimension's text is calculated

GetPassWord: Fires before open a password protected drawing.

GripSelectionBeforeModify: Occurs before an item is added or remove from the default active gripSelection, in case theEnableAutoGripOn is true.

GripSelectionModified: Fires when vdFigure objects are added or removed in the active grip selection.

LoadUnknownObjects: Fires when an Unknown objects is loaded from a document after an open command.

OnActionDraw: Occurs when an action requests a draw operation and before default VDF operations are performed.

OnActionDrawOsnap: Occurs when an action requests an object-snap (osnap) specific draw operation and before VDF default operations.

OnActionJobLoop: Fires Continually when an action is active and started .

OnActionJobLoopEx: Fires Continually when an action is active and started .

OnActionMouseMove: Fires after a Mouse move operation of active action is finished.

OnAddItem: Fires before an object register with the vdDocument is added to a collection.

OnAfterAddItem: Fires after an object register with the vdDocument is added to a collection.

OnAfterModifyObject: Fires after a change to a property of an object.

OnAfterNewDocument: Fires after the New() method.

OnAfterOpenDocument: Fires after opening a file.

OnAfterUndoStoreValue: Fires after a property of an object is stored in the undo-redo stack.

OnBeforeDocumentClear

Event is Fired before vdDocument object is cleared.

Overwrite it in order to do additional clear of other custom user resources

OnBeforeModifyObject: Fires before a change to a property of an object.

OnBeforeOpenDocument: Fires before opening a file.

OnCommandExecute: Fires when application runs under Mono and after a PostCommandActionString(Control, string) or SendCommandActionString(string) call and the active Action does not Parse.

OnDraw: Fires before all figures are drawn.

OnDrawAfter: Fires after all figures are drawn.

OnDrawAfterFigure: Fires after a vdFigure is drawn.

OnDrawBackground: Fires before the draw of the background.

OnDrawFigure: Fires before a vdFigure is drawn.

OnDrawOverAll: Fires after all entities was drawn and before the coordinate axis is drawn and the graphics updated on screen.

OnDrawScene: Fires when drawing the entire scene.

OnEraseObject: Fires before an object is set as deleted.

OnExportedExtraFiles: Fires when a drawing is saved and additional needed files was created.For example when expoting to SVG file.

OnFigureDrawGrips: Fires before the draw of the grip points of a vdFigure object.

OnFigureMouseOver: Event fired when the mouse is over an entity.

OnFilterFigure: Fires when an object is inserted into a collection.

OnFilterOsnap: Fired before an OsnapPoint added into the active selected Osnap collection.

OnFilterSnapPoint: Occurs when moving the mouse and the SnapMode is On and according to the SnapModeAffect.

OnGetFileImagePreview: Fires when the opendialog is called in order to display a preview image of a file that is not supported.

OnGetGripPoints: Fires before GetGripPoints() method.

OnGetOpenFileFilterFormat: Fires before the open dialog in order to filter the supported open extensions.

OnGetSaveFileFilterFormat: Fires before the open dialog in order to filter the supported save extensions.

OnInitBaseAction: Fires before the default BaseAction is added to the action stack of the document.

OnIsValidOpenFormat: Fires before Open(string) method and when the file's extendion is not implmented from VectorDraw.

OnIsValidSaveFormat: Fires before SaveAs(string) method and when the file's extension is not implemented from VectorDraw.

OnLoadUnknownFileName: Fires When an unsupported file extension is opened.

OnMoveGripPointsAt: Fires when a default move of a grip point of a vdFigure object.

OnNoFileFind: Fires when a file is not found to the support path.

OnObjectHandleChanged: Fired after a dublicate handle of an object is changed

OnOpenUrl: Fires before the default execution of the explorer opening a URL.

OnPolarTrackAngleValidate: Fires when the PolarTrack angle need validation and the PolarTrack is set to true.

OnPolarTrackToolTip: Fires before the PolarTrack Tooltip display.

OnProgress: Fires when a progress operation is changed.

OnProgressStart: Fires when the Progresses meter initialize.

OnProgressStop: Fires when the Progresses meter terminated.

OnPrompt: Fires when a Prompt(string) method is called.

OnRequestLicVal: Fired after downloading a url file and before open it.

OnResizeControlWindow: Fires when the control is resized.

OnSaveUnknownFileName: Fires When an unsupported file extension is saved.

OnScroll: Fires when a scrolling action is commited.

OnSelectionsAddItem: Occurs before adding one item to the Selections.

OnSelectionsRemoveAllItems: Occurs before removing all items from the Selections.

OnSelectionsRemoveItem: Occurs after removing an item from the Selections.

OnThreadFinished: Fires when a vdDocument.IvdThread thread is finished.

OnTimer: Occurs when the specified TimerInterval has elapsed and the timer is enabled.

OnUndoStoreValue: Fires before a property of an object is stored in the undo-redo stack.

OnVDSObjectHandleChanged: Fired after a dublicate handle of an object is changed durring export to a VDS file

OnViewCubeClick: Event is Fired before default action of a ViewCube (click) executed.