CIP JavaScript documentation for class " pfcSheetOwner"

Class pfcSheetOwner

Description

This interface represents a model containing sheets.

Direct Known Subclasses:: pfcModel2D

Property Summary


`number`	`CurrentSheetNumber`
	The current sheet number.

`/* readonly */ number`	`NumberOfSheets`
	The number of sheets in the model.

Method Summary


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

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

`pfcView2D`	`GetSheetBackgroundView (number SheetNumber)`
	Returns the background view for the given sheet.

`/* optional */ pfcSheetData`	`GetSheetData (number SheetNumber)`
	Returns information about the specified sheet.

`/* optional */ pfcDrawingFormat`	`GetSheetFormat (number SheetNumber)`
	Returns the drawing format used for the particular sheet.

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

`/* optional */ pfcSheetInfo`	`GetSheetInfo (number SheetNumber)`
	Returns information about the specified sheet.

`number`	`GetSheetScale (number SheetNumber, /* optional */ pfcModel DrawingModel)`
	Returns the scale of the drawing on particular sheet.

`pfcTransform3D`	`GetSheetTransform (number SheetNumber)`
	Returns the transformation matrix for the sheet.

`pfcUnit`	`GetSheetUnits (number SheetNumber)`
	Returns the length units for the given sheet.

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

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

`void`	`SetSheetFormat (number SheetNumber, pfcDrawingFormat Format, /* optional / number FormatSheetNumber, / optional */ pfcModel DrawingModel)`
	Applies the specified format to a drawing sheet.

`void`	`SetSheetScale (number SheetNumber, number Scale, /* optional */ pfcModel DrawingModel)`
	Sets the scale for a model on the sheet.

Property Detail

number CurrentSheetNumber

The current sheet number.

/* readonly */ number NumberOfSheets

The number of sheets in the model.

Method Detail

number 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.

Returns:: The number of the new sheet added.

void DeleteSheet (number 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).

Parameters:

SheetNumber: The number of the sheet to remove.

pfcView2D GetSheetBackgroundView (number 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.

Parameters:

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

Returns:: The background view object.

/* optional */ pfcSheetData GetSheetData (number SheetNumber)

Returns information about the specified sheet.

This method is deprecated. Use pfcSheetOwner.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.

/* optional */ pfcDrawingFormat GetSheetFormat (number SheetNumber)

Returns the drawing format used for the particular sheet.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - 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.

pfcModelDescriptor GetSheetFormatDescr (number 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.

Parameters:

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

Returns:: The model descriptor of the drawing format.

/* optional */ pfcSheetInfo GetSheetInfo (number SheetNumber)

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.

number GetSheetScale (number SheetNumber, /* optional */ pfcModel DrawingModel)

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.

pfcTransform3D GetSheetTransform (number SheetNumber)

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.

pfcUnit GetSheetUnits (number SheetNumber)

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.

void RegenerateSheet (number SheetNumber)

Regenerates a specified sheet.

The sheet must be displayed.

Parameters:

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

void ReorderSheet (number FromSheetNumber, number To)

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.

void SetSheetFormat (number SheetNumber, pfcDrawingFormat Format, /* optional */ number FormatSheetNumber, /* optional */ pfcModel DrawingModel)

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.

void SetSheetScale (number SheetNumber, number Scale, /* optional */ pfcModel DrawingModel)

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.