StyleCop

Wraps the MessageBox class.

Always use the AlertDialog class rather than MessageBox. When StyleCop is running in non-UI mode, this class will redirect the MessageBox output to the running log file.

Shows the alert dialog.

The StyleCop core instance. The parent control. The message to display on the dialog. The title of the dialog. The dialog buttons. The dialog icon. Returns the dialog result.

Shows a MessageBox.

The parent control. The message to display on the dialog. The title of the dialog. The dialog buttons. The dialog icon. Returns the dialog result.

Writes a message to do the output log.

The StyleCop core instance. The message to display on the dialog. The dialog icon.

Event arguments for the event.

The pages that have been added.

The path to the settings file.

Initializes a new instance of the class.

The path to the settings file.

Gets the pages that were added to the StyleCop settings dialog.

Gets the path to the StyleCop settings file.

Adds a page to be displayed on the StyleCop project settings dialog.

The page to add.

Describes a location within a code document.

other

An empty code location.

The ending position within the code.

The starting position within the code.

Initializes a new instance of the CodeLocation struct.

The index of the first character of the item within the file. The index of the last character of the item within the file. The index of the first character of the item within the line that it appears on. The index of the last character of the item within the line that it appears on. The line number that this item begins on. The line number that this item ends on.

Gets the ending point within the code.

Gets the starting line number of this code location.

Gets the number of lines spanned by the start and end points.

The line span will always be at least one.

Gets the starting point within the code.

Joins the two given locations.

The first location to join. The second location to join. Returns the joined .

Joins the two given locations.

The first location to join. The second location to join. Returns the joined .

Joins the two given locations.

The first location to join. The second location to join. Returns the joined .

Describes a point within a code file.

other

The index of the first character of the item within the document.

The index of the first character of the item within the line that it appears on.

The line number that this item appears on.

Initializes a new instance of the CodePoint struct.

The index of the first character of the item within the document. The index of the last character of the item within the line that it appears on. The line number that the item appears on. Must be greater than zero.

Gets the index of the first character of the item within the document.

Gets the index of the first character of the item within the line that it appears on.

Gets the line number that this item appears on. Minimum is 1.

Joins the two given points.

The first point to join. The second point to join. Returns the joined .

Reads code from a text reader.

The number of characters to read at a time from the text reader.

Contains the code to read.

The number of characters in the buffer.

Cached characters read from the text reader.

The position of the next unread character in the character buffer.

Initializes a new instance of the CodeReader class.

Contains the code to read.

Gets the next character from the code without advancing the internal pointer.

Returns the next character from the code or char.MinValue if there are no more characters to read.

Gets the next character from the code without advancing the internal pointer.

The index of the character to retrieve, advanced from the current index. Returns the next character from the code or char.MinValue if there are no more characters to read.

Gets the next non-whitespace character from the code without advancing the internal pointer.

The index of the character to retrieve, advanced from the current index. Returns the next non-whitespace character from the code or if there are no more non-whitespace characters to read.

Reads the next character from the code and advances the internal index.

Returns the next character from the code or char.MinValue if there are no more characters to read.

Reads the given number of characters from the code and advances the internal index.

The number of characters to read. Returns the characters or null if all of the characters could not be read.

Reads the given number of characters from the code as a string and advances the internal index.

The number of characters to read. Returns the string or null if all of the characters could not be read.

Loads the internal character buffer with the requested number of characters.

The number of characters to load. Returns true if the characters were loaded, or false if the end of the character source was reached before all the characters were loaded.

Implemented by lists of items.

The type of item stored in the list.

Gets the first item in the list.

Gets the last item in the list.

Gets an iterator for enumerating forward through the items in the list.

Returns the enumerable object.

Gets an iterator for enumerating forward through the items in the list.

The start position of the iterator. Returns the enumerable object.

Gets an iterator for enumerating forward through the nodes in the list.

Returns the enumerable object.

Gets an iterator for enumerating forward through the nodes in the list.

The start position of the iterator. Returns the enumerable object.

Determines whether the given node is beyond the bounds of the list.

The node to check. Returns true if the node is beyond the bounds of the list.

Gets an iterator for enumerating backwards through the items in the list.

Returns the enumerable object.

Gets an iterator for enumerating backwards through the items in the list.

The start position of the iterator. Returns the enumerable object.

Gets an iterator for enumerating backwards through the nodes in the list.

Returns the enumerable object.

Gets an iterator for enumerating backwards through the nodes in the list.

The start position of the iterator. Returns the enumerable object.

A list of items that points into a .

The type of item stored in the list.

The master list that this list points into.

The first item in the master list.

The last item in the master list.

Initializes a new instance of the class. Initializes a new instance of the ItemList class.

The master list that this list points into.

Initializes a new instance of the class. Initializes a new instance of the ItemList class.

The master list that this list points into. The first item in the master list. The last item in the master list.

Gets or sets the first item in the list.

Gets or sets the last item in the list.

Gets the master list that contains this list.

Creates a copy of this list.

Returns the copy.

Gets an iterator for enumerating forward through the items in the list.

Returns the enumerable object.

Gets an iterator for enumerating forward through the items in the list.

The start position of the iterator. Returns the enumerable object.

Gets an iterator for enumerating forward through the nodes in the list.

Returns the enumerable object.

Gets an iterator for enumerating forward through the nodes in the list.

The start position of the iterator. Returns the enumerable object.

Gets an enumerator for walking through the items in the list.

Returns the enumerator.

Determines whether the given node is beyond the bounds of the list.

The node to check. Returns true if the node is beyond the bounds of the list. This method only checks the nodes one step beyond the bounds of the list. If the node is more than one step beyond the bounds of the list, this method will still return true.

Gets an iterator for enumerating backwards through the items in the list.

Returns the enumerable object.

Gets an iterator for enumerating backwards through the items in the list.

The start position of the iterator. Returns the enumerable object.

Gets an iterator for enumerating backwards through the nodes in the list.

Returns the enumerable object.

Gets an iterator for enumerating backwards through the nodes in the list.

The start position of the iterator. Returns the enumerable object.

Gets an enumerator for walking through the items in the list.

Returns the enumerator.

Determines whether the given node comes after the last node in this list.

The node to check. Returns true if the given node comes after the last node in this list.

Determines whether the given node comes before the first node in this list.

The node to check. Returns true if the given node comes before the first node in this list.

A doubly-linked list.

The type of item stored in the list.

The number of items in the list.

The first node in the list.

The last node in the list.

Initializes a new instance of the class. Initializes a new instance of the LinkedItemList class.

The initial items for the list.

Initializes a new instance of the class. Initializes a new instance of the LinkedItemList class.

The initial nodes for the list.

Event that is fired when the node indexes are reset.

Gets the number of items in the collection.

Gets the first item in the list.

Gets a value indicating whether the collection is read-only.

Gets the last item in the list.

Adds an item to the collection.

The item to add to the collection.

Adds an item to the collection.

The node to add to the collection.

Adds the range of items to the collection.

The range of items to add. Returns the added nodes.

Adds the range of items to the collection.

The range of nodes to add.

Clears the contents of the list.

Determines whether the given item is contained within the list.

The item to search for. Returns true if the item is contained within the list.

Determines whether the given item is contained within the list.

The node to search for. Returns true if the node is contained within the list.

Copies the entire collection to the given array, starting at the specified index of the target array.

The array that is the destination of the nodes copied from the collection. The zero-based index in array at which copying begins.

Gets an iterator for enumerating forward through the items in the list.

Returns the enumerable object.

Gets an iterator for enumerating forward through the items in the list.

The start position of the iterator. Returns the enumerable object.

Gets an iterator for enumerating forward through the nodes in the list.

Returns the enumerable object.

Gets an iterator for enumerating forward through the nodes in the list.

The start position of the iterator. Returns the enumerable object.

Gets an enumerator that iterates through the nodes in the collection.

Returns an enumerator that iterates through the nodes in the collection.

Inserts a item into the list after the given item.

The item to insert. The node to insert the item after. Returns the new node.

Inserts a node into the list before the given item.

The item to insert. The node to insert the item before. Returns the new node.

Inserts the specified item at the beginning of the list.

The item to insert. Returns the new node.

Inserts the specified item at the end of the list.

The item to insert. Returns the new node.

Removes the given item from the list.

The item to remove from the list. Return true if the item was removed from the list. This method is inefficient as it must iterate the list to find the node to remove.

Removes the given node from the list.

The node to remove from the list. Return true if the node was removed from the list.

Removes the given range of nodes from the list.

The first node to remove. The last node to remove. This method assumes that both the start node and the end node are nodes in this list, and that the start node appears before the end node in the list. These assumptions are not verified, so use this method with care.

Removes the given node from the list and replaces it with a different node.

The node to remove. The replacement item. Returns the new node for the replacement item.

Removes the given node from the list and replaces it with a different node.

The node to remove. The replacement node.

Gets an iterator for enumerating backwards through the items in the list.

Returns the enumerable object.

Gets an iterator for enumerating backwards through the items in the list.

The start position of the iterator. Returns the enumerable object.

Gets an iterator for enumerating backwards through the nodes in the list.

Returns the enumerable object.

Gets an iterator for enumerating backwards through the nodes in the list.

The start position of the iterator. Returns the enumerable object.

Gets an enumerator that iterates through the nodes in the collection.

Returns an enumerator that iterates through the nodes in the collection.

Called when the node indexes are reset.

The event arguments.

Inserts a item into the list after the given item.

The node to insert. The node to insert the item after. Returns the new node.

Inserts a node into the list before the given item.

The node to insert. The node to insert the item before. Returns the new node.

Resets the indexes of all nodes in the list.

A set of enumerators for iterating through lists based on the class.

The type of item stored in the list.

Provides an enumerator for iterating backwards through the list.

The last item in the master list.

The first item in the master list.

Initializes a new instance of the BackwardNodeEnumerable class.

The first item in the master list. The last item in the master list.

Gets an enumerator for iterating through the list.

Returns the enumerator.

Gets an enumerator for iterating through the list.

Returns the enumerator.

Enumerates backwards through the nodes in the collection.

The last item in the master list.

The first item in the master list.

The current item in the collection.

Initializes a new instance of the BackwardNodeEnumerator class.

The first item in the master list. The last item in the master list.

Gets the current item.

Disposes the contents of the class.

Moves to the next item in the collection.

Returns false if there are no more items in the collection.

Resets the enumerator back to the beginning of the collection.

Provides an enumerator for iterating backwards through the items in the list.

The last item in the master list.

The first item in the master list.

Initializes a new instance of the BackwardValueEnumerable class.

The first item in the master list. The last item in the master list.

Gets an enumerator for iterating through the list.

Returns the enumerator.

Gets an enumerator for iterating through the list.

Returns the enumerator.

Enumerates backwards through the items in the collection.

The last item in the master list.

The first item in the master list.

The current item in the collection.

Initializes a new instance of the BackwardValueEnumerator class.

The first item in the master list. The last item in the master list.

Gets the current item.

Disposes the contents of the class.

Moves to the next item in the collection.

Returns false if there are no more items in the collection.

Resets the enumerator back to the beginning of the collection.

Provides an enumerator for iterating forward through the nodes in the list.

The last item in the master list.

The first item in the master list.

Initializes a new instance of the ForwardNodeEnumerable class.

The first item in the master list. The last item in the master list.

Gets an enumerator for iterating through the list.

Returns the enumerator.

Gets an enumerator for iterating through the list.

Returns the enumerator.

Enumerates forwards through the nodes in the collection.

The last item in the master list.

The first item in the master list.

The current item in the collection.

Initializes a new instance of the ForwardNodeEnumerator class.

The first item in the master list. The last item in the master list.

Gets the current item.

Disposes the contents of the class.

Moves to the next item in the collection.

Returns false if there are no more items in the collection.

Resets the enumerator back to the beginning of the collection.

Provides an enumerator for iterating forward through the items in the list.

The last item in the master list.

The first item in the master list.

Initializes a new instance of the ForwardValueEnumerable class.

The first item in the master list. The last item in the master list.

Gets an enumerator for iterating through the list.

Returns the enumerator.

Gets an enumerator for iterating through the list.

Returns the enumerator.

Enumerates forwards through the items in the collection.

The last item in the master list.

The first item in the master list.

The current item in the collection.

Initializes a new instance of the ForwardValueEnumerator class.

The first item in the master list. The last item in the master list.

Gets the current item.

Disposes the contents of the class.

Moves to the next item in the collection.

Returns false if there are no more items in the collection.

Resets the enumerator back to the beginning of the collection.

Interface which is implemented by a node class to be used with the LinkedItemList class.

The type of node stored in the linked list.

The current item.

The master list that contains this node.

The index of the node in the list in which it is contained.

The next node.

The previous node.

Initializes a new instance of the class. Initializes a new instance of the Node class.

The node item.

Gets the index of the node within the master list that contains it.

The index is not guaranteed to be immutable. Subscribe to the event to receive a notification when the indexes of nodes within the list are reset.

Gets the next node in the list.

Gets the previous node in the list.

Gets the node.

Gets or sets the master list that contains this node.

Determines whether the given node is in the same list as this node.

The other node. true if the nodes are in the same list; false otherwise.

Creates the index for the node.

Returns true if the index was created successfully, or false if it not possible to create a new index for this node. This method should be called after the node is added to a list.

Describes the index of a node in the list.

The amount of space to leave between each node index.

The main part of the index.

The small part of the index.

Compares the two indexes and returns a standard comparison result.

The first index. The second index. Returns a negative value if the first index is less than the second index, a positive value if the second index is greater than the first index, or zero if the two indexes are equal.

Determines whether the two indexes are equal.

The first index. The second index. Returns true if the indexes are equal.

Determines whether the first index is greater than the second index.

The first index. The second index. Returns true if the first index is greater than the second index.

Determines whether the first index is greater than or equal to the second index.

The first index. The second index. Returns true if the first index is greater than or equal to the second index.

Determines whether the two indexes are not equal.

The first index. The second index. Returns true if the indexes are not equal.

Determines whether the first index is less than the second index.

The first index. The second index. Returns true if the first index is less than the second index.

Determines whether the first index is less than or equal to the second index.

The first index. The second index. Returns true if the first index is less than or equal to the second index.

Determines whether the index is equal to the given object.

The object to compare with. Returns true if the object is equal to this index.

Gets the hash code for the index.

Returns the hash code for the index.

Gets the index as a string.

Returns the index as a string.

Creates an index for a new node being inserted at the beginning of the list.

The index of the previous node. Returns the new index. Returns true if the new index was created, or false if there are no more indexes.

Creates an index for a new node being inserted at the beginning of the list.

The index of the next node. Returns the new index. Returns true if the new index was created, or false if there are no more indexes.

Creates an index for a new node being inserted into the middle of the list.

The index of the previous node. The index of the next node. Returns the new index. Returns true if the new index was created, or false if there are no more indexes.

Creates an index for a new node which is the first node in the list.

Returns the new index. Returns true if the new index was created, or false if there are no more indexes.

Sets the index to the given big value.

The new big value.

Creates an index for a new node.

The big value of the previous node. The small value of the previous node. The big value of the next node. The small value of the next node. Returns the new index. Returns true if the new index was created, or false if there are no more indexes.

Creates a new big value between the two given values.

The previous big value. The next big value. Returns the new big value. Returns false if it was not possible to create a new big value.

Creates a new small value between the two given values.

The previous small value. The next small value. Returns the new small value. Returns false if it was not possible to create a new small value.

Options dialog to choose which settings files to use.

The components.

The culture combo box.

The culture parent property.

The culture property descriptor.

Indicates whether the page is dirty.

Indicates whether to enable writing of the cache.

The page description.

The label 2.

The label 3.

The max violation count masked text box.

The max violation count parent property.

The max violation count property descriptor.

The tab control hosting this page.

The tool tip.

The global value of the property.

The violations as errors check box.

The violations as errors property descriptor.

The violations as errors parent property.

The table layout panel 1.

The table layout panel 2.

The needed to make last row fill.

Property writeCachePropertyDescriptor.

Initializes a new instance of the CacheOptions class.

Gets or sets a value indicating whether the page is dirty.

Gets the value to place on the page tab.

Called when the page is activated.

Indicates whether the page is being activated or deactivated.

Saves the data and clears the dirty flag.

Returns true if the data was saved, false if not.

Initializes the page.

The tab control object.

Called after all pages have been applied.

The dirty state of the page before it was applied.

Called before all pages are applied.

Returns false if no pages should be applied.

Refreshes the merged override state of properties on the page.

The validate page.

The .

Clean up any resources being used.

Dispose parameter.

Gets the satellite languages.

The base name. The .

The get satellite languages.

The base name. The . The argument was null.

The culture combo box selected index changed.

The sender. The e.

Called when the checkbox is checked or unchecked.

The event sender. The event arguments.

Required method for Designer support - do not modify the contents of this method with the code editor.

The max violation count masked text box key down.

The sender. The e.

The max violation count text box text changed.

The sender. The e.

Sets the bold state of the checkboxes.

The violations as errors check box checked changed.

The sender. The e.

The object we lock on.

The countdown value we use.

Initializes a new instance of the class with the specified count.

The number of signals initially required to set the . is less than 0.

Gets the number of remaining signals required to release the countdown.

The number of remaining signals.

Increments the Countdown's current count by a specified value.

The value by which to increase .

Registers a signal with the , decrementing the value of .

Registers multiple signals with the , decrementing the value of by the specified amount.

The number of signals to register. is less than 1.

Blocks the current thread until the is set.

The current instance has already been disposed.

Marks an item as either containing or handing sensitive data which should be obscured in trace output.

This attribute may be applied to parameters or return values of methods to indicate that they contain sensitive data and should be obscured in the trace output. Alternatively entire properties, methods or constructors may be marked with this attribute and any input or output will be obscured from the trace. Note that this attribute only has an effect on the method which takes a parameter array, and the methods that take a parameter array or return value. Note that in DEBUG builds when the trace flag is used, the sensitive data can be printed out without being obscured which is useful for debugging. This flag is ignored in RELEASE builds to ensure that sensitive data cannot be traced on production systems. This example shows the attributes being applied to a parameter and return value of a method and then traced using the class.


            [return: SensitiveData]
            public string MyMethod([SensitiveData] string sensitiveVal, string publicVal)
            {
                StyleCopTrace.In(sensitiveVal, publicVal)
                // ...
                return StyleCopTrace.Out(otherSensitiveVal);
            }

The trace output from this will be as follows when the data is obscured:


            ... In  : MyNamespace.MyClass.MyMethod("<******>", "PublicValueText")
            ... Out : MyNamespace.MyClass.MyMethod()="<******>"

A custom class allowing more trace levels than the default switch.

This is a replacement for the default class. This class publishes the as an rather than as an as with the default implementation. This allows us to use any value for the tracing level rather than the restricted 5 values of the default class.

Initializes a new instance of the class with the default trace level.

The name of the switch. A description of the switch.

Initializes a new instance of the class with a specified enumerated trace level.

The name of the switch. A description of the switch. The trace level as a combination of values.

Initializes a new instance of the class with a specified trace level.

The name of the switch. A description of the switch. The trace level.

Gets or sets the current trace level.

Gets a value indicating whether tracing of errors is enabled.

Gets a value indicating whether tracing in and out of method bodies is enabled.

Gets a value indicating whether tracing of informational messages is enabled.

Gets a value indicating whether tracing of sensitive data is enabled.

Gets a value indicating whether the managed thread identifier should be included in the trace output.

Gets a value indicating whether the managed thread name should be included in the trace output.

Gets a value indicating whether tracing of verbose information is enabled.

Gets a value indicating whether tracing of warnings is enabled.

On switch setting changed.

The central manager class for application tracing, through which all application tracing should be done.

Style cop trace.

StyleCopTrace.

Initializes static members of the class.

Gets the that this class uses to decide whether to produce tracing messages.

Write an error message containing the passed text.

The text of the message.

Write an error message containing the passed arguments in the given format.

Format to be used when writing the args to a string. The arguments to insert into the format string.

Write an error message consisting of the details of an .

The to write the message about.

To be called on method entry. This overload is recommended for most purposes.

The values of the parameters that were passed into the function that is calling this trace function.

Write an information message containing the passed text.

The text of the message.

Write an information message containing the passed arguments in the given format.

Format to be used when writing the args to a string. The arguments to insert into the format string.

To be called when leaving a method. This overload is recommended for functions that have only input parameters and which do not have a return value.

To be called when leaving a method. This overload is recommended for functions that have only input parameters and which have a return value.

The return value of the method. The passed in parameter.

To be called when leaving a method. This overload is recommended for functions that have only input parameters and which have a return value.

The type of return value. The return value of the method. The passed in parameter.

Write a verbose informational message containing the passed text.

The text of the message.

Write a verbose informational message containing the passed arguments in the given format.

Format to be used when writing the args to a string. The arguments to insert into the format string.

Write a Warning message containing the passed text.

The text of the message.

Write an Warning message consisting of the details of an .

The to write the message about.

Write a Warning message containing the passed arguments in the given format.

Format to be used when writing the args to a string. The arguments to insert into the format string.

Returns the current processes private bytes.

A long of the processes private bytes.

A trace formatter class to perform the work of creating trace output strings on behalf of the class.

A regular expression to extract the names of members used with a format string.

Caches the calling method.

Caches whether the calling method is marked as sensitive.

Caches the stack depth of the calling method.

The buffer in which trace output is constructed.

Initializes a new instance of the class, which captures the calling method.

Writes a trace string for method entry.

Arguments that were passed into the method, which may be null if the method had no arguments.

Writes a trace string containing a message.

The qualifier indicating the severity of the message, e.g. Info or Warn. The message to write.

Writes a trace string containing a message.

The qualifier indicating the severity of the message, e.g. Info or Warn. The format of the message to write. Arguments to insert into .

Writes a trace string for method exit.

The return value of the method, which may be null if the method has no return type.

Gets the method that originally called into the class.

When the method returns, contains the stack depth of the calling method. A detailing the calling method.

Appends a parameter to the buffer.

Information about the parameter to append. The argument that was passed to the parameter.

Appends a 'prettily' formatted type name to the buffer.

The type to append the name of.

Initializes the buffer with a specified qualifier.

The trace qualifier, e.g. In or Err.

Gets whether an attribute is defined on a method, or if that method is part of a property whether the attribute is defined on the containing property.

The type of attribute to find. True if the attribute is defined, or False otherwise.

Represents the binary switch values used to turn on/off the various types of trace message.

No Tracing.

Trace in and out of methods and code blocks.

Trace output of error conditions.

Trace output of warning conditions.

Trace output of general information.

Trace the full details of sensitive information. This flag only has an effect in debug builds - release builds will always obscure sensitive information.

Includes the .NET Thread name with the message output.

Include the .Net Thread Hash with the message output.

Trace output that is considered highly verbose. Also modifies the tracing produced from In/Out so that reference types are expanded.

Contains static methods for access to win32 libraries.

The canonical name.

The canonical extended name.

The display name.

The domain name service domain name.

The fully qualified name.

The sam compatible name.

The service principal name.

The unique identifier.

The unknown name.

The user principal name.

The naming service.

Gets the default naming service.

Gets the culture.

Gets an array of the dictionary folders which have been scanned for dictionaries.

Gets a value indicating whether supports spelling.

Clears the cached services.

Gets a naming service for the specified culture.

The culture to use. The NamingService for the culture.

Adds the deprecated words dictionary and their preferred alternatives to the list of current deprecated words.

The dictionary of words to add.

Adds a folder to the list of folders scanned for CustomDictionary.xml files.

The path to add.

Check spelling of the word provided.

The word to check. The StyleCop.Spelling.WordSpelling.

The dispose.

The get compound alternate for discrete word.

The word. The System.String.

Returns a hash code of the files we use to check spelling.

The hash code or 0 if we don't use any other files.

The get discrete alternate for compound word.

The word 1. The word 2. The System.String.

The get preferred alternate for deprecated word.

The word. The System.String.

The is casing exception.

The word. The System.Boolean.

The dispose.

The disposing.

Called when the file changes.

The source of the event. The FileSystemEventArgs for the changing file.

Called when the file renames.

The source of the event. The RenamedEventArgs for the changing file.

Creates a FileWatcher.

The file to watch.

Initializes a new instance of the class.

The capacity.

Initializes a new instance of the class.

The comparer.

Initializes a new instance of the class.

The dictionary.

Initializes a new instance of the class.

The capacity. The comparer.

Initializes a new instance of the class.

The dictionary. The comparer.

Gets the count.

Gets a value indicating whether is read only.

Gets the keys.

Gets the values.

The this.

The key. The TValue.

The add.

The key. The value.

The add.

The item.

The clear.

The contains.

The key. The System.Boolean.

The contains.

The item. The System.Boolean.

The contains key.

The key. The System.Boolean.

The copy to.

The array. The array index.

The get enumerator.

The System.Collections.Generic.IEnumerator`1[T -> System.Collections.Generic.KeyValuePair`2[TKey -> TKey, TValue -> TValue]].

The remove.

The key. The System.Boolean.

The remove.

The item. The System.Boolean.

The try get value.

The key. The value. The System.Boolean.

Gets a path to the Office 2010, 2013, or 2016 proof directory. Returns string.Empty if the path could not be found.

Initializes a new instance of the class.

The comparer.

The collection changed.

Gets the count.

The add.

The item.

The clear.

The contains.

The item. The System.Boolean.

The copy to.

The array. The array index.

The get enumerator.

The System.Collections.Generic.IEnumerator`1[T -> System.String].

The remove.

The item. The System.Boolean.

The on collection changed.

The e.

The word parser.

The recognized words

Initializes a new instance of the class.

The text. The options. The recognized words.

Initializes a new instance of the class.

The text. The options. The recognized words. The prefix char. text is null options is invalid

The next word.

The System.String.

The peek word.

The System.String.

Parses the next word which starts with an upper case.

Peeks the next whole word.

The next whole word

Parses the next whole word.

Peeks the next character.

The next character

Peeks the next character at the specified position to look ahead.

The position of the character to look ahead. The next character at the specified position

Reads the next character.

Skips the next ignored characters.

The options for the word parser.

No parser options.

If set mnemonics will be ignored.

If set it will split compound words.

The result of the spelling check.

The word was spelled correctly.

The word was unrecognized.

The word was cased incorrectly.

Contains static methods for access to unix libraries.

Gets the unix kernel name by p/invoking uname.

The name of the unix kernel.

Interface which must be implemented by a host of the .

Called to cancel the host.

Called when the combined dirty status of the pages changes.

True if any of the pages are dirty, false if not.

The possible results of saving the settings.

The save succeeded.

One of the pages aborted the save operation.

An error occurred while saving the file.

Hosts a and provides standard property page buttons.

The context for the property control.

The StyleCop core instance.

The callback method for help.

The page set ID.

The property pages to display.

The settings file being edited.

Indicates whether settings have been changed on any page.

Initializes a new instance of the PropertyDialog class.

The array of pages to display on the property control. The file that contains the settings being edited. A unique ID that describes this set of property pages. The StyleCop core instance. Callback method for help, or null for no help. The context to the send to the property page control.

Delegate that is called when the user hits the Help button.

The currently active page on the control.

Gets a value indicating whether the user saved any changes to settings on the property pages.

Cancels the dialog.

IPropertyControlHost.Dirty implementation. Enables or disables the Apply button based upon whether any data on the pages is dirty.

True if the dialog is dirty.

The form's OnClosing event. Saves the window position.

The event arguments.

The form's OnLoad event. Initializes the PropertyControl object.

The event arguments.

Moves the first button into the same position as the second button.

The button to move. The button to move the first button on top of.

Called when the user clicks the Apply button.

The event sender. The event arguments.

Called when the user clicks the Cancel button.

The event sender. The event arguments.

Called when the user clicks the Help button.

The event sender. The event arguments.

Called when the user clicks the OK button.

The event sender. The event arguments.

Required designer variable.

Clean up any resources being used.

true if managed resources should be disposed; otherwise, false.

Required method for Designer support - do not modify the contents of this method with the code editor.

Loads settings from a version 105 settings document.

The types of settings properties.

A property containing a boolean value.

A property containing an integer value.

A property containing a string value.

A property containing a collection of properties.

Not a valid property.

Loads the settings from the document.

The settings document. Stores the settings.

Loads the settings from the document.

The root node of the settings document. Stores the settings.

Converts a legacy "Microsoft.SourceAnalysis" or "Microsoft.StyleCop" AddIn name to the new name.

The original name. Returns the converted name.

Determines the type of property represented by the property type name.

The property type name. Returns the well-known property type.

Loads analyzer settings from the document.

The root node of the settings document. Stores the settings.

Loads and stores a boolean property.

The name of the property to load. The node containing the property. The collection in which to store the property. The collection of property descriptors.

Loads and stores a collection property.

The name of the property to load. The node containing the property. The collection in which to store the property. The collection of property descriptors.

Loads files specified in file lists.

The root node of the settings document. Stores the settings.

Loads and stores an integer property.

The name of the property to load. The node containing the property. The collection in which to store the property. The collection of property descriptors.

Loads parser settings from the document.

The root node of the settings document. Stores the settings.

Loads a property collection from the settings file.

The node containing the property collection. The property collection storage object. The collection of property descriptors. An optional rule name to prepend the each property name.

Loads settings for rules.

The add-in containing the rules. The collection of properties to add the rules settings into. The collection of property descriptors for the add-in.

Loads and stores a string property.

The name of the property to load. The node containing the property. The collection in which to store the property. The collection of property descriptors.

Object model for hosting StyleCop in a simplified manner.

The StyleCop core instance.

The violation count.

The violations document.

Initializes a new instance of the StyleCopRunner class.

Event that is fired when output is generated from the console during an analysis.

Gets or sets the StyleCop core instance.

Gets or sets a value indicating whether we should capture the violations.

Gets the violation count.

Gets the violations document.

Called when output is generated during an analysis. This can be called simultaneously from several threads and so any code must be thread safe.

The event arguments.

Called when a violation is encountered during an analysis. This can be called simultaneously from several threads and so any code must be thread safe.

The event arguments.

Resets the violation count.

Creates a safe version of the element name that can be outputted to Xml.

The original name. Returns the safe name.

Called when output should be added to the Output pane.

The event sender. The event arguments.

Called when a violation is found.

The event sender. The event arguments.

A lightweight StyleCop host which does not depend on the file system for loading source and settings files. Source files and settings files can be loaded from any arbitrary source (in memory, database, etc.).

The default settings document.

Initializes a new instance of the StyleCopObjectConsole class.

The environment. The default settings to use, or null to allow each project to specify its own settings. The list of paths to search under for parser and analyzer addins. Can be null if no addin paths are provided. Indicates whether to load addins from the default application path.

Initializes a new instance of the StyleCopObjectConsole class.

Starts analyzing the source code documents contained within the given projects.

The projects to analyze. Returns false if an error occurs during analysis.

Gets the settings for the given project.

The project. Returns the settings, or null if there

Loads the settings files to use for the analysis.

The list of projects to use.

Delegate which is used to retrieve the object corresponding to the given path.

The path to the source code object. The project which contains the source code object. The parser for the source code type. Optional context. Returns the source code object.

Delegate which is used to retrieve the object corresponding to a given project path.

The path to the project. Indicates whether to return a object or a object. Returns the settings object.

An environment which does not depend on the file system for loading source and settings files. Source files and settings files can be loaded from any arbitrary source (in memory, database, etc.).

The list of parsers and their associations.

Callback which is used to retrieve Settings objects on demand.

Callback which is used to retrieve SourceCode objects on demand.

The path to the default settings file, if any.

Initializes a new instance of the ObjectBasedEnvironment class.

Callback which is used to create objects on demand. Optional callback which is used to create objects on demand.

Gets a value indicating whether the environment supports settings documents which link directly to another settings document to merge with.

Gets a value indicating whether the environment supports the use of the results cache.

Invoked when a new parser is loaded.

The new parser.

Adds a source code document to the given project.

The project which should contain the source code instance. The path to the source code document to add. Optional context information. Returns true if any source code documents were added to the project.

Gets the path to the default settings file for the currently running StyleCop installation.

Returns the path or an empty string if there is none.

Given the path to a settings document, determines the path to a parent settings file, if one exists.

The path to the local settings document. Returns the path to the parent settings document or null if none exists.

Gets the collection of parsers registered for the given file extension.

The file extension. Returns the parsers for the file extension.

Gets the settings for the given project.

The project containing the settings. Indicates whether to merge the settings with parent settings before returning them. Returns an exception if one occurred while loading the settings. Returns the settings.

Gets the settings given the path to the local settings.

The path to the settings to load. Indicates whether to merge the settings with parent settings before returning them. Returns an exception if one occurred while loading the settings. Returns the settings.

Loads or creates the settings at the given path, and returns them in writable mode.

The path to the settings. Returns an exception if one occurred loading or creating the settings. Returns the settings.

Loads the results cache at the given location.

The location of the results cache to load. Returns the results cache or null if there is no results cache at that location.

Removes the analysis results at the given location.

The location of the analysis results to remove.

Saves the analysis results at the given location.

The path to save the results under. The results to save. Returns an exception if one occurs while saving the results. Returns true if the results were saved successfully.

Saves the given results cache.

The location to save the results cache under. The results cache to save.

Saves the settings file at the path specified within the settings document.

The settings to save. If the document could not be saved, this returns the resulting exception information. Returns true if the file was successfully saved.

Loads the settings file at the given path.

The path to the settings file. Indicates whether a read-only document should be returned. If the document could not be loaded, this returns the resulting exception information. Returns the settings if they could be loaded.

A "fake" parser class used by the StyleCop engine to register violations exposed by the core engine.

Parses a source code document.

The source code to parse. The current pass number. The parsed representation of the file. Returns false if no further parsing should be done on this file.

Keeps track of the analysis status for a single code document.

Indicates whether the analysis is complete.

The document being parsed.

Indicates whether the contents of the class have been initialized.

Gets or sets a value indicating whether the analysis for this file is complete.

Gets or sets the document being parsed.

Gets or sets a value indicating whether the contents of the class have been initialized.

An interface implemented by types that describes an element within a code document.

Gets the collection of child elements beneath this element.

Gets the document that contains the code part.

Gets the fully qualified name of the element.

Gets the line number that this code part appears on in the document.

Gets the violations found in this element.

Adds one violation to this element.

The violation to add. Returns false if there is already an identical violation in the element.

Clears the analyzer tags for this element.

This method should only be called by the StyleCop framework.

Adapts an enumerable collection from one format to another.

The type of the elements enumerated over.

The enumerable collection that is wrapped by this class.

Initializes a new instance of the class. Initializes a new instance of the LegacyEnumeratorAdapter class.

The enumerator to wrap.

Gets the inner enumerator wrapped by this adapter.

Gets the current item.

Disposes the contents of the class.

Moves to the next item.

Returns false if there are no more items.

Resets the enumerator.

An environment which interacts with files on disk.

The list of file types and their associated parsers.

The path to the default settings file, if any.

Gets a value indicating whether the environment supports settings documents which link directly to another settings document to merge with.

Gets a value indicating whether the environment supports the use of the results cache.

Invoked when a new parser is loaded.

The new parser.

Adds a source code document to the given project.

Gets the path to the default settings file for the currently running StyleCop installation.

Returns the path or an empty string if there is none.

Given the path to a settings document, determines the path to a parent settings file, if one exists.

The path to the local settings document. Returns the path to the parent settings document or null if none exists.

Gets the collection of parsers registered for the given file extension.

The file extension. Returns the parsers for the file extension.

Gets the settings for the given project.

Gets the settings given the path to the local settings.

Loads or creates the settings at the given path, and returns them in writable mode.

The path to the settings. Returns an exception if one occurred loading or creating the settings. Returns the settings.

Loads the results cache at the given location.

The location of the results cache to load. Returns the results cache or null if there is no results cache at that location.

Removes the analysis results at the given location.

The location of the analysis results to remove.

Saves the analysis results at the given location.

The path to save the results under. The results to save. Returns an exception if one occurs while saving the results. Returns true if the results were saved successfully.

Saves the given results cache.

The location to save the results cache under. The results cache to save.

Saves the settings file at the path specified within the settings document.

The settings to save. If the document could not be saved, this returns the resulting exception information. Returns true if the file was successfully saved.

Creates a new instance with the given values.

The path to the code file. The project that contains this file. The parser that created this file object. Optional context information. Returns the newly created .

Gets the expected full path for a cache file

The location on which to base the cache file path The expected path for the cache file

Creates an empty settings file at the given path.

The path to the document to create. If the document could not be created, this returns the resulting exception information. Returns the document if it was successfully saved.

Loads the settings file at the given path.

Represents a collection of named source files which has specific settings applied to them.

The collection of files in the file list.

Initializes a new instance of the SourceFileListSettings class.

The settings for this file list.

Gets the custom settings for this file list.

Gets the collection of files in the file list.

Determines whether the given file exists within the file list.

The name of the file. true if the file exists; false otherwise.

Adds a file to the file list.

The name of the file to add.

Loads settings from a version 4.3 settings document.

The types of settings properties.

A property containing a boolean value.

A property containing an integer value.

A property containing a string value.

A property containing a collection of properties.

Not a valid property.

Loads the settings from the document.

The settings document. Stores the settings.

Loads the settings from the document.

The root node of the settings document. Stores the settings.

Converts a legacy "Microsoft.SourceAnalysis" or "Microsoft.StyleCop" AddIn name to the new name.

The original name. Returns the converted name.

Determines the type of property represented by the property type name.

The property type name. Returns the well-known property type.

Loads analyzer settings from the document.

The root node of the settings document. Stores the settings.

Loads and stores a boolean property.

The name of the property to load. The node containing the property. The collection in which to store the property. The collection of property descriptors.

Loads and stores a collection property.

The name of the property to load. The node containing the property. The collection in which to store the property. The collection of property descriptors.

Loads files specified in file lists.

The root node of the settings document. Stores the settings.

Loads and stores an integer property.

The name of the property to load. The node containing the property. The collection in which to store the property. The collection of property descriptors.

Loads parser settings from the document.

The root node of the settings document. Stores the settings.

Loads a property collection from the settings file.

The node containing the property collection. The property collection storage object. The collection of property descriptors. An optional rule name to prepend the each property name.

Loads settings for rules.

The add-in containing the rules. The collection of properties to add the rules settings into. The collection of property descriptors for the add-in.

Loads and stores a string property.

The name of the property to load. The node containing the property. The collection in which to store the property. The collection of property descriptors.

Loads settings from a version 4.1 settings document.

Changes the name of an analyzer setting property, if it exists.

The settings document. The analyzer name. The legacy name of the property. The new name of the property.

Loads the settings from the document.

The settings document. Stores the settings.

Adds a boolean property.

The name of the property. The property value. The collection of properties. The collection of property descriptors.

Adds or updates a property to enable or disable a rule depending on the value of a legacy property.

The name of the rule to enable or disable. The value of the legacy property. The collection of properties. The collection of property descriptors.

Loads analyzer settings from the document.

The settings document. Stores the settings.

Loads and stores a boolean property.

The name of the property to load. The node containing the property. The collection in which to store the property. The collection of property descriptors. If the settings node comes from a legacy, pre-4.2 analyzer, this parameter contains the ID of the legacy analyzer.

Loads and stores a collection property.

The name of the property to load. The node containing the property. The collection in which to store the property. The collection of property descriptors.

Loads and stores an integer property.

The name of the property to load. The node containing the property. The collection in which to store the property. The collection of property descriptors.

Loads parser settings from the document.

The settings document. Stores the settings.

Loads a property collection from the settings file.

The node containing the property collection. The property collection storage object. The collection of property descriptors. If the settings node comes from a legacy, pre-4.2 analyzer, this parameter contains the ID of the legacy analyzer.

Loads settings for rules.

The add-in containing the rules. The collection of properties to add the rules settings into. The collection of property descriptors for the add-in.

Loads and stores a string property.

The name of the property to load. The node containing the property. The collection in which to store the property. The collection of property descriptors.

Maps a 4.1 analyzer ID to a 4.3 analyzer ID.

The ID of the 4.1 analyzer. Returns the 4.3 analyzer ID.

Maps the given 4.1 analyzer name to a list of 4.3 rules.

The ID of the 4.1 analyzer. Returns the collection of 4.3 rules mapping to the analyzer.

Loads settings from a version 4.2 settings document.

Loads the settings from the document.

The settings document. Stores the settings.

Moves a rule from one analyzer node to a different analyzer node.

The settings document. The legacy analyzer name. The new analyzer name. The name of the rule to move.

Contains a collection of properties.

Gets the collection of property descriptors.

Handles saving and loading file data from the cache.

The current file cache version.

The DateTime format we use for the results cache.

The StyleCop core instance.

The dictionary to store the cached documents in.

Initializes a new instance of the ResultsCache class.

The StyleCop core instance.

Saves the cached results.

Loads the given project from the cache.

The project to load. Returns the project configuration or null if the project does not exist in the cache.

Loads results for the given source code document from the cache.

The source code to load. The parser that created this document. The last write time of the document. The time when the settings were last updated. Returns true if the results were loaded from the cache.

Saves the given code document results into a cache document.

The document to save. The parser that created the document. The time when the settings were last updated. Returns true if the document was saved.

Saves the given code project configuration into a cache document.

The project to save. Returns true if the configuration was saved.

Determines whether the timestamp information contained in the given node is equal to the given timestamp.

The node containing the timestamp information. The time to match again. Returns true if the node matches the given timestamp.

Determines whether the timestamp information contained in the given node is equal to the given timestamp.

The node containing the timestamp information. The time to match again. Returns true if the node matches the given timestamp.

Adds an xml element to the xmlNode containing the Timestamp provided.

The XmlDocument to use. The XmlNode to add the element under. The name to use for the element being created. The hashCode to write into the node.

Adds an xml element to the xmlNode containing the Timestamp provided.

The XmlDocument to use. The XmlNode to add the element under. The name to use for the element being created. The DateTime to write into the node.

Opens the results cache for the given code project.

The code project. Returns the node from the results cache for this code project. Returns the results cache.

Opens the results cache for the given source code document.

The source code document. The parser that created the document. Returns the node from the results cache for this code document. Returns the results cache.

A set of properties for a StyleCop add-in.

The analyzer or parser add-in.

Initializes a new instance of the AddInPropertyCollection class.

An analyzer or parser add-in.

Gets the StyleCop add-in.

Clones the contents of the collection.

Returns the cloned collection.

A property descriptor for a collection property.

Indicates whether the collection is an aggregate collection.

Initializes a new instance of the CollectionPropertyDescriptor class.

The name of the property. The friendly name of the property. The property description. Indicates whether to merge the property with parent properties. Indicates whether the collection is an aggregate collection.

Gets a value indicating whether the collection is an aggregate collection.

A property descriptor.

The description of the property.

Indicates whether to display the property on the settings dialog by default.

The friendly name of the property.

Indicates whether to merge the property with parent properties.

The name of the property.

The type of the property.

Initializes a new instance of the PropertyDescriptor class.

The name of the property. The type of the property. The friendly name of the property. The property description. Indicates whether to merge the property with parent properties. Indicates whether to display the property on the settings dialog.

Gets the description of the property.

Gets a value indicating whether to display the property on the settings dialog by default.

Gets the friendly name of the property.

Gets a value indicating whether to merge the property with parent properties.

Gets the name of the property.

Gets the type of the property.

Contains a collection of property descriptors.

The properties.

Initializes a new instance of the PropertyDescriptorCollection class.

Gets the number of property descriptors in the collection.

Gets a value indicating whether the collection is read-only.

Gets the collection of property descriptors.

Gets the collection of property names.

Gets the property descriptor for the given property name.

The name of the property. Returns the property descriptor or null if there is no property with the given name.

Adds a property descriptor to the collection.

The property descriptor to add.

Clears the collection.

Determines whether the given property descriptor is contained in the collection.

The property descriptor to search for. Returns true if the property descriptor is contained within the collection.

Determines whether the given property descriptor is contained in the collection.

The property name to search for. Returns true if the property descriptor is contained within the collection.

Copies values from the collection to the given array.

The array to copy the items into. The index within the array to begin copying.

Gets an enumerator for iterating through the values in the property descriptor collection.

Returns the enumerator.

Gets the property descriptor for the given property.

The name of the property. Returns the property descriptor for the given property, or null if the property is not contained within the collection.

Removes the given property descriptor from the collection.

The property descriptor to remove. Returns true if the property descriptor was removed from the collection, or false if it did not exist in the collection.

Gets an enumerator for iterating through the values in the property descriptor collection.

Returns the enumerator.

Adds the given descriptor to the collection.

The descriptor to add.

Initializes the contents of the collection from the given Xml.

The properties Xml node.

Extracts and returns the property description from the given node.

The property node. Returns the property description.

Extracts and returns the display settings value from the given node.

The property node. Returns the display settings value.

Extracts and returns the property friendly name from the given node.

The property node. Returns the property friendly name.

Extracts and returns the merge value from the given node.

The property node. Returns the merge value.

Extracts and returns the property name from the given node.

The property node. Returns the property name.

Adds a boolean property descriptor from the given Xml node.

The node containing the property descriptor information.

Adds a collection property descriptor from the given Xml node.

The node containing the property descriptor information.

Adds an integer property descriptor from the given Xml node.

The node containing the property descriptor information.

Adds a string property descriptor from the given Xml node.

The node containing the property descriptor information.

A property descriptor for a simple property.

The type of the property value described by the property descriptor.

Initializes a new instance of the class. Initializes a new instance of the PropertyDescriptor class.

Gets the default value of the property.

A simple property.

The type of the property value.

The value of the property.

Initializes a new instance of the class. Initializes a new instance of the PropertyValue class.

The property descriptor that this value represents. The value of the property.

Initializes a new instance of the class. Initializes a new instance of the PropertyValue class.

The container of this property. The name of the property. The value of the property.

Gets the default value of the property.

Gets a value indicating whether the property has a default value.

Gets a value indicating whether the property is currently set to the default value for the property.

Gets or sets the value of the property.

Clones the contents of the property.

Returns the cloned property.

Determines whether this property overrides the given property.

The parent property to compare with. Returns true if this property overrides the given property.

Loads settings from a pre-version 4.1 settings document.

The default settings file name.

Loads a pre-version 4.1 settings document.

The settings to load. The object where the settings will be stored.

Adds a boolean property to the settings.

The name of the property. The value of the property. The collection of properties. The collection of property descriptors.

Adds or updates a property to enable or disable a rule depending on the value of a legacy property.

The name of the rule to enable or disable. The value of the legacy property. The collection of properties. The collection of property descriptors.

Enables or disables all rules for the given analyzers.

The node representing the analyzer. The settings. Indicates whether to enable or disable the rules.

Sets the AnalyzeDesignerFiles property on the C# parser.

The settings collection. The text of the setting from the settings file.

Sets the given property on the given parser.

The settings collection. The ID of the analyzer. The name of the property to set. The text of the setting from the settings file.

Loads a property which no longer exists, and translates it into an enabled or disabled rule.

The settings. The ID of the analyzer owning the property. The name of legacy property. The property value.

Loads the valid prefixes from the given node..

The node containing the prefixes. The settings collection.

Maps a 4.0 analyzer ID to a 4.3 analyzer ID.

The ID of the 4.0 analyzer. Returns the 4.3 analyzer ID.

Maps the given 4.1 analyzer name to a list of 4.3 rules.

The ID of the 4.1 analyzer. Returns the collection of 4.3 rules mapping to the analyzer.

Attribute class for marking StyleCop add-in classes.

The id of the add-in xml file within the assembly resources.

Initializes a new instance of the StyleCopAddInAttribute class.

The ID of the add-in xml file within the analyzer resource.

Gets the ID of the add-in xml file within the assembly resources.

The environment used to interact with source code documents, settings, etc.

Gets the StyleCop core instance.

Gets a value indicating whether the environment supports settings documents which link directly to another settings document to merge with.

Gets a value indicating whether the environment supports reading and writing violation results caches.

Invoked when a new parser is loaded.

The new parser.

Adds a source code document to the given project.

Gets the path to the default settings file for the currently running StyleCop installation.

Returns the path or null if there is none.

Given the path to a settings document, determines the path to a parent settings file, if one exists.

The path to the local settings document. Returns the path to the parent settings document or null if none exists. The environment should search through parent folders above the location of the given settings file to attempt to find a parent settings file.

Gets the settings for the given project.

The project containing the settings. Indicates whether to merge the settings with parent settings before returning them. Returns the settings.

Gets the settings given the path to local settings.

The path to the settings to load. Indicates whether to merge the settings with parent settings before returning them. Returns the settings.

Loads or creates the settings at the given path, and returns them in writable mode.

The path to the settings. Returns an exception if one occurred loading or creating the settings. Returns the settings.

Loads or creates the settings at the given path, and returns them in writable mode.

The path to the settings. Returns the settings.

Loads the results cache at the given location.

The location of the results cache to load. Returns the results cache or null if there is no results cache at that location.

Removes the analysis results at the given location.

The location of the analysis results to remove.

Saves the analysis results at the given location.

The path to save the results under. The results to save. Returns an exception if one occurs while saving the results. Returns true if the results were saved successfully.

Saves the given results cache.

The location to save the results cache under. The results cache to save.

Saves the settings document at the path specified within the document.

The settings to save. If the document could not be saved, this returns the resulting exception information. Returns true if the document was successfully saved.

Saves the settings document at the path specified within the document.

The settings to save. Returns true if the document was successfully saved.

Describes source code to parse and analyze.

Each piece of source code to be parsed and analyzed by StyleCop must be described by a SourceCode object. A SourceCode object may only be used once. After the SourceCode has been processed by StyleCop, it cannot be sent to StyleCop a second time for analysis.

The list of configurations for the document.

The parser that handles this source code document.

The project that contains the source code document.

The list of violations in this document.

The settings for the project.

Initializes a new instance of the SourceCode class.

The project that contains this document. The parser that created this document.

Initializes a new instance of the SourceCode class.

The project that contains this document. The parser that created this document. The list of configurations for the document.

Gets the list of configurations for the file.

Gets a value indicating whether the source code document currently exists and is accessible.

Gets the name of the source code document.

Gets the parser that created this document.

Gets the full path to the source code document.

Gets the project that contains the document.

Gets or sets the settings for this source code.

Gets the time that the source code was last edited or updated.

Gets the type of code that the document contains.

Gets the violations found within this document.

Reads the contents of the source code into a TextReader.

Returns the TextReader containing the source code.

Adds one violation to this element.

The violation to add. Returns false if there is already an identical violation in the element.

Describes one compilation configuration style for a code document.

The list of conditional compilation flags for this configuration.

Initializes a new instance of the Configuration class.

The list of conditional compilation flags for this configuration.

Gets the list of flags defined in the configuration.

Determines whether the given flag is contained in the configuration.

The flag to search for. Returns true if the flag is contained in the configuration.

Gets the value of the given flag.

The defined flag to retrieve. Returns the value of the flag.

Event handler for converting elements within an adapted collection.

The type of the elements stored in the original collection. The type of the element returned in the adapted collection. The element to convert. Returns the converted element.

Adapts an enumerable collection from one format to another.

The type of the elements stored in the original collection. The type of the elements returned in the adapted collection. Implements the weakly typed interface IEnumerable.

The adapter converter.

The enumerable collection that is wrapped by this class.

Initializes a new instance of the class. Initializes a new instance of the EnumerableAdapter class.

The enumerable collection to wrap. Converts elements from the original list to the adapted list.

Gets the inner enumerable collection wrapped by this adapter.

Gets an enumerator for iterating through the items in the list.

Returns the enumerator.

Converts the item to its adapted format.

The item to convert. Returns the converted item.

Gets an enumerator for iterating through the items in the list.

Returns the enumerator.

Keeps track of the analysis status for a single code project.

Indicates whether to ignore the cached results for all files in this project.

Gets or sets a value indicating whether to ignore the cached results for all source code documents within this project.

Describes one analysis rule exposed by a StyleCop analyzer or parser.

Indicates whether the rule can be disabled.

The short ID of the rule.

The context message for the rule.

The rule description.

Indicates whether the rule is enabled by default.

The name of this rule.

The namespace that the rule is contained within.

The unique hash ID for the rule namespace.

The rule group that contains this rule.

The unique hash ID for the rule.

Indicates whether the rule is a warning.

Initializes a new instance of the Rule class.

The name of this rule. The namespace that the rule is contained within. The short ID of the rule. The context message for the rule. Indicates whether the rule is a warning.

Initializes a new instance of the Rule class.

The name of this rule. The namespace that the rule is contained within. The short ID of the rule. The context message for the rule. Indicates whether the rule is a warning. The description of the rule. The rule group that contains this rule. Indicates whether the rule is enabled by default. Indicates whether the rule can be disabled.

Gets a value indicating whether the rule can be disabled.

Gets the short identifier of the rule.

Gets the context message for the rule.

Gets the description of the rule.

Gets a value indicating whether the rule is enabled by default.

Gets the name of this rule.

Gets the namespace that contains the rule.

Gets the rule group that contains this rule, if any.

Gets a unique ID for this specific rule, which can be used as a hash for identifying this rule.

Gets a unique ID for this rule's namespace, which can be used as a hash for identifying the namespace.

Gets a value indicating whether the rule is a warning.

Gets a unique ID for identifying a rule.

The namespace containing the rule. The CheckID code for the rule, or * to match against all rules in the namespace. The rule name, or null if CheckID is *. Returns the unique ID.

Gets a unique hash code for identifying the rule.

Returns the hash code.

Generates a unique ID for a specific rule, which can be used as a hash for identifying the rule.

The rule's namespace. The rule's checkID. The rule's name. Returns the unique ID.

Generates a unique ID for the rule's namespace, which can be used as a hash for identifying the namespace.

The rule's namespace. Returns the unique ID.

The list of rules that can be triggered by this analyzer module.

An exception occurred while parsing the file.

A boolean property.

Initializes a new instance of the BooleanProperty class.

The property descriptor that this value represents. The value of the property.

Initializes a new instance of the BooleanProperty class.

The container of this property. The name of the property. The value of the property.

Clones the contents of the property.

Returns the cloned property.

Contains a collection of strings.

The inner property collection.

Initializes a new instance of the CollectionProperty class.

The property descriptor that this value represents.

Initializes a new instance of the CollectionProperty class.

The property descriptor that this value represents. The inner collection.

Initializes a new instance of the CollectionProperty class.

The container of this property. The name of the property.

Initializes a new instance of the CollectionProperty class.

The container of this property. The name of the property. The inner collection.

Gets a value indicating whether to aggregate the collection when merged.

Gets the number of values in the property values collection.

Gets a value indicating whether the property has a default value.

Gets a value indicating whether the property is currently set to the default value for the property.

Gets the collection of property values.

Adds a value to the property list.

The item to add.

Clears the list of property values.

Clones the contents of the collection.

Returns the cloned collection.

Determines whether the given value is contained in the property value list.

The item to search for. Returns true if the item is contained within the list.

Copies values from the list to the given array.

The array to copy the items into. The index within the array to begin copying.

Gets an enumerator for iterating through the values in the property collection.

Returns the enumerator.

Determines whether this property overrides the given property.

The parent property to compare with. Returns true if this property overrides the given property.

Removes the given value from the property list.

The value to remove. Returns true if the value was removed from the property collection, or false if it did not exist in the collection.

Gets an enumerator for iterating through the values in the property collection.

Returns the enumerator.

Determines whether the local values overrides the parent values.

The local values. The parent values. Indicates whether the collection is an aggregate collection. Returns true if the local values overrides the parent values.

An integer property.

Initializes a new instance of the class.

The property descriptor that this value represents. The value of the property.

Initializes a new instance of the class.

The container of this property. The name of the property. The value of the property.

Clones the contents of the property.

Returns the cloned property.

Interface which must be implemented by a page that appears on the .

Gets or sets a value indicating whether the page is dirty.

Gets the text displayed on the page tab.

Called whenever the page is being shown or hidden.

True if the page is being show, false if it is being hidden.

Saves the data on the page and resets any internal dirty flags.

Returns true if the page settings were applied.

Initializes the page object.

The property control that hosts the page.

Allows the property page to perform an action after the settings for all pages have been applied.

Indicates whether the page was dirty before it was applied.

Allows the property page to perform an action before any of the settings pages have been applied.

Returns false if no pages should be applied.

Called when the merged settings have changed.

Contains a collection of properties.

The properties.

Indicates whether the collection is read-only.

Initializes a new instance of the PropertyCollection class.

Gets the number of properties in the collection.

Gets a value indicating whether the collection is read-only.

Gets the collection of properties.

Gets the property with the given name.

The name of the property. Returns the property or null if there is no property with the given name.

Adds a property to the collection.

The property to add.

Clears the list of property values.

Clones the contents of the collection.

Returns the cloned collection.

Determines whether the given property is contained in the collection.

The property to search for. Returns true if the property is contained within the collection.

Determines whether the given property is contained in the collection.

The name of the property to search for. Returns true if the property is contained within the collection.

Copies values from the collection to the given array.

The array to copy the items into. The index within the array to begin copying.

Gets an enumerator for iterating through the values in the property collection.

Returns the enumerator.

Gets the property values collection for the given property.

The name of the property. Returns the values collection for the property or null if the property is not contained within the collection.

Removes the given property from the collection.

The property to remove. Returns true if the property was removed from the property collection, or false if it did not exist in the collection.

Removes the given property from the collection.

The name of the property to remove. Returns true if the property was removed from the property collection, or false if it did not exist in the collection.

Sets the given property.

The property to set.

Gets an enumerator for iterating through the values in the property collection.

Returns the enumerator.

Hosts property pages.

The context for the property pages.

The StyleCop core instance.

Indicates whether any of the pages are dirty.

The property page host.

The settings file to read from and write to.

The local settings merged with parent settings.

The pages to display.

The settings one level up from the local settings file.

Compares the local settings with the merged settings.

The pages to display.

Initializes a new instance of the PropertyControl class.

Gets the currently active page.

Gets the list of context objects passed to this property control.

Gets the StyleCop core instance.

Gets a value indicating whether any of the pages are dirty.

Gets the local settings file to read from and write to.

Gets the local settings merged with all parent settings.

Gets the list of pages that are currently loaded on the property control.

Gets the settings which the local settings are merged with at runtime, or null if there are no settings to merge.

Gets a comparer that can be used to determine whether local settings are overriding parent settings.

Called when the property control should be cancelled.

Sets the dirty flag and notifies the host that the dirty status has changed.

Called when the parent settings have changed.

Applies the data on the property pages.

Returns true if any pages were dirty. Returns false if any page returned false from it's apply call, in which case the apply failed.

The control must be initialized by calling this method during the host's OnLoad event.

Interface implemented by the host object. The array of pages to display on the tab control. The settings to read from and write to. The StyleCop core instance. The context for the property control.

Required method for Designer support - do not modify the contents of this method with the code editor.

Called when the size of the dialog changes.

The event sender.. The event arguments.

Sets the size of a tab page to fill the sheet area.

The index of the tab to size.

The possible property types.

A string value.

A boolean value.

An integer value.

A collection of values.

A single property.

The property descriptor.

Initializes a new instance of the PropertyValue class.

The property descriptor that this value represents.

Initializes a new instance of the PropertyValue class.

The container of this property. The name of the property.

Gets the description of the property.

Gets the friendly name of the property.

Gets a value indicating whether the property has a default value.

Gets a value indicating whether the property is currently set to the default value for the property.

Gets a value indicating whether the property is read-only.

Gets the property descriptor that this value represents.

Gets the name of the property.

Gets the type of the property.

Clones the contents of the property.

Returns the cloned property.

Determines whether this property overrides the given property.

The parent property to compare with. Returns true if this property overrides the given property.

Represents a single StyleCop settings file in read-only mode.

The alternate settings file name.

The default settings file name.

The settings for the analyzers.

The contents of the settings document.

The StyleCop core instance.

Lock object for enabled rules dictionary

The global settings.

The path to the settings document.

The settings for the parsers.

The collection of excluded files specified in the settings.

Indicates whether this is the default settings file for the installation.

The collection of enabled analyzers based on the settings.

Initializes a new instance of the Settings class.

The StyleCop core instance. The location of the settings document.

Initializes a new instance of the Settings class.

The StyleCop core instance. The path to the settings document. The initial contents of the settings document. The time when the settings were last updated.

Initializes a new instance of the Settings class.

The StyleCop core instance.

Gets the collection of settings for the analyzers.

Gets the contents of the settings document.

Gets the collection of enabled analyzers for these settings.

Gets the global settings.

Gets a value indicating whether the settings are loaded.

Gets the location of the settings file.

Gets the collection of settings for the parsers.

Gets a value indicating whether rules for this file list are enabled or disabled by default.

Gets the collection of source files lists.

Gets the time when the settings were last updated.

Gets the core instance.

Gets or sets a value indicating whether this is the default settings file for the installation.

Gets the settings for the analyzers.

Gets the settings for the parsers.

Gets a setting for the given add-in.

The add-in. The name of the setting property. Returns the setting or null if the setting does not exist for the add-in.

Gets the settings for the given add-in.

The add-in. Returns the add-in settings or null if there are no settings for the add-in.

Gets the custom settings for a file with the given name, if any.

The name of the file. Returns the custom settings or null if there are no custom settings specified for this file. Custom settings are specified through a SourceFileList node in the settings file.

Gets a value indicating whether the given rule is enabled for the given document.

The analyzer which contains the rule. The rule to check. Returns true if the rule is enabled; otherwise false.

Adds a set of custom source file settings.

The source file list settings.

Clears a setting for the given add-in.

The add-in. The name of the property to clear.

Sets a setting for the given add-in.

The add-in. The setting property to set.

Sets the settings for the given add-in.

The properties to set. This overrides any existing settings for the add-in.

Gets the correct property collection dictionary depending on whether the given add-in is a parser or an analyzer.

The add-in. Returns the correct dictionary.

Initializes the collection of enabled analyzers and rules based on these settings.

Loads the settings from the document.

Compares two settings files.

The local settings.

The parent settings to merge with the local settings.

Initializes a new instance of the SettingsComparer class.

The local settings. The parent setting to merge with the local settings, or null.

Gets the local settings.

Gets the parent settings.

Determines whether the local property overrides the parent property.

The local property. The parent property. Returns true if the local property overrides the parent property.

Determines whether the given add-in setting overrides the parent setting.

The add-in. The name of the property. The local value of the property. Returns true if the given add-in setting overrides the parent setting.

Determines whether the given global setting overrides the parent setting.

The name of the property. The local value of the property. Returns true if the given global setting overrides the parent setting.

Determines whether a local global setting overrides the parent setting.

The name of the property. Returns true if the local global setting overrides the parent setting.

Determines whether a local add-in setting overrides the parent setting.

The add-in. The name of the property. Returns true if the local add-in setting overrides the parent setting.

Merges a settings file with other settings files.

The name of the linked settings property.

The name of the merge settings property.

Merge with a linked settings file.

Do not merge the settings file.

Merge with a parent settings file.

The environment in which StyleCop is running.

The settings which should be merged.

Initializes a new instance of the SettingsMerger class.

The settings which should be merged. The environment in which StyleCop is running.

Gets the local settings merged with parent settings.

Gets the merged parent settings which would be merged with the local settings.

Merged two sets of property collections together.

The original property collection. The overriding property collection. The merged property collection.

Determines the type of merge to perform, based on the local settings file.

The settings file The environment. Returns the merge type.

Merges two collection properties together.

The merged property collection. The original property to merge. The overriding property to merge.

Merges two settings files together.

The original settings. The settings which are overriding the original settings. Returns the merged settings.

Finds a linked settings document and merges it with the given settings.

The original settings. Indicates whether the merge the original settings with the linked settings. Returns the merged settings. This method is designed to work only in file-based environments.

Scans all parent paths above the path containing the given settings file, and merges all settings together.

The original settings to merge. Indicates whether the merge the original settings with the parent settings files. Returns the merged settings.

A string property.

Initializes a new instance of the StringProperty class.

The property descriptor that this value represents. The value of the property.

Initializes a new instance of the StringProperty class.

The container of this property. The name of the property. The value of the property.

Clones the contents of the property.

Returns the cloned property.

Represents a single StyleCop settings file in read-write mode.

This is the StyleCop.Settings file version number written into files.

Initializes a new instance of the WritableSettings class.

The StyleCop core instance. The location of the settings document. The initial contents of the settings document. The time when the settings were last updated.

Creates a new settings document.

Returns the new document.

Clears a setting for the given add-in.

The add-in. The name of the property to clear.

Sets a setting for the given add-in.

The add-in. The setting property to set.

Writes the settings into the given document.

The environment that StyleCop is running under, if any. Returns the new settings document.

Saves the given boolean property into the given node.

The node under which to store the new property node. The property to save. The name of the property. Returns true if the property was written.

Saves the given collection property into the given node.

The node under which to store the new property node. The property to save. The name of the property. Returns true if the property was written.

Saves the given property into the given node.

The node under which to store the new property node. The property to save. The name of the property. Returns true if the property was written.

Saves the given property collection.

The node to store the property collection beneath. The name of the new property collection node. The property collection to store. The corresponding property collection from the parent settings, if any. Indicates whether the collection is aggregated with the parent collection. An optional name attribute value for the new property node. Returns true if at least one property was saved.

Saves a single property value.

The collection node containing the property. The property to save. The name of the property. Returns true if the property was saved; otherwise false.

Saves a rule property.

The node to store the property collection beneath. The property to save. The name of the rule. The name of the property. Returns true if the property was saved; otherwise false.

Saves the given string property into the given node.

The node under which to store the new property node. The property to save. The name of the property. Returns true if the property was written.

Saves the Settings provided into the XmlDocument.

The root document. The environment that StyleCop is running under, if any. The element to save our settings to. The settings to save.

An add-in to the StyleCop engine.

The default CheckId prefix for rules.

The unique ID of the add-in.

The property descriptors for the add-in.

Stores the list of rules for the add-in.

The StyleCop core instance.

The user-friendly description of the add-in.

The user-friendly name of the add-in.

Initializes a new instance of the StyleCopAddIn class.

Gets the StyleCop core instance.

Gets the description of the add-in.

Gets the unique ID of the add-in.

Gets the name of the add-in.

Gets the collection of property descriptors exposed by the add-in.

Gets the property pages to expose on the StyleCop settings dialog for this add-in.

Gets the time stamp of this assembly.

Gets the collection of rules exposed by this analyzer.

Adds one violation to the given code element.

The element that the violation appears in. The name of the rule that triggered the violation. String parameters to insert into the violation context string.

Adds one violation to the given code element.

The element that the violation appears in. The name of the rule that triggered the violation. String parameters to insert into the violation context string.

Adds one violation to the given code element.

The element that the violation appears in. The location in the code where the violation occurs. The name of the rule that triggered the violation. String parameters to insert into the violation string.

Adds one violation to the given code element.

The element that the violation appears in. The line in the code where the violation occurs. The name of the rule that triggered the violation. String parameters to insert into the violation string.

Adds one violation to the given code element.

The element that the violation appears in. The line in the code where the violation occurs. The name of the rule that triggered the violation. String parameters to insert into the violation string.

Clears the given property for the add-in.

The settings. The name of the property to clear.

Gets the rule with the given name.

The name of the rule to retrieve. Returns the rule or null if there is no rule with the given name.

Gets a setting for a rule exposed by the add-in.

The settings. The name of the rule. The name of the setting property. Returns the setting or null if it does not exist.

Gets a setting for the add-in.

The settings. The name of the setting property. Returns the setting or null if it does not exist.

Allows the add-in to initialize itself, after all initialization documents have been processed.

Gets a value indicating whether the given rule is enabled for the given document.

The document. The rule to check. Returns true if the rule is enabled; otherwise false.

Gets a value indicating whether the given rule is suppressed for the given element.

The element to check. The Id of the rule to check. The Name of the rule to check. The Namespace of the rule to check. Returns true if the rule is suppressed; otherwise false.

Sets the given property on the add-in.

The settings. The property to set.

Called when the user closes the solution.

Called when the user opens a new solution.

Gets the ID of an add-in given the type of that add-in.

The type of the add-in. Returns the ID of the add-in.

Initializes the add-in.

The StyleCop core instance. The add-in's XML initialization document. Indicates whether the xml document comes from the top-most type in the add-in's type hierarchy. Indicates whether the add-in comes from a known assembly.

Parses the Xml document which initializes the add-in.

The xml document to load. Indicates whether the xml document comes from the top-most type in the add-in's type hierarchy. Indicates whether the add-in comes from a known assembly.

Trims extra whitespace and newlines out of Xml text data.

The original Xml content. Returns the trimmed content.

Parses the given Xml document and loads the rules.

The rules node. The optional rule group name. Indicates whether the add-in comes from a known assembly.

The main entry point into the StyleCop core module.

The name of the ID for the project settings property page dialog.

The Major.Minor parts of the StyleCop version number i.e. 4.3 or 4.5.

The full version number of StyleCop i.e. 4.3.1.3 or 4.5.0.23.

Indicates whether the module is currently analyzing files.

True if the analyze should be canceled.

Indicates whether the results cache should be saved for each analyzed source code document.

Indicates whether it is ok to display UI dialogs.

The list of loaded code parsers.

The list of loaded analyzers.

The environment that StyleCop is running under.

The registry manager.

The fake core parser.

A tag object which can be optionally filled in by the host.

Initializes a new instance of the StyleCopCore class.

The environment that StyleCop is running under.

Initializes a new instance of the StyleCopCore class.

The environment that StyleCop is running under. A tag object which can be optionally filled in by the host.

Event that is fired when a violation has been encountered.

Event that is fired when a line of output is generated.

Event that is fired when one or more settings are changed on a project.

Event that is fired before the settings dialog is displayed, to allow listeners to add settings pages.

Gets the current operating system PlatformID.

Gets a value indicating whether StyleCop is currently analyzing files.

Gets or sets a value indicating whether the currently running analysis should cancel.

Gets the time stamp of this assembly.

Gets or sets a value indicating whether the results cache should be saved on disk.

Gets or sets a value indicating whether it is ok to display UI dialogs.

Gets the collection of loaded code parsers.

Gets the environment that StyleCop is running under.

Gets the Registry object, which can be used for writing items to StyleCop's registry key.

Gets the collection of global property descriptors exposed by StyleCop.

Gets the value of the optional tag filled in by the host at the time of this instance's creation.

Gets the list of violations that can be triggered by the core module.

Gets the Major.Minor parts of the StyleCop version number i.e. 4.3 or 4.5.

Gets the full version number of StyleCop i.e. 4.3.1.3 or 4.5.0.23.

Loads the add-in resource xml at the given path.

The add-in type. The resource ID of the analyzer xml. Returns the loaded Xml or null if none was loaded.

Initializes the StyleCop core instance. This must be called before the object can be used.

The list of paths to search under for parser and analyzer addins. Can be null if no addin paths are provided. Indicates whether to load addins from the default path, where the core binary is located.

Analyzes the files within the given projects.

The list of code projects to analyze.

Analyzes the files within the given projects.

The list of code projects to analyze. The path to a StyleCop settings file to use during analysis.

Analyzes the files within the given projects, ignoring all cached results.

The list of code projects to analyze.

Analyzes the files within the given projects, ignoring all cached results.

The list of code projects to analyze. The path to a StyleCop settings file to use during analysis.

Displays the settings dialog for a project.

The path to the settings file to edit. Returns true if at least one settings change was made.

Gets the analyzer with the given ID.

The ID of the analyzer. Returns the analyzer or null if there is no loaded analyzer with the given ID.

Gets the parser with the given ID.

The ID of the parser. Returns the parser or null if there is no loaded parser with the given ID.

Gets the add-in with the given ID.

The ID of the add-in. Returns the add-in or null if there is no loaded add-in with the given ID.

Gets the pages to display on the settings dialog.

The StyleCop core instance. Returns the list of settings pages to display.

Cleans up the given path so that it can always be matched against other paths.

The path to clean. Returns the cleaned path.

Adds a generic violation.

The file to add the violation to. The violation to add to the element.

Adds a generic violation.

The element to add the violation to. The violation to add to the element.

Adds a generic violation.

The element to add the violation to. The type of violation to add. The location the violation appears on. The string values to add to the context string.

Adds a generic violation.

The element to add the violation to. The type of violation to add. Line the violation appears on. The string values to add to the context string.

Adds a generic violation.

The source code document to add the violation to. The type of violation to add. Line the violation appears on. The string values to add to the context string.

Fires an output generated event.

The output to display.

Fires an output generated event.

Level of importance for the output. The output to display.

Displays the settings dialog for a project.

The path to the settings to edit. The ID of the settings property page. Returns true if at least one settings change was made.

Displays a settings dialog for a project.

The path to the settings. The list of pages to display on the settings dialog. A unique identifier string for the property page group. Returns true if at least one settings change was made.

Displays a settings dialog for a project.

The settings manager. The list of pages to display on the settings dialog. A unique identifier string for the property page group. Returns true if at least one settings change was made.

Compares the given configuration with the given list of flags.

The configuration object. The list of flags. Returns true if the configuration is identical to the flag list, or false otherwise.

Initializes the project to prepare it for analysis.

The project to initialize. The analysis data object. The file cache.

Gets the next type in the given add-in type's inheritance chain that implements the given attribute.

The add-in type. The attribute type. Returns the attribute, if found. Returns the next type, or null if there are no types containing the attribute.

Compares two public keys to see if they are the same.

The first public key. The second public key. true if the keys are the same; false otherwise.

Called when a violation is encountered while analyzing a code document. This can be called simultaneously from several threads and so any code must be thread safe.

The event arguments.

Called when a line of output is generated while analyzing a code document. This can be called simultaneously from several threads and so any code must be thread safe.

The event arguments.

Called when the settings are changed for one or more projects. This can be called simultaneously from several threads and so any code must be thread safe.

The event arguments.

Event that is fired before the settings dialog is displayed, to allow listeners to add settings pages.

The event arguments.

Loads the addin modules.

The path to the addin modules. The public key of the core assembly.

Instantiates an add-in object from the given assembly, with the given class name.

The type of the add-in. Indicates whether the add-in comes from a known assembly. Returns the created, initialized add-in.

Performs analysis of the given projects.

The list of code projects to analyze. True if the cache files should be ignored. The path to the settings to use during analysis.

Launches the worker threads and waits for them to complete.

The threading data. The number of threads to create. Returns a value indicating whether analysis of all files has been completed. If this returns false, another round of analysis must be performed.

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 An AlertDialog which provides the user an option has been fired while the program is running in a non-UI state. In this state, the only valid option for AlertDialog is MessageBoxButtons.OK. Check the DisplayUI property on the StyleCopCore object before calling an AlertDialog which provides other options..

Looks up a localized string similar to All files.

Looks up a localized string similar to An error occurred during the analysis: {0}.

Looks up a localized string similar to Rules.

Looks up a localized string similar to Both nodes must be null, or both nodes must be non-null..

Looks up a localized string similar to Options.

Looks up a localized string similar to Must not be null.

Looks up a localized string similar to StyleCop is running in non-UI mode. The settings dialog cannot be displayed in this mode. Check the status of the DisplayUI property on the StyleCopCore object before attempting to display settings..

Looks up a localized string similar to The settings file at this path cannot be loaded: {0}.

Looks up a localized string similar to The collection must not be empty or null.

Looks up a localized string similar to It is not possible to compare properties of different types..

Looks up a localized string similar to The settings file could not be saved: {0}.

Looks up a localized string similar to Could not save the violations file..

Looks up a localized string similar to Could not save the violations file. An exception occurred: {0}.

Looks up a localized string similar to Analyzers are no longer allowed by be disabled by default. The DisableByDefault attribute has been deprecated and is not allowed to appear on a SourceAnalyzer node. Instead, place a DisabledByDefault attribute on Rule nodes to indicate individual rules which are disabled by default..

Looks up a localized string similar to You are about to edit the default settings which are applied to all code on which this installation of StyleCop is run. You may need special permissions to write to the file. Are you sure you want to do this?.

Looks up a localized string similar to The settings file path must not be empty..

Looks up a localized string similar to Please enter a valid deprecated word and it's alternative before clicking the Add button.

Looks up a localized string similar to Enter a valid folder path before clicking Add.

Looks up a localized string similar to Please enter a valid word before clicking the Add button.

Looks up a localized string similar to Error: {0}.

Looks up a localized string similar to An exception occurred while loading one of the StyleCop add-ins: {0}, {1}.

Looks up a localized string similar to Global Settings File.

Looks up a localized string similar to Internal Error.

Looks up a localized string similar to The analyzer or parser add-in returned a null or empty Xml initialization document..

Looks up a localized string similar to The window location input string is invalid: {0}.

Looks up a localized string similar to The local settings file could not be opened or created: {0}.

Looks up a localized string similar to There is no description for the add-in..

Looks up a localized string similar to The root node does not have a valid name attribute..

Looks up a localized string similar to The value must be between {0} and {1}.

Looks up a localized string similar to The value must be greater than {0}.

Looks up a localized string similar to The value must be greater than or equal to {0}.

Looks up a localized string similar to The value must be greater than or equal to zero.

Looks up a localized string similar to The value must be greater than zero.

Looks up a localized string similar to The value must be less than {0}.

Looks up a localized string similar to The value must be less than or equal to {0}.

Looks up a localized string similar to The node has already been inserted into a different collection..

Looks up a localized string similar to The linked settings file does not exist or cannot be loaded..

Looks up a localized string similar to There is no settings file located in a parent folder above the location of this settings file..

Looks up a localized string similar to No violations encountered.

Looks up a localized string similar to The settings file for the project could not be loaded or created: {0}.

Looks up a localized string similar to The PropertyControl object has already been initialized.

Looks up a localized string similar to The property description has not been set..

Looks up a localized string similar to The property container does not contain a property descriptor for the {0} property..

Looks up a localized string similar to The property descriptor does not have a default value defined..

Looks up a localized string similar to The friendly name of the property has not been set..

Looks up a localized string similar to The property has no description..

Looks up a localized string similar to The property has no friendly name..

Looks up a localized string similar to The property has no name..

Looks up a localized string similar to The collection is read-only..

Looks up a localized string similar to The property is read-only..

Looks up a localized string similar to The name of the root node must be 'SourceParser'.

Looks up a localized string similar to A rule's CheckId must be six characters long, composed of two upper-case letters followed by four digits..

Looks up a localized string similar to A rule cannot be marked with DisableByDefault=true if it is also marked with CanDisable=false..

Looks up a localized string similar to The rule {0} does not exist.

Looks up a localized string similar to The rule group has no Name attribute..

Looks up a localized string similar to The rule {0} has no CheckId attribute..

Looks up a localized string similar to The rule {0} has no Context element or the Context is empty..

Looks up a localized string similar to The rule has no Name attribute..

Looks up a localized string similar to A rule name must start with an upper-case letter, and can only contain letters and numbers..

Looks up a localized string similar to A rule with the same name has already been added..

Looks up a localized string similar to StyleCop {0} Default Settings.

Looks up a localized string similar to {0} - {1}.

Looks up a localized string similar to StyleCop {0} Project Settings.

Looks up a localized string similar to A settings file has not been loaded..

Looks up a localized string similar to {0} (*.StyleCop)|*.StyleCop|{1} (*.*)|*.*".

Looks up a localized string similar to Settings files.

Looks up a localized string similar to Settings Files.

Looks up a localized string similar to The analyzer type does not have a properly formatted SourceAnalyzer attribute..

Looks up a localized string similar to The name of the root node must be 'SourceAnalyzer'.

Looks up a localized string similar to A SourceCodeFactory may not return null..

Looks up a localized string similar to The SourceCode's Type property is not set..

Looks up a localized string similar to Spelling.

Looks up a localized string similar to The string must not be empty or null.

Looks up a localized string similar to StyleCop is unable to load. An unexpected error occurred. {0}.

Looks up a localized string similar to A syntax error has been discovered in file {0} on line {1}..

Looks up a localized string similar to A syntax error has been discovered in file {0} on line {1}: {2}.

Looks up a localized string similar to StyleCop.

Looks up a localized string similar to A rule defined within a third-party rules add-in uses the CheckId {0}. CheckIds for third-party rules may not use the SA prefix, but instead must define their own two-letter prefix..

Looks up a localized string similar to {0}: {1}.

Looks up a localized string similar to {0} violations encountered..

Looks up a localized string similar to Warning: {0}.

The style cop thread.

StyleCop thread.

StyleCop analyze thread.

Class that contains data used by analysis worker threads.

The results cache manager.

The StyleCop core instance.

True if the results cache should be ignored.

The current analysis status of each project.

The list of projects to analyze.

The path to the settings to use during analysis.

The current analysis status of each source code document.

The pass number.

The index of the current project.

Stores the settings for each project.

The index of the current source code index within the current project.

Initializes a new instance of the Data class.

The StyleCop core instance. The list of code projects to analyze. The results cache. True to ignore the results cache. The path to the settings to use during analysis.

Gets the StyleCop core instance.

Gets a value indicating whether to ignore the cached results from the last run.

Gets or sets the current pass number.

Gets the results cache handler.

Gets the analysis status for the given source code document.

The source code to retrieve status for. Returns the analysis status for the source code.

Gets the next source code document to analyze.

Returns the source code document to analyze or null if none.

Gets the analysis status for the given project.

The project. Returns the analysis status for the project.

Gets the settings for the given project.

The project containing the settings. Returns the settings or null if the settings could not be loaded. If a settings path has been provided by the host, the project is ignored and the alternate settings provided by the host are loaded instead.

Resets the source code document index.

Pulls out the next source code document.

Returns the source code document to analyze or null if none.

The data for this worker thread.

Indicates whether the analysis of all files is complete.

Initializes a new instance of the StyleCopThread class.

The thread data.

Event that is fired when the thread is completed.

Gets a value indicating whether the analysis of all source code documents is complete.

Runs the thread operation.

The event sender.

Formats the exception message and stack trace into a loggable string.

The exception. Returns the formatted message.

Returns the leafname of the source code path.

The SourceCode object to use. The leafname.

Returns the text to use in the signalled output.

The SourceCode object to use. The text to signal.

Attempts to load results for the given document from the cache.

The source code document to load. Returns true if the results were loaded from the cache.

Parses and analyzes the given document.

The document to parse and analyze. The current status of the documents.

Runs the list of analyzers against the given document.

The document to analyze. The parser that created the document. The list of analyzers to run against the document.

Runs the analyzers against the given document.

The document to analyze. The parser that created the document. The analyzers to run against the document. The current pass number. Returns true if analysis was run, or false if analysis was delayed until the next pass.

The registry utils.

Performs operations in the registry.

The registry utils.

Performs operations in the registry.

Demands permissions on behalf of the RegistryUtils class.

Call this function before creating the RegistryUtils class in order to make sure that you (the caller) will have permissions to access the class.

The sub key to demand permissions for.

Call this function before creating the RegistryUtils class in order to make sure that you (the caller) will have permissions to access the class.

The sub key to demand permissions for.

Used to save the location and size of a form in the registry.

The current location of the form.

The current size of the form.

The current state of the form.

Initializes a new instance of the WindowLocation class.

The input string.

Gets or sets the location value.

Gets or sets the size value.

Gets or sets the window state value.

Converts the values to a string.

Returns the string representations of the values.

The StyleCop sub key.

The current user registry key for StyleCop.

The local machine registry key for StyleCop.

Finalizes an instance of the RegistryUtils class.

Gets the HKCU root key for the StyleCop key as read/write. It will be created if it doesn't exist.

Gets the HKLM root key for the StyleCop key as read only.

Gets a RegistryKey value for the specified and from the local machine hive.

The key to retrieve from the registry. The value to retrieve from the key provided. Returns the RegistryKey value or null if not found.

Gets a value under the StyleCop HKCU key.

The path to the value. Returns the object retrieved.

Adds or overwrites a value under the StyleCop HKCU key.

The path to the value. The object to write. Returns true if the value was written, false if not.

Gets a value under the StyleCop HKLM key.

The path to the value. Returns the object retrieved.

Restores the position of a form.

The unique name of the form. The form to restore. Form's default location (optional). Form's default size (optional). Returns false if there is no registry information for this form, or if the position of the form could not be restored.

Saves the current position of a form in the registry, given the position values.

A unique name for the form. The location of the form. The size of the form. The window state of the form. Return false if the position could not be saved.

Saves the current position of the given form in the registry.

A unique name for this form. The form to save. Returns false if the position could not be saved.

Creates a path of keys in the registry.

The root node to create the keys under. The path the create under the root node. Returns the key to the lowest branch created, or null if the path could not be created.

Traverses a path in the registry and returns the lowest key.

The root that the path is under. The path to traverse. Returns the key if it was found and loaded, or null otherwise.

Gets one value from the registry.

The root key to get the value under. The path to the value under the root key. Return the object or null if it could not be found or retrieved.

Sets one value in the registry.

The root key to set the value under. The path to the value to set. The value to set. Returns true if the value is set, false otherwise.

Used by the GetPath and CreatePath functions.

The path key.

The path stub.

A lightweight host for StyleCop which loads source files and settings files from the file system.

The output file path.

The settings path.

Initializes a new instance of the StyleCopConsole class.

The path to the settings to load or null to use the default project settings files. Indicates whether to write results cache files. Optional path to the results output file. The list of paths to search under for parser and analyzer addins. Can be null if no addin paths are provided. Indicates whether to load addins from the default path, where the core binary is located.

Initializes a new instance of the StyleCopConsole class.

Starts analyzing the source code documents contained within the given projects.

The projects to analyze. Determines whether to ignore cache files and reanalyze every file from scratch. Returns false if an error occurs during analysis.

Loads the settings files to use for the analysis.

The list of projects to use.

Contains the parsed object model for a source code document.

Storage space for analyzer data.

The original source code document.

Initializes a new instance of the CodeDocument class.

The source code document this instance represents.

Gets the parsed contents of the document.

Gets the settings for the the project that contains the document.

Gets the original source code document.

Gets the analyzer data dictionary for the document.

Disposes the contents of the class.

Indicates whether to dispose unmanaged resources.

Describes a project containing one or more source code documents.

The default culture.

The default maximum violation count.

The configuration for the project.

The unique key for the project.

The location where the project is contained.

The target framework version used to check new specification features.

The list of source code documents in the project.

The CultureInfo to use during analysis.

Deprecated words for the spell checker.

Folders to scan for CustomDictionary.xml files.

Maximum number of violations to occur before cancelling analysis.

Recognized words for the spell checker.

The settings for the project.

Indicates whether settings have been loaded into the project.

Indicates whether to write cache results for the project.

Initializes a new instance of the CodeProject class.

The unique key for the project. The location where the project is contained. The active configuration. The framework version for current code project, default 0 if not found.

Gets the project configuration.

Gets the CultureInfo to use during analysis.

Gets the dictionary of deprecated words and their alternatives.

Gets the dictionary of folders that will be scanned for CustomDictionary.xml files.

Gets the unique key for the project.

Gets the location where the project is contained.

Gets the target framework version for current project.

Gets a value indicating how many violations should occur before cancelling analysis.

Gets the list of recognized words.

Gets or sets the settings for the project.

Gets or sets a value indicating whether settings have been loaded into the project.

Gets the list of source code documents in the project.

Gets a value indicating whether to write cache results for the project.

Gets a value indicating whether to treat violations as errors.

Adds the given source code document to the project.

The source code to add.

Options dialog to choose which analyzers to run for the solution.

The name of an analyzer node.

The name of a parser node.

The name of a rule group node.

The name of a rule node.

Stores the properties for each analyzer and parser.

The enabled analyzers tree.

The components container for the control.

The description text box.

The details tree.

Indicates whether the page is dirty.

Initiates search for a rule.

Text string to match against rules for search.

Stores the form's accept button while focus is on the find rule ID textbox.

The static text label.

A tree label.

Find label.

List of images on for tree nodes.

Indicates whether the tree is currently being refreshed.

The table layout panel 1.

The table layout panel 2.

The tab control hosting this page.

Initializes a new instance of the AnalyzersOptions class.

Handler for matching nodes in the rules tree while searching for a node.

The node to match against. The search text to match against. Returns true if the node matches the given text; false otherwise.

Gets or sets a value indicating whether the pages are dirty.

Gets the value to place on the page tab.

Called when the page is activated.

Indicates whether the is being activated or deactivated..

Saves the data and clears the dirty flag.

Returns true if the data was saved, false if not.

Initializes the page.

The tab control object.

Called after all pages have been applied.

The dirty state of the page before it was applied.

Called before all pages are applied.

Returns false if no pages should be applied.

Refreshes the bold state for all analyzers.

Clean up any resources being used.

Dispose parameter.

Searches the given node collection to find a rule group node matching the given name.

The nodes collection. The name of the rule group. Returns the rule group node or null if there is none.

Inserts a nodes into a nodes collection, sorted by name.

The collection of nodes to insert into. The node to insert.

Sets the bold state of the given node.

The node to set. Indicates whether the item should be bolded. The tree that contains the item.

Adjusts the bold state of all nodes in the analyzer tree.

Event handler that is called when the user checks or un-checks an item in the list.

The event sender. The event arguments.

Called after a node is selected.

The event sender. The event arguments.

Called when a tree node is about to be collapsed.

The event sender. The event arguments.

Applies the properties for the given add-in.

The add-in.

Applies settings for rules under the given node.

The addin owning the rules. The parent node of the rules.

Checks or un-checks all nodes beneath the given node.

The node to check or un-check. Indicates whether to check or un-check the nodes.

Event handler that is called when the user checks or un-checks an item in the list.

The event sender. The event arguments.

Called after a node is selected in the details tree.

The event sender. The event arguments.

Sets the bold state of the given properties node based on its current status.

The node containing the properties.

Sets the bold state of the given rule item based on it current status.

The node containing the rule to set. Returns true if the item is bolded, false otherwise.

Adds nodes for an analyzer's rules to the tree.

The analyzer. The parent node for the analyzer.

Fills in the analyzer tree.

Fills the contents of the details tree.

Called when the file rule button is clicked.

The event sender. The event arguments.

Called when the formRuleId TextBox receives the input focus.

The event sender. The event arguments.

Called when a key is clicked while focus is on the find rule textbox.

The event sender. The event arguments.

Called when the formRuleId TextBox loses the input focus.

The event sender. The event arguments.

Required method for Designer support - do not modify the contents of this method with the code editor.

Sets the check state for the given property.

The addin that owns the property. The property.

Initializes the checked state of the given rule.

The rule to check. The node representing the rule.

Iterates through all nodes in the analyzer rules tree to try to find a matching node.

The collection of nodes to iterate. The search text to match against. Performs node matching. Returns the matching node, or null if none was found.

Searches for a rule with the given ID or name. If found, selects and shows the rule.

The text to search for.

Searches for a rule with the given ID or name, searching through various categories of information on the rule.

The text to search for. Returns the tree node representing the rule, or null if no node could be found.

Stores the properties for the given add-in.

The add-in.

A property addin pair.

The add-in.

The property.

Options dialog to choose which settings files to use.

The WinForms components manager.

The browse button.

Indicates whether the page is dirty.

Indicates whether the disable the linked settings options.

The edit button.

Edits the parent settings file.

The page description.

The global file path textbox.

Location label.

Determines whether to merge with a linked settings file.

Determines whether to merge with parent settings files.

Determines whether not to merge the settings.

The table layout panel 1.

The tab control hosting this page.

Initializes a new instance of the GlobalSettingsFileOptions class.

Gets or sets a value indicating whether the page is dirty.

Gets the value to place on the page tab.

Called when the page is activated.

Indicates whether the page is being activated or deactivated.

Saves the data and clears the dirty flag.

Returns true if the data was saved, false if not.

Initializes the page.

The tab control object.

Called after all pages have been applied.

The dirty state of the page before it was applied.

Called before all pages are applied.

Returns false if no pages should be applied.

Refreshes the merged override state of properties on the page.

Clean up any resources being used.

Dispose parameter.

Converts forward slashes to backslashes in a path string.

The path to convert. Returns the converted string.

Called when the browse button is clicked.

The event sender. The event arguments.

Called when the edit linked settings file button is clicked.

The event sender. The event arguments.

Confirms and edits a parent settings file.

The path to the parent settings.

Called when the edit parent settings file button is clicked.

The event sender. The event arguments.

Enables or disables the file controls.

Required method for Designer support - do not modify the contents of this method with the code editor.

Called when the text in the global file path textbox changes.

The event sender. The event arguments.

Called when the 'mergeWithLinkedFile' radio button is checked or unchecked.

The event sender. The event arguments.

Called when the 'mergeWithParents' radio button is checked or unchecked.

The event sender. The event arguments.

Called when the 'noMerge' radio button is checked or unchecked.

The event sender. The event arguments.

Attribute class for marking StyleCop analyzer classes.

The type of the parser that this analyzer is associated with.

Initializes a new instance of the SourceAnalyzerAttribute class.

The type of the parser that this analyzer is associated with.

Initializes a new instance of the SourceAnalyzerAttribute class.

The type of the parser that this analyzer is associated with. The ID of the analyzer xml file within the analyzer resource.

Gets the type of the parser that this analyzer is associated with.

Available log levels for controlling log output.

No logging.

Low log output. Only the most basic log strings use this level.

Medium log output. Data that is interesting, but not necessarily essential, should use this level.

The highest log output. Highly detailed log output should use this level.

Attribute class for marking StyleCop parser classes.

Initializes a new instance of the SourceParserAttribute class.

The ID of the parser xml file within the parser resource.

Extends the default WebClient.

Initializes a new instance of the class.

Gets or sets Timeout.

The get web request.

The address. An instance of a WebRequest.

Exception which is thrown when a syntax error is found in the code which prevents StyleCop from analyzing the code.

The line number that the error appears on.

The source code document that contains the syntax error.

Initializes a new instance of the SyntaxException class.

The source code document containing the exception. The line number of the exception.

Initializes a new instance of the SyntaxException class.

The source code document containing the exception. The line number of the exception. The exception message.

Initializes a new instance of the SyntaxException class.

The source code document containing the exception. The line number of the exception. The exception within this exception.

Initializes a new instance of the SyntaxException class.

The source code document containing the exception. The line number of the exception. The exception message. The exception within this exception.

Initializes a new instance of the SyntaxException class.

Holds the serialization info about the exception. Holds contextual information.

Gets the line number that the syntax error appears on.

Gets the source code document that contains the syntax error.

Populates a SerializationInfo with the data needed to serialize the target object.

The SerializationInfo to populate with data. The destination context for this serialization.

Describes a source code file on disk.

The file type extension of this file.

The folder that the file appears in.

The name of the file.

The path to the file.

Initializes a new instance of the CodeFile class.

The path to the code file. The project that contains this file. The parser that created this file object.

Initializes a new instance of the CodeFile class.

The path to the code file. The project that contains this file. The parser that created this file object. The list of configurations for the file.

Gets a value indicating whether the source code document currently exists and is accessible.

Gets the path to the folder that contains this file.

Gets the full path name of the file, spaced by underscores.

Gets the file name.

Gets the path to the file.

Gets the time that the source code was last edited or updated.

Gets the code type identifier.

This is equivalent to the file extension.

Reads the contents of the source code into a TextReader.

Returns the TextReader containing the source code.

Event argument for output generated event.

Initializes a new instance of the OutputEventArgs class.

The output text.

Initializes a new instance of the OutputEventArgs class.

The output text. The level of importance for this output event.

Gets the importance of the message.

Gets the output text.

Delegate used for getting error text.

Returns the error text.

Used to verify method parameters.

Prevents a default instance of the class from being created.

Asserts on the given value. This is meant to be used in non-public facing methods.

The boolean state of the parameter test. Name of the parameter. Message of the exception to create.

Asserts that the given number is greater than the given value.

The number to check. The number must be greater than this value. The name of the number parameter.