Click or drag to resize

DocumentVersions Class

The Class DocumentVersions defines extension methods for the CAEXFileType to retrieve and manipulate document versions attached to a CAEXFile. The DocumentVersion feature is described in the AutomationML BPR 06 "Naming of related documents and their versions" .
Inheritance Hierarchy
SystemObject
  Aml.Engine.AmlObjectsDocumentVersions

Namespace: Aml.Engine.AmlObjects
Assembly: Aml.Engine (in Aml.Engine.dll) Version: 3.2
Syntax
public static class DocumentVersions

The DocumentVersions type exposes the following members.

Methods
 NameDescription
Public Extension MethodAppendDocumentVersionInformation(CAEXFileType, DocumentVersionInformation, String) Appends the provided document version information to the AutomationML document
Public Extension MethodAppendDocumentVersionInformation(CAEXFileType, String, String, String) This function sets the DocumentVersion information for a referenced document. If DocumentVersion information about the same document Identifier already exists, this DocumentVersion information is replaced.
Public Extension MethodCreateDocumentVersionsHeader Creates the additional information representing a document versions header and appends it to the AutomationML document.
Public Extension MethodDeleteDocumentVersionInformation This function deletes all existing DocumentVersion information from the AutomationML document corresponding to the documentID.
Public Extension MethodDocumentVersionsHeader Get the Additional Information XML-Node from the CAEXFile, which represents the Document Versions node.
Public Extension MethodGetAllDocumentVersionInformation This methods returns an Enumeration of all Information related to document versions defined in the "DocumentVersions" information of an AutomationML document.
Public Extension MethodGetDocumentVersionInformation This function returns the DocumentVersion Information from the AutomationML document with the specified document Identifier, otherwise null.
Public Extension MethodReplaceDocumentVersionInformation This function replaces any existing DocumentVersion information corresponding to the identical oldDocumentID with the provided new DocumentVersion information.
Top
Fields
 NameDescription
Public fieldStatic memberDocumentElementName The document element name
Public fieldStatic memberDocumentIdentifierAttributeName The document identifier attribute name used in the Document element
Public fieldStatic memberDocumentVersionsAttributeName The document versions attribute name
Public fieldStatic memberDocumentVersionsAttributeValue The document versions attribute value
Public fieldStatic memberVersionAttributeName The version attribute name used in the document element
Top
See Also