CIP JavaScript documentation for class " pfcDetailItemOwner"

Class pfcDetailItemOwner

Description

This interface represents an object in Creo Parametric that contains detail items.

See Also:: pfcModel2D

Direct Known Subclasses:: pfcModel2D

Method Summary


`void`	`AllowReadonlyNoteSelection (boolean Allow)`
	Controls whether or not the Creo Parametric user can select read only detail notes.

`pfcDetailItem`	`CreateDetailItem (pfcDetailCreateInstructions Instructions)`
	Creates a new detail item in the model.

`pfcDetailNoteItem`	`CreateFreeNote (pfcDetailTextLines TextLines, pfcFreeAttachment Attach)`
	Creates Free note in specifed 2D model.

`pfcDetailNoteItem`	`CreateLeaderNote (pfcDetailTextLines TextLines, pfcAttachment NoteAttach, pfcLeaderAttachments LeaderAttach, /* optional */ number ElbowLength)`
	Creates leader note in specifed 2D model.

`pfcDetailNoteItem`	`CreateOffsetNote (pfcDetailTextLines TextLines, pfcOffsetAttachment Attach)`
	Creates offset note in specifed 2D model.

`pfcDetailNoteItem`	`CreateOnItemNote (pfcDetailTextLines TextLines, pfcParametricAttachment Attach)`
	Creates on item note in specifed 2D model.

`/* optional */ pfcDetailItem`	`GetDetailItem (pfcDetailType Type, number Id)`
	Finds a specified detail item, given the identifier and type.

`/* optional */ pfcDetailItems`	`ListDetailItems ( /* optional / pfcDetailType Type, / optional */ number SheetNumber)`
	Lists the detail items in the model.

`pfcDetailSymbolDefItem`	`RetrieveSymbolDefinition (string FileName, /* optional / string FilePath, / optional / number Version, / optional */ boolean UpdateUnconditionally)`

`DEPRECATED: since Creo 4`
`SUCCESSOR(S): DetailItemOwner.RetrieveSymbolDefItem`
Retrieves a symbol definition from disk.

`pfcDetailSymbolDefItem`	`RetrieveSymbolDefItem (string FileName, pfcDetailSymbolDefItemSource Source, /* optional / string FilePath, / optional / number Version, / optional */ boolean UpdateUnconditionally)`

Method Detail

void AllowReadonlyNoteSelection (boolean Allow)

Controls whether or not the Creo Parametric user can select read only detail notes.

Parameters:

Allow: true to allow selection of readonly detail notes, false to disallow it.

pfcDetailItem CreateDetailItem (pfcDetailCreateInstructions Instructions)

Creates a new detail item in the model.

Parameters:

Instructions: A data object describing the type and content of the new detail item.

Returns:: The newly created detail item.

pfcDetailNoteItem CreateFreeNote (pfcDetailTextLines TextLines, pfcFreeAttachment Attach)

Creates Free note in specifed 2D model.

Parameters:

TextLines: Text lines.
Attach: Free attachment.

Returns:: A note object.

pfcDetailNoteItem CreateLeaderNote (pfcDetailTextLines TextLines, pfcAttachment NoteAttach, pfcLeaderAttachments LeaderAttach, /* optional */ number ElbowLength)

Creates leader note in specifed 2D model.

Exceptions thrown (but not limited to):

pfcXToolkitOutOfMemory - Not enough memory.

Parameters:

TextLines: Text lines.
NoteAttach: Note text attachment.
LeaderAttach: Note leader attachment.
ElbowLength: Elbow Length of the note.

Returns:

pfcDetailNoteItem CreateOffsetNote (pfcDetailTextLines TextLines, pfcOffsetAttachment Attach)

Creates offset note in specifed 2D model.

Parameters:

TextLines: Text lines.
Attach: offset attachment.

Returns:: A note object.

pfcDetailNoteItem CreateOnItemNote (pfcDetailTextLines TextLines, pfcParametricAttachment Attach)

Creates on item note in specifed 2D model.

Parameters:

TextLines: Text lines.
Attach: on item attachment.

Returns:: A note object.

/* optional */ pfcDetailItem GetDetailItem (pfcDetailType Type, number Id)

Finds a specified detail item, given the identifier and type.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - This means either:

No entities were found, OR
No notes were found.

pfcXToolkitOutOfMemory - Found too many (either/all of) entities, notes to be contained in the output array. Use Visit instead.

Parameters:

Type: The detail item type.
Id: The Creo Parametric integer identifier.

Returns:: The detail item, or null if the item was not found.

/* optional */ pfcDetailItems ListDetailItems ( /* optional */ pfcDetailType Type, /* optional */ number SheetNumber)

Lists the detail items in the model.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - This means either:

No items were found, OR
No entities were found, OR
No groups were found, OR
No notes were found, OR
No symbol definitions were found, OR
No symbol instances were found.

pfcXToolkitOutOfMemory - Found too many (either/all of) entities, items, groups, notes, symbol definitions, symbol instances to be contained in the output array. Use Visit instead.

Parameters:

Type: The detail item type to search for, or null to return all detail items.
SheetNumber: The sheet number to search, or null to search all sheets. This argument is ignored if type is DETAIL_SYM_DEFINITION.

Returns:: Sequence of detail items, or null if no items matching the input values were found.

pfcDetailSymbolDefItem RetrieveSymbolDefinition (string FileName, /* optional */ string FilePath, /* optional */ number Version, /* optional */ boolean UpdateUnconditionally)


`DEPRECATED: since Creo 4`
`SUCCESSOR(S): DetailItemOwner.RetrieveSymbolDefItem`
Retrieves a symbol definition from disk. Exceptions thrown (but not limited to): `pfcXToolkitNotFound` - The specified symbol does not exist. `pfcXToolkitFound` - The specified symbol exist but was not retrieved. Parameters: `FileName` The name of the symbol definition file. `FilePath` The path to the symbol definition file, relative to the configuration option pro_symbol_dir. `null` indicates that the function should search the system symbol definition directory instead. `Version` The numerical version of the symbol definition file, or `null` to retrieve the latest version. `UpdateUnconditionally` `true` if Creo Parametric should update existing instances of this symbol definition, `false` if the operation should fail if the definition already exists in the model. Returns:

pfcDetailSymbolDefItem RetrieveSymbolDefItem (string FileName, pfcDetailSymbolDefItemSource Source, /* optional */ string FilePath, /* optional */ number Version, /* optional */ boolean UpdateUnconditionally)

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The specified symbol does not exist.

pfcXToolkitFound - The specified symbol exist but was not retrieved.

Parameters:

FileName
Source
FilePath
Version
UpdateUnconditionally

Returns: