CIP JAVA documentation for class "com.ptc.pfc.pfcDetail.DetailText"

Interface DetailText

package com.ptc.pfc.pfcDetail; public interface DetailText extends jxobject

Description

This interface represents a text entry in a detail note.

Method Summary
`/optional/ String`	`GetFontName ()` `DEPRECATED: since Creo 4` `SUCCESSOR(S): DetailText.SetTextStyle, AnnotationTextStyle.SetFont` Get method for attribute "FontName" The name of the text font. If `null`, the default Creo Parametric font is used.
`/optional/ Boolean`	`GetIsUnderlined ()` `DEPRECATED: since Creo 4` `SUCCESSOR(S): DetailText.SetTextStyle, AnnotationTextStyle.UnderlineText` Get method for attribute "IsUnderlined" Whether or not the text is underlined. If `null`, the text is not underlined.
`String`	`GetText ()` Get method for attribute "Text" The text string.
`/optional/ Double`	`GetTextHeight ()` `DEPRECATED: since Creo 4` `SUCCESSOR(S): DetailText.SetTextStyle, AnnotationTextStyle.SetHeight` Get method for attribute "TextHeight" The text height. If `null`, the default note text height is used.
`/optional/ Double`	`GetTextSlantAngle ()` `DEPRECATED: since Creo 4` `SUCCESSOR(S): DetailText.SetTextStyle, AnnotationTextStyle.SetSlantAngle` Get method for attribute "TextSlantAngle" The text slant angle. If `null`, no slant angle is applied.
`/optional/ AnnotationTextStyle`	`GetTextStyle ()`
`/optional/ Double`	`GetTextThickness ()` `DEPRECATED: since Creo 4` `SUCCESSOR(S): DetailText.SetTextStyle, AnnotationTextStyle.SetThickness` Get method for attribute "TextThickness" The text thickness. If `null`, a thickness of 0.0 is applied.
`/optional/ Double`	`GetTextWidthFactor ()` `DEPRECATED: since Creo 4` `SUCCESSOR(S): DetailText.SetTextStyle, AnnotationTextStyle.SetWidth` Get method for attribute "TextWidthFactor" The text width factor. If `null`, the width factor of 1.0 is applied.
`void`	`SetFontName ( /optional/ String value)` `DEPRECATED: since Creo 4` `SUCCESSOR(S): DetailText.SetTextStyle, AnnotationTextStyle.SetFont` Set method for attribute "FontName" The name of the text font. If `null`, the default Creo Parametric font is used.
`void`	`SetIsUnderlined ( /optional/ Boolean value)` `DEPRECATED: since Creo 4` `SUCCESSOR(S): DetailText.SetTextStyle, AnnotationTextStyle.UnderlineText` Set method for attribute "IsUnderlined" Whether or not the text is underlined. If `null`, the text is not underlined.
`void`	`SetText (String value)` Set method for attribute "Text" The text string.
`void`	`SetTextHeight ( /optional/ Double value)` `DEPRECATED: since Creo 4` `SUCCESSOR(S): DetailText.SetTextStyle, AnnotationTextStyle.SetHeight` Set method for attribute "TextHeight" The text height. If `null`, the default note text height is used.
`void`	`SetTextSlantAngle ( /optional/ Double value)` `DEPRECATED: since Creo 4` `SUCCESSOR(S): DetailText.SetTextStyle, AnnotationTextStyle.SetSlantAngle` Set method for attribute "TextSlantAngle" The text slant angle. If `null`, no slant angle is applied.
`void`	`SetTextStyle (AnnotationTextStyle TextStyle)`
`void`	`SetTextThickness ( /optional/ Double value)` `DEPRECATED: since Creo 4` `SUCCESSOR(S): DetailText.SetTextStyle, AnnotationTextStyle.SetThickness` Set method for attribute "TextThickness" The text thickness. If `null`, a thickness of 0.0 is applied.
`void`	`SetTextWidthFactor ( /optional/ Double value)` `DEPRECATED: since Creo 4` `SUCCESSOR(S): DetailText.SetTextStyle, AnnotationTextStyle.SetWidth` Set method for attribute "TextWidthFactor" The text width factor. If `null`, the width factor of 1.0 is applied.

Method Detail

GetTextHeight/SetTextHeight

`/optional/ Double`	`GetTextHeight`	`()`
`void`	`SetTextHeight`	`( /optional/ Double value)`

DEPRECATED: since Creo 4
SUCCESSOR(S): DetailText.SetTextStyle, AnnotationTextStyle.SetHeight

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

GetTextWidthFactor/SetTextWidthFactor

`/optional/ Double`	`GetTextWidthFactor`	`()`
`void`	`SetTextWidthFactor`	`( /optional/ Double value)`

DEPRECATED: since Creo 4
SUCCESSOR(S): DetailText.SetTextStyle, AnnotationTextStyle.SetWidth

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

GetTextSlantAngle/SetTextSlantAngle

`/optional/ Double`	`GetTextSlantAngle`	`()`
`void`	`SetTextSlantAngle`	`( /optional/ Double value)`

DEPRECATED: since Creo 4
SUCCESSOR(S): DetailText.SetTextStyle, AnnotationTextStyle.SetSlantAngle

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

GetTextThickness/SetTextThickness

`/optional/ Double`	`GetTextThickness`	`()`
`void`	`SetTextThickness`	`( /optional/ Double value)`

DEPRECATED: since Creo 4
SUCCESSOR(S): DetailText.SetTextStyle, AnnotationTextStyle.SetThickness

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

GetFontName/SetFontName

`/optional/ String`	`GetFontName`	`()`
`void`	`SetFontName`	`( /optional/ String value)`

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.

GetIsUnderlined/SetIsUnderlined

`/optional/ Boolean`	`GetIsUnderlined`	`()`
`void`	`SetIsUnderlined`	`( /optional/ Boolean value)`

DEPRECATED: since Creo 4
SUCCESSOR(S): DetailText.SetTextStyle, AnnotationTextStyle.UnderlineText

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

GetText/SetText

`String`	`GetText`	`()`
`void`	`SetText`	`(String value)`

The text string.

GetTextStyle

/*optional*/ AnnotationTextStyle GetTextStyle ()

Returns:

SetTextStyle

void SetTextStyle (AnnotationTextStyle TextStyle)

Parameters:

TextStyle

Returns: