Class pfcDetailItemOwner
Description
This interface represents an object in Creo Parametric that contains detail items.
See Also:
Direct Known Subclasses:
User Guide References:
Creating a Detail Item:pfcDetailItemOwner, Instructions:pfcDetailItemOwner, Instructions:pfcDetailItemOwner, Instructions:pfcDetailItemOwner, Instructions:pfcDetailItemOwner, Listing Detail Items:pfcDetailItemOwner, Retrieving Symbol Definitions:pfcDetailItemOwner
Method Summary
void | AllowReadonlyNoteSelection (boolean Allow) |
Controls whether or not the Creo Parametric user can select read only detail notes. | |
Creates a new detail item in the model. | |
Creates Free note in specifed 2D model. | |
CreateLeaderNote (pfcDetailTextLines TextLines, pfcAttachment NoteAttach, pfcLeaderAttachments LeaderAttach, /* optional */ number ElbowLength) | |
Creates leader note in specifed 2D model. | |
Creates offset note in specifed 2D model. | |
Creates on item note in specifed 2D model. | |
/* optional */ pfcDetailItem | |
Finds a specified detail item, given the identifier and type. | |
/* optional */ pfcDetailItems | |
Lists the detail items in the model. | |
RetrieveSymbolDefinition (string FileName, /* optional */ string FilePath, /* optional */ number Version, /* optional */ boolean UpdateUnconditionally) | |
DEPRECATED: since Creo 4 | |
SUCCESSOR(S): DetailItemOwner.RetrieveSymbolDefItem | |
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.
CreateDetailItem |
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.
User Guide References:
CreateFreeNote |
Creates Free note in specifed 2D model.
Parameters:
TextLines
Text lines.
Attach
Free attachment.
Returns:
A note object.
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:
CreateOffsetNote |
Creates offset note in specifed 2D model.
Parameters:
TextLines
Text lines.
Attach
offset attachment.
Returns:
A note object.
CreateOnItemNote |
Creates on item note in specifed 2D model.
Parameters:
TextLines
Text lines.
Attach
on item attachment.
Returns:
A note object.
/* optional */ pfcDetailItem | GetDetailItem |
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 |
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.
User Guide References:
RetrieveSymbolDefinition | (string FileName, /* optional */ string FilePath, /* optional */ number Version, /* optional */ boolean UpdateUnconditionally) |
DEPRECATED: since Creo 4
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:
User Guide References: