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

Open an element of the specified `name`.

== Synopsis

Declared in `<balxml_formatter_compactimpl.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
std::ostream&
openElement(
    std::ostream& stream,
    xref:BloombergLP/balxml/Formatter_CompactImplUtil/State.adoc[State]* state,
    std::string_view const& name,
    xref:BloombergLP/balxml/FormatterWhitespaceType/Enum.adoc[WhitespaceType::Enum] whitespaceMode = WhitespaceType::e_PRESERVE_WHITESPACE);
----

== Description

Write the opening tag at the current indent level with the optionally specified whitespace constraint `whitespaceMode` for its textual data to the specified `stream`, with formatting depending on the specified `state`, and update `state` accordingly, incrementing the indent level. Return the `stream`. `whitespaceMode` constrains how textual data is written with `addListData` for the current element, but not its nested elements. The behavior is undefined if `openElement` is called after the root element is closed and there is no subsequent call to `reset`.

== Return Value

a reference to the modifiable `stream`

== Parameters

[cols="1,4"]
|===
| Name| Description
| *stream*
| output stream
| *state*
| formatter state to consult and update
| *name*
| element name
| *whitespaceMode*
| whitespace constraint for element data
|===


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