Namespace: OpenEdge.Core.XML
Class
SaxWriter
Parent classes:
Progress.Lang.Object
OpenEdge.Core.XML.SaxWriter

Inherits: Progress.Lang.Object

Copyright (c) 2013, 2015 by Progress Software Corporation. All rights reserved.
/* ------------------------------------------------------------------------
File:SaxWriter
Purpose:An OOABL wrapper around the ABL SAX-WRITER handle.
Author(s):pjudge
Created:Mon Nov 22 15:40:24 EST 2010
Notes:* The majority of method names correspond to the ABL attributes/methods,
which are comprehensively documented in the ABL documentation set.




Method Summary
Options Name Purpose
OpenEdge.Core.XML.SaxWriter DeclareNamespace (longchar)
OpenEdge.Core.XML.SaxWriter DeclareNamespace (longchar, longchar)
EndDocument ()
OpenEdge.Core.XML.SaxWriter EndElement (longchar)
OpenEdge.Core.XML.SaxWriter EndElement (longchar, longchar)
Initialize ()
OpenEdge.Core.XML.SaxWriter InsertAttribute (longchar, longchar)
OpenEdge.Core.XML.SaxWriter InsertAttribute (longchar, longchar, longchar)
OpenEdge.Core.XML.SaxWriter Reset ()
OpenEdge.Core.XML.SaxWriter SetEncoding (character)
OpenEdge.Core.XML.SaxWriter SetIsFormatted (logical)
OpenEdge.Core.XML.SaxWriter SetIsFragment (logical)
OpenEdge.Core.XML.SaxWriter SetIsStandalone (logical)
OpenEdge.Core.XML.SaxWriter SetIsStrict (logical)
OpenEdge.Core.XML.SaxWriter SetVersion (character) /* Public property setter methods provided to enable a Fluent-style interface ( oSW:SetIsStrict(true):StartDocument(): ... ) */
OpenEdge.Core.XML.SaxWriter StartDocument ()
OpenEdge.Core.XML.SaxWriter StartElement (longchar)
OpenEdge.Core.XML.SaxWriter StartElement (longchar, longchar)
OpenEdge.Core.XML.SaxWriter StartElement (longchar, longchar, handle)
ValidateCanUpdateProperty (character)
OpenEdge.Core.XML.SaxWriter WriteDataElement (longchar, longchar)
OpenEdge.Core.XML.SaxWriter WriteDataElement (longchar, longchar, longchar)
OpenEdge.Core.XML.SaxWriter WriteDataElement (longchar, longchar, longchar, handle)
OpenEdge.Core.XML.SaxWriter WriteEmptyElement (longchar)
OpenEdge.Core.XML.SaxWriter WriteEmptyElement (longchar, longchar)
OpenEdge.Core.XML.SaxWriter WriteEmptyElement (longchar, longchar, handle)
OpenEdge.Core.XML.SaxWriter WriteExternalDTD (longchar, longchar)
OpenEdge.Core.XML.SaxWriter WriteExternalDTD (longchar, longchar, longchar)
OpenEdge.Core.XML.SaxWriter WriteFragment (handle) /** Writes a fragment's values from a specified XML node ref @param handle The valid XML node-ref handle containing the fragment @return logical Whether the operation succeeded or not. */
OpenEdge.Core.XML.SaxWriter WriteFragment (longchar) /** Writes a fragment's values from a specified XML node ref @param longchar The longchar containing the fragment @return logical Whether the operation succeeded or not. */
OpenEdge.Core.XML.SaxWriter WriteProcessingInstruction (longchar, longchar)
OpenEdge.Core.XML.SaxWriter WriteTo (character)
OpenEdge.Core.XML.SaxWriter WriteTo (handle)
OpenEdge.Core.XML.SaxWriter WriteTo (longchar)
OpenEdge.Core.XML.SaxWriter WriteTo (memptr)
OpenEdge.Core.XML.SaxWriter WriteValue (longchar) /** Writes a value to the output destination. This method defaults to writing characters. @param longchar The value being written. @return logical Whether the operation succeeded or not. */
OpenEdge.Core.XML.SaxWriter WriteValue (SaxWriterDataTypeEnum, longchar) /** Writes a value to the output destination. This method simply writes the value for the given type, using the correct WRITE-* call. There's a WriteFragment() method which deals with a noderef handle. @param SaxWriterDataTypeEnum The element type @param longchar The value being written. @return logical Whether the operation succeeded or not. */

Constructor Summary
Options Name Purpose
SaxWriter ()
SaxWriter (character)
SaxWriter (handle)
SaxWriter (longchar)
SaxWriter (memptr)

Property Summary
Options Name Purpose
CHARACTER Encoding /** Maps to SAX-WRITER ENCODING attribute. See the ABL documentation for more details. */
LOGICAL IsFormatted /** Maps to SAX-WRITER FORMATTED attribute. See the ABL documentation for more details. */
LOGICAL IsFragment /** Maps to SAX-WRITER FRAGMENT attribute. See the ABL documentation for more details. */
LOGICAL IsStandalone /** Maps to SAX-WRITER STANDALONE attribute. See the ABL documentation for more details. */
LOGICAL IsStrict /** Maps to SAX-WRITER STRICT attribute. See the ABL documentation for more details. */
CHARACTER Version /** Maps to SAX-WRITER VERSION attribute. See the ABL documentation for more details. */
OpenEdge.Core.XML.SaxWriteStatusEnum WriteStatus /** (derived) Maps to SAX-WRITER WRITE-STATUS attribute. See the ABL documentation for more details. */


Method Detail
Top

OpenEdge.Core.XML.SaxWriter DeclareNamespace (longchar)
Parameters:
pcNamespaceURI LONGCHAR
Returns OpenEdge.Core.XML.SaxWriter
Top

OpenEdge.Core.XML.SaxWriter DeclareNamespace (longchar, longchar)
Parameters:
pcNamespaceURI LONGCHAR
pcNamespacePrefix LONGCHAR
Returns OpenEdge.Core.XML.SaxWriter
Top

EndDocument ()
Top

OpenEdge.Core.XML.SaxWriter EndElement (longchar)
Parameters:
pcName LONGCHAR
Returns OpenEdge.Core.XML.SaxWriter
Top

OpenEdge.Core.XML.SaxWriter EndElement (longchar, longchar)
Parameters:
pcName LONGCHAR
pcNamespaceURI LONGCHAR
Returns OpenEdge.Core.XML.SaxWriter
Top

Initialize ()
Top

OpenEdge.Core.XML.SaxWriter InsertAttribute (longchar, longchar)
Parameters:
pcName LONGCHAR
pcValue LONGCHAR
Returns OpenEdge.Core.XML.SaxWriter
Top

OpenEdge.Core.XML.SaxWriter InsertAttribute (longchar, longchar, longchar)
Parameters:
pcName LONGCHAR
pcValue LONGCHAR
pcNamespaceURI LONGCHAR
Returns OpenEdge.Core.XML.SaxWriter
Top

OpenEdge.Core.XML.SaxWriter Reset ()
Returns OpenEdge.Core.XML.SaxWriter
Top

OpenEdge.Core.XML.SaxWriter SetEncoding (character)
Parameters:
pcEncoding CHARACTER
Returns OpenEdge.Core.XML.SaxWriter
Top

OpenEdge.Core.XML.SaxWriter SetIsFormatted (logical)
Parameters:
plIsFormatted LOGICAL
Returns OpenEdge.Core.XML.SaxWriter
Top

OpenEdge.Core.XML.SaxWriter SetIsFragment (logical)
Parameters:
plIsFragment LOGICAL
Returns OpenEdge.Core.XML.SaxWriter
Top

OpenEdge.Core.XML.SaxWriter SetIsStandalone (logical)
Parameters:
plIsStandalone LOGICAL
Returns OpenEdge.Core.XML.SaxWriter
Top

OpenEdge.Core.XML.SaxWriter SetIsStrict (logical)
Parameters:
plIsStrict LOGICAL
Returns OpenEdge.Core.XML.SaxWriter
Top

OpenEdge.Core.XML.SaxWriter SetVersion (character)
/* Public property setter methods provided to enable a Fluent-style interface
( oSW:SetIsStrict(true):StartDocument(): ... )
Parameters:
pcVersion CHARACTER
Returns OpenEdge.Core.XML.SaxWriter
Top

OpenEdge.Core.XML.SaxWriter StartDocument ()
Returns OpenEdge.Core.XML.SaxWriter
Top

OpenEdge.Core.XML.SaxWriter StartElement (longchar)
Parameters:
pcName LONGCHAR
Returns OpenEdge.Core.XML.SaxWriter
Top

OpenEdge.Core.XML.SaxWriter StartElement (longchar, longchar)
Parameters:
pcName LONGCHAR
pcNamespaceURI LONGCHAR
Returns OpenEdge.Core.XML.SaxWriter
Top

OpenEdge.Core.XML.SaxWriter StartElement (longchar, longchar, handle)
Parameters:
pcName LONGCHAR
pcNamespaceURI LONGCHAR
phSaxAttributes HANDLE
Returns OpenEdge.Core.XML.SaxWriter
Top

ValidateCanUpdateProperty (character)
Parameters:
pcPropertyName CHARACTER
Top

OpenEdge.Core.XML.SaxWriter WriteDataElement (longchar, longchar)
Parameters:
pcName LONGCHAR
pcValue LONGCHAR
Returns OpenEdge.Core.XML.SaxWriter
Top

OpenEdge.Core.XML.SaxWriter WriteDataElement (longchar, longchar, longchar)
Parameters:
pcName LONGCHAR
pcValue LONGCHAR
pcNamespaceURI LONGCHAR
Returns OpenEdge.Core.XML.SaxWriter
Top

OpenEdge.Core.XML.SaxWriter WriteDataElement (longchar, longchar, longchar, handle)
Parameters:
pcName LONGCHAR
pcValue LONGCHAR
pcNamespaceURI LONGCHAR
phSaxAttributes HANDLE
Returns OpenEdge.Core.XML.SaxWriter
Top

OpenEdge.Core.XML.SaxWriter WriteEmptyElement (longchar)
Parameters:
pcName LONGCHAR
Returns OpenEdge.Core.XML.SaxWriter
Top

OpenEdge.Core.XML.SaxWriter WriteEmptyElement (longchar, longchar)
Parameters:
pcName LONGCHAR
pcNamespaceURI LONGCHAR
Returns OpenEdge.Core.XML.SaxWriter
Top

OpenEdge.Core.XML.SaxWriter WriteEmptyElement (longchar, longchar, handle)
Parameters:
pcName LONGCHAR
pcNamespaceURI LONGCHAR
phSaxAttributes HANDLE
Returns OpenEdge.Core.XML.SaxWriter
Top

OpenEdge.Core.XML.SaxWriter WriteExternalDTD (longchar, longchar)
Parameters:
pcName LONGCHAR
pcSystemId LONGCHAR
Returns OpenEdge.Core.XML.SaxWriter
Top

OpenEdge.Core.XML.SaxWriter WriteExternalDTD (longchar, longchar, longchar)
Parameters:
pcName LONGCHAR
pcSystemId LONGCHAR
pcPublicId LONGCHAR
Returns OpenEdge.Core.XML.SaxWriter
Top

OpenEdge.Core.XML.SaxWriter WriteFragment (handle)
Purpose: Writes a fragment's values from a specified XML node ref
Parameters:
phNodeRef HANDLE
Returns OpenEdge.Core.XML.SaxWriter
logical Whether the operation succeeded or not.
Top

OpenEdge.Core.XML.SaxWriter WriteFragment (longchar)
Purpose: Writes a fragment's values from a specified XML node ref
Parameters:
pcValue LONGCHAR
Returns OpenEdge.Core.XML.SaxWriter
logical Whether the operation succeeded or not.
Top

OpenEdge.Core.XML.SaxWriter WriteProcessingInstruction (longchar, longchar)
Parameters:
pcTarget LONGCHAR
pcData LONGCHAR
Returns OpenEdge.Core.XML.SaxWriter
Top

OpenEdge.Core.XML.SaxWriter WriteTo (character)
Parameters:
pcFilename CHARACTER
Returns OpenEdge.Core.XML.SaxWriter
Top

OpenEdge.Core.XML.SaxWriter WriteTo (handle)
Parameters:
phStream HANDLE
Returns OpenEdge.Core.XML.SaxWriter
Top

OpenEdge.Core.XML.SaxWriter WriteTo (longchar)
Parameters:
pcDocument LONGCHAR
Returns OpenEdge.Core.XML.SaxWriter
Top

OpenEdge.Core.XML.SaxWriter WriteTo (memptr)
Parameters:
pmDocument MEMPTR
Returns OpenEdge.Core.XML.SaxWriter
Top

OpenEdge.Core.XML.SaxWriter WriteValue (longchar)
Purpose: Writes a value to the output destination. This method defaults to
writing characters.
Parameters:
pcValue LONGCHAR
Returns OpenEdge.Core.XML.SaxWriter
logical Whether the operation succeeded or not.
Top

OpenEdge.Core.XML.SaxWriter WriteValue (SaxWriterDataTypeEnum, longchar)
Purpose: Writes a value to the output destination. This method simply writes
the value for the given type, using the correct WRITE-* call.
There's a WriteFragment() method which deals with a noderef handle.
Parameters:
poType OpenEdge.Core.XML.SaxWriterDataTypeEnum
pcValue LONGCHAR
Returns OpenEdge.Core.XML.SaxWriter
logical Whether the operation succeeded or not.


Constructor Detail
Top

SaxWriter ()
Top

SaxWriter (character)
Parameters:
pcFilename CHARACTER
Top

SaxWriter (handle)
Parameters:
phStream HANDLE
Top

SaxWriter (longchar)
Parameters:
pcDocument LONGCHAR
Top

SaxWriter (memptr)
Parameters:
pmDocument MEMPTR


Property Detail
Top

CHARACTER Encoding
Purpose: Maps to SAX-WRITER ENCODING attribute. See the ABL documentation for more details.
Returns CHARACTER
Top

LOGICAL IsFormatted
Purpose: Maps to SAX-WRITER FORMATTED attribute. See the ABL documentation for more details.
Returns LOGICAL
Top

LOGICAL IsFragment
Purpose: Maps to SAX-WRITER FRAGMENT attribute. See the ABL documentation for more details.
Returns LOGICAL
Top

LOGICAL IsStandalone
Purpose: Maps to SAX-WRITER STANDALONE attribute. See the ABL documentation for more details.
Returns LOGICAL
Top

LOGICAL IsStrict
Purpose: Maps to SAX-WRITER STRICT attribute. See the ABL documentation for more details.
Returns LOGICAL
Top

CHARACTER Version
Purpose: Maps to SAX-WRITER VERSION attribute. See the ABL documentation for more details.
Returns CHARACTER
Top

OpenEdge.Core.XML.SaxWriteStatusEnum WriteStatus
Purpose: (derived) Maps to SAX-WRITER WRITE-STATUS attribute. See the ABL documentation for more details.
Returns OpenEdge.Core.XML.SaxWriteStatusEnum


Copyright © 2017 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 11.7