Package Class

Package Class

Represents a directory that contains other directories (packages) or documents (otx files).

Inheritance Hierarchy

SystemObject
Emotive.Otx.ApiPackage

Namespace: Emotive.Otx.Api
Assembly: Emotive.Otx.Api (in Emotive.Otx.Api.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

C++

Copy

public class Package : ICloneable

Public Class Package
	Implements ICloneable

public ref class Package : ICloneable

type Package =  
    class
        interface ICloneable
    end

The Package type exposes the following members.

Constructors

	Name	Description
	Package	Initializes a new instance of the Package class.

Top

Methods

	Name	Description
	AddDocument	Adds a document into this package.
	AddExistingDocument(String)	Adds an existing otx document into this package.
	AddExistingDocument(String, String)	Adds an existing otx document with a new name into this package.
	AddExistingPackage(String)	Adds an existing package with a new name into this package skipping all invalid otx files.
	AddExistingPackage(String, String)	Adds an existing package with a new name into this package skipping all invalid otx files.
	AddPackage	Adds a into this package.
	Clone	Clone this package.
	ContainsDocument	Checks if this package contains a document.
	ContainsPackage	Checks if this package contains a child package.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetDocument	Gets a document inside parent package.
	GetDocuments(String)	Gets an array of documents matching the specified search pattern from the current package.
	GetDocuments(String, SearchOption)	Gets an array of documents matching the specified search pattern from the current package, using a value to determine whether to search subpackages.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetPackage	Gets a child package from this package.
	GetPackages(String)	Gets an array of packages matching the specified search pattern from the current package.
	GetPackages(String, SearchOption)	Gets an array of packages matching the specified search pattern from the current package, using a value to determine whether to search subpackages.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	RemoveDocument(String)	Removes a document from this package by the given document name.
	RemoveDocument(Document)	Removes a document from this package.
	RemovePackage(String)	Removes a child package from this package by the given package name.
	RemovePackage(Package)	Removes a child package from this package.
	Rename	Renames this package and adapts its otx contents.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Properties

	Name	Description
	Documents	Gets and sets documents list.
	FullName	Gets full name of package. Format: Package1.Package2.Package3
	Name	Gets and sets package name.
	Packages	Gets and sets child package list.
	Parent	Gets the parent of this package.

Top

Reference

Emotive.Otx.Api Namespace