CIP C++ documentation for class "pfcSheetOwner"

Class pfcSheetOwner

# include <pfcSheet.h> class pfcSheetOwner : public virtual xobject { xaideclare(pfcSheetOwner) ... };

Description

This interface represents a model containing sheets.

Direct Known Subclasses:: pfcModel2D

Method Summary


`xint`	`AddSheet ()`
	Adds a sheet to the model.

`void`	`DeleteSheet (xint SheetNumber)`
	Removes a sheet from the model.

`xint`	`GetCurrentSheetNumber ()`
`void`	`SetCurrentSheetNumber (xint value)`
	The current sheet number.

`xint`	`GetNumberOfSheets ()`
	The number of sheets in the model.

`pfcView2D_ptr`	`GetSheetBackgroundView (xint SheetNumber)`
	Returns the background view for the given sheet.

`optional pfcSheetData_ptr`	`GetSheetData (xint SheetNumber)`
	Returns information about the specified sheet.

`optional pfcDrawingFormat_ptr`	`GetSheetFormat (xint SheetNumber)`
	Returns the drawing format used for the particular sheet.

`pfcModelDescriptor_ptr`	`GetSheetFormatDescr (xint SheetNumber)`
	Returns the model descriptor of the drawing format used for the particular sheet.

`optional pfcSheetInfo_ptr`	`GetSheetInfo (xint SheetNumber)`
	Returns information about the specified sheet.

`xreal`	`GetSheetScale (xint SheetNumber, optional pfcModel_ptr DrawingModel)`
	Returns the scale of the drawing on particular sheet.

`pfcTransform3D_ptr`	`GetSheetTransform (xint SheetNumber)`
	Returns the transformation matrix for the sheet.

`pfcUnit_ptr`	`GetSheetUnits (xint SheetNumber)`
	Returns the length units for the given sheet.

`void`	`RegenerateSheet (xint SheetNumber)`
	Regenerates a specified sheet.

`void`	`ReorderSheet (xint FromSheetNumber, xint To)`
	Reorders the given sheet to a new sheet number.



`void`	`SetSheetFormat (xint SheetNumber, pfcDrawingFormat_ptr Format, optional xint FormatSheetNumber, optional pfcModel_ptr DrawingModel)`
	Applies the specified format to a drawing sheet.

`void`	`SetSheetScale (xint SheetNumber, xreal Scale, optional pfcModel_ptr DrawingModel)`
	Sets the scale for a model on the sheet.

Method Detail

xint GetNumberOfSheets ()

The number of sheets in the model.

Manual References:: Drawings: Drawing Sheet Information, Drawings: Drawing Sheet Information

`xint`	`GetCurrentSheetNumber`	`()`
`void`	`SetCurrentSheetNumber`	`(xint value)`

The current sheet number.

Manual References:: Drawings: Drawing Sheet Information, Drawings: Drawing Sheet Information, Drawings: Drawing Sheet Operations, Drawings: Drawing Sheet Operations

xint AddSheet ()

Adds a sheet to the model.

Exceptions thrown (but not limited to):

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

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

Manual References:: Drawings: Drawing Sheet Operations, Drawings: Drawing Sheet Operations

Returns:: The number of the new sheet added.

void ReorderSheet (xint FromSheetNumber, xint To)

Reorders the given sheet to a new sheet number.

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

Manual References:: Drawings: Drawing Sheet Operations, Drawings: Drawing Sheet Operations

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.

Returns:

optional pfcSheetData_ptr GetSheetData (xint SheetNumber)

Returns information about the specified sheet.

This method is deprecated. Use pfcSheetOwner::GetSheetInfo(xint) instead.

Manual References:: Drawings: Drawing Sheet Information

Parameters:

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

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

optional pfcSheetInfo_ptr GetSheetInfo (xint SheetNumber)

Returns information about the specified sheet.

Manual References:: Drawings: Drawing Sheet Information, Drawings: Drawing Sheet Information

Parameters:

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

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

pfcTransform3D_ptr GetSheetTransform (xint SheetNumber)

Returns the transformation matrix for the sheet.

Manual References:: Drawings: Drawing Sheet Information, Drawings: Drawing Sheet Information

Parameters:

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

Returns:: The transformation matrix for the sheet.

void RegenerateSheet (xint SheetNumber)

Regenerates a specified sheet.

The sheet must be displayed.

Manual References:: Drawings: Drawing Operations, Drawings: Drawing Sheet Operations, Drawings: Drawing Sheet Operations

Parameters:

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

Returns:

void DeleteSheet (xint SheetNumber)

Removes a sheet from the model.

Exceptions thrown (but not limited to):

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

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

pfcXToolkitDeadLock - 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).

Manual References:: Drawings: Drawing Sheet Operations, Drawings: Drawing Sheet Operations

Parameters:

SheetNumber: The number of the sheet to remove.

Returns:

xreal GetSheetScale (xint SheetNumber, optional pfcModel_ptr DrawingModel)

Returns the scale of the drawing on particular sheet.

Manual References:: Drawings: Drawing Sheet Information, Drawings: Drawing Sheet Information

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.

void SetSheetScale (xint SheetNumber, xreal Scale, optional pfcModel_ptr DrawingModel)

Sets the scale for a model on the sheet.

Manual References:: Drawings: Drawing Sheet Operations, Drawings: Drawing Sheet Operations

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.

Returns:

optional pfcDrawingFormat_ptr GetSheetFormat (xint SheetNumber)

Returns the drawing format used for the particular sheet.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - Format for the sheet was not found.

Manual References:: Drawings: Drawing Sheet Information, Drawings: Drawing Sheet Information

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.

void SetSheetFormat (xint SheetNumber, pfcDrawingFormat_ptr Format, optional xint FormatSheetNumber, optional pfcModel_ptr DrawingModel)

Applies the specified format to a drawing sheet.

Manual References:: Drawings: Drawing Sheet Operations, Drawings: Drawing Sheet Operations

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.

Returns:

pfcView2D_ptr GetSheetBackgroundView (xint SheetNumber)

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.

Manual References:: Drawings: Drawing Sheet Information, Drawings: Drawing Sheet Information, Drawings: Obtaining Drawing Views, Drawings: Instructions

Parameters:

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

Returns:: The background view object.

pfcUnit_ptr GetSheetUnits (xint SheetNumber)

Returns the length units for the given sheet.

Manual References:: Drawings: Drawing Sheet Information, Drawings: Drawing Sheet Information

Parameters:

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

Returns:: The units.

pfcModelDescriptor_ptr GetSheetFormatDescr (xint SheetNumber)

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

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - Format for the sheet was not found.

Manual References:: Drawings: Drawing Sheet Information, Drawings: Drawing Sheet Information

Parameters:

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

Returns:: The model descriptor of the drawing format.