CIP C++ documentation for class "pfcTextReference"

Class pfcTextReference

# include <pfcDetail.h> class pfcTextReference : public virtual xobject { xdeclare(pfcTextReference) ... }; This is a COMPACT class.

Description

This interface identifies the text item used for a symbol definition which as a height type of SYMDEF_TEXT_RELATED.

See Also:: pfcSymbolDefHeight, pfcDetailSymbolDefInstructions, pfcDetailSymbolDefItem::ListDetailItems(optional pfcDetailType), pfcDetailSymbolDefItem::GetDetailItem(pfcDetailType, xint), pfcDetailSymbolDefItem::CreateDetailItem(pfcDetailCreateInstructions_ptr)

Method Summary


`static pfcTextReference_ptr`	`Create (pfcDetailNoteItem_ptr inTextRefNote, xint inTextLineNumber, xint inTextIndexNumber)`
	Creates a data object that identifies the text item used for a symbol definition which as a height type of SYMDEF_TEXT_RELATED.

`xint`	`GetTextIndexNumber ()`
`void`	`SetTextIndexNumber (xint value)`
	The index of the text, on this line.

`xint`	`GetTextLineNumber ()`
`void`	`SetTextLineNumber (xint value)`
	The line number of the note.

`pfcDetailNoteItem_ptr`	`GetTextRefNote ()`
`void`	`SetTextRefNote (pfcDetailNoteItem_ptr value)`
	The note item containing the text.

Method Detail

`pfcDetailNoteItem_ptr`	`GetTextRefNote`	`()`
`void`	`SetTextRefNote`	`(pfcDetailNoteItem_ptr value)`

The note item containing the text.

`xint`	`GetTextLineNumber`	`()`
`void`	`SetTextLineNumber`	`(xint value)`

The line number of the note.

`xint`	`GetTextIndexNumber`	`()`
`void`	`SetTextIndexNumber`	`(xint value)`

The index of the text, on this line.

static pfcTextReference_ptr Create (pfcDetailNoteItem_ptr inTextRefNote, xint inTextLineNumber, xint inTextIndexNumber)

Creates a data object that identifies the text item used for a symbol definition which as a height type of SYMDEF_TEXT_RELATED.

See Also:: pfcSymbolDefHeight, pfcDetailSymbolDefInstructions, pfcDetailSymbolDefItem::ListDetailItems(optional pfcDetailType), pfcDetailSymbolDefItem::GetDetailItem(pfcDetailType, xint), pfcDetailSymbolDefItem::CreateDetailItem(pfcDetailCreateInstructions_ptr)

Parameters: