CodeSmith.Engine
The file path that is being modified.
The content that the template generated.
The previous content waiting to be merged.
Generates the snippet.
The raw line.
The target extension.
The snippet output.
Outputs the usage.
The raw line.
The target extension.
Initializes a new instance of the class.
Initializes a new instance of the class.
The MSBuild task item to get the properties from.
Gets or sets the original name used to request the assembly resolve.
The original name.
Gets or sets the assembly name.
The assembly name.
Gets or sets the full assembly name.
The full assembly name.
Gets or sets the full path to the assembly.
The path to the assembly.
Gets or sets a value indicating the assembly should be copied local.
true if copy local; otherwise, false.
Gets a value indicating whether the assembly was loaded from the global assembly cache.
true if the assembly was loaded from the global assembly cache; otherwise, false.
Gets or sets the location where the assembly was resolved from.
The location where the assembly was resolved from.
Gets or sets the full path to the assemblies new local path.
The path to the assembly local path.
Initializes a new instance of the class.
Gets the current instance of .
The current instance.
This class can be used to compile templates.
Creates a new instance.
Path.
Creates a new instance.
Code template info.
Compiles the specified template and outputs an assembly to the output path.
Compiles the specified template and outputs an assembly to the output path.
Force recompile.
Compiles the specified template and outputs an assembly to the output path.
Output path.
Compiles the specified template and outputs an assembly to the output path.
Output path.
Force recompile.
Compiles the specified template and outputs an assembly to the output path.
Output path.
Force recompile.
Creates an instance of the compiled template. You must compile the template first.
Gets the code template information.
Gets or sets a value indicating whether the template should be compiled in debug mode or not.
true if debug; otherwise, false.
Gets or sets a value indicating whether line pragmas should be output in the compiled source code.
true if line pragmas should be generated; otherwise, false.
Gets or sets a value indicating whether the temp files should be kept.
true if you want to keep the temp files; otherwise, false.
Namespace that the compiled template should be a member of.
Gets or sets the type name of the compiled template.
Provides access to the compiled assembly.
Provides access to the generated source code.
Gets the errors.
Gets or sets the compiler output writer.
Gets the hash code based on the template dependencies.
Gets the full path to the template.
Gets the name of the template file.
Gets the name of the directory the template is located in.
Gets the template language.
Gets the target language.
Gets the response encoding.
Gets the description.
Gets the date the template was created.
Gets the date the template was modified.
Gets the hash code based on the template content and all template Dependencies.
Gets the type of the output for this template.
The type of the output.
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Releases unmanaged and - optionally - managed resources
true to release both managed and unmanaged resources; false to release only unmanaged resources.
Disposes the managed resources.
Disposes the unmanaged resources.
Releases unmanaged resources and performs other cleanup operations before the
is reclaimed by garbage collection.
Adds a instance to the current thread's .
The currently executing CodeTemplate
An instance of the current TemplateContext.
Cleans up all resources associated with the .
Returns the data associated with the current executing .
Returns the that is being rendered in the current executing .
Returns the Parent that is being rendered in the current executing .
Returns the Root that is being rendered in the current executing .
Creates a new Template Error while setting the SourceFilePath property.
Gets the item type for the file type.
The item.
Gets the CodeSmith safe import.
The CodeSmith safe import.
This is the channel from the client (child) process to the host (parent) process.
This is called by the client when it is ready to receive messages.
A pointer to the client channel
The process id of the host (parent) process.
This is the channel from the host (parent) proccess to the client (child) process.
A class to aid in remoting with a host process.
There can only be one HostProcess for the current process.
Initialize must be called to wire up the host process remoting.
When the client is fully started and ready to receive message,
ClientReady must be called to alert the host process that messages
can be sent.
Initializes a new instance of the class.
Raises the event.
The remote message.
Raises the event.
The remote message.
Raises the message error.
The error that occurred.
Initializes by getting the from
the specified host ipc URI. Must be called before calling other methods.
The host ipc URI.
Initialize must be called before any other method in the class.
Initialize can only be called once, additional calls will be ignored
Thrown when host remoting channel can not be loaded from .
Alerts the host process that the client is ready to receive messages. Must be called after Initialize.
Alerts the host process that the client is ready to receive messages. Must be called after Initialize.
Sends message to host async. Initialize must be called before this.
The message to send.
Shutdown was initiated in the client.
Occurs when a message is received from the remote process.
Occurs when a message is sent to the host process.
Raised when an error is thrown by .
Interface that all property serializers must implement.
This method will be used to save the property value when a template is being compiled.
Context information of the target property.
The property to be saved.
An object that will be stored in a Hashtable during template compilation.
This method will be used to restore the property value after a template has been compiled.
Context information of the target property.
The property to be loaded.
The value to be assigned to the template property after it has been compiled.
This method will be used when serializing the property value to an XML property set.
Context information of the target property.
The XML writer that the property value will be written to.
The property to be serialized.
This method will be used when deserializing the property from an XML property set.
Context information of the target property.
The XML node to read the property value from.
The value to be assigned to the template property.
This method will be used to parse a default value for a property when a template is being instantiated.
Context information of the target property.
The default value.
An object that will be assigned to the template property.
Begin generating code asynchronous
The project file to generate
Generates a CodeSmith Project file based on the file path to the csp.
File path to the csp file.
true if the csp was generated.
Access's the Registry and gets the string value of the specific SubKey.
The SubKey.
The name of the key.
The value returned from the registry.
Returns true if the object is not null.
Attempts to update configuration from a configuration file. The version of CodeSmith must be older than CodeSmith 5.1.
Type of the configuration class.
The configuration filename.
Updated Configuration file if a configuration file was found.
Finds all configuration files with a specified name.
Configuration file name.
A List of configuration files with the specified file name.
This method is here purely to make sure that we don't make a double call to the Initialize method while initializing configuration.
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
2
Finds the specified alias.
The alias.
The target extension.
The instance that match closest to the alias, extension pair.
Finds the specified alias.
The alias.
The target extension.
If true, the target extension must match.
The instance that matches the passed in alias and targetExtension
Finds the instance that match closest to the alias.
The partial alias.
The target extension.
The instance that match closest to the alias.
A collection of Active Snippet maps.
The key for the collection is the alias of the template map.
Gets the current singleton instance of Configuration.
The current singleton instance.
An instance of Configuration wont be created until the very first
call to the sealed class. This is a CLR optimization that
provides a properly lazy-loading singleton.
Nested class to lazy-load singleton.
Initializes the Nested class.
Explicit static constructor to tell C# compiler not to mark type as beforefieldinit.
Current singleton instance.
Interface defining an indexed object.
Gets or sets the index.
The index.
Gets or sets the alias.
The alias.
Gets or sets the target language.
The target language.
Gets or sets the template file.
The template file.
Returns the original template file name.
Gets or sets the name of the template.
The name of the template.
Gets the name of the display.
The name of the display.
Gets or sets the arguments.
The arguments.
Gets or sets the target file extensions.
The target extensions.
Gets or sets the property set.
The property set.
A base Collection used to load data on depand from database.
Copies the elements of the to an , starting at a particular index.
The one-dimensional that is the destination of the elements copied from . The must have zero-based indexing.
The zero-based index in at which copying begins.
is null.
is less than zero.
is multidimensional.
-or-
is equal to or greater than the length of .
-or-
The number of elements in the source is greater than the available space from to the end of the destination .
The type of the source cannot be cast automatically to the type of the destination .
Adds an item to the .
The to add to the .
The position into which the new element was inserted.
The is read-only.
-or-
The has a fixed size.
Determines whether the contains a specific value.
The to locate in the .
true if the is found in the ; otherwise, false.
Determines the index of a specific item in the .
The to locate in the .
The index of if found in the list; otherwise, -1.
Inserts an item to the at the specified index.
The zero-based index at which should be inserted.
The to insert into the .
is not a valid index in the .
The is read-only.
-or-
The has a fixed size.
is null reference in the .
Removes the first occurrence of a specific object from the .
The to remove from the .
The is read-only.
-or-
The has a fixed size.
Adds an item to the .
The object to add to the .
The is read-only.
Removes all items from the .
The is read-only.
Copies the elements of the to an , starting at a particular index.
The one-dimensional that is the destination of the elements copied from . The must have zero-based indexing.
The zero-based index in at which copying begins.
Determines whether the contains a specific value.
The object to locate in the .
true if is found in the ; otherwise, false.
Returns an enumerator that iterates through the collection.
A that can be used to iterate through the collection.
Determines the index of a specific item in the .
The object to locate in the .
The index of if found in the list; otherwise, -1.
Inserts an item to the at the specified index.
The zero-based index at which should be inserted.
The object to insert into the .
is not a valid index in the .
The is read-only.
Removes the first occurrence of a specific object from the .
The object to remove from the .
true if was successfully removed from the ; otherwise, false. This method also returns false if is not found in the original .
The is read-only.
Removes the item at the specified index.
The zero-based index of the item to remove.
is not a valid index in the .
The is read-only.
Returns an enumerator that iterates through a collection.
An object that can be used to iterate through the collection.
Gets the count.
Gets the index.
The item.
Gets the item.
The index.
Gets the items.
Clears the items.
Adds the item.
The item.
Inserts an element into the Collection at the specified index.
The zero-based index at which item should be inserted.
The object to insert. The value can be null (Nothing in Visual Basic) for reference types.
Removes the element at the specified index of the Collection.
The zero-based index of the element to remove.
Replaces the element at the specified index.
The zero-based index of the element to replace.
The new value for the element at the specified index. The value can be null (Nothing in Visual Basic) for reference types.
Determines whether the specified value is compatible with Collection.
The value to check.
true if is a compatible object; otherwise, false.
Verifies the type of the value.
The value to check.
Gets a value indicating whether access to the is synchronized (thread safe).
true if access to the is synchronized (thread safe); otherwise, false.
Gets an object that can be used to synchronize access to the .
An object that can be used to synchronize access to the .
Gets or sets the at the specified index.
Gets a value indicating whether the is read-only.
true if the is read-only; otherwise, false.
Gets a value indicating whether the has a fixed size.
true if the has a fixed size; otherwise, false.
Gets the number of elements contained in the .
The number of elements contained in the .
Gets or sets the type T at the specified index.
Gets a value indicating whether the is read-only.
true if the is read-only; otherwise, false.
Value to be cached.
Initializes a new instance of the class.
This method will safely upgrade the default values for collections and overwrite any directory settings.
The following method will check the registry and see if an upgrade is needed.
Returns true if the registry is up to date; returns false if there is no previous registry version.
Updates Lines Generated based off of the passed in string containing source code.
Source code.
Returns the numbers of hours saved by using CodeSmith.
Returns the numbers of hours saved by using CodeSmith.
Returns the amount of money saved by using CodeSmith.
Returns the amount of money saved by using CodeSmith.
Returns the path to the icon resource dll.
Returns the path to the icon resource dll.
Extracts an embedded license if it was found.
The full path to store the license file.
The assembly that contains the license file.
Checks an assembly for an embedded license.
The assembly with the embedded license.
Gets or sets a value indicating whether to track lines generated.
true to track lines generated; otherwise, false.
Gets or sets the number of lines generated.
The number of lines generated.
Gets or sets the average lines per hour.
The average lines per hour.
Gets or sets the average cost per hour.
The average cost per hour.
Gets or sets the application directory.
The application directory.
Gets the merge strategy aliases.
The merge strategy aliases.
Gets the language region definitions.
The language region definitions.
Gets the property designer maps.
The property designer maps.
Gets the conditional compilation statements for the compiler.
The conditional compilation.
Gets or sets the base CodeSmith sample directory.
The CodeSmith sample directory.
Gets or sets the CodeSmith sample directory.
The CodeSmith sample directory.
Gets or sets the CodeSmith maps directory.
The CodeSmith maps directory.
Gets or sets the CodeSmith templates directory.
The CodeSmith templates directory.
Gets or sets the CodeSmith data directory.
The CodeSmith data directory.
Gets or sets the template cache directory.
The template cache directory.
Gets or sets the property set cache directory.
The property set cache directory.
Gets or sets the plural overrides map file.
The plural overrides map file.
Controls whether the Customer Experience Improvement Program is enabled.
Gets or sets the semicolon delimited list of assembly probing paths. The path is relative to ApplicationDirectory.
The semicolon delimited list of assembly probing paths.
Returns true if CodeSmith Explorer, CodeSmith Studio, or Console was not the entry assembly.
Returns the name of the current Entry Assembly.
Gets the current singleton instance of Configuration.
The current singleton instance.
An instance of Configuration wont be created until the very first
call to the sealed class. This is a CLR optimization that
provides a properly lazy-loading singleton.
Nested class to lazy-load singleton.
Initializes the Nested class.
Explicit static constructor to tell C# compiler not to mark type as beforefieldinit.
Current singleton instance.
Loads this instance.
Saves this instance.
Gets the singleton instance.
The singleton instance.
Initializes a new instance of the class.
Initializes a new instance of the class.
The index.
Gets or sets the index.
The index.
Occurs when a property value changes.
IndexedEnumerable makes enumerating over collections much easier by implementing properties like: IsEven, IsOdd, IsLast.
Returns an IndexedEnumerable from any collection implementing IEnumerable<T>
Type of enumerable
Source enumerable
A new IndexedEnumerable<T>.
Returns an IndexedEnumerable from any collection implementing IEnumerable<T>
Type of enumerable
Source enumerable
A new IndexedEnumerable<T>.
IndexedEnumerable makes enumerating over collections much easier by implementing properties like: IsEven, IsOdd, IsLast.
Type to iterate over
Default constructor.
Constructor that takes an IEnumerable<T>
The collection to enumerate.
Returns an enumeration of Entry objects.
Non-generic form of GetEnumerator.
Represents each entry returned within a collection,
containing the _value and whether it is the first and/or
the last entry in the collection's. enumeration
The Entry Value.
Returns true if it is the first item in the collection.
Returns true if it is the last item in the collection.
The index of the current item in the collection.
Returns true if the current item has an even index
Returns true if the current item has an odd index
Raises the event.
The remote message.
Sends a message to the remote process
Occurs when the remote process is available.
Occurs when the remote process is starting.
Occurs when a message is received from the remote process.
Gets or sets the executable path for the remote process.
The executable path for the remote process.
Gets the current singleton instance of RemoteProjectProcess.
The current singleton instance.
An instance of RemoteProjectProcess wont be created until the very first
call to the sealed class. This is a CLR optimization that
provides a properly lazy-loading singleton.
Comprises utility methods for constructing a command line.
Initializes a new instance of the class.
Initializes a new instance of the class.
The command line to start with.
Appends the command line with file name represented by the parameter, inserting quotation marks if necessary.
Name of the file.
Appends the command line with a list of file names, inserting quotation marks if necessary.
The file names to append. If the array is null reference, then this method has no effect.
The delimiter to put between file names in the command line.
Appends the command line with a file name, and surrounds the file name with quotation marks as necessary.
Name of the file.
Appends the space if command line is not empty.
Appends the command line with the specified switch.
Name of the switch.
Appends the switch if true.
Name of the switch.
if set to true [condition].
Appends the switch if not null.
Name of the switch.
The parameter.
Appends the switch if not default.
Type of the parameter
Name of the switch.
The parameter.
Appends the switch if not default.
Type of the parameter
Name of the switch.
The parameter.
The default value.
Appends the switch if not null.
Name of the switch.
The parameters.
The delimiter.
Appends the switch unquoted if not null.
Name of the switch.
The parameter.
Appends the switch unquoted if not null.
Name of the switch.
The parameters.
The delimiter.
Appends the text unquoted.
The text to append.
Appends the text with quoting.
The text to append.
Determines whether [is quoting required] [the specified parameter].
The parameter.
true if [is quoting required] [the specified parameter]; otherwise, false.
Returns a that represents this instance.
A that represents this instance.
Verifies the throw no embedded double quotes.
Name of the switch.
The parameter.
Verifies the throw argument null.
The parameter.
Name of the parameter.
Gets the command line buffer.
The command line.
A collection that provides notifications when items get added, removed, or when the whole list is refreshed.
Initializes a new instance of the class.
Initializes a new instance of the class.
The collection.
Initializes a new instance of the class.
The delimited values.
Disallows reentrant attempts to change this collection.
An IDisposable object that can be used to dispose of the object.
Checks for reentrant attempts to change this collection.
Removes all elements from the .
Inserts an element into the at the specified index.
The zero-based index at which should be inserted.
The object to insert. The value can be null for reference types.
is less than zero.
-or-
is greater than .
Moves the item at the specified index to a new location in the collection.
The zero-based index specifying the location of the item to be moved.
The zero-based index specifying the new location of the item.
Moves the item at the specified index to a new location in the collection.
The zero-based index specifying the location of the item to be moved.
The zero-based index specifying the new location of the item.
Raises the CollectionChanged event with the provided arguments.
Raises the PropertyChanged event with the provided arguments.
The instance containing the event data.
Raises the PropertyChanged event with the provided arguments.
Name of the property.
Removes the element at the specified index of the .
The zero-based index of the element to remove.
is less than zero.
-or-
is equal to or greater than .
Replaces the element at the specified index.
The zero-based index of the element to replace.
The new value for the element at the specified index. The value can be null for reference types.
is less than zero.
-or-
is greater than .
Returns a that represents the current .
A that represents the current .
Returns a that represents the values.
The values.
The delimiter.
A that represents the current .
Returns a that represents the values.
The values.
A that represents the current .
Returns an array of strings that represents the current collection.
An array of strings that represents the current collection.
Adds the split values from to the collection.
The string is split using the property.
The delimited values.
The number of values added.
Thrown when is null.
Gets or sets the string delimiter.
The string delimiter.
Occurs when a property value changed.
Occurs when the collection changed.
A type converter for the .
Returns whether this converter can convert an object of the given type to the type of this converter, using the specified context.
An that provides a format context.
A that represents the type you want to convert from.
true if this converter can perform the conversion; otherwise, false.
Returns whether this converter can convert the object to the specified type, using the specified context.
An that provides a format context.
A that represents the type you want to convert to.
true if this converter can perform the conversion; otherwise, false.
Converts the given object to the type of this converter, using the specified context and culture information.
An that provides a format context.
The to use as the current culture.
The to convert.
An that represents the converted value.
The conversion cannot be performed.
Converts the given value object to the specified type, using the specified context and culture information.
An that provides a format context.
A . If null is passed, the current culture is assumed.
The to convert.
The to convert the parameter to.
An that represents the converted value.
The parameter is null.
The conversion cannot be performed.
Loads the default settings.
This method is called when existing config file is not
found. Use this method to populate the configuration
class with default values.
Upgrades the file.
The file to upgrade.
This method is called just before loading a previous config
file. Use this method to modify the file before it is loaded.
Upgrades the settings.
This method is called after loading a previous config file.
Use this method to change any existing configurations to
work with the latest version.
Gets a value indicating whether this instance can watch file.
true if this instance can watch file; otherwise, false.
Gets the configuration file.
The configuration file.
Gets a value indicating whether this configuration is backward compatible.
true if this configuration is backward compatible; otherwise, false.
Gets or sets the configuration version.
The configuration version.
Gets the list of language keys for the region defintion.
The language keys.
Gets or sets the region start regex.
The region start regex.
Gets or sets the region end regex.
The region end regex.
Gets or sets the name of the merge strategy alias.
The merge strategy alias name.
Gets or sets the fully qualified type name for the merge strategy.
The name of the type.
Gets the list of data types the designer should be used for.
The data types.
Gets or sets the type of the editor.
The type of the editor.
Gets or sets the type of the serializer.
The type of the serializer.
All templates must derive from this class.
This method can be overridden to perform logic when the template instance is created.
This method is overridden in templates to set default values in a template instance.
This method is overridden in templates to set unknown directive attributes in the ContextData.
This method can be overridden to perform logic before the template is rendered.
This method can be overridden to perform logic when a template exception occurs.
This method can be overridden to perform logic when a property changes.
This method can be overridden to perform logic when properties are loaded.
This method can be overridden to perform logic when properties are saved.
Renders to the template output to the specified writer.
Writer.
This method can be overridden to perform logic after the template is rendered.
The template output.
Renders the template output to a string.
Renders the template output to a string.
Renders the template output to a file.
The output file path.
if set to true overwrite file.
Renders the template output to a file.
The output file path.
The file that the output is dependent upon.
if set to true overwrite file.
Renders the template output to a file.
The output file.
if set to true overwrite file.
Renders the template output to a file using a merge strategy.
The output path.
The merge strategy to use.
Renders the template output to a file using a merge strategy.
The output path.
The merge strategy to use.
The source file to base the merge on.
Renders the template output to a file using a merge strategy.
The output file.
The merge strategy to use.
The source file to base the merge on.
Validates this template instance.
Allows the developer to add custom ValidationErrors to the validation collection.
Gets a default name for the template output. This can be overridden in your template to provide a suitable name for the output of the template based on the property values.
A file name (E.G., output.txt).
Set the context data object for the template.
Any items in the current ContextData object will be added to the new one.
This method should only be called while a template is initializing.
The context data object.
Parses the default value for properties. This can be overridden to provide custom default parsing logic.
Target property.
Default value.
Gets the property attribute. Property attributes can be used to store various information at the property level.
Name of the property.
Name of the attribute.
The value of the attribute
Sets the property attribute. Property attributes can be used to store various information at the property level.
Name of the property.
Name of the attribute.
The attribute value.
Gets the template attribute. Template attributes can be used to store various information at the template level.
Name of the attribute.
The value of the attribute
Sets the template attribute. Template attributes can be used to store various information at the template level.
Name of the attribute.
The attribute value.
Gets information on all of the properties on this template.
Gets information on all of the properties on this template.
Whether non-browsable properties should be included.
Gets information on all of the required properties for this template.
Saves the properties to a Hashtable.
Saves the properties to a Hashtable.
Whether non-browsable properties should be included.
Saves the properties to a Hashtable.
Whether non-browsable properties should be included.
Ignores the specified list of property names when copying properties to the template.
Restores the properties from a Hashtable.
Properties.
Saves the properties to an XML file.
XML file path.
Copies any matching properties to another CodeTemplate instance.
Template.
Copies any matching properties to another CodeTemplate instance.
Template.
Ignores the specified list of property names when copying properties to the template.
Copies any matching properties to another CodeTemplate instance.
Template.
Whether non-browsable properties should be included.
Copies any matching properties to another CodeTemplate instance.
Template.
Whether non-browsable properties should be included.
Ignores the specified list of property names when copying properties to the template.
Restores the properties from XML file.
XML file path.
Saves the properties to XML.
XmlWriter.
Saves the properties to XML.
Restores the properties from XML.
The XML fragment.
The base directory to resolve file references.
Sets the value for the specified property.
Property name.
Value to assign.
Sets the value for the specified property.
Information about the target property.
Value to assign.
Gets the value for the specified property.
Property name.
Gets an instance of the specified template.
Path to the template.
Gets an instance of the specified template.
Path to the template.
Forces the template to be recompiled instead of using the cache.
The CodeTemplate instance.
Gets an instance of the specified template.
Path to the template.
Forces the template to be recompiled instead of using the cache.
Share template context data with the child template instance.
The CodeTemplate instance.
This is the method that is responsible for notifying
receivers that the event occurred
This is the method that is responsible for notifying
receivers that the event occurred
This is the method that is responsible for notifying
receivers that the event occurred
Raises the event.
The instance containing the event data.
Registers the reference. When generating from within Visual Studio, these references will be added to the project.
Name of the reference.
Gets an instance of the specified template type. Should be used with the Register directive.
The CodeTemplate instance.
Gets an instance of the specified template type. Should be used with the Register directive.
Share template context data with the child template instance.
The CodeTemplate instance.
Response stream for the template output. You can write to the stream programmatically using this property.
Provides a way to report execution progress for the template.
State of this template instance.
Gets the information for the current template.
Gets the validation errors for this template.
Contextual data items can be stored in this object and shared with sub-templates. This data will not be persisted with the template property set.
Raised when an output file is registered
Raised prior to an output being written to disk
Occurs when a reference is registered.
Increments the IndentLevel by one.
The number of tabs or spaces the generated output should indent.
This value is outputted once for each Indent Level. IndentValue defaults to one tab.
Excludes a property from being required.
Marks a property as optional.
A class representing a template output file.
Initializes a new instance of the class.
The output file.
Initializes a new instance of the class.
The output file.
The metadata.
Initializes a new instance of the class.
The output file.
The file that output is dependent upon.
Initializes a new instance of the class.
The output file.
The file that output is dependent upon.
The metadata.
Performs an implicit conversion from to .
The output file.
The result of the conversion.
Performs an implicit conversion from to .
The output file.
The result of the conversion.
Gets the name of the output file.
The name of the output file.
Gets or sets the dependent upon file.
The dependent upon file.
Gets the metadata.
The metadata.
Initializes a new instance of the class.
Name of the item.
Gets or sets the name of the item.
The name of the item.
EventArgs derived type which holds the custom event fields
Initializes a new instance of the class.
The output file.
Initializes a new instance of the class.
The output file.
Gets or sets the output file.
The output file.
Initializes a new instance of the class.
Initializes a new instance of the class.
Initializes a new instance of the class.
The output file.
Gets or sets a value indicating whether this output is canceled
true if cancel; otherwise, false.
This represents the delegate method prototype that
event receivers must implement
This represents the delegate method prototype that
event receivers must implement
Progress information.
Performs a progress step.
Increments the current progress value by the specified amount.
Value.
Occurs when the progress value has been changed.
Occurs when the progress value has been changed.
Current status for the operation.
Minimum progress value.
Maximum progress value.
Gets or sets the current progress value.
Gets or sets the step increment value.
Provides information about a template validation error.
The Validation Message
The name of the Property.
EventArgs derived type which holds the custom event fields
Initializes a new instance of the class.
if set to true generation was successful.
The registered outputs.
Initializes a new instance of the class.
if set to true [result].
The registered outputs.
The registered references.
Initializes a new instance of the class.
if set to true [result].
The registered outputs.
The registered references.
The file path of the CodeSmith project file.
Initializes a new instance of the class.
The error.
This represents the delegate method prototype that
event receivers must implement
EventArgs derived type which holds the custom event fields
Use this constructor to initialize the event arguments
object with the custom event fields
This represents the delegate method prototype that
event receivers must implement
This represents the delegate method prototype that
event receivers must implement
EventArgs derived type which holds the custom event fields
Use this constructor to initialize the event arguments
object with the custom event fields
This represents the delegate method prototype that
event receivers must implement
EventArgs derived type which holds the custom event fields
This ensures that if the licensing is reset during runtime, that this is only ever incremented once.
This method checks to see if you are using invalid features of CodeSmith.
E.G. You are using CodeSmith Professional and register a CodeSmith Standard Key.
This will cause CodeSmith Generator Studio to close.
Clean up any resources being used.
true if managed resources should be disposed; otherwise, false.
Gets the map files.
Loads the specified name.
The path.
Loads the map with the specified name by trying to resolve the path.
The name of the map.
Tries the resolve path.
Name of the map.
The base directory.
The full path.
Initializes a new instance of the class.
Initializes a new instance of the class.
Whether map lookups should be case sensitive or not.
Initializes a new instance of the class.
Name of the map file.
Initializes a new instance of the class.
Name of the map file.
if set to true the key and value will be reversed.
Initializes a new instance of the class.
Name of the map file.
if set to true the key and value will be reversed.
The default value.
Saves the specified map file name.
Name of the map file.
Loads the specified map file name.
Name of the map file.
Loads the specified map file name.
Name of the map file.
if set to true [reverse].
Returns a that represents the current .
A that represents the current .
Adds an element with the provided key and value to the .
The object to use as the key of the element to add.
The object to use as the value of the element to add.
The is read-only.
An element with the same key already exists in the .
key is null.
Determines whether the contains an element with the specified key.
The key to locate in the .
true if the contains an element with the key; otherwise, false.
key is null.
Determines whether the specified value contains value.
The value.
true if the specified value contains value; otherwise, false.
Gets the enumerator.
Removes the element with the specified key from the .
The key of the element to remove.
true if the element is successfully removed; otherwise, false. This method also returns false if key was not found in the original .
The is read-only.
key is null.
Tries the get value.
The key.
The value.
Returns an enumerator that iterates through a collection.
An object that can be used to iterate through the collection.
Copies the elements of the to an , starting at a particular index.
The one-dimensional that is the destination of the elements copied from . The must have zero-based indexing.
The zero-based index in array at which copying begins.
array is null.
index is less than zero.
array is multidimensional.-or- index is equal to or greater than the length of array.-or- The number of elements in the source is greater than the available space from index to the end of the destination array.
The type of the source cannot be cast automatically to the type of the destination array.
Adds an element with the provided key and value to the object.
The to use as the key of the element to add.
The to use as the value of the element to add.
An element with the same key already exists in the object.
key is null.
The is read-only.-or- The has a fixed size.
Removes all items from the .
The is read-only.
Determines whether the object contains an element with the specified key.
The key to locate in the object.
true if the contains an element with the key; otherwise, false.
key is null.
Returns an object for the object.
An object for the object.
Removes the element with the specified key from the object.
The key of the element to remove.
The object is read-only.-or- The has a fixed size.
key is null.
Runs when the entire object graph has been deserialized.
The object that initiated the callback. The functionality for this parameter is not currently implemented.
Populates a with the data needed to serialize the target object.
The to populate with data.
The destination (see ) for this serialization.
The caller does not have the required permission.
Adds an item to the .
The object to add to the .
The is read-only.
Determines whether the contains a specific value.
The object to locate in the .
true if item is found in the ; otherwise, false.
Copies the elements of the to an , starting at a particular index.
The one-dimensional that is the destination of the elements copied from . The must have zero-based indexing.
The zero-based index in array at which copying begins.
arrayIndex is less than 0.
array is null.
array is multidimensional.-or-arrayIndex is equal to or greater than the length of array.-or-The number of elements in the source is greater than the available space from arrayIndex to the end of the destination array.-or-Type T cannot be cast automatically to the type of the destination array.
Removes the first occurrence of a specific object from the .
The object to remove from the .
true if item was successfully removed from the ; otherwise, false. This method also returns false if item is not found in the original .
The is read-only.
Returns an enumerator that iterates through the collection.
A that can be used to iterate through the collection.
Gets the name of the file.
The name of the file.
Whether the map lookups should be case Sensitive.
Gets or sets the description.
The description.
Gets a value indicating whether this key value pair is reversed.
true if reversed; otherwise, false.
Gets or sets a value indicating whether to return the key when its not found in the collection.
true to return the key; otherwise, false.
Gets or sets the default value for when the key is not found.
The default value.
Gets an containing the keys of the .
An containing the keys of the object that implements .
Gets an containing the values in the .
An containing the values in the object that implements .
Gets or sets the with the specified key.
Gets the with the specified key.
Gets the number of elements contained in the .
The number of elements contained in the .
Gets a value indicating whether access to the is synchronized (thread safe).
true if access to the is synchronized (thread safe); otherwise, false.
Gets an object that can be used to synchronize access to the .
An object that can be used to synchronize access to the .
Gets a value indicating whether the object has a fixed size.
true if the object has a fixed size; otherwise, false.
Gets a value indicating whether the is read-only.
true if the is read-only; otherwise, false.
Gets an containing the keys of the .
An containing the keys of the object that implements .
Gets an containing the values in the .
An containing the values in the object that implements .
Gets or sets the with the specified key.
Gets a value indicating whether the is read-only.
true if the is read-only; otherwise, false.
This interface can be implemented to create a merge strategy.
Initialize the merge strategy by passing in an initialization string.
Initialization string.
Merge the template output with the existing content.
A reference to the MergeContext.
This merge strategy can be used to insert the template output into a named region inside an existing file
and preserve the rest of the content in the file. The initialization string should be of the format:
"RegionName=<RegionName>;Language=<Language>"
This merge strategy can be used to preserve designated custom regions inside an existing file and
regenerate the rest of the content in the file. The initialization string should be of the format:
"RegionNameRegex=<RegexExpression>;Language=<Language>"
A strongly-typed resource class, for looking up localized strings, etc.
Returns the cached ResourceManager instance used by this class.
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
Looks up a localized string similar to The trial key is invalid. Please try again or contact customer service for assistance..
Looks up a localized string similar to The key you entered appears to be a full license key. Please use the Register button to register your license..
Looks up a localized string similar to Request Trial Key.
Looks up a localized string similar to Trial Key.
Looks up a localized string similar to Please enter your {0} trial key and click Try. If you do not have a trial key, please click the Request Trial Key link on the left. If you already have a license, click the Register button below..
Looks up a localized string similar to Enter Trial Key.
Interface that all property refreshers must implement.
Context information passed into the IPropertyRefresher methods.
The property that the context points to.
The CodeTemplate instance that the context points to.
The working directory for resolving and creating relative paths.
Saves the project to a file.
Name of the file.
Saves the project to a file.
Name of the file.
if set to true make paths relative.
Saves project to string.
An XML string of the project.
Saves project to string.
if set to true apply variables.
An XML string of the project.
Makes the paths relative to the directory of .
Inserts variables into the property set where the value matches.
The original project.
A new instance of CodeSmithProject.
Replaces variables in the property set with the variables value.
The original project.
A new instance of CodeSmithProject.
Returns a that represents the current .
A that represents the current .
Loads the project from a file.
Name of the file.
Loads the project from a file.
Name of the file.
if set to true replace variables.
Loads the project from a string.
The XML fragment.
Loads from string.
The XML fragment.
if set to true replace variables.
Creates a new object that is a copy of the current instance.
A new object that is a copy of this instance.
Context information passed into the IPropertySerializer methods.
Initializes a new instance of the class.
The property that the context points to.
The CodeTemplate instance that the context points to.
Initializes a new instance of the class.
The property info.
The instance.
The working directory.
The property that the context points to.
The CodeTemplate instance that the context points to.
The working directory for resolving and creating relative paths.
This class can be used to convert to and from an XmlNode for a class that supports XML serialization.
This type editor can be used on a class that supports XML serialization to allow the user to pick an XML file and have that XML file deserialized into the target class.
This class can be used to convert to and from an XmlNode for a class that supports XML serialization.
Allows you to browse for an XSD Schema.
The AdoHelper class is intended to encapsulate high performance, scalable best practices for
common data access uses.
The type of the factory.
Get an IDataParameter for use in a SQL command
The name of the parameter to create
The value of the specified parameter
An IDataParameter object
Get an IDataParameter for use in a SQL command
The name of the parameter to create
The System.Data.DbType of the parameter
The size of the parameter
The System.Data.ParameterDirection of the parameter
An IDataParameter object
Get an IDataParameter for use in a SQL command
The name of the parameter to create
The System.Data.DbType of the parameter
The size of the parameter
The source column of the parameter
The System.Data.DataRowVersion of the parameter
An IDataParameter object
This method is used to attach array of IDataParameters to an IDbCommand.
This method will assign a value of DbNull to any parameter with a direction of
InputOutput and a value of null.
This behavior will prevent default values from being used, but
this will be the less common case than an intended pure output parameter (derived as InputOutput)
where the user provided no input value.
The command to which the parameters will be added
An array of IDataParameterParameters to be added to command
Thrown if command is null.
This method assigns dataRow column values to an IDataParameterCollection
The IDataParameterCollection to be assigned values
The dataRow used to hold the stored procedure's parameter values
Thrown if any of the parameter names are invalid.
This method assigns dataRow column values to an array of IDataParameters
Array of IDataParameters to be assigned values
The dataRow used to hold the stored procedure's parameter values
Thrown if any of the parameter names are invalid.
This method assigns an array of values to an array of IDataParameters
Array of IDataParameters to be assigned values
Array of objects holding the values to be assigned
Thrown if an incorrect number of parameters are passed.
This method cleans up the parameter syntax for the provider
The IDbCommand containing the parameters to clean up.
This method opens (if necessary) and assigns a connection, transaction, command type and parameters
to the provided command
The IDbCommand to be prepared
A valid IDbConnection, on which to execute this command
A valid IDbTransaction, or 'null'
The CommandType (stored procedure, text, etc.)
The stored procedure name or SQL command
An array of IDataParameters to be associated with the command or 'null' if no parameters are required
true if the connection was opened by the method, otherwose is false.
Thrown if command is null.
Thrown if commandText is null.
This method clears (if necessary) the connection, transaction, command type and parameters
from the provided command
Not implemented here because the behavior of this method differs on each data provider.
The IDbCommand to be cleared
Execute an IDbCommand (that returns a resultset) against the database specified in
the connection string.
The IDbCommand object to use
A DataSet containing the resultset generated by the command
Thrown if command is null.
Execute an IDbCommand (that returns a resultset and takes no parameters) against the database specified in
the connection string.
DataSet ds = helper.ExecuteDataset(connString, CommandType.StoredProcedure, "GetOrders");
A valid connection string for an IDbConnection
The CommandType (stored procedure, text, etc.)
The stored procedure name or SQL command
A DataSet containing the resultset generated by the command
Thrown if connectionString is null
Thrown if commandText is null
A DataSet containing the resultset generated by the command
Execute an IDbCommand (that returns a resultset) against the database specified in the connection string
using the provided parameters.
DataSet ds = helper.ExecuteDataset(connString, CommandType.StoredProcedure, "GetOrders", new IDbParameter("@prodid", 24));
A valid connection string for an IDbConnection
The CommandType (stored procedure, text, etc.)
The stored procedure name or SQL command
An array of IDbParamters used to execute the command
A DataSet containing the resultset generated by the command
Thrown if connectionString is null
Thrown if any of the IDataParameters.ParameterNames are null, or if the parameter count does not match the number of values supplied
Thrown if commandText is null
Thrown if the parameter count does not match the number of values supplied
Execute a stored procedure via an IDbCommand (that returns a resultset) against the database specified in
the connection string using the provided parameter values. This method will query the database to discover the parameters for the
stored procedure (the first time each stored procedure is called), and assign the values based on parameter order.
This method provides no access to output parameters or the stored procedure's return value parameter.
DataSet ds = helper.ExecuteDataset(connString, "GetOrders", 24, 36);
A valid connection string for an IDbConnection
The name of the stored procedure
An array of objects to be assigned as the input values of the stored procedure
A DataSet containing the resultset generated by the command
Thrown if connectionString is null
Thrown if spName is null
Execute an IDbCommand (that returns a resultset and takes no parameters) against the provided IDbConnection.
DataSet ds = helper.ExecuteDataset(conn, CommandType.StoredProcedure, "GetOrders");
A valid IDbConnection
The CommandType (stored procedure, text, etc.)
The stored procedure name or SQL command
A DataSet containing the resultset generated by the command
Thrown if commandText is null
Thrown if connection is null
Execute an IDbCommand (that returns a resultset) against the specified IDbConnection
using the provided parameters.
DataSet ds = helper.ExecuteDataset(conn, CommandType.StoredProcedure, "GetOrders", new IDataParameter("@prodid", 24));
A valid IDbConnection
The CommandType (stored procedure, text, etc.)
The stored procedure name or SQL command
An array of IDataParameters used to execute the command
A DataSet containing the resultset generated by the command
Thrown if any of the IDataParameters.ParameterNames are null, or if the parameter count does not match the number of values supplied
Thrown if commandText is null
Thrown if the parameter count does not match the number of values supplied
Thrown if connection is null
Execute a stored procedure via an IDbCommand (that returns a resultset) against the specified IDbConnection
using the provided parameter values. This method will query the database to discover the parameters for the
stored procedure (the first time each stored procedure is called), and assign the values based on parameter order.
This method provides no access to output parameters or the stored procedure's return value parameter.
DataSet ds = helper.ExecuteDataset(conn, "GetOrders", 24, 36);
A valid IDbConnection
The name of the stored procedure
An array of objects to be assigned as the input values of the stored procedure
A DataSet containing the resultset generated by the command
Thrown if spName is null
Thrown if the parameter count does not match the number of values supplied
Thrown if connection is null
Execute an IDbCommand (that returns a resultset and takes no parameters) against the provided IDbTransaction.
DataSet ds = helper.ExecuteDataset(trans, CommandType.StoredProcedure, "GetOrders");
A valid IDbTransaction
The CommandType (stored procedure, text, etc.)
The stored procedure name or SQL command
A DataSet containing the resultset generated by the command
Thrown if commandText is null
Thrown if transaction is null
Thrown if transaction.Connection is null
Execute an IDbCommand (that returns a resultset) against the specified IDbTransaction
using the provided parameters.
DataSet ds = helper.ExecuteDataset(trans, CommandType.StoredProcedure, "GetOrders", new IDataParameter("@prodid", 24));
A valid IDbTransaction
The CommandType (stored procedure, text, etc.)
The stored procedure name or SQL command
An array of IDataParameters used to execute the command
A DataSet containing the resultset generated by the command
Thrown if any of the IDataParameters.ParameterNames are null, or if the parameter count does not match the number of values supplied
Thrown if commandText is null
Thrown if the parameter count does not match the number of values supplied
Thrown if transaction is null
Thrown if transaction.Connection is null
Execute a stored procedure via an IDbCommand (that returns a resultset) against the specified
IDbTransaction using the provided parameter values. This method will query the database to discover the parameters for the
stored procedure (the first time each stored procedure is called), and assign the values based on parameter order.
This method provides no access to output parameters or the stored procedure's return value parameter.
DataSet ds = helper.ExecuteDataset(tran, "GetOrders", 24, 36);
A valid IDbTransaction
The name of the stored procedure
An array of objects to be assigned as the input values of the stored procedure
A DataSet containing the resultset generated by the command
Thrown if spName is null
Thrown if the parameter count does not match the number of values supplied
Thrown if transaction is null
Thrown if transaction.Connection is null
Execute an IDbCommand (that returns no resultset) against the database
The IDbCommand to execute
An int representing the number of rows affected by the command
Thrown if command is null.
Execute an IDbCommand (that returns no resultset and takes no parameters) against the database specified in
the connection string
A valid connection string for an IDbConnection
The CommandType (stored procedure, text, etc.)
The stored procedure name or SQL command
An int representing the number of rows affected by the command
Thrown if connectionString is null
Thrown if commandText is null
Execute an IDbCommand (that returns no resultset) against the database specified in the connection string
using the provided parameters
A valid connection string for an IDbConnection
The CommandType (stored procedure, text, etc.)
The stored procedure name or SQL command
An array of IDataParameters used to execute the command
An int representing the number of rows affected by the command
Thrown if connectionString is null
Thrown if any of the IDataParameters.ParameterNames are null, or if the parameter count does not match the number of values supplied
Thrown if commandText is null
Thrown if the parameter count does not match the number of values supplied
Execute a stored procedure via an IDbCommand (that returns no resultset) against the database specified in
the connection string using the provided parameter values. This method will query the database to discover the parameters for the
stored procedure (the first time each stored procedure is called), and assign the values based on parameter order.
This method provides no access to output parameters or the stored procedure's return value parameter.
A valid connection string for an IDbConnection
The name of the stored prcedure
An array of objects to be assigned as the input values of the stored procedure
An int representing the number of rows affected by the command
Thrown if connectionString is null
Thrown if spName is null
Thrown if the parameter count does not match the number of values supplied
Execute an IDbCommand (that returns no resultset and takes no parameters) against the provided IDbConnection.
A valid IDbConnection
The CommandType (stored procedure, text, etc.)
The stored procedure name or SQL command
An int representing the number of rows affected by the command
Thrown if commandText is null
Thrown if connection is null
Execute an IDbCommand (that returns no resultset) against the specified IDbConnection
using the provided parameters.
A valid IDbConnection
The CommandType (stored procedure, text, etc.)
The stored procedure name or SQL command
An array of IDbParamters used to execute the command
An int representing the number of rows affected by the command
Thrown if any of the IDataParameters.ParameterNames are null, or if the parameter count does not match the number of values supplied
Thrown if commandText is null
Thrown if the parameter count does not match the number of values supplied
Thrown if connection is null
Execute a stored procedure via an IDbCommand (that returns no resultset) against the specified IDbConnection
using the provided parameter values. This method will query the database to discover the parameters for the
stored procedure (the first time each stored procedure is called), and assign the values based on parameter order.
This method provides no access to output parameters or the stored procedure's return value parameter.
A valid IDbConnection
The name of the stored procedure
An array of objects to be assigned as the input values of the stored procedure
An int representing the number of rows affected by the command
Thrown if spName is null
Thrown if the parameter count does not match the number of values supplied
Thrown if connection is null
Execute an IDbCommand (that returns no resultset and takes no parameters) against the provided IDbTransaction.
A valid IDbTransaction
The CommandType (stored procedure, text, etc.)
The stored procedure name or SQL command
An int representing the number of rows affected by the command
Thrown if commandText is null
Thrown if transaction is null
Thrown if transaction.Connection is null
Execute an IDbCommand (that returns no resultset) against the specified IDbTransaction
using the provided parameters.
A valid IDbTransaction
The CommandType (stored procedure, text, etc.)
The stored procedure name or SQL command
An array of IDataParameters used to execute the command
An int representing the number of rows affected by the command
Thrown if any of the IDataParameters.ParameterNames are null, or if the parameter count does not match the number of values supplied
Thrown if commandText is null
Thrown if the parameter count does not match the number of values supplied
Thrown if transaction is null
Thrown if transaction.Connection is null
Execute a stored procedure via an IDbCommand (that returns no resultset) against the specified
IDbTransaction using the provided parameter values. This method will query the database to discover the parameters for the
stored procedure (the first time each stored procedure is called), and assign the values based on parameter order.
This method provides no access to output parameters or the stored procedure's return value parameter.
A valid IDbTransaction
The name of the stored procedure
An array of objects to be assigned as the input values of the stored procedure
An int representing the number of rows affected by the command
Thrown if spName is null
Thrown if the parameter count does not match the number of values supplied
Thrown if transaction is null
Thrown if transaction.Connection is null
Execute an IDbCommand (that returns a resultset) against the database specified in
the connection string.
The IDbCommand object to use
A IDataReader containing the resultset generated by the command
Thrown if command is null.
Execute an IDbCommand (that returns a resultset) against the database specified in
the connection string.
The IDbCommand object to use
Enum indicating whether the connection was created internally or externally.
A IDataReader containing the resultset generated by the command
Thrown if command is null.
Create and prepare an IDbCommand, and call ExecuteReader with the appropriate CommandBehavior.
If we created and opened the connection, we want the connection to be closed when the DataReader is closed.
If the caller provided the connection, we want to leave it to them to manage.
A valid IDbConnection, on which to execute this command
A valid IDbTransaction, or 'null'
The CommandType (stored procedure, text, etc.)
The stored procedure name or SQL command
An array of IDataParameters to be associated with the command or 'null' if no parameters are required
Indicates whether the connection parameter was provided by the caller, or created by AdoHelper
IDataReader containing the results of the command
Thrown if any of the IDataParameters.ParameterNames are null, or if the parameter count does not match the number of values supplied
Thrown if commandText is null
Thrown if the parameter count does not match the number of values supplied
Thrown if connection is null
Execute an IDbCommand (that returns a resultset and takes no parameters) against the database specified in
the connection string.
A valid connection string for an IDbConnection
The CommandType (stored procedure, text, etc.)
The stored procedure name or SQL command
A IDataReader containing the resultset generated by the command
Thrown if connectionString is null
Thrown if commandText is null
Execute an IDbCommand (that returns a resultset) against the database specified in the connection string
using the provided parameters.
A valid connection string for an IDbConnection
The CommandType (stored procedure, text, etc.)
The stored procedure name or SQL command
An array of IDataParameters used to execute the command
A IDataReader containing the resultset generated by the command
Thrown if connectionString is null
Thrown if any of the IDataParameters.ParameterNames are null, or if the parameter count does not match the number of values supplied
Thrown if commandText is null
Thrown if the parameter count does not match the number of values supplied
Execute a stored procedure via an IDbCommand (that returns a resultset) against the database specified in
the connection string using the provided parameter values. This method will query the database to discover the parameters for the
stored procedure (the first time each stored procedure is called), and assign the values based on parameter order.
This method provides no access to output parameters or the stored procedure's return value parameter.
IDataReader dr = helper.ExecuteReader(connString, "GetOrders", 24, 36);
A valid connection string for an IDbConnection
The name of the stored procedure
An array of objects to be assigned as the input values of the stored procedure
an IDataReader containing the resultset generated by the command
Thrown if connectionString is null
Thrown if spName is null
Thrown if the parameter count does not match the number of values supplied
Execute an IDbCommand (that returns a resultset and takes no parameters) against the provided IDbConnection.
IDataReader dr = helper.ExecuteReader(conn, CommandType.StoredProcedure, "GetOrders");
A valid IDbConnection
The CommandType (stored procedure, text, etc.)
The stored procedure name or SQL command
an IDataReader containing the resultset generated by the command
Thrown if commandText is null
Execute an IDbCommand (that returns a resultset) against the specified IDbConnection
using the provided parameters.
IDataReader dr = helper.ExecuteReader(conn, CommandType.StoredProcedure, "GetOrders", new IDataParameter("@prodid", 24));
A valid IDbConnection
The CommandType (stored procedure, text, etc.)
The stored procedure name or SQL command
An array of IDataParameters used to execute the command
an IDataReader containing the resultset generated by the command
Thrown if any of the IDataParameters.ParameterNames are null, or if the parameter count does not match the number of values supplied
Thrown if commandText is null
Thrown if the parameter count does not match the number of values supplied
Thrown if connection is null
Execute a stored procedure via an IDbCommand (that returns a resultset) against the specified IDbConnection
using the provided parameter values. This method will query the database to discover the parameters for the
stored procedure (the first time each stored procedure is called), and assign the values based on parameter order.
This method provides no access to output parameters or the stored procedure's return value parameter.
IDataReader dr = helper.ExecuteReader(conn, "GetOrders", 24, 36);
A valid IDbConnection
The name of the stored procedure
An array of objects to be assigned as the input values of the stored procedure
an IDataReader containing the resultset generated by the command
Thrown if spName is null
Thrown if the parameter count does not match the number of values supplied
Thrown if connection is null
Execute an IDbCommand (that returns a resultset and takes no parameters) against the provided IDbTransaction.
IDataReader dr = helper.ExecuteReader(trans, CommandType.StoredProcedure, "GetOrders");
A valid IDbTransaction
The CommandType (stored procedure, text, etc.)
The stored procedure name or SQL command
A IDataReader containing the resultset generated by the command
Thrown if commandText is null
Execute an IDbCommand (that returns a resultset) against the specified IDbTransaction
using the provided parameters.
IDataReader dr = helper.ExecuteReader(trans, CommandType.StoredProcedure, "GetOrders", new IDataParameter("@prodid", 24));
A valid IDbTransaction
The CommandType (stored procedure, text, etc.)
The stored procedure name or SQL command
An array of IDataParameters used to execute the command
A IDataReader containing the resultset generated by the command
Execute a stored procedure via an IDbCommand (that returns a resultset) against the specified
IDbTransaction using the provided parameter values. This method will query the database to discover the parameters for the
stored procedure (the first time each stored procedure is called), and assign the values based on parameter order.
This method provides no access to output parameters or the stored procedure's return value parameter.
IDataReader dr = helper.ExecuteReader(tran, "GetOrders", 24, 36);
A valid IDbTransaction
The name of the stored procedure
An array of objects to be assigned as the input values of the stored procedure
an IDataReader containing the resultset generated by the command
Thrown if spName is null
Thrown if the parameter count does not match the number of values supplied
Thrown if transaction is null
Thrown if transaction.Connection is null
Execute an IDbCommand (that returns a 1x1 resultset) against the database specified in
the connection string.
The IDbCommand to execute
An object containing the value in the 1x1 resultset generated by the command
Thrown if command is null.
Execute an IDbCommand (that returns a 1x1 resultset and takes no parameters) against the database specified in
the connection string.
int orderCount = (int)helper.ExecuteScalar(connString, CommandType.StoredProcedure, "GetOrderCount");
A valid connection string for an IDbConnection
The CommandType (stored procedure, text, etc.)
The stored procedure name or SQL command
An object containing the value in the 1x1 resultset generated by the command
Thrown if connectionString is null
Thrown if commandText is null
Execute an IDbCommand (that returns a 1x1 resultset) against the database specified in the connection string
using the provided parameters.
A valid connection string for an IDbConnection
The CommandType (stored procedure, text, etc.)
The stored procedure name or SQL command
An array of IDataParameters used to execute the command
An object containing the value in the 1x1 resultset generated by the command
Thrown if connectionString is null
Thrown if any of the IDataParameters.ParameterNames are null, or if the parameter count does not match the number of values supplied
Thrown if commandText is null
Thrown if the parameter count does not match the number of values supplied
Execute a stored procedure via an IDbCommand (that returns a 1x1 resultset) against the database specified in
the connection string using the provided parameter values. This method will query the database to discover the parameters for the
stored procedure (the first time each stored procedure is called), and assign the values based on parameter order.
This method provides no access to output parameters or the stored procedure's return value parameter.
int orderCount = (int)helper.ExecuteScalar(connString, "GetOrderCount", 24, 36);
A valid connection string for an IDbConnection
The name of the stored procedure
An array of objects to be assigned as the input values of the stored procedure
An object containing the value in the 1x1 resultset generated by the command
Thrown if connectionString is null
Thrown if spName is null
Thrown if the parameter count does not match the number of values supplied
Execute an IDbCommand (that returns a 1x1 resultset and takes no parameters) against the provided IDbConnection.
int orderCount = (int)helper.ExecuteScalar(conn, CommandType.StoredProcedure, "GetOrderCount");
A valid IDbConnection
The CommandType (stored procedure, text, etc.)
The stored procedure name or SQL command
An object containing the value in the 1x1 resultset generated by the command
Thrown if commandText is null
Execute an IDbCommand (that returns a 1x1 resultset) against the specified IDbConnection
using the provided parameters.
A valid IDbConnection
The CommandType (stored procedure, text, etc.)
The stored procedure name or SQL command
An array of IDataParameters used to execute the command
An object containing the value in the 1x1 resultset generated by the command
Thrown if any of the IDataParameters.ParameterNames are null, or if the parameter count does not match the number of values supplied
Thrown if commandText is null
Thrown if the parameter count does not match the number of values supplied
Thrown if connection is null
Execute a stored procedure via an IDbCommand (that returns a 1x1 resultset) against the specified IDbConnection
using the provided parameter values. This method will query the database to discover the parameters for the
stored procedure (the first time each stored procedure is called), and assign the values based on parameter order.
This method provides no access to output parameters or the stored procedure's return value parameter.
int orderCount = (int)helper.ExecuteScalar(conn, "GetOrderCount", 24, 36);
A valid IDbConnection
The name of the stored procedure
An array of objects to be assigned as the input values of the stored procedure
An object containing the value in the 1x1 resultset generated by the command
Thrown if spName is null
Thrown if the parameter count does not match the number of values supplied
Thrown if connection is null
Execute an IDbCommand (that returns a 1x1 resultset and takes no parameters) against the provided IDbTransaction.
int orderCount = (int)helper.ExecuteScalar(tran, CommandType.StoredProcedure, "GetOrderCount");
A valid IDbTransaction
The CommandType (stored procedure, text, etc.)
The stored procedure name or SQL command
An object containing the value in the 1x1 resultset generated by the command
Thrown if commandText is null
Execute an IDbCommand (that returns a 1x1 resultset) against the specified IDbTransaction
using the provided parameters.
A valid IDbTransaction
The CommandType (stored procedure, text, etc.)
The stored procedure name or SQL command
An array of IDbParamters used to execute the command
An object containing the value in the 1x1 resultset generated by the command
Thrown if any of the IDataParameters.ParameterNames are null, or if the parameter count does not match the number of values supplied
Thrown if commandText is null
Thrown if the parameter count does not match the number of values supplied
Thrown if transaction is null
Thrown if transaction.Connection is null
Execute a stored procedure via an IDbCommand (that returns a 1x1 resultset) against the specified
IDbTransaction using the provided parameter values. This method will query the database to discover the parameters for the
stored procedure (the first time each stored procedure is called), and assign the values based on parameter order.
This method provides no access to output parameters or the stored procedure's return value parameter.
int orderCount = (int)helper.ExecuteScalar(tran, "GetOrderCount", 24, 36);
A valid IDbTransaction
The name of the stored procedure
An array of objects to be assigned as the input values of the stored procedure
An object containing the value in the 1x1 resultset generated by the command
Thrown if any of the IDataParameters.ParameterNames are null, or if the parameter count does not match the number of values supplied
Thrown if commandText is null
Thrown if spName is null
Thrown if the parameter count does not match the number of values supplied
Thrown if transaction is null
Thrown if transaction.Connection is null
Thrown if the transaction is rolled back or commmitted
Execute an IDbCommand (that returns a resultset) against the database specified in
the connection string.
The IDbCommand to execute
A DataSet wich will contain the resultset generated by the command
This array will be used to create table mappings allowing the DataTables to be referenced
by a user defined name (probably the actual table name)
Thrown if command is null.
Execute an IDbCommand (that returns a resultset and takes no parameters) against the database specified in
the connection string.
helper.FillDataset(connString, CommandType.StoredProcedure, "GetOrders", ds, new string[] {"orders"});
A valid connection string for an IDbConnection
The CommandType (stored procedure, text, etc.)
The stored procedure name or SQL command
A DataSet wich will contain the resultset generated by the command
This array will be used to create table mappings allowing the DataTables to be referenced
by a user defined name (probably the actual table name)
Thrown if connectionString is null
Thrown if commandText is null
Execute an IDbCommand (that returns a resultset) against the database specified in the connection string
using the provided parameters.
A valid connection string for an IDbConnection
The CommandType (stored procedure, text, etc.)
The stored procedure name or SQL command
An array of IDataParameters used to execute the command
A DataSet wich will contain the resultset generated by the command
This array will be used to create table mappings allowing the DataTables to be referenced
by a user defined name (probably the actual table name)
Thrown if connectionString is null
Thrown if any of the IDataParameters.ParameterNames are null, or if the parameter count does not match the number of values supplied
Thrown if commandText is null
Thrown if the parameter count does not match the number of values supplied
Execute a stored procedure via an IDbCommand (that returns a resultset) against the database specified in
the connection string using the provided parameter values. This method will query the database to discover the parameters for the
stored procedure (the first time each stored procedure is called), and assign the values based on parameter order.
This method provides no access to output parameters or the stored procedure's return value parameter.
helper.FillDataset(connString, CommandType.StoredProcedure, "GetOrders", ds, new string[] {"orders"}, 24);
A valid connection string for an IDbConnection
The name of the stored procedure
A dataset wich will contain the resultset generated by the command
This array will be used to create table mappings allowing the DataTables to be referenced
by a user defined name (probably the actual table name)
An array of objects to be assigned as the input values of the stored procedure
Thrown if connectionString is null
Thrown if spName is null
Thrown if the parameter count does not match the number of values supplied
Execute an IDbCommand (that returns a resultset and takes no parameters) against the provided IDbConnection.
helper.FillDataset(conn, CommandType.StoredProcedure, "GetOrders", ds, new string[] {"orders"});
A valid IDbConnection
The CommandType (stored procedure, text, etc.)
The stored procedure name or SQL command
A dataset wich will contain the resultset generated by the command
This array will be used to create table mappings allowing the DataTables to be referenced
by a user defined name (probably the actual table name)
Thrown if commandText is null
Thrown if connection is null
Execute an IDbCommand (that returns a resultset) against the specified IDbConnection
using the provided parameters.
A valid IDbConnection
The CommandType (stored procedure, text, etc.)
The stored procedure name or SQL command
A DataSet wich will contain the resultset generated by the command
This array will be used to create table mappings allowing the DataTables to be referenced
by a user defined name (probably the actual table name)
An array of IDataParameters used to execute the command
Thrown if commandText is null
Thrown if connection is null
Execute a stored procedure via an IDbCommand (that returns a resultset) against the specified IDbConnection
using the provided parameter values. This method will query the database to discover the parameters for the
stored procedure (the first time each stored procedure is called), and assign the values based on parameter order.
This method provides no access to output parameters or the stored procedure's return value parameter.
helper.FillDataset(conn, "GetOrders", ds, new string[] {"orders"}, 24, 36);
A valid IDbConnection
The name of the stored procedure
A dataset wich will contain the resultset generated by the command
This array will be used to create table mappings allowing the DataTables to be referenced
by a user defined name (probably the actual table name)
An array of objects to be assigned as the input values of the stored procedure
Thrown if spName is null
Thrown if connection is null
Execute an IDbCommand (that returns a resultset and takes no parameters) against the provided IDbTransaction.
helper.FillDataset(tran, CommandType.StoredProcedure, "GetOrders", ds, new string[] {"orders"});
A valid IDbTransaction
The CommandType (stored procedure, text, etc.)
The stored procedure name or SQL command
A dataset wich will contain the resultset generated by the command
This array will be used to create table mappings allowing the DataTables to be referenced
by a user defined name (probably the actual table name)
Thrown if commandText is null
Thrown if transaction is null
Thrown if transaction.Connection is null
Execute an IDbCommand (that returns a resultset) against the specified IDbTransaction
using the provided parameters.
A valid IDbTransaction
The CommandType (stored procedure, text, etc.)
The stored procedure name or SQL command
A DataSet wich will contain the resultset generated by the command
This array will be used to create table mappings allowing the DataTables to be referenced
by a user defined name (probably the actual table name)
An array of IDataParameters used to execute the command
Thrown if commandText is null
Thrown if transaction is null
Thrown if transaction.Connection is null
Execute a stored procedure via an IDbCommand (that returns a resultset) against the specified
IDbTransaction using the provided parameter values. This method will query the database to discover the parameters for the
stored procedure (the first time each stored procedure is called), and assign the values based on parameter order.
This method provides no access to output parameters or the stored procedure's return value parameter.
helper.FillDataset(tran, "GetOrders", ds, new string[] {"orders"}, 24, 36);
A valid IDbTransaction
The name of the stored procedure
A dataset wich will contain the resultset generated by the command
This array will be used to create table mappings allowing the DataTables to be referenced
by a user defined name (probably the actual table name)
An array of objects to be assigned as the input values of the stored procedure
Thrown if spName is null
Thrown if transaction is null
Thrown if transaction.Connection is null
Private helper method that execute an IDbCommand (that returns a resultset) against the specified IDbTransaction and IDbConnection
using the provided parameters.
A valid IDbConnection
A valid IDbTransaction
The CommandType (stored procedure, text, etc.)
The stored procedure name or SQL command
A DataSet wich will contain the resultset generated by the command
This array will be used to create table mappings allowing the DataTables to be referenced
by a user defined name (probably the actual table name)
An array of IDataParameters used to execute the command
This method consumes the RowUpdatingEvent and passes it on to the consumer specifed in the call to UpdateDataset
The object that generated the event
The System.Data.Common.RowUpdatingEventArgs
This method consumes the RowUpdatedEvent and passes it on to the consumer specifed in the call to UpdateDataset
The object that generated the event
The System.Data.Common.RowUpdatingEventArgs
Set up a command for updating a DataSet.
command object to prepare
output parameter specifying whether the connection used should be closed by the DAAB
An IDbCommand object
Executes the respective command for each inserted, updated, or deleted row in the DataSet.
helper.UpdateDataset(conn, insertCommand, deleteCommand, updateCommand, dataSet, "Order");
A valid SQL statement or stored procedure to insert new records into the data source
A valid SQL statement or stored procedure to delete records from the data source
A valid SQL statement or stored procedure used to update records in the data source
The DataSet used to update the data source
The DataTable used to update the data source.
Executes the IDbCommand for each inserted, updated, or deleted row in the DataSet also implementing RowUpdating and RowUpdated Event Handlers
RowUpdatingEventHandler rowUpdatingHandler = new RowUpdatingEventHandler( OnRowUpdating );
RowUpdatedEventHandler rowUpdatedHandler = new RowUpdatedEventHandler( OnRowUpdated );
helper.UpdateDataSet(sqlInsertCommand, sqlDeleteCommand, sqlUpdateCommand, dataSet, "Order", rowUpdatingHandler, rowUpdatedHandler);
A valid SQL statement or stored procedure to insert new records into the data source
A valid SQL statement or stored procedure to delete records from the data source
A valid SQL statement or stored procedure used to update records in the data source
The DataSet used to update the data source
The DataTable used to update the data source.
RowUpdatingEventHandler
RowUpdatedEventHandler
Simplify the creation of an IDbCommand object by allowing
a stored procedure and optional parameters to be provided
IDbCommand command = helper.CreateCommand(conn, "AddCustomer", "CustomerID", "CustomerName");
A valid connection string for an IDbConnection
The name of the stored procedure
An array of string to be assigned as the source columns of the stored procedure parameters
A valid IDbCommand object
Thrown if connectionString is null
Thrown if any of the IDataParameters.ParameterNames are null, or if the parameter count does not match the number of values supplied
Thrown if spName is null
Thrown if the parameter count does not match the number of values supplied
Simplify the creation of an IDbCommand object by allowing
a stored procedure and optional parameters to be provided
IDbCommand command = helper.CreateCommand(conn, "AddCustomer", "CustomerID", "CustomerName");
A valid IDbConnection object
The name of the stored procedure
An array of string to be assigned as the source columns of the stored procedure parameters
A valid IDbCommand object
Thrown if spName is null
Thrown if connection is null
Simplify the creation of an IDbCommand object by allowing
a stored procedure and optional parameters to be provided
A valid connection string for an IDbConnection
A valid SQL statement
A System.Data.CommandType
The parameters for the SQL statement
A valid IDbCommand object
Simplify the creation of an IDbCommand object by allowing
a stored procedure and optional parameters to be provided
IDbCommand command = helper.CreateCommand(conn, "AddCustomer", "CustomerID", "CustomerName");
A valid IDbConnection object
A valid SQL statement
A System.Data.CommandType
The parameters for the SQL statement
A valid IDbCommand object
Execute a stored procedure via an IDbCommand (that returns no resultset)
against the database specified in the connection string using the
dataRow column values as the stored procedure's parameters values.
This method will assign the parameter values based on row values.
The IDbCommand to execute
The dataRow used to hold the stored procedure's parameter values.
An int representing the number of rows affected by the command
Thrown if command is null.
Execute a stored procedure via an IDbCommand (that returns no resultset) against the database specified in
the connection string using the dataRow column values as the stored procedure's parameters values.
This method will query the database to discover the parameters for the
stored procedure (the first time each stored procedure is called), and assign the values based on row values.
A valid connection string for an IDbConnection
The name of the stored procedure
The dataRow used to hold the stored procedure's parameter values.
An int representing the number of rows affected by the command
Thrown if connectionString is null
Thrown if spName is null
Execute a stored procedure via an IDbCommand (that returns no resultset) against the specified IDbConnection
using the dataRow column values as the stored procedure's parameters values.
This method will query the database to discover the parameters for the
stored procedure (the first time each stored procedure is called), and assign the values based on row values.
A valid IDbConnection object
The name of the stored procedure
The dataRow used to hold the stored procedure's parameter values.
An int representing the number of rows affected by the command
Thrown if spName is null
Thrown if connection is null
Execute a stored procedure via an IDbCommand (that returns no resultset) against the specified
IDbTransaction using the dataRow column values as the stored procedure's parameters values.
This method will query the database to discover the parameters for the
stored procedure (the first time each stored procedure is called), and assign the values based on row values.
A valid IDbTransaction object
The name of the stored procedure
The dataRow used to hold the stored procedure's parameter values.
An int representing the number of rows affected by the command
Thrown if spName is null
Thrown if transaction is null
Thrown if transaction.Connection is null
Execute a stored procedure via an IDbCommand (that returns a resultset) against the database specified in
the connection string using the dataRow column values as the stored procedure's parameters values.
This method will assign the paraemter values based on row values.
The IDbCommand to execute
The dataRow used to hold the stored procedure's parameter values.
A DataSet containing the resultset generated by the command
Thrown if command is null.
Execute a stored procedure via an IDbCommand (that returns a resultset) against the database specified in
the connection string using the dataRow column values as the stored procedure's parameters values.
This method will query the database to discover the parameters for the
stored procedure (the first time each stored procedure is called), and assign the values based on row values.
A valid connection string for an IDbConnection
The name of the stored procedure
The dataRow used to hold the stored procedure's parameter values.
A DataSet containing the resultset generated by the command
Thrown if connectionString is null
Thrown if spName is null
Execute a stored procedure via an IDbCommand (that returns a resultset) against the specified IDbConnection
using the dataRow column values as the store procedure's parameters values.
This method will query the database to discover the parameters for the
stored procedure (the first time each stored procedure is called), and assign the values based on row values.
A valid IDbConnection object
The name of the stored procedure
The dataRow used to hold the stored procedure's parameter values.
A DataSet containing the resultset generated by the command
Thrown if spName is null
Thrown if connection is null
Execute a stored procedure via an IDbCommand (that returns a resultset) against the specified IDbTransaction
using the dataRow column values as the stored procedure's parameters values.
This method will query the database to discover the parameters for the
stored procedure (the first time each stored procedure is called), and assign the values based on row values.
A valid IDbTransaction object
The name of the stored procedure
The dataRow used to hold the stored procedure's parameter values.
A DataSet containing the resultset generated by the command
Thrown if spName is null
Thrown if transaction is null
Thrown if transaction.Connection is null
Execute a stored procedure via an IDbCommand (that returns a resultset) against the database specified in
the connection string using the dataRow column values as the stored procedure's parameters values.
This method will assign the parameter values based on parameter order.
The IDbCommand to execute
The dataRow used to hold the stored procedure's parameter values.
A IDataReader containing the resultset generated by the command
Thrown if command is null.
Execute a stored procedure via an IDbCommand (that returns a resultset) against the database specified in
the connection string using the dataRow column values as the stored procedure's parameters values.
This method will query the database to discover the parameters for the
stored procedure (the first time each stored procedure is called), and assign the values based on parameter order.
A valid connection string for an IDbConnection
The name of the stored procedure
The dataRow used to hold the stored procedure's parameter values.
A IDataReader containing the resultset generated by the command
Thrown if connectionString is null
Thrown if spName is null
Execute a stored procedure via an IDbCommand (that returns a resultset) against the specified IDbConnection
using the dataRow column values as the stored procedure's parameters values.
This method will query the database to discover the parameters for the
stored procedure (the first time each stored procedure is called), and assign the values based on parameter order.
A valid IDbConnection object
The name of the stored procedure
The dataRow used to hold the stored procedure's parameter values.
A IDataReader containing the resultset generated by the command
Thrown if spName is null
Thrown if connection is null
Execute a stored procedure via an IDbCommand (that returns a resultset) against the specified IDbTransaction
using the dataRow column values as the stored procedure's parameters values.
This method will query the database to discover the parameters for the
stored procedure (the first time each stored procedure is called), and assign the values based on parameter order.
A valid IDbTransaction object
The name of the stored procedure
The dataRow used to hold the stored procedure's parameter values.
A IDataReader containing the resultset generated by the command
Thrown if spName is null
Thrown if transaction is null
Thrown if transaction.Connection is null
Execute a stored procedure via an IDbCommand (that returns a 1x1 resultset) against the database specified in
the connection string using the dataRow column values as the stored procedure's parameters values.
This method will assign the parameter values based on parameter order.
The IDbCommand to execute
The dataRow used to hold the stored procedure's parameter values.
An object containing the value in the 1x1 resultset generated by the command
Thrown if command is null.
Execute a stored procedure via an IDbCommand (that returns a 1x1 resultset) against the database specified in
the connection string using the dataRow column values as the stored procedure's parameters values.
This method will query the database to discover the parameters for the
stored procedure (the first time each stored procedure is called), and assign the values based on parameter order.
A valid connection string for an IDbConnection
The name of the stored procedure
The dataRow used to hold the stored procedure's parameter values.
An object containing the value in the 1x1 resultset generated by the command
Thrown if connectionString is null
Thrown if spName is null
Execute a stored procedure via an IDbCommand (that returns a 1x1 resultset) against the specified IDbConnection
using the dataRow column values as the stored procedure's parameters values.
This method will query the database to discover the parameters for the
stored procedure (the first time each stored procedure is called), and assign the values based on parameter order.
A valid IDbConnection object
The name of the stored procedure
The dataRow used to hold the stored procedure's parameter values.
An object containing the value in the 1x1 resultset generated by the command
Thrown if spName is null
Thrown if connection is null
Execute a stored procedure via an IDbCommand (that returns a 1x1 resultset) against the specified IDbTransaction
using the dataRow column values as the stored procedure's parameters values.
This method will query the database to discover the parameters for the
stored procedure (the first time each stored procedure is called), and assign the values based on parameter order.
A valid IDbTransaction object
The name of the stored procedure
The dataRow used to hold the stored procedure's parameter values.
An object containing the value in the 1x1 resultset generated by the command
Thrown if spName is null
Thrown if transaction is null
Thrown if transaction.Connection is null
Checks for the existence of a return value parameter in the parametervalues
An array of objects to be assigned as the input values of the stored procedure
true if the parameterValues contains a return value parameter, false otherwise
Check to see if the parameter values passed to the helper are, in fact, IDataParameters.
Array of parameter values passed to helper
new array of IDataParameters built from parameter values
True if the parameter values are IDataParameters
Retrieves the set of IDataParameters appropriate for the stored procedure
This method will query the database for this information, and then store it in a cache for future requests.
A valid connection string for an IDbConnection
The name of the stored procedure
An array of IDataParameterParameters
Thrown if connectionString is null
Thrown if spName is null
Retrieves the set of IDataParameters appropriate for the stored procedure
This method will query the database for this information, and then store it in a cache for future requests.
A valid connection string for an IDbConnection
The name of the stored procedure
A bool value indicating whether the return value parameter should be included in the results
An array of IDataParameters
Thrown if connectionString is null
Thrown if spName is null
Retrieves the set of IDataParameters appropriate for the stored procedure
This method will query the database for this information, and then store it in a cache for future requests.
A valid IDataConnection object
The name of the stored procedure
An array of IDataParameters
Thrown if spName is null
Thrown if connection is null
Retrieves the set of IDataParameters appropriate for the stored procedure
This method will query the database for this information, and then store it in a cache for future requests.
A valid IDbConnection object
The name of the stored procedure
A bool value indicating whether the return value parameter should be included in the results
An array of IDataParameters
Thrown if spName is null
Thrown if connection is null
Retrieves the set of IDataParameters appropriate for the stored procedure
A valid IDbConnection object
The name of the stored procedure
A bool value indicating whether the return value parameter should be included in the results
An array of IDataParameters
Thrown if spName is null
Thrown if connection is null
Retrieve a parameter array from the cache
A valid connection string for an IDbConnection
The stored procedure name or SQL command
An array of IDataParameters
Thrown if connectionString is null
Thrown if commandText is null
Retrieve a parameter array from the cache
A valid IDbConnection object
The stored procedure name or SQL command
An array of IDataParameters
Thrown if commandText is null
Thrown if connection is null
Retrieve a parameter array from the cache
A valid IDbConnection object
The stored procedure name or SQL command
An array of IDataParameters
Add parameter array to the cache
A valid connection string for an IDbConnection
The stored procedure name or SQL command
An array of IDataParameters to be cached
Add parameter array to the cache
A valid IDbConnection
The stored procedure name or SQL command
An array of IDataParameters to be cached
Add parameter array to the cache
A valid IDbConnection
The stored procedure name or SQL command
An array of IDataParameters to be cached
Resolve at run time the appropriate set of IDataParameters for a stored procedure
A valid IDbConnection object
The name of the stored procedure
Whether or not to include their return value parameter
The parameter array discovered.
Thrown if spName is null
Thrown if connection is null
Internal handler used for bubbling up the event to the user
Internal handler used for bubbling up the event to the user
Returns an IDbConnection object for the given connection string
The connection string to be used to create the connection
An IDbConnection object
Thrown if connectionString is null
Returns an IDbDataAdapter object
The IDbDataAdapter
Calls the CommandBuilder.DeriveParameters method for the specified provider, doing any setup and cleanup necessary
The IDbCommand referencing the stored procedure from which the parameter information is to be derived. The derived parameters are added to the Parameters collection of the IDbCommand.
Returns an IDataParameter object
The IDataParameter object
Provider specific code to set up the updating/ed event handlers used by UpdateDataset
DataAdapter to attach the event handlers to
The handler to be called when a row is updating
The handler to be called when a row is updated
Returns an array of IDataParameters of the specified size
size of the array
The array of IDataParameters
Handle any provider-specific issues with BLOBs here by "washing" the IDataParameter and returning a new one that is set up appropriately for the provider.
The IDbConnection to use in cleansing the parameter
The parameter before cleansing
The parameter after it's been cleansed.
Delegate for creating a RowUpdatedEvent handler
The object that published the event
The RowUpdatedEventArgs for the event
Delegate for creating a RowUpdatingEvent handler
The object that published the event
The RowUpdatingEventArgs for the event
This enum is used to indicate whether the connection was provided by the caller, or created by AdoHelper, so that
we can set the appropriate CommandBehavior when calling ExecuteReader()
Connection is owned and managed by ADOHelper
Connection is owned and managed by the caller
ADOHelperParameterCache provides functions to leverage a static cache of procedure parameters, and the
ability to discover parameters for stored procedures at run-time.
Deep copy of cached IDataParameter array
Add parameter array to the cache
A valid connection string for an IDbConnection
The stored procedure name or SQL command
An array of IDataParameters to be cached
Thrown if commandText is null
Thrown if connectionString is null
Retrieve a parameter array from the cache
A valid connection string for an IDbConnection
The stored procedure name or SQL command
An array of IDataParameters
Thrown if commandText is null
Thrown if connectionString is null
Initializes a new instance of the class.
Initializes a new instance of the class.
Name of the friendly.
Releases unmanaged resources and performs other cleanup operations before the
is reclaimed by garbage collection.
Creates an instance in the .
Creates an instance in the .
The constructor args.
Performs application-defined tasks associated with freeing,
releasing, or resetting unmanaged resources.
Need a .
true if a is needed.
Gets the CodeSmith .
The CodeSmith .
Checks an exception for a licensing related error.
The exception
Returns true if a licensing exception is found.
Gets the current logger instance or falls back to a default logger.
Creates a relative path from one file or folder to another.
Contains the directory that defines the start of the relative path.
Contains the path that defines the endpoint of the relative path.
The relative path from the start directory to the end path.
Provides enumerated values that indicate the current status of a process.
Process is ready to run.
Process is currently running.
Process is complete.
Process ran with an error.
Process timed out.
A base class to run a process.
Initializes a new instance of the class.
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Deletes the specified temporary file.
Name of the file.
Runs the exectuable file with the specified task parameters.
true if the task runs successfully; otherwise, false.
Runs the executable file.
The path to tool.
The command line arguments.
The returned exit code of the executable file.
Generates the command line arguments.
Returns a string value containing the command line arguments to pass directly to the executable file.
Generates the full path to tool.
Returns the fully qualified path to the executable file.
Gets the working directory.
Returns the directory in which to run the executable file.
Indicates whether task execution should be skipped.
true to skip task execution; otherwise, false.
Indicates whether all task parameters are valid.
true if all task parameters are valid; otherwise, falsec>.
Releases unmanaged and - optionally - managed resources
true to release both managed and unmanaged resources; false to release only unmanaged resources.
Appends to the standard error writer.
The message to write.
Appends to the standard error writer.
A composite format string.
An System.Object array containing zero or more objects to format.
Gets the override value of the PATH environment variable.
The override value of the PATH environment variable.
Gets the returned exit code of the executable file.
The returned exit code of the executable file.
Gets the status of the process.
The status of the process.
Gets the Encoding of the standard error stream of the task.
The Encoding of the standard error stream of the task.
Gets the Encoding of the standard output stream of the task.
The Encoding of the standard output stream of the task.
Gets or sets the amount of time after which the task executable is terminated.
The amount of time after which the task executable is terminated.
Gets the name of the executable file to run.
The name of the executable file to run.
Gets or sets the path of the executable file to run.
The path of the executable file to run.
Gets the standard output stream.
The standard output.
Gets the standard error stream.
The standard error.
Gets or sets the standard error writer.
The standard error writer.
Gets or sets the standard output writer.
The standard output writer.
Utility class for working with the registry.
NOTE: At some time it would be nice to add automatic detection to see if values exist in the Wow6432Node keys.
Retrieves the specified value.
The RegistryKey that the sub key exists in.
Opens this key under the supplied RegistryKey.
Gets the value for the specified key.
Returns null if an error occurred, else returns the string value for the specified key.
Retrieves the specified value.
The RegistryKey that the sub key exists in.
Opens this key under the supplied RegistryKey.
Gets the value for the specified key.
The value to return if the key does not exist.
Returns null if an error occurred, else returns the string value for the specified key.
Retrieves the specified DWORD value.
The RegistryKey that the sub key exists in.
Opens this key under the supplied RegistryKey.
Gets the value for the specified key.
Returns 0 if an error occurred, else returns the int value for the specified key.
Retrieves the specified DWORD value.
The RegistryKey that the sub key exists in.
Opens this key under the supplied RegistryKey.
Gets the value for the specified key.
The value to return if the key does not exist.
Returns 0 if an error occurred, else returns the int value for the specified key.
Retrieves the specified QWORD value.
The RegistryKey that the sub key exists in.
Opens this key under the supplied RegistryKey.
Gets the value for the specified key.
Returns 0 if an error occurred, else returns the long value for the specified key.
Retrieves the specified QWORD value.
The RegistryKey that the sub key exists in.
Opens this key under the supplied RegistryKey.
Gets the value for the specified key.
The value to return if the key does not exist.
Returns 0 if an error occurred, else returns the long value for the specified key.
Retrieves the specified DWORD value.
The RegistryKey that the sub key exists in.
Opens this key under the supplied RegistryKey.
Gets the value for the specified key.
Returns false if an error occurred, else returns the value for the specified key.
Retrieves the specified DWORD value.
The RegistryKey that the sub key exists in.
Opens this key under the supplied RegistryKey.
Gets the value for the specified key.
The value to return if the key does not exist.
Returns false if an error occurred, else returns the value for the specified key.
Retrieves the specified Binary value.
The RegistryKey that the sub key exists in.
Opens this key under the supplied RegistryKey.
Gets the value for the specified key.
Returns null if an error occurred, else returns the byte[] value for the specified key.
Retrieves the specified Binary value.
The RegistryKey that the sub key exists in.
Opens this key under the supplied RegistryKey.
Gets the value for the specified key.
The value to return if the key does not exist.
Returns null if an error occurred, else returns the byte[] value for the specified key.
Retrieves the specified DateTime value.
The RegistryKey that the sub key exists in.
Opens this key under the supplied RegistryKey.
Gets the value for the specified key.
Returns DateTime.Min if an error occurred, else returns the value for the specified key.
Retrieves the specified DateTime value.
The RegistryKey that the sub key exists in.
Opens this key under the supplied RegistryKey.
Gets the value for the specified key.
The value to return if the key does not exist.
Returns DateTime.Min if an error occurred, else returns the value for the specified key.
Retrieves the type of the specified Registry value.
The RegistryKey that the sub key exists in.
Opens this key under the supplied RegistryKey.
Gets the value type for the specified key name.
Sets or creates the specified String value.
The RegistryKey that the sub key exists in.
Opens this key under the supplied RegistryKey.
Sets the value for the specified key name.
Sets this value to the key name.
Sets or creates the specified DWORD value.
The RegistryKey that the sub key exists in.
Opens this key under the supplied RegistryKey.
Sets the value for the specified key name.
Sets this value to the key name.
Sets or creates the specified QWORD value.
The RegistryKey that the sub key exists in.
Opens this key under the supplied RegistryKey.
Sets the value for the specified key name.
Sets this value to the key name.
Sets or creates the specified Boolean value.
The RegistryKey that the sub key exists in.
Opens this key under the supplied RegistryKey.
Sets the value for the specified key name.
Sets this value to the key name.
Sets or creates the specified Binary value.
The RegistryKey that the sub key exists in.
Opens this key under the supplied RegistryKey.
Sets the value for the specified key name.
Sets this value to the key name.
Sets or creates the specified DateTime value.
The RegistryKey that the sub key exists in.
Opens this key under the supplied RegistryKey.
Sets the value for the specified key name.
Sets this value to the key name.
Creates a new subkey or opens an existing subkey.
The RegistryKey that the sub key exists in.
Opens this key under the supplied RegistryKey.
Returns the opened subkey if it could be opened, else returns null.
Deletes a subkey and any child subkeys recursively.
The RegistryKey that the sub key exists in.
Deletes this key under the supplied RegistryKey.
Deletes the specified value from this (current) key.
The RegistryKey that the sub key exists in.
Opens this key under the supplied RegistryKey.
Sets the value for the specified key name.
Renames a registry key.
The RegistryKey that the sub key exists in.
Opens this key under the supplied RegistryKey.
Then name of the new SubKey.
The new SubKey.
Copies a registry key.
The RegistryKey that the sub key exists in.
Opens this key under the supplied RegistryKey.
Then name of the destination SubKey.
The newly copied SubKey.
Copies a HiveKey Recursively.
The RegistryKey that the sub key exists in.
Then name of the destination HiveKey.
Retrieves the number of values in the specified Registry hive.
The RegistryKey that the sub key exists in.
Opens this key under the supplied RegistryKey.
Returns the number of sub keys, else returns 0.
Retrieves the number of values in the specified Registry hive.
The RegistryKey that the sub key exists in.
Opens this key under the supplied RegistryKey.
Returns the number of sub keys, else returns 0.
Checks to see if a subkey exists.
The RegistryKey that the sub key exists in.
Returns false if the key wasn't found.
Checks to see if a subkey exists.
The RegistryKey that the sub key exists in.
Opens this key under the supplied RegistryKey.
Returns false if the key wasn't found.
Checks to see if a subkey exists.
The RegistryKey that the sub key exists in.
Opens this key under the supplied RegistryKey.
If the name is specified then it will check to see if this value exists.
Returns false if the key wasn't found.
Finds a specific key one level deep from the hivekey.
The RegistryKey that the sub key exists in.
Opens this key under the supplied RegistryKey.
Gets the value for the specified key.
Value to check.
The SubKey name if found; returns string.Empty if not found.
Retrieves all key names under a given hive key.
The RegistryKey that the sub key exists in.
Opens this key under the supplied RegistryKey.
/// Retrieves all key names under a given hive key.
Retrieves all subkeys under a given hive key.
The RegistryKey that the sub key exists in.
Opens this key under the supplied RegistryKey.
/// Retrieves all subkeys under a given hive key.
Returns the next available index in a list of registry sub keys.
The hive key.
Returns the next number in an indexed list.
create the root CodeSmith RegistryKey.
This is the Error message, it will be null unless an error occurred.
Returns the root CodeSmith RegistryKey (E.G Software\CodeSmith).
Returns the CodeSmith RegistryKey (E.G Software\CodeSmith\v6.x).
This is a DataReader that 'fixes' any null values before
they are returned to our business code.
Initializes the SafeDataReader object to use data from
the provided DataReader object.
The source DataReader object containing the data.
Gets a string value from the datareader.
Returns empty string for null.
Ordinal column position of the value.
Gets a value of type from the datareader.
Ordinal column position of the value.
Gets an integer from the datareader.
Returns 0 for null.
Ordinal column position of the value.
Gets a double from the datareader.
Returns 0 for null.
Ordinal column position of the value.
Gets a Guid value from the datareader.
Returns Guid.Empty for null.
Ordinal column position of the value.
Reads the next row of data from the datareader.
Moves to the next result set in the datareader.
Closes the datareader.
Gets a boolean value from the datareader.
Returns for null.
Ordinal column position of the value.
Gets a byte value from the datareader.
Returns 0 for null.
Ordinal column position of the value.
Invokes the GetBytes method of the underlying datareader.
Returns 0 for null.
Ordinal column position of the value.
Array containing the data.
Offset position within the buffer.
Offset position within the field.
Length of data to read.
Gets a char value from the datareader.
Returns Char.MinValue for null.
Ordinal column position of the value.
Invokes the GetChars method of the underlying datareader.
Returns 0 for null.
Ordinal column position of the value.
Array containing the data.
Offset position within the buffer.
Offset position within the field.
Length of data to read.
Invokes the GetData method of the underlying datareader.
Ordinal column position of the value.
Invokes the GetDataTypeName method of the underlying datareader.
Ordinal column position of the value.
Gets a date value from the datareader.
Returns DateTime.MinValue for null.
Ordinal column position of the value.
Gets a decimal value from the datareader.
Returns 0 for null.
Ordinal column position of the value.
Invokes the GetFieldType method of the underlying datareader.
Ordinal column position of the value.
Gets a Single value from the datareader.
Returns 0 for null.
Ordinal column position of the value.
Gets a Short value from the datareader.
Returns 0 for null.
Ordinal column position of the value.
Gets a Long value from the datareader.
Returns 0 for null.
Ordinal column position of the value.
Invokes the GetName method of the underlying datareader.
Ordinal column position of the value.
Gets an ordinal value from the datareader.
Name of the column containing the value.
Invokes the GetSchemaTable method of the underlying datareader.
Invokes the GetValues method of the underlying datareader.
An array of System.Object to
copy the values into.
Invokes the IsDBNull method of the underlying datareader.
Ordinal column position of the value.
Disposes the object.
Disposes the object.
True if called by
the public Dispose method.
Object finalizer.
Gets a string value from the datareader.
Returns empty string for null.
Name of the column containing the value.
Gets a value of type from the datareader.
Name of the column containing the value.
Gets an integer from the datareader.
Returns 0 for null.
Name of the column containing the value.
Gets a double from the datareader.
Returns 0 for null.
Name of the column containing the value.
Gets a Guid value from the datareader.
Returns Guid.Empty for null.
Name of the column containing the value.
Gets a boolean value from the datareader.
Returns for null.
Name of the column containing the value.
Gets a byte value from the datareader.
Returns 0 for null.
Name of the column containing the value.
Invokes the GetBytes method of the underlying datareader.
Returns 0 for null.
Name of the column containing the value.
Array containing the data.
Offset position within the buffer.
Offset position within the field.
Length of data to read.
Gets a char value from the datareader.
Returns Char.MinValue for null.
Name of the column containing the value.
Invokes the GetChars method of the underlying datareader.
Returns 0 for null.
Name of the column containing the value.
Array containing the data.
Offset position within the buffer.
Offset position within the field.
Length of data to read.
Invokes the GetData method of the underlying datareader.
Name of the column containing the value.
Invokes the GetDataTypeName method of the underlying datareader.
Name of the column containing the value.
Gets a date value from the datareader.
Returns DateTime.MinValue for null.
Name of the column containing the value.
Gets a decimal value from the datareader.
Returns 0 for null.
Name of the column containing the value.
Invokes the GetFieldType method of the underlying datareader.
Name of the column containing the value.
Gets a Single value from the datareader.
Returns 0 for null.
Name of the column containing the value.
Gets a Short value from the datareader.
Returns 0 for null.
Name of the column containing the value.
Gets a Long value from the datareader.
Returns 0 for null.
Name of the column containing the value.
Invokes the IsDBNull method of the underlying datareader.
Name of the column containing the value.
Get a reference to the underlying data reader
object that actually contains the data from
the data source.
Returns the depth property value from the datareader.
Returns the FieldCount property from the datareader.
Returns the IsClosed property value from the datareader.
Returns a value from the datareader.
Name of the column containing the value.
Returns a value from the datareader.
Ordinal column position of the value.
Returns the RecordsAffected property value from the underlying datareader.
Represents a xml serializable collection of keys and values.
The type of the keys in the dictionary.
The type of the values in the dictionary.
Initializes a new instance of the class.
Initializes a new instance of the class.
The dictionary.
Initializes a new instance of the class.
The comparer.
Initializes a new instance of the class.
The capacity.
Initializes a new instance of the class.
The dictionary.
The comparer.
Initializes a new instance of the class.
The capacity.
The comparer.
Initializes a new instance of the class.
A object containing the information required to serialize the .
A structure containing the source and destination of the serialized stream associated with the .
This property is reserved, apply the
to the class instead.
An
that describes the XML representation of the object that
is produced by the
method and consumed by the
method.
Generates an object from its XML representation.
The
stream from which the object is deserialized.
Converts an object into its XML representation.
The
stream to which the object is serialized.
Determines if a string is in plural form based on some simple rules.
Determines if a string is in singular form based on some simple rules.
Converts a string to plural based on some simple rules.
The value to convert.
Converts a string to plural based on some simple rules.
The value to convert.
The plural overrides map file.
Converts a string to plural based on some simple rules.
The value to convert.
The plural overrides map.
Converts a string to singular based on some simple rules.
Converts a string to singular based on some simple rules.
The value to convert.
The plural overrides map file.
Converts a string to singular based on some simple rules.
The value to convert.
The plural overrides map.
Converts a string to use camelCase.
Converts a string to use PascalCase.
Text to convert
Takes a NameIdentifier and spaces it out into words "Name Identifier".
Determines if a string value contains a space.
Determines if a string value contains any of the strings passed in.
Determines if a string is a numeric value.
Takes a number and appends the ordinal suffix. ie. 1 = 1st, 13 = 13th.
Takes a number and appends the ordinal suffix. ie. 1 = 1st, 13 = 13th.
Safely returns a value if GetValue succeeded, otherwise it returns null.
The Source Property
The object whose property value will be returned.
Optional index values for indexed properties. This value should be null for non-indexed properties.
Gets the latest released version number of CodeSmith that has been released.
If an internet connection was detected it will return the version information of the latest released version of CodeSmith.
If an internet connection could not be found then it returns null.
Returns the Assembly file version information for the CodeSmith.Engine assembly.
Returns the Assembly file version information for the CodeSmith.Engine assembly.
Returns the current version information in the following format: 5.2.0000 (Major.Minor.Revision)
Returns the current version information in the following format: 5.2.0000 (Major.Minor.Revision)
Returns the current version information in the following format: 5.2.0000 (Major.Minor.Build)
Returns the current version information in the following format: 5.2.0000 (Major.Minor.Build)
Returns the current version information in the following format: 5.2 (Major.Minor)
Returns the current version information in the following format: 5.2 (Major.Minor)