CIP C++ documentation for class "pfcDetailItemOwner"

Class pfcDetailItemOwner

# include <pfcDetail.h> class pfcDetailItemOwner : public virtual xobject { xaideclare(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 (xbool Allow)`
	Controls whether or not the Creo Parametric user can select read only detail notes.

`pfcDetailItem_ptr`	`CreateDetailItem (pfcDetailCreateInstructions_ptr Instructions)`
	Creates a new detail item in the model.

`pfcDetailNoteItem_ptr`	`CreateFreeNote (pfcDetailTextLines_ptr TextLines, pfcFreeAttachment_ptr Attach)`
	Creates Free note in specifed 2D model.

`pfcDetailNoteItem_ptr`	`CreateLeaderNote (pfcDetailTextLines_ptr TextLines, pfcAttachment_ptr NoteAttach, pfcLeaderAttachments_ptr LeaderAttach, optional xreal ElbowLength)`
	Creates leader note in specifed 2D model.

`pfcDetailNoteItem_ptr`	`CreateOffsetNote (pfcDetailTextLines_ptr TextLines, pfcOffsetAttachment_ptr Attach)`
	Creates offset note in specifed 2D model.

`pfcDetailNoteItem_ptr`	`CreateOnItemNote (pfcDetailTextLines_ptr TextLines, pfcParametricAttachment_ptr Attach)`
	Creates on item note in specifed 2D model.

`optional pfcDetailItem_ptr`	`GetDetailItem (pfcDetailType Type, xint Id)`
	Finds a specified detail item, given the identifier and type.

`optional pfcDetailItems_ptr`	`ListDetailItems (optional pfcDetailType Type, optional xint SheetNumber)`
	Lists the detail items in the model.

`pfcDetailSymbolDefItem_ptr`	`RetrieveSymbolDefinition (xrstring FileName, optional xrstring FilePath, optional xint Version, optional xbool UpdateUnconditionally)`
	`DEPRECATED: since Creo 4` `SUCCESSOR(S): pfcDetailItemOwner::RetrieveSymbolDefItem` Retrieves a symbol definition from disk.

`pfcDetailSymbolDefItem_ptr`	`RetrieveSymbolDefItem (xrstring FileName, pfcDetailSymbolDefItemSource Source, optional xrstring FilePath, optional xint Version, optional xbool UpdateUnconditionally)`

Method Detail

optional pfcDetailItems_ptr ListDetailItems (optional pfcDetailType Type, optional xint 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.

Manual References:: Drawings: Listing Detail Items, Drawings: Listing Detail Items

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.

optional pfcDetailItem_ptr GetDetailItem (pfcDetailType Type, xint 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.

pfcDetailItem_ptr CreateDetailItem (pfcDetailCreateInstructions_ptr Instructions)

Creates a new detail item in the model.

Manual References:: Drawings: Listing Detail Items, Drawings: Creating, Modifying and Reading Detail Items, Drawings: Creating, Modifying and Reading Detail Items, Drawings: Instructions, Drawings: Instructions, Drawings: Instructions

Parameters:

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

Returns:: The newly created detail item.

pfcDetailNoteItem_ptr CreateFreeNote (pfcDetailTextLines_ptr TextLines, pfcFreeAttachment_ptr Attach)

Creates Free note in specifed 2D model.

Manual References:: Drawings: Instructions

Parameters:

TextLines: Text lines.
Attach: Free attachment.

Returns:: A note object.

pfcDetailNoteItem_ptr CreateOffsetNote (pfcDetailTextLines_ptr TextLines, pfcOffsetAttachment_ptr Attach)

Creates offset note in specifed 2D model.

Manual References:: Drawings: Instructions

Parameters:

TextLines: Text lines.
Attach: offset attachment.

Returns:: A note object.

pfcDetailNoteItem_ptr CreateOnItemNote (pfcDetailTextLines_ptr TextLines, pfcParametricAttachment_ptr Attach)

Creates on item note in specifed 2D model.

Manual References:: Drawings: Instructions

Parameters:

TextLines: Text lines.
Attach: on item attachment.

Returns:: A note object.

pfcDetailNoteItem_ptr CreateLeaderNote (pfcDetailTextLines_ptr TextLines, pfcAttachment_ptr NoteAttach, pfcLeaderAttachments_ptr LeaderAttach, optional xreal ElbowLength)

Creates leader note in specifed 2D model.

Exceptions thrown (but not limited to):

pfcXToolkitOutOfMemory - Not enough memory.

Manual References:: Drawings: Instructions

Parameters:

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

Returns:

pfcDetailSymbolDefItem_ptr RetrieveSymbolDefinition (xrstring FileName, optional xrstring FilePath, optional xint Version, optional xbool UpdateUnconditionally)

DEPRECATED: since Creo 4
SUCCESSOR(S): pfcDetailItemOwner::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.

Manual References:: Drawings: Detail Symbol Definitions

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_ptr RetrieveSymbolDefItem (xrstring FileName, pfcDetailSymbolDefItemSource Source, optional xrstring FilePath, optional xint Version, optional xbool UpdateUnconditionally)

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The specified symbol does not exist.

pfcXToolkitFound - The specified symbol exist but was not retrieved.

Manual References:: Drawings: Detail Symbol Definitions

Parameters:

FileName
Source
FilePath
Version
UpdateUnconditionally

Returns:

void AllowReadonlyNoteSelection (xbool 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.

Returns: