Sandcastle Help File Builder Documentation
File
This event arguments class is used by build components to indicate that they have saved a file of some
sort (help content or fragment). The event handler is responsible for figuring out what to do with the
event.
Definition
Namespace: Sandcastle.Tools.BuildComponents
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2024.2.18.0
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2024.2.18.0
C#
public class FileCreatedEventArgs : EventArgsVB
Public Class FileCreatedEventArgs
Inherits EventArgsC++
public ref class FileCreatedEventArgs : public EventArgsF#
type FileCreatedEventArgs =
class
inherit EventArgs
endConstructors
| FileCreatedEventArgs | Constructor |
Properties
| ComponentId | This read-only property returns the ID of the component that saved the file |
| FilePath | This read-only property returns the path to the saved file |
| GroupId | This read-only property returns the group ID of the component that saved the file |
| IsContentFile | This read-only property indicates whether or not the file is a help content file |
| Key | This read-only property returns the topic key or null if not saved while generating a specific topic |
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 | Returns a string that represents the current object. (Inherited from Object) |