NumberSequenceTable::getAutoFormatData Method

Gets the auto formatting data based on the specified parameters.

Syntax

client server public static container getAutoFormatData(
    NumberSequenceDatatype _numberSequenceDatatype, 
    NumberSeqScope _scope, 
    int _highest, 
    boolean _includeScopeSegments)

Run On

Called

Parameters

• _numberSequenceDatatype
  Type: NumberSequenceDatatype Table
  The NumberSequenceDatatype to use when formatting.

• _scope
  Type: NumberSeqScope Class
  The NumberSeqScope to use when formatting.

• _highest
  Type: int
  The suggested highest number that may be used for the number sequence.

• _includeScopeSegments
  Type: boolean
  A Boolean value indicating whether or not to include scope information in the format.

Return Value

Type: container
A container holding the following three values: 1. An int value containing the actual highest number that may be used for the number sequence.
This may differ from _highest if the specified datatype could not hold a value that large.
2. The resulting NumberSequenceFormat.
3. The resulting annotated format.

See Also

Reference

NumberSequenceTable Table