CIP C++ documentation for class "pfcDetailText"

Class pfcDetailText

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

Description

This interface represents a text entry in a detail note.

Method Summary


`static pfcDetailText_ptr`	`Create (xrstring inText)`
	Creates a data object containing a text item in a note.

`optional xstring`	`GetFontName ()`
`void`	`SetFontName (optional xrstring value)`
	`DEPRECATED: since Creo 4` `SUCCESSOR(S): pfcDetailText::SetTextStyle, pfcAnnotationTextStyle::SetFont` The name of the text font. If `null`, the default Creo Parametric font is used.

`optional xbool`	`GetIsUnderlined ()`
`void`	`SetIsUnderlined (optional xbool value)`
	`DEPRECATED: since Creo 4` `SUCCESSOR(S): pfcDetailText::SetTextStyle, pfcAnnotationTextStyle::UnderlineText` Whether or not the text is underlined. If `null`, the text is not underlined.

`xstring`	`GetText ()`
`void`	`SetText (xrstring value)`
	The text string.

`optional xreal`	`GetTextHeight ()`
`void`	`SetTextHeight (optional xreal value)`
	`DEPRECATED: since Creo 4` `SUCCESSOR(S): pfcDetailText::SetTextStyle, pfcAnnotationTextStyle::SetHeight` The text height. If `null`, the default note text height is used.

`optional xreal`	`GetTextSlantAngle ()`
`void`	`SetTextSlantAngle (optional xreal value)`
	`DEPRECATED: since Creo 4` `SUCCESSOR(S): pfcDetailText::SetTextStyle, pfcAnnotationTextStyle::SetSlantAngle` The text slant angle. If `null`, no slant angle is applied.

`optional pfcAnnotationTextStyle_ptr`	`GetTextStyle ()`


`optional xreal`	`GetTextThickness ()`
`void`	`SetTextThickness (optional xreal value)`
	`DEPRECATED: since Creo 4` `SUCCESSOR(S): pfcDetailText::SetTextStyle, pfcAnnotationTextStyle::SetThickness` The text thickness. If `null`, a thickness of 0.0 is applied.

`optional xreal`	`GetTextWidthFactor ()`
`void`	`SetTextWidthFactor (optional xreal value)`
	`DEPRECATED: since Creo 4` `SUCCESSOR(S): pfcDetailText::SetTextStyle, pfcAnnotationTextStyle::SetWidth` The text width factor. If `null`, the width factor of 1.0 is applied.

	`DEPRECATED: since Creo 4` `SUCCESSOR(S): pfcDetailText::SetTextStyle, pfcAnnotationTextStyle::SetFont`

	`DEPRECATED: since Creo 4` `SUCCESSOR(S): pfcDetailText::SetTextStyle, pfcAnnotationTextStyle::UnderlineText`



	`DEPRECATED: since Creo 4` `SUCCESSOR(S): pfcDetailText::SetTextStyle, pfcAnnotationTextStyle::SetHeight`

	`DEPRECATED: since Creo 4` `SUCCESSOR(S): pfcDetailText::SetTextStyle, pfcAnnotationTextStyle::SetSlantAngle`

`void`	`SetTextStyle (pfcAnnotationTextStyle_ptr TextStyle)`


	`DEPRECATED: since Creo 4` `SUCCESSOR(S): pfcDetailText::SetTextStyle, pfcAnnotationTextStyle::SetThickness`

	`DEPRECATED: since Creo 4` `SUCCESSOR(S): pfcDetailText::SetTextStyle, pfcAnnotationTextStyle::SetWidth`

Method Detail

`optional xreal`	`GetTextHeight`	`()`
`void`	`SetTextHeight`	`(optional xreal value)`

DEPRECATED: since Creo 4
SUCCESSOR(S): pfcDetailText::SetTextStyle, pfcAnnotationTextStyle::SetHeight

The text height. If null, the default note text height is used.

`optional xreal`	`GetTextWidthFactor`	`()`
`void`	`SetTextWidthFactor`	`(optional xreal value)`

DEPRECATED: since Creo 4
SUCCESSOR(S): pfcDetailText::SetTextStyle, pfcAnnotationTextStyle::SetWidth

The text width factor. If null, the width factor of 1.0 is applied.

`optional xreal`	`GetTextSlantAngle`	`()`
`void`	`SetTextSlantAngle`	`(optional xreal value)`

DEPRECATED: since Creo 4
SUCCESSOR(S): pfcDetailText::SetTextStyle, pfcAnnotationTextStyle::SetSlantAngle

The text slant angle. If null, no slant angle is applied.

`optional xreal`	`GetTextThickness`	`()`
`void`	`SetTextThickness`	`(optional xreal value)`

DEPRECATED: since Creo 4
SUCCESSOR(S): pfcDetailText::SetTextStyle, pfcAnnotationTextStyle::SetThickness

The text thickness. If null, a thickness of 0.0 is applied.

`optional xstring`	`GetFontName`	`()`
`void`	`SetFontName`	`(optional xrstring value)`

DEPRECATED: since Creo 4
SUCCESSOR(S): pfcDetailText::SetTextStyle, pfcAnnotationTextStyle::SetFont

The name of the text font. If null, the default Creo Parametric font is used.

`optional xbool`	`GetIsUnderlined`	`()`
`void`	`SetIsUnderlined`	`(optional xbool value)`

DEPRECATED: since Creo 4
SUCCESSOR(S): pfcDetailText::SetTextStyle, pfcAnnotationTextStyle::UnderlineText

Whether or not the text is underlined. If null, the text is not underlined.

`xstring`	`GetText`	`()`
`void`	`SetText`	`(xrstring value)`

The text string.

optional pfcAnnotationTextStyle_ptr GetTextStyle ()

Returns:

void SetTextStyle (pfcAnnotationTextStyle_ptr TextStyle)

Parameters:

TextStyle

Returns:

static pfcDetailText_ptr Create (xrstring inText)

Creates a data object containing a text item in a note.

Parameters:

inText: The text string.

Returns:: The created data object.