Click or drag to resize

DocumentDataItemClass Class

SOWI Data XML based of System XML Document
Inheritance Hierarchy
SystemObject
  System.XmlXmlNode
    System.XmlXmlDocument
      SOWIData.XMLDocumentDataItemClass
        SOWIData.XMLIndexer

Namespace:  SOWIData.XML
Assembly:  SOWIData.XML (in SOWIData.XML.dll) Version: 19.1.23.1 (19.1.23.622)
Syntax
public class Document<DataItemClass> : XmlDocument

Type Parameters

DataItemClass
Data item class.

Important: the class must a parameterless constructor.

The DocumentDataItemClass type exposes the following members.

Constructors
  NameDescription
Public methodDocumentDataItemClass
Initializes a new instance of the DocumentDataItemClass class. Constructor without parameter
Top
Properties
  NameDescription
Public propertyAttributes
Gets an XmlAttributeCollection containing the attributes of this node.
(Inherited from XmlNode.)
Public propertyBaseURI
Gets the base URI of the current node.
(Inherited from XmlDocument.)
Public propertyChildNodes
Gets all the child nodes of the node.
(Inherited from XmlNode.)
Public propertyDocumentElement
Gets the root XmlElement for the document.
(Inherited from XmlDocument.)
Public propertyDocumentType
Gets the node containing the DOCTYPE declaration.
(Inherited from XmlDocument.)
Public propertyFileName
XML file to loads. Puts from class constructor parameter
Public propertyFirstChild
Gets the first child of the node.
(Inherited from XmlNode.)
Public propertyHasChildNodes
Gets a value indicating whether this node has any child nodes.
(Inherited from XmlNode.)
Public propertyImplementation
Gets the XmlImplementation object for the current document.
(Inherited from XmlDocument.)
Public propertyInnerText
Gets the concatenated values of the node and all its child nodes.
(Inherited from XmlDocument.)
Public propertyInnerXml
Gets or sets the markup representing the children of the current node.
(Inherited from XmlDocument.)
Public propertyIsReadOnly
Gets a value indicating whether the current node is read-only.
(Inherited from XmlDocument.)
Public propertyItemString
Gets the first child element with the specified Name.
(Inherited from XmlNode.)
Public propertyItemString, String
Gets the first child element with the specified LocalName and NamespaceURI.
(Inherited from XmlNode.)
Public propertyLastChild
Gets the last child of the node.
(Inherited from XmlNode.)
Public propertyLocalName
Gets the local name of the node.
(Inherited from XmlDocument.)
Public propertyName
Gets the qualified name of the node.
(Inherited from XmlDocument.)
Public propertyNamespaceURI
Gets the namespace URI of this node.
(Inherited from XmlNode.)
Public propertyNameTable
Gets the XmlNameTable associated with this implementation.
(Inherited from XmlDocument.)
Public propertyNextSibling
Gets the node immediately following this node.
(Inherited from XmlNode.)
Public propertyNodeType
Gets the type of the current node.
(Inherited from XmlDocument.)
Public propertyOuterXml
Gets the markup representing this node and all its child nodes.
(Inherited from XmlNode.)
Public propertyOwnerDocument
Gets the XmlDocument to which the current node belongs.
(Inherited from XmlDocument.)
Public propertyParentNode
Gets the parent node of this node (for nodes that can have parents).
(Inherited from XmlDocument.)
Public propertyPrefix
Gets or sets the namespace prefix of this node.
(Inherited from XmlNode.)
Public propertyPreserveWhitespace
Gets or sets a value indicating whether to preserve white space in element content.
(Inherited from XmlDocument.)
Public propertyPreviousSibling
Gets the node immediately preceding this node.
(Inherited from XmlNode.)
Public propertySchemaInfo
Returns the Post-Schema-Validation-Infoset (PSVI) of the node.
(Inherited from XmlDocument.)
Public propertySchemas
Gets or sets the XmlSchemaSet object associated with this XmlDocument.
(Inherited from XmlDocument.)
Public propertyValue
Gets or sets the value of the node.
(Inherited from XmlNode.)
Public propertyXmlResolver
Sets the XmlResolver to use for resolving external resources.
(Inherited from XmlDocument.)
Top
Methods
  NameDescription
Private methodAddDataItem
Adds a data item to this XML Document
Public methodAppendChild
Adds the specified node to the end of the list of child nodes, of this node.
(Inherited from XmlNode.)
Public methodClone
Creates a duplicate of this node.
(Inherited from XmlNode.)
Public methodCloneNode
Creates a duplicate of this node.
(Inherited from XmlDocument.)
Public methodCreateAttribute(String)
Creates an XmlAttribute with the specified Name.
(Inherited from XmlDocument.)
Public methodCreateAttribute(String, String)
Creates an XmlAttribute with the specified qualified name and NamespaceURI.
(Inherited from XmlDocument.)
Public methodCreateAttribute(String, String, String)
Creates an XmlAttribute with the specified Prefix, LocalName, and NamespaceURI.
(Inherited from XmlDocument.)
Public methodCreateCDataSection
Creates an XmlCDataSection containing the specified data.
(Inherited from XmlDocument.)
Public methodCreateComment
Creates an XmlComment containing the specified data.
(Inherited from XmlDocument.)
Protected methodCreateDefaultAttribute
Creates a default attribute with the specified prefix, local name and namespace URI.
(Inherited from XmlDocument.)
Public methodCreateDocumentFragment (Inherited from XmlDocument.)
Public methodCreateDocumentType
Returns a new XmlDocumentType object.
(Inherited from XmlDocument.)
Public methodCreateElement(String)
Creates an element with the specified name.
(Inherited from XmlDocument.)
Public methodCreateElement(String, String)
Creates an XmlElement with the qualified name and NamespaceURI.
(Inherited from XmlDocument.)
Public methodCreateElement(String, String, String)
Creates an element with the specified Prefix, LocalName, and NamespaceURI.
(Inherited from XmlDocument.)
Public methodCreateEntityReference
Creates an XmlEntityReference with the specified name.
(Inherited from XmlDocument.)
Public methodCreateNavigator
Creates a new XPathNavigator object for navigating this document.
(Inherited from XmlDocument.)
Protected methodCreateNavigator(XmlNode)
Creates an XPathNavigator object for navigating this document positioned on the XmlNode specified.
(Inherited from XmlDocument.)
Public methodCreateNode(String, String, String)
Creates an XmlNode with the specified node type, Name, and NamespaceURI.
(Inherited from XmlDocument.)
Public methodCreateNode(XmlNodeType, String, String)
Creates an XmlNode with the specified XmlNodeType, Name, and NamespaceURI.
(Inherited from XmlDocument.)
Public methodCreateNode(XmlNodeType, String, String, String)
Creates a XmlNode with the specified XmlNodeType, Prefix, Name, and NamespaceURI.
(Inherited from XmlDocument.)
Public methodCreateProcessingInstruction
Creates an XmlProcessingInstruction with the specified name and data.
(Inherited from XmlDocument.)
Public methodCreateSignificantWhitespace
Creates an XmlSignificantWhitespace node.
(Inherited from XmlDocument.)
Public methodCreateTextNode
Creates an XmlText with the specified text.
(Inherited from XmlDocument.)
Public methodCreateWhitespace
Creates an XmlWhitespace node.
(Inherited from XmlDocument.)
Public methodCreateXmlDeclaration
Creates an XmlDeclaration node with the specified values.
(Inherited from XmlDocument.)
Public methodDelete
Deletes data item
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodExistOne
Check exist one data item
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetBy
Gives a data item when exist by criterion
Public methodGetElementById
Gets the XmlElement with the specified ID.
(Inherited from XmlDocument.)
Public methodGetElementsByTagName(String)
Returns an XmlNodeList containing a list of all descendant elements that match the specified Name.
(Inherited from XmlDocument.)
Public methodGetElementsByTagName(String, String)
Returns an XmlNodeList containing a list of all descendant elements that match the specified LocalName and NamespaceURI.
(Inherited from XmlDocument.)
Public methodGetEnumerator
Provides support for the for each style iteration over the nodes in the XmlNode.
(Inherited from XmlNode.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Private methodGetItemsNodeName
Gives name of data item class include namespace and add .Items
Public methodGetList
Gives a list of data item class
Public methodGetNamespaceOfPrefix
Looks up the closest xmlns declaration for the given prefix that is in scope for the current node and returns the namespace URI in the declaration.
(Inherited from XmlNode.)
Public methodGetPrefixOfNamespace
Looks up the closest xmlns declaration for the given namespace URI that is in scope for the current node and returns the prefix defined in that declaration.
(Inherited from XmlNode.)
Private methodCode exampleGetProperty
Gives a property from object properties
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodImportNode
Imports a node from another document to the current document.
(Inherited from XmlDocument.)
Public methodInsert
Insert a data item to XML file
Public methodInsertAfter
Inserts the specified node immediately after the specified reference node.
(Inherited from XmlNode.)
Public methodInsertBefore
Inserts the specified node immediately before the specified reference node.
(Inherited from XmlNode.)
Private methodIsEqual
Checks two values whether is his equal
Public methodLoad(String)
Loads the XML document from the specified URL.
(Inherited from XmlDocument.)
Public methodLoad(Stream)
Loads the XML document from the specified stream.
(Inherited from XmlDocument.)
Public methodLoad(TextReader)
Loads the XML document from the specified TextReader.
(Inherited from XmlDocument.)
Public methodLoad(XmlReader)
Loads the XML document from the specified XmlReader.
(Inherited from XmlDocument.)
Public methodLoadXml
Loads the XML document from the specified string.
(Inherited from XmlDocument.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodNormalize
Puts all XmlText nodes in the full depth of the sub-tree underneath this XmlNode into a "normal" form where only markup (that is, tags, comments, processing instructions, CDATA sections, and entity references) separates XmlText nodes, that is, there are no adjacent XmlText nodes.
(Inherited from XmlNode.)
Public methodPrependChild
Adds the specified node to the beginning of the list of child nodes for this node.
(Inherited from XmlNode.)
Public methodReadNode
Creates an XmlNode object based on the information in the XmlReader. The reader must be positioned on a node or attribute.
(Inherited from XmlDocument.)
Public methodRemoveAll
Removes all the child nodes and/or attributes of the current node.
(Inherited from XmlNode.)
Public methodRemoveChild
Removes specified child node.
(Inherited from XmlNode.)
Public methodReplaceChild
Replaces the child node oldChild with newChild node.
(Inherited from XmlNode.)
Public methodSave(String)
Saves the XML document to the specified file.
(Inherited from XmlDocument.)
Public methodSave(Stream)
Saves the XML document to the specified stream.
(Inherited from XmlDocument.)
Public methodSave(TextWriter)
Saves the XML document to the specified TextWriter.
(Inherited from XmlDocument.)
Public methodSave(XmlWriter)
Saves the XML document to the specified XmlWriter.
(Inherited from XmlDocument.)
Public methodSelectNodes(String)
Selects a list of nodes matching the XPath expression.
(Inherited from XmlNode.)
Public methodSelectNodes(String, XmlNamespaceManager)
Selects a list of nodes matching the XPath expression. Any prefixes found in the XPath expression are resolved using the supplied XmlNamespaceManager.
(Inherited from XmlNode.)
Public methodSelectSingleNode(String)
Selects the first XmlNode that matches the XPath expression.
(Inherited from XmlNode.)
Public methodSelectSingleNode(String, XmlNamespaceManager)
Selects the first XmlNode that matches the XPath expression. Any prefixes found in the XPath expression are resolved using the supplied XmlNamespaceManager.
(Inherited from XmlNode.)
Public methodSupports
Test if the DOM implementation implements a specific feature.
(Inherited from XmlNode.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUpdate
Update a data item to XML file
Public methodValidate(ValidationEventHandler)
Validates the XmlDocument against the XML Schema Definition Language (XSD) schemas contained in the Schemas property.
(Inherited from XmlDocument.)
Public methodValidate(ValidationEventHandler, XmlNode)
Validates the XmlNode object specified against the XML Schema Definition Language (XSD) schemas in the Schemas property.
(Inherited from XmlDocument.)
Public methodWriteContentTo
Saves all the children of the XmlDocument node to the specified XmlWriter.
(Inherited from XmlDocument.)
Public methodWriteTo
Saves the XmlDocument node to the specified XmlWriter.
(Inherited from XmlDocument.)
Top
Events
  NameDescription
Public eventNodeChanged
Occurs when the Value of a node belonging to this document has been changed.
(Inherited from XmlDocument.)
Public eventNodeChanging
Occurs when the Value of a node belonging to this document is about to be changed.
(Inherited from XmlDocument.)
Public eventNodeInserted
Occurs when a node belonging to this document has been inserted into another node.
(Inherited from XmlDocument.)
Public eventNodeInserting
Occurs when a node belonging to this document is about to be inserted into another node.
(Inherited from XmlDocument.)
Public eventNodeRemoved
Occurs when a node belonging to this document has been removed from its parent.
(Inherited from XmlDocument.)
Public eventNodeRemoving
Occurs when a node belonging to this document is about to be removed from the document.
(Inherited from XmlDocument.)
Top
Extension Methods
  NameDescription
Public Extension MethodCode exampleAddXMLElement(XmlElement, String)Overloaded.
XML element add to XML document node.
(Defined by Helper.)
Public Extension MethodCode exampleAddXMLElementDataClass(Object, String, Boolean)Overloaded.
Create a XML node with XML elements from DataClass items and value from pDataItem. This added to XML document as XML node by name from parameter pAddToNode.
(Defined by Helper.)
Public Extension MethodCode exampleAddXMLElementListDataClass
Create a XML node with list of XML elements from DataClass items and value from parameter list pDataItemList. This added to XML document as XML node by name from parameter pAddToNode.
(Defined by Helper.)
Public Extension MethodGetObjectToBytes
Convert an object to byte array
(Defined by Extensions.)
Public Extension MethodCode exampleGetXMLElementDataClass(Object)Overloaded.
XML element value store to data item.
(Defined by Helper.)
Public Extension MethodCode exampleGetXMLElementDataClass(Object, Boolean)Overloaded.
XML node list of element value store to data item.
(Defined by Helper.)
Public Extension MethodCode exampleGetXMLElementListDataClass, DataClassForList
List of XML element store to list of data item.
(Defined by Helper.)
Public Extension MethodIsNumber
Check is value a number
(Defined by Convert.)
Public Extension MethodToHTMLDisplay(DataGrid, TempDataDictionary)Overloaded. (Defined by Extensions.)
Public Extension MethodCode exampleToHTMLDisplay(String, DataGridDataTypes, String, String, String, String, TempDataDictionary)Overloaded.
Gives HTML code for display.
(Defined by Extensions.)
Public Extension MethodToHTMLEditor(DataGrid, TempDataDictionary, String)Overloaded. (Defined by Extensions.)
Public Extension MethodToHTMLEditor(String, DataGridDataTypes, String, String, String, TempDataDictionary, Boolean, String, DataPlacements, String, String)Overloaded.
Gives HTML code for Input field
(Defined by Extensions.)
Public Extension MethodCode exampleToHTMLHidden(String)Overloaded.
Gives HTML code for hidden data
(Defined by Extensions.)
Public Extension MethodToHTMLHidden(DataGrid)Overloaded.
Gives HTML code for hidden data
(Defined by Extensions.)
Public Extension MethodXMLWriteOverloaded.
Gives XML string from object XMLDocument
(Defined by Helper.)
Public Extension MethodXMLWriteOverloaded.
Gives XML string from data item
(Defined by Helper.)
Top
Explicit Interface Implementations
Remarks
Data handling into XML element Data
Examples
A example of XML file structure
<Data>
  <SOWIData.XML.Test.TestObject.SOWIDataStandard.Items>
    <SOWIData.XML.Test.TestObject.SOWIDataStandard>
      <TestField>#DataValueIsNull</TestField>
      <ID>0</ID>
      <GUID>#DataValueIsNull</GUID>
      <ClientID>0</ClientID>
      <Name>TestSOWIDataXMLDocument_Insert on 20171209064603</Name>
      <Label>
      </Label>
      <Description>
      </Description>
      <DateTimeValue>#DataValueIsNull</DateTimeValue>
      <Value>0</Value>
      <Text>
      </Text>
      <Flag>False</Flag>
      <Checked>False</Checked>
      <Selection>0</Selection>
      <ColorUI>
      </ColorUI>
      <ActionText>Create</ActionText>
      <TaskText>Running</TaskText>
      <StatusText>None</StatusText>
      <CreateDate>#DataValueIsNull</CreateDate>
      <CreateUser>#DataValueIsNull</CreateUser>
      <LastEditDate>#DataValueIsNull</LastEditDate>
      <LastEditUser>#DataValueIsNull</LastEditUser>
      <DeleteDate>#DataValueIsNull</DeleteDate>
      <DeleteUser>#DataValueIsNull</DeleteUser>
      <Archive>False</Archive>
      <Help>
      </Help>
    </SOWIData.XML.Test.TestObject.SOWIDataStandard>
    <SOWIData.XML.Test.TestObject.SOWIDataStandard>
      <TestField>#DataValueIsNull</TestField>
      <ID>0</ID>
      <GUID>#DataValueIsNull</GUID>
      <ClientID>0</ClientID>
      <Name>TestSOWIDataXMLDocument_Insert on 20171209064627</Name>
      <Label>
      </Label>
      <Description>
      </Description>
      <DateTimeValue>#DataValueIsNull</DateTimeValue>
      <Value>0</Value>
      <Text>
      </Text>
      <Flag>False</Flag>
      <Checked>False</Checked>
      <Selection>0</Selection>
      <ColorUI>
      </ColorUI>
      <ActionText>Create</ActionText>
      <TaskText>Running</TaskText>
      <StatusText>None</StatusText>
      <CreateDate>#DataValueIsNull</CreateDate>
      <CreateUser>#DataValueIsNull</CreateUser>
      <LastEditDate>#DataValueIsNull</LastEditDate>
      <LastEditUser>#DataValueIsNull</LastEditUser>
      <DeleteDate>#DataValueIsNull</DeleteDate>
      <DeleteUser>#DataValueIsNull</DeleteUser>
      <Archive>False</Archive>
      <Help>
      </Help>
    </SOWIData.XML.Test.TestObject.SOWIDataStandard>
  </SOWIData.XML.Test.TestObject.SOWIDataStandard.Items>
</Data>
See Also