NumberSeq::createAnnotatedFormatFromSegments Method [AX 2012]

Creates an annotated format string from the specified segment information.

Syntax

client server public static str createAnnotatedFormatFromSegments(
    container _segments, 
   [boolean _includeAnnotationMarkers, 
    boolean _truncate])

Run On

Called

Parameters

• _segments
  Type: container
  A container that has segment information, which consists of two elements. The first element is a NumberSeqParameterType enumeration value that describes the parameter type, -1 for a segment that contains a constant literal value, or -2 for a segment that contains formatting characters. The second element is the value of the segment. The type of the value is specific to the parameter type.

• _includeAnnotationMarkers
  Type: boolean
  A Boolean value that indicates whether the format string should contain the annotation markup. If false, only the values of the segment will be included.

• _truncate
  Type: boolean
  A Boolean value that indicates whether segments enclosed in format string should be truncated to ensure the format string is a maximum of 20 characters long.

Return Value

Type: str
An annotated format string from the specified segment information.

Remarks

When the _includeAnnotationMarkers parameter is set equal to false, the method will generate the format string that corresponds to the annotated format string. When the _truncate parameter is set equal to true and truncation is required, the following is performed to reduce the length of the format:

1. All constant literal values will be removed.

2. Scope based segments will be shortened.

See Also

Reference

NumberSeq Class