Click or drag to resize

Document Class

RootPro Represents one drawing file open in CAD.
Inheritance Hierarchy
SystemObject
  RootPro.RootProCADDocument

Namespace:  RootPro.RootProCAD
Assembly:  RootPro.RootProCAD.Library (in RootPro.RootProCAD.Library.dll) Version: 9.0.0.0 (9.0.0.0)
Syntax
public abstract class Document

The Document type exposes the following members.

Constructors
  NameDescription
Protected methodDocument
Initializes a new instance of the Document class
Top
Properties
  NameDescription
Public propertyAnglePrecision
Acquires or sets the accuracy of the angle (number of decimal places).
Public propertyAngleUnitFormatType
Get or set the notation type of angle.
Public propertyBalloonSettings
Get the default value of the balloon setting.
Public propertyBalloonSettingsStyles
Get a collection of balloon's configuration styles.
Public propertyBasicShapeSettings
Get the default value of general figure setting.
Public propertyBasicShapeSettingsStyles
Get a collection of setting styles for general shapes.
Public propertyColors
Get a collection of colors.
Public propertyCurrentBalloonStyleName
Get or set the current balloon setting style name.
Public propertyCurrentBasicShapeStyleName
Get or set the current general graphic setting style name.
Public propertyCurrentDimensionStyleName
Gets or sets the current dimension setting style name.
Public propertyCurrentDrawing
Gets or sets the current partial map.
Public propertyCurrentHatchStyleName
Gets or sets the current hatching style name.
Public propertyCurrentLayout
Get or set the current layout.
Public propertyCurrentLeadStyleName
Gets or sets the current leader setting style name.
Public propertyCurrentPointMarkerStyleName
Gets or sets the current dot mark setting style name.
Public propertyCurrentTextStyleName
Gets or sets the current character setting style name.
Public propertyCustomHatchs
Get a collection of user defined hatches.
Public propertyDimensionSettings
Gets the default value of dimension setting.
Public propertyDimensionSettingsStyles
Get the collection of dimension setting styles.
Public propertyDotSize
Gets or sets the size of point (dot).
Public propertyDrawings
Acquire a collection of partial drawings.
Public propertyFileFormat
Get the format of the file.
Public propertyFullName
Get the full path of the drawing file including the drive / folder name.
Public propertyHatchSettings
Get the default value of hatch setting.
Public propertyHatchSettingsStyles
Get a collection of hatching setting styles.
Public propertyLayerTable
Get LayerTable representing all layers in the drawing.
Public propertyLeadSettings
Get the default value of the setting of the leader line.
Public propertyLeadSettingsStyles
Get a collection of setting style of leader line.
Public propertyLengthPrecision
Acquires or sets the precision of the length (number of decimal places).
Public propertyLengthUnitFormatType
Get or set the notation type of length.
Public propertyLineCapMode
Get or set the line end display mode.
Public propertyLineJoinMode
Get or set the display mode of the corner of the line.
Public propertyLinetypes
Get the collection of linetypes.
Public propertyLinetypeScaleFactor
Get or set the scale of the line pitch length.
Public propertyLinetypeScalingMode
Get or set scale mode of line pitch length.
Public propertyLinewidths
Get a collection of line widths.
Public propertyMasterDrawComponents
We will get a collection of drawing component definitions.
Public propertyName
Get the name of the drawing.
Public propertyPaperLinetypeDisplayMode
Gets or sets the line pitch display mode of the paper.
Public propertyPaperLinewidthDisplayMode
Get or set line width display mode of paper.
Public propertyPartLinetypeDisplayMode
Get or set the line pitch display mode of the partial drawing.
Public propertyPartLinewidthDisplayMode
Get or set the line width display mode of the partial drawing.
Public propertyPointMarkerSettings
Acquires the default value of point mark setting.
Public propertyPointMarkerSettingsStyles
Acquires a collection of style mark setting styles.
Public propertyPrintSettings
Acquire printing settings.
Public propertyReadOnly
Get whether the file is read-only.
Public propertySaved
Retrieve whether there are any changes that have not been saved in the drawing.
Public propertySelectionManager
Get the object that manages the selected shape.
Public propertySummaryInfo
Get the properties of the file.
Public propertyTemplateDocument
Get the document of the template.
Public propertyTemplateFileName
Get or set the file name of the template.
Public propertyTextSettings
Get the default value of the character setting.
Public propertyTextSettingsStyles
Get a collection of style setting styles.
Public propertyUndoManager
Obtain an object that manages UNDO / REDO.
Public propertyVersion
Get the version number of the file.
Top
Methods
  NameDescription
Public methodActivate
Activate the drawing.
Public methodAddShape
Add a shape.
Public methodClose
Close the drawing.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetShapeByID
Acquires the figure with the specified record ID.
Public methodGetShapeByNumber
Acquires the figure with the specified figure number.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsValidShape
Check if the specified shape is valid as a figure on the drawing.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnAfterSave
Generate an AfterSave event.
Protected methodOnBeforeSave
Raise BeforeSave event.
Protected methodOnBeginPrint
Raise the BeginPrint event.
Protected methodOnColorItemChanged
Raise the ColorItemChanged event.
Protected methodOnColorsChanged
Raise the ColorsChanged event.
Protected methodOnCurrentDrawingChanged
Raise the CurrentDrawingChanged event.
Protected methodOnCurrentShapeSettingsStyleChanged
Raises the CurrentShapeSettingsStyleChanged event.
Protected methodOnDrawingAdded
Raise the DrawingAdded event.
Protected methodOnDrawingChanged
Raise the DrawingChanged event.
Protected methodOnDrawingDeleting
Raise the DrawingDeleting event.
Protected methodOnEndPrint
Raise the EndPrint event.
Protected methodOnLayoutAdded
Raise the LayoutAdded event.
Protected methodOnLayoutChanged
Raise the LayoutChanged event.
Protected methodOnLayoutDeleting
Raise the LayoutDeleting event.
Protected methodOnLinetypeItemAdded
Raise the LinetypeItemAdded event.
Protected methodOnLinetypeItemChanged
Raise the LinetypeItemChanged event.
Protected methodOnLinetypeItemDeleting
Raise the LinetypeItemDeleting event.
Protected methodOnLinetypesChanged
Raise the LinetypesChanged event.
Protected methodOnLinewidthItemChanged
Raise the LinewidthItemChanged event.
Protected methodOnLinewidthsChanged
Raise the LinewidthsChanged event.
Protected methodOnMasterDrawComponentAdded
Raise MasterDrawComponentAdded event.
Protected methodOnMasterDrawComponentDeleting
Raise MasterDrawComponentDeleting event.
Protected methodOnShapeAdded
Raise ShapeAdded event.
Protected methodOnShapeChanged
Raise the ShapeChanged event.
Protected methodOnShapeDelete
Raise ShapeDelete event.
Protected methodOnShapePrinting
Raise the ShapePrinting event.
Protected methodOnShapeSettingsChanged
Raises the ShapeSettingsChanged event.
Protected methodOnShapeSettingsStyleAdded
Raises the ShapeSettingsStyleAdded event.
Protected methodOnShapeSettingsStyleChanged
Raise the ShapeSettingsStyleChanged event.
Protected methodOnShapeSettingsStyleDeleting
Raise the ShapeSettingsStyleDeleting event.
Public methodPrintOut
Print the active partial drawing.
Public methodPrintPreview
Display the print preview of the active partial drawing.
Public methodRemoveShape
Delete the shape.
Public methodSave
Save the drawing.
Public methodSaveAs(String)
Specify the file name and save the drawing.
Public methodSaveAs(String, FileFormat)
Specify the file name and save the drawing.
Public methodSaveAsPdf
Specify a file name and export the drawing to a PDF file.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUpdateShape
Update the shape.
Top
Events
  NameDescription
Public eventAfterSave
Occurs when the drawing is saved.
Public eventBeforeSave
Occurs before the drawing is saved.
Public eventBeginPrint
Occurs before the drawing is printed.
Public eventColorItemChanged
It occurs when one color is changed.
Public eventColorsChanged
Occurs when the color table is changed.
Public eventCurrentDrawingChanged
Occurs when the current partial diagram is changed.
Public eventCurrentShapeSettingsStyleChanged
Occurs when the current graphic setting style is changed.
Public eventDrawingAdded
Occurs when paper or partial drawing is added.
Public eventDrawingChanged
Occurs when paper or partial drawing has been changed.
Public eventDrawingDeleting
Occurs when paper or partial drawing is deleted.
Public eventEndPrint
Occurs after the drawing is printed.
Public eventLayoutAdded
Occurs when a layout is added.
Public eventLayoutChanged
Occurs when the layout is changed.
Public eventLayoutDeleting
Occurs when the layout is deleted.
Public eventLinetypeItemAdded
It occurs when line type is added.
Public eventLinetypeItemChanged
It occurs when one line type is changed.
Public eventLinetypeItemDeleting
Occurs when one line type is deleted.
Public eventLinetypesChanged
Occurs when the line type table is changed.
Public eventLinewidthItemChanged
It occurs when one line width is changed.
Public eventLinewidthsChanged
Occurs when the line width table is changed.
Public eventMasterDrawComponentAdded
It occurs when the definition of the drawing part is added.
Public eventMasterDrawComponentDeleting
Occurs when the definition of the drawing part is deleted.
Public eventShapeAdded
Occurs when a shape is added.
Public eventShapeChanged
Occurs when the shape is changed.
Public eventShapeDelete
Occurs when the shape is deleted.
Public eventShapePrinting
Occurs before a figure is printed.
Public eventShapeSettingsChanged
Occurs when the figure setting is changed.
Public eventShapeSettingsStyleAdded
Occurs when a figure setting style is added.
Public eventShapeSettingsStyleChanged
Occurs when the shape setting style is changed.
Public eventShapeSettingsStyleDeleting
Occurs when the shape setting style is deleted.
Top
See Also