com.crystaldecisions.sdk.occa.report.definition
Interface IStringFieldFormat

All Superinterfaces:
IClone
All Known Implementing Classes:
StringFieldFormat

public interface IStringFieldFormat
extends IClone

This interface enables you to get and set how a FieldObject containing Strings is formatted. If the field is not being used to represent a StringFormat property, and you modify this object, your changes will be ignored and discarded.


Method Summary
 int getCharacterSpacing()
          Returns the spacing between characters.
 StringFieldFormatConditionFormulas getConditionFormulas()
           
 boolean getEnableWordWrap()
          Deprecated. EnableWordWrap is not used.
 IIndentAndSpacingFormat getIndentAndSpacingFormat()
           Returns the indent and spacing format for the string field.
 int getMaxNumberOfLines()
           Returns the maximum number of lines of text for a string field.
 ReadingOrder getReadingOrder()
          Returns the reading order for the text field.
 TextFormat getTextFormat()
           Returns the text format for the string field.
 void setCharacterSpacing(int characterSpacing)
          Sets the spacing between characters.
 void setConditionFormulas(StringFieldFormatConditionFormulas conditionFormulas)
           
 void setEnableWordWrap(boolean enableWordWrap)
          Deprecated. EnableWordWrap is not used.
 void setIndentAndSpacingFormat(IIndentAndSpacingFormat indentAndSpacingFormat)
           Sets the indent and spacing format for the string field.
 void setMaxNumberOfLines(int maxNumberOfLines)
           Sets the maximum number of lines of text for a string field.
 void setReadingOrder(ReadingOrder newReadingOrder)
          Sets the reading order for the text field.
 void setTextFormat(TextFormat textFormat)
           Sets the text format for the string field.
 

Method Detail

getCharacterSpacing

int getCharacterSpacing()

Returns the spacing between characters.

Returns:
The spacing between characters as an int.

getIndentAndSpacingFormat

IIndentAndSpacingFormat getIndentAndSpacingFormat()

Returns the indent and spacing format for the string field.

Returns:
The indent and spacing format for the string field as IIndentAndSpacingFormat.

getMaxNumberOfLines

int getMaxNumberOfLines()

Returns the maximum number of lines of text for a string field.

Returns:
The maximum number of lines of text for a string field as an int.

getTextFormat

TextFormat getTextFormat()

Returns the text format for the string field.

Returns:
The text format for the string field as TextFormat.

getEnableWordWrap

boolean getEnableWordWrap()
Deprecated. EnableWordWrap is not used.

Returns whether lines of text that are too long will automatically be broken into multiple lines.

Returns:
true if word wrap is enabled, and otherwise false.

getReadingOrder

ReadingOrder getReadingOrder()

Returns the reading order for the text field. Reading order can be either left to right, or right to left.

Returns:
The reading order as ReadingOrder.

setCharacterSpacing

void setCharacterSpacing(int characterSpacing)

Sets the spacing between characters.

Parameters:
characterSpacing - The spacing between characters as an int.

setIndentAndSpacingFormat

void setIndentAndSpacingFormat(IIndentAndSpacingFormat indentAndSpacingFormat)

Sets the indent and spacing format for the string field.

Parameters:
indentAndSpacingFormat - The indent and spacing format for the string field as IIndentAndSpacingFormat.

setMaxNumberOfLines

void setMaxNumberOfLines(int maxNumberOfLines)

Sets the maximum number of lines of text for a string field.

Parameters:
maxNumberOfLines - The maximum number of lines of text for a string field as an int.

setTextFormat

void setTextFormat(TextFormat textFormat)

Sets the text format for the string field.

Parameters:
textFormat - The text format for the string field as TextFormat.

setEnableWordWrap

void setEnableWordWrap(boolean enableWordWrap)
Deprecated. EnableWordWrap is not used.

Sets whether lines of text that are too long will automatically be broken into multiple lines.

Parameters:
enableWordWrap - true if word wrap is enabled, and otherwise false.

setReadingOrder

void setReadingOrder(ReadingOrder newReadingOrder)

Sets the reading order for the text field. Reading order can be either left to right, or right to left.

Parameters:
newReadingOrder - The reading order as ReadingOrder.

getConditionFormulas

StringFieldFormatConditionFormulas getConditionFormulas()

setConditionFormulas

void setConditionFormulas(StringFieldFormatConditionFormulas conditionFormulas)