| Package | mx.rpc.xml |
| Interface | public interface IXMLEncoder |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Public Properties
| Property | Defined By | ||
|---|---|---|---|
| strictNillability : Boolean
When strictNillability is set to true, null values
are encoded according to XML Schema rules (requires nillable=true
to be set in the definition). | IXMLEncoder | ||
| xmlSpecialCharsFilter : Function
The function to be used to escape XML special characters before encoding
any simple content. | IXMLEncoder | ||
Public Methods
| Method | Defined By | ||
|---|---|---|---|
Encodes an ActionScript value as XML. | IXMLEncoder | ||
Resets the encoder to its initial state, including resetting any
Schema scope to the top level. | IXMLEncoder | ||
Property Detail
strictNillability | property |
strictNillability:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
When strictNillability is set to true, null values
are encoded according to XML Schema rules (requires nillable=true
to be set in the definition). When strictNillability is set to
false, null values are always encoded with the
xsi:nil="true" attribute. The default is false.
Implementation
public function get strictNillability():Boolean public function set strictNillability(value:Boolean):voidxmlSpecialCharsFilter | property |
xmlSpecialCharsFilter:Function| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The function to be used to escape XML special characters before encoding any simple content.
Implementation
public function get xmlSpecialCharsFilter():Function public function set xmlSpecialCharsFilter(value:Function):voidMethod Detail
encode | () | method |
public function encode(value:*, name:QName = null, type:QName = null, definition:XML = null):XMLList| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Encodes an ActionScript value as XML.
Parameters
value:* — The ActionScript value to encode as XML.
| |
name:QName (default = null) — The QName of an XML Schema element that
describes how to encode the value, or the name to be used for the
encoded XML node when a type parameter is also specified.
| |
type:QName (default = null) — The QName of an XML Schema simpleType or
complexType definition that describes how to encode the
value.
| |
definition:XML (default = null) — If neither a top-level element nor type exists in the
schema to describe how to encode this value, a custom element definition
can be provided.
|
XMLList — Returns an XML encoding of the given ActionScript value.
|
reset | () | method |
public function reset():void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Resets the encoder to its initial state, including resetting any Schema scope to the top level.
Mon Nov 28 2011, 06:48 AM -08:00