ProjectElement Class

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

Definition

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

public class ProjectElement : INotifyPropertyChanged

Public Class ProjectElement
	Implements INotifyPropertyChanged

public ref class ProjectElement : INotifyPropertyChanged

type ProjectElement = 
    class
        interface INotifyPropertyChanged
    end

ProjectElement(SandcastleProject, ProjectItem)	This constructor is used to wrap an existing project item
ProjectElement(SandcastleProject, String, String)	This constructor is used to create a new build item and add it to the project

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

Equals	Determines whether the specified object is equal to the current object. (Overrides ObjectEquals(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 the default hash function. (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
MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
OnPropertyChanged	This raises the PropertyChanged event
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)

The property changed event

Equality(ProjectElement, ProjectElement)	Overload for equal operator
Inequality(ProjectElement, ProjectElement)	Overload for not equal operator