NamespaceSummaryItem Class

This represents a a namespace summary item that can be used to add comments to a namespace in the help file or exclude it completely from the help file.

Definition

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

C#View Source Request Example

public class NamespaceSummaryItem : INotifyPropertyChanged

VBView Source Request Example

Public Class NamespaceSummaryItem
	Implements INotifyPropertyChanged

C++View Source Request Example

public ref class NamespaceSummaryItem : INotifyPropertyChanged

F#View Source Request Example

type NamespaceSummaryItem = 
    class
        interface INotifyPropertyChanged
    end

Inheritance: Object NamespaceSummaryItem

Implements: INotifyPropertyChanged

Constructors

NamespaceSummaryItem

Constructor

Properties

IsDirty	This read-only property can be used to determine if the namespace summary item was changed
IsDocumented	This is used to get or set whether or not the namespace is included in the help file
IsGroup	This read-only property is used to check whether or not this is a namespace group
Name	This read-only property is used to get the namespace name
Summary	This is used to get or set the namespace summary comments

Methods

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 the default hash function. (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	Return the namespace name as the string representation of the object (Overrides ObjectToString)

Events

PropertyChanged

Occurs when a property value changes.