DbXmlNameConverter class | QSYS API Reference Guide
Estimated reading time: 2 minutes
This class is a filter used in the XML transforms ExportToXml.xslt and ImportToXml.xslt. Encode() takes an arbitrary string and returns an XML-compliant Name string. For example, “$ITEMTEST” is returned as “_x0024_ITEMTEST”. Decode() performs the inverse function.
Namespace: ASNA.DataGate.Client.CopyData Assembly: ASNA.QSys.DataGate.Client.dll
Inheritance: Object
Properties
| Type | Name | Description |
|---|---|---|
| DbXmlNameConverter | Default | Gets the default instance of the class. |
| String | Urn | Defines the Uniform Resource Name (URN) for the class. |
Methods
| Signature | Description |
|---|---|
| Decode(XPathNavigator, String) | Decodes the provided XML-compliant string back into its original name. |
| Encode(XPathNavigator, String) | Encodes the provided name into an XML-compliant string. |
string Decode(XPathNavigator context, string name)
Decodes the provided XML-compliant string back into its original name.
Remarks
This method uses the method to perform the actual decoding.Before the decoding, it checks if the provided context is null. If it is, an is thrown.The method uses the method to decode the name, and handles any exceptions that might be thrown during the decoding.
string Decode(XPathNavigator context, string name)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| XPathNavigator | context | The context in which the decoding is performed. |
| String | name | The XML-compliant string to be decoded. |
Returns
| Type | Description |
|---|---|
| String | The original name that was encoded into the provided XML-compliant string. |
string Encode(XPathNavigator context, string name)
Encodes the provided name into an XML-compliant string.
Remarks
This method uses the method to perform the actual encoding.Before the encoding, it checks if the provided context is null. If it is, an is thrown.The method uses the method to encode the name, and handles any exceptions that might be thrown during the encoding.
string Encode(XPathNavigator context, string name)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| XPathNavigator | context | The context in which the encoding is performed. |
| String | name | The name to be encoded. |
Returns
| Type | Description |
|---|---|
| String | An XML-compliant string representation of the provided name. |