 | 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.
Inheritance HierarchySystemObject
SandcastleBuilder.UtilsPropertyBasedCollectionItem
SandcastleBuilder.UtilsNamespaceSummaryItem
SandcastleBuilder.UtilsPropertyBasedCollectionItem
SandcastleBuilder.UtilsNamespaceSummaryItem
Namespace: SandcastleBuilder.Utils
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2014.11.22.0
SyntaxThe NamespaceSummaryItem 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 | (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 |
Return the namespace name as the string representation of the object
(Overrides ObjectToString.) |
Properties| Name | Description | |
|---|---|---|
 | IsDirty |
This is used to get or set the dirty state of the item
(Inherited from PropertyBasedCollectionItem.) |
| 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
|
| ProjectFile |
This is used to get the owning project file
(Inherited from PropertyBasedCollectionItem.) |
| Summary |
This is used to get or set the namespace summary comments
|
See Also