 | FileItem Class |
This class represents a file that is part of the project
(MAML/additional content, site map, stylesheet, etc.).
Inheritance HierarchyNamespace: SandcastleBuilder.Utils
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2014.11.22.0
SyntaxThe FileItem type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | 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.) |
| GetAttributes | Returns a collection of custom attributes for this instance of a component. |
| GetClassName | Returns the class name of this instance of a component. |
| GetComponentName | Returns the name of this instance of a component. |
| GetConverter | Returns a type converter for this instance of a component. |
| GetDefaultEvent | Returns the default event for this instance of a component. |
| GetDefaultProperty | Returns the default property for this instance of a component. |
| GetEditor | Returns an editor of the specified type for this instance of a component. |
| GetEvents | Returns the events for this instance of a component. |
| GetEvents(Attribute) | Returns the events for this instance of a component using the specified attribute array as a filter. |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetProperties | Returns the properties for this instance of a component. |
| GetProperties(Attribute) | Returns the properties for this instance of a component using the attribute array as a filter. |
| GetPropertyOwner | Returns an object that contains the property described by the specified property descriptor. |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| RefreshPaths |
Refresh the paths due to a parent path being renamed
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Properties| Name | Description | |
|---|---|---|
 | AlternateText |
This is used to get or set alternate text for an image
|
| BuildAction |
This is used to set or get the build action of the item
|
| CopyToMedia |
This is used to get or set whether an item is copied to the output
folder during a build.
|
| ExcludeFromToc |
For content items such as HTML pages, this is used to get or set
whether or not the item is excluded from the table of contents.
|
| FullPath |
This is used to get the full path to the item
|
| ImageId |
This is used to get or set an ID for a conceptual content image
|
| Include |
This is used to set or get the filename (include path)
|
| Link |
This is used to set or get the link path
|
| Name |
This is used to set or get the name of the item
|
| ProjectElement |
This returns the project element associated with the instance
(Inherited from BaseBuildItem.) |
| SortOrder |
This is used to get or set the sort order for content layout and
site map files.
|
See Also