Interface DetailItemOwner
Description
This interface represents an object in Creo Parametric that contains detail items.
See Also:
Direct Known Subclasses:
User Guide References:
Listing Detail Items:DetailItemOwner, Creating a Detail Item:DetailItemOwner, Instructions:DetailItemOwner, Instructions:DetailItemOwner, Instructions:DetailItemOwner, Instructions:DetailItemOwner, Retrieving Symbol Definitions:DetailItemOwner
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 (DetailTextLines TextLines, Attachment NoteAttach, LeaderAttachments LeaderAttach, /*optional*/ Double ElbowLength) | |
Creates leader note in specifed 2D model. | |
Creates offset note in specifed 2D model. | |
Creates on item note in specifed 2D model. | |
/*optional*/ DetailItem | |
Finds a specified detail item, given the identifier and type. | |
/*optional*/ DetailItems | |
Lists the detail items in the model. | |
RetrieveSymbolDefinition (String FileName, /*optional*/ String FilePath, /*optional*/ Integer Version, /*optional*/ Boolean UpdateUnconditionally) | |
DEPRECATED: since Creo 4 SUCCESSOR(S): DetailItemOwner.RetrieveSymbolDefItem Retrieves a symbol definition from disk. | |
RetrieveSymbolDefItem (String FileName, DetailSymbolDefItemSource Source, /*optional*/ String FilePath, /*optional*/ Integer Version, /*optional*/ Boolean UpdateUnconditionally) | |
Method Detail
ListDetailItems | ||
/*optional*/ DetailItems | ListDetailItems |
Lists the detail items in the model.
Exceptions thrown (but not limited to):
XToolkitNotFound - 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.
XToolkitOutOfMemory - Found too many (either/all of) entities, items, groups, notes, symbol definitions, symbol instances to be contained in the output array. Use Visit instead.
User Guide References:
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.
GetDetailItem | ||
/*optional*/ DetailItem | GetDetailItem |
Finds a specified detail item, given the identifier and type.
Exceptions thrown (but not limited to):
XToolkitNotFound - This means either:
• No entities were found, OR
• No notes were found.
XToolkitOutOfMemory - 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.
CreateDetailItem | ||
CreateDetailItem |
Creates a new detail item in the model.
User Guide References:
Parameters:
Instructions
A data object describing the type and content of the new detail item.
Returns:
The newly created detail item.
CreateFreeNote | ||
CreateFreeNote |
Creates Free note in specifed 2D model.
Parameters:
TextLines
Text lines.
Attach
Free attachment.
Returns:
A note object.
CreateOffsetNote | ||
CreateOffsetNote |
Creates offset note in specifed 2D model.
Parameters:
TextLines
Text lines.
Attach
offset attachment.
Returns:
A note object.
CreateOnItemNote | ||
CreateOnItemNote |
Creates on item note in specifed 2D model.
Parameters:
TextLines
Text lines.
Attach
on item attachment.
Returns:
A note object.
CreateLeaderNote | ||
CreateLeaderNote | (DetailTextLines TextLines, Attachment NoteAttach, LeaderAttachments LeaderAttach, /*optional*/ Double ElbowLength) |
Creates leader note in specifed 2D model.
Exceptions thrown (but not limited to):
XToolkitOutOfMemory - Not enough memory.
Parameters:
TextLines
Text lines.
NoteAttach
Note text attachment.
LeaderAttach
Note leader attachment.
ElbowLength
Elbow Length of the note.
Returns:
RetrieveSymbolDefinition | ||
RetrieveSymbolDefinition | (String FileName, /*optional*/ String FilePath, /*optional*/ Integer Version, /*optional*/ Boolean UpdateUnconditionally) |
Retrieves a symbol definition from disk.
Exceptions thrown (but not limited to):
XToolkitNotFound - The specified symbol does not exist.
XToolkitFound - 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:
RetrieveSymbolDefItem | ||
RetrieveSymbolDefItem | (String FileName, DetailSymbolDefItemSource Source, /*optional*/ String FilePath, /*optional*/ Integer Version, /*optional*/ Boolean UpdateUnconditionally) |
Exceptions thrown (but not limited to):
XToolkitNotFound - The specified symbol does not exist.
XToolkitFound - The specified symbol exist but was not retrieved.
User Guide References:
Parameters:
FileName
Source
FilePath
Version
UpdateUnconditionally
Returns:
AllowReadonlyNoteSelection | ||
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.
Returns: