Sheet Object

Description

The Sheet object represents a sheet in a drawing document. See here for an overview on drawing views.

Methods

Name	Description
Activate	Method that causes this sheet to become the active sheet.
AddBorder	Method that adds the specified border definition to the sheet. This method will fail in the case where a border instance already exists on the sheet. In this case, use the Delete method of the Border object to remove the existing one first.
AddDefaultBorder	Method that adds an instance of the default border to the sheet. This method is the equivalent of inserting the 'Default Border' border. A border created using the default border is created 'on the fly' by Autodesk Inventor using the supplied input. It is not based on an existing border definition.
AddTitleBlock	Method that adds the specified title block definition to the sheet. Since a sheet can only have one title block at a time, calling this method will remove the existing title block.
ChangeLayer	Method that changes the associated layer for all the input objects.
CopyTo	Method that copies this sheet into the specified drawing document. The new sheet is returned.
CreateGeometryIntent	Method that creates a GeometryIntent object for use in various annotation and view creations.
Delete	Method that deletes this sheet.
FindUsingPoint	Method that finds drawing curve segments, entities on a sheet sketch, centerlines and centermarks that the given point lies on.
GetAvailableDesignViewsToRetrieve3DAnnotations	Gets an array of strings containing names of the design views of model document that the 3D annotations can be retrieved from.
GetReferenceKey	Method that generates and returns the reference key for this entity.
GetRetrievableAnnotations	Returns a collection of objects that represent the valid set of model dimensions that can be retrieved into the input drawing view.
RetrieveAnnotations	Retrieves sketch and/or model annotations into the drawing.
Update	Method that updates the sheet.

Properties

Name	Description
Application	Returns the top-level parent application object. When used the context of Inventor, an Application object is returned. When used in the context of Apprentice, an ApprenticeServer object is returned.
AttributeSets	Property that returns the AttributeSets collection object associated with this object.
AutoCADBlocks	Property that returns the AutoCADBlocks collection object. This object provides access to all instances of AutoCAD blocks on a sheet. This property returns Nothing for sheets on an Inventor IDW document.
Balloons	Property that returns the collection of on this sheet.
Border	Property that returns the Border or DefaultBorder object associated with the sheet. This property will return Nothing in the case where the sheet doesn't have a border.
Centerlines	Property that returns the Centerlines collection object.
Centermarks	Property that returns the Centermarks collection object.
ClientGraphicsCollection	Gets the ClientGraphicsCollection object.
ClientViews	Property that returns the collection for the drawing sheet.
CustomTables	Property that returns the CustomTables collection object for this sheet.
DataIO	Property that returns a DataIO object. The DataIO object can be used to write out the sheet data in various formats. The Sheet currently only supports
DrawingDimensions	Property that returns the DrawingDimensions collection object. This object provides access to all of the dimensions on the sheet.
DrawingNotes	Property that returns the DrawingNotes collection object consisting of all drawing notes.
DrawingViews	Property that returns the collection object. This provides access to the existing drawing views on the sheet.
EdgeSymbols	Read-only property that returns the collection of edge symbols on this sheet.
ExcludeFromCount	Gets or sets whether to exclude the sheet in the count of sheets in the drawing.
ExcludeFromPrinting	Gets or sets whether to exclude the sheet when printing the drawing.
FeatureControlFrames	Property that returns the FeatureControlFrames collection object.
GraphicsDataSetsCollection	Gets the GraphicsDataSetsCollection object.
Height	Gets or sets the height of the sheet.
HoleTables	Property that returns the HoleTables collection object.
IsModelSpaceSheet	Property that returns whether this is a model space sheet created automatically when opening (rather than importing) AutoCAD dwg files.
Name	Gets or sets the user-friendly name of the Sheet.
Orientation	Gets or sets the orientation of the sheet as it is viewed or printed.
Parent	Property returning the parent document. When used within Autodesk Inventor the DrawingDocument object will be returned. When used within Apprentice the ApprenticeServerDrawingDocument object will be returned.
PartsLists	Property that returns the PartsLists collection object associated with this sheet. This provides access to the existing parts lists on the sheet.
Revision	Gets or sets the revision number of the sheet.
RevisionClouds	Get the RevisionClouds collection object.
RevisionTables	Property that returns the RevisionTables collection object.
Size	Gets or sets the size of the Sheet as value in an enumeration of standard sheet sizes.
SketchedSymbols	Property that returns the SketchedSymbols collection object. This object provides access to all sketched symbols on a sheet.
Sketches	Property that returns the DrawingSketches collection object for the sheet. This object provides access to all of the sketches that have been created on the sheet and provides functionality to create new sketches.
Status	Property that returns the current status of the sheet and its contents. If the value is equal to kUpToDateDrawingSheet then the drawing sheet is up to date. Any other value means some portion of the sheet is out of date. The returned value can contain status information about several things about the sheet. You can use bitwise operators to determine the status for a particular item. For example the following can be used to see if the precise display for views on sheet are up to date. If (oSheet.Status And kProcessingPreciseDisplayDrawingSheet) = kProcessingPreciseDisplayDrawingSheet Then MsgBox "Processing precise display." End If This is useful when an operation requires the sheet to be up to date. For example, when plotting the sheet.
SurfaceTextureSymbols	Property that returns the SurfaceTextureSymbols collection object.
TextPropertySource	Read-write property that gets and sets the text property source model. This is the name of a drawing view.
TitleBlock	Property that returns the TitleBlock object associated with the sheet. This property will return Nothing in the case where the sheet doesn't have a title block.
TransitionSymbols	Returns the collection of edge symbols on this sheet.
Type	Returns an ObjectTypeEnum indicating this object's type.
WeldingSymbols	Get the DrawingWeldingSymbols collection object.
Width	Gets or sets the width of the sheet.

Accessed From

Samples

Name	Description
AutoCAD block insertion	Demonstrates inserting an AutoCAD block.
Balloons - edit	This sample demonstrates the editing of balloons in a drawing.
Creation a balloon	This sample demonstrates the creation of a balloon.
Baseline dimension sets	This sample demonstrates the creation of a baseline set dimension in a drawing.
Create bend note	This sample demonstrates the creation of a bend note on the drawing view of a flat pattern.
Creation of a break operation in a drawing view	Demonstrates the creation of a break operation.
Chain dimensions sets	This sample demonstrates the creation of a chain dimension set in a drawing.
Custom Table - create	This sample demonstrates how to create a custom table.
Create a Bend Table	This sample demonstrates the creation of a bend table in a drawing from a sheet metal part.
Create a Configuration Table	This sample demonstrates the creation of a configuration (iPart/iAssembly) table in a drawing from a factory document.
Create a drawing Excel Table	This sample demonstrates the creation of a table based on an Excel file in a drawing.
Adding and editing a feature control frame	These samples demonstrate editing an existing feature control frame symbol. The first sample adds a row to an existing symbol. The second sample replaces all rows of an existing symbol.
Create thread note	This sample demonstrates the creation of a thread note on a drawing view.
Creating a parts list	This sample demonstrates the creation of a parts list. The parts list is placed at the top right corner of the border if one exists, else it is placed at the top right corner of the sheet.
create punch note	This sample demonstrates the creation of a punch note on the drawing view of a flat pattern.
Border Insert	This sample illustrates inserting a default border.
Border Insert Default	This sample illustrates inserting a default border using the default values.
Create sheet with multiple views	This sample demonstrates the creation of a drawing sheet based on a particular sheet format containing the definition for multiple views.
Create SketchedSymbol Definition	This sample illustrates creating a new sketched symbol definition object and inserting it into the active sheet.
Create sketched symbol and leader	This sample illustrates creating sketched symbol with a leader.
Add surface texture symbol to dimension	This sample demonstrates the creation of a surface texture symbol attached to the extension line of a drawing dimension.
Sketch Text Add	This sample illustrates creating text in a sketch.
Title Block Definition Create and Insert	This sample illustrates creating a new title block definition object and inserting it into the active sheet. This sample consists of two subs. The first demonstrates the creation of a title block definition and the second inserts it into the active sheet.
Copying a title block definition	This sample demonstrates copying a title block definition from one drawing to another and replacing the existing title blocks in the drawing with the new title block.

Version

Introduced in version 4

Sheet Object

Description

Methods

Properties

Accessed From

Samples

Version

Was this information helpful?