PlugInConfiguration Class

This collection class is used to hold a plug-in's configuration and enabled state

Inheritance Hierarchy

SystemObject
SandcastleBuilder.UtilsPropertyBasedCollectionItem
SandcastleBuilder.Utils.BuildComponentPlugInConfiguration

Namespace: SandcastleBuilder.Utils.BuildComponent
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2014.11.22.0

Syntax

public class PlugInConfiguration : PropertyBasedCollectionItem

Public Class PlugInConfiguration
	Inherits PropertyBasedCollectionItem

public ref class PlugInConfiguration : public PropertyBasedCollectionItem

type PlugInConfiguration =  
    class
        inherit PropertyBasedCollectionItem
    end

The PlugInConfiguration type exposes the following members.

Methods

	Name	Description
	CheckProjectIsEditable	This is used to see if the project can be edited. If not, abort the change by throwing an exception. (Inherited from PropertyBasedCollectionItem.)
	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.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Properties

	Name	Description
	Configuration	This is used to get or set the plug-in's configuration information
	Enabled	This is used to get or set the plug-in's enabled state
	IsDirty	This is used to get or set the dirty state of the item (Inherited from PropertyBasedCollectionItem.)
	ProjectFile	This is used to get the owning project file (Inherited from PropertyBasedCollectionItem.)