|
|
The Document type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
|
|
AppendFile |
Append file with files already in document, adding to current contents.
|
|
|
AppendFiles |
Append files with files already in document, adding to current contents. More efficient than
appending each file separately.
|
|
|
AppendSheet |
Append contents of sheet to current active sheet.
|
|
|
BeginTransaction |
Returns a new Transaction object. This is used to
batch together edits. In the future it may support rollback.
|
|
|
Clear |
Delete entire contents of document, returning to default (untitled, empty) state.
|
|
|
CloseFileHandles |
Closes all file handles for currently loaded files, completing load for current sheet.
File handles may be reopened in future (e.g. when changing the active sheet).
|
|
|
ConvertSheet |
Convert sheet with sheetId.
|
|
|
CreateCommentWithUniqueId(String, CommentStatus) |
Create a Comment with an Id that is unique within this Document
|
|
|
CreateCommentWithUniqueId(String, CommentStatus, String) |
Create a Comment with an Id that is unique within this Document
|
|
|
DescribeAsAggregate |
Describes current contents in terms of an JSON AggregateModelDefinition object.
|
|
|
Dispose()()()() |
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
|
|
|
Dispose(Boolean) | |
|
|
EndDisableUndo |
Decrements an internal counter that determines if the undo mechanism is disabled.
As the count goes from 1 to 0 Undo is re-enabled. Should be used with a matched
call to StartDisableUndo.
|
|
|
Equals | (Inherited from Object.) |
|
|
ExportAsDwf |
Exports the document as a 'DWF' file.
|
|
|
Finalize |
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
|
|
GenerateThumbnail(Int32, Int32) |
Generates a Thumbnail Image for this Document.
|
|
|
GenerateThumbnail(Int32, Int32, Double) |
Generates a Thumbnail Image for this Document.
|
|
|
GenerateThumbnailByRayTrace |
Generates a thumbnail by ray trace for this Document.
|
|
|
GetBoundingBox |
Returns the bounding box for the entire document.
|
|
|
GetHashCode |
Serves as a hash function for a particular type. GetHashCode()()()() is suitable for use in hashing algorithms and data structures like a hash table. (Inherited from Object.) |
|
|
GetType |
Gets the Type of the current instance. (Inherited from Object.) |
|
|
MemberwiseClone |
Creates a shallow copy of the current Object. (Inherited from Object.) |
|
|
MergeFile |
Merge file into document, merging with current contents, ignoring duplicates.
|
|
|
MergeFiles |
Merge files with files already in document, merging with current contents. More efficient than
merging each file separately.
|
|
|
MergeSheet |
Merge contents of sheet to current active sheet, ignoring duplicates.
|
|
|
OpenAggregate |
Loads aggregate into document, replacing current contents.
|
|
|
OpenFile |
Load file into document, replacing current contents.
|
|
|
PublishFile |
Publish contents of document to a file.
|
|
|
Redo |
Redoes the last completed transaction and makes it available for Undo again.
|
|
|
ResolveReference |
Finds an item specified by the reference within this document.
|
|
|
Rollback |
Rolls back (undoes) the last completed transaction. It will not be available for Redo.
|
|
|
SaveFile(String) |
Save contents of document to a file.
|
|
|
SaveFile(String, DocumentFileVersion) |
Save contents of document to a file using a specific file version.
|
|
|
SetActiveSheet |
Switch to the sheet with Id sheetId.
|
|
|
SetGraduatedBackground |
Sets a graduated background.
|
|
|
SetHorizonBackground |
Sets a horizon background.
|
|
|
SetPlainBackground |
Sets a plain background.
|
|
|
ShowMatchingItemInSheet |
Search for items with same guid in item, if have, make the sheet with sheetId active,
and select the matching model items.
|
|
|
StartDisableUndo |
Increments an internal counter that determines if the undo mechanism is disabled.
As the count goes from 0 to 1 Undo is disabled. Should be used with a matched call
to EndDisableUndo.
|
|
|
ToString | (Overrides Object..::..ToString()()()().) |
|
|
TryAppendFile |
Try to append file with files already in document, adding to current contents.
|
|
|
TryAppendFiles |
Try to append files with files already in document, adding to current contents. More efficient than
appending each file separately.
|
|
|
TryAppendSheet |
Try to append contents of sheet to current active sheet.
|
|
|
TryCloseFileHandles |
Try to close all file handles for currently loaded files, completing load for current sheet.
File handles may be reopened in future (e.g. when changing the active sheet).
|
|
|
TryConvertSheet |
Try to Convert sheet with sheetId.
|
|
|
TryDescribeAsAggregate |
Describes current contents in terms of an JSON AggregateModelDefinition object.
|
|
|
TryMergeFile |
Try to merge file into document, merging with current contents, ignoring duplicates.
|
|
|
TryMergeFiles |
Try to merge files with files already in document, merging with current contents. More efficient than
merging each file separately.
|
|
|
TryMergeSheet |
Try to merge contents of sheet to current active sheet, ignoring duplicates.
|
|
|
TryOpenAggregate |
Try to load aggregate into document, replacing current contents..
|
|
|
TryOpenFile |
Try to load file into document, replacing current contents.
|
|
|
TryPublishFile |
Try to publish contents of document to a file.
|
|
|
TryRedo |
Tries to redo the last completed transaction and make it available for Undo again.
|
|
|
TryRollback |
Tries to roll back (undo) the last completed transaction and make it available for Redo.
|
|
|
TrySaveFile(String) |
Try to save contents of document to a file.
|
|
|
TrySaveFile(String, DocumentFileVersion) |
Try to save contents of document to a file using a specific file version.
|
|
|
TrySetActiveSheet |
Try to switch to the sheet with Id sheetId.
|
|
|
TryUndo |
Tries to undo the last completed transaction and make it available for Redo.
|
|
|
Undo |
Undoes the last completed transaction and makes it available for Redo.
|
|
|
UpdateFiles |
Updates loaded files to match files on disk (i.e. if file has been changed
since it was first loaded).
|
Extension Methods
| Name | Description | |
|---|---|---|
|
|
GetClash |
Extension method to provide a handy GetClash() method on Document.
(Defined by DocumentExtensions.) |
|
|
GetTakeoff |
Extension method to provide a handy GetTakeoff() method on Document
(Defined by DocumentExtensions.) |
|
|
GetTimeliner |
Extension method to provide a handy GetTimeliner() method on Document
(Defined by TimelinerDocumentExtensions.) |
Properties
| Name | Description | |
|---|---|---|
|
|
ActiveSheet |
Gets current active sheet
|
|
|
ActiveSheetType |
Gets current active sheet type
|
|
|
ActiveView |
Gets a reference to the currently active View
|
|
|
CanDescribeAsAggregate |
Determines if current contents can described in terms of an JSON AggregateModelDefinition object.
|
|
|
Clash |
Gets the associated DocumentClash part as discoverable IDocumentClash
|
|
|
CurrentComments |
Gets a DocumentCurrentComments object containing the current Comments data.
|
|
|
CurrentFileName |
Current file name. Different from suggested file name in that
SuggestedFileName will return a friendly name for a remote file on
the basis that it expects you are trying to save locally and will
return a "Untitled" name for files that aren't saved yet.
|
|
|
CurrentMeasurement |
Gets a DocumentCurrentMeasurement object containing the current measurement data.
|
|
|
CurrentSearch |
Gets a DocumentSearch object containing the current search.
|
|
|
CurrentSelection |
Gets a DocumentCurrentSelection object containing the current selection.
|
|
|
CurrentViewpoint |
Gets a DocumentCurrentViewpoint object containing the current Viewpoint data.
|
|
|
Database |
Gets a DocumentDatabase object containing embedded database.
|
|
|
DocumentInfo |
Gets DocumentInfoPart
|
|
|
FileName |
File name (or URL) for document. May be null if document is
empty or has no associated file name.
|
|
|
FrontRightTopViewUpVector |
Returns view direction up vector to look at model from front-right-top direction.
|
|
|
FrontRightTopViewVector |
Returns view direction to look at model from front-right-top direction.
|
|
|
FrontVector |
Natural front vector for this model. Will be Zero if no front vector defined.
|
|
|
Grids |
Gets a DocumentGrids object containing the Grids data.
|
|
|
HomeView |
The home view for the current document (if one is defined).
|
|
|
Hyperlinks |
Gets a DocumentHyperlinks object containing document hyperlinks.
|
|
|
IsActiveTransaction |
Is there a transaction in progress ?
|
|
|
IsClear |
Is document in its default (untitled, empty) state ?
|
|
|
IsDisposed |
Has this document been disposed ?
|
|
|
IsModified |
Returns true if modifications requiring a save have been performed
|
|
|
IsUndoDisabled |
Gets the disabled state of the Undo mechanism.
|
|
|
Models |
Gets a DocumentModels object containing the current list of Models.
|
|
|
NextRedo |
Display name of transaction that will be redone next time Redo() is called.
|
|
|
NextUndo |
Display name of transaction that will be undone next time Undo() is called.
|
|
|
RightVector |
Natural right vector for this model. Will be Zero if no right vector defined.
|
|
|
SavedViewpoints |
Gets a DocumentCurrentViewpoint object containing the current Viewpoint data.
|
|
|
SelectionSets |
Gets the SelectionSets stored in the document.
|
|
|
SuggestedFileName |
Suggested file name which document could be saved to. Always a valid filename
(absolute if file already exists, relative if suggested name for new file).
|
|
|
Takeoff |
Gets the associated DocumentTakeoff part as discoverable IDocumentTakeoff
|
|
|
Timeliner |
Gets the associated DocumentTimeliner part as discoverable IDocumentTimeliner
|
|
|
Title |
Title for document. Suitable for display in window title bar, or similar.
|
|
|
Tool |
Gets a DocumentTool object containing the
active Tool.
|
|
|
Units |
Units for document. Apply to all geometry, properties, transforms, viewpoints, etc. in the document.
|
|
|
UpVector |
Natural up vector for this model. Will be Zero if no up vector defined.
|
|
|
Views |
Gets a ReadOnlyCollection object
containing the current list of Views of the Document.
|
Events
| Name | Description | |
|---|---|---|
|
|
ActiveSheetChanged |
Occurs when the ActiveSheet has changed.
|
|
|
ActiveSheetChanging |
Occurs when the ActiveSheet is about to change.
|
|
|
ActiveViewChanged |
Occurs when the ActiveView has changed
|
|
|
ActiveViewChanging |
Occurs when the ActiveView is about to change
|
|
|
FileNameChanged |
Occurs when the file name of the Document is changed.
|
|
|
FileSaved |
Occurs when the document has been saved into a file
|
|
|
FileSaving |
Occurs when the document is about to be saved into a file
|
|
|
TransactionBeginning |
Occurs when a Transaction (multiple batched edits) begins, before any of the edits
in the transaction take place.
|
|
|
TransactionEnded |
Occurs when a Transaction (multiple batched edits) has ended and all
the edits have been completed or rolled back.
|
|
|
UnitsChanged |
Occurs when the units of the Document are changed.
|
|
|
ViewAdded | |
|
|
ViewRemoved |