[#BloombergLP-balxml-EncoderOptions]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/balxml.adoc[balxml]::EncoderOptions
:relfileprefix: ../../
:mrdocs:

Options for performing XML encodings. Encoding style is either COMPACT or PRETTY. If encoding style is COMPACT, no whitespace will be added between elements. If encoding style is `PRETTY`, then the `InitialIndentLevel`, `SpacesPerLevel`, and `WrapColumn` parameters are used to specify the formatting of the output. Note that `InitialIndentLevel`, `SpacesPerLevel`, and `WrapColumn` are ignored when `EncodingStyle` is COMPACT (this is the default). The generated C++ code for this schema element is created by using bas_codegen.pl, run by balxml/code_from_xsd.pl, with no hand‐editing.

== Synopsis

Declared in `<balxml_encoderoptions.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class EncoderOptions;
----

== Enums

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balxml/EncoderOptions/_04enum-0f.adoc[`Unnamed enum`] 
| Attribute identifiers used by `bdlat` attribute lookup for this type.
| xref:BloombergLP/balxml/EncoderOptions/_04enum-0e.adoc[`Unnamed enum`] 
| The number of attributes in this type.
| xref:BloombergLP/balxml/EncoderOptions/_04enum-01.adoc[`Unnamed enum`] 
| Attribute indices used by `bdlat` attribute lookup for this type.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balxml/EncoderOptions/2constructor-0c.adoc[`EncoderOptions`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/balxml/EncoderOptions/2destructor.adoc[`~EncoderOptions`] [.small]#[destructor]#
| Destroy this object.
| xref:BloombergLP/balxml/EncoderOptions/operator_assign-00.adoc[`operator=`] 
| Assignment operators
| xref:BloombergLP/balxml/EncoderOptions/accessAttribute-03.adoc[`accessAttribute`] 
| `accessAttribute` overloads
| xref:BloombergLP/balxml/EncoderOptions/accessAttributes.adoc[`accessAttributes`] 
| Invoke the specified `accessor` sequentially on each (non‐modifiable) attribute of this object, supplying `accessor` with the corresponding attribute information structure until such invocation returns a non‐zero value. Return the value from the last invocation of `accessor` (i.e., the invocation that terminated the sequence).
| xref:BloombergLP/balxml/EncoderOptions/allowControlCharacters.adoc[`allowControlCharacters`] 
| Return the value of the "AllowControlCharacters" attribute of this object.
| xref:BloombergLP/balxml/EncoderOptions/datetimeFractionalSecondPrecision.adoc[`datetimeFractionalSecondPrecision`] 
| Return the value of the "DatetimeFractionalSecondPrecision" attribute of this object.
| xref:BloombergLP/balxml/EncoderOptions/encodingStyle.adoc[`encodingStyle`] 
| Return the value of the "EncodingStyle" attribute of this object.
| xref:BloombergLP/balxml/EncoderOptions/formattingMode.adoc[`formattingMode`] 
| Return the value of the "FormattingMode" attribute of this object.
| xref:BloombergLP/balxml/EncoderOptions/initialIndentLevel.adoc[`initialIndentLevel`] 
| Return the value of the "InitialIndentLevel" attribute of this object.
| xref:BloombergLP/balxml/EncoderOptions/manipulateAttribute-06.adoc[`manipulateAttribute`] 
| `manipulateAttribute` overloads
| xref:BloombergLP/balxml/EncoderOptions/manipulateAttributes.adoc[`manipulateAttributes`] 
| Invoke the specified `manipulator` sequentially on the address of each (modifiable) attribute of this object, supplying `manipulator` with the corresponding attribute information structure until such invocation returns a non‐zero value. Return the value from the last invocation of `manipulator` (i.e., the invocation that terminated the sequence).
| xref:BloombergLP/balxml/EncoderOptions/maxDecimalFractionDigits.adoc[`maxDecimalFractionDigits`] 
| Return a reference offering non‐modifiable access to the "MaxDecimalFractionDigits" attribute of this object.
| xref:BloombergLP/balxml/EncoderOptions/maxDecimalTotalDigits.adoc[`maxDecimalTotalDigits`] 
| Return a reference offering non‐modifiable access to the "MaxDecimalTotalDigits" attribute of this object.
| xref:BloombergLP/balxml/EncoderOptions/objectNamespace.adoc[`objectNamespace`] 
| Return a reference offering non‐modifiable access to the "ObjectNamespace" attribute of this object.
| xref:BloombergLP/balxml/EncoderOptions/outputXMLHeader.adoc[`outputXMLHeader`] 
| Return the value of the "OutputXMLHeader" attribute of this object.
| xref:BloombergLP/balxml/EncoderOptions/outputXSIAlias.adoc[`outputXSIAlias`] 
| Return the value of the "OutputXSIAlias" attribute of this object.
| xref:BloombergLP/balxml/EncoderOptions/print.adoc[`print`] 
| Format this object to the specified output `stream` at the optionally specified indentation `level` and return a reference to the modifiable `stream`. If `level` is specified, optionally specify `spacesPerLevel`, the number of spaces per indentation level for this and all of its nested objects. Each line is indented by the absolute value of `level * spacesPerLevel`. If `level` is negative, suppress indentation of the first line. If `spacesPerLevel` is negative, suppress line breaks and format the entire output on one line. If `stream` is initially invalid, this operation has no effect. Note that a trailing newline is provided in multiline mode only.
| xref:BloombergLP/balxml/EncoderOptions/reset.adoc[`reset`] 
| Reset this object to the default value (i.e., its value upon default construction).
| xref:BloombergLP/balxml/EncoderOptions/schemaLocation.adoc[`schemaLocation`] 
| Return a reference offering non‐modifiable access to the "SchemaLocation" attribute of this object.
| xref:BloombergLP/balxml/EncoderOptions/setAllowControlCharacters.adoc[`setAllowControlCharacters`] 
| Set the "AllowControlCharacters" attribute of this object to the specified `value`.
| xref:BloombergLP/balxml/EncoderOptions/setDatetimeFractionalSecondPrecision.adoc[`setDatetimeFractionalSecondPrecision`] 
| Set the "DatetimeFractionalSecondPrecision" attribute of this object to the specified `value`.
| xref:BloombergLP/balxml/EncoderOptions/setEncodingStyle.adoc[`setEncodingStyle`] 
| Set the "EncodingStyle" attribute of this object to the specified `value`.
| xref:BloombergLP/balxml/EncoderOptions/setFormattingMode.adoc[`setFormattingMode`] 
| Set the "FormattingMode" attribute of this object to the specified `value`.
| xref:BloombergLP/balxml/EncoderOptions/setInitialIndentLevel.adoc[`setInitialIndentLevel`] 
| Set the "InitialIndentLevel" attribute of this object to the specified `value`.
| xref:BloombergLP/balxml/EncoderOptions/setMaxDecimalFractionDigits.adoc[`setMaxDecimalFractionDigits`] 
| Set the "MaxDecimalFractionDigits" attribute of this object to the specified `value`.
| xref:BloombergLP/balxml/EncoderOptions/setMaxDecimalTotalDigits.adoc[`setMaxDecimalTotalDigits`] 
| Set the "MaxDecimalTotalDigits" attribute of this object to the specified `value`.
| xref:BloombergLP/balxml/EncoderOptions/setObjectNamespace.adoc[`setObjectNamespace`] 
| Set the "ObjectNamespace" attribute of this object to the specified `value`.
| xref:BloombergLP/balxml/EncoderOptions/setOutputXMLHeader.adoc[`setOutputXMLHeader`] 
| Set the "OutputXMLHeader" attribute of this object to the specified `value`.
| xref:BloombergLP/balxml/EncoderOptions/setOutputXSIAlias.adoc[`setOutputXSIAlias`] 
| Set the "OutputXSIAlias" attribute of this object to the specified `value`.
| xref:BloombergLP/balxml/EncoderOptions/setSchemaLocation.adoc[`setSchemaLocation`] 
| Set the "SchemaLocation" attribute of this object to the specified `value`.
| xref:BloombergLP/balxml/EncoderOptions/setSignificantDoubleDigits.adoc[`setSignificantDoubleDigits`] 
| Set the "SignificantDoubleDigits" attribute of this object to the specified `value`.
| xref:BloombergLP/balxml/EncoderOptions/setSpacesPerLevel.adoc[`setSpacesPerLevel`] 
| Set the "SpacesPerLevel" attribute of this object to the specified `value`.
| xref:BloombergLP/balxml/EncoderOptions/setTag.adoc[`setTag`] 
| Set the "Tag" attribute of this object to the specified `value`.
| xref:BloombergLP/balxml/EncoderOptions/setUseZAbbreviationForUtc.adoc[`setUseZAbbreviationForUtc`] 
| Set the "UseZAbbreviationForUtc" attribute of this object to the specified `value`.
| xref:BloombergLP/balxml/EncoderOptions/setWrapColumn.adoc[`setWrapColumn`] 
| Set the "WrapColumn" attribute of this object to the specified `value`.
| xref:BloombergLP/balxml/EncoderOptions/significantDoubleDigits.adoc[`significantDoubleDigits`] 
| Return a reference offering non‐modifiable access to the "SignificantDoubleDigits" attribute of this object.
| xref:BloombergLP/balxml/EncoderOptions/spacesPerLevel.adoc[`spacesPerLevel`] 
| Return the value of the "SpacesPerLevel" attribute of this object.
| xref:BloombergLP/balxml/EncoderOptions/tag.adoc[`tag`] 
| Return a reference offering non‐modifiable access to the "Tag" attribute of this object.
| xref:BloombergLP/balxml/EncoderOptions/useZAbbreviationForUtc.adoc[`useZAbbreviationForUtc`] 
| Return the value of the "UseZAbbreviationForUtc" attribute of this object.
| xref:BloombergLP/balxml/EncoderOptions/wrapColumn.adoc[`wrapColumn`] 
| Return the value of the "WrapColumn" attribute of this object.
|===


== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balxml/EncoderOptions/lookupAttributeInfo-086.adoc[`lookupAttributeInfo`] 
| `lookupAttributeInfo` overloads
|===


== Static Data Members

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balxml/EncoderOptions/ATTRIBUTE_INFO_ARRAY.adoc[`ATTRIBUTE_INFO_ARRAY`] 
| Attribute metadata array used by `bdlat` attribute lookup for this type.
| xref:BloombergLP/balxml/EncoderOptions/CLASS_NAME.adoc[`CLASS_NAME`] 
| Name of this class for use in XML serialization.
| xref:BloombergLP/balxml/EncoderOptions/DEFAULT_INITIALIZER_ALLOW_CONTROL_CHARACTERS.adoc[`DEFAULT_INITIALIZER_ALLOW_CONTROL_CHARACTERS`] 
| Default initial value for `allowControlCharacters`.
| xref:BloombergLP/balxml/EncoderOptions/DEFAULT_INITIALIZER_DATETIME_FRACTIONAL_SECOND_PRECISION.adoc[`DEFAULT_INITIALIZER_DATETIME_FRACTIONAL_SECOND_PRECISION`] 
| Default initial value for `dateTimeFractionalSecondPrecision`.
| xref:BloombergLP/balxml/EncoderOptions/DEFAULT_INITIALIZER_ENCODING_STYLE.adoc[`DEFAULT_INITIALIZER_ENCODING_STYLE`] 
| Default initial value for `encodingStyle`.
| xref:BloombergLP/balxml/EncoderOptions/DEFAULT_INITIALIZER_FORMATTING_MODE.adoc[`DEFAULT_INITIALIZER_FORMATTING_MODE`] 
| Default initial value for `formattingMode`.
| xref:BloombergLP/balxml/EncoderOptions/DEFAULT_INITIALIZER_INITIAL_INDENT_LEVEL.adoc[`DEFAULT_INITIALIZER_INITIAL_INDENT_LEVEL`] 
| Default initial value for `initialIndentLevel`.
| xref:BloombergLP/balxml/EncoderOptions/DEFAULT_INITIALIZER_OUTPUT_X_M_L_HEADER.adoc[`DEFAULT_INITIALIZER_OUTPUT_X_M_L_HEADER`] 
| Default initial value for `outputXMLHeader` (`true`).
| xref:BloombergLP/balxml/EncoderOptions/DEFAULT_INITIALIZER_OUTPUT_X_S_I_ALIAS.adoc[`DEFAULT_INITIALIZER_OUTPUT_X_S_I_ALIAS`] 
| Default initial value for `outputXSIAlias`.
| xref:BloombergLP/balxml/EncoderOptions/DEFAULT_INITIALIZER_SPACES_PER_LEVEL.adoc[`DEFAULT_INITIALIZER_SPACES_PER_LEVEL`] 
| Default initial value for `spacesPerLevel`.
| xref:BloombergLP/balxml/EncoderOptions/DEFAULT_INITIALIZER_USE_Z_ABBREVIATION_FOR_UTC.adoc[`DEFAULT_INITIALIZER_USE_Z_ABBREVIATION_FOR_UTC`] 
| Default initial value for `useZAbbreviationForUtc`.
| xref:BloombergLP/balxml/EncoderOptions/DEFAULT_INITIALIZER_WRAP_COLUMN.adoc[`DEFAULT_INITIALIZER_WRAP_COLUMN`] 
| Default initial value for `wrapColumn`.
|===


== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balxml/operator_not_eq-00a.adoc[`operator!=`]
| Return `true` if the specified `lhs` and `rhs` attribute objects do not have the same value, and `false` otherwise. Two attribute objects do not have the same value if one or more respective attributes differ in values.
| xref:BloombergLP/balxml/operator_eq-05.adoc[`operator==`]
| Return `true` if the specified `lhs` and `rhs` attribute objects have the same value, and `false` otherwise. Two attribute objects have the same value if each respective attribute has the same value.
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#