 | Automation |
Class AutomationMLContainer provides methods to save an AutomationML document and
related documents which are needed for the interpretation or representation of
AutomationML data into a single packed and zipped file. The various parts are
assembled into this AutomationMLContainer. The Class provides methods to retrieve
parts from a loaded container or for the assembly of parts into one single
container. A Utility, to build a self containing container from a loaded
CAEXDocument and the external referenced files, retrieved from the external
references and ExternalInterface classes is defined in a special service.
Inheritance HierarchyNamespace: Aml.Engine.AmlObjects
Assembly: Aml.Engine (in Aml.Engine.dll) Version: 3.2
SyntaxThe AutomationMLContainer type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | AutomationMLContainer(Stream) | Initializes a new instance of the AutomationMLContainer class using the specified stream resource. |
| AutomationMLContainer(String) | Initializes a new instance of the AutomationMLContainer class using the specified container file to load or save the package. |
| AutomationMLContainer(Stream, FileMode) | Initializes a new instance of the AutomationMLContainer class using the specified stream resource. |
| AutomationMLContainer(String, FileMode) | Initializes a new instance of the AutomationMLContainer class using the specified container file to load or save the package. |
| AutomationMLContainer(Stream, FileMode, FileAccess) | Initializes a new instance of the AutomationMLContainer class using the specified stream resource. |
| AutomationMLContainer(String, FileMode, FileAccess) | Initializes a new instance of the AutomationMLContainer class using the specified container file to load or save the package. |
| AutomationMLContainer(String, FileMode, FileAccess, FileShare) | Initializes a new instance of the AutomationMLContainer class using the specified container file to load or save the package. |
Properties| Name | Description | |
|---|---|---|
 | CompressionMode | Gets or sets the compression mode which is Normal by default. |
| ContainerFilename | Gets the full path of the used container file. |
| ExtractionDirectory | Gets the full path of the directory, used for extraction. |
| FilePath | Gets the full path of the used container file. |
| Package | Gets the underlying package of this instance. |
Methods| Name | Description | |
|---|---|---|
| AddAnyContent(PackagePart, Stream, Uri, String, Boolean) | Adds any content from the specified stream resource to the package creating relationships to the package and to the part, containing the root document using the relationship type AnyContent. |
| AddAnyContent(PackagePart, String, Uri, String, Boolean) | Adds any content to the package creating relationships to the package and to the part, containing the root document using the relationship type AnyContent. |
| AddCAEXSchema(Stream, Uri) | Adds a CAEX schema part retrieved from a stream resource to the package and creates a package - part relationship to the package using the relationship type CAEXSchema. |
| AddCAEXSchema(String, Uri) | Adds a CAEX schema file to the package and creates a package - part relationship to the package using the relationship type CAEXSchema |
| AddCollada(PackagePart, Stream, Uri, Boolean) | Adds a COLLADA part read from the specified stream resource to the package and creates relationships to the package and to the root document using the Collada. |
| AddCollada(PackagePart, String, Uri, Boolean) | Adds a COLLADA file to the package and creates relationships to the package and to the root document using the Collada. |
| AddColladaSchema(Stream, Uri) | Adds a COLLADA schema part from the stream resource to the package and creates a package - part relationship to the package using ColladaSchema. |
| AddColladaSchema(String, Uri) | Adds a COLLADA schema file to the package and creates a package - part relationship to the package using ColladaSchema. |
| AddLibrary(Stream, Uri) | Adds a library stream to the package and creates a package - part relationship of type Library. |
| AddLibrary(String, Uri) | Adds a library file to the package and creates a package - part relationship of type Library. |
| AddLibrary(PackagePart, Stream, Uri, Boolean) | Adds a library from a stream resource to the package and creates relationships to the package and to the part containing the root document using the relationship type Library. |
| AddLibrary(PackagePart, String, Uri, Boolean) | Adds a library file to the package and creates relationships to the package and to the package containing the root document using the Library. |
| AddPLCopenXml(PackagePart, Stream, Uri, Boolean) | Adds a PLCopenXml part read from a stream resource to the package and creates relationships to the package and to the package part containing the root document using the relationship type PLCopenXml. |
| AddPLCopenXml(PackagePart, String, Uri, Boolean) | Adds a PLCopenXml file to the package and creates relationships to the package and to the package part containing the root document using the relationship type PLCopenXml. |
| AddPLCopenXmlSchema(Stream, Uri) | Adds a PLCopenXml schema part from a stream resource to the package and creates a package - part relationship of type PLCopenXmlSchema. |
| AddPLCopenXmlSchema(String, Uri) | Adds a PLCopenXml schema file to the package and creates a package - part relationship of type PLCopenXmlSchema to the package. |
| AddRoot(Stream, Uri) | Adds a root AML file from a stream resource to the package and creates a package - part relationship of type Root. |
| AddRoot(String, Uri) | Adds a root AML file to the package and creates a package - part relationship of type Root. |
| CheckRelatedParts | Returns an enumeration of the related parts for the specified part and relationship type. |
| Close | Saves and closes the package and all part streams. |
| Dispose | Performs application-defined tasks associated with the release, return or resetting of unmanaged resources. |
| Extract(DirectoryInfo) | Extracts all parts in the package to the specified directory |
| Extract(DirectoryInfo, PackagePart) | Extracts the specified part in the package to the specified directory. |
| ExtractAllFiles | Extracts all parts in the package to the specified directory |
| Flush | Saves the contents of all parts and relationships, contained in the package. |
| GetPart | Returns the part with the given URI. |
| GetParts | Returns an enumeration of all parts inside the package. |
| GetPartsByRelationShipType | Returns an enumeration of all parts with the given relationship type from the package. |
| GetRelatedPartByUri | Gets the related part by URI. |
| GetRelatedParts(PackagePart) | Returns an enumeration of all related parts for the given part. |
| GetRelatedParts(PackagePart, AutomationMLContainerRelationshipType) | Returns an enumeration of the related parts for the specified part and relationship type. |
| GetRelationShips | Returns an enumeration of all contained relationships of this instance. |
| GetRelationShipsByType | Returns an enumeration of all relationships with the given relationship type. |
| PartExists | Determines, if a part with the specified part URI exists. |
| RelationShipExists | Determines, if the specified relationship type exists. |
| RelinkPart(Uri, Uri) | Obsolete. Changes the Uri of a package part. The part is removed and readded with the provided newPartUri. All relationships of the part are updated. |
| RelinkPart(PackagePart, PackagePart, Uri) | Changes the Uri of a package part. The part is removed and readded with the provided newPartUri. All relationships of the part are updated. If a related Part is defined, with the provided part as a target, the relations are redefined. |
| RootDocumentPath | Gets the file path to the first root AML document when the container is already extracted. Extract(DirectoryInfo) If the container is created from a stream source or no root document is found, the return value is string.Empty. |
| RootDocumentStream | Gets the stream of the first root AML document. If no root document is found, the return value is null. |
| Save | Saves the package and all part streams, the package is still open. |
Fields| Name | Description | |
|---|---|---|
  | AutomationMLMimeType | The AutomationML MIME type |
See Also