CIP Visual Basic.NET documentation for interface "IpfcDetailItemOwner"

Interface IpfcDetailItemOwner

Description

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

See Also:: IpfcModel2D

Direct Known Subclasses:: IpfcModel2D

Method Summary


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

`Function`	`CreateDetailItem (Instructions as IpfcDetailCreateInstructions) as IpfcDetailItem`
	Creates a new detail item in the model.

`Function`	`CreateFreeNote (TextLines as IpfcDetailTextLines, Attach as IpfcFreeAttachment) as IpfcDetailNoteItem`
	Creates Free note in specifed 2D model.

`Function`	`CreateLeaderNote (TextLines as IpfcDetailTextLines, NoteAttach as IpfcAttachment, LeaderAttach as IpfcLeaderAttachments, ElbowLength as Double [optional]) as IpfcDetailNoteItem`
	Creates leader note in specifed 2D model.

`Function`	`CreateOffsetNote (TextLines as IpfcDetailTextLines, Attach as IpfcOffsetAttachment) as IpfcDetailNoteItem`
	Creates offset note in specifed 2D model.

`Function`	`CreateOnItemNote (TextLines as IpfcDetailTextLines, Attach as IpfcParametricAttachment) as IpfcDetailNoteItem`
	Creates on item note in specifed 2D model.

`Function`	`GetDetailItem (Type as IpfcDetailType, Id as Long) as IpfcDetailItem [optional]`
	Finds a specified detail item, given the identifier and type.

`Function`	`ListDetailItems (Type as IpfcDetailType [optional], SheetNumber as Long [optional]) as IpfcDetailItems [optional]`
	Lists the detail items in the model.

`Function`	`RetrieveSymbolDefinition (FileName as String, FilePath as String [optional], Version as Long [optional], UpdateUnconditionally as Boolean [optional]) as IpfcDetailSymbolDefItem`

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

`Function`	`RetrieveSymbolDefItem (FileName as String, Source as IpfcDetailSymbolDefItemSource, FilePath as String [optional], Version as Long [optional], UpdateUnconditionally as Boolean [optional]) as IpfcDetailSymbolDefItem`

Method Detail

Sub AllowReadonlyNoteSelection (Allow as Boolean)

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.

Function CreateDetailItem (Instructions as IpfcDetailCreateInstructions) as IpfcDetailItem

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.

Function CreateFreeNote (TextLines as IpfcDetailTextLines, Attach as IpfcFreeAttachment) as IpfcDetailNoteItem

Creates Free note in specifed 2D model.

Parameters:

TextLines: Text lines.
Attach: Free attachment.

Returns:: A note object.

Function CreateLeaderNote (TextLines as IpfcDetailTextLines, NoteAttach as IpfcAttachment, LeaderAttach as IpfcLeaderAttachments, ElbowLength as Double [optional]) as IpfcDetailNoteItem

Creates leader note in specifed 2D model.

Exceptions thrown (but not limited to):

IpfcXToolkitOutOfMemory - Not enough memory.

Parameters:

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

Returns:

Function CreateOffsetNote (TextLines as IpfcDetailTextLines, Attach as IpfcOffsetAttachment) as IpfcDetailNoteItem

Creates offset note in specifed 2D model.

Parameters:

TextLines: Text lines.
Attach: offset attachment.

Returns:: A note object.

Function CreateOnItemNote (TextLines as IpfcDetailTextLines, Attach as IpfcParametricAttachment) as IpfcDetailNoteItem

Creates on item note in specifed 2D model.

Parameters:

TextLines: Text lines.
Attach: on item attachment.

Returns:: A note object.

Function GetDetailItem (Type as IpfcDetailType, Id as Long) as IpfcDetailItem [optional]

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

Exceptions thrown (but not limited to):

IpfcXToolkitNotFound - This means either:

No entities were found, OR
No notes were found.

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

Function ListDetailItems (Type as IpfcDetailType [optional], SheetNumber as Long [optional]) as IpfcDetailItems [optional]

Lists the detail items in the model.

Exceptions thrown (but not limited to):

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

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

Function RetrieveSymbolDefinition (FileName as String, FilePath as String [optional], Version as Long [optional], UpdateUnconditionally as Boolean [optional]) as IpfcDetailSymbolDefItem

DEPRECATED: since Creo 4

SUCCESSOR(S): DetailItemOwner.RetrieveSymbolDefItem

Retrieves a symbol definition from disk.

Exceptions thrown (but not limited to):

IpfcXToolkitNotFound - The specified symbol does not exist.

IpfcXToolkitFound - 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:

Function RetrieveSymbolDefItem (FileName as String, Source as IpfcDetailSymbolDefItemSource, FilePath as String [optional], Version as Long [optional], UpdateUnconditionally as Boolean [optional]) as IpfcDetailSymbolDefItem

Exceptions thrown (but not limited to):

IpfcXToolkitNotFound - The specified symbol does not exist.

IpfcXToolkitFound - The specified symbol exist but was not retrieved.

Parameters:

FileName
Source
FilePath
Version
UpdateUnconditionally

Returns: