Autodesk.Navisworks.Api
Animation behavior as applied by the TimeLiner simulation engine.
The animation duration is scaled to be same as task duration.
The animation starts when the task starts. The animation may be clipped if the task finishes before animation does.
The animation starts so that it ends when the task ends. The animation start is clipped (starts part way through) if the animation needs to start before task does.
Appearance overrides.
Appearance overrides.
Material overrides.
The singleton object that represents the application.
Gets a reference to the current Document being displayed in a View
Occurs when the ActiveDocument has changed
Occurs when the ActiveDocument is about to change
Gets a reference to the
ApplicationAutomation singleton,
which provides the same interface for automation as NavisWorksApplication in the Automation assembly
Provides an instance of the Progress class
which starts reporting of progress of an operation, typically displaying a progress bar
or dialog to the end user.
Provides an instance of the Progress class
which starts reporting of progress of an operation, typically displaying a progress bar
or dialog to the end user.
Title for the overall progress operation
Provides an instance of the Progress class
which starts reporting of progress of an operation, typically displaying a progress bar
or dialog to the end user.
Title for the overall progress operation (title for Navisworks progress dialog)
Message describing the current operation (body of Navisworks progress dialog)
Provides access to the BIM360 state of the application of which is hosting the API. Will be null
if the application doesn't have BIM360 state.
Occurs when the Application's BIM360 state been created. Bim360 will be non-null.
Occurs when the Application's BIM360 state is about to be destroyed. Bim360 will be set to
null after this event has been raised.
Occurs when a Document has been added to the Documents
collection. Typically soon after the Document has been created.
Occurs when a Document has been removed from the Documents
collection. Typically shortly before the Document is destroyed.
Gets a reference to the Read Only collection of documents currently open
Provides access to Drag Drop utilities.
Finishes the operation and disposes of the Progress control allocated using BeginProgress()
Occurs when a file reference has been interactively resolved. Raised before FileResolved if
automatic resolution has failed.
Occurs when a file reference needs to be interactively resolved. Raised after FileResolving
if automatic resolution has failed.
Occurs when a file reference has been resolved. Typically when opening a file.
Occurs when a file reference needs to be resolved. Typically when opening a file.
Retrieve the custom colors for the current session
The custom colors for the current session
Provides information about the Gui of the application which is hosting the API. Will be null
if the application doesn't have a Gui.
Occurs when the Application's GUI has been created. Gui will be non-null.
Occurs when the Application's GUI is about to be destroyed. Gui will be set to
null after this event has been raised.
Occurs when the application finishes processing and is about to enter the idle state.
Gets whether this instance is running under Automation
Is user data collection enabled.
Load DocumentInfo.
fileName to load DocumentInfo from
Returns DocumentInfo if success
Failed to open file
Gets a reference to the Primary Document being worked on. Once set the MainDocument does
not change for the lifetime of the application.
Occurs when the MainDocument has changed
Occurs when the MainDocument is about to change.
Provides access to Application Options.
Provides information about the Plugins available
in the application runtime
Occurs when BeginProgress() is called.
If any handler markes the event as handled, the standard progress dialog will not be displayed.
Occurs when EndProgress is called.
Occurs when an error occurs during the lifetime of a
Progress object.
For example, if an error occurs whilst opening a large file the error
can be displayed to the user who is offered the chance to cancel.
Occurs during Progress
reporting when message describing current operation is updated.
Occurs when Progress.BeginSubOperation
is called.
Occurs when Progress.EndSubOperation
is called.
Occurs during Progress
reporting when progress is updated.
Occurs when Progress.SetVisible
is called.
Register a bitmap for later use by the graphics system. The function returns
an integer ID, or -1 if registration failed.
Provides access to Application Resources.
Set the custom colors for the current session
The custom colors to set for the current session
Title for application. Suitable for display in window title bar, or similar.
Try to Load DocumentInfo.
fileName to load DocumentInfo from
Returns null if failed
Unregister a previously registered bitmap. The function returns
true if successful, or false otherwise.
Provides information about the version of the currently running API and Runtime
Represents a person/company/role that an item can be assigned to.
Argument 'other' is null
Argument 'other' has been Disposed
Is this assignee assigned.
Object has been Disposed
Display name of the assignee.
Object has been Disposed
Determines whether the specified object and the current object refer to the same
underlying native object. Returns false if either object has been disposed.
Serves as a hash function for a particular type. is suitable for use in hashing algorithms and data structures like a hash table.
A hash code for the current .
Internal ID of the assignee.
Object has been Disposed
Gets a value indicating whether the object is read-only.
Returns a that represents the current .
A that represents the current .
Object has been Disposed
Represents an axis and angle result
Constructor for an angle/axis pair result.
The angle in radians
The axis
Axis aligned 2D bounding box. Immutable.
Create an empty bounding box
Create a bounding box from a min and max point that define the opposite corners of the box
Argument 'minPoint' is null
Argument 'minPoint' has been Disposed
A component of minPosition is greater than the corresponding component of maxPosition
Argument 'maxPoint' is null
Argument 'maxPoint' has been Disposed
Area of bounding box, 0 if empty
Object has been Disposed
Center of bounding box
Object has been Disposed
True if this completely contains box
Object has been Disposed
Argument 'box' is null
Argument 'box' has been Disposed
True if this contains point
Object has been Disposed
Argument 'point' is null
Argument 'point' has been Disposed
Determines whether the specified object and the current object refer to the same
underlying native object. Returns false if either object has been disposed.
Return box that represents union of this with another box
Object has been Disposed
Argument 'box' is null
Argument 'box' has been Disposed
Serves as a hash function for a particular type. is suitable for use in hashing algorithms and data structures like a hash table.
A hash code for the current .
Does bounding box have a non-zero area ?
Object has been Disposed
Return box that represents intersection of this with another box
Object has been Disposed
Argument 'box' is null
Argument 'box' has been Disposed
True if this intersects box
Object has been Disposed
Argument 'box' is null
Argument 'box' has been Disposed
True if this intersects point (same as Contains() for a point)
Object has been Disposed
Argument 'point' is null
Argument 'point' has been Disposed
Is bounding box empty ?
Object has been Disposed
Gets a value indicating whether the object is read-only.
Return max point that defines corner of box with largest values for all components
Object has been Disposed
Return min point that defines corner of box with smallest values for all components
Object has been Disposed
Extents of bounding box from min point to max point
Object has been Disposed
Returns a that represents the current .
A that represents the current .
Return this box translated by an offset
Object has been Disposed
Argument 'offset' is null
Argument 'offset' has been Disposed
Axis aligned 3D bounding box. Immutable.
Create an empty bounding box
Create a bounding box from a min and max point that define the opposite corners of the box
Argument 'minPoint' is null
Argument 'minPoint' has been Disposed
A component of minPosition is greater than the corresponding component of maxPosition
Argument 'maxPoint' is null
Argument 'maxPoint' has been Disposed
Center of bounding box
Object has been Disposed
Computes closest point in box to a given point
Object has been Disposed
Argument 'point' is null
Argument 'point' has been Disposed
True if this completely contains box
Object has been Disposed
Argument 'box' is null
Argument 'box' has been Disposed
True if this contains point
Object has been Disposed
Argument 'point' is null
Argument 'point' has been Disposed
Returns an empty bounding box
Determines whether the specified object and the current object refer to the same
underlying native object. Returns false if either object has been disposed.
Return box that represents union of this with another box
Object has been Disposed
Argument 'box' is null
Argument 'box' has been Disposed
Return box that represents union of this with another point
Object has been Disposed
Argument 'point' is null
Argument 'point' has been Disposed
Serves as a hash function for a particular type. is suitable for use in hashing algorithms and data structures like a hash table.
A hash code for the current .
Does bounding box have a non-zero surface area ?
Object has been Disposed
Does bounding box have a non-zero volume ?
Object has been Disposed
Return box that represents intersection of this with another box
Object has been Disposed
Argument 'box' is null
Argument 'box' has been Disposed
True if this intersects box
Object has been Disposed
Argument 'box' is null
Argument 'box' has been Disposed
True if this intersects point (same as Contains() for a point)
Object has been Disposed
Argument 'point' is null
Argument 'point' has been Disposed
Is bounding box empty ?
Object has been Disposed
Gets a value indicating whether the object is read-only.
Return max point that defines corner of box with largest values for all components
Object has been Disposed
Return min point that defines corner of box with smallest values for all components
Object has been Disposed
Extents of bounding box from min point to max point
Object has been Disposed
Sum of the areas of the faces of the bounding box, 0 if empty
Object has been Disposed
Returns a that represents the current .
A that represents the current .
Return this box translated by an offset
Object has been Disposed
Argument 'offset' is null
Argument 'offset' has been Disposed
Volume of bounding box, 0 if empty
Object has been Disposed
Describes the relationship of camera to viewer.
First person mode.
Third person mode.
Exception thrown when an operation could not complete because the end user
has canceled it (usually through progress reporting).
Creates a CanceledOperationException object
Creates a CanceledOperationException object
Creates a CanceledOperationException object
The error message that explains the reason for the exception.
Creates a CanceledOperationException object
The exception that is the cause of the current exception. If the innerException parameter is not null, the current exception is raised in a catch block that handles the inner exception.
A representation of a clipping plane.
Argument 'other' is null
Argument 'other' has been Disposed
The clip plane alignment.
Object has been Disposed
Object is Read-Only
Object has been Disposed
Object is Read-Only
Argument 'up' is null
Argument 'up' has been Disposed
Argument 'front' is null
Argument 'front' has been Disposed
Object has been Disposed
Object is Read-Only
Argument 'origin' is null
Argument 'origin' has been Disposed
Argument 'normal' is null
Argument 'normal' has been Disposed
Object has been Disposed
Object is Read-Only
Argument 'origin' is null
Argument 'origin' has been Disposed
Argument 'normal' is null
Argument 'normal' has been Disposed
Argument 'xAxis' has been Disposed
Transforms the clip plane.
Object has been Disposed
Object is Read-Only
Argument 'trans' is null
Argument 'trans' has been Disposed
Object has been Disposed
Object is Read-Only
Argument 'from' is null
Argument 'from' has been Disposed
Is this clip plane in the default (uninitialized) state.
Object has been Disposed
The distance of the plane from the world origin.
Object has been Disposed
Object has been Disposed
Object is Read-Only
Object has been Disposed
Object is Read-Only
Argument 'origin' is null
Argument 'origin' has been Disposed
Argument 'up' has been Disposed
Argument 'front' has been Disposed
Object has been Disposed
Object is Read-Only
Argument 'origin' is null
Argument 'origin' has been Disposed
Argument 'up' has been Disposed
Argument 'front' has been Disposed
Argument 'normal' has been Disposed
Object has been Disposed
Object is Read-Only
Argument 'origin' is null
Argument 'origin' has been Disposed
Argument 'up' has been Disposed
Argument 'front' has been Disposed
Argument 'normal' has been Disposed
Argument 'xAxis' has been Disposed
Object has been Disposed
Object is Read-Only
Argument 'normal' is null
Argument 'normal' has been Disposed
Gets a value indicating whether the object is read-only.
Object has been Disposed
Object is Read-Only
The normal of the plane.
Object has been Disposed
Object is Read-Only
Argument 'normal' is null
Argument 'normal' has been Disposed
The origin of the plane.
Object has been Disposed
Object is Read-Only
Argument 'origin' is null
Argument 'origin' has been Disposed
Object has been Disposed
Object is Read-Only
Object has been Disposed
Object is Read-Only
The transform of this plane.
Object has been Disposed
Object is Read-Only
Argument 'trans' is null
Argument 'trans' has been Disposed
Object has been Disposed
Object is Read-Only
Argument 'offset' is null
Argument 'offset' has been Disposed
Returns the X axis for the clip plane.
Object has been Disposed
Alignment of a clip plane.
Not aligned
Aligned with the view
Aligned to the back
Aligned to the front
Aligned to the left
Aligned to the right
Aligned to the top
Aligned to the bottom
Aligned with a surface
Aligned with a line
Custom alignment
Represents the set of clip planes in a view.
The clipping box position.
Object has been Disposed
Object is Read-Only
Argument 'box' is null
Argument 'box' has been Disposed
The internal transform used for the section box.
Object has been Disposed
Object has been Disposed
Argument 'point' is null
Argument 'point' has been Disposed
Object has been Disposed
Object is Read-Only
Argument 'other' is null
Argument 'other' has been Disposed
The current clip plane.
Object has been Disposed
The index of the current plane.
Object has been Disposed
Object is Read-Only
Is the clipping set enabled.
Object has been Disposed
Object is Read-Only
Object has been Disposed
Object is Read-Only
Argument 'boundingBox' is null
Argument 'boundingBox' has been Disposed
Object has been Disposed
Object has been Disposed
Argument 'box' has been Disposed
Argument 'rotation' has been Disposed
Object has been Disposed
Object has been Disposed
Argument 'other' is null
Argument 'other' has been Disposed
Gets a value indicating whether the object is read-only.
Are the clip planes linked.
Object has been Disposed
Object is Read-Only
The mode of the set.
Object has been Disposed
Object is Read-Only
The range over which the clip planes operate.
Object has been Disposed
Object is Read-Only
Argument 'range' is null
Argument 'range' has been Disposed
Object has been Disposed
Object is Read-Only
Argument 'box' is null
Argument 'box' has been Disposed
Argument 'rotation' is null
Argument 'rotation' has been Disposed
Object has been Disposed
Object is Read-Only
Argument 'trans' is null
Argument 'trans' has been Disposed
Object has been Disposed
Object has been Disposed
Object is Read-Only
Argument 'trans' is null
Argument 'trans' has been Disposed
Object has been Disposed
Object is Read-Only
Argument 'offset' is null
Argument 'offset' has been Disposed
Performs comparison 'By Value'
Compares the two references 'By Value'
The mode of the clip plane set.
Planes
Box
Possible states a clip plane can be in.
Default (uninitialized)
Enabled
Disabled
Represents a color as three floating-point components (r,g,b) with a normal range 0.0 to 1.0. Immutable.
Create a color from float (r,g,b) components in the range 0 to 1
Adds two colors to create another color. Same as operator+
Object has been Disposed
Argument 'color' is null
Argument 'color' has been Disposed
Blue color component (in range 0 to 1)
Object has been Disposed
Returns a Color initialized to black
Returns a Color initialized to blue
Determines whether the specified object and the current object refer to the same
underlying native object. Returns false if either object has been disposed.
Create a color from byte (r,g,b) components in the range 0 to 255
Green color component (in range 0 to 1)
Object has been Disposed
Return color components as clamped bytes (in range 0 to 255)
Object has been Disposed
Serves as a hash function for a particular type. is suitable for use in hashing algorithms and data structures like a hash table.
A hash code for the current .
Returns a Color initialized to green
Is color black ?
Object has been Disposed
Gets a value indicating whether the object is read-only.
Scales intensity of color by value. Same as operator*
Object has been Disposed
Adds the R, G and B values of value1 and value2 and returns the resulting Color
Multiplies the R, G and B values of color by intensity and returns the Resulting Color
Multiplies the R, G and B values of color by intensity and returns the Resulting Color
Subtracts the R, G and B values of value2 from value1 and returns the resulting Color
Red color component (in range 0 to 1)
Object has been Disposed
Returns a Color initialized to red
Subtracts color to create another color. Same as operator-
Object has been Disposed
Argument 'color' is null
Argument 'color' has been Disposed
Returns a that represents the current .
A that represents the current .
Convert color to a Vector3D
Object has been Disposed
Returns a Color initialized to white
A user comment. Immutable.
Create a comment from a copy of another comment
Argument 'from' is null
Argument 'from' has been Disposed
Create a comment without a meaningfull id using current user as author. Use Document.CreateCommentWithUniqueId to create a comment with an unique id within a particular Document.
Create a comment without a meaningfull id. Use Document.CreateCommentWithUniqueId to create a comment with an unique id within a particular Document.
Author (creator) of comment
Object has been Disposed
Body of comment
Object has been Disposed
Date and time at which comment was created
Object has been Disposed
Determines whether the specified object and the current object refer to the same
underlying native object. Returns false if either object has been disposed.
Serves as a hash function for a particular type. is suitable for use in hashing algorithms and data structures like a hash table.
A hash code for the current .
Comment identifier. Unique within a Document. 0 if no meaningful id.
Object has been Disposed
Gets a value indicating whether the object is read-only.
Status of comment
Object has been Disposed
Returns a that represents the current .
A that represents the current .
A collection of Comments
Create an empty collection
Create a collection that is a copy of from
Argument 'from' is null
Argument 'from' has been Disposed
Adds item to the end of the collection.
Object has been Disposed
Object is Read-Only
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' is ReadOnly
Adds an item to the .
The to add to the .
The position into which the new element was inserted.
The is read-only.-or- The has a fixed size.
Add the items of the specified collection to the SavedItemCollection
The collection to add items from
Removes all items from the collection
Object has been Disposed
Object is Read-Only
Gets a value indicating whether the object is read-only.
Determines whether the SavedItemCollection contains a specific value.
Object has been Disposed
Argument 'item' has been Disposed
Determines whether the contains a specific value.
The to locate in the .
true if the is found in the ; otherwise, false.
Sets the contents of the collection to the items in from
The collection to copy contents from
Copies the elements of the to an , starting at a particular index.
The one-dimensional that is the destination of the elements copied from . The must have zero-based indexing.
The zero-based index in array at which copying begins.
arrayIndex is less than 0.
array is null.
array is multidimensional.-or-arrayIndex is equal to or greater than the length of array.-or-The number of elements in the source is greater than the available space from arrayIndex to the end of the destination array.-or-Type T cannot be cast automatically to the type of the destination array.
Copies the elements of the to an , starting at a particular index.
The one-dimensional that is the destination of the elements copied from . The must have zero-based indexing.
The zero-based index in array at which copying begins.
array is null.
index is less than zero.
array is multidimensional.-or- index is equal to or greater than the length of array.-or- The number of elements in the source is greater than the available space from index to the end of the destination array.
The type of the source cannot be cast automatically to the type of the destination array.
Enumerates over the collection and copies the items into to
Collection to copy into
Gets the number of elements contained in the collection.
Object has been Disposed
Returns an enumerator that can iterate through the collection.
An IEnumerator that can be used to iterate through the collection.
Gets or sets the element at the specified index.
Object has been Disposed
Object is Read-Only
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' is ReadOnly
Argument 'index' out of range
Determines the index of a specific item in the Collection
Argument 'item' has been Disposed
Determines the index of a specific item in the .
The to locate in the .
The index of value if found in the list; otherwise, -1.
Inserts item into the collection at the specified index
Object has been Disposed
Object is Read-Only
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' is ReadOnly
Argument 'index' out of range
Inserts an item to the at the specified index.
The to insert into the .
The zero-based index at which value should be inserted.
index is not a valid index in the .
The is read-only.-or- The has a fixed size.
value is null reference in the .
Returns an enumerator that can iterate through the collection.
An IEnumerator that
can be used to iterate through the collection.
Gets a value indicating whether the has a fixed size.
true if the has a fixed size; otherwise, false.
Gets a value indicating whether the object is read-only.
Gets a value indicating whether access to the is synchronized (thread safe).
true if access to the is synchronized (thread safe); otherwise, false.
Removes the first occurrence of a specific item from the collection.
The object to remove from the collection.
true if item was successfully removed from the collection; otherwise, false.
This method also returns false if item is not found in the original collection.
The collection is read-only.
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' is ReadOnly
Removes the first occurrence of a specific object from the .
The to remove from the .
The is read-only.-or- The has a fixed size.
Removes the item at the specified index.
The zero-based index of the item to remove.
The is read-only.
index is not a valid index in the .
Gets an object that can be used to synchronize access to the .
An object that can be used to synchronize access to the .
Specifies status of comment.
Newly created comment.
Active issue.
Issue has been approved.
Issue has been resolved.
Enumerates cursors used in input into Navisworks
Special case. Returned by GetCursor() if handled already.
Handled Cursor.
Walk Cursor.
Fly Cursor.
Orbit Cursor.
Swivel Cursor.
Examine Cursor.
Pan Cursor.
Zoom Cursor.
Turntable Cursor.
Focus Cursor.
Application Cursor.
ZoomBox Cursor.
Measure Cursor.
HyperHand Cursor.
PanWorld Cursor.
Roll Cursor.
Stop Cursor.
MeasureEdge Cursor.
MeasureVertex Cursor.
Redline Cursor.
Erase Cursor.
Wheel Cursor.
Markup Selection Cursor.
Markup Snapping Cursor.
Markup Eraser Cursor.
Markup QuickPick Cursor.
Markup Bucket Cursor.
Markup AutoPoly Cursor.
Named property with data value. Immutable.
Create a property from a combined name and display name
Argument 'combinedName' has been Disposed
Argument 'data' is null
Argument 'data' has been Disposed
Create a property from separate name and display name
Argument 'value' is null
Argument 'value' has been Disposed
Combined name of property
Object has been Disposed
Diplay name (localized, suitable for display to end user)
Object has been Disposed
Determines whether the specified object and the current object refer to the same
underlying native object. Returns false if either object has been disposed.
Serves as a hash function for a particular type. is suitable for use in hashing algorithms and data structures like a hash table.
A hash code for the current .
Gets a value indicating whether the object is read-only.
Name of property (suitable for programmatic use)
Object has been Disposed
Parses formattedValue into a value compatible (same type and formatting) with the current Value.
Parsed value
formattedValue is not in a format compatible with the current value.
Returns a that represents the current .
A that represents the current .
Try to parse formattedValue into a value compatible (same type and formatting) with the current Value. Returns a value with type of None on failure
Object has been Disposed
Value of the property
Object has been Disposed
A collection of objects.
Create an empty collection
Create a collection that is a copy of from
Argument 'from' is null
Argument 'from' has been Disposed
Adds item to the end of the collection.
Object has been Disposed
Object is Read-Only
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' is ReadOnly
Adds an item to the .
The to add to the .
The position into which the new element was inserted.
The is read-only.-or- The has a fixed size.
Add the items of the specified collection to the SavedItemCollection
The collection to add items from
Removes all items from the collection
Object has been Disposed
Object is Read-Only
Gets a value indicating whether the object is read-only.
Determines whether the SavedItemCollection contains a specific value.
Object has been Disposed
Argument 'item' has been Disposed
Determines whether the contains a specific value.
The to locate in the .
true if the is found in the ; otherwise, false.
Sets the contents of the collection to the items in from
The collection to copy contents from
Copies the elements of the to an , starting at a particular index.
The one-dimensional that is the destination of the elements copied from . The must have zero-based indexing.
The zero-based index in array at which copying begins.
arrayIndex is less than 0.
array is null.
array is multidimensional.-or-arrayIndex is equal to or greater than the length of array.-or-The number of elements in the source is greater than the available space from arrayIndex to the end of the destination array.-or-Type T cannot be cast automatically to the type of the destination array.
Copies the elements of the to an , starting at a particular index.
The one-dimensional that is the destination of the elements copied from . The must have zero-based indexing.
The zero-based index in array at which copying begins.
array is null.
index is less than zero.
array is multidimensional.-or- index is equal to or greater than the length of array.-or- The number of elements in the source is greater than the available space from index to the end of the destination array.
The type of the source cannot be cast automatically to the type of the destination array.
Enumerates over the collection and copies the items into to
Collection to copy into
Gets the number of elements contained in the collection.
Object has been Disposed
Find first property with specified
First matching property or null
Object has been Disposed
Argument 'name' has been Disposed
Find first property with specified
First matching property or null
Object has been Disposed
Find first property with specified
First matching property or null
Object has been Disposed
Returns an enumerator that can iterate through the collection.
An IEnumerator that can be used to iterate through the collection.
Gets or sets the element at the specified index.
Object has been Disposed
Object is Read-Only
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' is ReadOnly
Argument 'index' out of range
Determines the index of a specific item in the Collection
Argument 'item' has been Disposed
Determines the index of a specific item in the .
The to locate in the .
The index of value if found in the list; otherwise, -1.
Inserts item into the collection at the specified index
Object has been Disposed
Object is Read-Only
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' is ReadOnly
Argument 'index' out of range
Inserts an item to the at the specified index.
The to insert into the .
The zero-based index at which value should be inserted.
index is not a valid index in the .
The is read-only.-or- The has a fixed size.
value is null reference in the .
Returns an enumerator that can iterate through the collection.
An IEnumerator that
can be used to iterate through the collection.
Gets a value indicating whether the has a fixed size.
true if the has a fixed size; otherwise, false.
Gets a value indicating whether the object is read-only.
Gets a value indicating whether access to the is synchronized (thread safe).
true if access to the is synchronized (thread safe); otherwise, false.
Removes the first occurrence of a specific item from the collection.
The object to remove from the collection.
true if item was successfully removed from the collection; otherwise, false.
This method also returns false if item is not found in the original collection.
The collection is read-only.
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' is ReadOnly
Removes the first occurrence of a specific object from the .
The to remove from the .
The is read-only.-or- The has a fixed size.
Removes the item at the specified index.
The zero-based index of the item to remove.
The is read-only.
index is not a valid index in the .
Gets an object that can be used to synchronize access to the .
An object that can be used to synchronize access to the .
Names (values of ) of commonly found properties.
Name of AutoCad Entity Handle ()
"Value" property
Name of Item "Creator" property (same as )
Name of Item "File Name" property (same as )
Name of Item "GUID" property (same as )
Name of Item "Hidden" property
Name of Item "Icon" property
Name of Item "Internal Type" property (same as )
Name of Item "Layer" property
Name of Item "Material" property
Name of Item "Name" property (same as )
Name of Item "Required" property
Name of Item "Source File" property
Name of Item "Source File Name" property (same as )
Name of Item "Type" property (same as )
Name of Item "Unit" property (same as )
Name of Microstation Element Id ()
"Value" property
Name of Revit Element Id ()
"Value" property
Represents the contents of one or more loaded files.
Gets current active sheet
Occurs when the ActiveSheet has changed.
Occurs when the ActiveSheet is about to change.
Gets current active sheet type
Gets a reference to the currently active View
Occurs when the ActiveView has changed
Occurs when the ActiveView is about to change
Gets a DocumentAlignments object containing the Civil Alignment data.
Append file with files already in document, adding to current contents.
Path to try and append file from
Failed to append file
Append files with files already in document, adding to current contents. More efficient than
appending each file separately.
Paths to append files from
Failed to append files
Append contents of sheet to current active sheet.
SheetInfo to try and append sheet from
Failed to append sheet
Document IsClear
Returns a new Transaction object. This is used to
batch together edits. In the future it may support rollback.
String that may be displayed in the GUI for undoing this transaction.
New Transaction object.
Determines if current contents can described in terms of an JSON AggregateModelDefinition object.
false if current contents cannot be described as an aggregate.
Gets the associated DocumentClash part as discoverable IDocumentClash
Delete entire contents of document, returning to default (untitled, empty) state.
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).
Failed to close file handles
Convert sheet with sheetId.
Id of sheet to convert
Argument 'sheetId' is not contained in current document.
Failed to convert
Create a Comment with an Id that is unique within this Document
Create a Comment with an Id that is unique within this Document
Gets a DocumentCurrentComments object containing the current Comments data.
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.
Gets a DocumentCurrentMeasurement object containing the current measurement data.
Gets a DocumentSearch object containing the current search.
Gets a DocumentCurrentSelection object containing the current selection.
Gets a DocumentCurrentViewpoint object containing the current Viewpoint data.
Gets a DocumentDatabase object containing embedded database.
Describes current contents in terms of an JSON AggregateModelDefinition object.
Current contents cannot be described as an aggregate.
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Gets DocumentInfoPart
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.
Exports the document as a 'DWF' file.
Exports contents of document to an NWD file..
Path to try and publish file to
Options to export file with
Failed to export file
Document IsClear
File name (or URL) for document. May be null if document is
empty or has no associated file name.
Occurs when the file name of the Document is changed.
Occurs when the document has been saved into a file
Occurs when the document is about to be saved into a file
Occurs when the document has updated files.
Occurs when the document is about to update files.
Current file version for document.
Returns view direction up vector to look at model from front-right-top direction.
Returns view direction to look at model from front-right-top direction.
Natural front vector for this model. Will be Zero if no front vector defined.
Generates an Image for this Document.
Generates an Image for this Document.
Returns the bounding box for the entire document.
If true, bounding box will not include hidden items, otherwise hidden items will be taken into account.
Bounding box for all items in the document.
Returns information relevant to the specified point.
A 3D point in the world
A list of PointInfo objects related to the world point.
Gets a DocumentGrids object containing the Grids data.
The home view for the current document (if one is defined).
Gets a DocumentHyperlinks object containing document hyperlinks.
Is there a transaction in progress ?
Is document in its default (untitled, empty) state ?
Has this document been disposed ?
Returns true if modifications requiring a save have been performed
Gets the disabled state of the Undo mechanism.
True if Undo mechanism is currently disabled, otherwise false.
Merge file into document, merging with current contents, ignoring duplicates.
Path to try and merge file from
Failed to merge file
Merge files with files already in document, merging with current contents. More efficient than
merging each file separately.
Paths to merge files from
Failed to merge files
Merge contents of sheet to current active sheet, ignoring duplicates.
SheetInfo to try and merge sheet from
Failed to merge sheet
Document IsClear
Gets a DocumentModels object containing the current list of Models.
Display name of transaction that will be redone next time Redo() is called.
Null if nothing can be redone
Display name of transaction that will be undone next time Undo() is called.
Null if nothing can be undone
Loads aggregate into document, replacing current contents.
Aggregate in the form of a JSON AggregateModelDefinition object.
Failed to open aggregate.
Load file into document, replacing current contents.
Path to try and load file from
Failed to open file
Publish contents of document to a file.
Path to try and publish file to
Publishing properties to publish file with
Failed to publish file
Document IsClear
Redoes the last completed transaction and makes it available for Undo again.
No transaction is available to Redo or there is an active transaction in progress.
Remove the file with the provided index from the document.
Index of the file to remove from the document
Failed to remove the file
Finds an item specified by the reference within this document.
Null if the item can't be found.
reference does not refer to a specific part (documentPartId is empty/null).
if reference is null.
Natural right vector for this model. Will be Zero if no right vector defined.
Rolls back (undoes) the last completed transaction. It will not be available for Redo.
No transaction is available to Undo or there is an active transaction in progress.
Gets a DocumentCurrentViewpoint object containing the current Viewpoint data.
Save contents of document to a file.
Path to try and save file to
Failed to save file
Document IsClear
Save contents of document to a file using a specific file version.
Path to try and save file to
Failed to save file
Document IsClear
fileName does not have .nwd or .nwf extension
Gets the SelectionSets stored in the document.
Switch to the sheet with Id sheetId.
Id of sheet to make active
Argument 'sheetId' is not contained in current document.
Failed to load sheet
Sets a graduated background.
Sets a horizon background.
Sets a plain background.
Search for items with same guid in item, if have, make the sheet with sheetId active,
and select the matching model items.
Id of sheet to search in
ModelItem to search with same Guid
item is null.
Argument 'sheetId' is not contained in current document.
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.
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).
Gets the associated DocumentTakeoff part as discoverable IDocumentTakeoff
Gets the associated DocumentTimeliner part as discoverable IDocumentTimeliner
Title for document. Suitable for display in window title bar, or similar.
Gets a DocumentTool object containing the
active Tool.
Returns a that represents the current .
A that represents the current .
Occurs when a Transaction (multiple batched edits) begins, before any of the edits
in the transaction take place.
Occurs when a Transaction (multiple batched edits) has ended and all
the edits have been completed or rolled back.
Try to append file with files already in document, adding to current contents.
Path to try and append file from
false if append fails
Try to append files with files already in document, adding to current contents. More efficient than
appending each file separately.
Paths to append files from
false if append fails
Try to append contents of sheet to current active sheet.
SheetInfo to try and append sheet from
false if append fails
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).
false if load cannot be completed or file handles cannot be closed
Try to Convert sheet with sheetId.
Id of sheet to try to convert
false if sheet could not be converted
Document IsClear
Describes current contents in terms of an JSON AggregateModelDefinition object.
false if current contents cannot be described as an aggregate.
Exports contents of document to an NWD file..
Path to try and publish file to
Options to export file with
Document IsClear
Try to merge file into document, merging with current contents, ignoring duplicates.
Path to try and merge file from
false if merge fails
Try to merge files with files already in document, merging with current contents. More efficient than
merging each file separately.
Paths to merge files from
false if merge fails
Try to merge contents of sheet to current active sheet, ignoring duplicates.
SheetInfo to try and merge sheet from
false if merge fails
Try to load aggregate into document, replacing current contents..
Aggregate in the form of a JSON AggregateModelDefinition object.
false if load fails
Try to load file into document, replacing current contents.
Path to try and load file from
false if load fails
Try to publish contents of document to a file.
Path to try and publish file to
Publishing properties to publish file with
false if publish fails
Document IsClear
Tries to redo the last completed transaction and make it available for Undo again.
False if nothing can be redone or there is an active transaction in progress
Try to remove the file with the provided index from the document.
Index of the file to remove from the document
false if the file could not be removed
Tries to roll back (undo) the last completed transaction and make it available for Redo.
False if nothing can be undone or there is an active transaction in progress
Try to save contents of document to a file.
Path to try and save file to
false if save fails
Document IsClear
Try to save contents of document to a file using a specific file version.
Path to try and save file to
false if save fails
Document IsClear
fileName does not have .nwd or .nwf extension
Try to switch to the sheet with Id sheetId.
Id of sheet to make active
false if sheet could not be made active
Document IsClear
Tries to undo the last completed transaction and make it available for Redo.
False if nothing can be undone or there is an active transaction in progress
Undoes the last completed transaction and makes it available for Redo.
No transaction is available to Undo or there is an active transaction in progress.
Units for document. Apply to all geometry, properties, transforms, viewpoints, etc. in the document.
Occurs when the units of the Document are changed.
Updates loaded files to match files on disk (i.e. if file has been changed
since it was first loaded).
true if anything in document was updated
Natural up vector for this model. Will be Zero if no up vector defined.
Occurs when a View has been added to the Views
collection. Typically soon after the View has been created.
Occurs when a View has been removed from the Views
collection. Typically shortly before the View is destroyed.
Gets a ReadOnlyCollection object
containing the current list of Views of the Document.
Event arguments used for Document related events
Gets the Document that the event is describing.
The exception that is thrown by file operation methods in Document
Creates a DocumentFileException
Creates a DocumentFileException
Creates a DocumentFileException
The error message that explains the reason for the exception.
Creates a DocumentFileException
The error message that explains the reason for the exception.
The exception that is the cause of the current exception. If the innerException parameter is not null, the current exception is raised in a catch block that handles the inner exception.
Enumeration of Navisworks Document file format versions.
Use the most recent version of the file format supported by the runtime
Version of file format used by Navisworks 2015
Version of file format used by Navisworks 2016
Version of file format used by Navisworks 2017
Version of file format used by Navisworks 2018
Version of file format used by Navisworks 2019
Version of file format used by Navisworks 2020
Version of file format used by Navisworks 2021
Version of file format used by Navisworks 2022
Version of file format used by Navisworks 2023
Version of file format used by Navisworks 2024
Version of file format used by Navisworks 2025
Version of file format used by Navisworks 2026
Information about a that can be accessed without loading the entire document
Create an empty DocumentInfo
Get the currently active sheet
Object has been Disposed
Get the id of the currently active sheet
Object has been Disposed
Get Guid generated when current version of corresponding file was saved. Changes whenever document is saved.
Object has been Disposed
Find Sheet by sheet Id
Object has been Disposed
Get Index by sheet Id
Object has been Disposed
Gets a value indicating whether the object is read-only.
Get the property category collection
Object has been Disposed
Get original Guid when FileInfo was first created. Once set remains the same while Guid changes when saving to a file of a different type.
Object has been Disposed
Specifies parts of a
Current sheet Id
Represents Euler angles returned from a method
Constructor for a Euler angle result.
'X' Euler angle
'Y' Euler angle
'Z' Euler angle
Event arguments used for the Application::FileInteractiveResolved event
Get file reference that FileReference has been resolved to, or null if not resolved
Get user's response from interactive dialog.
Event arguments used for the Application::FileInteractiveResolving event
Get string to display to the end user explaining what sort of file is being resolved
Set whether event handler has handled interactive file resolution.
If set to true, default interactive file resolution will not occur.
Set file reference that has been resolved to by interactively
asking user. Leave as null if file can’t be resolved.
Set user's response from interactive dialog.
Utility class used to resolve a file reference to a real file
Default constructor
String to display to end user if reference has to be resolved interactively
Object has been Disposed
Object is Read-Only
Gets a value indicating whether the object is read-only.
File name that is referring to file to be resolved, empty if not known
Object has been Disposed
Object is Read-Only
File name that is referring to file to be resolved as it was when saved, empty if not known
Object has been Disposed
Object is Read-Only
Resolve a file reference (absolute path, relative path, URL, ...)
Resolve a file reference (absolute path, relative path, URL, ...)
Specify whether result should include FileNameToOpen
Result of calling FileReferenceResolver::Resolve
File name that can be opened to read contents of file referred to
Resolved (updated) reference
OK if reference was resolved successfully
Specifies type of FileReference
Null or empty file reference
Absolute path to file on disk
URL for remote file
File embedded in referring file
Path relative to referring file
Unknown type of file reference
Base class for file resolution related events
Get file reference to be resolved
Get type of file reference to be resolved
Get file name that is referring to file to be resolved, or null if not known
Get file name that is referring to file to be resolved as it was when saved, or null if not known
Get whether file is being resolved in order to open it.
User response from request for file resolution
User has supplied an updated file reference
User wants to cancel the entire operation
User wants to ignore this unresolved file
User wants to ignore this and any other unresolved files
Event arguments used for the Application::FileResolved event
Get file name to open to read contents of resolved reference. Same as ResolvedFileReference
if file is local. Null if not resolved or file is remote and has not been downloaded.
Get file reference that FileReference has been resolved to, or null if not resolved
Get type of file reference to be resolved
Event arguments used for the Application::FileResolving event
Set file name to open to read contents of resolved file.
Leave as null if ResolveToOpen is false or file can’t be resolved.
Set whether event handler has handled file resolution.
If set to true, default file resolution will not occur.
Set file reference that has been resolved to.
Leave as null if file can’t be resolved.
Event arguments used for SaveFile related events
Gets the name of the file that is being saved to
Gets whether the save is a publish
Gets whether the save has completed successfully
Event arguments used for FileUpdate related events
Gets whether any files were updated.
A simple folder of saved items.
Create an empty folder
Gets a value indicating whether the object is read-only.
Class encapsulating API for the rendering of client graphics.
Renders a 2D arc in the XY plane at the current Z depth.
Centre point of the arc.
Start point of the arc.
End point of the arc.
Should the arc be filled in or an outline.
Object has been Disposed
Object is Read-Only
Argument 'centre' is null
Argument 'centre' has been Disposed
Argument 'start' is null
Argument 'start' has been Disposed
Argument 'end' is null
Argument 'end' has been Disposed
Renders a 3D arc.
Center point of the arc.
Start point of the arc.
End point of the arc.
Normal for arc.
Should the arc be filled in or an outline.
Object has been Disposed
Object is Read-Only
Argument 'center' is null
Argument 'center' has been Disposed
Argument 'start' is null
Argument 'start' has been Disposed
Argument 'end' is null
Argument 'end' has been Disposed
Argument 'normal' is null
Argument 'normal' has been Disposed
Begin rendering a complex polygon.
Vertex properties for the polygon.
Object has been Disposed
Object is Read-Only
Begin complex polygon contour.
Object has been Disposed
Object is Read-Only
Begin rendering in the Model Context.
Object has been Disposed
Object is Read-Only
Begins a convex polygon.
Vertex properties for the polygon.
Object has been Disposed
Object is Read-Only
Begin rendering in a user-defined context.
Object has been Disposed
Object is Read-Only
Begin rendering in the Window Context.
Object has been Disposed
Object is Read-Only
Renders a 2D segment of a 3rd order Bezier curve.
Start point of the segment.
Control point for segment.
Object has been Disposed
Object is Read-Only
Argument 'start' is null
Argument 'start' has been Disposed
Argument 'control' is null
Argument 'control' has been Disposed
Argument 'end' is null
Argument 'end' has been Disposed
Renders a 2D segment of a 3rd order Bezier curve.
Start point of the segment.
Control point for segment.
Number of points to evaluate along the Bezier.
Object has been Disposed
Object is Read-Only
Argument 'start' is null
Argument 'start' has been Disposed
Argument 'control' is null
Argument 'control' has been Disposed
Argument 'end' is null
Argument 'end' has been Disposed
Renders a registered bitmap
Index of the registered bitmap to render.
Origin point of the bitmap.
Overall alpha value for the bitmap.
Object has been Disposed
Object is Read-Only
Argument 'origin' is null
Argument 'origin' has been Disposed
Renders a registered bitmap
Index of the registered bitmap to render.
Origin point of the bitmap.
Width of the image you want to render.
Height of the image you want to render.
Overall alpha value for the bitmap.
Object has been Disposed
Object is Read-Only
Argument 'origin' is null
Argument 'origin' has been Disposed
Enables or disables blending.
Should blending be enabled.
Object has been Disposed
Object is Read-Only
Check to see if you can render a given text string with given font info.
Object has been Disposed
Object is Read-Only
Argument 'fontInfo' has been Disposed
Renders a 2D circle in the XY plane at the current Z depth.
Centre point of the circle.
Radius of circle.
Should the circle be filled in or an outline.
Object has been Disposed
Object is Read-Only
Argument 'centre' is null
Argument 'centre' has been Disposed
Renders a 3D circle in the model space.
Centre point of the circle.
normal for the circle.
Radius of circle.
Should the circle be filled in or an outline.
Object has been Disposed
Object is Read-Only
Argument 'centre' is null
Argument 'centre' has been Disposed
Argument 'normal' is null
Argument 'normal' has been Disposed
Sets the current render color.
Color value.
Alpha value. Range of 0.0 to 1.0. 0.0 is fully transparent, 1.0 is fully opaque.
Object has been Disposed
Object is Read-Only
Argument 'colorValue' is null
Argument 'colorValue' has been Disposed
Renders a 3D cone.
Start point of centre axis.
End point of centre axis.
Radius at start point of cone.
Radius at end point of cone.
Object has been Disposed
Object is Read-Only
Argument 'start' is null
Argument 'start' has been Disposed
Argument 'end' is null
Argument 'end' has been Disposed
Renders a 3D cuboid.
Origin point of rectangle.
Vector representing 'x' side of cuboid.
Vector representing 'y' side of cuboid.
Vector representing 'y' side of cuboid.
Should the cuboid be filled in or an outline.
Object has been Disposed
Object is Read-Only
Argument 'origin' is null
Argument 'origin' has been Disposed
Argument 'xVector' is null
Argument 'xVector' has been Disposed
Argument 'yVector' is null
Argument 'yVector' has been Disposed
Argument 'zVector' is null
Argument 'zVector' has been Disposed
Renders a 3D cylinder.
Start point of centre axis.
End point of centre axis.
Radius of cylinder.
Object has been Disposed
Object is Read-Only
Argument 'start' is null
Argument 'start' has been Disposed
Argument 'end' is null
Argument 'end' has been Disposed
Enables or disables depth buffer writing.
Should writing to the depth buffer be enabled.
Object has been Disposed
Object is Read-Only
Enables or disables depth testing.
Should depth testing be enabled.
Object has been Disposed
Object is Read-Only
Renders a 2D axis-aligned ellipse in the XY plane at the current Z depth.
Centre point of the ellipse.
Length of X radius.
Length of Y radius.
Should the ellipse be filled in or an outline.
Object has been Disposed
Object is Read-Only
Argument 'centre' is null
Argument 'centre' has been Disposed
Renders a 2D axis-aligned ellipse in the XY plane at the current Z depth.
Centre point of the ellipse.
Length of X radius.
Length of Y radius.
Should the ellipse be filled in or an outline.
Number of points used to draw ellipse.
Object has been Disposed
Object is Read-Only
Argument 'centre' is null
Argument 'centre' has been Disposed
Ends current complex polygon.
Object has been Disposed
Object is Read-Only
Ends current complex polygon contour.
Object has been Disposed
Object is Read-Only
End rendering in the Model context.
Object has been Disposed
Object is Read-Only
End current convex polygon.
Object has been Disposed
Object is Read-Only
End rendering in the User context.
Object has been Disposed
Object is Read-Only
End rendering in the Window Context.
Object has been Disposed
Object is Read-Only
Returns font metrics.
Object has been Disposed
Object is Read-Only
Argument 'fontInfo' has been Disposed
Argument 'metrics' has been Disposed
Gets a value indicating whether the object is read-only.
Enables or disables lighting.
Should lighting be enabled.
Object has been Disposed
Object is Read-Only
Renders a 2D line in the XY plane at the current depth.
First point of line.
Second point of line.
Object has been Disposed
Object is Read-Only
Argument 'point1' is null
Argument 'point1' has been Disposed
Argument 'point2' is null
Argument 'point2' has been Disposed
Renders a 3D line.
Start point.
End point.
Object has been Disposed
Object is Read-Only
Argument 'start' is null
Argument 'start' has been Disposed
Argument 'end' is null
Argument 'end' has been Disposed
Sets the current line stipple mode.
Factor to stretch pattern by. May be clamped.
Bit pattern to stipple line with.
Object has been Disposed
Object is Read-Only
Sets the current line width.
line width to render with.
Object has been Disposed
Object is Read-Only
Renders a 2D point in the XY plane at the current depth.
Position to render point.
Object has been Disposed
Object is Read-Only
Argument 'point2D' is null
Argument 'point2D' has been Disposed
Renders a 3D point.
Position to render point.
Object has been Disposed
Object is Read-Only
Argument 'point3D' is null
Argument 'point3D' has been Disposed
Tessellation winding rule
Object has been Disposed
Object is Read-Only
Renders a 2D polyline in the XY plane at the current depth.
Array of each point
Object has been Disposed
Object is Read-Only
Argument 'points' is null
Argument 'points' has been Disposed
Renders a 3D polyline.
Array of each point
Object has been Disposed
Object is Read-Only
Argument 'points' is null
Argument 'points' has been Disposed
Renders a 2D rectangle in the XY plane at the current Z depth.
Bottom-left coordinate of rectangle.
Top-right coordinate of rectangle.
Should the rectangle be filled in or an outline.
Object has been Disposed
Object is Read-Only
Argument 'bottomLeft' is null
Argument 'bottomLeft' has been Disposed
Argument 'topRight' is null
Argument 'topRight' has been Disposed
Renders a 3D rectangle.
Origin point of rectangle.
Vector representing 'x' side of rectangle.
Vector representing 'y' side of rectangle.
Should the rectangle be filled in or an outline.
Object has been Disposed
Object is Read-Only
Argument 'origin' is null
Argument 'origin' has been Disposed
Argument 'xVector' is null
Argument 'xVector' has been Disposed
Argument 'yVector' is null
Argument 'yVector' has been Disposed
Set texture image index.
image index registered by Application.RegisterBitmap API.
Object has been Disposed
Object is Read-Only
Renders a 3D sphere.
Center of sphere.
Radius of sphere.
Object has been Disposed
Object is Read-Only
Argument 'center' is null
Argument 'center' has been Disposed
Renders 2D text.Text is rendered in 2D as bitmaps. It always faces the viewer.
Object has been Disposed
Object is Read-Only
Argument 'fontInfo' has been Disposed
Argument 'origin' is null
Argument 'origin' has been Disposed
Returns the extents of 2D text.
Object has been Disposed
Object is Read-Only
Argument 'fontInfo' has been Disposed
Specifies texture co-ordinate for next polygon vertex.
Texture co-ordinate.
Object has been Disposed
Object is Read-Only
Argument 'coordinate' is null
Argument 'coordinate' has been Disposed
Renders a 2D triangle in the XY plane at the current Z depth.
First point of triangle.
Second point of triangle.
Third point of triangle.
Should the triangle be filled in or an outline.
Object has been Disposed
Object is Read-Only
Argument 'point1' is null
Argument 'point1' has been Disposed
Argument 'point2' is null
Argument 'point2' has been Disposed
Argument 'point3' is null
Argument 'point3' has been Disposed
Renders a 3D triangle.
First point on triangle.
Second point on triangle.
Third point on triangle.
Should the triangle be filled in or an outline.
Object has been Disposed
Object is Read-Only
Argument 'point1' is null
Argument 'point1' has been Disposed
Argument 'point2' is null
Argument 'point2' has been Disposed
Argument 'point3' is null
Argument 'point3' has been Disposed
Specifies polygon vertex.
Vertex co-ordinate.
Object has been Disposed
Object is Read-Only
Argument 'coordinate' is null
Argument 'coordinate' has been Disposed
Specifies color of next polygon vertex.
Vertex color.
Vertex alpha value.
Object has been Disposed
Object is Read-Only
Argument 'color' is null
Argument 'color' has been Disposed
Specifies normal of next polygon vertex.
Vertex normal.
Object has been Disposed
Object is Read-Only
Argument 'normal' is null
Argument 'normal' has been Disposed
Returns height of window.
Object has been Disposed
Returns width of window.
Object has been Disposed
Represents an Intersection of two Grid Lines
The display name comprising the two grid line labels and the level label.
Object has been Disposed
Gets a value indicating whether the object is read-only.
The Grid Level this Intersection is on.
Object has been Disposed
The 1st Grid Line forming this Intersection.
Object has been Disposed
The 3D direction of 1st grid line at the point of the intersection.
Object has been Disposed
The 2nd Grid Line forming this Intersection.
Object has been Disposed
The 3D direction of 2nd grid line at the point of the intersection.
Object has been Disposed
The 3D position of the intersection.
Object has been Disposed
A grid level
Returns the intersection of the grid level closest to a given 3D point.
Object has been Disposed
Argument 'point' is null
Argument 'point' has been Disposed
Name of the grid level as diplayed in the GUI.
Object has been Disposed
Evelation of the grid level.
Object has been Disposed
Gets a value indicating whether the object is read-only.
A collection of Grid Levels
Adds item to the end of the collection.
Object has been Disposed
Object is Read-Only
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' is ReadOnly
Adds an item to the .
The to add to the .
The position into which the new element was inserted.
The is read-only.-or- The has a fixed size.
Add the items of the specified collection to the SavedItemCollection
The collection to add items from
Removes all items from the collection
Object has been Disposed
Object is Read-Only
Gets a value indicating whether the object is read-only.
Determines whether the SavedItemCollection contains a specific value.
Object has been Disposed
Argument 'item' has been Disposed
Determines whether the contains a specific value.
The to locate in the .
true if the is found in the ; otherwise, false.
Sets the contents of the collection to the items in from
The collection to copy contents from
Copies the elements of the to an , starting at a particular index.
The one-dimensional that is the destination of the elements copied from . The must have zero-based indexing.
The zero-based index in array at which copying begins.
arrayIndex is less than 0.
array is null.
array is multidimensional.-or-arrayIndex is equal to or greater than the length of array.-or-The number of elements in the source is greater than the available space from arrayIndex to the end of the destination array.-or-Type T cannot be cast automatically to the type of the destination array.
Copies the elements of the to an , starting at a particular index.
The one-dimensional that is the destination of the elements copied from . The must have zero-based indexing.
The zero-based index in array at which copying begins.
array is null.
index is less than zero.
array is multidimensional.-or- index is equal to or greater than the length of array.-or- The number of elements in the source is greater than the available space from index to the end of the destination array.
The type of the source cannot be cast automatically to the type of the destination array.
Enumerates over the collection and copies the items into to
Collection to copy into
Gets the number of elements contained in the collection.
Object has been Disposed
Returns an enumerator that can iterate through the collection.
An IEnumerator that can be used to iterate through the collection.
Gets or sets the element at the specified index.
Object has been Disposed
Object is Read-Only
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' is ReadOnly
Argument 'index' out of range
Determines the index of a specific item in the Collection
Argument 'item' has been Disposed
Determines the index of a specific item in the .
The to locate in the .
The index of value if found in the list; otherwise, -1.
Inserts item into the collection at the specified index
Object has been Disposed
Object is Read-Only
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' is ReadOnly
Argument 'index' out of range
Inserts an item to the at the specified index.
The to insert into the .
The zero-based index at which value should be inserted.
index is not a valid index in the .
The is read-only.-or- The has a fixed size.
value is null reference in the .
Returns an enumerator that can iterate through the collection.
An IEnumerator that
can be used to iterate through the collection.
Gets a value indicating whether the has a fixed size.
true if the has a fixed size; otherwise, false.
Gets a value indicating whether the object is read-only.
Gets a value indicating whether access to the is synchronized (thread safe).
true if access to the is synchronized (thread safe); otherwise, false.
Removes the first occurrence of a specific item from the collection.
The object to remove from the collection.
true if item was successfully removed from the collection; otherwise, false.
This method also returns false if item is not found in the original collection.
The collection is read-only.
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' is ReadOnly
Removes the first occurrence of a specific object from the .
The to remove from the .
The is read-only.-or- The has a fixed size.
Removes the item at the specified index.
The zero-based index of the item to remove.
The is read-only.
index is not a valid index in the .
Gets an object that can be used to synchronize access to the .
An object that can be used to synchronize access to the .
A Grid Line
Name of GridLine as diplayed in the GUI.
Object has been Disposed
Gets a value indicating whether the object is read-only.
A collection of GridLines
Adds item to the end of the collection.
Object has been Disposed
Object is Read-Only
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' is ReadOnly
Adds an item to the .
The to add to the .
The position into which the new element was inserted.
The is read-only.-or- The has a fixed size.
Add the items of the specified collection to the SavedItemCollection
The collection to add items from
Removes all items from the collection
Object has been Disposed
Object is Read-Only
Gets a value indicating whether the object is read-only.
Determines whether the SavedItemCollection contains a specific value.
Object has been Disposed
Argument 'item' has been Disposed
Determines whether the contains a specific value.
The to locate in the .
true if the is found in the ; otherwise, false.
Sets the contents of the collection to the items in from
The collection to copy contents from
Copies the elements of the to an , starting at a particular index.
The one-dimensional that is the destination of the elements copied from . The must have zero-based indexing.
The zero-based index in array at which copying begins.
arrayIndex is less than 0.
array is null.
array is multidimensional.-or-arrayIndex is equal to or greater than the length of array.-or-The number of elements in the source is greater than the available space from arrayIndex to the end of the destination array.-or-Type T cannot be cast automatically to the type of the destination array.
Copies the elements of the to an , starting at a particular index.
The one-dimensional that is the destination of the elements copied from . The must have zero-based indexing.
The zero-based index in array at which copying begins.
array is null.
index is less than zero.
array is multidimensional.-or- index is equal to or greater than the length of array.-or- The number of elements in the source is greater than the available space from index to the end of the destination array.
The type of the source cannot be cast automatically to the type of the destination array.
Enumerates over the collection and copies the items into to
Collection to copy into
Gets the number of elements contained in the collection.
Object has been Disposed
Returns an enumerator that can iterate through the collection.
An IEnumerator that can be used to iterate through the collection.
Gets or sets the element at the specified index.
Object has been Disposed
Object is Read-Only
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' is ReadOnly
Argument 'index' out of range
Determines the index of a specific item in the Collection
Argument 'item' has been Disposed
Determines the index of a specific item in the .
The to locate in the .
The index of value if found in the list; otherwise, -1.
Inserts item into the collection at the specified index
Object has been Disposed
Object is Read-Only
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' is ReadOnly
Argument 'index' out of range
Inserts an item to the at the specified index.
The to insert into the .
The zero-based index at which value should be inserted.
index is not a valid index in the .
The is read-only.-or- The has a fixed size.
value is null reference in the .
Returns an enumerator that can iterate through the collection.
An IEnumerator that
can be used to iterate through the collection.
Gets a value indicating whether the has a fixed size.
true if the has a fixed size; otherwise, false.
Gets a value indicating whether the object is read-only.
Gets a value indicating whether access to the is synchronized (thread safe).
true if access to the is synchronized (thread safe); otherwise, false.
Removes the first occurrence of a specific item from the collection.
The object to remove from the collection.
true if item was successfully removed from the collection; otherwise, false.
This method also returns false if item is not found in the original collection.
The collection is read-only.
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' is ReadOnly
Removes the first occurrence of a specific object from the .
The to remove from the .
The is read-only.-or- The has a fixed size.
Removes the item at the specified index.
The zero-based index of the item to remove.
The is read-only.
index is not a valid index in the .
Gets an object that can be used to synchronize access to the .
An object that can be used to synchronize access to the .
The Grids data as returned by DocumentGrids.Value.
Copy constructor
Argument 'from' is null
Argument 'from' has been Disposed
The Active Grid System
Object has been Disposed
Object is Read-Only
Argument 'system' has been Disposed
Argument 'system' is null
Create a new copy of this item
Object has been Disposed
Gets a value indicating whether the object is read-only.
The render mode for grids and levels.
Object has been Disposed
Object is Read-Only
The collection of all GridSystems within the Document.
Provides access to Grids Options
The color of the Grid lines on the level directly above the camera.
The color of the Grid lines on the level directly below the camera.
Determines if Grids will rendered.
The color of the Grid lines on levels not directly above or below the camera.
Renders occluded grid lines.
Determines which Levels are rendered.
Renders Levels directly above and directly below the current Viewpoint.
Renders the Level directly above the current Viewpoint.
Renders the Level directly below the current Viewpoint.
Renders all Levels.
Renders just the level you are locked to.
A system of grid lines and levels
Returns the location closest to a given 3D point.
Object has been Disposed
Argument 'point' is null
Argument 'point' has been Disposed
Name of GridSystem as diplayed in the GUI.
Object has been Disposed
Gets a value indicating whether the object is read-only.
Accesses Grid Levels contained in this System.
Object has been Disposed
Accesses Grid Lines contained in this System.
Object has been Disposed
Determines if the GridSystem is locked to a particular level
Object has been Disposed
Object is Read-Only
Argument 'level' has been Disposed
Accesses origin point of this System.
Object has been Disposed
Accesses up direction of this System.
Object has been Disposed
A collection of GridSystems.
Adds item to the end of the collection.
Object has been Disposed
Object is Read-Only
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' is ReadOnly
Adds an item to the .
The to add to the .
The position into which the new element was inserted.
The is read-only.-or- The has a fixed size.
Add the items of the specified collection to the SavedItemCollection
The collection to add items from
Removes all items from the collection
Object has been Disposed
Object is Read-Only
Gets a value indicating whether the object is read-only.
Determines whether the SavedItemCollection contains a specific value.
Object has been Disposed
Argument 'item' has been Disposed
Determines whether the contains a specific value.
The to locate in the .
true if the is found in the ; otherwise, false.
Sets the contents of the collection to the items in from
The collection to copy contents from
Copies the elements of the to an , starting at a particular index.
The one-dimensional that is the destination of the elements copied from . The must have zero-based indexing.
The zero-based index in array at which copying begins.
arrayIndex is less than 0.
array is null.
array is multidimensional.-or-arrayIndex is equal to or greater than the length of array.-or-The number of elements in the source is greater than the available space from arrayIndex to the end of the destination array.-or-Type T cannot be cast automatically to the type of the destination array.
Copies the elements of the to an , starting at a particular index.
The one-dimensional that is the destination of the elements copied from . The must have zero-based indexing.
The zero-based index in array at which copying begins.
array is null.
index is less than zero.
array is multidimensional.-or- index is equal to or greater than the length of array.-or- The number of elements in the source is greater than the available space from index to the end of the destination array.
The type of the source cannot be cast automatically to the type of the destination array.
Enumerates over the collection and copies the items into to
Collection to copy into
Gets the number of elements contained in the collection.
Object has been Disposed
Returns an enumerator that can iterate through the collection.
An IEnumerator that can be used to iterate through the collection.
Gets or sets the element at the specified index.
Object has been Disposed
Object is Read-Only
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' is ReadOnly
Argument 'index' out of range
Determines the index of a specific item in the Collection
Argument 'item' has been Disposed
Determines the index of a specific item in the .
The to locate in the .
The index of value if found in the list; otherwise, -1.
Inserts item into the collection at the specified index
Object has been Disposed
Object is Read-Only
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' is ReadOnly
Argument 'index' out of range
Inserts an item to the at the specified index.
The to insert into the .
The zero-based index at which value should be inserted.
index is not a valid index in the .
The is read-only.-or- The has a fixed size.
value is null reference in the .
Returns an enumerator that can iterate through the collection.
An IEnumerator that
can be used to iterate through the collection.
Gets a value indicating whether the has a fixed size.
true if the has a fixed size; otherwise, false.
Gets a value indicating whether the object is read-only.
Gets a value indicating whether access to the is synchronized (thread safe).
true if access to the is synchronized (thread safe); otherwise, false.
Removes the first occurrence of a specific item from the collection.
The object to remove from the collection.
true if item was successfully removed from the collection; otherwise, false.
This method also returns false if item is not found in the original collection.
The collection is read-only.
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' is ReadOnly
Removes the first occurrence of a specific object from the .
The to remove from the .
The is read-only.-or- The has a fixed size.
Removes the item at the specified index.
The zero-based index of the item to remove.
The is read-only.
index is not a valid index in the .
Gets an object that can be used to synchronize access to the .
An object that can be used to synchronize access to the .
Base class for classes which contain a collection of saved items.
Children of the group
Create a new copy of this item without its child-items
Object has been Disposed
Gets a value indicating whether the object is read-only.
Represents a Help Id returned from a call to a ToolPlugin or Input Plugin.
Constructor for a HelpIdResult.
The status of whether the plugin handled the call. If true then HelpId should containg the Help Id.
Help Id being returned.
Represents a hyperlink attached to a ModelItem.
Creates a new hyperlink.
Hyperlink name.
Hyperlink URL.
Creates a new hyperlink from a Uri.
Determines whether the specified object and the current object refer to the same
underlying native object. Returns false if either object has been disposed.
Serves as a hash function for a particular type. is suitable for use in hashing algorithms and data structures like a hash table.
A hash code for the current .
Gets a value indicating whether the object is read-only.
Hyperlink name.
Object has been Disposed
Returns a that represents the current .
A that represents the current .
Hyperlink URL.
Object has been Disposed
A collection of Hyperlinks
Create an empty collection
Create a collection that is a copy of from
Argument 'from' is null
Argument 'from' has been Disposed
Adds item to the end of the collection.
Object has been Disposed
Object is Read-Only
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' is ReadOnly
Adds an item to the .
The to add to the .
The position into which the new element was inserted.
The is read-only.-or- The has a fixed size.
Add the items of the specified collection to the SavedItemCollection
The collection to add items from
Removes all items from the collection
Object has been Disposed
Object is Read-Only
Gets a value indicating whether the object is read-only.
Determines whether the SavedItemCollection contains a specific value.
Object has been Disposed
Argument 'item' has been Disposed
Determines whether the contains a specific value.
The to locate in the .
true if the is found in the ; otherwise, false.
Sets the contents of the collection to the items in from
The collection to copy contents from
Copies the elements of the to an , starting at a particular index.
The one-dimensional that is the destination of the elements copied from . The must have zero-based indexing.
The zero-based index in array at which copying begins.
arrayIndex is less than 0.
array is null.
array is multidimensional.-or-arrayIndex is equal to or greater than the length of array.-or-The number of elements in the source is greater than the available space from arrayIndex to the end of the destination array.-or-Type T cannot be cast automatically to the type of the destination array.
Copies the elements of the to an , starting at a particular index.
The one-dimensional that is the destination of the elements copied from . The must have zero-based indexing.
The zero-based index in array at which copying begins.
array is null.
index is less than zero.
array is multidimensional.-or- index is equal to or greater than the length of array.-or- The number of elements in the source is greater than the available space from index to the end of the destination array.
The type of the source cannot be cast automatically to the type of the destination array.
Enumerates over the collection and copies the items into to
Collection to copy into
Gets the number of elements contained in the collection.
Object has been Disposed
Returns an enumerator that can iterate through the collection.
An IEnumerator that can be used to iterate through the collection.
Gets or sets the element at the specified index.
Object has been Disposed
Object is Read-Only
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' is ReadOnly
Argument 'index' out of range
Determines the index of a specific item in the Collection
Argument 'item' has been Disposed
Determines the index of a specific item in the .
The to locate in the .
The index of value if found in the list; otherwise, -1.
Inserts item into the collection at the specified index
Object has been Disposed
Object is Read-Only
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' is ReadOnly
Argument 'index' out of range
Inserts an item to the at the specified index.
The to insert into the .
The zero-based index at which value should be inserted.
index is not a valid index in the .
The is read-only.-or- The has a fixed size.
value is null reference in the .
Returns an enumerator that can iterate through the collection.
An IEnumerator that
can be used to iterate through the collection.
Gets a value indicating whether the has a fixed size.
true if the has a fixed size; otherwise, false.
Gets a value indicating whether the object is read-only.
Gets a value indicating whether access to the is synchronized (thread safe).
true if access to the is synchronized (thread safe); otherwise, false.
Removes the first occurrence of a specific item from the collection.
The object to remove from the collection.
true if item was successfully removed from the collection; otherwise, false.
This method also returns false if item is not found in the original collection.
The collection is read-only.
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' is ReadOnly
Removes the first occurrence of a specific object from the .
The to remove from the .
The is read-only.-or- The has a fixed size.
Removes the item at the specified index.
The zero-based index of the item to remove.
The is read-only.
index is not a valid index in the .
Gets an object that can be used to synchronize access to the .
An object that can be used to synchronize access to the .
Extends the NET interface to include provision of dynamic properties.
Enumerates the dynamically added members of the object by name.
Fetches the property value specified by the string argument.
Name of the dynamic property to obtain. As with real NET properties, this name is case-sensitive.
Value of the dynamic property retrieved.
Name is not a valid dynamic property.
Sets a value to the property specified by the string argument.
Name of the dynamic property to set. As with real NET properties, this name is case-sensitive.
Value to set. This should match the type of the dynamic property.
The same object as was passed to argument 'value'. This enables settor chaining.
Name is not a valid dynamic property.
Value does not cast to the expected dynamic property type.
Setting to the property is not supported.
Defines the style of the image generation
Render scene
Render scene using ray trace
Render scene plus any overlay such as Redlines
Category of properties stored in DocumentInfo and SheetInfo objects.
Get the display name.
Object has been Disposed
Determines whether the specified object and the current object refer to the same
underlying native object. Returns false if either object has been disposed.
Serves as a hash function for a particular type. is suitable for use in hashing algorithms and data structures like a hash table.
A hash code for the current .
Gets a value indicating whether the object is read-only.
Get the properties
Object has been Disposed
A collection of objects.
Create an empty collection
Gets the number of elements contained in the collection.
Returns an enumerator that can iterate through the collection.
An IEnumerator that can be used to iterate through the collection.
Gets a value indicating whether the object is read-only.
Enumerates key modifiers used in input into Navisworks
No modifier keys pressed
SHIFT modifier key pressed
ALT modifier keys pressed
CTRL modifier key pressed
Double Click
Material Override
Material Override.
May be null.
Material Override.
Material Override.
May be null.
A 3x3 matrix.
Default constructor. Makes an identity matrix.
Make from a rotation.
Argument 'rotation' is null
Argument 'rotation' has been Disposed
Make from elements specified in row major order.
Get determinant of matrix.
Object has been Disposed
Equal within a tolerance, each element of matrix is equal to corresponding element within given tolerance.
Object has been Disposed
Argument 'matrix' is null
Argument 'matrix' has been Disposed
Equal within a tolerance, each element of matrix is equal to corresponding element within given tolerance.
Object has been Disposed
Argument 'matrix' is null
Argument 'matrix' has been Disposed
Determines whether the specified object and the current object refer to the same
underlying native object. Returns false if either object has been disposed.
"Get a single matrix element."
Argument 'row' out of range
Argument 'column' out of range
Serves as a hash function for a particular type. is suitable for use in hashing algorithms and data structures like a hash table.
A hash code for the current .
Is matrix the identity matrix ?
Object has been Disposed
Gets a value indicating whether the object is read-only.
Is matrix a zero matrix? A zero matrix is one where every component is 0.0.
Object has been Disposed
Returns a that represents the current .
A that represents the current .
The type of measurement tool being used.
No measurement type
Distance measurement type
Angle measurement type
Area measurement type
Represents a loaded model within the model hierarchy
Name of creating file loader or design application. Null if unknown.
Object has been Disposed
Determines whether the specified object and the current object refer to the same
underlying native object. Returns false if either object has been disposed.
Filename this model was loaded from
Object has been Disposed
Preferred front vector for model. Will be zero if no front vector defined.
Object has been Disposed
Serves as a hash function for a particular type. is suitable for use in hashing algorithms and data structures like a hash table.
A hash code for the current .
Globally unique identifier for this model
Object has been Disposed
Is there a front vector defined for model ?
Object has been Disposed
Is there a north vector defined for model ?
Object has been Disposed
Is there a right vector defined for model ?
Object has been Disposed
Is there an up vector defined for model ?
Object has been Disposed
Gets a value indicating whether the object is read-only.
Is the transform reflected.
Preferred north vector for model. Will be zero if no north vector defined.
Object has been Disposed
Properties specified when model was last published. Will be null if model has not been published.
Object has been Disposed
Preferred right vector for model. Will be zero if no right vector defined.
Object has been Disposed
Root item of the model hierarchy corresponding to this model
Object has been Disposed
Schema definitions in use by this model.
Object has been Disposed
Original source filename this model was first converted from. Null if unknown.
Object has been Disposed
Get original Guid that this model was created with. Guid may be modified to ensure all models within a sheet have unique Guids. If the same model is appended to a sheet twice, each model has the same SourceGuid but different Guids.
Object has been Disposed
Transform applied to the model.
Units in which dimensions of this model are defined
Object has been Disposed
Preferred up vector for model. Will be zero if no up vector defined.
Object has been Disposed
Names (values of ) of commonly found model creators.
Models created by export from Archicad
Models created by ASCII Laser reader
Models created by Autodesk RealDWG reader
Models created by CIS/2 reader
Models created by DWF reader
Models created by Faro reader
Models created by IFC reader
Models created by IGES reader
Models created by Inventor reader
Models created by JTOpen reader
Models created by Leica reader
Models created by export from 3D Studio Max
Models created by export from Microstation
Models created by Microstation design file (DGN) reader
Models created by Parasolid reader
Models created by export from Revit
Models created by Riegl reader
Models created by RVM reader
Models created by SAT reader
Models created by SketchUp reader
Models created by STEP reader
Models created by STL reader
Models created by 3D Studio reader
Models created by VRML reader
Models created by Z+F reader
Represents geometry within the model hierarchy
Current (visible) color for this geometry
Object has been Disposed
Returns the currently active transform of the geometry.
Object has been Disposed
Current (visible) transparency for this geometry
Object has been Disposed
Bounding box of this geometry in world space
Object has been Disposed
Determines whether the specified object and the current object refer to the same
underlying native object. Returns false if either object has been disposed.
Number of fragments this geometry is divided into
Object has been Disposed
Serves as a hash function for a particular type. is suitable for use in hashing algorithms and data structures like a hash table.
A hash code for the current .
Gets a value indicating whether the object is read-only.
Is this geometry solid ? (Includes triangle primitives which all form closed, manifold shells)
Object has been Disposed
Item in the model hierarchy corresponding to this geometry
Object has been Disposed
Original color for this geometry (as specified by design file)
Object has been Disposed
Returns the original transform of the geometry when it was loaded.
Object has been Disposed
Original transparency for this geometry (as specified by design file)
Object has been Disposed
Permanent color for geometry. Either original color or color explicitly overriden by user.
Transform applied to the original transform of the model geometry.
Permanent transform for the model geometry.
The transform formed as a result of combining the original transform with the override transform.
Permanent transparency for geometry.
Either original transparency or transparency explicitly overriden by user.
Number of primitives (triangles,lines,points) that define this geometry
Object has been Disposed
Types of primitives used to define this geometry
Object has been Disposed
Represents an instance within the model hierarchy, corresponding to an item in the Navisworks selection tree
All ancestors of this item (excluding item itself) within the model hierarchy
All ancestors of this item (including item itself) within the model hierarchy
Calculates bounding box of item and its children
Object has been Disposed
Calculates bounding box of item and its children
Object has been Disposed
Children of this item within the model hierarchy
Display name for type of item, derived from types in original design application.
Object has been Disposed
Name for type of item. Derived from types in original design application.
Object has been Disposed
All descendants of this item (excluding item itself) within the model hierarchy
All descendants of this item (including item itself) within the model hierarchy
End user supplied name for item. May be null.
Object has been Disposed
Determines whether the specified object and the current object refer to the same
underlying native object. Returns false if either object has been disposed.
Depth first search for geometry below this item in hierarchy
First geometry or null if none found
Object has been Disposed
Find ancestor that meets the requirements for First Object selection Behavior
Return ancestor that meets the requirements for First Object selection Behavior or nulll if no ancestor does
Object has been Disposed
Geometry for this item, null if it does not have geometry
Object has been Disposed
Serves as a hash function for a particular type. is suitable for use in hashing algorithms and data structures like a hash table.
A hash code for the current .
Properties of this item filtered so that only the categories that the end user
would see in the GUI are shown (based on global options settings)
Does this item have geometry ?
Object has been Disposed
Does this item refer to a model ?
Object has been Disposed
Guid for the instance data refered to by this item
Object has been Disposed
HashCode for the instance data refered to by this item
Object has been Disposed
All items in the model hierarchy (including this item) that share instance data with this item
Does this item represent a collection ?
Object has been Disposed
Does this item represent a composite object ?
Object has been Disposed
Is this item frozen (frozen items cannot be picked graphically).
Is this item hidden (won't be displayed in viewing window).
Does this item represent an insert ?
Object has been Disposed
Does this item represent a layer ?
Object has been Disposed
Gets a value indicating whether the object is read-only.
Is this item required (will always display in viewing window, won't drop out).
Does this item refer to the same instance data as another item ?
Other item to compare instance data with
Object has been Disposed
Argument 'item' is null
Argument 'item' has been Disposed
Model corresponding to item, null if it does not have a model
Object has been Disposed
Parent item within the model hierarchy, null if this is the root of the hierarchy
Properties of this item divided into multiple categories
This item as an enumerable collection of one item
Returns the Transform attached to this item in the original source design file
Object has been Disposed
A collection of ModelItems. Often used to represent an explicit selection
Create an empty collection
Create a copy of another collection
Argument 'from' is null
Argument 'from' has been Disposed
Argument 'from' is associated with a different document
Adds an item to the .
The object to add to the .
The is read-only.
Add all instances of items included in the selection
Object has been Disposed
Object is Read-Only
Add the items of the specified collection to the ModelItemCollection
The collection to add items from
Are all instances of items included in the selection also in the selection?
Object has been Disposed
Calculates bounding box of all items contained in the selection
Object has been Disposed
Calculates bounding box of all items contained in the selection
Object has been Disposed
Removes all items from the .
The is read-only.
Determines whether the Selection contains a specific value.
The ModelItem to locate in the Selection.
true if item is found in the Selection; otherwise, false.
Sets the contents of the collection to the items in from
Object has been Disposed
Object is Read-Only
Argument 'from' is null
Argument 'from' has been Disposed
Argument 'from' is associated with a different document
Sets the contents of the collection to the items in from
The collection to copy contents from
Copies the elements of the to an , starting at a particular index.
The one-dimensional that is the destination of the elements copied from . The must have zero-based indexing.
The zero-based index in array at which copying begins.
arrayIndex is less than 0.
array is null.
array is multidimensional.-or-arrayIndex is equal to or greater than the length of array.-or-The number of elements in the source is greater than the available space from arrayIndex to the end of the destination array.-or-Type T cannot be cast automatically to the type of the destination array.
Copies the contents of the collection into to
The collection to copy contents into
Gets the number of elements contained in the collection.
All descendants of the items in the collection (excluding the items themselves)
All descendants of the items in the collection (including the items themselves)
Return the first item in the collection or null if empty
Object has been Disposed
Returns an enumerator that can iterate through the collection.
An IEnumerator that can be used to iterate through the collection.
Inverts the selection.
The document to invert the selection relative to.
Should be the same document that you got the original collection from.
Argument 'doc' in null
Is any item in sel contained in selection? Are any items in value contained in any of the items in this selection?
Object has been Disposed
Argument 'value' is null
Argument 'value' has been Disposed
Is item contained in selection? Item must be contained in any of the items in this selection
Object has been Disposed
Argument 'item' is null
Argument 'item' has been Disposed
Is sel contained in selection? Are all items in value contained in any of the items in this selection?
Object has been Disposed
Argument 'value' is null
Argument 'value' has been Disposed
Are any paths contained by this selection also contained by value?
Object has been Disposed
Argument 'value' is null
Argument 'value' has been Disposed
Is no item contained by any other item?
Object has been Disposed
Does the collection represent nothing selected?
Object has been Disposed
Gets a value indicating whether the object is read-only.
Is item a member of this selection?
Object has been Disposed
Argument 'item' is null
Argument 'item' has been Disposed
Is value a subset of this selection? All paths in value must also be in this selection
Object has been Disposed
Argument 'value' is null
Argument 'value' has been Disposed
Remove any selected items that are contained by other items
Object has been Disposed
Object is Read-Only
Replaces this selection by one which contains the same items as this one does while including the minimum number of items.
Object has been Disposed
Object is Read-Only
Removes the first occurrence of a specific ModelItem from the Selection.
The object to remove from the Selection.
true if item was successfully removed from the Selection; otherwise, false. This method also returns false if item is not found in the original Selection.
The Selection is read-only.
Performs comparison 'By Value'
Compares the two references 'By Value'
Filters the items based on a search condition
Filters the items based on a set of search conditions
Collection of ModelItems that only supports Enumerable style interfaces
Default constructor for ModelItemEnumerableCollection
Enumerates over the collection and copies the items into to
Collection to copy into
Returns an empty ModelItemEnumerableCollection
Returns the first item in the enumeration, returns null if the collection is empty
Returns an enumerator that can iterate through the collection.
An IEnumerator that can be used to iterate through the collection.
Returns a that represents the current .
A that represents the current .
Filters the items based on a search condition
Filters the instances based on a set of search conditions
Filters the instances to those with given InstanceGuid
A named integer constant with localized display name. Immutable.
Construct a named integer constant
Value of constant
Base name for constant - actual name will be "baseName:value"
Construct a named integer constant
Value of constant
Base name for constant - actual name will be "baseName:value"
Display name (may be overridden by localized version in .name file)
Construct a named integer constant with value 0
Name of constant
Construct a named integer constant with value 0
Name of constant
Display name (may be overridden by localized version in .name file)
Base name for constant. Related constants (enumerations) have the same base name.
Object has been Disposed
Display name of constant (localized)
Object has been Disposed
Determines whether the specified object and the current object refer to the same
underlying native object. Returns false if either object has been disposed.
Serves as a hash function for a particular type. is suitable for use in hashing algorithms and data structures like a hash table.
A hash code for the current .
Gets a value indicating whether the object is read-only.
Name of constant
Object has been Disposed
Returns a that represents the current .
A that represents the current .
Is this constant the same as another constant.
Object has been Disposed
Argument 'other' is null
Argument 'other' has been Disposed
Value of constant
Object has been Disposed
A collection of objects.
Create an empty collection
Create a collection that is a copy of from
Argument 'from' is null
Argument 'from' has been Disposed
Adds an item to the .
The object to add to the .
The is read-only.
Adds an item to the .
The to add to the .
The position into which the new element was inserted.
The is read-only.-or- The has a fixed size.
Removes all items from the .
The is read-only.
Gets a value indicating whether the object is read-only.
Determines whether the SavedItemCollection contains a specific value.
Object has been Disposed
Argument 'item' has been Disposed
Determines whether the contains a specific value.
The to locate in the .
true if the is found in the ; otherwise, false.
Copies the elements of the to an , starting at a particular index.
The one-dimensional that is the destination of the elements copied from . The must have zero-based indexing.
The zero-based index in array at which copying begins.
arrayIndex is less than 0.
array is null.
array is multidimensional.-or-arrayIndex is equal to or greater than the length of array.-or-The number of elements in the source is greater than the available space from arrayIndex to the end of the destination array.-or-Type T cannot be cast automatically to the type of the destination array.
Copies the elements of the to an , starting at a particular index.
The one-dimensional that is the destination of the elements copied from . The must have zero-based indexing.
The zero-based index in array at which copying begins.
array is null.
index is less than zero.
array is multidimensional.-or- index is equal to or greater than the length of array.-or- The number of elements in the source is greater than the available space from index to the end of the destination array.
The type of the source cannot be cast automatically to the type of the destination array.
Enumerates over the collection and copies the items into to
Collection to copy into
Gets the number of elements contained in the collection.
Object has been Disposed
Removes all items from the .
The is read-only.
Removes the item at the specified index.
The zero-based index of the item to remove.
The is read-only.
index is not a valid index in the .
Returns an enumerator that can iterate through the collection.
An IEnumerator that can be used to iterate through the collection.
Gets or sets the element at the specified index.
Object has been Disposed
Object is Read-Only
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' is ReadOnly
Argument 'index' out of range
Determines the index of a specific item in the Collection
Argument 'item' has been Disposed
Determines the index of a specific item in the .
The to locate in the .
The index of value if found in the list; otherwise, -1.
Inserts an item to the at the specified index.
The object to insert into the .
The zero-based index at which item should be inserted.
The is read-only.
index is not a valid index in the .
Inserts an item to the at the specified index.
The to insert into the .
The zero-based index at which value should be inserted.
index is not a valid index in the .
The is read-only.-or- The has a fixed size.
value is null reference in the .
Returns an enumerator that can iterate through the collection.
An IEnumerator that
can be used to iterate through the collection.
Gets a value indicating whether the has a fixed size.
true if the has a fixed size; otherwise, false.
Gets a value indicating whether the object is read-only.
Gets a value indicating whether access to the is synchronized (thread safe).
true if access to the is synchronized (thread safe); otherwise, false.
Removes the first occurrence of a specific object from the .
The object to remove from the .
true if item was successfully removed from the ; otherwise, false. This method also returns false if item is not found in the original .
The is read-only.
Removes the first occurrence of a specific object from the .
The to remove from the .
The is read-only.-or- The has a fixed size.
Removes the item at the specified index.
The zero-based index of the item to remove.
index is not a valid index in the .
The is read-only.-or- The has a fixed size.
Gets an object that can be used to synchronize access to the .
An object that can be used to synchronize access to the .
Common base class for classes which act as a managed handle to an implementation in native, unmanaged code
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Determines whether the specified object and the current object refer to the same
underlying native object. Returns false if either object has been disposed.
Allows an to attempt to free resources and perform other cleanup operations before the is reclaimed by garbage collection.
Serves as a hash function for a particular type. is suitable for use in hashing algorithms and data structures like a hash table.
A hash code for the current .
Gets a value indicating whether the object has been disposed and is no longer available.
Gets a value indicating whether the object is read-only.
Determines whether the two objects refer to the same underlying native object.
Returns false if either object has been disposed.
Determines whether the two objects refer to different underlying native objects. Returns true
if either object has been disposed.
Determines whether the two handles refer to the same underlying native object.
Returns false if either handle has been disposed.
First NativeHandle
Second NativeHandle
Returns a that represents the current .
A that represents the current .
Default constructor
Should any externally referenced files including ReCap scans and textures be embedded in the exported file?
Object has been Disposed
Object is Read-Only
Should hidden ModelItems be removed from the exported file?
Object has been Disposed
Object is Read-Only
File version to write out to.
Object has been Disposed
Object is Read-Only
Gets a value indicating whether the object is read-only.
Should normal object properties be removed from the exported file?
Object has been Disposed
Object is Read-Only
Represents the result of doing a HitTest in a view
Constructor for PickItemResult.
The model item that was picked.
The normal of the picked item
The picked point on the surface of the picked model item (in world space).
The type of item that was picked
Different types of primitive used to define geometry
Nothing extra to return or do
Snap to tri edge between vertex 0 and 1
Snap to tri edge between vertex 1 and 2
Snap to tri edge between vertex 2 and 0
Snap to any tri edge
Snap to tri vertex 0
Snap to tri vertex 1
Snap to tri vertex 2
Snap to any vertex
Snap to line vertex 0
Snap to line vertex 1
Snap to any line vertex
Snap to middle of the line
Snap to the center of circular and elliptical arcs
Point at pick
Distance at pick
Nearer than near_threshold
Nearest to center, rather than to camera
Ignore surface not under center
The result of a pick action.
Represents a position in 2D space.
Create a zero vector
Exception when 'false'
Create a point from a data object of type Point2D
Argument 'data' is null
Argument 'data' has been Disposed
Create a point from X and Y components
Translates a point by a vector to produce a new point
Object has been Disposed
Argument 'vector' is null
Argument 'vector' has been Disposed
Distance of point from origin
Object has been Disposed
Distance of point from origin squared
Object has been Disposed
Distance from this point to another point
Object has been Disposed
Argument 'other' is null
Argument 'other' has been Disposed
Distance squared from this point to another point
Object has been Disposed
Argument 'other' is null
Argument 'other' has been Disposed
Determines whether the specified object and the current object refer to the same
underlying native object. Returns false if either object has been disposed.
Serves as a hash function for a particular type. is suitable for use in hashing algorithms and data structures like a hash table.
A hash code for the current .
Is this point at the origin (all components zero) ?
Object has been Disposed
Gets a value indicating whether the object is read-only.
Return point at the origin (all components zero)
Creates a new vector from point to this
Object has been Disposed
Argument 'point' is null
Argument 'point' has been Disposed
Translates a point by a vector to produce a new point
Object has been Disposed
Argument 'vector' is null
Argument 'vector' has been Disposed
Converts point to a data object of type Point3D
Object has been Disposed
Compare points using a tolerance
Object has been Disposed
Argument 'point' is null
Argument 'point' has been Disposed
Compare points using a tolerance
Argument 'point0' is null
Argument 'point0' has been Disposed
Argument 'point1' is null
Argument 'point1' has been Disposed
Compare points using a tolerance
Argument 'point0' is null
Argument 'point0' has been Disposed
Argument 'point1' is null
Argument 'point1' has been Disposed
Compare points using a tolerance
Object has been Disposed
Argument 'point' is null
Argument 'point' has been Disposed
Returns a that represents the current .
A that represents the current .
Returns the X component of the point
Object has been Disposed
Returns the Y component of the point
Object has been Disposed
List of 2D points.
Creates an empty list
Adds a point to the back of the list
Object has been Disposed
Object is Read-Only
Argument 'point' has been Disposed
Gets a value indicating whether the object is read-only.
Represents a position in 3D space. Immutable.
Create a zero vector
Exception when 'false'
Create a point from a data object of type Point3D
Argument 'data' is null
Argument 'data' has been Disposed
Create a point from X, Y and Z components
Translates a point by a vector to produce a new point
Object has been Disposed
Argument 'vector' is null
Argument 'vector' has been Disposed
Distance of point from origin
Object has been Disposed
Distance of point from origin squared
Object has been Disposed
Distance from this point to another point
Object has been Disposed
Argument 'other' is null
Argument 'other' has been Disposed
Distance squared from this point to another point
Object has been Disposed
Argument 'other' is null
Argument 'other' has been Disposed
Determines whether the specified object and the current object refer to the same
underlying native object. Returns false if either object has been disposed.
Serves as a hash function for a particular type. is suitable for use in hashing algorithms and data structures like a hash table.
A hash code for the current .
Is this point at the origin (all components zero) ?
Object has been Disposed
Gets a value indicating whether the object is read-only.
Translates a point by a vector to produce a new point
Translates a vector by a point to produce a new point
Creates a new Vector from value2 to value1
Translates a point by a vector to produce a new point
Return point at the origin (all components zero)
Creates a new vector from point to this
Object has been Disposed
Argument 'point' is null
Argument 'point' has been Disposed
Translates a point by a vector to produce a new point
Object has been Disposed
Argument 'vector' is null
Argument 'vector' has been Disposed
Converts point to a data object of type Point3D
Object has been Disposed
Compare points using a tolerance
Object has been Disposed
Argument 'point' is null
Argument 'point' has been Disposed
Compare points using a tolerance
Argument 'point0' is null
Argument 'point0' has been Disposed
Argument 'point1' is null
Argument 'point1' has been Disposed
Compare points using a tolerance
Argument 'point0' is null
Argument 'point0' has been Disposed
Argument 'point1' is null
Argument 'point1' has been Disposed
Compare points using a tolerance
Object has been Disposed
Argument 'point' is null
Argument 'point' has been Disposed
Returns a that represents the current .
A that represents the current .
Convert point to a vector (equivalent to vector from origin to point)
Object has been Disposed
Returns the X component of the point
Object has been Disposed
Returns the Y component of the point
Object has been Disposed
Returns the Z component of the point
Object has been Disposed
List of 3D points.
Creates an empty list
Adds a point to the back of the list
Object has been Disposed
Object is Read-Only
Argument 'point' has been Disposed
Gets a value indicating whether the object is read-only.
Different types of primitive used to define geometry
No primitives
Includes triangle primitives
Includes line primitives
Includes point primitives
Includes snap point primitives
Includes text primitives
Used to report progress of lengthy operations
Starts a sub operation. Progress in sub op between 0 and 1 maps to fraction of remaining time in main operation. Can be nested.
Fraction of remaining time this sub operation will take, between 0 and 1
Object has been Disposed
Object is Read-Only
Starts a sub operation. Progress in sub op between 0 and 1 maps to fraction of remaining time in main operation. Can be nested.
Fraction of remaining time this sub operation will take, between 0 and 1
User message to display for this sub operation.
Object has been Disposed
Object is Read-Only
Forces operation to cancel next time is called
Object has been Disposed
Object is Read-Only
Ends the current sub operation. It may have either fully completed or ended early.
Object has been Disposed
Object is Read-Only
Ends the current sub operation. It may have either fully completed or ended early.
States whether the sub operation completed or not.
Object has been Disposed
Object is Read-Only
Hide the progress if it is a dialog and it needs to get out of the way of another window that is about to open.
Object has been Disposed
Object is Read-Only
Determines if the operation is cancelled.
Object has been Disposed
Object is Read-Only
Gets a value indicating whether the object is read-only.
Report an error immediately to the user.
Application/operation-defined error code.
false if user wants to cancel operation, true if they want to ignore and continue.
Object has been Disposed
Object is Read-Only
Report an error immediately to the user.
Application/operation-defined error code.
User error message.
false if user wants to cancel operation, true if they want to ignore and continue.
Object has been Disposed
Object is Read-Only
Report an error immediately to the user.
Application/operation-defined error code.
User error message.
Is the error related to the current working filename ?
false if user wants to cancel operation, true if they want to ignore and continue.
Object has been Disposed
Object is Read-Only
Show the progress if it is a dialog and was previously hidden.
Object has been Disposed
Object is Read-Only
Updates progress on the current operation or sub-operation
Fraction of operation or sub-operation completed, between 0 and 1
false if user wants to cancel operation, true if they want to continue.
Object has been Disposed
Object is Read-Only
The working filename. Set if multiple files are being processed in this operation to give more detailed information.
Object has been Disposed
Object is Read-Only
Event arguments used for the Application::ProgressBeginning event
Gets the title of the overall operation that progress is being reported for. Displayed in
the title bar of the Navisworks progress dialog.
Event arguments used for the Application::ProgressEnded event
Event arguments used for the Application::ProgressErrorReporting event
Sets a value indicating whether the operation should be canceled.
Gets the error code that describes the current Error.
Gets whether the Error being reported was related to a file operation.
Gets a message that describes the current error.
Gets a reference to the Progress class instance relating to this Event.
Base class for progress related events where event handler can replace standard implementation
Sets a value that indicates whether the event handler has completely handled
the event or whether the system should continue its own processing.
Event arguments used for the Application.ProgressMessageReporting event
Gets a message describing the current operation.
Displayed in Navisworks progress dialog.
Gets a reference to the Progress class instance relating to this Event.
Event arguments used for the Application::ProgressSubOperationBeganEventArgs event
Gets the fraction of remaining time this sub operation will take
Gets a reference to the Progress class instance relating to this Event.
Event arguments used for the Application::ProgressSubOperationEnded event
Gets a value indicating whether the sub-operation was fully completed
Gets a reference to the Progress class instance relating to this Event.
Event arguments used for the Application::ProgressUpdating event
Sets a value indicating whether the operation should be canceled.
Gets the fraction of the overall progress operation that has been done. Displayed in title bar
of Navisworks progress dialog.
Gets a reference to the Progress class instance relating to this Event.
Gets the fraction of the current progress sub-operation that has been done. Displayed in the progress
bar of the Navisworks progress dialog.
Event arguments used for the Application::ProgressVisibility event
Gets a reference to the Progress class instance relating to this Event.
Gets a value indicating whether the progress dialog should be visible or not
Represents result of projecting a point.
Constructor for a projection result.
Depth value (in clip space).
X screen co-ordinate.
Y screen co-ordinate.
A named category of properties
Combined name of category
Display name of category (localized)
Obtain any associated binary data if HasBinaryData is
Returns value of the Int64 stable id contained in this category.
is false
Returns value of the String stable id contained in this category.
is false
Does this category represent binary data?
Does this category contain an Int64 stable id ?
Does this category represent any type of ?
Does this category contain any type of stable id ? A stable id can be used to
identify the same across multiple versions of a .
A category with a stable id contains only a single property with the value of the id.
Does this category contain a String stable id ?
Has this object been disposed ?
Name of category (suitable for programmatic use)
The properties in this category
Obtain any associated if HasSchemaData is
Returns a that represents the current .
A that represents the current .
A collection of objects.
Find first category with specified
Find first category with specified
Find first category with specified
Find first category with a stable id
Find first property with specified
and
Find first property with specified
and
Find first property with specified and
Returns an enumerator that can iterate through the collection.
An IEnumerator that can be used to iterate through the collection.
Gets a value indicating whether the object is read-only.
Names (values of ) of commonly found property categories.
Name of AutoCAD "AutoCad" property category
Name of AutoCAD "Entity Handle" property category
Name of "Geometry" property category
Name of "Hyperlinks" property category
Name of "Item" property category
Name of "Material" property category
Name of Microstation "MicroStation" property category
Name of Microstation "Element Id" property category
Name of Revit "Element Id" property category
Name of "Transform" property category
Name of "XRef" property category
Set of properties used when publishing a file
Default constructor
Copy constructor
Argument 'value' is null
Argument 'value' has been Disposed
Can the file be resaved after it has been published ?
Object has been Disposed
Object is Read-Only
Who created data ?
Object has been Disposed
Object is Read-Only
Any comments
Object has been Disposed
Object is Read-Only
Any copyright statement
Object has been Disposed
Object is Read-Only
Should the publish properties be displayed when asking the user for a password ?
Object has been Disposed
Object is Read-Only
Should the publish properties be displayed when the published file is opened ?
Object has been Disposed
Object is Read-Only
Should any properties from linked databases be embedded in the published file ?
Object has been Disposed
Object is Read-Only
Date that content expires. Only valid if HasExpiryDate is true.
Object has been Disposed
Object is Read-Only
Has the published file been resaved (and possibly modified) since it was published ?
Object has been Disposed
Is there a valid expiry date ?
Object has been Disposed
Is the content password protected ?
Object has been Disposed
Gets a value indicating whether the object is read-only.
Any keywords for searching
Object has been Disposed
Object is Read-Only
Date of publication
Object has been Disposed
Object is Read-Only
Who's the data intended for ?
Object has been Disposed
Object is Read-Only
Who published data ?
Object has been Disposed
Object is Read-Only
Remove any expiry date that has been set
Object has been Disposed
Object is Read-Only
Remove any password that has been set
Object has been Disposed
Object is Read-Only
Set a password to protect the content with when published
Object has been Disposed
Object is Read-Only
Subject
Object has been Disposed
Object is Read-Only
Title of published content
Object has been Disposed
Object is Read-Only
A rotation in 3D space defined as a quaternion.
Default constructor, makes an Identity rotation
Exception when 'false'
Creates rotation that rotates vector1 to same direction as vector2
Argument 'vector1' is null
Argument 'vector1' has been Disposed
Argument 'vector2' is null
Argument 'vector2' has been Disposed
Creates rotation about axis by angle between v1 and v2 projected onto plane normal to axis.
Argument 'axis' is null
Argument 'axis' has been Disposed
Argument 'vector1' is null
Argument 'vector1' has been Disposed
Argument 'vector2' is null
Argument 'vector2' has been Disposed
Creates rotation about given axis by angle in radians
Argument 'axis' is null
Argument 'axis' has been Disposed
Creates rotation from 4 components
The 'A' component of the quaternion
Object has been Disposed
The 'B' component of the quaternion
Object has been Disposed
The 'C' component of the quaternion
Object has been Disposed
Creates a Euler angle rotation.
Parameters are in radians.
Rotation is created by combination of rotations about X, Y and Z axes.
The 'D' component of the quaternion
Object has been Disposed
Determines whether the specified object and the current object refer to the same
underlying native object. Returns false if either object has been disposed.
Serves as a hash function for a particular type. is suitable for use in hashing algorithms and data structures like a hash table.
A hash code for the current .
Creates an Identity rotation
Returns an inverted version of this rotation (all components inverted)
Object has been Disposed
Determines if the Rotation is an identity
Object has been Disposed
Gets a value indicating whether the object is read-only.
Returns a normalized version of this rotation (magnitude of 1)
Object has been Disposed
Calculates an axis and angle representation of this rotation.
Calculates the Euler angles for this rotation.
Equal within a tolerance, treating quaternion as 4D position. Equality of representation, not of rotation.
Object has been Disposed
Argument 'rotation' is null
Argument 'rotation' has been Disposed
Equal within a tolerance, treating quaternion as 4D position. Equality of representation, not of rotation.
Object has been Disposed
Argument 'rotation' is null
Argument 'rotation' has been Disposed
Returns a that represents the current .
A that represents the current .
An instance of a rule that is used by plugins to apply behaviour.
Determines if all of the required parameters for the rule have been set.
Object has been Disposed
Creates a copy of the rule.
Object has been Disposed
Name of the rule as diplayed in the GUI.
Object has been Disposed
Object is Read-Only
Determines if this rule is enabled.
Object has been Disposed
Object is Read-Only
Determines if the plugin that implements this rule has been found.
Object has been Disposed
Gets a value indicating whether the object is read-only.
Determines if any of the required parameters for the rule have been set.
Object has been Disposed
Performs comparison 'By Value'
Compares the two references 'By Value'
A collection of Rules
Create an empty collection
Adds item to the end of the collection.
Object has been Disposed
Object is Read-Only
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' is ReadOnly
Adds an item to the .
The to add to the .
The position into which the new element was inserted.
The is read-only.-or- The has a fixed size.
Add the items of the specified collection to the SavedItemCollection
The collection to add items from
Removes all items from the collection
Object has been Disposed
Object is Read-Only
Gets a value indicating whether the object is read-only.
Determines whether the SavedItemCollection contains a specific value.
Object has been Disposed
Argument 'item' has been Disposed
Determines whether the contains a specific value.
The to locate in the .
true if the is found in the ; otherwise, false.
Sets the contents of the collection to the items in from
The collection to copy contents from
Copies the elements of the to an , starting at a particular index.
The one-dimensional that is the destination of the elements copied from . The must have zero-based indexing.
The zero-based index in array at which copying begins.
arrayIndex is less than 0.
array is null.
array is multidimensional.-or-arrayIndex is equal to or greater than the length of array.-or-The number of elements in the source is greater than the available space from arrayIndex to the end of the destination array.-or-Type T cannot be cast automatically to the type of the destination array.
Copies the elements of the to an , starting at a particular index.
The one-dimensional that is the destination of the elements copied from . The must have zero-based indexing.
The zero-based index in array at which copying begins.
array is null.
index is less than zero.
array is multidimensional.-or- index is equal to or greater than the length of array.-or- The number of elements in the source is greater than the available space from index to the end of the destination array.
The type of the source cannot be cast automatically to the type of the destination array.
Enumerates over the collection and copies the items into to
Collection to copy into
Gets the number of elements contained in the collection.
Object has been Disposed
Creates a deep copy of the collection.
Object has been Disposed
Returns an enumerator that can iterate through the collection.
An IEnumerator that can be used to iterate through the collection.
Gets or sets the element at the specified index.
Object has been Disposed
Object is Read-Only
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' is ReadOnly
Argument 'index' out of range
Determines the index of a specific item in the Collection
Argument 'item' has been Disposed
Determines the index of a specific item in the .
The to locate in the .
The index of value if found in the list; otherwise, -1.
Inserts item into the collection at the specified index
Object has been Disposed
Object is Read-Only
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' is ReadOnly
Argument 'index' out of range
Inserts an item to the at the specified index.
The to insert into the .
The zero-based index at which value should be inserted.
index is not a valid index in the .
The is read-only.-or- The has a fixed size.
value is null reference in the .
Returns an enumerator that can iterate through the collection.
An IEnumerator that
can be used to iterate through the collection.
Gets a value indicating whether the has a fixed size.
true if the has a fixed size; otherwise, false.
Gets a value indicating whether the object is read-only.
Gets a value indicating whether access to the is synchronized (thread safe).
true if access to the is synchronized (thread safe); otherwise, false.
Maintains existing list as far as possible while
making sure that same rules exist as in source, with
rules not in source disabled.
Object has been Disposed
Object is Read-Only
Argument 'source' is null
Argument 'source' has been Disposed
Removes the first occurrence of a specific item from the collection.
The object to remove from the collection.
true if item was successfully removed from the collection; otherwise, false.
This method also returns false if item is not found in the original collection.
The collection is read-only.
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' is ReadOnly
Removes the first occurrence of a specific object from the .
The to remove from the .
The is read-only.-or- The has a fixed size.
Removes the item at the specified index.
The zero-based index of the item to remove.
The is read-only.
index is not a valid index in the .
Gets an object that can be used to synchronize access to the .
An object that can be used to synchronize access to the .
Performs comparison 'By Value'
Compares the two references 'By Value'
The exception that is thrown when trying to use a Navisworks control but
the control can't find a Navisworks runtime to use.
For example if no Navisworks product is installed.
Creates a RuntimeLoaderException
Creates a RuntimeLoaderException
Creates a RuntimeLoaderException
The error message that explains the reason for the exception.
Creates a RuntimeLoaderException
The error message that explains the reason for the exception.
The exception that is the cause of the current exception. If the innerException parameter is not null, the current exception is raised in a catch block that handles the inner exception.
Base class for all saved items.
Indicates whether the implementation of Transform() will do anything
Object has been Disposed
Comments about the item
Object has been Disposed
Create a new copy of this item
Object has been Disposed
Create a new item of the same type as this item
Object has been Disposed
Create an unique copy of item
Object has been Disposed
Name for item as displayed in the GUI
Object has been Disposed
Object is Read-Only
Globally Unique Id for item
Object has been Disposed
Object is Read-Only
True if this item is a GroupItem
Object has been Disposed
Gets a value indicating whether the object is read-only.
Makes a name unique within the immediate children on the group
group to make unique name
Object has been Disposed
Object is Read-Only
Argument 'group' has been Disposed
Makes a name unique within the immediate children on the group
group to make unique name
salt string to use in making a name unique
Object has been Disposed
Object is Read-Only
Argument 'group' has been Disposed
Parent of this item. Null if item has no parent
Object has been Disposed
Apply the given transform to the item
Object has been Disposed
Object is Read-Only
Argument 'transform' is null
Argument 'transform' has been Disposed
Describes the action that caused a changed event for a -based
part.
An item was added or inserted
An item was removed
An item was replaced
An item was moved within the SavedItem hierarchy
An item was edited within the SavedItem hierarchy
The contents of the Document part have changed dramatically
Event arguments when a hierarchy changes
Gets the action that caused the event
Gets the parts of the item that were edited (None if Action is not equal to Edit)
Gets the index within NewParent at which a Add, Replace, Edit or Move action occurred.
Gets the item effected by a Add, Replace, Edit or Move action.
Gets the new Parent of the item effected by a Add, Replace, Edit or Move action.
Gets the index within OldParent at which a Remove, Replace, Edit or Move action occurred.
Gets the old item effected by a Remove, Replace, Edit or Move action. For an Edit action only
the parts of the item specified by EditedParts are valid.
Gets the old Parent of the item effected by a Remove, Replace, Edit or Move action.
Collection of SavedItems that stores the children
of a .
Adds item to the end of the collection.
Object has been Disposed
Object is Read-Only
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' is ReadOnly
Argument 'item' contains an unsupported type of SavedItem
Add the items of the specified collection to the SavedItemCollection
The collection to add items from
Determines whether item can be added to the collection.
false if item is ReadOnly or of an incompatible type
Removes all items from the collection
Object has been Disposed
Object is Read-Only
Determines whether the SavedItemCollection contains a specific value.
Object has been Disposed
Argument 'item' has been Disposed
Sets the contents of the collection to the items in from
The collection to copy contents from
Copies the elements of the to an , starting at a particular index.
The one-dimensional that is the destination of the elements copied from . The must have zero-based indexing.
The zero-based index in array at which copying begins.
arrayIndex is less than 0.
array is null.
array is multidimensional.-or-arrayIndex is equal to or greater than the length of array.-or-The number of elements in the source is greater than the available space from arrayIndex to the end of the destination array.-or-Type T cannot be cast automatically to the type of the destination array.
Enumerates over the collection and copies the items into to
Collection to copy into
Gets the number of elements contained in the collection.
Object has been Disposed
Returns an enumerator that can iterate through the collection.
An IEnumerator that
can be used to iterate through the collection.
Determines the index of a specific item in the SavedItemCollection
Argument 'item' has been Disposed
Determines the index of the first item in the collection with the specified DisplayName
Index of first item or -1 if none found
Determines the index of the first item in the collection with the specified guid
Index of first item or -1 if none found
Inserts item into the collection at the specified index
Object has been Disposed
Object is Read-Only
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' is ReadOnly
Argument 'item' contains an unsupported type of SavedItem
Argument 'index' out of range
Gets a value indicating whether the collection is read-only.
Removes the first occurrence of a specific item from the collection.
The object to remove from the collection.
true if item was successfully removed from the collection; otherwise, false.
This method also returns false if item is not found in the original collection.
The collection is read-only.
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' is ReadOnly
Removes the item at the specified index.
The zero-based index of the item to remove.
The is read-only.
index is not a valid index in the .
Performs a case-insensitive lexicographical sort of the items in the collection.
Folders sort to top (like Windows Explorer).
Performs a case-insensitive lexicographical sort of the items in the collection.
Folders sort to top (like Windows Explorer).
Specifies parts of a
No parts
DisplayName property
Comments
Additional data attached to a
A part specific to a particular subclass of SavedItem
A part specific to a particular subclass of SavedItem
A part specific to a particular subclass of SavedItem
A part specific to a particular subclass of SavedItem
A part specific to a particular subclass of SavedItem
A part specific to a particular subclass of SavedItem
A part specific to a particular subclass of SavedItem
A part specific to a particular subclass of SavedItem
A part specific to a particular subclass of SavedItem
A part specific to a particular subclass of SavedItem
A part specific to a particular subclass of SavedItem
A part specific to a particular subclass of SavedItem
A part specific to a particular subclass of SavedItem
A part specific to a particular subclass of SavedItem
A part specific to a particular subclass of SavedItem
A part specific to a particular subclass of SavedItem
A part specific to a particular subclass of SavedItem
A part specific to a particular subclass of SavedItem
A part specific to a particular subclass of SavedItem
A part specific to a particular subclass of SavedItem
All parts specific to a particular subclass of SavedItem
All parts
Represents a reference to a saved item. Immutable.
Creates an empty reference.
Creates a copy of a saved item reference.
Argument 'value' is null
Argument 'value' has been Disposed
Creates a reference to a saved item in a document part.
Argument 'documentPartId' is not convertable to a 7-bit ASCII string
Display string for the reference.
Identifies the document part containing the item.
Object has been Disposed
Determines whether the specified object and the current object refer to the same
underlying native object. Returns false if either object has been disposed.
Serves as a hash function for a particular type. is suitable for use in hashing algorithms and data structures like a hash table.
A hash code for the current .
True if this doesn't reference any saved item.
Object has been Disposed
Gets a value indicating whether the object is read-only.
Identifies a saved item within a particular document part.
Object has been Disposed
Returns a that represents the current .
A that represents the current .
A named saved viewpoint.
Default constructor
Exception when 'false'
Initialize SavedViewpoint with a Viewpoint
Argument 'viewpoint' is null
Argument 'viewpoint' has been Disposed
Determines if this SavedViewpoint contains material overrides.
Determines if this SavedViewpoint contains visibility overrides.
Gets material overrides for this SavedViewpoint.
Gets visibility overrides for this SavedViewpoint.
Gets a value indicating whether the object is read-only.
Acesses the Viewpoint ascociated with this object.
Object has been Disposed
An animation consisting of SavedViewpoints and SavedViewpointAnimationCuts.
Default constructor
Gets a value indicating whether the object is read-only.
Does the animation run on a continuous loop
Object has been Disposed
Object is Read-Only
Control the interpolation between frames
Object has been Disposed
Object is Read-Only
Simple cut from one frame in an animation to another.
Default constructor
Time in seconds of the delay
Object has been Disposed
Object is Read-Only
Gets a value indicating whether the object is read-only.
Defines a search that can be run to find ModelItems
Create a clear search
Create a copy of another search
Argument 'from' is null
Argument 'from' has been Disposed
True if the search conditions and selection critera are compatible between this and another search
Object has been Disposed
Argument 'spec' is null
Argument 'spec' has been Disposed
Clears search back to it's default state
Object has been Disposed
Object is Read-Only
Returns a ModelItemCollection that represents the items specified by this Search in document.
Document to search
true if progress should be reported via normal progress reporting
Argument 'document' is null
Search Selection contains explicit items from a different document
End user cancels operation through progress interface
Returns a ModelItemCollection that represents the items specified by this Search in the document
which it is associated with.
true if progress should be reported via normal progress reporting
No document is associated with this Search
End user cancels operation through progress interface
Returns the first ModelItem specified by this Search in document. Returns null if none found.
Document to search
true if progress should be reported via normal progress reporting
Argument 'document' is null
Search Selection contains explicit items from a different document
End user cancels operation through progress interface
Returns the first ModelItem specified by this Search in the document
which it is associated with. Returns null if none found.
true if progress should be reported via normal progress reporting
No document is associated with this Search
End user cancels operation through progress interface
Returns an enumerable that steps through the items specified by this Search in document.
Document to search
true if progress should be reported via normal progress reporting
Argument 'document' is null
Search Selection contains explicit items from a different document
End user cancels operation through progress interface
Returns a an enumerable that steps through the items specified by this Search in the document
which it is associated with.
true if progress should be reported via normal progress reporting
No document is associated with this Search
End user cancels operation through progress interface
True if selection is clear, and there are no search conditions
Object has been Disposed
Gets a value indicating whether the object is read-only.
Locations within Selection to search. Default is DescendantsAndSelf.
Object has been Disposed
Object is Read-Only
Merges another Search into this Search, appending its conditions as a new group of conditions.
Search to merge.
A merge could not be performed, as the searches are incompatible e.g. different model selections searched.
When value is true, search ignores descendants of any matching model items. Default is true.
Object has been Disposed
Object is Read-Only
Search conditions that will be applied during search
Object has been Disposed
Selection that will be searched
Object has been Disposed
Attempts to merge another Search into this Search, combining conditions of search as a new group of conditions. Returns true if
the merge is successful, and false if the Searches are incompatible e.g. different model selections searched.
Search to merge.
Performs comparison 'By Value'
Compares the two references 'By Value'
Defines a based condition for use in searches. Immutable.
Create a search condition
Combined name for category to compare against
Combined name for property to compare against
Options to use when evaluating condition
Comparison operator to use when evaluating condition
Value to compare against when evaluating condition
Argument 'categoryCombinedName' has been Disposed
Argument 'propertyCombinedName' has been Disposed
Argument 'value' is null
Argument 'value' has been Disposed
Combined name for category to compare against
Object has been Disposed
Creates condition that matches if item has property specified by this condition and compares successfully with value
Invalid operation when '!PropertyCombinedName'
Object has been Disposed
Argument 'value' is null
Argument 'value' has been Disposed
Comparison operator to use when evaluating condition
Object has been Disposed
Creates condition that matches if item has property specified by this condition and has a DisplayString value that contains specified string
Invalid operation when '!PropertyCombinedName'
Object has been Disposed
Creates condition that matches if item has property specified by this condition and has a DisplayString value that matches specified wildcard string
Invalid operation when '!PropertyCombinedName'
Object has been Disposed
Determines whether the specified object and the current object refer to the same
underlying native object. Returns false if either object has been disposed.
Creates condition that matches if item has property specified by this condition and equal value
Invalid operation when '!PropertyCombinedName'
Object has been Disposed
Argument 'value' is null
Argument 'value' has been Disposed
Serves as a hash function for a particular type. is suitable for use in hashing algorithms and data structures like a hash table.
A hash code for the current .
Creates condition that matches if item has category with specified CombinedName
Argument 'combinedName' has been Disposed
Argument 'combinedName' is null
Creates condition that matches if item has category with specified DisplayName
Argument 'displayName' is null
Creates condition that matches if item has category with specified Name
Argument 'name' is null
Creates condition that matches if item has property in category with specified CombinedNames
Argument 'categoryCombinedName' has been Disposed
Argument 'categoryCombinedName' is null
Argument 'propertyCombinedName' has been Disposed
Argument 'propertyCombinedName' is null
Creates condition that matches if item has property in category with specified DisplayNames
Argument 'categoryDisplayName' is null
Argument 'propertyDisplayName' is null
Creates condition that matches if item has property in category with specified Names
Argument 'categoryName' is null
Argument 'propertyName' is null
Creates condition that matches if item matches this condition while ignoring accents during string value comparisons
Object has been Disposed
Creates condition that matches if item matches this condition while ignoring case during string value comparisons
Object has been Disposed
Creates condition that matches if item matches this condition while ignoring character widths during string value comparisons
Object has been Disposed
Gets a value indicating whether the object is read-only.
Creates condition that matches if item does not match this condition
Object has been Disposed
Options to use when evaluating condition
Object has been Disposed
Combined name for property to compare against
Object has been Disposed
Creates condition that matches if item has property specified by this condition and value of specified type
Invalid operation when '!PropertyCombinedName'
Object has been Disposed
Creates condition that is same as this condition with option set
Object has been Disposed
Returns a that represents the current .
A that represents the current .
Value to compare against when evaluating condition
Object has been Disposed
A collection of SearchConditions
Create an empty collection
Create a collection that is a copy of from
Argument 'from' is null
Argument 'from' has been Disposed
Adds item to the end of the collection.
Object has been Disposed
Object is Read-Only
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' is ReadOnly
Adds an item to the .
The to add to the .
The position into which the new element was inserted.
The is read-only.-or- The has a fixed size.
Add the items of the specified collection to the SearchConditionCollection
as a new group of conditions. The combined set of SearchConditions will match
if any group within the set matches.
The collection to add the items from
Add the items of the specified collection to the SavedItemCollection
The collection to add items from
Removes all items from the collection
Object has been Disposed
Object is Read-Only
Gets a value indicating whether the object is read-only.
Determines whether the SavedItemCollection contains a specific value.
Object has been Disposed
Argument 'item' has been Disposed
Determines whether the contains a specific value.
The to locate in the .
true if the is found in the ; otherwise, false.
Sets the contents of the collection to the items in from
The collection to copy contents from
Copies the elements of the to an , starting at a particular index.
The one-dimensional that is the destination of the elements copied from . The must have zero-based indexing.
The zero-based index in array at which copying begins.
arrayIndex is less than 0.
array is null.
array is multidimensional.-or-arrayIndex is equal to or greater than the length of array.-or-The number of elements in the source is greater than the available space from arrayIndex to the end of the destination array.-or-Type T cannot be cast automatically to the type of the destination array.
Copies the elements of the to an , starting at a particular index.
The one-dimensional that is the destination of the elements copied from . The must have zero-based indexing.
The zero-based index in array at which copying begins.
array is null.
index is less than zero.
array is multidimensional.-or- index is equal to or greater than the length of array.-or- The number of elements in the source is greater than the available space from index to the end of the destination array.
The type of the source cannot be cast automatically to the type of the destination array.
Enumerates over the collection and copies the items into to
Collection to copy into
Gets the number of elements contained in the collection.
Object has been Disposed
Returns an enumerator that can iterate through the collection.
An IEnumerator that can be used to iterate through the collection.
Gets or sets the element at the specified index.
Object has been Disposed
Object is Read-Only
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' is ReadOnly
Argument 'index' out of range
Determines the index of a specific item in the Collection
Argument 'item' has been Disposed
Determines the index of a specific item in the .
The to locate in the .
The index of value if found in the list; otherwise, -1.
Inserts item into the collection at the specified index
Object has been Disposed
Object is Read-Only
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' is ReadOnly
Argument 'index' out of range
Inserts an item to the at the specified index.
The to insert into the .
The zero-based index at which value should be inserted.
index is not a valid index in the .
The is read-only.-or- The has a fixed size.
value is null reference in the .
Returns an enumerator that can iterate through the collection.
An IEnumerator that
can be used to iterate through the collection.
Gets a value indicating whether the has a fixed size.
true if the has a fixed size; otherwise, false.
Gets a value indicating whether the object is read-only.
Gets a value indicating whether access to the is synchronized (thread safe).
true if access to the is synchronized (thread safe); otherwise, false.
Removes the first occurrence of a specific item from the collection.
The object to remove from the collection.
true if item was successfully removed from the collection; otherwise, false.
This method also returns false if item is not found in the original collection.
The collection is read-only.
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' is ReadOnly
Removes the first occurrence of a specific object from the .
The to remove from the .
The is read-only.-or- The has a fixed size.
Removes the item at the specified index.
The zero-based index of the item to remove.
The is read-only.
index is not a valid index in the .
Gets an object that can be used to synchronize access to the .
An object that can be used to synchronize access to the .
Specifies comparison operator used to see whether a will match
Never matches
Matches if item has specified category
Matches if item does not have specified category
Matches if item has the specified property in the specified category
Matches if item does not have the specified property in the specified category
Matches if specified property exists and value has the same
Matches if specified property exists and has the same value
Matches if specified property exists and does not have the same value
Matches if specified property exists, has the same numeric (Int32, AnyDouble, DateTime) and property value less than condition value
Matches if specified property exists, has the same numeric (Int32, AnyDouble, DateTime) and property value less than or equal to condition value
Matches if specified property exists, has the same numeric (Int32, AnyDouble, DateTime) and property value greater than or equal to condition value
Matches if specified property exists, has the same numeric (Int32, AnyDouble, DateTime) and property value greater than condition value
Matches if specified property exists, is of DisplayString type and contains the display string in condition value
Matches if specified property exists, is of DisplayString type and matches the wildcard display string in condition value
Matches if specified property exists, is of DateTime type and is within one day prior to the DateTime in condition value
Matches if specified property exists, is of DateTime type and is within one week prior to the DateTime in condition value
Options that modify matching behavior
No additional options
Do not compare DisplayName when looking for matching category
Do not compare Name when looking for matching category
Do not compare DisplayName when looking for matching property
Do not compare Name when looking for matching property
Ignore case when comparing DisplayString values
Negate the sense of the condition
When used in a , marks the start of a group of conditions. Collection matches if any group of conditions matches.
Ignore accents when comparing DisplayString values
Ignore character width when comparing DisplayString values
Do not compare DisplayName when looking for matching category or property
Do not compare Name when looking for matching category or property
Which items within a Selection should be searched
No items
Direct contents of the selection
Descendants of the items in the selection
Direct contents of the selection and their descendants
Represents a selection as either an explicit collection of ModelItems or as a collection of SelectionSources that will generate a selection on demand.
Create a clear selection
Create a selection as a explicit collection of ModelItems
Argument 'from' is null
Argument 'from' has been Disposed
Argument 'from' is associated with a different document
Create a copy of another selection
Argument 'from' is null
Argument 'from' has been Disposed
Argument 'from' is associated with a different document
Create a selection as a collection of SelectionSources
Argument 'from' is null
Argument 'from' has been Disposed
Argument 'from' is associated with a different document
Reset selection to the default state, explicit and nothing selected
Object has been Disposed
Object is Read-Only
Initialise as explicit selection with a copy of items
Object has been Disposed
Object is Read-Only
Argument 'from' is null
Argument 'from' has been Disposed
Argument 'from' is associated with a different document
Initialise selection with a copy of another selection
Object has been Disposed
Object is Read-Only
Argument 'from' is null
Argument 'from' has been Disposed
Argument 'from' is associated with a different document
Initialise as collection of SelectionSources
Object has been Disposed
Object is Read-Only
Argument 'from' is null
Argument 'from' has been Disposed
Argument 'from' is associated with a different document
Initialise as explicit selection with items in from
The collection to copy contents from
Object is Read-Only
Selection as explicit collection of ModelItems
Invalid operation when '!HasExplicitSelection'
Object has been Disposed
Returns a ModelItemCollection that represents the items specified by this Selection in the document
which it is associated with.
No document is associated with this selection
Returns a ModelItemCollection that represents the items specified by this Selection in document.
Selection contains explicit items from a different document
Does this selection contain an explicit collection of ModelItems ?
Object has been Disposed
Does this selection contain a collection of SelectionSources ?
Object has been Disposed
Is this the default selection (explicit and nothing selected) ?
Object has been Disposed
Gets a value indicating whether the object is read-only.
Initialises selection with a selection source that selects everything in document when resolved
Object has been Disposed
Object is Read-Only
Selection as collection of SelectionSources
Invalid operation when '!(HasSelectionSources || IsClear)'
Object has been Disposed
Performs comparison 'By Value'
Compares the two references 'By Value'
Determines which ModelItem is selected when using the Select tool to pick an object
First item containing object picked that HasModel (File)
First item containing object picked that IsLayer
First item containing object picked that is child of IsLayer item
Last item containing object picked that has Instances count of 1
Last item containing object picked that HasGeometry
First item that only contains object picked
Picking has no effect (selection does not change)
Last item containing object picked that IsComposite
Custom selection behaviour, defined by the application
containing a saved or
Create a SelectionSet with empty ExplicitModelItems
Create a SelectionSet with ExplicitModelItems
Argument 'items' is null
Argument 'items' has been Disposed
Create a SelectionSet with a Search
Argument 'search' is null
Argument 'search' has been Disposed
Argument 'search' has no SearchConditions
Create a copy of another SelectionSet
Argument 'value' is null
Argument 'value' has been Disposed
Initialize SelectionSet with copy of ExplicitModelItems
Object has been Disposed
Object is Read-Only
Argument 'items' is null
Argument 'items' has been Disposed
Initialize SelectionSet with copy of a Search
Object has been Disposed
Object is Read-Only
Argument 'search' is null
Argument 'search' has been Disposed
Argument 'search' has no SearchConditions
Initialize SelectionSet with copy of another SelectionSet
Object has been Disposed
Object is Read-Only
Argument 'value' is null
Argument 'value' has been Disposed
Initialise as explicit ModelItems with items in from
The collection to copy contents from
Object is Read-Only
The explicit ModelItems stored in the selection set
Invalid operation when '!HasExplicitModelItems'
Object has been Disposed
Returns a ModelItemCollection that represents the items specified by this SelectionSet in the document
which it is associated with.
No document is associated with this SelectionSet
Returns a ModelItemCollection that represents the items specified by this SelectionSet in document.
Document to search (if required)
Argument 'document' is null
SelectionSet contains explicit items from a different document
Does the SelectionSet contain an explicit set of ModelItems ?
Object has been Disposed
Does the SelectionSet contain a Search ?
Object has been Disposed
Gets a value indicating whether the object is read-only.
The Search stored in the selection set
Invalid operation when '!HasSearch'
Object has been Disposed
Performs comparison 'By Value'
Compares the two references 'By Value'
Represents a reference to a source that can generate a selection on demand. Immutable.
Determines whether the specified object and the current object refer to the same
underlying native object. Returns false if either object has been disposed.
Serves as a hash function for a particular type. is suitable for use in hashing algorithms and data structures like a hash table.
A hash code for the current .
Object has been Disposed
Gets a value indicating whether the object is read-only.
Returns a that represents the current .
A that represents the current .
Returns a that will generate the selected items specified by the selection source
null if source could not be resolved or source does not represent selection as a Search
Returns a that represents the selected items specified by the selection source
null if source could not be resolved
A collection of SelectionSources
Create an empty collection
Create a collection that is a copy of from
Argument 'from' is null
Argument 'from' has been Disposed
Adds an item to the .
The object to add to the .
The is read-only.
Add the items of the specified collection to the SelectionSourceCollection
The collection to add items from
Removes all items from the .
The is read-only.
Determines whether the SelectionSourceCollection contains a specific value.
Sets the contents of the collection to the items in from
The collection to copy contents from
Copies the elements of the to an , starting at a particular index.
The one-dimensional that is the destination of the elements copied from . The must have zero-based indexing.
The zero-based index in array at which copying begins.
arrayIndex is less than 0.
array is null.
array is multidimensional.-or-arrayIndex is equal to or greater than the length of array.-or-The number of elements in the source is greater than the available space from arrayIndex to the end of the destination array.-or-Type T cannot be cast automatically to the type of the destination array.
Copies the contents of the collection into to
The collection to copy contents into
Gets the number of elements contained in the collection.
Returns an enumerator that can iterate through the collection.
An IEnumerator that can be used to iterate through the collection.
Determines the index of a specific item in the SelectionSourceCollection
Inserts an item to the at the specified index.
The object to insert into the .
The zero-based index at which item should be inserted.
The is read-only.
index is not a valid index in the .
Gets a value indicating whether the object is read-only.
Removes the first occurrence of a specific item from the collection.
The object to remove from the collection.
true if item was successfully removed from the collection; otherwise, false. This method also returns false if item is not found in the original collection.
The collection is read-only.
Removes the item at the specified index.
The zero-based index of the item to remove.
The is read-only.
index is not a valid index in the .
Performs comparison 'By Value'
Compares the two references 'By Value'
Sign In Server Type.
Production.
Staging.
Development.
Sheet information. Often used to represent a sheet in a multi-sheet file
Checks whether this sheet has been previously converted and will load quickly if required
Checks whether this sheet has been previously converted and can be searched without loading
Checks whether this sheet contains matching modelItem.
ModelItem to check
Returns false if this sheet does not contain matching ModelItem or this sheet hasn't been previously converted
item is null.
Return a copy with unique sheet id
Uniquely identifies a specific sheet within a file
Object has been Disposed
Get whether the sheet has been loaded during the current Navisworks session
Object has been Disposed
Gets a value indicating whether the object is read-only.
Get the property category collection
Object has been Disposed
Get type of sheet
Object has been Disposed
Get original Guid that this sheet was created with. Guid may be modified to ensure all sheets have unique Guids. If the same sheet is added to a document twice, each sheet has the same SourceGuid but different Guids.
Object has been Disposed
Get the sheet thumbnail file name
Object has been Disposed
Determines which type the sheet is
Sheet contains a 3D model
Sheet contains a 2D model (plot)
Type of simulation being run.
No simulation
Timeliner simulation
Animator simulation
The stereo mode in use in stereo viewing options.
Objects look as if they're behind the screen
Focal point is on screen, objects can be in front and behind
Tessellation winding rule
Winding rule odd
Winding rule non-zero
Winding rule positive
Winding rule negative
Winding rule Abs_GEq_Two
Extents of a 2D text object. Immutable.
Creates an empty extents object.
Creates a new extents object.
Bounding box
Object has been Disposed
Determines whether the specified object and the current object refer to the same
underlying native object. Returns false if either object has been disposed.
Serves as a hash function for a particular type. is suitable for use in hashing algorithms and data structures like a hash table.
A hash code for the current .
Gets a value indicating whether the object is read-only.
Origin
Object has been Disposed
Returns a that represents the current .
A that represents the current .
Information about a text font. Immutable.
Creates an empty font info object.
Creates a new font info object.
Determines whether the specified object and the current object refer to the same
underlying native object. Returns false if either object has been disposed.
Serves as a hash function for a particular type. is suitable for use in hashing algorithms and data structures like a hash table.
A hash code for the current .
Gets a value indicating whether the object is read-only.
Italics
Object has been Disposed
Font size in points
Object has been Disposed
Strikeout
Object has been Disposed
Returns a that represents the current .
A that represents the current .
Font typeface
Object has been Disposed
Font weight
Object has been Disposed
Global metrics for a typeface.
Gets a value indicating whether the object is read-only.
View tool enumeration.
No active tool
Select
Select Box
Redline Freehand
Redline Line
Redline Ellipse
Redline Cloud
Redline Line String
Redline Tag
Redline Text
Redline Erase
Redline Arrow
Measure Point To Point
Measure Point To Multiple Points
Measure Point Line
Measure Accumulate
Measure Angle
Measure Area
Basic View Object Wheel
Basic Tour Building Wheel
Full Navigation Wheel
Mini View Object Wheel
Mini Tour Building Wheel
Mini Full Navigation Wheel
Full 2D Navigation Wheel
Pan common across all Autodesk products
Zoom common across all Autodesk products
Zoom Window common across all Autodesk products
Orbit common across all Autodesk products
Free Orbit common across all Autodesk products
Constrained Orbit common across all Autodesk products
Look At common across all Autodesk products
Look Around common across all Autodesk products
Walk common across all Autodesk products
Center common across all Autodesk products
Camera fixed in place
Classic Navisworks Free Look Around (Swivel)
Classic Navisworks Free Orbit (Examine)
Classic Navisworks Walk
Classic Navisworks Fly
Classic Navisworks Constrained Orbit (Turntable)
Classic Navisworks Zoom
Classic Navisworks Pan
Classic Navisworks Constrained Pan
Clasic Navisworks Look Around (Swivel)
Classic Navisworks Orbit
Classic Navisworks Zoom Window (Zoom Box)
Functionality is provided by a ToolPlugin
Represents a Tooltip and an identifier, that is returned from a call to a ToolPlugin or InputPlugin.
Constructor for a TooltipResult.
Tooltip display name.
Tooltip Id.
This is used to batch together edits.
Currently it is a requirement that you must call Commit,
after doing your edits. In the future rollback may be supported.
This is used to batch together edits. In C# it would typically be used
within a 'using' block.In the future it may support rollback.
The Document that this transaction applies to.
String that may be displayed in the GUI for undoing this transaction.
Call to commit the transaction.
Transaction has already been Commited
Object has been Disposed
String that may be displayed in the GUI for undoing this transaction.
The Document that this transaction applies to.
Has this transaction been committed ?
Has this transaction been disposed ?
A generic transformation in 3D space.
Default constructor. Makes an Identity transform.
Make a transform from a matrix and a vector.
Argument 'linear' is null
Argument 'linear' has been Disposed
Argument 'trans' is null
Argument 'trans' has been Disposed
Make a transform from a rotation (3D homogenous).
Argument 'rotation' is null
Argument 'rotation' has been Disposed
Make a transform from a rotation and a translation.
Argument 'rotation' is null
Argument 'rotation' has been Disposed
Argument 'translation' is null
Argument 'translation' has been Disposed
Make a transform from another transform.
Argument 'transform' is null
Argument 'transform' has been Disposed
Create an identity transform.
Set matrix to be 3D homogenous translation matrix.
Argument 'translation' is null
Argument 'translation' has been Disposed
Determines whether the specified object and the current object refer to the same
underlying native object. Returns false if either object has been disposed.
Treat as homogenous 3D matrix and factor into scale orientation, scale, rotation and translation components.
Object has been Disposed
Treat as homogenous 3D matrix and factor into scale orientation, scale, rotation and translation components.
Object has been Disposed
Argument 'worldCenter' is null
Argument 'worldCenter' has been Disposed
Serves as a hash function for a particular type. is suitable for use in hashing algorithms and data structures like a hash table.
A hash code for the current .
Return inverse of matrix. Matrix must be non-singular (non-zero determinant).
Object has been Disposed
Determines if the transform is affine.
Object has been Disposed
Determines if the transform is an identity.
Object has been Disposed
Determines if the transform is linear.
Object has been Disposed
Gets a value indicating whether the object is read-only.
Determines if the transform is a rotation.
Object has been Disposed
Determines if the transform is a translation.
Object has been Disposed
Determines if the transform is a uniform scaling.
Object has been Disposed
Get parts of matrix which represent orthogonal transforms.
Object has been Disposed
Multiply two transforms in the order that the arguments are given, and return the result.
Argument 'leftTransform' is null
Argument 'leftTransform' has been Disposed
Argument 'rightTransform' is null
Argument 'rightTransform' has been Disposed
Equal within a tolerance. Each element of matrix is equal to corresponding element, within the given tolerance.
Object has been Disposed
Argument 'transform' is null
Argument 'transform' has been Disposed
Equal within a tolerance. Each element of matrix is equal to corresponding element, within the given tolerance.
Object has been Disposed
Argument 'transform' is null
Argument 'transform' has been Disposed
Returns a that represents the current .
A that represents the current .
Translate a transform by a vector.
Argument 'translation' is null
Argument 'translation' has been Disposed
Argument 'transform' is null
Argument 'transform' has been Disposed
Get parts of matrix which represent the translation.
Object has been Disposed
Affine transform represented as individual components that combine to form complete transform. Immutable.
Combine components together into a composite transform.
Object has been Disposed
Serves as a hash function for a particular type. is suitable for use in hashing algorithms and data structures like a hash table.
A hash code for the current .
Gets a value indicating whether the object is read-only.
The rotation component of the transform.
Object has been Disposed
Object is Read-Only
Argument 'rotation' is null
Argument 'rotation' has been Disposed
The scale component of the transform.
Object has been Disposed
Object is Read-Only
Argument 'scale' is null
Argument 'scale' has been Disposed
The scale orientation component of the transform.
Object has been Disposed
Object is Read-Only
Argument 'scale_orientation' is null
Argument 'scale_orientation' has been Disposed
Returns a that represents the current .
A that represents the current .
The translation component of the transform.
Object has been Disposed
Object is Read-Only
Argument 'translation' is null
Argument 'translation' has been Disposed
Unit conversion package class.
Gets a value indicating whether the object is read-only.
Return the scale factor between two linear units.
Units of linear dimension.
SI meter. Distance light travels, in a vacuum, in 1 299,792,458th of a second
1 100th of an SI meter
1 1000th of an SI meter
1 3rd of a yard
1 12th of a foot, 2.54 centimeters exactly
Imperial yard, 0.9144 SI meters exactly
1000 SI meters
1760 yards
1 1,000,000th of an SI meter, a micron
1 1,000th of an inch
1 1,000,000th of an inch
A vector with unit length. Represents a direction in 3D space. Immutable.
Create a unit vector from a vector, normalizing if required
Argument 'vector' is null
Argument 'vector' has been Disposed
Create a unit vector from X, Y and Z components, normalizing if required
Adds a vector to this to produce a new vector
Object has been Disposed
Argument 'vector' is null
Argument 'vector' has been Disposed
Adds a value to every X, Y and Z coordinate in the Vector and returns a new Vector with the result
Object has been Disposed
Returns the angle between this vector and another vector in the range [0, PI]
vector to calculate angle with
angle in radians between this and vector
Object has been Disposed
Argument 'vector' is null
Argument 'vector' has been Disposed
Returns the angle between this vector and another vector in the range [-PI, PI], using a reference vector to determine the sign of the angle
vector to calculate angle with
reference vector pointing away from the plane containing this and vector
angle in radians between this and vector
Object has been Disposed
Argument 'vector' is null
Argument 'vector' has been Disposed
Argument 'reference' is null
Argument 'reference' has been Disposed
Returns the cross product between this vector and another
Object has been Disposed
Argument 'vector' is null
Argument 'vector' has been Disposed
Compare with direction of vector using a tolerance
Object has been Disposed
Argument 'vector' is null
Argument 'vector' has been Disposed
Compare with direction of vector using a tolerance
Object has been Disposed
Argument 'vector' is null
Argument 'vector' has been Disposed
Divides this vector by another to produce a new vector
Object has been Disposed
Argument 'vector' is null
Argument 'vector' has been Disposed
Divides every X, Y and Z coordinate in the Vector by a value and returns a new Vector with the result
Object has been Disposed
Returns the dot product between this vector and another
Object has been Disposed
Argument 'vector' is null
Argument 'vector' has been Disposed
Determines whether the specified object and the current object refer to the same
underlying native object. Returns false if either object has been disposed.
Serves as a hash function for a particular type. is suitable for use in hashing algorithms and data structures like a hash table.
A hash code for the current .
Gets a value indicating whether the object is read-only.
Is this a zero vector ? Will occur if all inputs to constructor are zero.
Object has been Disposed
Multiplies a vector by this to produce a new vector
Object has been Disposed
Argument 'vector' is null
Argument 'vector' has been Disposed
Multiplies every X, Y and Z coordinate in the Vector by a value and returns a new Vector with the result
Object has been Disposed
Returns a negated version of this vector (all components negated)
Object has been Disposed
Adds two vectors to produce a new vector
Adds two vectors to produce a new vector
Adds a value to every X, Y and Z coordinate in the Vector and returns a new Vector with the result
Adds two vectors to produce a new vector
Adds a value to every X, Y and Z coordinate in the Vector and returns a new Vector with the result
Divides every X, Y and Z coordinate in the Vector by a value and returns a new Vector with the result
Converts a UnitVector3D to a Vector3D
Multiplies every X, Y and Z coordinate in the Vector by a value and returns a new Vector with the result
Multiplies every X, Y and Z coordinate in the Vector by a value and returns a new Vector with the result
Subtracts two vectors to produce a new vector
Subtracts two vectors to produce a new vector
Subtracts a value from every X, Y and Z coordinate in the Vector and returns a new Vector with the result
Subtracts two vectors to produce a new vector
Subtracts a vector from this to produce a new vector
Object has been Disposed
Argument 'vector' is null
Argument 'vector' has been Disposed
Subtracts a value from every X, Y and Z coordinate in the Vector and returns a new Vector with the result
Object has been Disposed
Compare unit vectors using a tolerance
Object has been Disposed
Argument 'vector' is null
Argument 'vector' has been Disposed
Compare vectors using a tolerance
Argument 'vector0' is null
Argument 'vector0' has been Disposed
Argument 'vector1' is null
Argument 'vector1' has been Disposed
Compare vectors using a tolerance
Argument 'vector0' is null
Argument 'vector0' has been Disposed
Argument 'vector1' is null
Argument 'vector1' has been Disposed
Compare unit vectors using a tolerance
Object has been Disposed
Argument 'vector' is null
Argument 'vector' has been Disposed
Returns a that represents the current .
A that represents the current .
Convert unit vector to a vector
Object has been Disposed
Returns a unit vector in the X direction (1,0,0)
Returns a unit vector in the Y direction (0,1,0)
Returns a unit vector in the Z direction (0,0,1)
Returns the X component of the vector
Object has been Disposed
Returns the Y component of the vector
Object has been Disposed
Returns the Z component of the vector
Object has been Disposed
A value type that can store data of one of several different types.
Creates Data with no value stored
Creates a named constant value
Argument 'value' has been Disposed
Creates a boolean value
Creates a unitless double value
Creates a specific type of double based value
Value to create
Particular type of double value to create
type is not a floating point based type
Creates a 2D point value
Creates a 3D point value
Creates an integer value
Creates a display string value
Creates an LtNat32 value
Creates an LtNat64 value
Type of value stored
Object has been Disposed
The XML element name used for XML serialization
Determines whether the specified object and the current object refer to the same
underlying native object. Returns false if either object has been disposed.
Creates a boolean value
Creates a value
Creates a display string value
Creates a unitless double value
Creates a double angle value
Creates a double area value
Creates a double length value
Creates a double volume value
Creates an identifier string value
Argument 'value' is not convertable to a 7-bit ASCII string
Creates a 32 bit integer value
Creates a 64 bit integer value
Creates a named constant value
Argument 'value' has been Disposed
Creates a Nat32 value
Creates a Nat64 value
Creates Data with no value stored
Creates a Point2D value
Creates a 2D point value
Creates a Point3D value
Creates a 3D point value
Serves as a hash function for a particular type. is suitable for use in hashing algorithms and data structures like a hash table.
A hash code for the current .
Is data any type of double based value ?
Object has been Disposed
Is data a boolean value ?
Object has been Disposed
Is data a value ?
Object has been Disposed
Is data a display string value ?
Object has been Disposed
Is data a unitless double value ?
Object has been Disposed
Is data a double angle value ?
Object has been Disposed
Is data a double area value ?
Object has been Disposed
Is data a double length value ?
Object has been Disposed
Is data a double volume value ?
Object has been Disposed
Is data an identifier string value ?
Object has been Disposed
Is data a unitless 32 bit integer value ?
Object has been Disposed
Is data an int64?
Object has been Disposed
Is data a named constant value ?
Object has been Disposed
Is data an LtNat32?
Object has been Disposed
Is data an LtNat64?
Object has been Disposed
Does data have no value ?
Object has been Disposed
Is data a 2D point?
Object has been Disposed
Is data a 3D point?
Object has been Disposed
Gets a value indicating whether the object is read-only.
Create a VariantData object from serialised XML values
Access any type of double value
Not supported if '!IsAnyDouble'
Object has been Disposed
Access boolean value
Not supported if '!IsBoolean'
Object has been Disposed
Access value
Not supported if '!IsDateTime'
Object has been Disposed
Access display string value
Not supported if '!IsDisplayString'
Object has been Disposed
Access unitless double value
Not supported if '!IsDouble'
Object has been Disposed
Access double angle value
Not supported if '!IsDoubleAngle'
Object has been Disposed
Access double area value
Not supported if '!IsDoubleArea'
Object has been Disposed
Access double length value
Not supported if '!IsDoubleLength'
Object has been Disposed
Access double volume value
Not supported if '!IsDoubleVolume'
Object has been Disposed
Access identifier string value
Not supported if '!IsIdentifierString'
Object has been Disposed
Access 32 bit integer value
Not supported if '!IsInt32'
Object has been Disposed
Access Int64 value
Not supported if '!IsInt64'
Object has been Disposed
Access named constant value
Not supported if '!IsNamedConstant'
Object has been Disposed
Access LtNat32 value
Not supported if '!IsNat32'
Object has been Disposed
Access LtNat64 value
Not supported if '!IsNat64'
Object has been Disposed
Access Point2D value
Access Point3D value
Write serializable string representation
Object has been Disposed
Returns a that represents the current .
A that represents the current .
The XML attribute name used for XML serialization
The XML attribute value used for XML serialization
Object has been Disposed
The XML element content used for XML serialization
Object has been Disposed
Create an empty collection
Create a collection that is a copy of from
Argument 'from' is null
Argument 'from' has been Disposed
Adds an item to the .
The object to add to the .
The is read-only.
Adds an item to the .
The to add to the .
The position into which the new element was inserted.
The is read-only.-or- The has a fixed size.
Removes all items from the .
The is read-only.
Gets a value indicating whether the object is read-only.
Determines whether the SavedItemCollection contains a specific value.
Object has been Disposed
Argument 'item' has been Disposed
Determines whether the contains a specific value.
The to locate in the .
true if the is found in the ; otherwise, false.
Copies the elements of the to an , starting at a particular index.
The one-dimensional that is the destination of the elements copied from . The must have zero-based indexing.
The zero-based index in array at which copying begins.
arrayIndex is less than 0.
array is null.
array is multidimensional.-or-arrayIndex is equal to or greater than the length of array.-or-The number of elements in the source is greater than the available space from arrayIndex to the end of the destination array.-or-Type T cannot be cast automatically to the type of the destination array.
Copies the elements of the to an , starting at a particular index.
The one-dimensional that is the destination of the elements copied from . The must have zero-based indexing.
The zero-based index in array at which copying begins.
array is null.
index is less than zero.
array is multidimensional.-or- index is equal to or greater than the length of array.-or- The number of elements in the source is greater than the available space from index to the end of the destination array.
The type of the source cannot be cast automatically to the type of the destination array.
Enumerates over the collection and copies the items into to
Collection to copy into
Gets the number of elements contained in the collection.
Object has been Disposed
Removes all items from the .
The is read-only.
Removes the item at the specified index.
The zero-based index of the item to remove.
The is read-only.
index is not a valid index in the .
Returns an enumerator that can iterate through the collection.
An IEnumerator that can be used to iterate through the collection.
Gets or sets the element at the specified index.
Object has been Disposed
Object is Read-Only
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' is ReadOnly
Argument 'index' out of range
Determines the index of a specific item in the Collection
Argument 'item' has been Disposed
Determines the index of a specific item in the .
The to locate in the .
The index of value if found in the list; otherwise, -1.
Inserts an item to the at the specified index.
The object to insert into the .
The zero-based index at which item should be inserted.
The is read-only.
index is not a valid index in the .
Inserts an item to the at the specified index.
The to insert into the .
The zero-based index at which value should be inserted.
index is not a valid index in the .
The is read-only.-or- The has a fixed size.
value is null reference in the .
Returns an enumerator that can iterate through the collection.
An IEnumerator that
can be used to iterate through the collection.
Gets a value indicating whether the has a fixed size.
true if the has a fixed size; otherwise, false.
Gets a value indicating whether the object is read-only.
Gets a value indicating whether access to the is synchronized (thread safe).
true if access to the is synchronized (thread safe); otherwise, false.
Removes the first occurrence of a specific object from the .
The object to remove from the .
true if item was successfully removed from the ; otherwise, false. This method also returns false if item is not found in the original .
The is read-only.
Removes the first occurrence of a specific object from the .
The to remove from the .
The is read-only.-or- The has a fixed size.
Removes the item at the specified index.
The zero-based index of the item to remove.
index is not a valid index in the .
The is read-only.-or- The has a fixed size.
Gets an object that can be used to synchronize access to the .
An object that can be used to synchronize access to the .
Type of data stored in a VariantData class.
Empty. No data stored.
Unitless double value
Unitless 32 bit integer value
Boolean (true/false) value
String intended for display to the end user (normally localized)
A specific date and time (usually UTC)
A double that represents a length (specific units depend on context)
A double that represents an angle in radians
A named constant
String intended to be used as a programmatic identifier. 7-bit ASCII characters only.
A double that species an area (specific units depend on context)
A double that species a volume (specific units depend on context)
A 3D point value
A 2D point value
Unsigned 32 bit integer value
64 bit integer value
Unsigned 64 bit integer value
Represents a direction with magnitude in 2D space. Immutable.
Create a zero vector
Exception when 'false'
Create a vector from X and Y components
Translates a point by this vector and returns the resulting point
Adds another vector to this to produce a new vector
Object has been Disposed
Argument 'vector' is null
Argument 'vector' has been Disposed
Adds a value to every X, Y and Z coordinate in the Vector and returns a new Vector with the result
Object has been Disposed
Returns the angle between this vector and another vector in the range [0, PI]
Vector to calculate angle with.
Angle in radians between this and vector.
Object has been Disposed
Argument 'vector' is null
Argument 'vector' has been Disposed
Returns the angle between this vector and another vector in the range [-PI, PI], using a reference vector to determine the sign of the angle
Vector to calculate angle with.
Reference vector pointing away from the plane containing this and vector.
Angle in radians between this and vector.
Object has been Disposed
Argument 'vector' is null
Argument 'vector' has been Disposed
Argument 'reference' is null
Argument 'reference' has been Disposed
Returns the cross product between this vector and another
Object has been Disposed
Argument 'vector' is null
Argument 'vector' has been Disposed
Compare direction of vectors using a tolerance
Object has been Disposed
Argument 'vector' is null
Argument 'vector' has been Disposed
Compare direction of vectors using a tolerance
Object has been Disposed
Argument 'vector' is null
Argument 'vector' has been Disposed
Divides this vector by another to produce a new vector
Object has been Disposed
Argument 'vector' is null
Argument 'vector' has been Disposed
Divides every X, Y and Z coordinate in the Vector by a value and returns a new Vector with the result
Object has been Disposed
Returns the dot product between this vector and another
Object has been Disposed
Argument 'vector' is null
Argument 'vector' has been Disposed
Determines whether the specified object and the current object refer to the same
underlying native object. Returns false if either object has been disposed.
Serves as a hash function for a particular type. is suitable for use in hashing algorithms and data structures like a hash table.
A hash code for the current .
Returns an inverted version of this vector (all components inverted)
Object has been Disposed
Gets a value indicating whether the object is read-only.
Is this a zero vector (all components are zero) ?
Object has been Disposed
Magnitude of vector
Object has been Disposed
Magnitude of vector squared
Object has been Disposed
Multiplies a vector by this to produce a new vector
Object has been Disposed
Argument 'vector' is null
Argument 'vector' has been Disposed
Multiplies every X, Y and Z coordinate in the Vector by a value and returns a new Vector with the result
Object has been Disposed
Returns a negated version of this vector (all components negated)
Object has been Disposed
Returns a normalized version of this vector (magnitude of 1)
Object has been Disposed
Adds two vectors to produce a new vector
Adds a value to every X, Y and Z coordinate in the Vector and returns a new Vector with the result
Adds a value to every X, Y and Z coordinate in the Vector and returns a new Vector with the result
Divides two vectors to produce a new vector
Divides every X, Y and Z coordinate in the Vector by a value and returns a new Vector with the result
Multiplies two vectors to produce a new vector
Multiplies every X, Y and Z coordinate in the Vector by a value and returns a new Vector with the result
Multiplies every X, Y and Z coordinate in the Vector by a value and returns a new Vector with the result
Subtracts two vectors to produce a new vector
Subtracts a value from every X, Y and Z coordinate in the Vector and returns a new Vector with the result
Subtracts a vector from this to produce a new vector
Object has been Disposed
Argument 'vector' is null
Argument 'vector' has been Disposed
Subtracts a value from every X, Y and Z coordinate in the Vector and returns a new Vector with the result
Object has been Disposed
Compare vectors using a tolerance
Object has been Disposed
Argument 'vector' is null
Argument 'vector' has been Disposed
Compare vectors using a tolerance
Argument 'vector0' is null
Argument 'vector0' has been Disposed
Argument 'vector1' is null
Argument 'vector1' has been Disposed
Compare vectors using a tolerance
Argument 'vector0' is null
Argument 'vector0' has been Disposed
Argument 'vector1' is null
Argument 'vector1' has been Disposed
Compare vectors using a tolerance
Object has been Disposed
Argument 'vector' is null
Argument 'vector' has been Disposed
Convert vector to a point (equivalent to point from adding vector to origin)
Object has been Disposed
Returns a that represents the current .
A that represents the current .
Returns a unit vector in the X direction (1,0)
Returns a unit vector in the Y direction (0,1)
Returns the X component of the vector
Object has been Disposed
Returns the Y component of the vector
Object has been Disposed
Returns a zero vector (0,0)
Represents a direction with magnitude in 3D space. Immutable.
Create a zero vector
Exception when 'false'
Create a vector from X, Y and Z components
Translates a point by this vector and returns the resulting point
Adds another vector to this to produce a new vector
Object has been Disposed
Argument 'vector' is null
Argument 'vector' has been Disposed
Adds a value to every X, Y and Z coordinate in the Vector and returns a new Vector with the result
Object has been Disposed
Returns the angle between this vector and another vector in the range [0, PI]
vector to calculate angle with
angle in radians between this and vector
Object has been Disposed
Argument 'vector' is null
Argument 'vector' has been Disposed
Returns the angle between this vector and another vector in the range [-PI, PI], using a reference vector to determine the sign of the angle
vector to calculate angle with
reference vector pointing away from the plane containing this and vector
angle in radians between this and vector
Object has been Disposed
Argument 'vector' is null
Argument 'vector' has been Disposed
Argument 'reference' is null
Argument 'reference' has been Disposed
Returns the cross product between this vector and another
Object has been Disposed
Argument 'vector' is null
Argument 'vector' has been Disposed
Compare direction of vectors using a tolerance
Object has been Disposed
Argument 'vector' is null
Argument 'vector' has been Disposed
Compare direction of vectors using a tolerance
Object has been Disposed
Argument 'vector' is null
Argument 'vector' has been Disposed
Compare direction of vectors using a tolerance
Object has been Disposed
Argument 'vector' is null
Argument 'vector' has been Disposed
Compare direction of vectors using a tolerance
Object has been Disposed
Argument 'vector' is null
Argument 'vector' has been Disposed
Divides this vector by another to produce a new vector
Object has been Disposed
Argument 'vector' is null
Argument 'vector' has been Disposed
Divides every X, Y and Z coordinate in the Vector by a value and returns a new Vector with the result
Object has been Disposed
Returns the dot product between this vector and another
Object has been Disposed
Argument 'vector' is null
Argument 'vector' has been Disposed
Determines whether the specified object and the current object refer to the same
underlying native object. Returns false if either object has been disposed.
Serves as a hash function for a particular type. is suitable for use in hashing algorithms and data structures like a hash table.
A hash code for the current .
Returns an inverted version of this vector (all components inverted)
Object has been Disposed
Gets a value indicating whether the object is read-only.
Is this a zero vector (all components are zero) ?
Object has been Disposed
Magnitude of vector
Object has been Disposed
Magnitude of vector squared
Object has been Disposed
Returns a negated version of this vector (all components negated)
Object has been Disposed
Returns a normalized version of this vector (magnitude of 1)
Object has been Disposed
Adds two vectors to produce a new vector
Adds a value to every X, Y and Z coordinate in the Vector and returns a new Vector with the result
Adds a value to every X, Y and Z coordinate in the Vector and returns a new Vector with the result
Divides two vectors to produce a new vector
Divides every X, Y and Z coordinate in the Vector by a value and returns a new Vector with the result
Multiplies two vectors to produce a new vector
Multiplies every X, Y and Z coordinate in the Vector by a value and returns a new Vector with the result
Multiplies every X, Y and Z coordinate in the Vector by a value and returns a new Vector with the result
Subtracts two vectors to produce a new vector
Subtracts a value from every X, Y and Z coordinate in the Vector and returns a new Vector with the result
Subtracts a vector from this to produce a new vector
Object has been Disposed
Argument 'vector' is null
Argument 'vector' has been Disposed
Subtracts a value from every X, Y and Z coordinate in the Vector and returns a new Vector with the result
Object has been Disposed
Convert vector to a color
Unable to return a valid value
Object has been Disposed
Compare vectors using a tolerance
Object has been Disposed
Argument 'vector' is null
Argument 'vector' has been Disposed
Compare vectors using a tolerance
Argument 'vector0' is null
Argument 'vector0' has been Disposed
Argument 'vector1' is null
Argument 'vector1' has been Disposed
Compare vectors using a tolerance
Argument 'vector0' is null
Argument 'vector0' has been Disposed
Argument 'vector1' is null
Argument 'vector1' has been Disposed
Compare vectors using a tolerance
Object has been Disposed
Argument 'vector' is null
Argument 'vector' has been Disposed
Convert vector to a point (equivalent to point from adding vector to origin)
Object has been Disposed
Returns a that represents the current .
A that represents the current .
Returns a unit vector in the X direction (1,0,0)
Returns a unit vector in the Y direction (0,1,0)
Returns a unit vector in the Z direction (0,0,1)
Returns the X component of the vector
Object has been Disposed
Returns the Y component of the vector
Object has been Disposed
Returns the Z component of the vector
Object has been Disposed
Returns a zero vector (0,0,0)
Vertex properties enumeration.
None
Normals
Colours
Texture co-ordinates
Represents a view of a document.
Updates the viewpoint in this view based on change required.
Returns a viewpoint representing this view.
The document associated with this View.
Decrements an internal counter that determines if the view is in interactive mode.
As the count goes from 1 to 0 the View is set out of interactive mode.
Should be used with a matched call to StartInteractive.
Focuses the view on the currently selected objects.
Generates an Image for this View.
Generates an Image for this View.
Gets clipping planes in the form of a JSON ClipPlaneSet object.
Gets redlines in the form of a JSON RedlineCollection object.
The renderable height of the view in Windows screen pixels
Has this view been disposed ?
Determines if the view is in interactive mode.
Move's the Camera to look from FrontRightTop.
Picks a single item from the given window coordinate point.
A PickItemResult object that contains the picked item.
Returns null if nothing is picked or coordinates are invalid.
Picks a single item from the given window coordinate point.
Width of picking region in pixels. Normally 1.
Whether picking should operate only on items that were rendered during the last frame. Normally true.
A PickItemResult object that contains the picked item.
Returns null if nothing is picked or coordinates are invalid.
Picks a single item from the given window coordinate rectangle.
A PickItemResult object that contains the picked item
Returns null if nothing is picked or coordinates are invalid.
Picks a single item from the given window coordinate rectangle.
Whether picking should operate only on items that were rendered during the last frame. Normally true.
A PickItemResult object that contains the picked item
Returns null if nothing is picked or coordinates are invalid.
Picks multiple items from the given window coordinate rectangle.
Whether picking should operate only on items that are contained in the rectangle
A ModelItemCollection containing the picked items.
Returns null if nothing is picked or coordinates are invalid.
Picks multiple items from the given window coordinate rectangle.
Whether picking should operate only on items that are contained in the rectangle.
Whether picking should operate only on items that were rendered during the last frame. Normally true.
A ModelItemCollection containing the picked items.
Returns null if nothing is picked or coordinates are invalid.
Converts a point in world space into view coordinates.
Asks for Render after all other events have been processed.
Sets clipping planes.
Clipping planes in the form of a JSON ClipPlaneSet object.
Failed to set clipping planes.
Sets redlines.
Redlines in the form of a JSON RedlineCollection object.
Failed to set redlines.
Increments an internal counter that determines if the view is in interactive mode.
As the count goes from 0 to 1 the View is set into interactive mode.
Should be used with a matched call to EndInteractive.
Sets clipping planes.
Clipping planes in the form of a JSON ClipPlaneSet object.
Sets redlines.
Redlines in the form of a JSON RedlineCollection object.
The renderable width of the view in Windows screen pixels
Specifies type of change being made to a View.
The current viewpoint jumps straight to the new viewpoint.
Collision detection and gravity have no effect.
User is interactively navigating from current viewpoint to new viewpoint.
Actual viewpoint set may be modified due to collision detection and gravity.
Event arguments used for View related events
Gets the View that the event is describing.
Represents a viewpoint
Default constructor
Exception when 'false'
Rotate camera so that it points in given direction using shortest
rotation path.
Rotate camera about view direction so that camera up vector is
aligned with given up vector (in same plane as view direction and
given up vector).
Angular speed of the camera.
AngularSpeed not set
The diameter of the physical camera aperture in camera units. Used for advanced rendering effects.
Aspect ratio of camera (width/height). Default 1.0 (square).
Object has been Disposed
Object is Read-Only
Argument 's' is null
Argument 's' has been Disposed
Creates a copy of the Viewpoint.
Object has been Disposed
Distance from eye point to far plane along view direction. Must be greater than near distance.
Describes the users intentions if the product has to modify the far distance (typically because of graphics system limitations).
Far plane distance.
The focal distance of the camera.
FocalDistance not set
Describes viewpoint in terms of an JSON AutodeskCommonCamera object.
Determines if AngularSpeed has been set
Determines if FocalDistance has been set
Determines if Lighting has been set
Determines if LinearSpeed has been set
Determines if RenderStyle has been set
Determines if Tool has been set
Determines if Viewer has been set.
Determines if WorldUpVector has been set
Defines camera field of view in combination with aspect ratio.
For a perspective camera, this is the vertical field of view
(the angle between top and bottom planes of the camera view frustum).
For an orthographic camera, this is the distance between top and
bottom planes of the camera view frustum.
Default 0.785398 (45 degrees)
The distance between the left and right planes of the view frustum at
the focal distance along the view direction from the camera position.
FocalDistance not set
Required horizontal scaling of the image when adapting the camera view to the display window.
Describes how to adapt the camera view so that it's aspect ratio matches that of the display window.
Gets a value indicating whether the object is read-only.
Lighting used for this viewpoint
Lighting not set
Linear speed of the camera.
LinearSpeed not set
Distance from eye point to near plane along view direction. Must be greater than zero.
Describes the users intentions if the product has to modify the near distance (typically because of graphics system limitations).
Near plane distance.
Rotate camera so that it points at given location using shortest
rotation path.
Position of the camera.
The projection type of the current viewpoint.
The style used for rendering.
RenderStyle not set
Distance that the plane normal to the view direction, at the focal distance
along the view direction from the camera position, is offset to the right.
Need to call SetFocalDistance before using this property.
FocalDistance not set
The ratio between the right offset (the distance that the target plane is offset to the right) and the
horizontal extent (the distance between the left and right planes of the view frustum at the target distance).
Rotation of camera from base orientation. The base
orientation is looking down the negative Z-axis with
+X to the right and +Y up.
Default 0 0 0 1 (no rotation).
Set viewpoint from JSON AutodeskCommonCamera.
Camera in the form of a JSON AutodeskCommonCamera object.
Failed to set camera.
Set the distances between the left and right planes, and the top and bottom planes of the
view frustum at the focal distance along the view direction from the camera position.
Need to call SetFocalDistance before calling this method.
FocalDistance not set
The time measured in seconds that the physical aperture is open. Used for advanced rendering effects.
The Tool in use.
Tool not set
Try to set viewpoint from JSON AutodeskCommonCamera.
Camera in the form of a JSON AutodeskCommonCamera.
false if operation fails
Distance that the plane normal to the view direction, at the focal distance
along the view direction from the camera position, is offset upwards.
Need to call SetFocalDistance before using this property.
FocalDistance not set
The ratio between the up offset (the distance that the target plane is offset upwards) and the
vertical extent (the distance between the top and bottom planes of the view frustum at the target distance).
The distance between the top and bottom planes of the view frustum
at the focal distance along the view direction from the camera position.
FocalDistance not set
Avatar used for this viewpoint.
Viewpoint not set.
Avatar used for this viewpoint.
Viewpoint not set.
Preferred up vector. Used by "walk" paradigm navigation methods to move on a plane.
WorldUpVector not set
Zooms the viewpoint to view a given bounding box.
The bounding box to zoom to view.
Describes the user's intentions if the product has to modify near and far distances (typically because of graphics system limitations).
User has specified exact distance.
For near distance, user has specified maximum distance and the product can use a smaller value to increase render quality. For far distance, user has specified minimum distance and the product can use a larger value to increase render quality.
Distance was chosen automatically by the product.
Describes how to adapt the camera view so that its aspect ratio matches that of the display window.
The frustum is used as is within the largest subset of the window that has the correct aspect ratio. The rest of the window is masked out (e.g. black bars).
The frustum extents are enlarged so that all of the original image is visible.
Only HorizontalExtent is modified so that vertical extent is preserved.
Only VerticalExtent is modified so that horizontal extent is preserved.
The frustum extents are reduced so that a subset of the original image is visible.
The lighting of the viewpoint
Turns off lighting completely
Lights provided by user in model
An automatic headlight provided by viewer
Advanced level of lighting, implemented by application
The projection type of the viewpoint
Perspective viewpoint
Orthographic viewpoint
The render style of the viewpoint
Highest quality, as specified in model
Lower quality, same appearance
Smooth shaded (simple shade model, no textures)
Wire frame
Hidden line wire frame
The stereo projection type of the viewpoint.
Standard mono camera
Left eye for stereo
Right eye for stereo
Flags specifying which sorts of redraw are requested.
No redraw requested unless other flags specified.
Main Render requested.
Overlay Render requested.
Main Render and Overlay Render requested.
Visibility Overrides.
Visibility Overrides.
Visibility Overrides.
Provides the same interface as Api.Automation.NavisworksApplication but within the current process.
Calls made via NavisworksApplication or command line when automating eventually call methods
on here.
Adds another assembly that plugins can be loaded from.
Assembly is loaded using the LoadFrom context and can be used outside the Application root.
Appends the Navisworks supported file to the currently loaded document
The file name including extension
Failed to append file
Creates a corresponding nwc file for specified file.
The file name, excluding extension, for the cache file
Normal behavior is that Progress is displayed when performing long operations, even during Automated actions.
Normal behavior is that Progress is displayed when performing long operations, even during Automated actions.
Executes an Addin Plugin whose full name is given by pluginId, passing in the paramaters given.
The full identifier for the plugin.
This is formed as Name.DeveloperId
Optional parameters to pass to the plugin
Plugin not found, failed to load or is not an AddInPlugin
Generates a Thumbnail Image for this Document, and save it as a PNG image
The width of the image
The height of the image
The file name of the saved image
Fail to generate the thumbnail
Generates a thumbnail render by ray trace for this Document, and save it as a PNG image
The width of the image
The height of the image
The file name of the saved image
Fail to generate the thumbnail
Loads one or more Navisworks supported files
First file to open
Other files to open
Failed to open file
Sends the current View to the Printer
Sends the current View to the Printer
The name of the printer to print to
Sends the current View to the Printer
The name of the printer to print to
The name of the printer driver to use
Sends the current View to the Printer
The name of the printer to print to
The name of the printer driver to use
The name of the port the printer is connected to
Save the documents loaded using OpenFile to a single Navisworks Document
The file name including extension
Failed to save file
Represents Application level Drag & Drop.
Tries to decode the data passed in drag drop operations.
If successful determines the source Process Id.
Tries to decode the data passed in drag drop operations.
If successful determines the source Process Id.
Name of the format used for Navisworks drag drop operations.
Currently is just a notification theat Current Selection has been dragged.
Represents Application level options
Provides access to Grids Options.
Provides information about the Plugins available in the application runtime
Adds another assembly that plugins can be loaded from.
Assembly is loaded using the LoadFrom context and can be used outside the Application root.
Executes an Addin Plugin whose full name is given by pluginId, passing in the paramaters given.
The full identifier for the plugin.
This is formed as Name.DeveloperId
Optional parameters to pass to the plugin
Plugin not found or is not an AddInPlugin
Failed to load plugin
Execute is Disabled via CanExecute
Returns a collection of PluginRecords that implement a particular interface
The Id of the InterfaceRecord
Collection if empty if no mathcing PluginRecordsare found
Searches for a PluginRecord by Id
The full identifier for the plugin.
This is formed as Name.DeveloperId
Returns the PluginRecord or Null if it cannot be found
Gets collection of PluginRecords that describe the available plugins
Occurs when the collection of PluginRecords has changed.
Occurs when the collection of PluginRecords is about to change.
Provides access to Application Resources
Looks up a localizable string
The identifier of the string to lookup
Returns localized string
The identifier is Null.
Failed to look up string with specified identifier
Looks up a localizable string
The identifier of the string to lookup
Returns localized string or value of 'name' if it cannot be found
The identifier is Null.
Looks up a localizable string
The identifier of the string to lookup
Returns localized string or Null if it cannot be found
The identifier is Null.
Provides information about the version of the currently running API and Runtime
Major version number for the Navisworks API.
Changes when a non-backwards compatible change is made to a stable version of the API.
Always less than or equal to .
Minor version number for the Navisworks API.
Changes when there is a behavioral or minor change to a stable version of the API
that may have an impact on backwards compatibility.
Always less than or equal to .
Build number for Api and Runtime. Changes on every build (and hence every release).
Is this version of the API stable ? If false, breaking changes may be made at any time and client
code must be recompiled for every build. Api will be unstable for alpha and early beta releases.
Is this an alpha or beta version of the runtime ?
Identifies the Navisworks runtime that is providing this implementation of the API. Will typically
be an installed Navisworks product.
Gets the language code corresponding to the one Navisworks is using.
Major version number for the current Navisworks Runtime.
This changes with every major (annual) release of Navisworks products.
Minor version number for the current Navisworks Runtime.
This changes with every minor (service pack or subscription release) update of Navisworks products.
The complete product name for the Navisworks runtime that is providing
this implementation of the API.
Provides access to the BIM360 state of the application which is hosting the API.
Gives access to all current Accounts.
Youu'll only get these once SignedIn.
Rest Api access.
Rest Api access.
Returns true if any BIM 360 Models are loaded.
BIM 360 SignIn support.
Attempts to parse a string as a BIM 360 URI, and then determines resource information.
Argument 'input' is null.
Failed to parse 'input' into a BIM 360 URI.
Occurs when BIM 360 data is about to refresh.
Occurs when the refresh of BIM 360 data is complete.
Attempts to parse a string as a BIM 360 URI, and then determines resource information.
Provides access to the Gui of the application which is hosting the API.
Occurs when the Gui (including the main window) is about to close.
Occurs when the Gui is about to close and can be handled to cancel closure.
Called when a DockPanePlugin gets it's Visible property
The full identifier for the plugin.
This is formed as Name.DeveloperId
Reports if there is an authenticated user.
Sign In status.
Get the main window of the application. Use as parent window for dialogs and message boxes.
Sign In server type.
Server Type.
Occurs when the server type changes.
Called when a DockPanePlugin activates the plugin pane.
The full identifier for the plugin.
This is formed as Name.DeveloperId
Called when a DockPanePlugin sets it's Visible property
The full identifier for the plugin.
This is formed as Name.DeveloperId
The value to set
Allows Idle to be raised.
Action to raise Idle. Will be called with valid Action during GUI
creation, and with null during GUI destruction.
Occurs when user signs in.
Occurs when user has signed out.
Authenticate with Autodesk ID. Popup generic sign-in UI in Navisworks to allow users to enter the credentials.
true if authenticated or false if failed to authenticate.
Occurs when user is signing out.
The internal user ID of the user currently logged in. The user ID will be null if no user is logged in.
Internal user ID. Null if no user is authenticated.
The current authenticated user's Autodesk ID.
Autodesk ID. Null if no user is authenticated.
Sign-out the current authenticated user.
true if succeeded or false if failed.
Provides information about a BIM 360 Account.
Guid identifier of Account.
Identifier of Account.
AuthToken related to this Account.
Name of this Account.
User type of this Account.
Provides information about a BIM 360 Resource.
Identifier of Account the resource belongs to.
Display name of the resource.
Version independent identifier for the resource.
Optional identifier of Parent of the resource.
Identifier of Project the resource belongs to.
Type of the resource.
Version dependent identifier for the resource.
Resource Type.
Project.
Model.
Merged Model.
Enumeration of database edit.
A normal database edit
A redo database edit
An undo database edit
The element of DatabaseChangeCollection.
The type of change DatabaseChangeTypes.
The row id of current database change, use the RowId to find out all columns.
The table name of current database change.
Collection of DatabaseChange that only supports Enumerable style interfaces
Returns an enumerator that can iterate through the collection.
An IEnumerator that can be used to iterate through the collection.
Returns a that represents the current .
A that represents the current .
Filters the changes based on changeType
Which DatabaseChangeTypes will be cared
Filters the changes based on tablesName
Which tables would be cared. support multi tables and use white space between table names, Like "ABC def".
Filters the changes based on tableNames and changeType
Which tables would be cared. support multi tables and use white space between table names, Like "ABC def".
Which DatabaseChangeTypes will be cared
Determines which action should do after transaction
Undoable update database, insert|update|delete row
Non undoable database operate, like create table
Event arguments when a database changed event.
Gets the action that caused the event
Gets action type of database editing.
Gets change collection that were edited, if Action is not Edited, Changes will be null.
Change type
No change
Insert row
Delete row
Update row
All change types
The exception that is thrown when database failed
Creates a DatabaseException
The error code.
Creates a DatabaseException
The error code.
The error message that explains the reason for the exception.
Creates a DatabaseException
The error code.
The error message that explains the reason for the exception.
The exception that is the cause of the current exception. If the innerException parameter is not null, the current exception is raised in a catch block that handles the inner exception.
Creates a DatabaseException
Get database failed error code.
Event arguments for the model units and transform change event
Sets the allow change value. Unit and transform updates are not applied to the model when allow change is set to false.
Gets the whether the event source is the UI.
Gets the model linear units to be applied.
Gets the model.
Gets the transform to be applied.
Gets the whether the transform will be reversed when applied.
Implementation of DbCommand.
Default constructor
Initializes the command and associates it with the specified connection.
The connection to associate with the command
Initializes the command with the given command text
The SQL command text
Initializes the command with the given SQL command text and attach the command to the specified
connection.
The SQL command text
The connection to associate with the command
Not implemented
The SQL command text associated with the command
Not implement
The type of the command. NavisworksCommand only supports CommandType.Text
The connection associated with this command
Forwards to the local CreateParameter() function
Returns a NavisWorksDataReader object
Create a new parameter.
Return NavisworksParameter
Forwards to the local Connection property
Forwards to the local Parameters property
Not implement
Not implement
Creates a new NavisWorksDataReader to execute/iterate the array of prepared statements
The behavior the data reader should adopt
Returns a NavisWorksDataReader object
Execute the command and return the number of rows inserted/updated affected by it.
The number of rows inserted/updated affected by this executed command
Database exception
Overrides the default behavior of DbDataReader to return a specialized NavisWorksDataReader class
Return NavisWorksDataReader
Database exception
Overrides the default behavior to return a NavisWorksDataReader specialization class
The flags to be associated with the reader
Return NavisWorksDataReader
Database exception
Execute the command and return the first column of the first row of the resultset
(if present), or null if no resultset was returned.
The first column of the first row of the first resultset from the query
Database exception
Not implement, will implement
Returns the NavisworksParameterCollection for this command
Does nothing. Commands are prepared as they are executed the first time, and kept in prepared state afterwards.
Not implement
Implementation of DbConnection.
Not implement
Not implement
Does nothing, always keep open.
Not implement
Create a new NavisworksCommand and associate it with this connection.
Returns an instantiated NavisworksCommand object already assigned to this connection.
Forwards to the local CreateCommand() function
Not implement
Not implement
Returns schema information for the data source of this connection
using the specified string for the schema name and the specified string array
for the restriction values.
Specifies the name of the schema to return. Now only support "INDEXES" and "INDEXCOLUMNS"
Specifies a set of restriction values for the requested schema.
A System.Data.DataTable that contains schema information.
Does nothing, connection is automatically opened by DocumentDatabase.
Not implement
Returns the state of the connection
Implementation of DbDataAdapter.
Default constructor
Constructs a data adapter using the specified select command.
The select command to associate with the adapter.
Constructs a data adapter with the supplied select command text and associated with the specified connection.
The select command text to associate with the data adapter.
The connection to associate with the select command.
Gets/sets the delete command for this DataAdapter
Gets/sets the insert command for this DataAdapter
Raised by DbDataAdapter after a row is updated
The event's specifics
Raised by the underlying DbDataAdapter when a row is being updated
The event's specifics
Row updated event handler
Row updating event handler
Gets/sets the select command for this DataAdapter
Not implement
Not implement
Not implement
Not implement
Gets/sets the update command for this DataAdapter
Implementation of DbDataReader.
Closes the datareader.
Not implemented. Returns 0
Returns the number of columns in the current resultset.
Retrieves the column as a boolean value
The index of the column to retrieve
bool
Retrieves the column as a single byte value
The index of the column to retrieve
byte
Retrieves a column as an array of bytes (blob).
To determine the number of bytes in the column, pass a null value for the buffer.The total length will be returned.
The index of the column to retrieve
The zero-based index of where to begin reading the data
The buffer to write the bytes into
The zero-based index of where to begin writing into the array
The number of bytes to retrieve
The actual number of bytes written into the array, if buffer is null, will return total length
Returns the column as a single character
The index of the column to retrieve
char
Retrieves a column as an array of chars (blob)
To determine the number of characters in the column, pass a null value for the buffer. The total length will be returned.
The index of the column to retrieve
The zero-based index of where to begin reading the data
The buffer to write the characters into
The zero-based index of where to begin writing into the array
The number of bytes to retrieve
The actual number of bytes written into the array, if buffer is null, will return total length
Retrieves the name of the back-end datatype of the column
The index of the column to retrieve
string
Retrieve the column as a date/time value
The index of the column to retrieve
DateTime
Retrieve the column as a decimal value
The index of the column to retrieve
decimal
Returns the column as a double
The index of the column to retrieve
double
Returns the .NET type of a given column
The index of the column to retrieve
Type
Returns a column as a float value
The index of the column to retrieve
float
Returns the column as a Guid
The index of the column to retrieve
Guid
Returns the column as a short
The index of the column to retrieve
Int16
Retrieves the column as an int
The index of the column to retrieve
Int32
Retrieves the column as a long
The index of the column to retrieve
Int64
Retrieves the name of the column
The index of the column to retrieve
string
Retrieves the index of a column, given its name
The name of the column to retrieve
The int index of the column
Schema information in SQLite is difficult to map into .NET conventions, so a lot of work must be done
to gather the necessary information so it can be represented in an ADO.NET manner.
Returns a DataTable containing the schema information for the active SELECT statement being processed.
Retrieves the column as a string
The index of the column to retrieve
string
Retrieves the column as an object corresponding to the underlying datatype of the column
The index of the column to retrieve
object
Retrieves the values of multiple columns, up to the size of the supplied array
The array to fill with values from the columns in the current resultset
The number of columns retrieved
Returns True if the resultset has rows that can be fetched
Returns True if the data reader is closed
Returns True if the specified column is null
The index of the column to retrieve
True or False
Indexer to retrieve data from a column given its i
The index of the column to retrieve
The value contained in the column
Indexer to retrieve data from a column given its name
The name of the column to retrieve data for
The value contained in the column
Moves to the next resultset in multiple row-returning SQL command.
True if the command was successful and a new resultset is available, False otherwise.
Database exception
Reads the next row from the resultset
True if a new row was successfully loaded and is ready for processing
Retrieve the count of records affected by an update/insert/delete command. Only valid once the data reader is closed!
Implementation of DbParameter.
Default constructor
Constructs a named parameter given the specified parameter name and initial value
The parameter name
The initial value of the parameter
Returns the datatype of the parameter
Supports only input parameters
Whether or not the parameter can contain a null value
Returns the parameter name
Returns the size of the parameter
Gets/sets the source column
Used by DbCommandBuilder to determine the mapping for nullable fields
Gets and sets the row version
Gets and sets the parameter value. If no datatype was specified, the datatype will assume the type from the value given.
Implementation of DbParameterCollection.
Adds a parameter to the collection
The parameter to add
A zero-based index of where the parameter is located in the array
Adds a parameter to the collection
The parameter to add
A zero-based index of where the parameter is located in the array
Adds an array of parameters to the collection
The array of parameters to add
Adds a named/unnamed parameter and its value to the parameter collection.
Name of the parameter, or null to indicate an unnamed parameter
The initial value of the parameter
Returns the NavisworksParameter object created during the call.
Clears the array and resets the collection
Determines if the parameter exists in the collection
The NavisworksParameter to check
True if the parameter is in the collection
Determines if the named parameter exists in the collection
The name of the parameter to check
True if the parameter is in the collection
Not implemented
Returns a count of parameters in the collection
Retrieves a parameter by its index in the collection
The index of the parameter to retrieve
A DbParameter object
Retrieve a parameter by name from the collection
The name of the parameter to fetch
A DbParameter object
Returns the index of a parameter
The parameter to find
-1 if not found, otherwise a zero-based index of the parameter
Returns the index of a parameter given its name
The name of the parameter to find
-1 if not found, otherwise a zero-based index of the parameter
Inserts a parameter into the array at the specified location
The zero-based index to insert the parameter at
The parameter to insert
Returns false
Returns false
Returns true
Overloaded to specialize the return value of the default indexer
The index of the parameter to get/set
The specified NavisworksParameter
Overloaded to specialize the return value of the default indexer
Name of the parameter to get/set
The specified named NavisworksParameter
Removes specified parameter from the collection
The parameter to remove
Removes a parameter from the collection given its index
The zero-based parameter index to remove
Removes a parameter from the collection given its name
The name of the parameter to remove
Re-assign a parameter at the specified index
The zero-based index of the parameter to replace
The new parameter
Re-assign the named parameter to a new parameter object
The name of the parameter to replace
The new parameter
Returns null
Implementation of DbTransaction.
Commits the current transaction.
Returns the underlying connection to which this transaction applies.
Forwards to the local Connection property
Gets the isolation level of the transaction. NavisworksTransaction only supports Serializable transactions.
Rolls back the active transaction.
Stores the Civil Alignment information contained in a Document.
The index of the alignment, from the provided list, that is the current alignment used for
rendering and everything else.
Are there any alignments in the scene
Is rendering of the current alignment enabled
Get a list of all of the alignments in the scene
Stores the Current Comments information contained in a Document.
Occurs when the Value of this object has changed.
Changes the Current Comments.
Typically called when the focus changes from one Comment Source to an other.
Internal string representing the owner of the comments.
The Comments.
Changes the Current Comments.
Typically called when the focus changes from one Comment Source to an other.
Internal string representing the owner of the comments.
The Comments.
The Comment to select.
Occurs when when the Value of this object is about to change.
Sets situation that there is no owner, comments are cleared and editing prevented.
Copies the CommentCollection from comments.
Creates a copy of the CommentCollection associated with this object.
Conversion operator returning .
Internal string representing the owner of the comments.
Explicit form of conversion operator returning .
The value of the current CommentsCollection within the Document.
The current measurement state in a Document
Converts the measurement to redlines. Then adds the redlines to the current saved viewpoint.
If there is no current saved viewpoint, then one is created.
Cannot convert to Redlines
No active viewer
Failed to add redlines to current saved viewpoint
Cannot convert to Redlines
No active viewer
Failed to add redlines to current saved viewpoint
Determines if the measurement can be converted to redlines
Returns the difference
Difference not set
Difference not set
Returns the end point
EndPoint not set
EndPoint not set
Returns the first point
FirstPoint not set
FirstPoint not set
Determines if the difference is available
Determines if the end point is available
Determines if the first point is available
Determines if the MeasurementValue and MeasurementType are available
Returns the measurement type
Measurement not set
Measurement not set
Returns the measurement value
Measurement not set
Measurement not set
Returns the measurement tool in use
Returns the tool measurement type
The current search in a Document
Occurs when the Search contained in this object has changed
Occurs when the Search contained in this object is about to change
Clears the current search
Copies the Search from search
Creates a copy of the Search associated with this object
Returns true when there is no selection or search conditions in the search
Conversion operator returning
Explicit form of conversion operator returning
The value of the current search within the document
The current selection in a Document
Adds a ModelItem to the Selection
The ModelItem we wish to add to the selection
Adds a range of ModelItem to the Selection
The ModelItems we wish to add to the selection
Occurs when the Selection contained in this object has changed
Occurs when the Selection contained in this object is about to change
Removes all entries from
Copies the ModelItems from a ModelItemCollection and replaces the list of entries held
in SelectedItems
The ModelItems to reference for this operation
Copies the Selection from selection and replaces the list of entries held
in SelectedItems
Updates the SelectionSources in Selection from selectionSources and
replaces the list of entries held in SelectedItems
Copies the ModelItems from a IEnumerable>ModelItem< and
replaces the list of entries held in SelectedItems
The ModelItems to reference for this operation
Creates a copy of the Selection associated with this object
Returns true when there are no ModelItems in the selection
Conversion operator returning
Removes a ModelItem from the Selection
The ModelItems we wish to remove from the selection
Selects all the ModelItems in the current document
Collection of instances of ModelItem in this Selection
Explicit form of conversion operator returning
The value of the current selection within the document
The Current Viewpoint in a Document
Occurs when the Viewpoint contained in this object has changed.
Occurs when the Viewpoint contained in this object is about to change.
Copies the Viewpoint from viewpoint int the one in the Document
Creates a copy of the Viewpoint associated with this object
Conversion operator returning
Explicit form of conversion operator returning
The value of the current Viewpoint within the document
The embedded database in a Document
Begin a transaction.
Determines which action should do after commit transaction, DatabaseChangedAction
If success return NavisworksTransaction, if failed, return null
Database element can't be created
Database exception
Occurs when the DocumentDatabase has changed
Occurs when the DocumentDatabase is about to change
Enable table to undoable or redoable.
Database element can't be created
Database exception
If is in a transaction.
Occurs when entirely new database loaded from file.
Conversion operator returning
Explicit form of conversion operator returning
Occurs when a database transaction is about to begins, before any of the edits in the transaction take place.
Occurs when a database transaction begins, before any of the edits in the transaction take place.
Occurs when a database transaction has completed all edits and will commit.
Occurs when a database transaction has completed all edits and happen error, but will rollback.
Current database about to be unloaded (about to change file or exit).
The value of the NavisworksConnection of embedded database in the document
Stores the Grids information contained in a Document.
The GridSystem that will be rendered.
Occurs when the GridsData contained in this object has changed.
Occurs when the GridsData contained in about to change.
The GridSystem that will be rendered.
Sets the LockedLevel for a particular System.
The collection of all GridSystems within the Document.
Stores the Hyperlinks information contained in a Document.
Occurs when the document hyperlinks have changed.
Occurs when the document hyperlinks are about to change.
Deletes all hyperlinks from a ModelItem.
Gets hyperlinks for a ModelItem.
Resets hyperlinks on all ModelItems.
Resets hyperlinks on a ModelItem back to their original state.
Sets hyperlinks for a ModelItem from a list of hyperlinks.
The DocumentInfo stored in a Document
Adds a copy of item to the end of the specified parent group contained by DocumentInfo.
The parent group to add to. RootItem or null to add directly to Value
Argument 'parent' has been Disposed
Argument 'parent' is not contained by DocumentInfo
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' contains an unsupported type of SavedItem
Adds a copy of item to the end of Value.
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' contains an unsupported type of SavedItem
Adds an unique copy of item to the end of Value
If the parent group have the same name, will add it to item name
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' contains an unsupported type of SavedItem
Occurs when the DocumentInfo contained in this object has changed
Occurs when the DocumentInfo contained in this object is about to change
Creates a copy of
Edit item and update it's DisplayName
Argument 'item' has been Disposed
Argument 'item' is not contained by DocumentInfo
Inserts a copy of item into the specified parent group contained by DocumentInfo.
The parent group to insert into. RootItem or null to insert directly into Value
Argument 'parent' has been Disposed
Argument 'parent' is not contained by DocumentInfo
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' contains an unsupported type of SavedItem
Argument 'index' out of range
Inserts a copy of item into Value.
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' contains an unsupported type of SavedItem
Argument 'index' out of range
Inserts a copy of item into the specified parent group contained by DocumentInfo. If have same sheet, will reset id and rename
The parent group to insert into. RootItem or null to insert directly into Value
If the parent group have the same name, will add it to item name
Argument 'parent' has been Disposed
Argument 'parent' is not contained by DocumentInfo
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' contains an unsupported type of SavedItem
Argument 'index' out of range
Moves item at oldIndex in OldParent to newIndex in newParent
The parent group to move the item from.
The parent group to move to.
If newParent is equal to oldParent, the item will be moved within the same SavedItemCollection.
Argument 'oldParent' has been Disposed
Argument 'oldParent' is not contained by DocumentInfo
Argument 'newParent' has been Disposed
Argument 'newParent' is not contained by DocumentInfo
Argument 'oldIndex' out of range
Argument 'newIndex' out of range
Move sheet from oldIndex to new position in collection.
The sheet in this position to move
The moved sheet place in this position
Two arguments 'oldIndex' and 'newIndex are equal, they should not be equal.
Argument 'oldIndex' out of range
Argument 'newIndex' out of range
Conversion operator returning
Removes specified item from the specified parent group contained by DocumentInfo.
The parent group to remove from. null to remove directly from DocumentInfo
false if item not found in DocumentInfo
Argument 'parent' has been Disposed
Argument 'parent' is not contained by DocumentInfo
Argument 'item' has been Disposed
Removes specified item from DocumentInfo.
false if item not found in DocumentInfo
Argument 'item' has been Disposed
Removes item from the specified parent group contained by DocumentInfo.
The parent group to remove from. RootItem or null to remove directly from DocumentInfo
Argument 'parent' has been Disposed
Argument 'parent' is not contained by DocumentInfo
Argument 'index' out of range
Removes item at the specified index from DocumentInfo.
Argument 'index' out of range
Replaces item from the specified parent group with a copy of item
The parent group to insert into. RootItem or null to insert directly into Value
Argument 'parent' has been Disposed
Argument 'parent' is not contained by DocumentInfo
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' contains an unsupported type of SavedItem
Argument 'index' out of range
Replaces item at given index within DocumentInfo with a copy of item
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' contains an unsupported type of SavedItem
Argument 'index' out of range
Explicit form of conversion operator returning
The value of the current DocumentInfo within the document
Stores the collection of Models contained in a Document
Occurs when the collection of Models has changed
Occurs when the collection of Models is about to change
Determines whether the collection contains a specific value.
The Model to locate in the collection.
true if item is found in the collection; otherwise, false.
Copies the elements of the to an , starting at a particular index.
The one-dimensional that is the destination of the elements copied from . The must have zero-based indexing.
The zero-based index in array at which copying begins.
arrayIndex is less than 0.
array is null.
array is multidimensional.-or-arrayIndex is equal to or greater than the length of array.-or-The number of elements in the source is greater than the available space from arrayIndex to the end of the destination array.-or-Type T cannot be cast automatically to the type of the destination array.
Copies the contents of the collection into to
The target collection
to is null
Gets the number of elements contained in the collection.
Returns an empty collection associated with this Document
Returns a snapshot collection containing the RootItem from each
Returns a collection of indices that defines a path from the root item through its
descendants to the specified item.
Item is not contained in this document part
Return the path identifier that defines a path from the root item through its
descendants to the specified item, and the model index this item belongs to.
Argument 'item' is null
Returns numeric ID for a given model item.
ID for model item, or 0 if no ID.
Returns collection of model items that have a given numeric ID.
Model item collection containing requested items (if any).
Gets the first Model in the collection, returns null if the collection is empty
Gets the hidden status as defined by the constituent models.
Returns an enumerator that can iterate through the collection.
An IEnumerator that can be used to iterate through the collection.
Determines the index of a specific item in the DocumentModels.
Returns true if all items have their IsFrozen property set.
items is null
Returns true if all items have their Hidden property set.
items is null
Gets a value indicating whether the collection is read-only.
Returns true if all items have their IsRequired property set.
items is null
Ensures the model items given and all of their children are visible.
Occurs when the material (color or transparency) of any ModelGeometry
in the models has changed.
Occurs when the editable properties (Hidden or Required) of any ModelItem
in the models has changed.
Occurs when the units or transform of a Model has changed.
Occurs when the units or transform of a Model are about to change.
Overrides the permanent color of all ModelGeometry descendants
of items.
items is null
color is null
Apply an incremental transform to a selection.
Overrides the permanent transparency of all ModelGeometry descendants
of items.
items is null
Overrides the temporary color of all ModelGeometry descendants
of items.
items is null
color is null
Overrides the temporary transparency of all ModelGeometry descendants
of items.
items is null
Clears the IsFrozen property on all items in the models.
Clears the IsHidden property on all items in the models.
Resets the hidden status to that defined in the constituent models.
Resets permanent material properties (color and transparency) of
all ModelGeometry in the models.
Reset incremental transforms for all model items contained in the entire model.
Clears the IsRequired property on all items in the models.
Resets temporary material properties (color and transparency) of
all ModelGeometry in the models.
Resets permanent material properties (color and transparency) of
all ModelGeometry descendants of items.
items is null
Reset incremental transforms for all model items contained in the selection.
Resets temporary material properties (color and transparency) of
all ModelGeometry descendants of items.
items is null
Returns the saved item referenced by a collection of indices that define a path from the
root item through its descendants to the specified item.
null if source cannot be resolved
Argument 'path' is null
Returns the saved item referenced by a model index and a path identifier that
define a path from the root item through its descendants to the specified item.
null if source cannot be resolved
Argument 'pathId' is null
All descendants of RootItems (excluding the RootItems themselves).
All descendants of RootItems (including the RootItems themselves).
The RootItem from each model
Occurs whenever a new scene is loaded (or reloaded). This is meant only for internal
Navisworks usage.
Sets the IsFrozen property on all instances of specified items.
items is null
Sets the IsHidden property on all instances of specified items.
items is null
Sets the model units and transform.
Sets the IsRequired property on all instances of specified items.
items is null
The saved viewpoints stored in a Document.
Edit item and add Comment to item's Comments
Argument 'item' has been Disposed
Argument 'item' is not contained by SavedViewpoints
Adds a copy of item to the end of the specified parent group contained by SavedViewpoints.
The parent group to add to. RootItem or null to add directly to Value
Argument 'parent' has been Disposed
Argument 'parent' is not contained by SavedViewpoints
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' contains an unsupported type of SavedItem
Adds a copy of item to the end of Value.
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' contains an unsupported type of SavedItem
Creates a view that captures current runtime overrides.
Occurs when the SavedViewpoints contained in this object has changed
Occurs when the SavedViewpoint contained in this object is about to change
Removes all items in Value
Copies the SavedViewpoints from value and
replaces the list of entries held in .
Copies the SavedViewpoints from value and replaces the list of entries held
in .
Creates a copy of the SavedViewpoints associated with this object
Returns a collection of indices that defines a path from the root item through its
descendents to the specified item.
Item is not contained in this document part
Returns a reference to a saved item.
Argument 'item' is not contained in this document part
The current item as displayed in the GUI. Must exist in or be null.
Argument 'savedViewpoint' is not contained by SavedViewpoints
Occurs when CurrentSavedViewpoint has changed.
Edit item and update it's Comments
Argument 'item' has been Disposed
Argument 'item' is not contained by SavedViewpoints
Edit item and update it's DisplayName
Argument 'item' has been Disposed
Argument 'item' is not contained by SavedViewpoints
The internal identifier for this type of document part.
Inserts a copy of item into the specified parent group contained by SavedViewpoints.
The parent group to insert into. RootItem or null to insert directly into Value
Argument 'parent' has been Disposed
Argument 'parent' is not contained by SavedViewpoints
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' contains an unsupported type of SavedItem
Argument 'index' out of range
Inserts a copy of item into Value.
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' contains an unsupported type of SavedItem
Argument 'index' out of range
Moves item at oldIndex in OldParent to newIndex in newParent
The parent group to move the item from. RootItem or null to remove directly from Value
The parent group to move to. RootItem or null to move directly into Value.
If newParent is equal to oldParent, the item will be moved within the same SavedItemCollection.
Argument 'oldParent' has been Disposed
Argument 'oldParent' is not contained by SavedViewpoints
Argument 'newParent' has been Disposed
Argument 'newParent' is not contained by SavedViewpoints
Argument 'oldIndex' out of range
Argument 'newIndex' out of range
Moves item from oldIndex to newIndex within Value
Argument 'oldIndex' out of range
Argument 'newIndex' out of range
Conversion operator returning
Removes specified item from the specified parent group contained by SavedViewpoints.
The parent group to remove from. RootItem or null to remove directly from Value
false if item not found in Value
Argument 'parent' has been Disposed
Argument 'parent' is not contained by SavedViewpoints
Argument 'item' has been Disposed
Removes specified item from Value.
false if item not found in Value
Argument 'item' has been Disposed
Removes item from the specified parent group contained by SavedViewpoints.
The parent group to remove from. RootItem or null to remove directly from Value
Argument 'parent' has been Disposed
Argument 'parent' is not contained by SavedViewpoints
Argument 'index' out of range
Removes item at the specified index from Value.
Argument 'index' out of range
Replaces the SavedViewpoint within Value with an updated copy.
Viewpoint, Redlines and visibility are updated to those in the current View.
Argument 'savedViewpoint' has been Disposed
Argument 'savedViewpoint' is null
Argument 'savedViewpoint' is not contained by SavedViewpoints
Replaces item from the specified parent group with a copy of item
The parent group to insert into. RootItem or null to insert directly into Value
Argument 'parent' has been Disposed
Argument 'parent' is not contained by SavedViewpoints
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' contains an unsupported type of SavedItem
Argument 'index' out of range
Replaces item at given index within Value with a copy of item
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' contains an unsupported type of SavedItem
Argument 'index' out of range
Returns the saved item referenced by a guid.
Returns the saved item referenced by a collection of indices that define a path from the
root item through its descendents to the specified item.
null if source cannot be resolved
Argument 'path' is null
Returns the saved item referenced by a SavedItemReference.
DocumentPartId on reference does not match the Id of this part
Argument 'reference' is null
as the children of a
Explicit form of conversion operator returning
The collection of SavedViewpoints stored in the Document
The SelectionSets stored in a Document
Edit item and add Comment to item's Comments
Argument 'item' has been Disposed
Argument 'item' is not contained by SelectionSets
Adds a copy of item to the end of the specified parent group contained by SelectionSets.
The parent group to add to. RootItem or null to add directly to Value
Argument 'parent' has been Disposed
Argument 'parent' is not contained by Selectionsets
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' contains an unsupported type of SavedItem
Adds a copy of item to the end of Value.
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' contains an unsupported type of SavedItem
Occurs when the SelectionSets contained in this object has changed
Occurs when the Selection contained in this object is about to change
Removes all items in Value
Copies the SelectionSets from value and
replaces the list of entries held in .
Copies the SelectionSets from value and replaces the list of entries held
in .
Creates a copy of the SelectionSets associated with this object
Returns a collection of indices that defines a path from the root item through its
descendents to the specified item.
Item is not contained in this document part
Returns a reference to a saved item.
Argument 'item' is not contained in this document part
Returns a selection source that refers to the selection defined by a Selection Set
or folder of Selection Sets.
Argument 'item' is not contained in this document part
Edit item and update it's Comments
Argument 'item' has been Disposed
Argument 'item' is not contained by SelectionSets
Edit item and update it's DisplayName
Argument 'item' has been Disposed
Argument 'item' is not contained by SelectionSets
The internal identifier for this type of document part.
Inserts a copy of item into the specified parent group contained by SelectionSets.
The parent group to insert into. RootItem or null to insert directly into Value
Argument 'parent' has been Disposed
Argument 'parent' is not contained by Selectionsets
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' contains an unsupported type of SavedItem
Argument 'index' out of range
Inserts a copy of item into Value.
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' contains an unsupported type of SavedItem
Argument 'index' out of range
Moves item at oldIndex in OldParent to newIndex in newParent
The parent group to move the item from. RootItem or null to remove directly from Value
The parent group to move to. RootItem or null to move directly into Value.
If newParent is equal to oldParent, the item will be moved within the same SavedItemCollection.
Argument 'oldParent' has been Disposed
Argument 'oldParent' is not contained by Selectionsets
Argument 'newParent' has been Disposed
Argument 'newParent' is not contained by Selectionsets
Argument 'oldIndex' out of range
Argument 'newIndex' out of range
Moves item from oldIndex to newIndex within Value
Argument 'oldIndex' out of range
Argument 'newIndex' out of range
Conversion operator returning
Removes specified item from the specified parent group contained by SelectionSets.
The parent group to remove from. RootItem or null to remove directly from Value
false if item not found in Value
Argument 'parent' has been Disposed
Argument 'parent' is not contained by Selectionsets
Argument 'item' has been Disposed
Removes specified item from Value.
false if item not found in Value
Argument 'item' has been Disposed
Removes item from the specified parent group contained by SelectionSets.
The parent group to remove from. RootItem or null to remove directly from Value
Argument 'parent' has been Disposed
Argument 'parent' is not contained by Selectionsets
Argument 'index' out of range
Removes item at the specified index from Value.
Argument 'index' out of range
Replaces item from the specified parent group with a copy of item
The parent group to insert into. RootItem or null to insert directly into Value
Argument 'parent' has been Disposed
Argument 'parent' is not contained by Selectionsets
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' contains an unsupported type of SavedItem
Argument 'index' out of range
Replaces item at given index within Value with a copy of item
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' contains an unsupported type of SavedItem
Argument 'index' out of range
Returns the saved item referenced by a guid.
Returns the saved item referenced by a collection of indices that define a path from the
root item through its descendents to the specified item.
null if source cannot be resolved
Argument 'path' is null
Returns the saved item referenced by a SavedItemReference.
DocumentPartId on reference does not match the Id of this part
Argument 'reference' is null
Returns the saved item referenced by a SelectionSource
null if source cannot be resolved
Argument 'source' is null
as the children of a
Explicit form of conversion operator returning
The collection of SelectionSets stored in the Document
The active tool in a Document
Occurs when the current Tool has changed
For the case where is CustomToolPlugin,
this will return the the passed in ToolPlugin identifier.
Conversion operator returning
Explicit method that sets
Sets the current Tool to a custom ToolPlugin.
Loaded ToolPlugin
Argument 'toolPlugin' is null
Explicit form of conversion operator returning
The value of the active Tool within the document
Attempts to set to CustomToolPlugin will be ignored.
This method cannot be used with 'CustomToolPlugin', use SetCustomToolPlugin instead
Discoverable Document Part for Clash Detective
Discoverable Document Part for Takeoff
Discoverable Document Part for Timeliner
Represent a combined id with model index and the path identifier.
Constructor for a ModelItemPathId.
The model index
The path identifier
Location of an AddInPlugin in the Navisworks menus system
Do not display in the menus
Display in the Addin menu
Display in the Import menu
Display in the Export menu
Display in the Help menu
Display in the Context menu for currently selected ModelItem
Display in the 2D Context menu for currently selected ModelItem
A plugin that can be called either using the GUI,
ApplicationAutomation
or using the Automation .NET API
Default constructor for an AddInPlugin
This is called to determine the state of plugin.
Primarily if Execute can be called.
This method is called when the plugin is executed
Called to tell the plugin to display help
Return true if you have handled this call
Optional attribute for use with an AddInPlugin derived class.
If this attribute is not used, the default location for an AddInPlugin is AddInLocation.AddIn
Constructor AddInPluginAttribute, takes a single parameter giving the location of the Plugin in the Navisworks menus system
Determines the conditions in which CanExecuteCommand should be called.
Specifies if the command can toggle
The 16x16 icon to display for this command
The 32x32 icon to display for this command
Specifies if CanExecuteCommand should cause the Plugin to load
Determines where the plugin is displayed in Navisworks menus system
Specifies the keyboard shortcut for the command.
The Ids of the windows for which the shortcut is valid.
Multiple Ids can be specified by separating with ";".
If Ids are specified the shortcut should be valid in all contexts.
Represents an AddInPlugin record in Navisworks
This is called to determine the state of plugin.
Primarily if Execute can be called.
Specifies if the command can toggle
Executes the plugin, loading it if needed
Execute is Disabled via CanExecute
The 16x16 icon to be displayed for this command
The 32x32 icon to be displayed for this command
Gets the plugin if loaded, otherwise null
Returns the plugin, loads it if required
Plugin failed to load
Where the plugin is displayed in Navisworks menus system
Specifies the keyboard shortcut for the command.
The Ids of the windows for which the shortcut is valid.
Multiple Ids can be specified by separating with ";".
If Ids are specified the shortcut should be valid in all contexts.
Returns the plugin, loads it if required
null if plugin failed to load
Determines logic used to determine if a command is Enabled
Command is Enabled unless specifically disabled by CanExecute implementation
Command is disabled if the doument is Clear
Command is Disabled unless there is a single selection
Command is Disabled unless there are multiple selections
A plugin for implementing an action to apply to clash results.
Default constructor.
Test whether the item is in a state that is appropriate to use this plugin.
If false is returned then the plugin will only be available to be called
when just a single item is selected in the clash UI Results list.
Represents a ClashResultActionPluginRecord record in Navisworks
Gets the plugin if loaded, otherwise null
Returns the plugin, loads it if required
Plugin failed to load
Returns the plugin, loads it if required
null if plugin failed to load
Defines a new command in the GUI system
Constructor
The name of the command
Determines the conditions in which CanExecuteCommand should be called.
Specifies if the command can toggle
The text to display for this command
The Extended Tooltip to display for this command
The 16x16 icon to display for this command
The 32x32 icon to display for this command
Specifies if CanExecuteCommand should cause the Plugin to load
The name of the command
Specifies the keyboard shortcut for the command.
The Ids of the windows for which the shortcut is valid.
Multiple Ids can be specified by separating with ";".
If Ids are specified the shortcut should be valid in all contexts.
The Tooltip to display for this command
A plugin that can be used to add commands to the GUI
Default constructor for a CommandHandlerPlugin
Called to determine if a command can be executed
The name of the command
Called to determine if a ribbon tab can be executed
The name of the ribbon tab
Called when a command is executed
The name of the command
Paramaters to be passed to the command
Called to tell the plugin to display help
The name of the command
Return true if you have handled this call
Represents an CommandHandlerPlugin record in Navisworks
Calls CanExecuteCommand on the plugin
The Id of the command
Invalid Id
Calls CanExecuteRibbonTab on the plugin
The Id of the ribbon tab
Plugin failed to load
Invalid Id
Commands defined by this plugin
Calls ExecuteCommand on the plugin
The Id of the command
Paramaters to be passed to the command
Execute is Disabled via CanExecute
Plugin failed to load
Invalid Id
Helper to extract a name from a Id.
Gets the plugin if loaded, otherwise null
Returns the plugin, loads it if required
Plugin failed to load
Helper to make an Id from a name
Xaml files that define the layout of the RibbonTabs and Commands
Ribbon Tabs defined by this plugin
Calls TryShowCommandHelp on the plugin
The Id of the command
Plugin failed to load
Invalid Id
ToolTips files that define tooltips for RibbonTabs and Commands
Returns the plugin, loads it if required
null if plugin failed to load
Calls TryShowCommandHelp on the plugin
The Id of the command
Represents the definition of a command in the GUI system
Specifies if the command can toggle
The text to be displayed for this command
The extended tooltip to be displayed for this command
The 16x16 icon to be displayed for this command
The full Id of the command. This is a combination of
and Plugin.Id
The 32x32 icon to be displayed for this command
Specifies the keyboard shortcut for the command.
The Ids of the windows for which the shortcut is valid.
Multiple Ids can be specified by separating with ";".
If Ids are specified the shortcut should be valid in all contexts.
The tooltip to be displayed for this command
Represents the state of a command in the GUI
Constructor
Constructor
Allows specifiecation of Enabled
Specifies if the command should be checked
Specifies if the command should be enabled
Specifies if the command should be visible
Specifies if the display name for the command should be overridden
A custom plugin is the most basic plugin that can be defined.
It can be used when none of the specialized behaviour of other plugin tyes is required.
Default constructor for a CustomPlugin
Record representing a CustomPlugin
Gets the plugin if loaded, otherwise null
Returns the plugin, loads it if required
Plugin failed to load
Returns the plugin, loads it if required
null if plugin failed to load
A plugin that can be used to add a docking pane to the GUI.
Default constructor for a DockPanePlugin
Activates the pane (i.e. makes it the window with keyboard focus), also making it
visible first, if necessary.
Called to tell the plugin to create it's pane. The pane will be resized as specified by the
DockPanePluginAttribute.
Should be overriden in conjunction with
DestroyControlPane.
A Control that contains the pane content
Called to tell the plugin to create it's pane. The pane will be resized as specified by the
DockPanePluginAttribute.
Should be overriden in conjunction with
DestroyHWndPane.
The pane should be created using this window as it's parent
The handle of window that contains the pane content
Called to tell the plugin to destroy it's pane
Should be overriden in conjunction with
CreateControlPane.
The pane to destroy
Called to tell the plugin to destroy it's pane.
Should be overriden in conjunction with
CreateHWndPane.
The pane to destroy
Called when the active pane changes
Called when the visibility of the pane changes
Called to tell the plugin to display help
Return true if you have handled this call
Called to tell the plugin to display help at a screen point
Return true if you have handled this call
Called to tell the plugin to display help for highlight
Return true if you have handled this call
The visibility of the pane
Optional attribute for use with an DockPanePlugin derived class.
If this attribute is not used, the default values are the same as using a DockPanePluginAttribute(100,100)
Constructor DockPanePluginAttribute, takes a pair of values that specify the prefered size for the pane. Default values are:
MinimumWidth=0,
MinimumHeight=0,
AutoScroll=true,
FixedSize=true.
The preferred width
The preferred height
Determines if scroll bars should appear when the pane gets bellow it's minimum size
Determines if the pane should be resizable
Minimum height of pane, 0 means no preference
Minimum width of pane, 0 means no preference
Preferred height of pane, 0 means no preference
Preferred width of pane, 0 means no preference
Represents an DockPanePlugin record in Navisworks
Determines if scroll bars should appear when the pane gets bellow it's minimum size
Determines if the pane should be resizable
Gets the plugin if loaded, otherwise null
Returns the plugin, loads it if required
Plugin failed to load
Minimum height of pane, 0 means no preference
Minimum width of pane, 0 means no preference
Preferred height of pane, 0 means no preference
Preferred width of pane, 0 means no preference
Returns the plugin, loads it if required
null if plugin failed to load
Differs fom other plugin types in that the plugin is not delay loaded.
A typical implementation will subscribe to some API events in
OnLoaded and
unsubscribe in OnUnloading.
Default constructor for a EventWatcherPlugin
Called once immediately after the plugin has been loaded (created).
Default implementation does nothing.
This is a good place to subscribe to API events.
Called once just before the plugin is unloaded. If the plugin implements
IDisposable, then
Dispose will be called immediately after the plugin is unloaded.
Plugins are typically unloaded at application shutdown or when the end user has disabled a plugin.
Default implementation does nothing.
This is a good place to unsubscribe from API events.
Record representing a EventWatcherPlugin
Gets the plugin if loaded, otherwise null
Returns the plugin, loads it if required
Plugin failed to load
Returns the plugin, loads it if required
null if plugin failed to load
The exception that is thrown when you try to call Execute on a plugin who's CanExecute method states that it should be disabled.
Creates a PluginLoadException
Creates a PluginLoadException
Creates a PluginLoadException
The error message that explains the reason for the exception.
Creates a PluginLoadException
The error message that explains the reason for the exception.
The exception that is the cause of the current exception. If the innerException parameter is not null, the current exception is raised in a catch block that handles the inner exception.
Metadata about a file or URI.
Default constructor.
Is the ModificationTime property valid?
Object has been Disposed
Is the RevisionId property valid?
Object has been Disposed
Is the Size property valid?
Object has been Disposed
The modification time of the URI.
Object has been Disposed
Object is Read-Only
The revision id of the URI.
Object has been Disposed
Object is Read-Only
The size in bytes of the URI.
Object has been Disposed
Object is Read-Only
A file handle opened via the FileProtocolPlugin.
Default constructor.
Closes an open file handle.
Reads data from a file.
Writes data to a file.
Open mode for FileProtocolPlugin interface.
Open for read
Open for write
A plugin for implementing a custom file protocol.
Default constructor.
Downloads a remote URI to a local path.
Returns information about a URI.
Downloads a remote URI to the protocols internal cache.
Does this protocol access remote data?
Directly opens a URI.
Uploads a file to a remote URI.
List of schemes that this protocol supports.
Does this protocol support direct opening of a file?
Does this protocol support the GetFile and PutFile methods?
Does this protocol support it's own cache?
Returns the normal display name for a given URI.
Returns the path to store in the MRU list for a given URI.
Returns the verbose display name for a given URI.
Returns the verbose display name for a given URI.
Called to resolve an absolute URI.
Called to resolve an relative URI.
Represents a FileProtocolPlugin record in Navisworks
Gets the plugin if loaded, otherwise null
Returns the plugin, loads it if required
Plugin failed to load
Returns the plugin, loads it if required
null if plugin failed to load
A plugin for implementing a home screen extension
Default constructor for a HomeScreenExtensionPlugin
The URL for the iframe to display.
The HTML to load in the iframe if the FrameUrl cannot be loaded.
Returns the host object origins.
The host object origins
The host object for the iframe.
The name to access HostObject.
Sets the host object origins. The host object is only accessible if the
iframe's origin matches one of the provided origins (for security reasons).
The host object origins
Represents a HomeScreenExtensionPlugin record in Navisworks
Returns the plugin, loads it if required
Plugin failed to load
A plugin that can respond to mouse and keyboard inputs.
Default constructor for an InputPlugin
ContextMenu handler.
GetCursor handler.
GetHelpIdAtPoint handler.
GetHelpIdForHighlight handler.
GetTooltip handler
MouseLeave handler.
KeyDrag handler.
KeyUp handler.
ModifierKeyDown handler.
ModifierKeyUp handler.
Mouse down handler.
Mouse drag handler.
Mouse leave handler.
Mouse move handler.
Mouse up handler.
WheelDrag handler.
Represents an InputPlugin record in Navisworks
Gets the plugin if loaded, otherwise null
Returns the plugin, loads it if required
Plugin failed to load
Returns the plugin, loads it if required
null if plugin failed to load
Attribute that declares a plugin implements a particular interface or behaviours.
Attribute that declares a plugin implements particular interface or behaviour.
The combination of Name and DeveloperId is used
to form an Id that identifies which interface is being supported.
The name of the interface.
The 4 character ADN developer code or a GUID.
The 4 character ADN developer code or a GUID. The combination of this and Name is used
to form and Id that identifies which interface is being supported.
Optional additional information about the interface implementation
The name of the Inteface. The combination of this and DeveloperId is used
to form an Id that identifies which interface is being supported.
Optional additional information about the interface implementation
Record that declares a plugin implements a particular interface or behaviour.
The 4 character ADN developer code or a GUID. The combination of this and Name is used
to form Id that identifies which interface is being supported.
Optional additional information about the interface implementation
The full identifier of the interface being supported. This is formed as
Name.DeveloperId
The name of the Inteface. The combination of this and DeveloperId is used
to form Id that identifies which interface is being supported.
Optional additional information about the interface implementation
Base class for all plugins
Default constructor for a Plugin
The 4 character ADN developer code or a GUID. The combination of this and Name should make the plugin unique
Looks up a localizable string that is specific to this plugin
The identifier of the string to lookup
Returns localized string
The identifier is Null.
Failed to look up string with specified identifier
Looks up a localizable string that is specific to this plugin
The identifier of the string to lookup
Returns localized string or value of 'name' if it cannot be found
The identifier is Null.
The full identifier for the plugin. This is formed as
Name.DeveloperId
Called once to determines if the plugin is enabled.
Only called if PluginRecord.SupportsIsSelfEnabled is true
The name of the Plugin. The combination of this and DeveloperId should make the plugin unique
Called once immediately after the plugin has been loaded (created).
Plugins are loaded on demand so this may be some time after application startup.
Default implementation does nothing.
This is a good place to subscribe to API events.
Called once just before the plugin is unloaded. If the plugin implements
IDisposable, then
Dispose will be called immediately after the plugin is unloaded.
Plugins are typically unloaded at application shutdown or when the end user has disabled a plugin.
Default implementation does nothing.
This is a good place to unsubscribe from API events.
The PluginRecord that provides access to the attribute defined properties for this plugin.
Looks up a localizable string that is specific to this plugin
The identifier of the string to lookup
Returns localized string or Null if it cannot be found
The identifier is Null.
The standard attribute which must be applied to all plug-ins.
The standard attribute constructor which must be applied to all plug-ins.
The combination of Name and DeveloperId should make the plugin unique
The name of the Plugin.
The 4 character ADN developer code or a GUID.
The 4 character ADN developer code or a GUID. The combination of this and Name should make the plugin unique
Text to display in the Navisworks GUI
The extended tooltip to display when the Plugin is highlighted in the Navisworks GUI
The name of the Plugin. The combination of this and DeveloperId should make the plugin unique
Options that modify how a plugin behaves
Determines if Plugin.IsSelfEnabled will be called.
The tooltip to display when the Plugin is highlighted in the Navisworks GUI
The exception that is thrown when a plugin fails to load
Creates a PluginLoadException
Creates a PluginLoadException
Creates a PluginLoadException
The error message that explains the reason for the exception.
Creates a PluginLoadException
The error message that explains the reason for the exception.
The exception that is the cause of the current exception. If the innerException parameter is not null, the current exception is raised in a catch block that handles the inner exception.
Options that modify how a plugin behaves
No additional options
Supports being used in a control (see Autodesk.Navisworks.Api.Controls)
Metadata for a plugin that can be loaded into Navisworks.
The information in PluginRecord is available even if the corresponding Plugin hasn’t been loaded.
Gets the 4 character ADN developer code or a GUID. The combination of this and Name should make the plugin unique
Text to display in the Navisworks GUI.
Extended Tooltip to display when the Plugin is highlighted in the Navisworks GUI
Finds an InterfaceRecord
The Id of the InterfaceRecord
null if the InterfaceRecord cannot be found
Determines if an attempt has been made to create the Plugin.
Determines if an attempt has been made to create the plugin, and it has failed.
Where SupportsIsSelfEnabled is true then the plugin
will be created early and IsSelfEnabled
will be called to determine the result.
Will return false if the plugin could not be created to make the call.
The full identifier for the plugin. This is formed as
Name.DeveloperId
Returns a collection of InterfaceRecords that declare which interfaces we support
Gets whether the Plugin is currently enabled for use or not.
Gets whether the Plugin is currently loaded
Gets the plugin if loaded, otherwise null
Returns the plugin, loads it if required
Plugin failed to load
Gets the name of the Plugin. The combination of this and DeveloperId should make the plugin unique
Gets flags for how plugins run
Determines if IsSelfEnabled will be called.
Tooltip to display when the Plugin is highlighted in the Navisworks GUI
Returns the plugin, loads it if required
null if plugin failed to load
A plugin that can perform custom rendering.
Default constructor for an RenderPlugin
Should return bounding box of any additional model space geometry that will be rendered so that near/far clipping planes can be adjusted accordingly.
Bounding box
Override to allow custom drawing overlayed on main render.
Override to allow custom drawing in main render.
Represents an RenderPlugin record in Navisworks
Gets the plugin if loaded, otherwise null
Returns the plugin, loads it if required
Plugin failed to load
Returns the plugin, loads it if required
null if plugin failed to load
Defines a new ribbon layout in the GUI system
Constructor
The Xaml file that specifies the Ribbon tab
The Xaml file that specifies the Ribbon tab and commands
Represents the definition of a ribbon layout in the GUI system
The path to the Xaml file that specifies the layout of ribbon and commands
Defines a ribbon tab in the GUI system.
Constructor
The name of the Ribbon tab
Determines the conditions in which CanExecuteRibbonTab should be called.
The text to display for this Ribbon tab
Specifies if CanExecuteRibbonTab should cause the Plugin to load
The name of the Ribbon tab
Represents the definition of a ribbon tab in the GUI system.
The text to be displayed for this Ribbon tab
The full Id of the ribbon tab. This is a combination of
and Plugin.Id
Attribute which causes a string localization file to be loaded for a particular plug-in.
Attribute causes a string localization file to be loaded for a particular plug-in.
The filename containing the strings.
The filename containing the strings.
A plugin that provides the behaviour of a custom tool.
Default constructor for an ToolPlugin
ContextMenu handler.
GetCursor handler.
GetHelpIdAtPoint handler.
GetHelpIdForHighlight handler.
GetTooltip handler
MouseLeave handler.
KeyDrag handler.
KeyUp handler.
Should return bounding box of any additional model space geometry that will be rendered so that near/far clipping planes can be adjusted accordingly.
Bounding box
ModifierKeyDown handler.
ModifierKeyUp handler.
Mouse down handler.
Mouse drag handler.
Mouse leave handler.
Mouse move handler.
Mouse up handler.
Override to allow custom drawing overlayed on main render.
Override to allow custom drawing in main render.
WheelDrag handler.
Represents an ToolPlugin record in Navisworks
Gets the plugin if loaded, otherwise null
Returns the plugin, loads it if required
Plugin failed to load
Returns the plugin, loads it if required
null if plugin failed to load
Defines tooltips for ribbon tabs and commands in the GUI system.
Constructor
The file that specifies the tooltips
The file that specifies the tooltips for Ribbon tab and commands
Represents the definition of tooltips for ribbon tabs and commands in the GUI system.
The path to the file that specifies the tool tips for the ribbon and commands
Represents the definition of a value within a .
Default constructor. No identifier specified.
Constructs the field with a given identifier.
Provided field ID is invalid or missing. 7-bit ASCII without spaces must be used.
Argument 'id' is not convertable to a 7-bit ASCII string
Default value that created objects will contain at creation time.
Object has been Disposed
Object is Read-Only
Gets a value from a given via the associated .
C++ exception 'LcUSchemaNotCompiledException' thrown
C++ exception 'LcUSchemaInvalidAccessorException' thrown
Object has been Disposed
Argument 'accessor' is null
Argument 'accessor' has been Disposed
Gets a value indicating whether the object is read-only.
Sets a value into a given via the associated .
C++ exception 'LcUSchemaNotCompiledException' thrown
C++ exception 'LcUSchemaInvalidAccessorException' thrown
Object has been Disposed
Argument 'accessor' is null
Argument 'accessor' has been Disposed
Intermediate base class for all complex structural Fields.
Gets a value indicating whether the object is read-only.
A collection of concept strings.
Create an empty collection.
Create one collection from another.
Argument 'from' is null
Argument 'from' has been Disposed
Adds an item to the .
The to add to the .
The position into which the new element was inserted.
The is read-only.-or- The has a fixed size.
Adds item to the end of the collection.
Object has been Disposed
Object is Read-Only
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' is ReadOnly
Add the items of the specified collection to the SavedItemCollection
The collection to add items from
Removes all items from the collection
Object has been Disposed
Object is Read-Only
Gets a value indicating whether the object is read-only.
Determines whether the contains a specific value.
The to locate in the .
true if the is found in the ; otherwise, false.
Determines whether the SavedItemCollection contains a specific value.
Object has been Disposed
Argument 'item' has been Disposed
Sets the contents of the collection to the items in from
The collection to copy contents from
Copies the elements of the to an , starting at a particular index.
The one-dimensional that is the destination of the elements copied from . The must have zero-based indexing.
The zero-based index in array at which copying begins.
array is null.
index is less than zero.
array is multidimensional.-or- index is equal to or greater than the length of array.-or- The number of elements in the source is greater than the available space from index to the end of the destination array.
The type of the source cannot be cast automatically to the type of the destination array.
Enumerates over the collection and copies the items into to
Collection to copy into
Copies the elements of the to an , starting at a particular index.
The one-dimensional that is the destination of the elements copied from . The must have zero-based indexing.
The zero-based index in array at which copying begins.
arrayIndex is less than 0.
array is null.
array is multidimensional.-or-arrayIndex is equal to or greater than the length of array.-or-The number of elements in the source is greater than the available space from arrayIndex to the end of the destination array.-or-Type T cannot be cast automatically to the type of the destination array.
Gets the number of elements contained in the collection.
Object has been Disposed
Returns an enumerator that can iterate through the collection.
An IEnumerator that can be used to iterate through the collection.
Gets or sets the element at the specified index.
Object has been Disposed
Object is Read-Only
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' is ReadOnly
Argument 'index' out of range
Determines the index of a specific item in the .
The to locate in the .
The index of value if found in the list; otherwise, -1.
Determines the index of a specific item in the Collection
Argument 'item' has been Disposed
Inserts an item to the at the specified index.
The to insert into the .
The zero-based index at which value should be inserted.
index is not a valid index in the .
The is read-only.-or- The has a fixed size.
value is null reference in the .
Inserts item into the collection at the specified index
Object has been Disposed
Object is Read-Only
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' is ReadOnly
Argument 'index' out of range
Returns an enumerator that can iterate through the collection.
An IEnumerator that
can be used to iterate through the collection.
Gets a value indicating whether the has a fixed size.
true if the has a fixed size; otherwise, false.
Gets a value indicating whether the object is read-only.
Gets a value indicating whether access to the is synchronized (thread safe).
true if access to the is synchronized (thread safe); otherwise, false.
Removes the first occurrence of a specific object from the .
The to remove from the .
The is read-only.-or- The has a fixed size.
Removes the first occurrence of a specific item from the collection.
The object to remove from the collection.
true if item was successfully removed from the collection; otherwise, false.
This method also returns false if item is not found in the original collection.
The collection is read-only.
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' is ReadOnly
Removes the item at the specified index.
The zero-based index of the item to remove.
The is read-only.
index is not a valid index in the .
Gets an object that can be used to synchronize access to the .
An object that can be used to synchronize access to the .
Represents the definition of a value within a .
Default constructor. No identifier specified.
Constructs the field with a given identifier.
Provided field ID is invalid or missing. 7-bit ASCII without spaces must be used.
Argument 'id' is not convertable to a 7-bit ASCII string
Default value that created objects will contain at creation time.
Object has been Disposed
Object is Read-Only
Gets a value from a given via the associated .
C++ exception 'LcUSchemaNotCompiledException' thrown
C++ exception 'LcUSchemaInvalidAccessorException' thrown
Object has been Disposed
Argument 'accessor' is null
Argument 'accessor' has been Disposed
Gets a value indicating whether the object is read-only.
Sets a value into a given via the associated .
C++ exception 'LcUSchemaNotCompiledException' thrown
C++ exception 'LcUSchemaInvalidAccessorException' thrown
Object has been Disposed
Argument 'accessor' is null
Argument 'accessor' has been Disposed
Represents the unit group (eg. length, volume, angle, etc) of the field value.
Object has been Disposed
Object is Read-Only
Provides editing access into a via an associated . Represents a given position inside .
Gets a value indicating whether the object is read-only.
Base class for all fields used within SchemaDefinitions.
Field-specific semantics associated with this field.
Object has been Disposed
The field's display name internal ID. Used for looking up the localized display name.
Object has been Disposed
C++ exception 'LcUSchemaCompiledException' thrown
Object is Read-Only
Argument 'display_name_id' is not convertable to a 7-bit ASCII string
The identifier for the field.
Object has been Disposed
C++ exception 'LcUSchemaCompiledException' thrown
Provided field ID is invalid or missing. 7-bit ASCII without spaces must be used.
Object is Read-Only
Argument 'id' is not convertable to a 7-bit ASCII string
Gets a value indicating whether the object is read-only.
Performs comparison 'By Value'
Compares the two references 'By Value'
A collection of Fields.
Create an empty collection.
Create one collection from another.
Argument 'from' is null
Argument 'from' has been Disposed
Adds item to the end of the collection.
Object has been Disposed
Object is Read-Only
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' is ReadOnly
Adds an item to the .
The to add to the .
The position into which the new element was inserted.
The is read-only.-or- The has a fixed size.
Add the items of the specified collection to the SavedItemCollection
The collection to add items from
Removes all items from the collection
Object has been Disposed
Object is Read-Only
Gets a value indicating whether the object is read-only.
Determines whether the SavedItemCollection contains a specific value.
Object has been Disposed
Argument 'item' has been Disposed
Determines whether the contains a specific value.
The to locate in the .
true if the is found in the ; otherwise, false.
Sets the contents of the collection to the items in from
The collection to copy contents from
Copies the elements of the to an , starting at a particular index.
The one-dimensional that is the destination of the elements copied from . The must have zero-based indexing.
The zero-based index in array at which copying begins.
arrayIndex is less than 0.
array is null.
array is multidimensional.-or-arrayIndex is equal to or greater than the length of array.-or-The number of elements in the source is greater than the available space from arrayIndex to the end of the destination array.-or-Type T cannot be cast automatically to the type of the destination array.
Copies the elements of the to an , starting at a particular index.
The one-dimensional that is the destination of the elements copied from . The must have zero-based indexing.
The zero-based index in array at which copying begins.
array is null.
index is less than zero.
array is multidimensional.-or- index is equal to or greater than the length of array.-or- The number of elements in the source is greater than the available space from index to the end of the destination array.
The type of the source cannot be cast automatically to the type of the destination array.
Enumerates over the collection and copies the items into to
Collection to copy into
Gets the number of elements contained in the collection.
Object has been Disposed
Returns an enumerator that can iterate through the collection.
An IEnumerator that can be used to iterate through the collection.
Gets or sets the element at the specified index.
Object has been Disposed
Object is Read-Only
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' is ReadOnly
Argument 'index' out of range
Determines the index of a specific item in the Collection
Argument 'item' has been Disposed
Determines the index of a specific item in the .
The to locate in the .
The index of value if found in the list; otherwise, -1.
Inserts item into the collection at the specified index
Object has been Disposed
Object is Read-Only
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' is ReadOnly
Argument 'index' out of range
Inserts an item to the at the specified index.
The to insert into the .
The zero-based index at which value should be inserted.
index is not a valid index in the .
The is read-only.-or- The has a fixed size.
value is null reference in the .
Returns an enumerator that can iterate through the collection.
An IEnumerator that
can be used to iterate through the collection.
Gets a value indicating whether the has a fixed size.
true if the has a fixed size; otherwise, false.
Gets a value indicating whether the object is read-only.
Gets a value indicating whether access to the is synchronized (thread safe).
true if access to the is synchronized (thread safe); otherwise, false.
Removes the first occurrence of a specific item from the collection.
The object to remove from the collection.
true if item was successfully removed from the collection; otherwise, false.
This method also returns false if item is not found in the original collection.
The collection is read-only.
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' is ReadOnly
Removes the first occurrence of a specific object from the .
The to remove from the .
The is read-only.-or- The has a fixed size.
Removes the item at the specified index.
The zero-based index of the item to remove.
The is read-only.
index is not a valid index in the .
Gets an object that can be used to synchronize access to the .
An object that can be used to synchronize access to the .
Intermediate base class for all complex group Fields.
Gets a value indicating whether the object is read-only.
Represents the definition of a value within a .
Default constructor. No identifier specified.
Constructs the field with a given identifier.
Provided field ID is invalid or missing. 7-bit ASCII without spaces must be used.
Argument 'id' is not convertable to a 7-bit ASCII string
Constructs the field with a given identifier.
Provided field ID is invalid or missing. 7-bit ASCII without spaces must be used.
Argument 'id' is not convertable to a 7-bit ASCII string
Default value that created objects will contain at creation time.
Object has been Disposed
Object is Read-Only
Gets a value from a given via the associated .
C++ exception 'LcUSchemaNotCompiledException' thrown
C++ exception 'LcUSchemaInvalidAccessorException' thrown
Object has been Disposed
Argument 'accessor' is null
Argument 'accessor' has been Disposed
Gets a value indicating whether the object is read-only.
Ownership semantics for this GUID.
Object has been Disposed
C++ exception 'LcUSchemaCompiledException' thrown
Object is Read-Only
Sets a value into a given via the associated .
C++ exception 'LcUSchemaNotCompiledException' thrown
C++ exception 'LcUSchemaInvalidAccessorException' thrown
Object has been Disposed
Argument 'accessor' is null
Argument 'accessor' has been Disposed
Target concept, if any, that we expect the referenced resource to implement.
Object has been Disposed
C++ exception 'LcUSchemaCompiledException' thrown
Object is Read-Only
Ownership semantics for a given GUID.
GUID has no implied meaning.
Uniquely identifies a given resource. There are no ownership implications as this is on the resource itself.
A unique reference to another resource. Ownership is implicit as no other resource can own this reference.
A shared reference to another resource. Ownership is akin to reference counting.
A reference to another resource that explicitly has no ownership. The reference may be invalid (i.e. the resource could be missing).
A reference to another resource that explicitly has direct ownership. Similar to UniqueReference but may be referenced by WeakReference GUIDs.
A reference to an external resource that is not specified via Identifier.
Represents the definition of a value within a .
Default constructor. No identifier specified.
Constructs the field with a given identifier.
Provided field ID is invalid or missing. 7-bit ASCII without spaces must be used.
Argument 'id' is not convertable to a 7-bit ASCII string
Default value that created objects will contain at creation time.
Object has been Disposed
Object is Read-Only
Gets a value from a given via the associated .
C++ exception 'LcUSchemaNotCompiledException' thrown
C++ exception 'LcUSchemaInvalidAccessorException' thrown
Object has been Disposed
Argument 'accessor' is null
Argument 'accessor' has been Disposed
Gets a value indicating whether the object is read-only.
Sets a value into a given via the associated .
C++ exception 'LcUSchemaNotCompiledException' thrown
C++ exception 'LcUSchemaInvalidAccessorException' thrown
Object has been Disposed
Argument 'accessor' is null
Argument 'accessor' has been Disposed
Provides read-only access into a via an associated . Represents a given position inside .
Gets a value indicating whether the object is read-only.
Tests to see if this accessor is associated with a given .
Object has been Disposed
Argument 'instance' has been Disposed
Enables construction of SchemaDefinitions.
Default constructor.
Adds a given concept string onto the schema definition under construction.
Object has been Disposed
Object is Read-Only
Copies & adds in the field to the builder's internal collection.
Provided field ID is invalid or missing. 7-bit ASCII without spaces must be used.
Provided field ID is already in use.
Object has been Disposed
Object is Read-Only
Argument 'field' is null
Argument 'field' has been Disposed
Constructs a schema definition matching what has been passed into & .
Object has been Disposed
Object is Read-Only
Gets a value indicating whether the object is read-only.
Contains data values defined by a given schema definition. May be traversed manually or accessed via NET DLR dynamic typing.
Creates a copy of the current state of this data object.
C++ exception 'LcUSchemaInvalidException' thrown
Object has been Disposed
Schema definition that defines this data object.
Object has been Disposed
Enumerates the dynamically added members of the object by name.
Accessor for editing values when beginning a query into this data object.
C++ exception 'LcUSchemaInvalidException' thrown
Object has been Disposed
Object is Read-Only
Fetches the property value specified by the string argument.
Name of the dynamic property to obtain. As with real NET properties, this name is case-sensitive.
Value of the dynamic property retrieved.
Name is not a valid dynamic property.
Gets a value indicating whether the object is read-only.
Read-only accessor for beginning a query into this data object.
C++ exception 'LcUSchemaInvalidException' thrown
Object has been Disposed
Sets a value to the property specified by the string argument.
Name of the dynamic property to set. As with real NET properties, this name is case-sensitive.
Value to set. This should match the type of the dynamic property.
The same object as was passed to argument 'value'. This enables settor chaining.
Name is not a valid dynamic property.
Value does not cast to the expected dynamic property type.
Setting to the property is not supported.
Performs a value comparison.
C++ exception 'LcUSchemaInvalidException' thrown
Object has been Disposed
Argument 'rhs' is null
Argument 'rhs' has been Disposed
Performs comparison 'By Value'
Compares the two references 'By Value'
Schema definitions are used to define data structures that are then created as schema data objects for use with various Navisworks API calls.
The concepts that this definition implements.
Object has been Disposed
Creates a concrete data object to hold values structured according to the Fields within this definition.
Object has been Disposed
Determines whether the specified object and the current object refer to the same
underlying native object. Returns false if either object has been disposed.
The top level of Fields within this definition.
Object has been Disposed
Serves as a hash function for a particular type. is suitable for use in hashing algorithms and data structures like a hash table.
A hash code for the current .
Gets a value indicating whether the object is read-only.
Performs comparison 'By Value'
Compares the two references 'By Value'
A collection of Definitions.
Create an empty collection.
Create one collection from another.
Argument 'from' is null
Argument 'from' has been Disposed
Adds an item to the .
The object to add to the .
The is read-only.
Adds an item to the .
The to add to the .
The position into which the new element was inserted.
The is read-only.-or- The has a fixed size.
Removes all items from the .
The is read-only.
Gets a value indicating whether the object is read-only.
Determines whether the SavedItemCollection contains a specific value.
Object has been Disposed
Argument 'item' has been Disposed
Determines whether the contains a specific value.
The to locate in the .
true if the is found in the ; otherwise, false.
Copies the elements of the to an , starting at a particular index.
The one-dimensional that is the destination of the elements copied from . The must have zero-based indexing.
The zero-based index in array at which copying begins.
arrayIndex is less than 0.
array is null.
array is multidimensional.-or-arrayIndex is equal to or greater than the length of array.-or-The number of elements in the source is greater than the available space from arrayIndex to the end of the destination array.-or-Type T cannot be cast automatically to the type of the destination array.
Copies the elements of the to an , starting at a particular index.
The one-dimensional that is the destination of the elements copied from . The must have zero-based indexing.
The zero-based index in array at which copying begins.
array is null.
index is less than zero.
array is multidimensional.-or- index is equal to or greater than the length of array.-or- The number of elements in the source is greater than the available space from index to the end of the destination array.
The type of the source cannot be cast automatically to the type of the destination array.
Enumerates over the collection and copies the items into to
Collection to copy into
Gets the number of elements contained in the collection.
Object has been Disposed
Removes all items from the .
The is read-only.
Removes the item at the specified index.
The zero-based index of the item to remove.
The is read-only.
index is not a valid index in the .
Returns an enumerator that can iterate through the collection.
An IEnumerator that can be used to iterate through the collection.
Gets or sets the element at the specified index.
Object has been Disposed
Object is Read-Only
Argument 'item' has been Disposed
Argument 'item' is null
Argument 'item' is ReadOnly
Argument 'index' out of range
Determines the index of a specific item in the Collection
Argument 'item' has been Disposed
Determines the index of a specific item in the .
The to locate in the .
The index of value if found in the list; otherwise, -1.
Inserts an item to the at the specified index.
The object to insert into the .
The zero-based index at which item should be inserted.
The is read-only.
index is not a valid index in the .
Inserts an item to the at the specified index.
The to insert into the .
The zero-based index at which value should be inserted.
index is not a valid index in the .
The is read-only.-or- The has a fixed size.
value is null reference in the .
Returns an enumerator that can iterate through the collection.
An IEnumerator that
can be used to iterate through the collection.
Gets a value indicating whether the has a fixed size.
true if the has a fixed size; otherwise, false.
Gets a value indicating whether the object is read-only.
Gets a value indicating whether access to the is synchronized (thread safe).
true if access to the is synchronized (thread safe); otherwise, false.
Removes the first occurrence of a specific object from the .
The object to remove from the .
true if item was successfully removed from the ; otherwise, false. This method also returns false if item is not found in the original .
The is read-only.
Removes the first occurrence of a specific object from the .
The to remove from the .
The is read-only.-or- The has a fixed size.
Removes the item at the specified index.
The zero-based index of the item to remove.
index is not a valid index in the .
The is read-only.-or- The has a fixed size.
Gets an object that can be used to synchronize access to the .
An object that can be used to synchronize access to the .
Intermediate base class for all simple value Fields.
Gets a value indicating whether the object is read-only.
Represents the definition of a value within a .
Default constructor. No identifier specified.
Constructs the field with a given identifier.
Provided field ID is invalid or missing. 7-bit ASCII without spaces must be used.
Argument 'id' is not convertable to a 7-bit ASCII string
Default value that created objects will contain at creation time.
Object has been Disposed
Object is Read-Only
Gets a value from a given via the associated .
C++ exception 'LcUSchemaNotCompiledException' thrown
C++ exception 'LcUSchemaInvalidAccessorException' thrown
Object has been Disposed
Argument 'accessor' is null
Argument 'accessor' has been Disposed
Gets a value indicating whether the object is read-only.
Sets a value into a given via the associated .
C++ exception 'LcUSchemaNotCompiledException' thrown
C++ exception 'LcUSchemaInvalidAccessorException' thrown
Object has been Disposed
Argument 'accessor' is null
Argument 'accessor' has been Disposed
Represents the definition of a structure within a .
Default constructor. No identifier specified.
Constructs the field with a given identifier.
Provided field ID is invalid or missing. 7-bit ASCII without spaces must be used.
Argument 'id' is not convertable to a 7-bit ASCII string
The fields that comprise the struct content.
Object has been Disposed
Gets a value indicating whether the object is read-only.
Represents the unit group (eg. length, volume, angle, etc) of the field value.
No unit group specified (default).
Unit group is length.
Unit group is area.
Unit group is volume.
Unit group is angle.
Represents the definition of a vector within a .
Default constructor. No identifier specified.
Argument 'value' has been Disposed
Constructs the field with a given identifier.
Provided field ID is invalid or missing. 7-bit ASCII without spaces must be used.
Argument 'id' is not convertable to a 7-bit ASCII string
Argument 'value' is null
Argument 'value' has been Disposed
Represents collection metadata, including whether the collection is ordered, and whether the elements are unique.
Object has been Disposed
Object is Read-Only
Obtains the number of values held within a distinct object.
Accessor provided by parent object e.g. from , or a containing VectorField's IndexAccessor.
C++ exception 'LcUSchemaStorageNotCompiledException' thrown
C++ exception 'LcUSchemaInvalidAccessorException' thrown
Object has been Disposed
Argument 'accessor' is null
Argument 'accessor' has been Disposed
Obtains the appropriate accessor for a given index into the vector.
Accessor provided by parent object e.g. from , or a containing VectorField's IndexAccessor.
C++ exception 'LcUSchemaStorageNotCompiledException' thrown
C++ exception 'LcUSchemaInvalidAccessorException' thrown
An invalid index was passed.
Object has been Disposed
Argument 'accessor' is null
Argument 'accessor' has been Disposed
Obtains the appropriate accessor for a given index into the vector.
Accessor provided by parent object e.g. from , or a containing VectorField's IndexAccessor.
C++ exception 'LcUSchemaStorageNotCompiledException' thrown
C++ exception 'LcUSchemaInvalidAccessorException' thrown
An invalid index was passed.
Object has been Disposed
Argument 'accessor' is null
Argument 'accessor' has been Disposed
Gets a value indicating whether the object is read-only.
Sets the number of values held within a distinct object. Each index will be initialised to its default value.
Accessor provided by parent object e.g. from , or a containing VectorField's IndexAccessor.
C++ exception 'LcUSchemaStorageNotCompiledException' thrown
C++ exception 'LcUSchemaInvalidAccessorException' thrown
Object has been Disposed
Argument 'accessor' is null
Argument 'accessor' has been Disposed
A field object that identifies the type used within the vector & provides access to each index.
Object has been Disposed
Represents collection metadata, including whether the collection is ordered, and whether the elements are unique.
Preserving element order is not important. (Default)
Preserving element order is important.
Preserving element order is not important and elements must be unique.
Preserving element order is important and elements must be unique.