CIP Visual Basic.NET documentation for interface "IpfcSheetOwner"

Interface IpfcSheetOwner

Description

This interface represents a model containing sheets.

Direct Known Subclasses:: IpfcModel2D

Property Summary


`Property`	`CurrentSheetNumber`	`as Long`
	The current sheet number.

`Property`	`NumberOfSheets`	`as Long`
	The number of sheets in the model.

Method Summary


`Function`	`AddSheet () as Long`
	Adds a sheet to the model.

`Sub`	`DeleteSheet (SheetNumber as Long)`
	Removes a sheet from the model.

`Function`	`GetSheetBackgroundView (SheetNumber as Long) as IpfcView2D`
	Returns the background view for the given sheet.

`Function`	`GetSheetData (SheetNumber as Long) as IpfcSheetData [optional]`
	Returns information about the specified sheet.

`Function`	`GetSheetFormat (SheetNumber as Long) as IpfcDrawingFormat [optional]`
	Returns the drawing format used for the particular sheet.

`Function`	`GetSheetFormatDescr (SheetNumber as Long) as IpfcModelDescriptor`
	Returns the model descriptor of the drawing format used for the particular sheet.

`Function`	`GetSheetInfo (SheetNumber as Long) as IpfcSheetInfo [optional]`
	Returns information about the specified sheet.

`Function`	`GetSheetScale (SheetNumber as Long, DrawingModel as IpfcModel [optional]) as Double`
	Returns the scale of the drawing on particular sheet.

`Function`	`GetSheetTransform (SheetNumber as Long) as IpfcTransform3D`
	Returns the transformation matrix for the sheet.

`Function`	`GetSheetUnits (SheetNumber as Long) as IpfcUnit`
	Returns the length units for the given sheet.

`Sub`	`RegenerateSheet (SheetNumber as Long)`
	Regenerates a specified sheet.

`Sub`	`ReorderSheet (FromSheetNumber as Long, To as Long)`
	Reorders the given sheet to a new sheet number.

`Sub`	`SetSheetFormat (SheetNumber as Long, Format as IpfcDrawingFormat, FormatSheetNumber as Long [optional], DrawingModel as IpfcModel [optional])`
	Applies the specified format to a drawing sheet.

`Sub`	`SetSheetScale (SheetNumber as Long, Scale as Double, DrawingModel as IpfcModel [optional])`
	Sets the scale for a model on the sheet.

Property Detail

Property CurrentSheetNumber as Long

The current sheet number.

Property NumberOfSheets as Long

The number of sheets in the model.

Method Detail

Function AddSheet () as Long

Adds a sheet to the model.

Exceptions thrown (but not limited to):

IpfcXToolkitNotFound - The function failed because you do not have the required modules.

IpfcXToolkitInvalidItem - The function did nothing because the model already has the maximum number of sheets allowed.

Returns:: The number of the new sheet added.

Sub DeleteSheet (SheetNumber as Long)

Removes a sheet from the model.

Exceptions thrown (but not limited to):

IpfcXToolkitNotFound - The function failed because you do not have the required modules.

IpfcXToolkitInvalidItem - The function did nothing because the specified sheet is not in the specified drawing.

IpfcXToolkitDeadLock - The Creo Parametric user interface is not prepared to handle this request (because it is blocked by another process such as an OLE container activation).

Parameters:

SheetNumber: The number of the sheet to remove.

Function GetSheetBackgroundView (SheetNumber as Long) as IpfcView2D

Returns the background view for the given sheet.

The sheet background view is used for the placement of items in the drawing without associating them to a particular model view.

Parameters:

SheetNumber: The sheet number. Sheet numbers range from 1 up to the number of sheets.

Returns:: The background view object.

Function GetSheetData (SheetNumber as Long) as IpfcSheetData [optional]

Returns information about the specified sheet.

This method is deprecated. Use IpfcSheetOwner.GetSheetInfo() instead.

Parameters:

SheetNumber: The sheet number. Sheet numbers range from 1 to the number of sheets.

Returns:: The sheet data, including size, orientation, and units.

Function GetSheetFormat (SheetNumber as Long) as IpfcDrawingFormat [optional]

Returns the drawing format used for the particular sheet.

Exceptions thrown (but not limited to):

IpfcXToolkitNotFound - Format for the sheet was not found.

Parameters:

SheetNumber: The sheet number. Sheet numbers range from 1 to the number of sheets.

Returns:: The drawing format, or null, if no format is assigned to the sheet.

Function GetSheetFormatDescr (SheetNumber as Long) as IpfcModelDescriptor

Returns the model descriptor of the drawing format used for the particular sheet.

Exceptions thrown (but not limited to):

IpfcXToolkitNotFound - Format for the sheet was not found.

Parameters:

SheetNumber: The sheet number. Sheet numbers range from 1 to the number of sheets.

Returns:: The model descriptor of the drawing format.

Function GetSheetInfo (SheetNumber as Long) as IpfcSheetInfo [optional]

Returns information about the specified sheet.

Parameters:

SheetNumber: The sheet number. Sheet numbers range from 1 to the number of sheets.

Returns:: The sheet info including size, orientation, and units.

Function GetSheetScale (SheetNumber as Long, DrawingModel as IpfcModel [optional]) as Double

Returns the scale of the drawing on particular sheet.

Parameters:

SheetNumber: The sheet number. Sheet numbers range from 1 to the number of sheets.
DrawingModel: The model used to measure the scale. If null, the function uses the current model in the drawing.

Returns:: The sheet scale. If no models are used in the drawing, the scale is 1.0.

Function GetSheetTransform (SheetNumber as Long) as IpfcTransform3D

Returns the transformation matrix for the sheet.

Parameters:

SheetNumber: The sheet number. Sheet numbers range from 1 to the number of sheets.

Returns:: The transformation matrix for the sheet.

Function GetSheetUnits (SheetNumber as Long) as IpfcUnit

Returns the length units for the given sheet.

Parameters:

SheetNumber: The sheet number. Sheet numbers range from 1 up to the number of sheets.

Returns:: The units.

Sub RegenerateSheet (SheetNumber as Long)

Regenerates a specified sheet.

The sheet must be displayed.

Parameters:

SheetNumber: The sheet number. Sheet numbers range from 1 to the number of sheets.

Sub ReorderSheet (FromSheetNumber as Long, To as Long)

Reorders the given sheet to a new sheet number.

Reordering will cause other affected sheets to change their sheet numbers as well.

Parameters:

FromSheetNumber: The sheet number to reorder. Sheet numbers range from 1 to the number of sheets.
To: The new sheet number for the sheet.

Sub SetSheetFormat (SheetNumber as Long, Format as IpfcDrawingFormat, FormatSheetNumber as Long [optional], DrawingModel as IpfcModel [optional])

Applies the specified format to a drawing sheet.

Parameters:

SheetNumber: The sheet number to apply the format. Sheet numbers range from 1 to the number of sheets.
Format: The drawing format to apply.
FormatSheetNumber: The sheet number of the format to apply. This number can range from 1 to the number of sheets in the format. Pass null to use the first format sheet.
DrawingModel: The drawing model (used when resolving parameters in the format). Pass null to use the current drawing model.

Sub SetSheetScale (SheetNumber as Long, Scale as Double, DrawingModel as IpfcModel [optional])

Sets the scale for a model on the sheet.

Parameters:

SheetNumber: The sheet number. Sheet numbers range from 1 to the number of sheets.
Scale: The scale to use.
DrawingModel: The drawing model to scale. Pass null to use the current drawing model.