Sandcastle Help File Builder Documentation
IFile
This defines the interface used to interact with a file item in a help file builder project
Definition
Namespace: Sandcastle.Core.Project
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2025.9.30.0
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2025.9.30.0
C#
public interface IFileItemVB
Public Interface IFileItemC++
public interface class IFileItemF#
type IFileItem = interface endProperties
| AlternateText | This is used to get or set alternate text for an image |
| BuildAction | This is used to get or set the build action of the item |
| FullPath | This read-only property 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 |
| IncludePath | This is used to get or set the filename (the Include path) |
| LinkPath | This is used to get or set the link path |
| Project | This read-only property is used to get the containing project |
Methods
| RemoveFromProjectFile | Remove the item from the containing project |
| ToContentFile | This is used to convert the file item to a ContentFile instance |