C# Class Mono.Addins.Description.AddinDescription

Inheritance: IBinaryXmlElement

Show file Open project: mono/mono-addins Class Usage Examples

Private Properties

Property	Type	Description
AddinDescription	System
FilesChanged	bool
FindExtensionNode	Mono.Addins.Description.ExtensionNodeDescription
GetBool	bool
IBinaryXmlElement	void
IBinaryXmlElement	void
Merge	AddinDescription
MergeExternalData	void
ParseString	string
ReadBinary	AddinDescription
ResetXmlDoc	void
SaveBinary	void
SaveBinary	void
SaveCoreProperty	void
SaveXml	void
SetBasePath	void
SetExtensionsAddinId	void
StoreFileInfo	void
SupportsVersion	bool
TransferCoreProperties	void
UnmergeExternalData	void
Verify	System.Collections.Specialized.StringCollection

Public Methods

Method	Description
AddExtensionPoint ( string path ) : ExtensionPoint	Adds an extension point.
Read ( Stream stream, string basePath ) : AddinDescription	Load an add-in description from a stream
Read ( TextReader reader, string basePath ) : AddinDescription	Load an add-in description from a text reader
Read ( string configFile ) : AddinDescription	Load an add-in description from a file
Save ( ) : void	Saves the add-in description. The description is saved to the file specified in the FileName property.
Save ( string fileName ) : void	Saves the add-in description. Saves the add-in description to the specified file and sets the FileName property.
SaveToXml ( ) : XmlDocument	Generates an XML representation of the add-in description
Verify ( ) : StringCollection	Verify this instance. This method checks all the definitions in the description and returns a list of errors. If the returned list is empty, it means that the description is valid.

Private Methods

Method	Description
AddinDescription ( ) : System
FilesChanged ( ) : bool
FindExtensionNode ( string path, bool lookInDeps ) : Mono.Addins.Description.ExtensionNodeDescription
GetBool ( string s, bool defval ) : bool
IBinaryXmlElement ( Mono.Addins.Serialization.BinaryXmlReader reader ) : void
IBinaryXmlElement ( Mono.Addins.Serialization.BinaryXmlWriter writer ) : void
Merge ( AddinDescription desc1, AddinDescription desc2 ) : AddinDescription
MergeExternalData ( AddinDescription other ) : void
ParseString ( string input ) : string
ReadBinary ( Mono.Addins.Database.FileDatabase fdb, string configFile ) : AddinDescription
ResetXmlDoc ( ) : void
SaveBinary ( Mono.Addins.Database.FileDatabase fdb ) : void
SaveBinary ( Mono.Addins.Database.FileDatabase fdb, string file ) : void
SaveCoreProperty ( XmlElement elem, string val, string attr, string prop ) : void
SaveXml ( ) : void
SetBasePath ( string path ) : void
SetExtensionsAddinId ( string addinId ) : void
StoreFileInfo ( ) : void
SupportsVersion ( string ver ) : bool
TransferCoreProperties ( bool removeProperties ) : void
UnmergeExternalData ( Hashtable addins ) : void
Verify ( Mono.Addins.Database.AddinFileSystemExtension fs ) : StringCollection

Method Details

AddExtensionPoint() public method

Adds an extension point.

public AddExtensionPoint ( string path ) : ExtensionPoint
path	string	/// Path that identifies the new extension point. ///
return	ExtensionPoint

Read() public static method

Load an add-in description from a stream

public static Read ( Stream stream, string basePath ) : AddinDescription
stream	Stream	/// The stream ///
basePath	string	/// The path to be used to resolve relative file paths. ///
return	AddinDescription

Read() public static method

Load an add-in description from a text reader

public static Read ( TextReader reader, string basePath ) : AddinDescription
reader	System.IO.TextReader	/// The text reader ///
basePath	string	/// The path to be used to resolve relative file paths. ///
return	AddinDescription

Read() public static method

Load an add-in description from a file

public static Read ( string configFile ) : AddinDescription
configFile	string	/// The file. ///
return	AddinDescription

Save() public method

Saves the add-in description.

The description is saved to the file specified in the FileName property.

/// It is thrown if FileName is not set ///

public Save ( ) : void
return	void

Save() public method

Saves the add-in description.

Saves the add-in description to the specified file and sets the FileName property.

public Save ( string fileName ) : void
fileName	string	/// File name where to save this instance ///
return	void

SaveToXml() public method

Generates an XML representation of the add-in description

public SaveToXml ( ) : XmlDocument
return	System.Xml.XmlDocument

Verify() public method

Verify this instance.

This method checks all the definitions in the description and returns a list of errors. If the returned list is empty, it means that the description is valid.

public Verify ( ) : StringCollection
return	System.Collections.Specialized.StringCollection