CIP JavaScript documentation for class " pfcDetailText"

Class pfcDetailText

Description

This interface represents a text entry in a detail note.

Property Summary


`/* optional */ string`	`FontName`

`DEPRECATED: since Creo 4`
`SUCCESSOR(S): DetailText.SetTextStyle, AnnotationTextStyle.SetFont`
The name of the text font. If `null`, the default Creo Parametric font is used.

`/* optional */ boolean`	`IsUnderlined`

`DEPRECATED: since Creo 4`
`SUCCESSOR(S): DetailText.SetTextStyle, AnnotationTextStyle.UnderlineText`
Whether or not the text is underlined. If `null`, the text is not underlined.

`string`	`Text`
	The text string.

`/* optional */ number`	`TextHeight`

`DEPRECATED: since Creo 4`
`SUCCESSOR(S): DetailText.SetTextStyle, AnnotationTextStyle.SetHeight`
The text height. If `null`, the default note text height is used.

`/* optional */ number`	`TextSlantAngle`

`DEPRECATED: since Creo 4`
`SUCCESSOR(S): DetailText.SetTextStyle, AnnotationTextStyle.SetSlantAngle`
The text slant angle. If `null`, no slant angle is applied.

`/* optional */ number`	`TextThickness`

`DEPRECATED: since Creo 4`
`SUCCESSOR(S): DetailText.SetTextStyle, AnnotationTextStyle.SetThickness`
The text thickness. If `null`, a thickness of 0.0 is applied.

`/* optional */ number`	`TextWidthFactor`

`DEPRECATED: since Creo 4`
`SUCCESSOR(S): DetailText.SetTextStyle, AnnotationTextStyle.SetWidth`
The text width factor. If `null`, the width factor of 1.0 is applied.

Method Summary


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

`/* optional */ pfcAnnotationTextStyle`	`GetTextStyle ()`


`void`	`SetTextStyle (pfcAnnotationTextStyle TextStyle)`

Property Detail

/* optional */ string FontName


`DEPRECATED: since Creo 4`
`SUCCESSOR(S): DetailText.SetTextStyle, AnnotationTextStyle.SetFont`
The name of the text font. If `null`, the default Creo Parametric font is used.

/* optional */ boolean IsUnderlined


`DEPRECATED: since Creo 4`
`SUCCESSOR(S): DetailText.SetTextStyle, AnnotationTextStyle.UnderlineText`
Whether or not the text is underlined. If `null`, the text is not underlined.

string Text

The text string.

/* optional */ number TextHeight


`DEPRECATED: since Creo 4`
`SUCCESSOR(S): DetailText.SetTextStyle, AnnotationTextStyle.SetHeight`
The text height. If `null`, the default note text height is used.

/* optional */ number TextSlantAngle


`DEPRECATED: since Creo 4`
`SUCCESSOR(S): DetailText.SetTextStyle, AnnotationTextStyle.SetSlantAngle`
The text slant angle. If `null`, no slant angle is applied.

/* optional */ number TextThickness


`DEPRECATED: since Creo 4`
`SUCCESSOR(S): DetailText.SetTextStyle, AnnotationTextStyle.SetThickness`
The text thickness. If `null`, a thickness of 0.0 is applied.

/* optional */ number TextWidthFactor


`DEPRECATED: since Creo 4`
`SUCCESSOR(S): DetailText.SetTextStyle, AnnotationTextStyle.SetWidth`
The text width factor. If `null`, the width factor of 1.0 is applied.

Method Detail

static pfcDetailText Create (string inText)

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

Parameters:

/* optional */ pfcAnnotationTextStyle GetTextStyle ()

void SetTextStyle (pfcAnnotationTextStyle TextStyle)

Parameters: