VersionSettings Class

This represents version settings for the VersionBuilderPlugIn.

Inheritance Hierarchy

SystemObject
SandcastleBuilder.PlugInsVersionSettings

Namespace: SandcastleBuilder.PlugIns
Assembly: SandcastleBuilder.PlugIns (in SandcastleBuilder.PlugIns.dll) Version: 2014.11.22.0

Syntax

public class VersionSettings

Public Class VersionSettings

public ref class VersionSettings

type VersionSettings =  class end

The VersionSettings type exposes the following members.

Constructors

	Name	Description
	VersionSettings	Constructor

Methods

	Name	Description
	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.)
	FromXPathNavigator	Create a version settings instance from an XPath navigator containing the settings.
	GetHashCode	This is overridden to return the hash code of the combined framework and version number. (Overrides ObjectGetHashCode.)
	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.)
	ToXml	Store the version settings as a node in the given XML document

Properties

	Name	Description
	FrameworkLabel	This is used to get or set the framework label for the related project.
	HelpFileProject	This is used to get or set the path to the help file builder project used to generate version information.
	ListDescription	This returns a description of the entry suitable for display in a bound list control.
	RipOldApis	Gets or sets a value indicating whether to remove old APIs from the final output.
	Version	This is used to get or set the version number description for the related project.