Smartsite Documentatie > SXML > Vipers > Global Viper Methods > String Viper Class > String.XmlEncode Viper Method
SCAS Level
Returns the XmlEncoded string of the given string.

Syntax

Smartsite SXML CopyCode image Copy Code 
string string.xmlencode(string s)
string string.xmlencode(string s, enum options)
string string.xmlencode(string s, boolean includeQuotes)

Parameters

Name Data Type Description
s String The input string.
options Enum The options.
Enum values:
  • None
    No encoding or decoding
  • LessThan
    Includes the < character (encoded: &lt;)
  • GreaterThan
    Includes the > character (encoded: &gt;)
  • Ampersand
    Includes the & character (encoded: &amp;)
  • Apostrophe
    Includes the ' character (encoded: &apos;)
  • QuotationMark
    Includes the " character (encoded: &quot;)
  • ViperDirective
    Includes the { character (encoded: &#123;)
  • NumericEntities
    Includes numeric entities decoding. This option is only useful when decoding XML.
  • CharacterEntities
    Includes character entities decoding. This option is only useful when decoding XML and when a character reference dictionary is provided.
  • SkipCDATA
    Skip CDATA sections.
  • SkipComments
    Skip comments.
  • DoubleAmpersand
    Ampersands are encoded and decoded twice. Example: encodes < into &amp;lt;. Decodes &amp;amp; into &.
  • Xml
    Provides the default xml encoding and decoding of the five builtin entity reference (<, >, &, ', ") and the decoding of the numeric entities.
  • Sxml
    Provides the default sxml encoding and decoding consisting of the default xml coding plus the viper directive ({)
  • Html
    Provides the default html encoding and decoding consisting of the default xml coding plus decoding of character entity references
includeQuotes Boolean If set to true quotes are included.

Return Value

Data Type Description
String An encoded string.

Expand image Examples

Expand image See Also

SXML