XmlEditOptions Leave feedback
On this page
Inheritance: java.lang.Object
All Implemented Interfaces: com.groupdocs.editor.options.IEditOptions
public final class XmlEditOptions implements IEditOptions
Allows to specify custom options for loading XML (eXtensible Markup Language) documents and converting them to the HTML
| Constructor | Description |
|---|---|
| XmlEditOptions() |
| Method | Description |
|---|---|
| getEncoding() | Character encoding of the text document, which will be applied for its opening. |
| setEncoding(Charset value) | Character encoding of the text document, which will be applied for its opening. |
| getFixIncorrectStructure() | Allows to enable or disable mechanism for fixing corrupted XML structure. |
| setFixIncorrectStructure(boolean value) | Allows to enable or disable mechanism for fixing corrupted XML structure. |
| getRecognizeUris() | Allows to enable URI recognition algorithm |
| setRecognizeUris(boolean value) | Allows to enable URI recognition algorithm |
| getRecognizeEmails() | Allows to enable recognition algorithm for email addresses in attribute values |
| setRecognizeEmails(boolean value) | Allows to enable recognition algorithm for email addresses in attribute values |
| getTrimTrailingWhitespaces() | Allows to enable the truncation of trailing whitespaces in the inner-tag text. |
| setTrimTrailingWhitespaces(boolean value) | Allows to enable the truncation of trailing whitespaces in the inner-tag text. |
| getAttributeValuesQuoteType() | Allows to specify quote type (single or double quotes) for attribute values. |
| setAttributeValuesQuoteType(QuoteType value) | Allows to specify quote type (single or double quotes) for attribute values. |
| getHighlightOptions() | Allows to adjust the XML highlighting, that will be applied to the XML structure, when it is represented in HTML. |
| getFormatOptions() | Allows to adjust the XML formatting, that will be applied to the XML structure, when it is represented in HTML. |
public XmlEditOptions()
public final Charset getEncoding()
Character encoding of the text document, which will be applied for its opening. By default is null \u2014 internal document encoding will be applied.
Returns: java.nio.charset.Charset
public final void setEncoding(Charset value)
Character encoding of the text document, which will be applied for its opening. By default is null \u2014 internal document encoding will be applied.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.nio.charset.Charset |
public final boolean getFixIncorrectStructure()
Allows to enable or disable mechanism for fixing corrupted XML structure. By default is disabled (false).
By default only proper valid well-formed XML documents are acceptable. When this option is enabled, GroupDocs.Editor will try to fix corrupted XML structure if possible.
Returns: boolean
public final void setFixIncorrectStructure(boolean value)
Allows to enable or disable mechanism for fixing corrupted XML structure. By default is disabled (false).
By default only proper valid well-formed XML documents are acceptable. When this option is enabled, GroupDocs.Editor will try to fix corrupted XML structure if possible.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
public final boolean getRecognizeUris()
Allows to enable URI recognition algorithm
Returns: boolean
public final void setRecognizeUris(boolean value)
Allows to enable URI recognition algorithm
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
public final boolean getRecognizeEmails()
Allows to enable recognition algorithm for email addresses in attribute values
Returns: boolean
public final void setRecognizeEmails(boolean value)
Allows to enable recognition algorithm for email addresses in attribute values
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
public final boolean getTrimTrailingWhitespaces()
Allows to enable the truncation of trailing whitespaces in the inner-tag text. By default is disabled (false) \u2014 trailing whitespaces will be preserved.
Returns: boolean
public final void setTrimTrailingWhitespaces(boolean value)
Allows to enable the truncation of trailing whitespaces in the inner-tag text. By default is disabled (false) \u2014 trailing whitespaces will be preserved.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
public final QuoteType getAttributeValuesQuoteType()
Allows to specify quote type (single or double quotes) for attribute values. Double quotes are default.
Returns: QuoteType
public final void setAttributeValuesQuoteType(QuoteType value)
Allows to specify quote type (single or double quotes) for attribute values. Double quotes are default.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | QuoteType |
public final XmlHighlightOptions getHighlightOptions()
Allows to adjust the XML highlighting, that will be applied to the XML structure, when it is represented in HTML. Default highlighting is used and is adjustable. Cannot be null.
Returns: XmlHighlightOptions
public final XmlFormatOptions getFormatOptions()
Allows to adjust the XML formatting, that will be applied to the XML structure, when it is represented in HTML. Default formatting is used and is adjustable. Cannot be null.
Returns: XmlFormatOptions
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.