ProjectElement Class

This class is a wrapper for build items in the project.

Inheritance Hierarchy

SystemObject
SandcastleBuilder.UtilsProjectElement

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

Syntax

public sealed class ProjectElement

Public NotInheritable Class ProjectElement

public ref class ProjectElement sealed

[<SealedAttribute>]
type ProjectElement =  class end

The ProjectElement type exposes the following members.

Methods

	Name	Description
	Equals	Determines whether the specified Object is equal to the current Object. (Overrides ObjectEquals(Object).)
	GetHashCode	Serves as a hash function for a particular type. (Overrides ObjectGetHashCode.)
	GetMetadata	Get a metadata value from a project element
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	HasMetadata	See if the named metadata item exists
	RemoveFromProjectFile	Remove the item from the project
	SetMetadata	Set a metadata value in the project item
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Operators

	Name	Description
	Equality	Overload for equal operator
	Inequality	Overload for not equal operator

Fields

	Name	Description
	AlternateText	Alternate text
	BuildAction	Build action
	Configuration	Configuration setting
	CopyToMedia	Copy to media folder
	ExcludeFromToc	Exclude from table of contents
	Guid	Project COM object's GUID
	HintPath	File reference hint path
	ImageId	Image ID
	IncludePath	Include item
	LinkPath	Linked item path
	Name	Project name item
	OutDir	Output directory setting
	Platform	Platform setting
	ProjectGuid	Project GUID item
	ProjectName	Project name setting
	ReferenceOutputAssembly	Reference output assembly item
	SolutionDir	Solution directory
	SolutionExt	Solution extension
	SolutionFileName	Solution filename (no path)
	SolutionName	Solution name (no path or extension)
	SolutionPath	Solution path (directory and filename)
	SortOrder	Sort order
	VersionMajor	Project COM object's major version
	VersionMinor	Project COM object's minor version
	WrapperTool	Project COM object's wrapper tool

Properties

	Name	Description
	Include	This is used to set or get the filename (Include attribute)
	ItemName	This is used to set or get the item name (a.k.a BuildAction)
	Project	This read-only property is used to get the containing project