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

Options for performing XML encodings&period; Encoding style is either COMPACT or PRETTY&period; If encoding style is COMPACT, no whitespace will be added between elements&period; If encoding style is `PRETTY`, then the `InitialIndentLevel`, `SpacesPerLevel`, and `WrapColumn` parameters are used to specify the formatting of the output&period; Note that `InitialIndentLevel`, `SpacesPerLevel`, and `WrapColumn` are ignored when `EncodingStyle` is COMPACT (this is the default)&period; The generated C&plus;&plus; code for this schema element is created by using bas&lowbar;codegen&period;pl, run by balxml&sol;code&lowbar;from&lowbar;xsd&period;pl, with no hand&hyphen;editing&period;

== Synopsis

Declared in `&lt;balxml&lowbar;encoderoptions&period;h&gt;`

[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&period;
| xref:BloombergLP/balxml/EncoderOptions/_04enum-0e.adoc[`Unnamed enum`] 
| The number of attributes in this type&period;
| xref:BloombergLP/balxml/EncoderOptions/_04enum-01.adoc[`Unnamed enum`] 
| Attribute indices used by `bdlat` attribute lookup for this type&period;
|===


== Member Functions

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


== 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&lowbar;INFO&lowbar;ARRAY`] 
| Attribute metadata array used by `bdlat` attribute lookup for this type&period;
| xref:BloombergLP/balxml/EncoderOptions/CLASS_NAME.adoc[`CLASS&lowbar;NAME`] 
| Name of this class for use in XML serialization&period;
| xref:BloombergLP/balxml/EncoderOptions/DEFAULT_INITIALIZER_ALLOW_CONTROL_CHARACTERS.adoc[`DEFAULT&lowbar;INITIALIZER&lowbar;ALLOW&lowbar;CONTROL&lowbar;CHARACTERS`] 
| Default initial value for `allowControlCharacters`&period;
| xref:BloombergLP/balxml/EncoderOptions/DEFAULT_INITIALIZER_DATETIME_FRACTIONAL_SECOND_PRECISION.adoc[`DEFAULT&lowbar;INITIALIZER&lowbar;DATETIME&lowbar;FRACTIONAL&lowbar;SECOND&lowbar;PRECISION`] 
| Default initial value for `dateTimeFractionalSecondPrecision`&period;
| xref:BloombergLP/balxml/EncoderOptions/DEFAULT_INITIALIZER_ENCODING_STYLE.adoc[`DEFAULT&lowbar;INITIALIZER&lowbar;ENCODING&lowbar;STYLE`] 
| Default initial value for `encodingStyle`&period;
| xref:BloombergLP/balxml/EncoderOptions/DEFAULT_INITIALIZER_FORMATTING_MODE.adoc[`DEFAULT&lowbar;INITIALIZER&lowbar;FORMATTING&lowbar;MODE`] 
| Default initial value for `formattingMode`&period;
| xref:BloombergLP/balxml/EncoderOptions/DEFAULT_INITIALIZER_INITIAL_INDENT_LEVEL.adoc[`DEFAULT&lowbar;INITIALIZER&lowbar;INITIAL&lowbar;INDENT&lowbar;LEVEL`] 
| Default initial value for `initialIndentLevel`&period;
| xref:BloombergLP/balxml/EncoderOptions/DEFAULT_INITIALIZER_OUTPUT_X_M_L_HEADER.adoc[`DEFAULT&lowbar;INITIALIZER&lowbar;OUTPUT&lowbar;X&lowbar;M&lowbar;L&lowbar;HEADER`] 
| Default initial value for `outputXMLHeader` (`true`)&period;
| xref:BloombergLP/balxml/EncoderOptions/DEFAULT_INITIALIZER_OUTPUT_X_S_I_ALIAS.adoc[`DEFAULT&lowbar;INITIALIZER&lowbar;OUTPUT&lowbar;X&lowbar;S&lowbar;I&lowbar;ALIAS`] 
| Default initial value for `outputXSIAlias`&period;
| xref:BloombergLP/balxml/EncoderOptions/DEFAULT_INITIALIZER_SPACES_PER_LEVEL.adoc[`DEFAULT&lowbar;INITIALIZER&lowbar;SPACES&lowbar;PER&lowbar;LEVEL`] 
| Default initial value for `spacesPerLevel`&period;
| xref:BloombergLP/balxml/EncoderOptions/DEFAULT_INITIALIZER_USE_Z_ABBREVIATION_FOR_UTC.adoc[`DEFAULT&lowbar;INITIALIZER&lowbar;USE&lowbar;Z&lowbar;ABBREVIATION&lowbar;FOR&lowbar;UTC`] 
| Default initial value for `useZAbbreviationForUtc`&period;
| xref:BloombergLP/balxml/EncoderOptions/DEFAULT_INITIALIZER_WRAP_COLUMN.adoc[`DEFAULT&lowbar;INITIALIZER&lowbar;WRAP&lowbar;COLUMN`] 
| Default initial value for `wrapColumn`&period;
|===


== Non-Member Functions

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


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