Sandcastle Help File Builder Documentation
File
This class represents a file that is part of the project (MAML/additional content, site map, style
sheet, etc.).
Definition
Namespace: SandcastleBuilder.Utils
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2024.12.21.0
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2024.12.21.0
C#
public class FileItem : ProjectElement, ICustomTypeDescriptorVB
Public Class FileItem
Inherits ProjectElement
Implements ICustomTypeDescriptorC++
public ref class FileItem : public ProjectElement,
ICustomTypeDescriptorF#
type FileItem =
class
inherit ProjectElement
interface ICustomTypeDescriptor
end- Inheritance
- Object ProjectElement FileItem
- Implements
- ICustomTypeDescriptor
Properties
| 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 |
| 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 attribute)
(Inherited from ProjectElement) |
| IncludePath | This is used to set or get the filename (include path) |
| ItemType |
This is used to set or get the item type (a.k.a BuildAction)
(Inherited from ProjectElement) |
| LinkPath | This is used to set or get the link path |
| Name | This is used to set or get the name of the item |
| Project |
This read-only property is used to get the containing project
(Inherited from ProjectElement) |
| SortOrder | This is used to get or set the sort order for content layout and site map files |
Methods
| Equals | Determines whether the specified object is equal to the current object. (Inherited from ProjectElement) |
| 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 the default hash function. (Inherited from ProjectElement) |
| GetMetadata |
Get a metadata value from a project element
(Inherited from ProjectElement) |
| 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) |
| HasMetadata |
See if the named metadata item exists
(Inherited from ProjectElement) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| OnPropertyChanged |
This raises the PropertyChanged event
(Inherited from ProjectElement) |
| RefreshPaths | Refresh the paths due to a parent path being renamed |
| RemoveFromProjectFile |
Remove the item from the project
(Inherited from ProjectElement) |
| SetMetadata |
Set a metadata value in the project item
(Inherited from ProjectElement) |
| ToContentFile | This is used to convert the file item to a ContentFile instance |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
Events
| PropertyChanged |
The property changed event
(Inherited from ProjectElement) |