TransformationArgument Class

This class is used to contain transformation argument values

Definition

Namespace: Sandcastle.Core.PresentationStyle.Transformation
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2024.2.18.0
public class TransformationArgument
Inheritance
Object    TransformationArgument

Remarks

These are modified using any values stored in the help file builder project at build time

Constructors

Properties

Content This is used to get or set the argument's content for complex arguments
DefaultContent The default content if any was specified
DefaultValue The default value if one was specified
Description This read-only property returns a description of the argument
IsForConceptualBuild This read-only property returns whether or not the argument applies to conceptual builds
IsForReferenceBuild This read-only property returns whether or not the argument applies to reference builds
Key This read-only property returns the argument key
Value This is used to get or set the argument's value for simple arguments

Methods

Clone This is used to clone a transformation argument
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
ToStringReturns a string that represents the current object.
(Inherited from Object)
ToXml This is used to convert the transformation argument to an XML element for storing in a help file builder project.

See Also