SandcastleBuilder.PlugIns
This represents version settings for the .
This is used to see if the property
should be serialized.
True to serialize it, false if it matches the default
and should not be serialized. This property cannot be reset
as it should always have a value.
This is used to see if the property
should be serialized.
True to serialize it, false if it matches the default
and should not be serialized. This property cannot be reset
as it should always have a value.
Constructor
Create a version settings instance from an XPath navigator
containing the settings.
The base path provider object
The XPath navigator from which to
obtain the settings.
A object containing the
settings from the XPath navigator.
It should contain an element called version
with three attributes (label, version and
helpFileProject).
Store the version settings as a node in the given XML document
The XML document
The node in which to store the element
Returns the node that was added.
The version settings are stored in an element called
version with three attributes (label, version
and helpFileProject).
This is overridden to return the hash code of the combined
framework and version number.
The hash code for the version settings.
This is used to get or set the location of the reflection file
at build time.
This is used to get or set the framework label for the related
project.
This is used to group like versions of projects.
This is used to get or set the version number description for the
related project.
This is used to get or set the path to the help file builder
project used to generate version information.
The help file builder project makes it simple to manage
settings for the prior version's assemblies such as references,
API filter settings, etc.
This returns a description of the entry suitable for display in a
bound list control.
This form is used to configure the settings for the
.
Constructor
The current XML configuration
XML fragment
This is used to validate deployment location settings
The target location textbox to
validate
The user name textbox to validate
The password textbox to validate
The proxy server checkbox to
validate
The proxy user name textbox to
validate
The proxy password textbox to
validate
The default credentials
checkbox to validate
The proxy server checkbox to
validate
The proxy default credentials
checkbox to validate
The target location URI
The proxy server URI
True if the configuration is valid, false if not
Close without saving
The sender of the event
The event arguments
Go to the CodePlex home page of the Sandcastle Help File Builder
project.
The sender of the event
The event arguments
Enable or disable the user name and password controls based on
the Default Credentials check state.
The sender of the event
The event arguments
Enable or disable the proxy server settings based on the Use
Proxy Server check state.
The sender of the event
The event arguments
Enable or disable the proxy user credentials based on the Proxy
Default Credentials check state.
The sender of the event
The event arguments
Validate the configuration and save it
The sender of the event
The event arguments
Required designer variable.
Clean up any resources being used.
true if managed resources should be disposed; otherwise, false.
Required method for Designer support - do not modify
the contents of this method with the code editor.
This is used to return the configuration information
This class is used to specify user credentials.
Constructor
There are two overloads for the constructor.
Constructor
True to use default credentials, false to
use the supplied user name and password.
The user name to use.
The password to use.
Create a user credentials instance from an XPath navigator
containing the settings.
The XPath navigator from which to
obtain the settings.
A object containing the
settings from the XPath navigator.
It should contain an element called userCredentials
with three attributes: useDefault, userName, and
password.
Store the credentials as a node in the given XML document
The XML document
The node in which to store the element
Returns the node that was added or the one that
already existed in the document.
The credentials are stored in an element called
userCredentials with three attributes: useDefault,
userName, and password. It is created if it
does not already exist.
This is used to set or get the flag indicating whether or not to
use default credentials.
By default, this is true and and
will be ignored.
Get or set the user name
If is true, this will
be ignored.
Get or set the password
If is true, this will
be ignored.
This represents reference link settings for the
.
This is used to see if the property
should be serialized.
True to serialize it, false if it matches the default
and should not be serialized. This property cannot be reset
as it should always have a value.
Constructor
Create a reference link settings instance from an XPath navigator
containing the settings.
The base path provider object
The XPath navigator from which to
obtain the settings.
A object containing the
settings from the XPath navigator.
It should contain an element called target
with two attributes (linkType and helpFileProject).
Store the reference link settings as a node in the given XML
document.
The XML document
The node in which to store the element
Returns the node that was added.
The reference link settings are stored in an element
called target with two attributes (linkType and
helpFileProject).
This is used to get or set the location of the reflection file
at build time.
This is used to get or set the link type for the target
This is used to get or set the path to the help file builder
project used to generate reference link information.
The help file builder project makes it simple to manage
settings for the other target's assemblies such as references,
API filter settings, etc.
This returns a description of the entry suitable for display in a
bound list control.
This form is used to configure the settings for the
.
Required designer variable.
Clean up any resources being used.
true if managed resources should be disposed; otherwise, false.
Required method for Designer support - do not modify
the contents of this method with the code editor.
Constructor
The current XML configuration
XML fragment
Close without saving
The sender of the event
The event arguments
Go to the CodePlex home page of the Sandcastle Help File Builder
project.
The sender of the event
The event arguments
Enable or disable the user name and password controls based on
the Default Credentials check state.
The sender of the event
The event arguments
Validate the configuration and save it
The sender of the event
The event arguments
This is used to return the configuration information
This form is used to edit the
configuration.
Required designer variable.
Clean up any resources being used.
true if managed resources should be disposed; otherwise, false.
Required method for Designer support - do not modify
the contents of this method with the code editor.
Constructor
The current project
The current XML configuration
XML fragment
Close without saving
The sender of the event
The event arguments
Add a new help file builder project to the version settings.
The sender of the event
The event arguments
Delete a version settings item
The sender of the event
The event arguments
Update the property grid with the selected item
The sender of the event
The event arguments
Refresh the list box item when a property changes
The sender of the event
The event arguments
Validate the configuration and save it
The sender of the event
The event arguments
Launch the URL in the web browser
The sender of the event
The event arguments
This is used to return the configuration information
This form is used to configure the settings for the
.
Constructor
The current XML configuration
XML fragment
Close without saving
The sender of the event
The event arguments
Launch the URL in the web browser.
The sender of the event
The event arguments
Validate the configuration and save it
The sender of the event
The event arguments
Required designer variable.
Clean up any resources being used.
true if managed resources should be disposed; otherwise, false.
Required method for Designer support - do not modify
the contents of this method with the code editor.
This is used to return the configuration information
This form is used to edit the
configuration.
Constructor
The current project
The current XML configuration
XML fragment
Close without saving
The sender of the event
The event arguments
Add a new help file builder project to the reference link settings.
The sender of the event
The event arguments
Delete a reference links item
The sender of the event
The event arguments
Update the property grid with the selected item
The sender of the event
The event arguments
Refresh the list box item when a property changes
The sender of the event
The event arguments
Validate the configuration and save it
The sender of the event
The event arguments
Launch the URL in the web browser
The sender of the event
The event arguments
Required designer variable.
Clean up any resources being used.
true if managed resources should be disposed; otherwise, false.
Required method for Designer support - do not modify
the contents of this method with the code editor.
This is used to return the configuration information
This plug-in class can be used to rearrange the table of contents such
that namespaces are nested within their parent namespaces rather than
appearing as a flat list of all namespaces at the root level.
This method is used by the Sandcastle Help File Builder to let the
plug-in perform its own configuration.
A reference to the active project
The current configuration XML fragment
A string containing the new configuration XML fragment
The configuration data will be stored in the help file
builder project.
This method is used to initialize the plug-in at the start of the
build process.
A reference to the current build
process.
The configuration data that the plug-in
should use to initialize itself.
This method is used to execute the plug-in during the build process
The current execution context
This handles garbage collection to ensure proper disposal of the
plug-in if not done explicity with .
This implements the Dispose() interface to properly dispose of
the plug-in object.
There are two overloads for this method.
This can be overridden by derived classes to add their own
disposal code if necessary.
Pass true to dispose of the managed
and unmanaged resources or false to just dispose of the
unmanaged resources.
This read-only property returns a friendly name for the plug-in
This read-only property returns the version of the plug-in
This read-only property returns the copyright information for the
plug-in.
This read-only property returns a brief description of the plug-in
This plug-in does not run in partial builds
This read-only property returns a collection of execution points
that define when the plug-in should be invoked during the build
process.
This collection class is used to hold the binding redirect settings
information for the .
This is used to save the binding redirect settings list to the
configuration settings.
The XML configuration document.
The root configuration node
This is used to load the binding redirect settings list from the
configuration settings.
The base path provider object
The XPath navigator from which the
information is loaded.
This plug-in class is designed to add additional reference link
targets to the Reflection Index Data and Resolve Reference
Links build components so that links can be created to other third
party help in a Help 2 collection.
This method is used by the Sandcastle Help File Builder to let the
plug-in perform its own configuration.
A reference to the active project
The current configuration XML fragment
A string containing the new configuration XML fragment
The configuration data will be stored in the help file
builder project.
This method is used to initialize the plug-in at the start of the
build process.
A reference to the current build
process.
The configuration data that the plug-in
should use to initialize itself.
This is thrown if the plug-in
configuration is not valid.
This method is used to execute the plug-in during the build process
The current execution context
This is used to merge the reflection file info into the named
configuration file.
The configuration filename
True if it is the conceptual
configuration file or false if it is the reference configuration
file.
This handles garbage collection to ensure proper disposal of the
plug-in if not done explicity with .
This implements the Dispose() interface to properly dispose of
the plug-in object.
There are two overloads for this method.
This can be overridden by derived classes to add their own
disposal code if necessary.
Pass true to dispose of the managed
and unmanaged resources or false to just dispose of the
unmanaged resources.
This is called to build a project
The project to build
The working path for the project
Returns true if successful, false if not
This is called by the build process thread to update the
application with the current build step.
The sender of the event
The event arguments
This read-only property returns a friendly name for the plug-in
This read-only property returns the version of the plug-in
This read-only property returns the copyright information for the
plug-in.
This read-only property returns a brief description of the plug-in
This plug-in does not run in partial builds
This read-only property returns a collection of execution points
that define when the plug-in should be invoked during the build
process.
This plug-in class is used to copy the resulting help file output to
a location other than the output folder (i.e. a file share, an FTP
site, a web server, etc.).
This method is used by the Sandcastle Help File Builder to let the
plug-in perform its own configuration.
A reference to the active project
The current configuration XML fragment
A string containing the new configuration XML fragment
The configuration data will be stored in the help file
builder project.
This method is used to initialize the plug-in at the start of the
build process.
A reference to the current build
process.
The configuration data that the plug-in
should use to initialize itself.
This is thrown if the plug-in
configuration is not valid.
This method is used to execute the plug-in during the build process
The current execution context
Deploy the given list of files to the specified location
The list of files to deploy
The deployment location
This handles garbage collection to ensure proper disposal of the
plug-in if not done explicity with .
This implements the Dispose() interface to properly dispose of
the plug-in object.
There are two overloads for this method.
This can be overridden by derived classes to add their own
disposal code if necessary.
Pass true to dispose of the managed
and unmanaged resources or false to just dispose of the
unmanaged resources.
This read-only property returns a friendly name for the plug-in
This read-only property returns the version of the plug-in
This read-only property returns the copyright information for the
plug-in.
This read-only property returns a brief description of the plug-in
This plug-in does not run in partial builds
This read-only property returns a collection of execution points
that define when the plug-in should be invoked during the build
process.
This form is used to configure the settings for the
.
Constructor
The current XML configuration
XML fragment
Close without saving
The sender of the event
The event arguments
Go to the CodePlex home page of the Sandcastle Help File Builder
project.
The sender of the event
The event arguments
Enable or disable the user name and password controls based on
the Default Credentials check state.
The sender of the event
The event arguments
Enable or disable the proxy server settings based on the Use
Proxy Server check state.
The sender of the event
The event arguments
Enable or disable the proxy user credentials based on the Proxy
Default Credentials check state.
The sender of the event
The event arguments
Validate the configuration and save it
The sender of the event
The event arguments
Required designer variable.
Clean up any resources being used.
true if managed resources should be disposed; otherwise, false.
Required method for Designer support - do not modify
the contents of this method with the code editor.
This is used to return the configuration information
This form is used to configure the settings for the
.
Constructor
The current XML configuration
XML fragment
Close without saving
The sender of the event
The event arguments
Launch the URL in the web browser.
The sender of the event
The event arguments
Select the path to the bibliography file
The sender of the event
The event arguments
Validate the configuration and save it
The sender of the event
The event arguments
Required designer variable.
Clean up any resources being used.
true if managed resources should be disposed; otherwise, false.
Required method for Designer support - do not modify
the contents of this method with the code editor.
This is used to return the configuration information
This plug-in class is used to add assembly binding redirection support
to the MRefBuilder configuration file.
This method is used by the Sandcastle Help File Builder to let the
plug-in perform its own configuration.
A reference to the active project
The current configuration XML fragment
A string containing the new configuration XML fragment
The configuration data will be stored in the help file
builder project.
This method is used to initialize the plug-in at the start of the
build process.
A reference to the current build
process.
The configuration data that the plug-in
should use to initialize itself.
This method is used to execute the plug-in during the build process
The current execution context
This handles garbage collection to ensure proper disposal of the
plug-in if not done explicity with .
This implements the Dispose() interface to properly dispose of
the plug-in object.
There are two overloads for this method.
This can be overridden by derived classes to add their own
disposal code if necessary.
Pass true to dispose of the managed
and unmanaged resources or false to just dispose of the
unmanaged resources.
This read-only property returns a friendly name for the plug-in
This read-only property returns the version of the plug-in
This read-only property returns the copyright information for the
plug-in.
This read-only property returns a brief description of the plug-in
This plug-in runs in partial builds
This read-only property returns a collection of execution points
that define when the plug-in should be invoked during the build
process.
This plug-in class can be used to exclude API members from the table
of contents via the <tocexclude /> XML comment tag. The
excluded items are still accessible in the help file via other topic
links.
This method is used by the Sandcastle Help File Builder to let the
plug-in perform its own configuration.
A reference to the active project
The current configuration XML fragment
A string containing the new configuration XML fragment
The configuration data will be stored in the help file
builder project.
This method is used to initialize the plug-in at the start of the
build process.
A reference to the current build
process.
The configuration data that the plug-in
should use to initialize itself.
This method is used to execute the plug-in during the build process
The current execution context
This handles garbage collection to ensure proper disposal of the
plug-in if not done explicity with .
This implements the Dispose() interface to properly dispose of
the plug-in object.
There are two overloads for this method.
This can be overridden by derived classes to add their own
disposal code if necessary.
Pass true to dispose of the managed
and unmanaged resources or false to just dispose of the
unmanaged resources.
This read-only property returns a friendly name for the plug-in
This read-only property returns the version of the plug-in
This read-only property returns the copyright information for the
plug-in.
This read-only property returns a brief description of the plug-in
This plug-in does not run in partial builds
This read-only property returns a collection of execution points
that define when the plug-in should be invoked during the build
process.
This plug-in class is designed to run after the build completes to
send notification of the completion status via e-mail. The log file
can be sent as an attachment.
This method is used by the Sandcastle Help File Builder to let the
plug-in perform its own configuration.
A reference to the active project
The current configuration XML fragment
A string containing the new configuration XML fragment
The configuration data will be stored in the help file
builder project.
This method is used to initialize the plug-in at the start of the
build process.
A reference to the current build
process.
The configuration data that the plug-in
should use to initialize itself.
This is thrown if the plug-in
configuration is not valid.
This method is used to execute the plug-in during the build process
The current execution context
Since this runs after completion of the build and the
log file is closed, any progress messages reported here will not
appear in it, just in the output window on the main form.
This handles garbage collection to ensure proper disposal of the
plug-in if not done explicity with .
This implements the Dispose() interface to properly dispose of
the plug-in object.
There are two overloads for this method.
This can be overridden by derived classes to add their own
disposal code if necessary.
Pass true to dispose of the managed
and unmanaged resources or false to just dispose of the
unmanaged resources.
This is used to run the log file through an XSL transform so that
it is more readable.
The transformed log filename
This read-only property returns a friendly name for the plug-in
This read-only property returns the version of the plug-in
This read-only property returns the copyright information for the
plug-in.
This read-only property returns a brief description of the plug-in
This plug-in does not run in partial builds
This read-only property returns a collection of execution points
that define when the plug-in should be invoked during the build
process.
This plug-in class is used to add bibliography support to the topics
This method is used by the Sandcastle Help File Builder to let the
plug-in perform its own configuration.
A reference to the active project
The current configuration XML fragment
A string containing the new configuration XML fragment
The configuration data will be stored in the help file
builder project.
This method is used to initialize the plug-in at the start of the
build process.
A reference to the current build
process.
The configuration data that the plug-in
should use to initialize itself.
This method is used to execute the plug-in during the build process
The current execution context
Add the bibliography file parameter to the TransformComponent
configuration.
The BuildAssembler configuration file
to modify
This handles garbage collection to ensure proper disposal of the
plug-in if not done explicity with .
This implements the Dispose() interface to properly dispose of
the plug-in object.
There are two overloads for this method.
This can be overridden by derived classes to add their own
disposal code if necessary.
Pass true to dispose of the managed
and unmanaged resources or false to just dispose of the
unmanaged resources.
This read-only property returns a friendly name for the plug-in
This read-only property returns the version of the plug-in
This read-only property returns the copyright information for the
plug-in.
This read-only property returns a brief description of the plug-in
This plug-in runs in partial builds
This read-only property returns a collection of execution points
that define when the plug-in should be invoked during the build
process.
This plug-in class can be used to build a help file consisting of
nothing but additional content items. It is also useful for
proofreading your additional content without having to build all the
API topics.
This method is used by the Sandcastle Help File Builder to let the
plug-in perform its own configuration.
A reference to the active project
The current configuration XML fragment
A string containing the new configuration XML fragment
The configuration data will be stored in the help file
builder project.
This method is used to initialize the plug-in at the start of the
build process.
A reference to the current build
process.
The configuration data that the plug-in
should use to initialize itself.
This method is used to execute the plug-in during the build process
The current execution context
This handles garbage collection to ensure proper disposal of the
plug-in if not done explicity with .
This implements the Dispose() interface to properly dispose of
the plug-in object.
There are two overloads for this method.
This can be overridden by derived classes to add their own
disposal code if necessary.
Pass true to dispose of the managed
and unmanaged resources or false to just dispose of the
unmanaged resources.
This read-only property returns a friendly name for the plug-in
This read-only property returns the version of the plug-in
This read-only property returns the copyright information for the
plug-in.
This read-only property returns a brief description of the plug-in
This plug-in does not run in partial builds
This read-only property returns a collection of execution points
that define when the plug-in should be invoked during the build
process.
This plug-in class is designed to modify the HTML files and alter the
build so as to overcome the encoding issues encountered when building
Help 1.x (CHM) files for various foreign languages.
This uses the Steel
Bytes SBAppLocale tool to run the Help 1.x compiler using the
correct locale.
This method is used by the Sandcastle Help File Builder to let the
plug-in perform its own configuration.
A reference to the active project
The current configuration XML fragment
A string containing the new configuration XML fragment
The configuration data will be stored in the help file
builder project.
This method is used to initialize the plug-in at the start of the
build process.
A reference to the current build
process.
The configuration data that the plug-in
should use to initialize itself.
This method is used to execute the plug-in during the build process
The current execution context
This handles garbage collection to ensure proper disposal of the
plug-in if not done explicity with .
This implements the Dispose() interface to properly dispose of
the plug-in object.
There are two overloads for this method.
This can be overridden by derived classes to add their own
disposal code if necessary.
Pass true to dispose of the managed
and unmanaged resources or false to just dispose of the
unmanaged resources.
This read-only property returns a friendly name for the plug-in
This read-only property returns the version of the plug-in
This read-only property returns the copyright information for the
plug-in.
This read-only property returns a brief description of the plug-in
This plug-in does not run in partial builds
This read-only property returns a collection of execution points
that define when the plug-in should be invoked during the build
process.
This form is used to configure the settings for the
.
Constructor
The current XML configuration
XML fragment
Close without saving
The sender of the event
The event arguments
Launch the URL in the web browser.
The sender of the event
The event arguments
Select the path to the SBAppLocale tool
The sender of the event
The event arguments
Validate the configuration and save it
The sender of the event
The event arguments
Required designer variable.
Clean up any resources being used.
true if managed resources should be disposed; otherwise, false.
Required method for Designer support - do not modify
the contents of this method with the code editor.
This is used to return the configuration information
This class is used to specify credentials for a proxy server.
Constructor
There are two overloads for the constructor.
Constructor
True to use default the proxy server, false
to not use it.
The server name to use.
The user credentials to use for the proxy
server.
Create a proxy credentials instance from an XPath navigator
containing the settings.
The XPath navigator from which to
obtain the settings.
A object containing the
settings from the XPath navigator.
It should contain an element called proxyCredentials
with two attributes (useProxy and proxyServer) and a
nested userCredentials element.
Store the credentials as a node in the given XML document
The XML document
The node in which to store the element
Returns the node that was added or the one that
already existed in the document.
The credentials are stored in an element called
proxyCredentials with two attributes (useProxy and
proxyServer) and a nested userCredentials element.
It is created if it does not already exist.
This is used to set or get the flag indicating whether or not to
use the proxy server.
By default, this is false and and
will be ignored.
Get or set the proxy server name
If is false, this will be
ignored.
Get the user credentials
If is false, this will be
ignored.
This form is used to edit the
configuration.
Required designer variable.
Clean up any resources being used.
true if managed resources should be disposed; otherwise, false.
Required method for Designer support - do not modify
the contents of this method with the code editor.
Constructor
The current project
The current XML configuration
XML fragment
Close without saving
The sender of the event
The event arguments
Add a new setting item to the collection
The sender of the event
The event arguments
Delete a binding settings item
The sender of the event
The event arguments
Update the property grid with the selected item
The sender of the event
The event arguments
Refresh the list box item when a property changes
The sender of the event
The event arguments
Validate the configuration and save it
The sender of the event
The event arguments
Launch the URL in the web browser
The sender of the event
The event arguments
This is used to return the configuration information
This collection class is used to hold the reference link settings
information for the .
This is used to save the reference link settings list to the
configuration settings.
The XML configuration document.
The root configuration node
This is used to load the reference link settings list from the
configuration settings.
The base path provider object
The XPath navigator from which the
information is loaded.
This form is used to edit the
configuration.
Required designer variable.
Clean up any resources being used.
true if managed resources should be disposed; otherwise, false.
Required method for Designer support - do not modify
the contents of this method with the code editor.
Constructor
The current XML configuration
XML fragment
Close without saving
The sender of the event
The event arguments
Validate the configuration and save it
The sender of the event
The event arguments
Add a new XPath expression
The sender of the event
The event arguments
Delete the selected XPath expression
The sender of the event
The event arguments
Validate the expression and store it
The sender of the event
The event arguments
Load the selected expression for editing
The sender of the event
The event arguments
Launch the URL in the web browser
The sender of the event
The event arguments
This is used to return the configuration information
This plug-in class is designed to generate version information for
assemblies in the current project and others related to the same
product that can be merged into the current project's help file topics.
This method is used by the Sandcastle Help File Builder to let the
plug-in perform its own configuration.
A reference to the active project
The current configuration XML fragment
A string containing the new configuration XML fragment
The configuration data will be stored in the help file
builder project.
This method is used to initialize the plug-in at the start of the
build process.
A reference to the current build
process.
The configuration data that the plug-in
should use to initialize itself.
This is thrown if the plug-in
configuration is not valid.
This method is used to execute the plug-in during the build process
The current execution context
This handles garbage collection to ensure proper disposal of the
plug-in if not done explicity with .
This implements the Dispose() interface to properly dispose of
the plug-in object.
There are two overloads for this method.
This can be overridden by derived classes to add their own
disposal code if necessary.
Pass true to dispose of the managed
and unmanaged resources or false to just dispose of the
unmanaged resources.
Update the version information items in the shared builder content
file.
Remove the standard version information items from the shared
content file as the version builder information will take its
place in the topics. New items are added for each version of
the project defined in the configuration settings.
This is called to build a project
The project to build
The working path for the project
Returns true if successful, false if not
This is called by the build process thread to update the
application with the current build step.
The sender of the event
The event arguments
This creates the Version Builder configuration and script files
The name of the script to run
This read-only property returns a friendly name for the plug-in
This read-only property returns the version of the plug-in
This read-only property returns the copyright information for the
plug-in.
This read-only property returns a brief description of the plug-in
This plug-in runs in partial builds
This read-only property returns a collection of execution points
that define when the plug-in should be invoked during the build
process.
This represents a deployment location
Constructor
There are two overloads for the constructor
Constructor
The deployment location
The user credentials, if any
The proxy credentials, if any
Create a deployment location instance from an XPath navigator
containing the settings.
The XPath navigator from which to
obtain the settings.
The id of the element to load
A object containing the
settings from the XPath navigator.
It should contain an element called deploymentLocation
with two attributes (id with the specified ID value and
location) and nested userCredentials and
proxyCredentials elements.
Store the deployment location as a node in the given XML document
The XML document
The node in which to store the element
The id of the element to create
Returns the node that was added or the one that
already existed in the document.
The deployment location is stored in an element called
deploymentLocation with two attributes (id matching
the specified id and location) and nested
userCredentials and proxyCredentials elements. It
is created if it does not already exist.
The location to which the help file is deployed
The user credentials for the location
The proxy credentials for the location
This plug-in class is designed to modify the reflection information
file produced after running MRefBuilder on assemblies produced by the
Script# compiler so that it is suitable for use in producing a help
file.
This method is used by the Sandcastle Help File Builder to let the
plug-in perform its own configuration.
A reference to the active project
The current configuration XML fragment
A string containing the new configuration XML fragment
The configuration data will be stored in the help file
builder project.
This method is used to initialize the plug-in at the start of the
build process.
A reference to the current build
process.
The configuration data that the plug-in
should use to initialize itself.
This method is used to execute the plug-in during the build process
The current execution context
This handles garbage collection to ensure proper disposal of the
plug-in if not done explicity with .
This implements the Dispose() interface to properly dispose of
the plug-in object.
There are two overloads for this method.
This can be overridden by derived classes to add their own
disposal code if necessary.
Pass true to dispose of the managed
and unmanaged resources or false to just dispose of the
unmanaged resources.
This read-only property returns a friendly name for the plug-in
This read-only property returns the version of the plug-in
This read-only property returns the copyright information for the
plug-in.
This read-only property returns a brief description of the plug-in
This plug-in runs in partial builds
This read-only property returns a collection of execution points
that define when the plug-in should be invoked during the build
process.
This plug-in class is designed to generate XML comments and reflection
file information for Atlas client script libraries using AjaxDoc.
This method is used by the Sandcastle Help File Builder to let the
plug-in perform its own configuration.
A reference to the active project
The current configuration XML fragment
A string containing the new configuration XML fragment
The configuration data will be stored in the help file
builder project.
This method is used to initialize the plug-in at the start of the
build process.
A reference to the current build
process.
The configuration data that the plug-in
should use to initialize itself.
This is thrown if the plug-in
configuration is not valid.
This method is used to execute the plug-in during the build process
The current execution context
This handles garbage collection to ensure proper disposal of the
plug-in if not done explicity with .
This implements the Dispose() interface to properly dispose of
the plug-in object.
There are two overloads for this method.
This can be overridden by derived classes to add their own
disposal code if necessary.
Pass true to dispose of the managed
and unmanaged resources or false to just dispose of the
unmanaged resources.
This is the entry point for the thread that runs the browser to
invoke AjaxDoc.
Hook up the error handler on completion to handle script errors
The sender of the event
The event arguments
If a script error occurs, stop processing
The sender of the event
The event arguments
This notes when the page completes navigating
The sender of the event
The event arguments
If ran successfully, the page navigates twice. The first
time is the initial page load. It immediately submits itself to
post the results. On the second navigation, we can assume it was
successful and the page contains the "success" result message.
This read-only property returns a friendly name for the plug-in
This read-only property returns the version of the plug-in
This read-only property returns the copyright information for the
plug-in.
This read-only property returns a brief description of the plug-in
This plug-in runs in partial builds
This read-only property returns a collection of execution points
that define when the plug-in should be invoked during the build
process.
This plug-in class is used to filter out unwanted information from the
reflection information file using XPath queries.
This method is used by the Sandcastle Help File Builder to let the
plug-in perform its own configuration.
A reference to the active project
The current configuration XML fragment
A string containing the new configuration XML fragment
The configuration data will be stored in the help file
builder project.
This method is used to initialize the plug-in at the start of the
build process.
A reference to the current build
process.
The configuration data that the plug-in
should use to initialize itself.
This method is used to execute the plug-in during the build process
The current execution context
This handles garbage collection to ensure proper disposal of the
plug-in if not done explicity with .
This implements the Dispose() interface to properly dispose of
the plug-in object.
There are two overloads for this method.
This can be overridden by derived classes to add their own
disposal code if necessary.
Pass true to dispose of the managed
and unmanaged resources or false to just dispose of the
unmanaged resources.
This read-only property returns a friendly name for the plug-in
This read-only property returns the version of the plug-in
This read-only property returns the copyright information for the
plug-in.
This read-only property returns a brief description of the plug-in
This plug-in runs in partial builds
This read-only property returns a collection of execution points
that define when the plug-in should be invoked during the build
process.
This represents binding redirection settings for the
.
Constructor
The base path provider
This returns a string representation of the item
The item value as a string
Create a binding redirect settings instance from an XPath navigator
containing the settings.
The base path provider object
The XPath navigator from which to
obtain the settings.
A object containing
the settings from the XPath navigator.
It should contain an element called dependentAssembly
with a configFile attribute or a nested assemblyIdentity and
bindingRedirect element that define the settings.
Store the binding redirect settings as a node in the given XML
document.
The XML document
The node in which to store the element
Returns the node that was added.
The settings are stored in an element called
dependentAssembly.
This is used to get or set the assembly name (no extension)
This is used to get or set the public key token for the assembly
If omitted, "null" is assumed
This is used to get or set the culture for the assembly
If omitted, "neutral" is assumed
This is used to get or set the old version number to redirect to
the new version number.
This is used to get or set the ending old version number range to
redirect to the new version number.
If not set, only will be used to
redirect a single version.
This is used to get or set the new version number to which the old
versions are redirected.
This is used to get or set the path to the configuration file from
which the settings should be imported.
If specified, the properties in the Binding Redirect
category are ignored.
This collection class is used to hold the version settings information
for the .
This is used to save the version settings list to the configuration
settings.
The XML configuration document.
The root configuration node
This is used to load the version settings list from the
configuration settings.
The base path provider object
The XPath navigator from which the
information is loaded.
This is used to sort the collection in ascending order by framework
label and version.