Index: DamClients/DamUI/trunk/release/Install_Version/ogr_csharp.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/System.Data.SQLite.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/TmpImportFiles/scenarios.csv =================================================================== diff -u --- DamClients/DamUI/trunk/release/Install_Version/TmpImportFiles/scenarios.csv (revision 0) +++ DamClients/DamUI/trunk/release/Install_Version/TmpImportFiles/scenarios.csv (revision 2315) @@ -0,0 +1,3 @@ +location_id;location_scenario_id;water_height;water_height_low;dike_table_height;water_height_decimerings_hoogte;max_waterheight;safety_factor_piping;safety_factor_stability_inner_slope;safety_factor_stability_outer_slope;probability_of_failure_stability_innerslope;probability_of_failure_stability_outerslope;probability_of_failure_piping;uplift_criterion_piping;uplift_criterion_stability +D1;1;0.000;0.680;21.110;0.000;1.120;aa;0.000;1.300;31.730;63.310;0.000;1.3;0.000 +D2;1;0.000;1.680;22.110;dd;1.220;32.600;1.000;1.400;32.730;3.310;1.000;1.3;0.000 Index: DamClients/DamUI/trunk/release/Install_Version/DevExpress.XtraCharts.v12.2.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/KellermanSoftware.Compare-NET-Objects.xml =================================================================== diff -u --- DamClients/DamUI/trunk/release/Install_Version/KellermanSoftware.Compare-NET-Objects.xml (revision 0) +++ DamClients/DamUI/trunk/release/Install_Version/KellermanSoftware.Compare-NET-Objects.xml (revision 2315) @@ -0,0 +1,1899 @@ + + + + KellermanSoftware.Compare-NET-Objects + + + + + Cache for properties, fields, and methods to speed up reflection + + + + + Reflection Cache for property info + + + + + Reflection Cache for field info + + + + + Reflection Cache for methods + + + + + Static constructor + + + + + Clear the cache + + + + + Get a list of the fields within a type + + + + + + + + Get the value of a property + + + + + + + + + + Get a list of the properties in a type + + + + + + + + Get a method by name + + + + + + + + Get the cached methods for a type + + + + + + + Compare Parameters + + + + + The configuration settings + + + + + The type of the first object + + + + + The type of the second object + + + + + Details about the comparison + + + + + A reference to the parent object1 + + + + + A reference to the parent object2 + + + + + The first object to be compared + + + + + The second object to be compared + + + + + The breadcrumb in the tree + + + + Implements methods to support the comparison of objects for equality, in a customizable fashion. + + + Implements methods to support the comparison of objects for equality, in a customizable fashion. + The comparison object type. + + + Compare two objects of the same type to each other. + True if the objects are considered equivalent, according to the current CompareLogic. + + + Retrieves the hash of the specified object. + The object to retrieve a hash for. + + + Defines the configuration and logic by which Equals comparisons will be performed. + + + Gets or sets a value indicating whether the base object hashes should be used. + + False by default to allow CompareLogic to evaluate equivalence of otherwise instance-sensitive hashing objects. + NOTE: Any object which doesn't override GetHashCode will behave this way, so this property should generally be left false. + + + + + Helper methods for files and directories + + + + + Get the current directory of the executing assembly + + + + + + Ensure the passed string ends with a directory separator character unless the string is blank. + + The string to append the backslash to. + String with a "/" on the end + + + + Interface for mocking + + + + + Compare two objects of the same type to each other. + + + Check the Differences or DifferencesString Properties for the differences. + Default MaxDifferences is 1 for performance + + + + True if they are equal + + + + Reflection properties and fields are cached. By default this cache is cleared automatically after each compare. + + + + + The default configuration + + + + + Helper methods for processes + + + + + Execute an external program. + + Path and filename of the executable. + Arguments to pass to the executable. + Window style for the process (hidden, minimized, maximized, etc). + Wait for the process to finish. + Exit Code + + + + Class that allows comparison of two objects of the same type to each other. Supports classes, lists, arrays, dictionaries, child comparison and more. + + + CompareLogic compareLogic = new CompareLogic(); + + Person person1 = new Person(); + person1.DateCreated = DateTime.Now; + person1.Name = "Greg"; + + Person person2 = new Person(); + person2.Name = "John"; + person2.DateCreated = person1.DateCreated; + + ComparisonResult result = compareLogic.Compare(person1, person2); + + if (!result.AreEqual) + Console.WriteLine(result.DifferencesString); + + + + + + Set up defaults for the comparison + + + + + Pass in the configuration + + + + + + Set up defaults for the comparison + + If true, use settings from the app.config + + + + Compare two objects of the same type to each other. + + + Check the Differences or DifferencesString Properties for the differences. + Default MaxDifferences is 1 for performance + + + + True if they are equal + + + + Reflection properties and fields are cached. By default this cache is cleared automatically after each compare. + + + + + The default configuration + + + + + Obsolete Use CompareLogic instead + + + + + Obsolete Use CompareLogic instead + + + + + Obsolete Use CompareLogic instead + + + + + Obsolete Use CompareLogic.Compare instead + + + + + Obsolete Use CompareLogic.ClearCache instead + + + + + Obsolete Use the ComparisonResult.ElapsedMilliseconds returned from CompareLogic.Compare + + + + + Obsolete Use CompareLogic.Config.ShowBreadcrumb instead + + + + + Obsolete Use CompareLogic.Config.MembersToIgnore for members or CompareLogic.Config.ClassTypesToIgnore instead + + + + + Obsolete Use CompareLogic.Config.MembersToInclude or CompareLogic.Config.ClassTypesToInclude instead + + + + + Obsolete Use CompareLogic.Config.ComparePrivateProperties instead + + + + + Obsolete Use CompareLogic.Config.ComparePrivateFields instead + + + + + Obsolete Use CompareLogic.Config.CompareStaticProperties instead + + + + + Obsolete Use CompareLogic.Config.CompareStaticFields instead + + + + + Obsolete Use CompareLogic.Config.CompareChildren instead + + + + + Obsolete Use CompareLogic.Config.CompareReadOnly instead + + + + + Obsolete Use CompareLogic.Config.CompareFields instead + + + + + Obsolete Use CompareLogic.Config.IgnoreCollectionOrder instead + + + + + Obsolete Use CompareLogic.Config.CompareProperties instead + + + + + Obsolete Use CompareLogic.Config.MaxDifferences instead + + + + + Obsolete Use the ComparisonResult.Differences returned from CompareLogic.Compare + + + + + Obsolete Use the ComparisonResult.DifferencesString returned from CompareLogic.Compare + + + + + Obsolete Use CompareLogic.Config.AutoClearCache instead + + + + + Obsolete Use CompareLogic.Config.Caching instead + + + + + Obsolete Use CompareLogic.Config.AttributesToIgnore instead + + + + + Obsolete Use CompareLogic.Config.IgnoreObjectTypes instead + + + + + Obsolete Use CompareLogic.Config.CustomComparers instead + + + + + Obsolete Use CompareLogic.Config.CustomComparers instead + + + + + Obsolete Use CompareLogic.Config.ExpectedName instead + + + + + Obsolete Use CompareLogic.Config.ActualName instead + + + + + Obsolete Use CompareLogic.Config.DifferenceCallback instead + + + + + Obsolete Use CompareLogic.Config.CollectionMatchingSpec instead + + + + + Details about the comparison + + + + + Set the configuration for the comparison + + + + + + Keep track of parent objects in the object hiearchy + + + + + Add parent, handle references count + + + + + + Remove parent, handle references count + + + + + + Keep track of the depth of structs being compared. Used with ComparisonConfig.MaxStructDepth + + + + + Configuration + + + + + The amount of time in milliseconds it took for the comparison + + + + + The differences found during the compare + + + + + The differences found in a string suitable for a textbox + + + + + Returns true if the objects are equal + + + + + Returns true if the number of differences has reached the maximum + + + + + Configuration + + + + + Default Constructor + + + + + Reset the configuration to the default values + + + + + Ignore millisecond differences between DateTime values or DateTimeOffset values. The default is 0 (any time difference will be shown). + + + + + When comparing struct, the depth to compare for children. The default is 2 + + + + + If true, unknown object types will be ignored instead of throwing an exception. The default is false. + + + + + If true, invalid indexers will be skipped. The default is false. + + + + + If a class implements an interface then only members of the interface will be compared. The default is all members are compared. + + + + + Show breadcrumb at each stage of the comparision. The default is false. + This is useful for debugging deep object graphs. + + + + + A list of class types to be ignored in the comparison. The default is to compare all class types. + + + + + Only these class types will be compared. The default is to compare all class types. + + + + + Ignore Data Table Names, Data Table Column Names, properties, or fields by name during the comparison. Case sensitive. The default is to compare all members. + + MembersToIgnore.Add("CreditCardNumber") + + + + Only compare elements by name for Data Table Names, Data Table Column Names, properties and fields. Case sensitive. The default is to compare all members. + + MembersToInclude.Add("FirstName") + + + + If true, private properties and fields will be compared. The default is false. Silverlight and WinRT restricts access to private variables. + + + + + If true, private fields will be compared. The default is false. Silverlight and WinRT restricts access to private variables. + + + + + If true, static properties will be compared. The default is true. + + + + + If true, static fields will be compared. The default is true. + + + + + If true, child objects will be compared. The default is true. + If false, and a list or array is compared list items will be compared but not their children. + + + + + If true, compare read only properties (only the getter is implemented). The default is true. + + + + + If true, compare fields of a class (see also CompareProperties). The default is true. + + + + + If true, compare each item within a collection to every item in the other. The default is false. WARNING: setting this to true significantly impacts performance. + + + + + If true, compare properties of a class (see also CompareFields). The default is true. + + + + + The maximum number of differences to detect. The default is 1 for performance reasons. + + + + + The maximum number of differences to detect when comparing byte arrays. The default is 1. + + + + + Reflection properties and fields are cached. By default this cache is cleared after each compare. Set to false to keep the cache for multiple compares. + + + + + + By default properties and fields for types are cached for each compare. By default this cache is cleared after each compare. + + + + + + A list of attributes to ignore a class, property or field + + AttributesToIgnore.Add(typeof(XmlIgnoreAttribute)); + + + + If true, objects will be compared ignore their type diferences. The default is false. + + + + + In the differences string, this is the name for expected name. The default is: Expected + + + + + In the differences string, this is the name for the actual name. The default is: Actual + + + + + Callback invoked each time the comparer finds a difference. The default is no call back. + + + + + Sometimes one wants to match items between collections by some key first, and then + compare the matched objects. Without this, the comparer basically says there is no + match in collection B for any given item in collection A that doesn't Compare with a result of true. + The results of this aren't particularly useful for object graphs that are mostly the same, but not quite. + Enter CollectionMatchingSpec + + The enumerable strings should be property (not field, for now, to keep it simple) names of the + Type when encountered that will be used for matching + + You can use complex type properties, too, as part of the key to match. To match on all props/fields on + such a matching key, Don't set this property (default comparer behavior) + NOTE: types are looked up as exact. e.g. if foo is an entry in the dictionary and bar is a + sub-class of foo, upon encountering a bar type, the comparer will not find the entry of foo + + + + + A list of custom comparers that take priority over the built in comparers + + + + + If true, string.empty and null will be treated as equal. The default is false. + + + + + The precision to compare double values. The default is 0. + + + + + Detailed information about the difference + + + + + Item and property name only + + + + + + The type and index of what is compared + + + + + + Nicely formatted string + + + + + + Name of Expected Object + + + + + Name of Actual Object + + + + + Returns the parent property name + + + + + The breadcrumb of the property leading up to the value + + + + + The child property name + + + + + Object1 Value as a string + + + + + Object2 Value as a string + + + + + The type of the first object + + + + + The type of the second object + + + + + A reference to the parent of object1 + + + + + A reference to the parent of object2 + + + + + Object1 as a reference + + + + + Object2 as a reference + + + + + Prefix to put on the beginning of the message + + + + + Logic for comparing lists that are out of order based on a key + + + + + Common functionality for all Comparers + + + + + Add a breadcrumb to an existing breadcrumb + + Comparison configuration + The existing breadcrumb + The field or property name + The new breadcrumb + + + + Add a breadcrumb to an existing breadcrumb + + The comparison configuration + The existing breadcrumb + The property or field name + Extra information to output after the name + The index for an array, list, or row + The new breadcrumb + + + + Add a breadcrumb to an existing breadcrumb + + Comparison configuration + The existing breadcrumb + The field or property name + Extra information to append after the name + The index if it is an array, list, row etc. + The new breadcrumb + + + + Add a difference for the current parameters + + + + + + Add a difference to the result + + The difference to add to the result + The comparison result + + + + Convert an object to a nicely formatted string + + + + + + + Initializes a new instance of the class. + + The root comparer. + + + + Compares the enumerators and ignores the order + + + + + Abstract Base Duel File Report that has default Output + + + + + Define a dual file report like Beyond Compare, WinMerge etc. + + + + + Output the differences to two files + + A list of differences + The path to write the expected results + The path to write the actual results + + + + Launch the comparison application + + The path to write the expected results + The path to write the actual results + + + + Create two difference files and compare in WinMerge + + A list of the differences + The path to write the expected results + The path to write the actual results + + + + Launch application to compare two files + + The path for the expected file results + The path for the actual file results + + + + Report for showing differences to an end user + + + + + Defines a Single File Report + + + + + Output the differences to a file + + A list of differences + The file path + + + + Output the differences to a stream + + A list of differences + Where to write to + + + + Output the differences to a string + + A list of differences + A string + + + + Launch the application for showing the file + + The file path + + + + Initializes a new instance of the class. + + + + + Output the differences to a file + + A list of differences + The file path + + + + Output the differences to a stream + + A list of differences + Where to write to + + + + Output the differences to a string + + A list of differences + A string + + + + Launch the application for showing the file + + The file path + + + + The text in between the values. Defaults to: CHANGED TO -> + + + + + Output files and launch WinMerge + + + + + Launch the WinMerge + + The path to write the expected results + The path to write the actual results + + + + Find the path of the WinMerge executable + + The path or null if not found + + + + Output files and launch Beyond Compare + + + + + Launch the WinMerge + + The path to write the expected results + The path to write the actual results + + + + Find the path of the Beyond Compare executable + + The path or null if not found + + + + Create a CSV file of the differences and launch the default CSV handler (usually Excel) + + + + + Output the differences to a file + + A list of differences + The file path + + + + Output the differences to a stream + + A list of differences + An output stream + + + + Output the differences to a string + + A list of differences + A string + + + + Launch the WinMerge + + The differences file + + + + Escape special characters + + + + + + + The base comparer which contains all the type comparers + + + + + Compare two objects + + + + + A list of the type comparers + + + + + Factory to create a root comparer + + + + + Get the current root comparer + + + + + + Methods for manipulating strings + + + + + Insert spaces into a string + + + OrderDetails = Order Details + 10Net30 = 10 Net 30 + FTPHost = FTP Host + + + + + + + Compare two byte arrays + + + + + Common functionality for all Type Comparers + + + + + Protected constructor that references the root comparer + + + + + + If true the type comparer will handle the comparison for the type + + The type of the first object + The type of the second object + + + + + Compare the two objects + + + + + A reference to the root comparer as newed up by the RootComparerFactory + + + + + Protected constructor that references the root comparer + + The root comparer. + + + + If true the type comparer will handle the comparison for the type + + The type of the first object + The type of the second object + true if it is a byte array; otherwise, false. + + + + Compare two byte array objects + + + + + Compare two objects of type class + + + + + Constructor for the class comparer + + The root comparer instantiated by the RootComparerFactory + + + + Returns true if the both objects are a class + + The type of the first object + The type of the second object + + + + + Compare two classes + + + + + Compare all columns in a data row + + + + + Constructor that takes a root comparer + + + + + + Returns true if this is a DataRow + + The type of the first object + The type of the second object + + + + + Compare two data rows + + + + + Compare all tables and all rows in all tables + + + + + Constructor that takes a root comparer + + + + + + Returns true if both objects are data sets + + The type of the first object + The type of the second object + + + + + Compare two data sets + + + + + Compare all rows in a data table + + + + + Constructor that takes a root comparer + + + + + + Returns true if both objects are of type DataTable + + The type of the first object + The type of the second object + + + + + Compare two datatables + + + + + Compare DateTimeOffsets with the ability to ignore millisecond differences + + + + + Constructor that takes a root comparer + + + + + + Returns true if both types are DateTimeOffset + + + + + + + + Compare two DateTimeOffset + + + + + + Compare Double values with the ability to specify the precision + + + + + Constructor that takes a root comparer + + + + + + Returns true if both types are double + + + + + + + + Compare two doubles + + + + + + Compare dates with the option to ignore based on milliseconds + + + + + Constructor that takes a root comparer + + + + + + Returns true if both types are DateTime + + + + + + + + Compare two DateTime variables + + + + + + Logic to compare two dictionaries + + + + + Constructor that takes a root comparer + + + + + + Returns true if both types are dictionaries + + The type of the first object + The type of the second object + + + + + Compare two dictionaries + + + + + Logic to compare to enum values + + + + + Constructor with a default root comparer + + + + + + Returns true if both objects are of type enum + + The type of the first object + The type of the second object + + + + + Compare two enums + + + + + Logic to compare two LINQ enumerators + + + + + Constructor that takes a root comparer + + + + + + Returns true if either object is of type LINQ Enumerator + + The type of the first object + The type of the second object + + + + + Compare two objects that implement LINQ Enumerator + + + + + Exclude types depending upon the configuration + + + + + Returns true if the property or field should be excluded + + + + + + + + Check if the class type should be excluded based on the configuration + + + + + + + + + Check if any type has attributes that should be bypassed + + + + + + Compare all the fields of a class or struct (Note this derrives from BaseComparer, not TypeComparer) + + + + + Constructor with a root comparer + + + + + + Compare the fields of a class + + + + + Class FontDescriptorComparer. + + + + + Protected constructor that references the root comparer + + The root comparer. + + + + If true the type comparer will handle the comparison for the type + + The type of the first object + The type of the second object + true if [is type match] [the specified type1]; otherwise, false. + + + + + Compare the two fonts + + + + + Logic to compare two hash sets + + + + + Constructor that takes a root comparer + + + + + + Returns true if both objects are hash sets + + The type of the first object + The type of the second object + + + + + Compare two hash sets + + + + + Compare objects that implement IList + + + + + Constructor that takes a root comparer + + + + + + Returns true if both objects implement IList + + The type of the first object + The type of the second object + + + + + Compare two objects that implement IList + + + + + Logic to compare an integer indexer (Note, inherits from BaseComparer, not TypeComparer) + + + + + Constructor that takes a root comparer + + + + + + Compare an integer indexer + + + + + Logic to compare two IP End Points + + + + + Constructor that takes a root comparer + + + + + + Returns true if both objects are an IP End Point + + The type of the first object + The type of the second object + + + + + Compare two IP End Points + + + + + Logic to compare to pointers + + + + + Constructor that takes a root comparer + + + + + + Returns true if both types are a pointer + + The type of the first object + The type of the second object + + + + + Compare two pointers + + + + + Compare two properties (Note inherits from BaseComparer instead of TypeComparer + + + + + Constructor that takes a root comparer + + + + + + Compare the properties of a class + + + + + Logic to compare two runtime types + + + + + Constructor that takes a root comparer + + + + + + Returns true if both types are of type runtme type + + + + + + + + Compare two runtime types + + + + + Compare primitive types (long, int, short, byte etc.) and DateTime, decimal, and Guid + + + + + Constructor that takes a root comparer + + + + + + Returns true if the type is a simple type + + The type of the first object + The type of the second object + + + + + Compare two simple types + + + + + Compare two strings + + + + + Constructor that takes a root comparer + + + + + + Returns true if both objects are a string or if one is a string and one is a a null + + The type of the first object + The type of the second object + + + + + Compare two strings + + + + + Compare two structs + + + + + Constructor that takes a root comparer + + + + + + Returns true if both objects are of type struct + + + + + + + + Compare two structs + + + + + Logic to compare two timespans + + + + + Constructor that takes a root comparer + + + + + + Returns true if both objects are timespans + + The type of the first object + The type of the second object + + + + + Compare two timespans + + + + + Compare two URIs + + + + + Constructor that takes a root comparer + + + + + + Returns true if both types are a URI + + The type of the first object + The type of the second object + + + + + Compare two URIs + + + + + Methods for detecting + + + + + Returns true if it is a byte array + + + + + + + Returns true if the type can have children + + + + + + + True if the type is an array + + + + + + + Returns true if it is a struct + + + + + + + Returns true if the type is a timespan + + + + + + + Return true if the type is a class + + + + + + + Return true if the type is an interface + + + + + + + Return true if the type is a URI + + + + + + + Return true if the type is a pointer + + + + + + + Return true if the type is an enum + + + + + + + Return true if the type is a dictionary + + + + + + + Return true if the type is a hashset + + + + + + + Return true if the type is a List + + + + + + + Return true if the type is an Enumerable + + + + + + + Return true if the type is a Double + + + + + + + Return true if the type is a DateTime + + + + + + + Return true if the type is a DateTimeOffset + + + + + + Return true if the type is a string + + + + + + + Return true if the type is a primitive type, date, decimal, string, or GUID + + + + + + + Returns true if the Type is a Runtime type + + + + + + + Returns true if the type is an IPEndPoint + + + + + + + Returns true if the type is a dataset + + + + + + + Returns true if the type is a data table + + + + + + + Returns true if the type is a data row + + + + + + + Returns true if the type is a font + + The type1. + + + Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.Dam.Data.dll.config =================================================================== diff -u --- DamClients/DamUI/trunk/release/Install_Version/Deltares.Dam.Data.dll.config (revision 0) +++ DamClients/DamUI/trunk/release/Install_Version/Deltares.Dam.Data.dll.config (revision 2315) @@ -0,0 +1,125 @@ + + + + + +
+ + + + + + segments + + + locations + + + soilprofiles + + + surfacelines + + + characteristicpoints + + + csv + + + Soilbase\soilbase.mdb + + + modelparameters + + + 0.66 + + + pl1lines + + + gauges + + + .\DGeoStability.exe + + + .\GeoStudio.exe + + + Automatic + + + 36 + + + 2 + + + 14 + + + 2 + + + 3 + + + 2 + + + 6 + + + 2 + + + 10 + + + 2.5 + + + 10 + + + 2.5 + + + OnBoundaryLines + + + 0.25 + + + OnBoundaryLines + + + 0.25 + + + + + Index: DamClients/DamUI/trunk/release/Install_Version/LumenWorks.Framework.IO.XML =================================================================== diff -u --- DamClients/DamUI/trunk/release/Install_Version/LumenWorks.Framework.IO.XML (revision 0) +++ DamClients/DamUI/trunk/release/Install_Version/LumenWorks.Framework.IO.XML (revision 2315) @@ -0,0 +1,1538 @@ + + + + LumenWorks.Framework.IO + + + + + Represents a reader that provides fast, cached, dynamic access to CSV data. + + The number of records is limited to - 1. + + + + Contains the cached records. + + + + + Contains the current record index (inside the cached records array). + + + + + Indicates if a new record is being read from the CSV stream. + + + + + Contains the binding list linked to this reader. + + + + + Initializes a new instance of the CsvReader class. + + A pointing to the CSV file. + if field names are located on the first non commented line, otherwise, . + + is a . + + + Cannot read from . + + + + + Initializes a new instance of the CsvReader class. + + A pointing to the CSV file. + if field names are located on the first non commented line, otherwise, . + The buffer size in bytes. + + is a . + + + Cannot read from . + + + + + Initializes a new instance of the CsvReader class. + + A pointing to the CSV file. + if field names are located on the first non commented line, otherwise, . + The delimiter character separating each field (default is ','). + + is a . + + + Cannot read from . + + + + + Initializes a new instance of the CsvReader class. + + A pointing to the CSV file. + if field names are located on the first non commented line, otherwise, . + The delimiter character separating each field (default is ','). + The buffer size in bytes. + + is a . + + + Cannot read from . + + + + + Initializes a new instance of the CsvReader class. + + A pointing to the CSV file. + if field names are located on the first non commented line, otherwise, . + The delimiter character separating each field (default is ','). + The quotation character wrapping every field (default is '''). + + The escape character letting insert quotation characters inside a quoted field (default is '\'). + If no escape character, set to '\0' to gain some performance. + + The comment character indicating that a line is commented out (default is '#'). + Determines how values should be trimmed. + + is a . + + + Cannot read from . + + + + + Initializes a new instance of the CsvReader class. + + A pointing to the CSV file. + if field names are located on the first non commented line, otherwise, . + The delimiter character separating each field (default is ','). + The quotation character wrapping every field (default is '''). + + The escape character letting insert quotation characters inside a quoted field (default is '\'). + If no escape character, set to '\0' to gain some performance. + + The comment character indicating that a line is commented out (default is '#'). + if spaces at the start and end of a field are trimmed, otherwise, . Default is . + The buffer size in bytes. + + is a . + + + must be 1 or more. + + + + + Gets the current record index in the CSV file. + + The current record index in the CSV file. + + + + Gets a value that indicates whether the current stream position is at the end of the stream. + + if the current stream position is at the end of the stream; otherwise . + + + + Gets the field at the specified index. + + The field at the specified index. + + must be included in [0, [. + + + No record read yet. Call ReadLine() first. + + + The CSV data appears to be missing a field. + + + The CSV appears to be corrupt at the current position. + + + The instance has been disposed of. + + + + + Reads the CSV stream from the current position to the end of the stream. + + + The instance has been disposed of. + + + + + Reads the next record. + + + Indicates if the reader will proceed to the next record after having read headers. + if it stops after having read headers; otherwise, . + + + Indicates if the reader will skip directly to the next line without parsing the current one. + To be used when an error occurs. + + if a record has been successfully reads; otherwise, . + + The instance has been disposed of. + + + + + Moves before the first record. + + + + + Moves to the last record read so far. + + + + + Moves to the specified record index. + + The record index. + true if the operation was successful; otherwise, false. + + The instance has been disposed of. + + + + + Represents a binding list wrapper for a CSV reader. + + + + + Contains the linked CSV reader. + + + + + Contains the cached record count. + + + + + Contains the cached property descriptors. + + + + + Contains the current sort property. + + + + + Contains the current sort direction. + + + + + Initializes a new instance of the CsvBindingList class. + + + + + + Represents a CSV field property descriptor. + + + + + Contains the field index. + + + + + Initializes a new instance of the CsvPropertyDescriptor class. + + The field name. + The field index. + + + + Gets the field index. + + The field index. + + + + Represents a CSV record comparer. + + + + + Contains the field index of the values to compare. + + + + + Contains the sort direction. + + + + + Initializes a new instance of the CsvRecordComparer class. + + The field index of the values to compare. + The sort direction. + + + + Represents a reader that provides fast, non-cached, forward-only access to CSV data. + + + + + Defines the default buffer size. + + + + + Defines the default delimiter character separating each field. + + + + + Defines the default quote character wrapping every field. + + + + + Defines the default escape character letting insert quotation characters inside a quoted field. + + + + + Defines the default comment character indicating that a line is commented out. + + + + + Contains the field header comparer. + + + + + Contains the pointing to the CSV file. + + + + + Contains the buffer size. + + + + + Contains the comment character indicating that a line is commented out. + + + + + Contains the escape character letting insert quotation characters inside a quoted field. + + + + + Contains the delimiter character separating each field. + + + + + Contains the quotation character wrapping every field. + + + + + Determines which values should be trimmed. + + + + + Indicates if field names are located on the first non commented line. + + + + + Contains the default action to take when a parsing error has occured. + + + + + Contains the action to take when a field is missing. + + + + + Indicates if the reader supports multiline. + + + + + Indicates if the reader will skip empty lines. + + + + + Indicates if the class is initialized. + + + + + Contains the field headers. + + + + + Contains the dictionary of field indexes by header. The key is the field name and the value is its index. + + + + + Contains the current record index in the CSV file. + A value of means that the reader has not been initialized yet. + Otherwise, a negative value means that no record has been read yet. + + + + + Contains the starting position of the next unread field. + + + + + Contains the index of the next unread field. + + + + + Contains the array of the field values for the current record. + A null value indicates that the field have not been parsed. + + + + + Contains the maximum number of fields to retrieve for each record. + + + + + Contains the read buffer. + + + + + Contains the current read buffer length. + + + + + Indicates if the end of the reader has been reached. + + + + + Indicates if the last read operation reached an EOL character. + + + + + Indicates if the first record is in cache. + This can happen when initializing a reader with no headers + because one record must be read to get the field count automatically + + + + + Indicates if one or more field are missing for the current record. + Resets after each successful record read. + + + + + Indicates if a parse error occured for the current record. + Resets after each successful record read. + + + + + Initializes a new instance of the CsvReader class. + + A pointing to the CSV file. + if field names are located on the first non commented line, otherwise, . + + is a . + + + Cannot read from . + + + + + Initializes a new instance of the CsvReader class. + + A pointing to the CSV file. + if field names are located on the first non commented line, otherwise, . + The buffer size in bytes. + + is a . + + + Cannot read from . + + + + + Initializes a new instance of the CsvReader class. + + A pointing to the CSV file. + if field names are located on the first non commented line, otherwise, . + The delimiter character separating each field (default is ','). + + is a . + + + Cannot read from . + + + + + Initializes a new instance of the CsvReader class. + + A pointing to the CSV file. + if field names are located on the first non commented line, otherwise, . + The delimiter character separating each field (default is ','). + The buffer size in bytes. + + is a . + + + Cannot read from . + + + + + Initializes a new instance of the CsvReader class. + + A pointing to the CSV file. + if field names are located on the first non commented line, otherwise, . + The delimiter character separating each field (default is ','). + The quotation character wrapping every field (default is '''). + + The escape character letting insert quotation characters inside a quoted field (default is '\'). + If no escape character, set to '\0' to gain some performance. + + The comment character indicating that a line is commented out (default is '#'). + Determines which values should be trimmed. + + is a . + + + Cannot read from . + + + + + Initializes a new instance of the CsvReader class. + + A pointing to the CSV file. + if field names are located on the first non commented line, otherwise, . + The delimiter character separating each field (default is ','). + The quotation character wrapping every field (default is '''). + + The escape character letting insert quotation characters inside a quoted field (default is '\'). + If no escape character, set to '\0' to gain some performance. + + The comment character indicating that a line is commented out (default is '#'). + Determines which values should be trimmed. + The buffer size in bytes. + + is a . + + + must be 1 or more. + + + + + Occurs when there is an error while parsing the CSV stream. + + + + + Raises the event. + + The that contains the event data. + + + + Gets the comment character indicating that a line is commented out. + + The comment character indicating that a line is commented out. + + + + Gets the escape character letting insert quotation characters inside a quoted field. + + The escape character letting insert quotation characters inside a quoted field. + + + + Gets the delimiter character separating each field. + + The delimiter character separating each field. + + + + Gets the quotation character wrapping every field. + + The quotation character wrapping every field. + + + + Indicates if field names are located on the first non commented line. + + if field names are located on the first non commented line, otherwise, . + + + + Indicates if spaces at the start and end of a field are trimmed. + + if spaces at the start and end of a field are trimmed, otherwise, . + + + + Gets the buffer size. + + + + + Gets or sets the default action to take when a parsing error has occured. + + The default action to take when a parsing error has occured. + + + + Gets or sets the action to take when a field is missing. + + The action to take when a field is missing. + + + + Gets or sets a value indicating if the reader supports multiline fields. + + A value indicating if the reader supports multiline field. + + + + Gets or sets a value indicating if the reader will skip empty lines. + + A value indicating if the reader will skip empty lines. + + + + Gets or sets the default header name when it is an empty string or only whitespaces. + The header index will be appended to the specified name. + + The default header name when it is an empty string or only whitespaces. + + + + Gets the maximum number of fields to retrieve for each record. + + The maximum number of fields to retrieve for each record. + + The instance has been disposed of. + + + + + Gets a value that indicates whether the current stream position is at the end of the stream. + + if the current stream position is at the end of the stream; otherwise . + + + + Gets the field headers. + + The field headers or an empty array if headers are not supported. + + The instance has been disposed of. + + + + + Gets the current record index in the CSV file. + + The current record index in the CSV file. + + + + Indicates if one or more field are missing for the current record. + Resets after each successful record read. + + + + + Indicates if a parse error occured for the current record. + Resets after each successful record read. + + + + + Gets the field with the specified name and record position. must be . + + + The field with the specified name and record position. + + + is or an empty string. + + + The CSV does not have headers ( property is ). + + + not found. + + + Record index must be > 0. + + + Cannot move to a previous record in forward-only mode. + + + Cannot read record at . + + + The CSV appears to be corrupt at the current position. + + + The instance has been disposed of. + + + + + Gets the field at the specified index and record position. + + + The field at the specified index and record position. + A is returned if the field cannot be found for the record. + + + must be included in [0, [. + + + Record index must be > 0. + + + Cannot move to a previous record in forward-only mode. + + + Cannot read record at . + + + The CSV appears to be corrupt at the current position. + + + The instance has been disposed of. + + + + + Gets the field with the specified name. must be . + + + The field with the specified name. + + + is or an empty string. + + + The CSV does not have headers ( property is ). + + + not found. + + + The CSV appears to be corrupt at the current position. + + + The instance has been disposed of. + + + + + Gets the field at the specified index. + + The field at the specified index. + + must be included in [0, [. + + + No record read yet. Call ReadLine() first. + + + The CSV appears to be corrupt at the current position. + + + The instance has been disposed of. + + + + + Ensures that the reader is initialized. + + + + + Gets the field index for the provided header. + + The header to look for. + The field index for the provided header. -1 if not found. + + The instance has been disposed of. + + + + + Copies the field array of the current record to a one-dimensional array, starting at the beginning of the target array. + + The one-dimensional that is the destination of the fields of the current record. + + is . + + + The number of fields in the record is greater than the available space from to the end of . + + + + + Copies the field array of the current record to a one-dimensional array, starting at the beginning of the target array. + + The one-dimensional that is the destination of the fields of the current record. + The zero-based index in at which copying begins. + + is . + + + is les than zero or is equal to or greater than the length . + + + No current record. + + + The number of fields in the record is greater than the available space from to the end of . + + + + + Gets the current raw CSV data. + + Used for exception handling purpose. + The current raw CSV data. + + + + Indicates whether the specified Unicode character is categorized as white space. + + A Unicode character. + if is white space; otherwise, . + + + + Moves to the specified record index. + + The record index. + true if the operation was successful; otherwise, false. + + The instance has been disposed of. + + + + + Parses a new line delimiter. + + The starting position of the parsing. Will contain the resulting end position. + if a new line delimiter was found; otherwise, . + + The instance has been disposed of. + + + + + Determines whether the character at the specified position is a new line delimiter. + + The position of the character to verify. + + if the character at the specified position is a new line delimiter; otherwise, . + + + + + Fills the buffer with data from the reader. + + if data was successfully read; otherwise, . + + The instance has been disposed of. + + + + + Reads the field at the specified index. + Any unread fields with an inferior index will also be read as part of the required parsing. + + The field index. + Indicates if the reader is currently initializing. + Indicates if the value(s) are discarded. + + The field at the specified index. + A indicates that an error occured or that the last field has been reached during initialization. + + + is out of range. + + + There is no current record. + + + The CSV data appears to be missing a field. + + + The CSV data appears to be malformed. + + + The instance has been disposed of. + + + + + Reads the next record. + + if a record has been successfully reads; otherwise, . + + The instance has been disposed of. + + + + + Reads the next record. + + + Indicates if the reader will proceed to the next record after having read headers. + if it stops after having read headers; otherwise, . + + + Indicates if the reader will skip directly to the next line without parsing the current one. + To be used when an error occurs. + + if a record has been successfully reads; otherwise, . + + The instance has been disposed of. + + + + + Skips empty and commented lines. + If the end of the buffer is reached, its content be discarded and filled again from the reader. + + + The position in the buffer where to start parsing. + Will contains the resulting position after the operation. + + if the end of the reader has not been reached; otherwise, . + + The instance has been disposed of. + + + + + Worker method. + Skips empty and commented lines. + + + The position in the buffer where to start parsing. + Will contains the resulting position after the operation. + + + The instance has been disposed of. + + + + + Skips whitespace characters. + + The starting position of the parsing. Will contain the resulting end position. + if the end of the reader has not been reached; otherwise, . + + The instance has been disposed of. + + + + + Skips ahead to the next NewLine character. + If the end of the buffer is reached, its content be discarded and filled again from the reader. + + + The position in the buffer where to start parsing. + Will contains the resulting position after the operation. + + if the end of the reader has not been reached; otherwise, . + + The instance has been disposed of. + + + + + Handles a parsing error. + + The parsing error that occured. + The current position in the buffer. + + is . + + + + + Handles a missing field error. + + The partially parsed value, if available. + The missing field index. + The current position in the raw data. + + The resulting value according to . + If the action is set to , + then the parse error will be handled according to . + + + + + Validates the state of the data reader. + + The validations to accomplish. + + No current record. + + + This operation is invalid when the reader is closed. + + + + + Copy the value of the specified field to an array. + + The index of the field. + The offset in the field value. + The destination array where the field value will be copied. + The destination array offset. + The number of characters to copy from the field value. + + + + + Returns an that can iterate through CSV records. + + An that can iterate through CSV records. + + The instance has been disposed of. + + + + + Returns an that can iterate through CSV records. + + An that can iterate through CSV records. + + The instance has been disposed of. + + + + + Returns an that can iterate through CSV records. + + An that can iterate through CSV records. + + The instance has been disposed of. + + + + + Contains the disposed status flag. + + + + + Contains the locking object for multi-threading purpose. + + + + + Occurs when the instance is disposed of. + + + + + Gets a value indicating whether the instance has been disposed of. + + + if the instance has been disposed of; otherwise, . + + + + + Raises the event. + + A that contains the event data. + + + + Checks if the instance has been disposed of, and if it has, throws an ; otherwise, does nothing. + + + The instance has been disposed of. + + + Derived classes should call this method at the start of all methods and properties that should not be accessed after a call to . + + + + + Releases all resources used by the instance. + + + Calls with the disposing parameter set to to free unmanaged and managed resources. + + + + + Releases the unmanaged resources used by this instance and optionally releases the managed resources. + + + to release both managed and unmanaged resources; to release only unmanaged resources. + + + + + Releases unmanaged resources and performs other cleanup operations before the instance is reclaimed by garbage collection. + + + + + Defines the data reader validations. + + + + + No validation. + + + + + Validate that the data reader is initialized. + + + + + Validate that the data reader is not closed. + + + + + Supports a simple iteration over the records of a . + + + + + Contains the enumerated . + + + + + Contains the current record. + + + + + Contains the current record index. + + + + + Initializes a new instance of the class. + + The to iterate over. + + is a . + + + + + Gets the current record. + + + + + Advances the enumerator to the next record of the CSV. + + if the enumerator was successfully advanced to the next record, if the enumerator has passed the end of the CSV. + + + + Sets the enumerator to its initial position, which is before the first record in the CSV. + + + + + Gets the current record. + + + + + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + + + + + Provides data for the event. + + + + + Contains the error that occured. + + + + + Contains the action to take. + + + + + Initializes a new instance of the ParseErrorEventArgs class. + + The error that occured. + The default action to take. + + + + Gets the error that occured. + + The error that occured. + + + + Gets or sets the action to take. + + The action to take. + + + + Represents the exception that is thrown when a CSV file is malformed. + + + + + Contains the message that describes the error. + + + + + Contains the raw data when the error occured. + + + + + Contains the current field index. + + + + + Contains the current record index. + + + + + Contains the current position in the raw data. + + + + + Initializes a new instance of the MalformedCsvException class. + + + + + Initializes a new instance of the MalformedCsvException class. + + The message that describes the error. + + + + Initializes a new instance of the MalformedCsvException class. + + The message that describes the error. + The exception that is the cause of the current exception. + + + + Initializes a new instance of the MalformedCsvException class. + + The raw data when the error occured. + The current position in the raw data. + The current record index. + The current field index. + + + + Initializes a new instance of the MalformedCsvException class. + + The raw data when the error occured. + The current position in the raw data. + The current record index. + The current field index. + The exception that is the cause of the current exception. + + + + Initializes a new instance of the MalformedCsvException class with serialized data. + + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + + + + Gets the raw data when the error occured. + + The raw data when the error occured. + + + + Gets the current position in the raw data. + + The current position in the raw data. + + + + Gets the current record index. + + The current record index. + + + + Gets the current field index. + + The current record index. + + + + Gets a message that describes the current exception. + + A message that describes the current exception. + + + + When overridden in a derived class, sets the with information about the exception. + + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + + + + Represents the exception that is thrown when a there is a missing field in a record of the CSV file. + + + MissingFieldException would have been a better name, but there is already a . + + + + + Initializes a new instance of the MissingFieldCsvException class. + + + + + Initializes a new instance of the MissingFieldCsvException class. + + The message that describes the error. + + + + Initializes a new instance of the MissingFieldCsvException class. + + The message that describes the error. + The exception that is the cause of the current exception. + + + + Initializes a new instance of the MissingFieldCsvException class. + + The raw data when the error occured. + The current position in the raw data. + The current record index. + The current field index. + + + + Initializes a new instance of the MissingFieldCsvException class. + + The raw data when the error occured. + The current position in the raw data. + The current record index. + The current field index. + The exception that is the cause of the current exception. + + + + Initializes a new instance of the MissingFieldCsvException class with serialized data. + + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + + + + Specifies the action to take when a field is missing. + + + + + Treat as a parsing error. + + + + + Replaces by an empty value. + + + + + Replaces by a null value (). + + + + + Specifies the action to take when a parsing error has occured. + + + + + Raises the event. + + + + + Tries to advance to next line. + + + + + Throws an exception. + + + + + 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 Buffer size must be 1 or more.. + + + + + Looks up a localized string similar to Cannot move to a previous record in forward-only mode.. + + + + + Looks up a localized string similar to Cannot read record at index '{0}'.. + + + + + Looks up a localized string similar to Enumeration has either not started or has already finished.. + + + + + Looks up a localized string similar to Collection was modified; enumeration operation may not execute.. + + + + + Looks up a localized string similar to '{0}' field header not found.. + + + + + Looks up a localized string similar to Field index must be included in [0, FieldCount[. Specified field index was : '{0}'.. + + + + + Looks up a localized string similar to The CSV appears to be corrupt near record '{0}' field '{1} at position '{2}'. Current raw data : '{3}'.. + + + + + Looks up a localized string similar to '{0}' is not a supported missing field action.. + + + + + Looks up a localized string similar to No current record.. + + + + + Looks up a localized string similar to The CSV does not have headers (CsvReader.HasHeaders property is false).. + + + + + Looks up a localized string similar to The number of fields in the record is greater than the available space from index to the end of the destination array.. + + + + + Looks up a localized string similar to '{0}' is not a valid ParseErrorAction while inside a ParseError event.. + + + + + Looks up a localized string similar to '{0}' is not a supported ParseErrorAction.. + + + + + Looks up a localized string similar to This operation is invalid when the reader is closed.. + + + + + Looks up a localized string similar to Record index must be 0 or more.. + + + + Index: DamClients/DamUI/trunk/release/Install_Version/nunit.framework.xml =================================================================== diff -u --- DamClients/DamUI/trunk/release/Install_Version/nunit.framework.xml (revision 0) +++ DamClients/DamUI/trunk/release/Install_Version/nunit.framework.xml (revision 2315) @@ -0,0 +1,10899 @@ + + + + nunit.framework + + + + + Attribute used to apply a category to a test + + + + + The name of the category + + + + + Construct attribute for a given category based on + a name. The name may not contain the characters ',', + '+', '-' or '!'. However, this is not checked in the + constructor since it would cause an error to arise at + as the test was loaded without giving a clear indication + of where the problem is located. The error is handled + in NUnitFramework.cs by marking the test as not + runnable. + + The name of the category + + + + Protected constructor uses the Type name as the name + of the category. + + + + + The name of the category + + + + + Used to mark a field for use as a datapoint when executing a theory + within the same fixture that requires an argument of the field's Type. + + + + + Used to mark an array as containing a set of datapoints to be used + executing a theory within the same fixture that requires an argument + of the Type of the array elements. + + + + + Attribute used to provide descriptive text about a + test case or fixture. + + + + + Construct the attribute + + Text describing the test + + + + Gets the test description + + + + + Enumeration indicating how the expected message parameter is to be used + + + + Expect an exact match + + + Expect a message containing the parameter string + + + Match the regular expression provided as a parameter + + + Expect a message that starts with the parameter string + + + + ExpectedExceptionAttribute + + + + + + Constructor for a non-specific exception + + + + + Constructor for a given type of exception + + The type of the expected exception + + + + Constructor for a given exception name + + The full name of the expected exception + + + + Gets or sets the expected exception type + + + + + Gets or sets the full Type name of the expected exception + + + + + Gets or sets the expected message text + + + + + Gets or sets the user message displayed in case of failure + + + + + Gets or sets the type of match to be performed on the expected message + + + + + Gets the name of a method to be used as an exception handler + + + + + ExplicitAttribute marks a test or test fixture so that it will + only be run if explicitly executed from the gui or command line + or if it is included by use of a filter. The test will not be + run simply because an enclosing suite is run. + + + + + Default constructor + + + + + Constructor with a reason + + The reason test is marked explicit + + + + The reason test is marked explicit + + + + + Attribute used to mark a test that is to be ignored. + Ignored tests result in a warning message when the + tests are run. + + + + + Constructs the attribute without giving a reason + for ignoring the test. + + + + + Constructs the attribute giving a reason for ignoring the test + + The reason for ignoring the test + + + + The reason for ignoring a test + + + + + Abstract base for Attributes that are used to include tests + in the test run based on environmental settings. + + + + + Constructor with no included items specified, for use + with named property syntax. + + + + + Constructor taking one or more included items + + Comma-delimited list of included items + + + + Name of the item that is needed in order for + a test to run. Multiple itemss may be given, + separated by a comma. + + + + + Name of the item to be excluded. Multiple items + may be given, separated by a comma. + + + + + The reason for including or excluding the test + + + + + PlatformAttribute is used to mark a test fixture or an + individual method as applying to a particular platform only. + + + + + Constructor with no platforms specified, for use + with named property syntax. + + + + + Constructor taking one or more platforms + + Comma-deliminted list of platforms + + + + CultureAttribute is used to mark a test fixture or an + individual method as applying to a particular Culture only. + + + + + Constructor with no cultures specified, for use + with named property syntax. + + + + + Constructor taking one or more cultures + + Comma-deliminted list of cultures + + + + Marks a test to use a combinatorial join of any argument data + provided. NUnit will create a test case for every combination of + the arguments provided. This can result in a large number of test + cases and so should be used judiciously. This is the default join + type, so the attribute need not be used except as documentation. + + + + + PropertyAttribute is used to attach information to a test as a name/value pair.. + + + + + Construct a PropertyAttribute with a name and string value + + The name of the property + The property value + + + + Construct a PropertyAttribute with a name and int value + + The name of the property + The property value + + + + Construct a PropertyAttribute with a name and double value + + The name of the property + The property value + + + + Constructor for derived classes that set the + property dictionary directly. + + + + + Constructor for use by derived classes that use the + name of the type as the property name. Derived classes + must ensure that the Type of the property value is + a standard type supported by the BCL. Any custom + types will cause a serialization Exception when + in the client. + + + + + Gets the property dictionary for this attribute + + + + + Default constructor + + + + + Marks a test to use pairwise join of any argument data provided. + NUnit will attempt too excercise every pair of argument values at + least once, using as small a number of test cases as it can. With + only two arguments, this is the same as a combinatorial join. + + + + + Default constructor + + + + + Marks a test to use a sequential join of any argument data + provided. NUnit will use arguements for each parameter in + sequence, generating test cases up to the largest number + of argument values provided and using null for any arguments + for which it runs out of values. Normally, this should be + used with the same number of arguments for each parameter. + + + + + Default constructor + + + + + Summary description for MaxTimeAttribute. + + + + + Construct a MaxTimeAttribute, given a time in milliseconds. + + The maximum elapsed time in milliseconds + + + + RandomAttribute is used to supply a set of random values + to a single parameter of a parameterized test. + + + + + ValuesAttribute is used to provide literal arguments for + an individual parameter of a test. + + + + + Abstract base class for attributes that apply to parameters + and supply data for the parameter. + + + + + Gets the data to be provided to the specified parameter + + + + + The collection of data to be returned. Must + be set by any derived attribute classes. + We use an object[] so that the individual + elements may have their type changed in GetData + if necessary. + + + + + Construct with one argument + + + + + + Construct with two arguments + + + + + + + Construct with three arguments + + + + + + + + Construct with an array of arguments + + + + + + Get the collection of values to be used as arguments + + + + + Construct a set of doubles from 0.0 to 1.0, + specifying only the count. + + + + + + Construct a set of doubles from min to max + + + + + + + + Construct a set of ints from min to max + + + + + + + + Get the collection of values to be used as arguments + + + + + RangeAttribute is used to supply a range of values to an + individual parameter of a parameterized test. + + + + + Construct a range of ints using default step of 1 + + + + + + + Construct a range of ints specifying the step size + + + + + + + + Construct a range of longs + + + + + + + + Construct a range of doubles + + + + + + + + Construct a range of floats + + + + + + + + RepeatAttribute may be applied to test case in order + to run it multiple times. + + + + + Construct a RepeatAttribute + + The number of times to run the test + + + + RequiredAddinAttribute may be used to indicate the names of any addins + that must be present in order to run some or all of the tests in an + assembly. If the addin is not loaded, the entire assembly is marked + as NotRunnable. + + + + + Initializes a new instance of the class. + + The required addin. + + + + Gets the name of required addin. + + The required addin name. + + + + Summary description for SetCultureAttribute. + + + + + Construct given the name of a culture + + + + + + Summary description for SetUICultureAttribute. + + + + + Construct given the name of a culture + + + + + + SetUpAttribute is used in a TestFixture to identify a method + that is called immediately before each test is run. It is + also used in a SetUpFixture to identify the method that is + called once, before any of the subordinate tests are run. + + + + + Attribute used to mark a class that contains one-time SetUp + and/or TearDown methods that apply to all the tests in a + namespace or an assembly. + + + + + Attribute used to mark a static (shared in VB) property + that returns a list of tests. + + + + + Attribute used in a TestFixture to identify a method that is + called immediately after each test is run. It is also used + in a SetUpFixture to identify the method that is called once, + after all subordinate tests have run. In either case, the method + is guaranteed to be called, even if an exception is thrown. + + + + + Provide actions to execute before and after tests. + + + + + When implemented by an attribute, this interface implemented to provide actions to execute before and after tests. + + + + + Executed before each test is run + + Provides details about the test that is going to be run. + + + + Executed after each test is run + + Provides details about the test that has just been run. + + + + Provides the target for the action attribute + + The target for the action attribute + + + + Adding this attribute to a method within a + class makes the method callable from the NUnit test runner. There is a property + called Description which is optional which you can provide a more detailed test + description. This class cannot be inherited. + + + + [TestFixture] + public class Fixture + { + [Test] + public void MethodToTest() + {} + + [Test(Description = "more detailed description")] + publc void TestDescriptionMethod() + {} + } + + + + + + Descriptive text for this test + + + + + TestCaseAttribute is used to mark parameterized test cases + and provide them with their arguments. + + + + + The ITestCaseData interface is implemented by a class + that is able to return complete testcases for use by + a parameterized test method. + + NOTE: This interface is used in both the framework + and the core, even though that results in two different + types. However, sharing the source code guarantees that + the various implementations will be compatible and that + the core is able to reflect successfully over the + framework implementations of ITestCaseData. + + + + + Gets the argument list to be provided to the test + + + + + Gets the expected result + + + + + Indicates whether a result has been specified. + This is necessary because the result may be + null, so it's value cannot be checked. + + + + + Gets the expected exception Type + + + + + Gets the FullName of the expected exception + + + + + Gets the name to be used for the test + + + + + Gets the description of the test + + + + + Gets a value indicating whether this is ignored. + + true if ignored; otherwise, false. + + + + Gets a value indicating whether this is explicit. + + true if explicit; otherwise, false. + + + + Gets the ignore reason. + + The ignore reason. + + + + Construct a TestCaseAttribute with a list of arguments. + This constructor is not CLS-Compliant + + + + + + Construct a TestCaseAttribute with a single argument + + + + + + Construct a TestCaseAttribute with a two arguments + + + + + + + Construct a TestCaseAttribute with a three arguments + + + + + + + + Gets the list of arguments to a test case + + + + + Gets or sets the expected result. Use + ExpectedResult by preference. + + The result. + + + + Gets or sets the expected result. + + The result. + + + + Gets a flag indicating whether an expected + result has been set. + + + + + Gets a list of categories associated with this test; + + + + + Gets or sets the category associated with this test. + May be a single category or a comma-separated list. + + + + + Gets or sets the expected exception. + + The expected exception. + + + + Gets or sets the name the expected exception. + + The expected name of the exception. + + + + Gets or sets the expected message of the expected exception + + The expected message of the exception. + + + + Gets or sets the type of match to be performed on the expected message + + + + + Gets or sets the description. + + The description. + + + + Gets or sets the name of the test. + + The name of the test. + + + + Gets or sets the ignored status of the test + + + + + Gets or sets the ignored status of the test + + + + + Gets or sets the explicit status of the test + + + + + Gets or sets the reason for not running the test + + + + + Gets or sets the reason for not running the test. + Set has the side effect of marking the test as ignored. + + The ignore reason. + + + + FactoryAttribute indicates the source to be used to + provide test cases for a test method. + + + + + Construct with the name of the data source, which must + be a property, field or method of the test class itself. + + An array of the names of the factories that will provide data + + + + Construct with a Type, which must implement IEnumerable + + The Type that will provide data + + + + Construct with a Type and name. + that don't support params arrays. + + The Type that will provide data + The name of the method, property or field that will provide data + + + + The name of a the method, property or fiend to be used as a source + + + + + A Type to be used as a source + + + + + Gets or sets the category associated with this test. + May be a single category or a comma-separated list. + + + + + [TestFixture] + public class ExampleClass + {} + + + + + Default constructor + + + + + Construct with a object[] representing a set of arguments. + In .NET 2.0, the arguments may later be separated into + type arguments and constructor arguments. + + + + + + Descriptive text for this fixture + + + + + Gets and sets the category for this fixture. + May be a comma-separated list of categories. + + + + + Gets a list of categories for this fixture + + + + + The arguments originally provided to the attribute + + + + + Gets or sets a value indicating whether this should be ignored. + + true if ignore; otherwise, false. + + + + Gets or sets the ignore reason. May set Ignored as a side effect. + + The ignore reason. + + + + Get or set the type arguments. If not set + explicitly, any leading arguments that are + Types are taken as type arguments. + + + + + Attribute used to identify a method that is + called before any tests in a fixture are run. + + + + + Attribute used to identify a method that is called after + all the tests in a fixture have run. The method is + guaranteed to be called, even if an exception is thrown. + + + + + Adding this attribute to a method within a + class makes the method callable from the NUnit test runner. There is a property + called Description which is optional which you can provide a more detailed test + description. This class cannot be inherited. + + + + [TestFixture] + public class Fixture + { + [Test] + public void MethodToTest() + {} + + [Test(Description = "more detailed description")] + publc void TestDescriptionMethod() + {} + } + + + + + + Used on a method, marks the test with a timeout value in milliseconds. + The test will be run in a separate thread and is cancelled if the timeout + is exceeded. Used on a method or assembly, sets the default timeout + for all contained test methods. + + + + + Construct a TimeoutAttribute given a time in milliseconds + + The timeout value in milliseconds + + + + Marks a test that must run in the STA, causing it + to run in a separate thread if necessary. + + On methods, you may also use STAThreadAttribute + to serve the same purpose. + + + + + Construct a RequiresSTAAttribute + + + + + Marks a test that must run in the MTA, causing it + to run in a separate thread if necessary. + + On methods, you may also use MTAThreadAttribute + to serve the same purpose. + + + + + Construct a RequiresMTAAttribute + + + + + Marks a test that must run on a separate thread. + + + + + Construct a RequiresThreadAttribute + + + + + Construct a RequiresThreadAttribute, specifying the apartment + + + + + ValueSourceAttribute indicates the source to be used to + provide data for one parameter of a test method. + + + + + Construct with the name of the factory - for use with languages + that don't support params arrays. + + The name of the data source to be used + + + + Construct with a Type and name - for use with languages + that don't support params arrays. + + The Type that will provide data + The name of the method, property or field that will provide data + + + + The name of a the method, property or fiend to be used as a source + + + + + A Type to be used as a source + + + + + AttributeExistsConstraint tests for the presence of a + specified attribute on a Type. + + + + + The Constraint class is the base of all built-in constraints + within NUnit. It provides the operator overloads used to combine + constraints. + + + + + The IConstraintExpression interface is implemented by all + complete and resolvable constraints and expressions. + + + + + Return the top-level constraint for this expression + + + + + + Static UnsetObject used to detect derived constraints + failing to set the actual value. + + + + + The actual value being tested against a constraint + + + + + The display name of this Constraint for use by ToString() + + + + + Argument fields used by ToString(); + + + + + The builder holding this constraint + + + + + Construct a constraint with no arguments + + + + + Construct a constraint with one argument + + + + + Construct a constraint with two arguments + + + + + Sets the ConstraintBuilder holding this constraint + + + + + Write the failure message to the MessageWriter provided + as an argument. The default implementation simply passes + the constraint and the actual value to the writer, which + then displays the constraint description and the value. + + Constraints that need to provide additional details, + such as where the error occured can override this. + + The MessageWriter on which to display the message + + + + Test whether the constraint is satisfied by a given value + + The value to be tested + True for success, false for failure + + + + Test whether the constraint is satisfied by an + ActualValueDelegate that returns the value to be tested. + The default implementation simply evaluates the delegate + but derived classes may override it to provide for delayed + processing. + + An ActualValueDelegate + True for success, false for failure + + + + Test whether the constraint is satisfied by a given reference. + The default implementation simply dereferences the value but + derived classes may override it to provide for delayed processing. + + A reference to the value to be tested + True for success, false for failure + + + + Write the constraint description to a MessageWriter + + The writer on which the description is displayed + + + + Write the actual value for a failing constraint test to a + MessageWriter. The default implementation simply writes + the raw value of actual, leaving it to the writer to + perform any formatting. + + The writer on which the actual value is displayed + + + + Default override of ToString returns the constraint DisplayName + followed by any arguments within angle brackets. + + + + + + Returns the string representation of this constraint + + + + + This operator creates a constraint that is satisfied only if both + argument constraints are satisfied. + + + + + This operator creates a constraint that is satisfied if either + of the argument constraints is satisfied. + + + + + This operator creates a constraint that is satisfied if the + argument constraint is not satisfied. + + + + + Returns a DelayedConstraint with the specified delay time. + + The delay in milliseconds. + + + + + Returns a DelayedConstraint with the specified delay time + and polling interval. + + The delay in milliseconds. + The interval at which to test the constraint. + + + + + The display name of this Constraint for use by ToString(). + The default value is the name of the constraint with + trailing "Constraint" removed. Derived classes may set + this to another name in their constructors. + + + + + Returns a ConstraintExpression by appending And + to the current constraint. + + + + + Returns a ConstraintExpression by appending And + to the current constraint. + + + + + Returns a ConstraintExpression by appending Or + to the current constraint. + + + + + Class used to detect any derived constraints + that fail to set the actual value in their + Matches override. + + + + + Constructs an AttributeExistsConstraint for a specific attribute Type + + + + + + Tests whether the object provides the expected attribute. + + A Type, MethodInfo, or other ICustomAttributeProvider + True if the expected attribute is present, otherwise false + + + + Writes the description of the constraint to the specified writer + + + + + AttributeConstraint tests that a specified attribute is present + on a Type or other provider and that the value of the attribute + satisfies some other constraint. + + + + + Abstract base class used for prefixes + + + + + The base constraint + + + + + Construct given a base constraint + + + + + + Constructs an AttributeConstraint for a specified attriute + Type and base constraint. + + + + + + + Determines whether the Type or other provider has the + expected attribute and if its value matches the + additional constraint specified. + + + + + Writes a description of the attribute to the specified writer. + + + + + Writes the actual value supplied to the specified writer. + + + + + Returns a string representation of the constraint. + + + + + BasicConstraint is the abstract base for constraints that + perform a simple comparison to a constant value. + + + + + Initializes a new instance of the class. + + The expected. + The description. + + + + Test whether the constraint is satisfied by a given value + + The value to be tested + True for success, false for failure + + + + Write the constraint description to a MessageWriter + + The writer on which the description is displayed + + + + NullConstraint tests that the actual value is null + + + + + Initializes a new instance of the class. + + + + + TrueConstraint tests that the actual value is true + + + + + Initializes a new instance of the class. + + + + + FalseConstraint tests that the actual value is false + + + + + Initializes a new instance of the class. + + + + + NaNConstraint tests that the actual value is a double or float NaN + + + + + Test that the actual value is an NaN + + + + + + + Write the constraint description to a specified writer + + + + + + BinaryConstraint is the abstract base of all constraints + that combine two other constraints in some fashion. + + + + + The first constraint being combined + + + + + The second constraint being combined + + + + + Construct a BinaryConstraint from two other constraints + + The first constraint + The second constraint + + + + AndConstraint succeeds only if both members succeed. + + + + + Create an AndConstraint from two other constraints + + The first constraint + The second constraint + + + + Apply both member constraints to an actual value, succeeding + succeeding only if both of them succeed. + + The actual value + True if the constraints both succeeded + + + + Write a description for this contraint to a MessageWriter + + The MessageWriter to receive the description + + + + Write the actual value for a failing constraint test to a + MessageWriter. The default implementation simply writes + the raw value of actual, leaving it to the writer to + perform any formatting. + + The writer on which the actual value is displayed + + + + OrConstraint succeeds if either member succeeds + + + + + Create an OrConstraint from two other constraints + + The first constraint + The second constraint + + + + Apply the member constraints to an actual value, succeeding + succeeding as soon as one of them succeeds. + + The actual value + True if either constraint succeeded + + + + Write a description for this contraint to a MessageWriter + + The MessageWriter to receive the description + + + + CollectionConstraint is the abstract base class for + constraints that operate on collections. + + + + + Construct an empty CollectionConstraint + + + + + Construct a CollectionConstraint + + + + + + Determines whether the specified enumerable is empty. + + The enumerable. + + true if the specified enumerable is empty; otherwise, false. + + + + + Test whether the constraint is satisfied by a given value + + The value to be tested + True for success, false for failure + + + + Protected method to be implemented by derived classes + + + + + + + CollectionItemsEqualConstraint is the abstract base class for all + collection constraints that apply some notion of item equality + as a part of their operation. + + + + + Construct an empty CollectionConstraint + + + + + Construct a CollectionConstraint + + + + + + Flag the constraint to use the supplied IComparer object. + + The IComparer object to use. + Self. + + + + Flag the constraint to use the supplied IComparer object. + + The IComparer object to use. + Self. + + + + Flag the constraint to use the supplied Comparison object. + + The IComparer object to use. + Self. + + + + Flag the constraint to use the supplied IEqualityComparer object. + + The IComparer object to use. + Self. + + + + Flag the constraint to use the supplied IEqualityComparer object. + + The IComparer object to use. + Self. + + + + Compares two collection members for equality + + + + + Return a new CollectionTally for use in making tests + + The collection to be included in the tally + + + + Flag the constraint to ignore case and return self. + + + + + EmptyCollectionConstraint tests whether a collection is empty. + + + + + Check that the collection is empty + + + + + + + Write the constraint description to a MessageWriter + + + + + + UniqueItemsConstraint tests whether all the items in a + collection are unique. + + + + + Check that all items are unique. + + + + + + + Write a description of this constraint to a MessageWriter + + + + + + CollectionContainsConstraint is used to test whether a collection + contains an expected object as a member. + + + + + Construct a CollectionContainsConstraint + + + + + + Test whether the expected item is contained in the collection + + + + + + + Write a descripton of the constraint to a MessageWriter + + + + + + CollectionEquivalentCOnstraint is used to determine whether two + collections are equivalent. + + + + + Construct a CollectionEquivalentConstraint + + + + + + Test whether two collections are equivalent + + + + + + + Write a description of this constraint to a MessageWriter + + + + + + CollectionSubsetConstraint is used to determine whether + one collection is a subset of another + + + + + Construct a CollectionSubsetConstraint + + The collection that the actual value is expected to be a subset of + + + + Test whether the actual collection is a subset of + the expected collection provided. + + + + + + + Write a description of this constraint to a MessageWriter + + + + + + CollectionOrderedConstraint is used to test whether a collection is ordered. + + + + + Construct a CollectionOrderedConstraint + + + + + Modifies the constraint to use an IComparer and returns self. + + + + + Modifies the constraint to use an IComparer<T> and returns self. + + + + + Modifies the constraint to use a Comparison<T> and returns self. + + + + + Modifies the constraint to test ordering by the value of + a specified property and returns self. + + + + + Test whether the collection is ordered + + + + + + + Write a description of the constraint to a MessageWriter + + + + + + Returns the string representation of the constraint. + + + + + + If used performs a reverse comparison + + + + + CollectionTally counts (tallies) the number of + occurences of each object in one or more enumerations. + + + + + Construct a CollectionTally object from a comparer and a collection + + + + + Try to remove an object from the tally + + The object to remove + True if successful, false if the object was not found + + + + Try to remove a set of objects from the tally + + The objects to remove + True if successful, false if any object was not found + + + + The number of objects remaining in the tally + + + + + ComparisonAdapter class centralizes all comparisons of + values in NUnit, adapting to the use of any provided + IComparer, IComparer<T> or Comparison<T> + + + + + Returns a ComparisonAdapter that wraps an IComparer + + + + + Returns a ComparisonAdapter that wraps an IComparer<T> + + + + + Returns a ComparisonAdapter that wraps a Comparison<T> + + + + + Compares two objects + + + + + Gets the default ComparisonAdapter, which wraps an + NUnitComparer object. + + + + + Construct a ComparisonAdapter for an IComparer + + + + + Compares two objects + + + + + + + + Construct a default ComparisonAdapter + + + + + ComparisonAdapter<T> extends ComparisonAdapter and + allows use of an IComparer<T> or Comparison<T> + to actually perform the comparison. + + + + + Construct a ComparisonAdapter for an IComparer<T> + + + + + Compare a Type T to an object + + + + + Construct a ComparisonAdapter for a Comparison<T> + + + + + Compare a Type T to an object + + + + + Abstract base class for constraints that compare values to + determine if one is greater than, equal to or less than + the other. This class supplies the Using modifiers. + + + + + ComparisonAdapter to be used in making the comparison + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + + + + Modifies the constraint to use an IComparer and returns self + + + + + Modifies the constraint to use an IComparer<T> and returns self + + + + + Modifies the constraint to use a Comparison<T> and returns self + + + + + Delegate used to delay evaluation of the actual value + to be used in evaluating a constraint + + + + + ConstraintBuilder maintains the stacks that are used in + processing a ConstraintExpression. An OperatorStack + is used to hold operators that are waiting for their + operands to be reognized. a ConstraintStack holds + input constraints as well as the results of each + operator applied. + + + + + Initializes a new instance of the class. + + + + + Appends the specified operator to the expression by first + reducing the operator stack and then pushing the new + operator on the stack. + + The operator to push. + + + + Appends the specified constraint to the expresson by pushing + it on the constraint stack. + + The constraint to push. + + + + Sets the top operator right context. + + The right context. + + + + Reduces the operator stack until the topmost item + precedence is greater than or equal to the target precedence. + + The target precedence. + + + + Resolves this instance, returning a Constraint. If the builder + is not currently in a resolvable state, an exception is thrown. + + The resolved constraint + + + + Gets a value indicating whether this instance is resolvable. + + + true if this instance is resolvable; otherwise, false. + + + + + OperatorStack is a type-safe stack for holding ConstraintOperators + + + + + Initializes a new instance of the class. + + The builder. + + + + Pushes the specified operator onto the stack. + + The op. + + + + Pops the topmost operator from the stack. + + + + + + Gets a value indicating whether this is empty. + + true if empty; otherwise, false. + + + + Gets the topmost operator without modifying the stack. + + The top. + + + + ConstraintStack is a type-safe stack for holding Constraints + + + + + Initializes a new instance of the class. + + The builder. + + + + Pushes the specified constraint. As a side effect, + the constraint's builder field is set to the + ConstraintBuilder owning this stack. + + The constraint. + + + + Pops this topmost constrait from the stack. + As a side effect, the constraint's builder + field is set to null. + + + + + + Gets a value indicating whether this is empty. + + true if empty; otherwise, false. + + + + Gets the topmost constraint without modifying the stack. + + The topmost constraint + + + + ConstraintExpression represents a compound constraint in the + process of being constructed from a series of syntactic elements. + + Individual elements are appended to the expression as they are + reognized. Once an actual Constraint is appended, the expression + returns a resolvable Constraint. + + + + + ConstraintExpressionBase is the abstract base class for the + ConstraintExpression class, which represents a + compound constraint in the process of being constructed + from a series of syntactic elements. + + NOTE: ConstraintExpressionBase is separate because the + ConstraintExpression class was generated in earlier + versions of NUnit. The two classes may be combined + in a future version. + + + + + The ConstraintBuilder holding the elements recognized so far + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the + class passing in a ConstraintBuilder, which may be pre-populated. + + The builder. + + + + Returns a string representation of the expression as it + currently stands. This should only be used for testing, + since it has the side-effect of resolving the expression. + + + + + + Appends an operator to the expression and returns the + resulting expression itself. + + + + + Appends a self-resolving operator to the expression and + returns a new ResolvableConstraintExpression. + + + + + Appends a constraint to the expression and returns that + constraint, which is associated with the current state + of the expression being built. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the + class passing in a ConstraintBuilder, which may be pre-populated. + + The builder. + + + + Returns a ConstraintExpression, which will apply + the following constraint to all members of a collection, + succeeding only if a specified number of them succeed. + + + + + Returns a new PropertyConstraintExpression, which will either + test for the existence of the named property on the object + being tested or apply any following constraint to that property. + + + + + Returns a new AttributeConstraint checking for the + presence of a particular attribute on an object. + + + + + Returns a new AttributeConstraint checking for the + presence of a particular attribute on an object. + + + + + Returns the constraint provided as an argument - used to allow custom + custom constraints to easily participate in the syntax. + + + + + Returns the constraint provided as an argument - used to allow custom + custom constraints to easily participate in the syntax. + + + + + Returns a constraint that tests two items for equality + + + + + Returns a constraint that tests that two references are the same object + + + + + Returns a constraint that tests whether the + actual value is greater than the suppled argument + + + + + Returns a constraint that tests whether the + actual value is greater than or equal to the suppled argument + + + + + Returns a constraint that tests whether the + actual value is greater than or equal to the suppled argument + + + + + Returns a constraint that tests whether the + actual value is less than the suppled argument + + + + + Returns a constraint that tests whether the + actual value is less than or equal to the suppled argument + + + + + Returns a constraint that tests whether the + actual value is less than or equal to the suppled argument + + + + + Returns a constraint that tests whether the actual + value is of the exact type supplied as an argument. + + + + + Returns a constraint that tests whether the actual + value is of the exact type supplied as an argument. + + + + + Returns a constraint that tests whether the actual value + is of the type supplied as an argument or a derived type. + + + + + Returns a constraint that tests whether the actual value + is of the type supplied as an argument or a derived type. + + + + + Returns a constraint that tests whether the actual value + is of the type supplied as an argument or a derived type. + + + + + Returns a constraint that tests whether the actual value + is of the type supplied as an argument or a derived type. + + + + + Returns a constraint that tests whether the actual value + is assignable from the type supplied as an argument. + + + + + Returns a constraint that tests whether the actual value + is assignable from the type supplied as an argument. + + + + + Returns a constraint that tests whether the actual value + is assignable from the type supplied as an argument. + + + + + Returns a constraint that tests whether the actual value + is assignable from the type supplied as an argument. + + + + + Returns a constraint that tests whether the actual value + is a collection containing the same elements as the + collection supplied as an argument. + + + + + Returns a constraint that tests whether the actual value + is a subset of the collection supplied as an argument. + + + + + Returns a new CollectionContainsConstraint checking for the + presence of a particular object in the collection. + + + + + Returns a new CollectionContainsConstraint checking for the + presence of a particular object in the collection. + + + + + Returns a new ContainsConstraint. This constraint + will, in turn, make use of the appropriate second-level + constraint, depending on the type of the actual argument. + This overload is only used if the item sought is a string, + since any other type implies that we are looking for a + collection member. + + + + + Returns a constraint that succeeds if the actual + value contains the substring supplied as an argument. + + + + + Returns a constraint that succeeds if the actual + value contains the substring supplied as an argument. + + + + + Returns a constraint that succeeds if the actual + value starts with the substring supplied as an argument. + + + + + Returns a constraint that succeeds if the actual + value starts with the substring supplied as an argument. + + + + + Returns a constraint that succeeds if the actual + value ends with the substring supplied as an argument. + + + + + Returns a constraint that succeeds if the actual + value ends with the substring supplied as an argument. + + + + + Returns a constraint that succeeds if the actual + value matches the Regex pattern supplied as an argument. + + + + + Returns a constraint that succeeds if the actual + value matches the Regex pattern supplied as an argument. + + + + + Returns a constraint that tests whether the path provided + is the same as an expected path after canonicalization. + + + + + Returns a constraint that tests whether the path provided + is the same path or under an expected path after canonicalization. + + + + + Returns a constraint that tests whether the path provided + is the same path or under an expected path after canonicalization. + + + + + Returns a constraint that tests whether the actual value falls + within a specified range. + + + + + Returns a ConstraintExpression that negates any + following constraint. + + + + + Returns a ConstraintExpression that negates any + following constraint. + + + + + Returns a ConstraintExpression, which will apply + the following constraint to all members of a collection, + succeeding if all of them succeed. + + + + + Returns a ConstraintExpression, which will apply + the following constraint to all members of a collection, + succeeding if at least one of them succeeds. + + + + + Returns a ConstraintExpression, which will apply + the following constraint to all members of a collection, + succeeding if all of them fail. + + + + + Returns a new ConstraintExpression, which will apply the following + constraint to the Length property of the object being tested. + + + + + Returns a new ConstraintExpression, which will apply the following + constraint to the Count property of the object being tested. + + + + + Returns a new ConstraintExpression, which will apply the following + constraint to the Message property of the object being tested. + + + + + Returns a new ConstraintExpression, which will apply the following + constraint to the InnerException property of the object being tested. + + + + + With is currently a NOP - reserved for future use. + + + + + Returns a constraint that tests for null + + + + + Returns a constraint that tests for True + + + + + Returns a constraint that tests for False + + + + + Returns a constraint that tests for a positive value + + + + + Returns a constraint that tests for a negative value + + + + + Returns a constraint that tests for NaN + + + + + Returns a constraint that tests for empty + + + + + Returns a constraint that tests whether a collection + contains all unique items. + + + + + Returns a constraint that tests whether an object graph is serializable in binary format. + + + + + Returns a constraint that tests whether an object graph is serializable in xml format. + + + + + Returns a constraint that tests whether a collection is ordered + + + + + Helper class with properties and methods that supply + a number of constraints used in Asserts. + + + + + Returns a ConstraintExpression, which will apply + the following constraint to all members of a collection, + succeeding only if a specified number of them succeed. + + + + + Returns a new PropertyConstraintExpression, which will either + test for the existence of the named property on the object + being tested or apply any following constraint to that property. + + + + + Returns a new AttributeConstraint checking for the + presence of a particular attribute on an object. + + + + + Returns a new AttributeConstraint checking for the + presence of a particular attribute on an object. + + + + + Returns a constraint that tests two items for equality + + + + + Returns a constraint that tests that two references are the same object + + + + + Returns a constraint that tests whether the + actual value is greater than the suppled argument + + + + + Returns a constraint that tests whether the + actual value is greater than or equal to the suppled argument + + + + + Returns a constraint that tests whether the + actual value is greater than or equal to the suppled argument + + + + + Returns a constraint that tests whether the + actual value is less than the suppled argument + + + + + Returns a constraint that tests whether the + actual value is less than or equal to the suppled argument + + + + + Returns a constraint that tests whether the + actual value is less than or equal to the suppled argument + + + + + Returns a constraint that tests whether the actual + value is of the exact type supplied as an argument. + + + + + Returns a constraint that tests whether the actual + value is of the exact type supplied as an argument. + + + + + Returns a constraint that tests whether the actual value + is of the type supplied as an argument or a derived type. + + + + + Returns a constraint that tests whether the actual value + is of the type supplied as an argument or a derived type. + + + + + Returns a constraint that tests whether the actual value + is of the type supplied as an argument or a derived type. + + + + + Returns a constraint that tests whether the actual value + is of the type supplied as an argument or a derived type. + + + + + Returns a constraint that tests whether the actual value + is assignable from the type supplied as an argument. + + + + + Returns a constraint that tests whether the actual value + is assignable from the type supplied as an argument. + + + + + Returns a constraint that tests whether the actual value + is assignable from the type supplied as an argument. + + + + + Returns a constraint that tests whether the actual value + is assignable from the type supplied as an argument. + + + + + Returns a constraint that tests whether the actual value + is a collection containing the same elements as the + collection supplied as an argument. + + + + + Returns a constraint that tests whether the actual value + is a subset of the collection supplied as an argument. + + + + + Returns a new CollectionContainsConstraint checking for the + presence of a particular object in the collection. + + + + + Returns a new CollectionContainsConstraint checking for the + presence of a particular object in the collection. + + + + + Returns a new ContainsConstraint. This constraint + will, in turn, make use of the appropriate second-level + constraint, depending on the type of the actual argument. + This overload is only used if the item sought is a string, + since any other type implies that we are looking for a + collection member. + + + + + Returns a constraint that succeeds if the actual + value contains the substring supplied as an argument. + + + + + Returns a constraint that succeeds if the actual + value contains the substring supplied as an argument. + + + + + Returns a constraint that fails if the actual + value contains the substring supplied as an argument. + + + + + Returns a constraint that succeeds if the actual + value starts with the substring supplied as an argument. + + + + + Returns a constraint that succeeds if the actual + value starts with the substring supplied as an argument. + + + + + Returns a constraint that fails if the actual + value starts with the substring supplied as an argument. + + + + + Returns a constraint that succeeds if the actual + value ends with the substring supplied as an argument. + + + + + Returns a constraint that succeeds if the actual + value ends with the substring supplied as an argument. + + + + + Returns a constraint that fails if the actual + value ends with the substring supplied as an argument. + + + + + Returns a constraint that succeeds if the actual + value matches the Regex pattern supplied as an argument. + + + + + Returns a constraint that succeeds if the actual + value matches the Regex pattern supplied as an argument. + + + + + Returns a constraint that fails if the actual + value matches the pattern supplied as an argument. + + + + + Returns a constraint that tests whether the path provided + is the same as an expected path after canonicalization. + + + + + Returns a constraint that tests whether the path provided + is the same path or under an expected path after canonicalization. + + + + + Returns a constraint that tests whether the path provided + is the same path or under an expected path after canonicalization. + + + + + Returns a constraint that tests whether the actual value falls + within a specified range. + + + + + Returns a ConstraintExpression that negates any + following constraint. + + + + + Returns a ConstraintExpression that negates any + following constraint. + + + + + Returns a ConstraintExpression, which will apply + the following constraint to all members of a collection, + succeeding if all of them succeed. + + + + + Returns a ConstraintExpression, which will apply + the following constraint to all members of a collection, + succeeding if at least one of them succeeds. + + + + + Returns a ConstraintExpression, which will apply + the following constraint to all members of a collection, + succeeding if all of them fail. + + + + + Returns a new ConstraintExpression, which will apply the following + constraint to the Length property of the object being tested. + + + + + Returns a new ConstraintExpression, which will apply the following + constraint to the Count property of the object being tested. + + + + + Returns a new ConstraintExpression, which will apply the following + constraint to the Message property of the object being tested. + + + + + Returns a new ConstraintExpression, which will apply the following + constraint to the InnerException property of the object being tested. + + + + + Returns a constraint that tests for null + + + + + Returns a constraint that tests for True + + + + + Returns a constraint that tests for False + + + + + Returns a constraint that tests for a positive value + + + + + Returns a constraint that tests for a negative value + + + + + Returns a constraint that tests for NaN + + + + + Returns a constraint that tests for empty + + + + + Returns a constraint that tests whether a collection + contains all unique items. + + + + + Returns a constraint that tests whether an object graph is serializable in binary format. + + + + + Returns a constraint that tests whether an object graph is serializable in xml format. + + + + + Returns a constraint that tests whether a collection is ordered + + + + + The ConstraintOperator class is used internally by a + ConstraintBuilder to represent an operator that + modifies or combines constraints. + + Constraint operators use left and right precedence + values to determine whether the top operator on the + stack should be reduced before pushing a new operator. + + + + + The precedence value used when the operator + is about to be pushed to the stack. + + + + + The precedence value used when the operator + is on the top of the stack. + + + + + Reduce produces a constraint from the operator and + any arguments. It takes the arguments from the constraint + stack and pushes the resulting constraint on it. + + + + + + The syntax element preceding this operator + + + + + The syntax element folowing this operator + + + + + The precedence value used when the operator + is about to be pushed to the stack. + + + + + The precedence value used when the operator + is on the top of the stack. + + + + + PrefixOperator takes a single constraint and modifies + it's action in some way. + + + + + Reduce produces a constraint from the operator and + any arguments. It takes the arguments from the constraint + stack and pushes the resulting constraint on it. + + + + + + Returns the constraint created by applying this + prefix to another constraint. + + + + + + + Negates the test of the constraint it wraps. + + + + + Constructs a new NotOperator + + + + + Returns a NotConstraint applied to its argument. + + + + + Abstract base for operators that indicate how to + apply a constraint to items in a collection. + + + + + Constructs a CollectionOperator + + + + + Represents a constraint that succeeds if all the + members of a collection match a base constraint. + + + + + Returns a constraint that will apply the argument + to the members of a collection, succeeding if + they all succeed. + + + + + Represents a constraint that succeeds if any of the + members of a collection match a base constraint. + + + + + Returns a constraint that will apply the argument + to the members of a collection, succeeding if + any of them succeed. + + + + + Represents a constraint that succeeds if none of the + members of a collection match a base constraint. + + + + + Returns a constraint that will apply the argument + to the members of a collection, succeeding if + none of them succeed. + + + + + Represents a constraint that succeeds if the specified + count of members of a collection match a base constraint. + + + + + Construct an ExactCountOperator for a specified count + + The expected count + + + + Returns a constraint that will apply the argument + to the members of a collection, succeeding if + none of them succeed. + + + + + Represents a constraint that simply wraps the + constraint provided as an argument, without any + further functionality, but which modifes the + order of evaluation because of its precedence. + + + + + Constructor for the WithOperator + + + + + Returns a constraint that wraps its argument + + + + + Abstract base class for operators that are able to reduce to a + constraint whether or not another syntactic element follows. + + + + + Operator used to test for the presence of a named Property + on an object and optionally apply further tests to the + value of that property. + + + + + Constructs a PropOperator for a particular named property + + + + + Reduce produces a constraint from the operator and + any arguments. It takes the arguments from the constraint + stack and pushes the resulting constraint on it. + + + + + + Gets the name of the property to which the operator applies + + + + + Operator that tests for the presence of a particular attribute + on a type and optionally applies further tests to the attribute. + + + + + Construct an AttributeOperator for a particular Type + + The Type of attribute tested + + + + Reduce produces a constraint from the operator and + any arguments. It takes the arguments from the constraint + stack and pushes the resulting constraint on it. + + + + + Operator that tests that an exception is thrown and + optionally applies further tests to the exception. + + + + + Construct a ThrowsOperator + + + + + Reduce produces a constraint from the operator and + any arguments. It takes the arguments from the constraint + stack and pushes the resulting constraint on it. + + + + + Abstract base class for all binary operators + + + + + Reduce produces a constraint from the operator and + any arguments. It takes the arguments from the constraint + stack and pushes the resulting constraint on it. + + + + + + Abstract method that produces a constraint by applying + the operator to its left and right constraint arguments. + + + + + Gets the left precedence of the operator + + + + + Gets the right precedence of the operator + + + + + Operator that requires both it's arguments to succeed + + + + + Construct an AndOperator + + + + + Apply the operator to produce an AndConstraint + + + + + Operator that requires at least one of it's arguments to succeed + + + + + Construct an OrOperator + + + + + Apply the operator to produce an OrConstraint + + + + + ContainsConstraint tests a whether a string contains a substring + or a collection contains an object. It postpones the decision of + which test to use until the type of the actual argument is known. + This allows testing whether a string is contained in a collection + or as a substring of another string using the same syntax. + + + + + Initializes a new instance of the class. + + The expected. + + + + Test whether the constraint is satisfied by a given value + + The value to be tested + True for success, false for failure + + + + Write the constraint description to a MessageWriter + + The writer on which the description is displayed + + + + Flag the constraint to use the supplied IComparer object. + + The IComparer object to use. + Self. + + + + Flag the constraint to use the supplied IComparer object. + + The IComparer object to use. + Self. + + + + Flag the constraint to use the supplied Comparison object. + + The IComparer object to use. + Self. + + + + Flag the constraint to use the supplied IEqualityComparer object. + + The IComparer object to use. + Self. + + + + Flag the constraint to use the supplied IEqualityComparer object. + + The IComparer object to use. + Self. + + + + Flag the constraint to ignore case and return self. + + + + + Applies a delay to the match so that a match can be evaluated in the future. + + + + + Creates a new DelayedConstraint + + The inner constraint two decorate + The time interval after which the match is performed + If the value of is less than 0 + + + + Creates a new DelayedConstraint + + The inner constraint two decorate + The time interval after which the match is performed + The time interval used for polling + If the value of is less than 0 + + + + Test whether the constraint is satisfied by a given value + + The value to be tested + True for if the base constraint fails, false if it succeeds + + + + Test whether the constraint is satisfied by a delegate + + The delegate whose value is to be tested + True for if the base constraint fails, false if it succeeds + + + + Test whether the constraint is satisfied by a given reference. + Overridden to wait for the specified delay period before + calling the base constraint with the dereferenced value. + + A reference to the value to be tested + True for success, false for failure + + + + Write the constraint description to a MessageWriter + + The writer on which the description is displayed + + + + Write the actual value for a failing constraint test to a MessageWriter. + + The writer on which the actual value is displayed + + + + Returns the string representation of the constraint. + + + + + EmptyDirectoryConstraint is used to test that a directory is empty + + + + + Test whether the constraint is satisfied by a given value + + The value to be tested + True for success, false for failure + + + + Write the constraint description to a MessageWriter + + The writer on which the description is displayed + + + + Write the actual value for a failing constraint test to a + MessageWriter. The default implementation simply writes + the raw value of actual, leaving it to the writer to + perform any formatting. + + The writer on which the actual value is displayed + + + + EmptyConstraint tests a whether a string or collection is empty, + postponing the decision about which test is applied until the + type of the actual argument is known. + + + + + Test whether the constraint is satisfied by a given value + + The value to be tested + True for success, false for failure + + + + Write the constraint description to a MessageWriter + + The writer on which the description is displayed + + + + EqualConstraint is able to compare an actual value with the + expected value provided in its constructor. Two objects are + considered equal if both are null, or if both have the same + value. NUnit has special semantics for some object types. + + + + + If true, strings in error messages will be clipped + + + + + NUnitEqualityComparer used to test equality. + + + + + Initializes a new instance of the class. + + The expected value. + + + + Flag the constraint to use a tolerance when determining equality. + + Tolerance value to be used + Self. + + + + Flag the constraint to use the supplied IComparer object. + + The IComparer object to use. + Self. + + + + Flag the constraint to use the supplied IComparer object. + + The IComparer object to use. + Self. + + + + Flag the constraint to use the supplied IComparer object. + + The IComparer object to use. + Self. + + + + Flag the constraint to use the supplied Comparison object. + + The IComparer object to use. + Self. + + + + Flag the constraint to use the supplied IEqualityComparer object. + + The IComparer object to use. + Self. + + + + Flag the constraint to use the supplied IEqualityComparer object. + + The IComparer object to use. + Self. + + + + Test whether the constraint is satisfied by a given value + + The value to be tested + True for success, false for failure + + + + Write a failure message. Overridden to provide custom + failure messages for EqualConstraint. + + The MessageWriter to write to + + + + Write description of this constraint + + The MessageWriter to write to + + + + Display the failure information for two collections that did not match. + + The MessageWriter on which to display + The expected collection. + The actual collection + The depth of this failure in a set of nested collections + + + + Displays a single line showing the types and sizes of the expected + and actual enumerations, collections or arrays. If both are identical, + the value is only shown once. + + The MessageWriter on which to display + The expected collection or array + The actual collection or array + The indentation level for the message line + + + + Displays a single line showing the point in the expected and actual + arrays at which the comparison failed. If the arrays have different + structures or dimensions, both values are shown. + + The MessageWriter on which to display + The expected array + The actual array + Index of the failure point in the underlying collections + The indentation level for the message line + + + + Display the failure information for two IEnumerables that did not match. + + The MessageWriter on which to display + The expected enumeration. + The actual enumeration + The depth of this failure in a set of nested collections + + + + Flag the constraint to ignore case and return self. + + + + + Flag the constraint to suppress string clipping + and return self. + + + + + Flag the constraint to compare arrays as collections + and return self. + + + + + Switches the .Within() modifier to interpret its tolerance as + a distance in representable values (see remarks). + + Self. + + Ulp stands for "unit in the last place" and describes the minimum + amount a given value can change. For any integers, an ulp is 1 whole + digit. For floating point values, the accuracy of which is better + for smaller numbers and worse for larger numbers, an ulp depends + on the size of the number. Using ulps for comparison of floating + point results instead of fixed tolerances is safer because it will + automatically compensate for the added inaccuracy of larger numbers. + + + + + Switches the .Within() modifier to interpret its tolerance as + a percentage that the actual values is allowed to deviate from + the expected value. + + Self + + + + Causes the tolerance to be interpreted as a TimeSpan in days. + + Self + + + + Causes the tolerance to be interpreted as a TimeSpan in hours. + + Self + + + + Causes the tolerance to be interpreted as a TimeSpan in minutes. + + Self + + + + Causes the tolerance to be interpreted as a TimeSpan in seconds. + + Self + + + + Causes the tolerance to be interpreted as a TimeSpan in milliseconds. + + Self + + + + Causes the tolerance to be interpreted as a TimeSpan in clock ticks. + + Self + + + + EqualityAdapter class handles all equality comparisons + that use an IEqualityComparer, IEqualityComparer<T> + or a ComparisonAdapter. + + + + + Compares two objects, returning true if they are equal + + + + + Returns true if the two objects can be compared by this adapter. + The base adapter cannot handle IEnumerables except for strings. + + + + + Returns an EqualityAdapter that wraps an IComparer. + + + + + Returns an EqualityAdapter that wraps an IEqualityComparer. + + + + + Returns an EqualityAdapter that wraps an IEqualityComparer<T>. + + + + + Returns an EqualityAdapter that wraps an IComparer<T>. + + + + + Returns an EqualityAdapter that wraps a Comparison<T>. + + + + + EqualityAdapter that wraps an IComparer. + + + + + Returns true if the two objects can be compared by this adapter. + Generic adapter requires objects of the specified type. + + + + + EqualityAdapter that wraps an IComparer. + + + + Helper routines for working with floating point numbers + + + The floating point comparison code is based on this excellent article: + http://www.cygnus-software.com/papers/comparingfloats/comparingfloats.htm + + + "ULP" means Unit in the Last Place and in the context of this library refers to + the distance between two adjacent floating point numbers. IEEE floating point + numbers can only represent a finite subset of natural numbers, with greater + accuracy for smaller numbers and lower accuracy for very large numbers. + + + If a comparison is allowed "2 ulps" of deviation, that means the values are + allowed to deviate by up to 2 adjacent floating point values, which might be + as low as 0.0000001 for small numbers or as high as 10.0 for large numbers. + + + + + Compares two floating point values for equality + First floating point value to be compared + Second floating point value t be compared + + Maximum number of representable floating point values that are allowed to + be between the left and the right floating point values + + True if both numbers are equal or close to being equal + + + Floating point values can only represent a finite subset of natural numbers. + For example, the values 2.00000000 and 2.00000024 can be stored in a float, + but nothing inbetween them. + + + This comparison will count how many possible floating point values are between + the left and the right number. If the number of possible values between both + numbers is less than or equal to maxUlps, then the numbers are considered as + being equal. + + + Implementation partially follows the code outlined here: + http://www.anttirt.net/2007/08/19/proper-floating-point-comparisons/ + + + + + Compares two double precision floating point values for equality + First double precision floating point value to be compared + Second double precision floating point value t be compared + + Maximum number of representable double precision floating point values that are + allowed to be between the left and the right double precision floating point values + + True if both numbers are equal or close to being equal + + + Double precision floating point values can only represent a limited series of + natural numbers. For example, the values 2.0000000000000000 and 2.0000000000000004 + can be stored in a double, but nothing inbetween them. + + + This comparison will count how many possible double precision floating point + values are between the left and the right number. If the number of possible + values between both numbers is less than or equal to maxUlps, then the numbers + are considered as being equal. + + + Implementation partially follows the code outlined here: + http://www.anttirt.net/2007/08/19/proper-floating-point-comparisons/ + + + + + + Reinterprets the memory contents of a floating point value as an integer value + + + Floating point value whose memory contents to reinterpret + + + The memory contents of the floating point value interpreted as an integer + + + + + Reinterprets the memory contents of a double precision floating point + value as an integer value + + + Double precision floating point value whose memory contents to reinterpret + + + The memory contents of the double precision floating point value + interpreted as an integer + + + + + Reinterprets the memory contents of an integer as a floating point value + + Integer value whose memory contents to reinterpret + + The memory contents of the integer value interpreted as a floating point value + + + + + Reinterprets the memory contents of an integer value as a double precision + floating point value + + Integer whose memory contents to reinterpret + + The memory contents of the integer interpreted as a double precision + floating point value + + + + Union of a floating point variable and an integer + + + The union's value as a floating point variable + + + The union's value as an integer + + + The union's value as an unsigned integer + + + Union of a double precision floating point variable and a long + + + The union's value as a double precision floating point variable + + + The union's value as a long + + + The union's value as an unsigned long + + + + Tests whether a value is greater than the value supplied to its constructor + + + + + The value against which a comparison is to be made + + + + + Initializes a new instance of the class. + + The expected value. + + + + Write the constraint description to a MessageWriter + + The writer on which the description is displayed + + + + Test whether the constraint is satisfied by a given value + + The value to be tested + True for success, false for failure + + + + Tests whether a value is greater than or equal to the value supplied to its constructor + + + + + The value against which a comparison is to be made + + + + + Initializes a new instance of the class. + + The expected value. + + + + Write the constraint description to a MessageWriter + + The writer on which the description is displayed + + + + Test whether the constraint is satisfied by a given value + + The value to be tested + True for success, false for failure + + + + Tests whether a value is less than the value supplied to its constructor + + + + + The value against which a comparison is to be made + + + + + Initializes a new instance of the class. + + The expected value. + + + + Write the constraint description to a MessageWriter + + The writer on which the description is displayed + + + + Test whether the constraint is satisfied by a given value + + The value to be tested + True for success, false for failure + + + + Tests whether a value is less than or equal to the value supplied to its constructor + + + + + The value against which a comparison is to be made + + + + + Initializes a new instance of the class. + + The expected value. + + + + Write the constraint description to a MessageWriter + + The writer on which the description is displayed + + + + Test whether the constraint is satisfied by a given value + + The value to be tested + True for success, false for failure + + + + MessageWriter is the abstract base for classes that write + constraint descriptions and messages in some form. The + class has separate methods for writing various components + of a message, allowing implementations to tailor the + presentation as needed. + + + + + Construct a MessageWriter given a culture + + + + + Method to write single line message with optional args, usually + written to precede the general failure message. + + The message to be written + Any arguments used in formatting the message + + + + Method to write single line message with optional args, usually + written to precede the general failure message, at a givel + indentation level. + + The indentation level of the message + The message to be written + Any arguments used in formatting the message + + + + Display Expected and Actual lines for a constraint. This + is called by MessageWriter's default implementation of + WriteMessageTo and provides the generic two-line display. + + The constraint that failed + + + + Display Expected and Actual lines for given values. This + method may be called by constraints that need more control over + the display of actual and expected values than is provided + by the default implementation. + + The expected value + The actual value causing the failure + + + + Display Expected and Actual lines for given values, including + a tolerance value on the Expected line. + + The expected value + The actual value causing the failure + The tolerance within which the test was made + + + + Display the expected and actual string values on separate lines. + If the mismatch parameter is >=0, an additional line is displayed + line containing a caret that points to the mismatch point. + + The expected string value + The actual string value + The point at which the strings don't match or -1 + If true, case is ignored in locating the point where the strings differ + If true, the strings should be clipped to fit the line + + + + Writes the text for a connector. + + The connector. + + + + Writes the text for a predicate. + + The predicate. + + + + Writes the text for an expected value. + + The expected value. + + + + Writes the text for a modifier + + The modifier. + + + + Writes the text for an actual value. + + The actual value. + + + + Writes the text for a generalized value. + + The value. + + + + Writes the text for a collection value, + starting at a particular point, to a max length + + The collection containing elements to write. + The starting point of the elements to write + The maximum number of elements to write + + + + Abstract method to get the max line length + + + + + Static methods used in creating messages + + + + + Static string used when strings are clipped + + + + + Returns the representation of a type as used in NUnitLite. + This is the same as Type.ToString() except for arrays, + which are displayed with their declared sizes. + + + + + + + Converts any control characters in a string + to their escaped representation. + + The string to be converted + The converted string + + + + Return the a string representation for a set of indices into an array + + Array of indices for which a string is needed + + + + Get an array of indices representing the point in a enumerable, + collection or array corresponding to a single int index into the + collection. + + The collection to which the indices apply + Index in the collection + Array of indices + + + + Clip a string to a given length, starting at a particular offset, returning the clipped + string with ellipses representing the removed parts + + The string to be clipped + The maximum permitted length of the result string + The point at which to start clipping + The clipped string + + + + Clip the expected and actual strings in a coordinated fashion, + so that they may be displayed together. + + + + + + + + + Shows the position two strings start to differ. Comparison + starts at the start index. + + The expected string + The actual string + The index in the strings at which comparison should start + Boolean indicating whether case should be ignored + -1 if no mismatch found, or the index where mismatch found + + + + The Numerics class contains common operations on numeric values. + + + + + Checks the type of the object, returning true if + the object is a numeric type. + + The object to check + true if the object is a numeric type + + + + Checks the type of the object, returning true if + the object is a floating point numeric type. + + The object to check + true if the object is a floating point numeric type + + + + Checks the type of the object, returning true if + the object is a fixed point numeric type. + + The object to check + true if the object is a fixed point numeric type + + + + Test two numeric values for equality, performing the usual numeric + conversions and using a provided or default tolerance. If the tolerance + provided is Empty, this method may set it to a default tolerance. + + The expected value + The actual value + A reference to the tolerance in effect + True if the values are equal + + + + Compare two numeric values, performing the usual numeric conversions. + + The expected value + The actual value + The relationship of the values to each other + + + + NUnitComparer encapsulates NUnit's default behavior + in comparing two objects. + + + + + Compares two objects + + + + + + + + Returns the default NUnitComparer. + + + + + Generic version of NUnitComparer + + + + + + Compare two objects of the same type + + + + + NUnitEqualityComparer encapsulates NUnit's handling of + equality tests between objects. + + + + + + + + + + Compares two objects for equality within a tolerance + + The first object to compare + The second object to compare + The tolerance to use in the comparison + + + + + If true, all string comparisons will ignore case + + + + + If true, arrays will be treated as collections, allowing + those of different dimensions to be compared + + + + + Comparison objects used in comparisons for some constraints. + + + + + Compares two objects for equality within a tolerance. + + + + + Helper method to compare two arrays + + + + + Method to compare two DirectoryInfo objects + + first directory to compare + second directory to compare + true if equivalent, false if not + + + + Returns the default NUnitEqualityComparer + + + + + Gets and sets a flag indicating whether case should + be ignored in determining equality. + + + + + Gets and sets a flag indicating that arrays should be + compared as collections, without regard to their shape. + + + + + Gets and sets an external comparer to be used to + test for equality. It is applied to members of + collections, in place of NUnit's own logic. + + + + + Gets the list of failure points for the last Match performed. + + + + + FailurePoint class represents one point of failure + in an equality test. + + + + + The location of the failure + + + + + The expected value + + + + + The actual value + + + + + Indicates whether the expected value is valid + + + + + Indicates whether the actual value is valid + + + + + PathConstraint serves as the abstract base of constraints + that operate on paths and provides several helper methods. + + + + + The expected path used in the constraint + + + + + The actual path being tested + + + + + Flag indicating whether a caseInsensitive comparison should be made + + + + + Construct a PathConstraint for a give expected path + + The expected path + + + + Test whether the constraint is satisfied by a given value + + The value to be tested + True for success, false for failure + + + + Returns true if the expected path and actual path match + + + + + Returns the string representation of this constraint + + + + + Canonicalize the provided path + + + The path in standardized form + + + + Test whether two paths are the same + + The first path + The second path + Indicates whether case should be ignored + + + + + Test whether one path is under another path + + The first path - supposed to be the parent path + The second path - supposed to be the child path + Indicates whether case should be ignored + + + + + Test whether one path is the same as or under another path + + The first path - supposed to be the parent path + The second path - supposed to be the child path + + + + + Modifies the current instance to be case-insensitve + and returns it. + + + + + Modifies the current instance to be case-sensitve + and returns it. + + + + + Summary description for SamePathConstraint. + + + + + Initializes a new instance of the class. + + The expected path + + + + Test whether the constraint is satisfied by a given value + + The expected path + The actual path + True for success, false for failure + + + + Write the constraint description to a MessageWriter + + The writer on which the description is displayed + + + + SubPathConstraint tests that the actual path is under the expected path + + + + + Initializes a new instance of the class. + + The expected path + + + + Test whether the constraint is satisfied by a given value + + The expected path + The actual path + True for success, false for failure + + + + Write the constraint description to a MessageWriter + + The writer on which the description is displayed + + + + SamePathOrUnderConstraint tests that one path is under another + + + + + Initializes a new instance of the class. + + The expected path + + + + Test whether the constraint is satisfied by a given value + + The expected path + The actual path + True for success, false for failure + + + + Write the constraint description to a MessageWriter + + The writer on which the description is displayed + + + + Predicate constraint wraps a Predicate in a constraint, + returning success if the predicate is true. + + + + + Construct a PredicateConstraint from a predicate + + + + + Determines whether the predicate succeeds when applied + to the actual value. + + + + + Writes the description to a MessageWriter + + + + + NotConstraint negates the effect of some other constraint + + + + + Initializes a new instance of the class. + + The base constraint to be negated. + + + + Test whether the constraint is satisfied by a given value + + The value to be tested + True for if the base constraint fails, false if it succeeds + + + + Write the constraint description to a MessageWriter + + The writer on which the description is displayed + + + + Write the actual value for a failing constraint test to a MessageWriter. + + The writer on which the actual value is displayed + + + + AllItemsConstraint applies another constraint to each + item in a collection, succeeding if they all succeed. + + + + + Construct an AllItemsConstraint on top of an existing constraint + + + + + + Apply the item constraint to each item in the collection, + failing if any item fails. + + + + + + + Write a description of this constraint to a MessageWriter + + + + + + SomeItemsConstraint applies another constraint to each + item in a collection, succeeding if any of them succeeds. + + + + + Construct a SomeItemsConstraint on top of an existing constraint + + + + + + Apply the item constraint to each item in the collection, + succeeding if any item succeeds. + + + + + + + Write a description of this constraint to a MessageWriter + + + + + + NoItemConstraint applies another constraint to each + item in a collection, failing if any of them succeeds. + + + + + Construct a NoItemConstraint on top of an existing constraint + + + + + + Apply the item constraint to each item in the collection, + failing if any item fails. + + + + + + + Write a description of this constraint to a MessageWriter + + + + + + ExactCoutConstraint applies another constraint to each + item in a collection, succeeding only if a specified + number of items succeed. + + + + + Construct an ExactCountConstraint on top of an existing constraint + + + + + + + Apply the item constraint to each item in the collection, + succeeding only if the expected number of items pass. + + + + + + + Write a description of this constraint to a MessageWriter + + + + + + PropertyExistsConstraint tests that a named property + exists on the object provided through Match. + + Originally, PropertyConstraint provided this feature + in addition to making optional tests on the vaue + of the property. The two constraints are now separate. + + + + + Initializes a new instance of the class. + + The name of the property. + + + + Test whether the property exists for a given object + + The object to be tested + True for success, false for failure + + + + Write the constraint description to a MessageWriter + + The writer on which the description is displayed + + + + Write the actual value for a failing constraint test to a + MessageWriter. + + The writer on which the actual value is displayed + + + + Returns the string representation of the constraint. + + + + + + PropertyConstraint extracts a named property and uses + its value as the actual value for a chained constraint. + + + + + Initializes a new instance of the class. + + The name. + The constraint to apply to the property. + + + + Test whether the constraint is satisfied by a given value + + The value to be tested + True for success, false for failure + + + + Write the constraint description to a MessageWriter + + The writer on which the description is displayed + + + + Write the actual value for a failing constraint test to a + MessageWriter. The default implementation simply writes + the raw value of actual, leaving it to the writer to + perform any formatting. + + The writer on which the actual value is displayed + + + + Returns the string representation of the constraint. + + + + + + RangeConstraint tests whethe two values are within a + specified range. + + + + + Initializes a new instance of the class. + + From. + To. + + + + Test whether the constraint is satisfied by a given value + + The value to be tested + True for success, false for failure + + + + Write the constraint description to a MessageWriter + + The writer on which the description is displayed + + + + ResolvableConstraintExpression is used to represent a compound + constraint being constructed at a point where the last operator + may either terminate the expression or may have additional + qualifying constraints added to it. + + It is used, for example, for a Property element or for + an Exception element, either of which may be optionally + followed by constraints that apply to the property or + exception. + + + + + Create a new instance of ResolvableConstraintExpression + + + + + Create a new instance of ResolvableConstraintExpression, + passing in a pre-populated ConstraintBuilder. + + + + + Resolve the current expression to a Constraint + + + + + This operator creates a constraint that is satisfied only if both + argument constraints are satisfied. + + + + + This operator creates a constraint that is satisfied only if both + argument constraints are satisfied. + + + + + This operator creates a constraint that is satisfied only if both + argument constraints are satisfied. + + + + + This operator creates a constraint that is satisfied if either + of the argument constraints is satisfied. + + + + + This operator creates a constraint that is satisfied if either + of the argument constraints is satisfied. + + + + + This operator creates a constraint that is satisfied if either + of the argument constraints is satisfied. + + + + + This operator creates a constraint that is satisfied if the + argument constraint is not satisfied. + + + + + Appends an And Operator to the expression + + + + + Appends an Or operator to the expression. + + + + + ReusableConstraint wraps a resolved constraint so that it + may be saved and reused as needed. + + + + + Construct a ReusableConstraint + + The constraint or expression to be reused + + + + Conversion operator from a normal constraint to a ReusableConstraint. + + The original constraint to be wrapped as a ReusableConstraint + + + + + Returns the string representation of the constraint. + + A string representing the constraint + + + + Resolves the ReusableConstraint by returning the constraint + that it originally wrapped. + + A resolved constraint + + + + SameAsConstraint tests whether an object is identical to + the object passed to its constructor + + + + + Initializes a new instance of the class. + + The expected object. + + + + Test whether the constraint is satisfied by a given value + + The value to be tested + True for success, false for failure + + + + Write the constraint description to a MessageWriter + + The writer on which the description is displayed + + + + BinarySerializableConstraint tests whether + an object is serializable in binary format. + + + + + Test whether the constraint is satisfied by a given value + + The value to be tested + True for success, false for failure + + + + Write the constraint description to a MessageWriter + + The writer on which the description is displayed + + + + Write the actual value for a failing constraint test to a + MessageWriter. The default implementation simply writes + the raw value of actual, leaving it to the writer to + perform any formatting. + + The writer on which the actual value is displayed + + + + Returns the string representation + + + + + BinarySerializableConstraint tests whether + an object is serializable in binary format. + + + + + Test whether the constraint is satisfied by a given value + + The value to be tested + True for success, false for failure + + + + Write the constraint description to a MessageWriter + + The writer on which the description is displayed + + + + Write the actual value for a failing constraint test to a + MessageWriter. The default implementation simply writes + the raw value of actual, leaving it to the writer to + perform any formatting. + + The writer on which the actual value is displayed + + + + Returns the string representation of this constraint + + + + + StringConstraint is the abstract base for constraints + that operate on strings. It supports the IgnoreCase + modifier for string operations. + + + + + The expected value + + + + + Indicates whether tests should be case-insensitive + + + + + Constructs a StringConstraint given an expected value + + The expected value + + + + Modify the constraint to ignore case in matching. + + + + + EmptyStringConstraint tests whether a string is empty. + + + + + Test whether the constraint is satisfied by a given value + + The value to be tested + True for success, false for failure + + + + Write the constraint description to a MessageWriter + + The writer on which the description is displayed + + + + NullEmptyStringConstraint tests whether a string is either null or empty. + + + + + Constructs a new NullOrEmptyStringConstraint + + + + + Test whether the constraint is satisfied by a given value + + The value to be tested + True for success, false for failure + + + + Write the constraint description to a MessageWriter + + The writer on which the description is displayed + + + + SubstringConstraint can test whether a string contains + the expected substring. + + + + + Initializes a new instance of the class. + + The expected. + + + + Test whether the constraint is satisfied by a given value + + The value to be tested + True for success, false for failure + + + + Write the constraint description to a MessageWriter + + The writer on which the description is displayed + + + + StartsWithConstraint can test whether a string starts + with an expected substring. + + + + + Initializes a new instance of the class. + + The expected string + + + + Test whether the constraint is matched by the actual value. + This is a template method, which calls the IsMatch method + of the derived class. + + + + + + + Write the constraint description to a MessageWriter + + The writer on which the description is displayed + + + + EndsWithConstraint can test whether a string ends + with an expected substring. + + + + + Initializes a new instance of the class. + + The expected string + + + + Test whether the constraint is matched by the actual value. + This is a template method, which calls the IsMatch method + of the derived class. + + + + + + + Write the constraint description to a MessageWriter + + The writer on which the description is displayed + + + + RegexConstraint can test whether a string matches + the pattern provided. + + + + + Initializes a new instance of the class. + + The pattern. + + + + Test whether the constraint is satisfied by a given value + + The value to be tested + True for success, false for failure + + + + Write the constraint description to a MessageWriter + + The writer on which the description is displayed + + + + ThrowsConstraint is used to test the exception thrown by + a delegate by applying a constraint to it. + + + + + Initializes a new instance of the class, + using a constraint to be applied to the exception. + + A constraint to apply to the caught exception. + + + + Executes the code of the delegate and captures any exception. + If a non-null base constraint was provided, it applies that + constraint to the exception. + + A delegate representing the code to be tested + True if an exception is thrown and the constraint succeeds, otherwise false + + + + Converts an ActualValueDelegate to a TestDelegate + before calling the primary overload. + + + + + + + Write the constraint description to a MessageWriter + + The writer on which the description is displayed + + + + Write the actual value for a failing constraint test to a + MessageWriter. The default implementation simply writes + the raw value of actual, leaving it to the writer to + perform any formatting. + + The writer on which the actual value is displayed + + + + Returns the string representation of this constraint + + + + + Get the actual exception thrown - used by Assert.Throws. + + + + + ThrowsNothingConstraint tests that a delegate does not + throw an exception. + + + + + Test whether the constraint is satisfied by a given value + + The value to be tested + True if no exception is thrown, otherwise false + + + + Converts an ActualValueDelegate to a TestDelegate + before calling the primary overload. + + + + + + + Write the constraint description to a MessageWriter + + The writer on which the description is displayed + + + + Write the actual value for a failing constraint test to a + MessageWriter. The default implementation simply writes + the raw value of actual, leaving it to the writer to + perform any formatting. + + The writer on which the actual value is displayed + + + + Modes in which the tolerance value for a comparison can + be interpreted. + + + + + The tolerance was created with a value, without specifying + how the value would be used. This is used to prevent setting + the mode more than once and is generally changed to Linear + upon execution of the test. + + + + + The tolerance is used as a numeric range within which + two compared values are considered to be equal. + + + + + Interprets the tolerance as the percentage by which + the two compared values my deviate from each other. + + + + + Compares two values based in their distance in + representable numbers. + + + + + The Tolerance class generalizes the notion of a tolerance + within which an equality test succeeds. Normally, it is + used with numeric types, but it can be used with any + type that supports taking a difference between two + objects and comparing that difference to a value. + + + + + Constructs a linear tolerance of a specdified amount + + + + + Constructs a tolerance given an amount and ToleranceMode + + + + + Tests that the current Tolerance is linear with a + numeric value, throwing an exception if it is not. + + + + + Returns an empty Tolerance object, equivalent to + specifying no tolerance. In most cases, it results + in an exact match but for floats and doubles a + default tolerance may be used. + + + + + Returns a zero Tolerance object, equivalent to + specifying an exact match. + + + + + Gets the ToleranceMode for the current Tolerance + + + + + Gets the value of the current Tolerance instance. + + + + + Returns a new tolerance, using the current amount as a percentage. + + + + + Returns a new tolerance, using the current amount in Ulps. + + + + + Returns a new tolerance with a TimeSpan as the amount, using + the current amount as a number of days. + + + + + Returns a new tolerance with a TimeSpan as the amount, using + the current amount as a number of hours. + + + + + Returns a new tolerance with a TimeSpan as the amount, using + the current amount as a number of minutes. + + + + + Returns a new tolerance with a TimeSpan as the amount, using + the current amount as a number of seconds. + + + + + Returns a new tolerance with a TimeSpan as the amount, using + the current amount as a number of milliseconds. + + + + + Returns a new tolerance with a TimeSpan as the amount, using + the current amount as a number of clock ticks. + + + + + Returns true if the current tolerance is empty. + + + + + TypeConstraint is the abstract base for constraints + that take a Type as their expected value. + + + + + The expected Type used by the constraint + + + + + Construct a TypeConstraint for a given Type + + + + + + Write the actual value for a failing constraint test to a + MessageWriter. TypeConstraints override this method to write + the name of the type. + + The writer on which the actual value is displayed + + + + ExactTypeConstraint is used to test that an object + is of the exact type provided in the constructor + + + + + Construct an ExactTypeConstraint for a given Type + + The expected Type. + + + + Test that an object is of the exact type specified + + The actual value. + True if the tested object is of the exact type provided, otherwise false. + + + + Write the description of this constraint to a MessageWriter + + The MessageWriter to use + + + + ExceptionTypeConstraint is a special version of ExactTypeConstraint + used to provided detailed info about the exception thrown in + an error message. + + + + + Constructs an ExceptionTypeConstraint + + + + + Write the actual value for a failing constraint test to a + MessageWriter. Overriden to write additional information + in the case of an Exception. + + The MessageWriter to use + + + + InstanceOfTypeConstraint is used to test that an object + is of the same type provided or derived from it. + + + + + Construct an InstanceOfTypeConstraint for the type provided + + The expected Type + + + + Test whether an object is of the specified type or a derived type + + The object to be tested + True if the object is of the provided type or derives from it, otherwise false. + + + + Write a description of this constraint to a MessageWriter + + The MessageWriter to use + + + + AssignableFromConstraint is used to test that an object + can be assigned from a given Type. + + + + + Construct an AssignableFromConstraint for the type provided + + + + + + Test whether an object can be assigned from the specified type + + The object to be tested + True if the object can be assigned a value of the expected Type, otherwise false. + + + + Write a description of this constraint to a MessageWriter + + The MessageWriter to use + + + + AssignableToConstraint is used to test that an object + can be assigned to a given Type. + + + + + Construct an AssignableToConstraint for the type provided + + + + + + Test whether an object can be assigned to the specified type + + The object to be tested + True if the object can be assigned a value of the expected Type, otherwise false. + + + + Write a description of this constraint to a MessageWriter + + The MessageWriter to use + + + + Thrown when an assertion failed. + + + + + The error message that explains + the reason for the exception + + + The error message that explains + the reason for the exception + The exception that caused the + current exception + + + + Serialization Constructor + + + + + Thrown when an assertion failed. + + + + + + + The error message that explains + the reason for the exception + The exception that caused the + current exception + + + + Serialization Constructor + + + + + Thrown when a test executes inconclusively. + + + + + The error message that explains + the reason for the exception + + + The error message that explains + the reason for the exception + The exception that caused the + current exception + + + + Serialization Constructor + + + + + Thrown when an assertion failed. + + + + + + + The error message that explains + the reason for the exception + The exception that caused the + current exception + + + + Serialization Constructor + + + + + + + + + + + Compares two objects of a given Type for equality within a tolerance + + The first object to compare + The second object to compare + The tolerance to use in the comparison + + + + + The different targets a test action attribute can be applied to + + + + + Default target, which is determined by where the action attribute is attached + + + + + Target a individual test case + + + + + Target a suite of test cases + + + + + Delegate used by tests that execute code and + capture any thrown exception. + + + + + The Assert class contains a collection of static methods that + implement the most common assertions used in NUnit. + + + + + We don't actually want any instances of this object, but some people + like to inherit from it to add other static methods. Hence, the + protected constructor disallows any instances of this object. + + + + + The Equals method throws an AssertionException. This is done + to make sure there is no mistake by calling this function. + + + + + + + override the default ReferenceEquals to throw an AssertionException. This + implementation makes sure there is no mistake in calling this function + as part of Assert. + + + + + + + Helper for Assert.AreEqual(double expected, double actual, ...) + allowing code generation to work consistently. + + The expected value + The actual value + The maximum acceptable difference between the + the expected and the actual + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Throws a with the message and arguments + that are passed in. This allows a test to be cut short, with a result + of success returned to NUnit. + + The message to initialize the with. + Arguments to be used in formatting the message + + + + Throws a with the message and arguments + that are passed in. This allows a test to be cut short, with a result + of success returned to NUnit. + + The message to initialize the with. + + + + Throws a with the message and arguments + that are passed in. This allows a test to be cut short, with a result + of success returned to NUnit. + + + + + Throws an with the message and arguments + that are passed in. This is used by the other Assert functions. + + The message to initialize the with. + Arguments to be used in formatting the message + + + + Throws an with the message that is + passed in. This is used by the other Assert functions. + + The message to initialize the with. + + + + Throws an . + This is used by the other Assert functions. + + + + + Throws an with the message and arguments + that are passed in. This causes the test to be reported as ignored. + + The message to initialize the with. + Arguments to be used in formatting the message + + + + Throws an with the message that is + passed in. This causes the test to be reported as ignored. + + The message to initialize the with. + + + + Throws an . + This causes the test to be reported as ignored. + + + + + Throws an with the message and arguments + that are passed in. This causes the test to be reported as inconclusive. + + The message to initialize the with. + Arguments to be used in formatting the message + + + + Throws an with the message that is + passed in. This causes the test to be reported as inconclusive. + + The message to initialize the with. + + + + Throws an . + This causes the test to be reported as Inconclusive. + + + + + Apply a constraint to an actual value, succeeding if the constraint + is satisfied and throwing an assertion exception on failure. + + A Constraint to be applied + The actual value to test + + + + Apply a constraint to an actual value, succeeding if the constraint + is satisfied and throwing an assertion exception on failure. + + A Constraint to be applied + The actual value to test + The message that will be displayed on failure + + + + Apply a constraint to an actual value, succeeding if the constraint + is satisfied and throwing an assertion exception on failure. + + A Constraint expression to be applied + The actual value to test + The message that will be displayed on failure + Arguments to be used in formatting the message + + + + Apply a constraint to an actual value, succeeding if the constraint + is satisfied and throwing an assertion exception on failure. + + A Constraint expression to be applied + An ActualValueDelegate returning the value to be tested + + + + Apply a constraint to an actual value, succeeding if the constraint + is satisfied and throwing an assertion exception on failure. + + A Constraint expression to be applied + An ActualValueDelegate returning the value to be tested + The message that will be displayed on failure + + + + Apply a constraint to an actual value, succeeding if the constraint + is satisfied and throwing an assertion exception on failure. + + An ActualValueDelegate returning the value to be tested + A Constraint expression to be applied + The message that will be displayed on failure + Arguments to be used in formatting the message + + + + Apply a constraint to a referenced value, succeeding if the constraint + is satisfied and throwing an assertion exception on failure. + + A Constraint to be applied + The actual value to test + + + + Apply a constraint to a referenced value, succeeding if the constraint + is satisfied and throwing an assertion exception on failure. + + A Constraint to be applied + The actual value to test + The message that will be displayed on failure + + + + Apply a constraint to a referenced value, succeeding if the constraint + is satisfied and throwing an assertion exception on failure. + + A Constraint to be applied + The actual value to test + The message that will be displayed on failure + Arguments to be used in formatting the message + + + + Asserts that a condition is true. If the condition is false the method throws + an . + + The evaluated condition + The message to display if the condition is false + Arguments to be used in formatting the message + + + + Asserts that a condition is true. If the condition is false the method throws + an . + + The evaluated condition + The message to display if the condition is false + + + + Asserts that a condition is true. If the condition is false the method throws + an . + + The evaluated condition + + + + Asserts that the code represented by a delegate throws an exception + that satisfies the constraint provided. + + A TestDelegate to be executed + A ThrowsConstraint used in the test + + + + Apply a constraint to an actual value, succeeding if the constraint + is satisfied and throwing an assertion exception on failure. + Used as a synonym for That in rare cases where a private setter + causes a Visual Basic compilation error. + + A Constraint to be applied + The actual value to test + + + + Apply a constraint to an actual value, succeeding if the constraint + is satisfied and throwing an assertion exception on failure. + Used as a synonym for That in rare cases where a private setter + causes a Visual Basic compilation error. + + A Constraint to be applied + The actual value to test + The message that will be displayed on failure + + + + Apply a constraint to an actual value, succeeding if the constraint + is satisfied and throwing an assertion exception on failure. + Used as a synonym for That in rare cases where a private setter + causes a Visual Basic compilation error. + + + This method is provided for use by VB developers needing to test + the value of properties with private setters. + + A Constraint expression to be applied + The actual value to test + The message that will be displayed on failure + Arguments to be used in formatting the message + + + + Verifies that a delegate throws a particular exception when called. + + A constraint to be satisfied by the exception + A TestSnippet delegate + The message that will be displayed on failure + Arguments to be used in formatting the message + + + + Verifies that a delegate throws a particular exception when called. + + A constraint to be satisfied by the exception + A TestSnippet delegate + The message that will be displayed on failure + + + + Verifies that a delegate throws a particular exception when called. + + A constraint to be satisfied by the exception + A TestSnippet delegate + + + + Verifies that a delegate throws a particular exception when called. + + The exception Type expected + A TestSnippet delegate + The message that will be displayed on failure + Arguments to be used in formatting the message + + + + Verifies that a delegate throws a particular exception when called. + + The exception Type expected + A TestSnippet delegate + The message that will be displayed on failure + + + + Verifies that a delegate throws a particular exception when called. + + The exception Type expected + A TestSnippet delegate + + + + Verifies that a delegate throws a particular exception when called. + + Type of the expected exception + A TestSnippet delegate + The message that will be displayed on failure + Arguments to be used in formatting the message + + + + Verifies that a delegate throws a particular exception when called. + + Type of the expected exception + A TestSnippet delegate + The message that will be displayed on failure + + + + Verifies that a delegate throws a particular exception when called. + + Type of the expected exception + A TestSnippet delegate + + + + Verifies that a delegate throws an exception when called + and returns it. + + A TestDelegate + The message that will be displayed on failure + Arguments to be used in formatting the message + + + + Verifies that a delegate throws an exception when called + and returns it. + + A TestDelegate + The message that will be displayed on failure + + + + Verifies that a delegate throws an exception when called + and returns it. + + A TestDelegate + + + + Verifies that a delegate throws an exception of a certain Type + or one derived from it when called and returns it. + + The expected Exception Type + A TestDelegate + The message that will be displayed on failure + Arguments to be used in formatting the message + + + + Verifies that a delegate throws an exception of a certain Type + or one derived from it when called and returns it. + + The expected Exception Type + A TestDelegate + The message that will be displayed on failure + + + + Verifies that a delegate throws an exception of a certain Type + or one derived from it when called and returns it. + + The expected Exception Type + A TestDelegate + + + + Verifies that a delegate throws an exception of a certain Type + or one derived from it when called and returns it. + + The expected Exception Type + A TestDelegate + The message that will be displayed on failure + Arguments to be used in formatting the message + + + + Verifies that a delegate throws an exception of a certain Type + or one derived from it when called and returns it. + + The expected Exception Type + A TestDelegate + The message that will be displayed on failure + + + + Verifies that a delegate throws an exception of a certain Type + or one derived from it when called and returns it. + + The expected Exception Type + A TestDelegate + + + + Verifies that a delegate does not throw an exception + + A TestSnippet delegate + The message that will be displayed on failure + Arguments to be used in formatting the message + + + + Verifies that a delegate does not throw an exception. + + A TestSnippet delegate + The message that will be displayed on failure + + + + Verifies that a delegate does not throw an exception. + + A TestSnippet delegate + + + + Asserts that a condition is true. If the condition is false the method throws + an . + + The evaluated condition + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Asserts that a condition is true. If the condition is false the method throws + an . + + The evaluated condition + The message to display in case of failure + + + + Asserts that a condition is true. If the condition is false the method throws + an . + + The evaluated condition + + + + Asserts that a condition is true. If the condition is false the method throws + an . + + The evaluated condition + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Asserts that a condition is true. If the condition is false the method throws + an . + + The evaluated condition + The message to display in case of failure + + + + Asserts that a condition is true. If the condition is false the method throws + an . + + The evaluated condition + + + + Asserts that a condition is false. If the condition is true the method throws + an . + + The evaluated condition + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Asserts that a condition is false. If the condition is true the method throws + an . + + The evaluated condition + The message to display in case of failure + + + + Asserts that a condition is false. If the condition is true the method throws + an . + + The evaluated condition + + + + Asserts that a condition is false. If the condition is true the method throws + an . + + The evaluated condition + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Asserts that a condition is false. If the condition is true the method throws + an . + + The evaluated condition + The message to display in case of failure + + + + Asserts that a condition is false. If the condition is true the method throws + an . + + The evaluated condition + + + + Verifies that the object that is passed in is not equal to null + If the object is null then an + is thrown. + + The object that is to be tested + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Verifies that the object that is passed in is not equal to null + If the object is null then an + is thrown. + + The object that is to be tested + The message to display in case of failure + + + + Verifies that the object that is passed in is not equal to null + If the object is null then an + is thrown. + + The object that is to be tested + + + + Verifies that the object that is passed in is not equal to null + If the object is null then an + is thrown. + + The object that is to be tested + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Verifies that the object that is passed in is not equal to null + If the object is null then an + is thrown. + + The object that is to be tested + The message to display in case of failure + + + + Verifies that the object that is passed in is not equal to null + If the object is null then an + is thrown. + + The object that is to be tested + + + + Verifies that the object that is passed in is equal to null + If the object is not null then an + is thrown. + + The object that is to be tested + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Verifies that the object that is passed in is equal to null + If the object is not null then an + is thrown. + + The object that is to be tested + The message to display in case of failure + + + + Verifies that the object that is passed in is equal to null + If the object is not null then an + is thrown. + + The object that is to be tested + + + + Verifies that the object that is passed in is equal to null + If the object is not null then an + is thrown. + + The object that is to be tested + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Verifies that the object that is passed in is equal to null + If the object is not null then an + is thrown. + + The object that is to be tested + The message to display in case of failure + + + + Verifies that the object that is passed in is equal to null + If the object is not null then an + is thrown. + + The object that is to be tested + + + + Verifies that the double that is passed in is an NaN value. + If the object is not NaN then an + is thrown. + + The value that is to be tested + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Verifies that the double that is passed in is an NaN value. + If the object is not NaN then an + is thrown. + + The value that is to be tested + The message to display in case of failure + + + + Verifies that the double that is passed in is an NaN value. + If the object is not NaN then an + is thrown. + + The value that is to be tested + + + + Verifies that the double that is passed in is an NaN value. + If the object is not NaN then an + is thrown. + + The value that is to be tested + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Verifies that the double that is passed in is an NaN value. + If the object is not NaN then an + is thrown. + + The value that is to be tested + The message to display in case of failure + + + + Verifies that the double that is passed in is an NaN value. + If the object is not NaN then an + is thrown. + + The value that is to be tested + + + + Assert that a string is empty - that is equal to string.Empty + + The string to be tested + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Assert that a string is empty - that is equal to string.Empty + + The string to be tested + The message to display in case of failure + + + + Assert that a string is empty - that is equal to string.Empty + + The string to be tested + + + + Assert that an array, list or other collection is empty + + An array, list or other collection implementing ICollection + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Assert that an array, list or other collection is empty + + An array, list or other collection implementing ICollection + The message to display in case of failure + + + + Assert that an array, list or other collection is empty + + An array, list or other collection implementing ICollection + + + + Assert that a string is not empty - that is not equal to string.Empty + + The string to be tested + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Assert that a string is not empty - that is not equal to string.Empty + + The string to be tested + The message to display in case of failure + + + + Assert that a string is not empty - that is not equal to string.Empty + + The string to be tested + + + + Assert that an array, list or other collection is not empty + + An array, list or other collection implementing ICollection + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Assert that an array, list or other collection is not empty + + An array, list or other collection implementing ICollection + The message to display in case of failure + + + + Assert that an array, list or other collection is not empty + + An array, list or other collection implementing ICollection + + + + Assert that a string is either null or equal to string.Empty + + The string to be tested + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Assert that a string is either null or equal to string.Empty + + The string to be tested + The message to display in case of failure + + + + Assert that a string is either null or equal to string.Empty + + The string to be tested + + + + Assert that a string is not null or empty + + The string to be tested + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Assert that a string is not null or empty + + The string to be tested + The message to display in case of failure + + + + Assert that a string is not null or empty + + The string to be tested + + + + Asserts that an object may be assigned a value of a given Type. + + The expected Type. + The object under examination + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Asserts that an object may be assigned a value of a given Type. + + The expected Type. + The object under examination + The message to display in case of failure + + + + Asserts that an object may be assigned a value of a given Type. + + The expected Type. + The object under examination + + + + Asserts that an object may be assigned a value of a given Type. + + The expected Type. + The object under examination + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Asserts that an object may be assigned a value of a given Type. + + The expected Type. + The object under examination + The message to display in case of failure + + + + Asserts that an object may be assigned a value of a given Type. + + The expected Type. + The object under examination + + + + Asserts that an object may not be assigned a value of a given Type. + + The expected Type. + The object under examination + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Asserts that an object may not be assigned a value of a given Type. + + The expected Type. + The object under examination + The message to display in case of failure + + + + Asserts that an object may not be assigned a value of a given Type. + + The expected Type. + The object under examination + + + + Asserts that an object may not be assigned a value of a given Type. + + The expected Type. + The object under examination + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Asserts that an object may not be assigned a value of a given Type. + + The expected Type. + The object under examination + The message to display in case of failure + + + + Asserts that an object may not be assigned a value of a given Type. + + The expected Type. + The object under examination + + + + Asserts that an object is an instance of a given type. + + The expected Type + The object being examined + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Asserts that an object is an instance of a given type. + + The expected Type + The object being examined + The message to display in case of failure + + + + Asserts that an object is an instance of a given type. + + The expected Type + The object being examined + + + + Asserts that an object is an instance of a given type. + + The expected Type + The object being examined + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Asserts that an object is an instance of a given type. + + The expected Type + The object being examined + The message to display in case of failure + + + + Asserts that an object is an instance of a given type. + + The expected Type + The object being examined + + + + Asserts that an object is an instance of a given type. + + The expected Type + The object being examined + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Asserts that an object is an instance of a given type. + + The expected Type + The object being examined + The message to display in case of failure + + + + Asserts that an object is an instance of a given type. + + The expected Type + The object being examined + + + + Asserts that an object is not an instance of a given type. + + The expected Type + The object being examined + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Asserts that an object is not an instance of a given type. + + The expected Type + The object being examined + The message to display in case of failure + + + + Asserts that an object is not an instance of a given type. + + The expected Type + The object being examined + + + + Asserts that an object is not an instance of a given type. + + The expected Type + The object being examined + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Asserts that an object is not an instance of a given type. + + The expected Type + The object being examined + The message to display in case of failure + + + + Asserts that an object is not an instance of a given type. + + The expected Type + The object being examined + + + + Asserts that an object is not an instance of a given type. + + The expected Type + The object being examined + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Asserts that an object is not an instance of a given type. + + The expected Type + The object being examined + The message to display in case of failure + + + + Asserts that an object is not an instance of a given type. + + The expected Type + The object being examined + + + + Verifies that two values are equal. If they are not, then an + is thrown. + + The expected value + The actual value + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Verifies that two values are equal. If they are not, then an + is thrown. + + The expected value + The actual value + The message to display in case of failure + + + + Verifies that two values are equal. If they are not, then an + is thrown. + + The expected value + The actual value + + + + Verifies that two values are equal. If they are not, then an + is thrown. + + The expected value + The actual value + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Verifies that two values are equal. If they are not, then an + is thrown. + + The expected value + The actual value + The message to display in case of failure + + + + Verifies that two values are equal. If they are not, then an + is thrown. + + The expected value + The actual value + + + + Verifies that two values are equal. If they are not, then an + is thrown. + + The expected value + The actual value + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Verifies that two values are equal. If they are not, then an + is thrown. + + The expected value + The actual value + The message to display in case of failure + + + + Verifies that two values are equal. If they are not, then an + is thrown. + + The expected value + The actual value + + + + Verifies that two values are equal. If they are not, then an + is thrown. + + The expected value + The actual value + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Verifies that two values are equal. If they are not, then an + is thrown. + + The expected value + The actual value + The message to display in case of failure + + + + Verifies that two values are equal. If they are not, then an + is thrown. + + The expected value + The actual value + + + + Verifies that two values are equal. If they are not, then an + is thrown. + + The expected value + The actual value + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Verifies that two values are equal. If they are not, then an + is thrown. + + The expected value + The actual value + The message to display in case of failure + + + + Verifies that two values are equal. If they are not, then an + is thrown. + + The expected value + The actual value + + + + Verifies that two doubles are equal considering a delta. If the + expected value is infinity then the delta value is ignored. If + they are not equal then an is + thrown. + + The expected value + The actual value + The maximum acceptable difference between the + the expected and the actual + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Verifies that two doubles are equal considering a delta. If the + expected value is infinity then the delta value is ignored. If + they are not equal then an is + thrown. + + The expected value + The actual value + The maximum acceptable difference between the + the expected and the actual + The message to display in case of failure + + + + Verifies that two doubles are equal considering a delta. If the + expected value is infinity then the delta value is ignored. If + they are not equal then an is + thrown. + + The expected value + The actual value + The maximum acceptable difference between the + the expected and the actual + + + + Verifies that two doubles are equal considering a delta. If the + expected value is infinity then the delta value is ignored. If + they are not equal then an is + thrown. + + The expected value + The actual value + The maximum acceptable difference between the + the expected and the actual + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Verifies that two doubles are equal considering a delta. If the + expected value is infinity then the delta value is ignored. If + they are not equal then an is + thrown. + + The expected value + The actual value + The maximum acceptable difference between the + the expected and the actual + The message to display in case of failure + + + + Verifies that two doubles are equal considering a delta. If the + expected value is infinity then the delta value is ignored. If + they are not equal then an is + thrown. + + The expected value + The actual value + The maximum acceptable difference between the + the expected and the actual + + + + Verifies that two objects are equal. Two objects are considered + equal if both are null, or if both have the same value. NUnit + has special semantics for some object types. + If they are not equal an is thrown. + + The value that is expected + The actual value + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Verifies that two objects are equal. Two objects are considered + equal if both are null, or if both have the same value. NUnit + has special semantics for some object types. + If they are not equal an is thrown. + + The value that is expected + The actual value + The message to display in case of failure + + + + Verifies that two objects are equal. Two objects are considered + equal if both are null, or if both have the same value. NUnit + has special semantics for some object types. + If they are not equal an is thrown. + + The value that is expected + The actual value + + + + Verifies that two values are not equal. If they are equal, then an + is thrown. + + The expected value + The actual value + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Verifies that two values are not equal. If they are equal, then an + is thrown. + + The expected value + The actual value + The message to display in case of failure + + + + Verifies that two values are not equal. If they are equal, then an + is thrown. + + The expected value + The actual value + + + + Verifies that two values are not equal. If they are equal, then an + is thrown. + + The expected value + The actual value + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Verifies that two values are not equal. If they are equal, then an + is thrown. + + The expected value + The actual value + The message to display in case of failure + + + + Verifies that two values are not equal. If they are equal, then an + is thrown. + + The expected value + The actual value + + + + Verifies that two values are not equal. If they are equal, then an + is thrown. + + The expected value + The actual value + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Verifies that two values are not equal. If they are equal, then an + is thrown. + + The expected value + The actual value + The message to display in case of failure + + + + Verifies that two values are not equal. If they are equal, then an + is thrown. + + The expected value + The actual value + + + + Verifies that two values are not equal. If they are equal, then an + is thrown. + + The expected value + The actual value + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Verifies that two values are not equal. If they are equal, then an + is thrown. + + The expected value + The actual value + The message to display in case of failure + + + + Verifies that two values are not equal. If they are equal, then an + is thrown. + + The expected value + The actual value + + + + Verifies that two values are not equal. If they are equal, then an + is thrown. + + The expected value + The actual value + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Verifies that two values are not equal. If they are equal, then an + is thrown. + + The expected value + The actual value + The message to display in case of failure + + + + Verifies that two values are not equal. If they are equal, then an + is thrown. + + The expected value + The actual value + + + + Verifies that two values are not equal. If they are equal, then an + is thrown. + + The expected value + The actual value + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Verifies that two values are not equal. If they are equal, then an + is thrown. + + The expected value + The actual value + The message to display in case of failure + + + + Verifies that two values are not equal. If they are equal, then an + is thrown. + + The expected value + The actual value + + + + Verifies that two values are not equal. If they are equal, then an + is thrown. + + The expected value + The actual value + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Verifies that two values are not equal. If they are equal, then an + is thrown. + + The expected value + The actual value + The message to display in case of failure + + + + Verifies that two values are not equal. If they are equal, then an + is thrown. + + The expected value + The actual value + + + + Verifies that two objects are not equal. Two objects are considered + equal if both are null, or if both have the same value. NUnit + has special semantics for some object types. + If they are equal an is thrown. + + The value that is expected + The actual value + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Verifies that two objects are not equal. Two objects are considered + equal if both are null, or if both have the same value. NUnit + has special semantics for some object types. + If they are equal an is thrown. + + The value that is expected + The actual value + The message to display in case of failure + + + + Verifies that two objects are not equal. Two objects are considered + equal if both are null, or if both have the same value. NUnit + has special semantics for some object types. + If they are equal an is thrown. + + The value that is expected + The actual value + + + + Asserts that two objects refer to the same object. If they + are not the same an is thrown. + + The expected object + The actual object + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Asserts that two objects refer to the same object. If they + are not the same an is thrown. + + The expected object + The actual object + The message to display in case of failure + + + + Asserts that two objects refer to the same object. If they + are not the same an is thrown. + + The expected object + The actual object + + + + Asserts that two objects do not refer to the same object. If they + are the same an is thrown. + + The expected object + The actual object + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Asserts that two objects do not refer to the same object. If they + are the same an is thrown. + + The expected object + The actual object + The message to display in case of failure + + + + Asserts that two objects do not refer to the same object. If they + are the same an is thrown. + + The expected object + The actual object + + + + Verifies that the first value is greater than the second + value. If it is not, then an + is thrown. + + The first value, expected to be greater + The second value, expected to be less + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Verifies that the first value is greater than the second + value. If it is not, then an + is thrown. + + The first value, expected to be greater + The second value, expected to be less + The message to display in case of failure + + + + Verifies that the first value is greater than the second + value. If it is not, then an + is thrown. + + The first value, expected to be greater + The second value, expected to be less + + + + Verifies that the first value is greater than the second + value. If it is not, then an + is thrown. + + The first value, expected to be greater + The second value, expected to be less + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Verifies that the first value is greater than the second + value. If it is not, then an + is thrown. + + The first value, expected to be greater + The second value, expected to be less + The message to display in case of failure + + + + Verifies that the first value is greater than the second + value. If it is not, then an + is thrown. + + The first value, expected to be greater + The second value, expected to be less + + + + Verifies that the first value is greater than the second + value. If it is not, then an + is thrown. + + The first value, expected to be greater + The second value, expected to be less + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Verifies that the first value is greater than the second + value. If it is not, then an + is thrown. + + The first value, expected to be greater + The second value, expected to be less + The message to display in case of failure + + + + Verifies that the first value is greater than the second + value. If it is not, then an + is thrown. + + The first value, expected to be greater + The second value, expected to be less + + + + Verifies that the first value is greater than the second + value. If it is not, then an + is thrown. + + The first value, expected to be greater + The second value, expected to be less + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Verifies that the first value is greater than the second + value. If it is not, then an + is thrown. + + The first value, expected to be greater + The second value, expected to be less + The message to display in case of failure + + + + Verifies that the first value is greater than the second + value. If it is not, then an + is thrown. + + The first value, expected to be greater + The second value, expected to be less + + + + Verifies that the first value is greater than the second + value. If it is not, then an + is thrown. + + The first value, expected to be greater + The second value, expected to be less + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Verifies that the first value is greater than the second + value. If it is not, then an + is thrown. + + The first value, expected to be greater + The second value, expected to be less + The message to display in case of failure + + + + Verifies that the first value is greater than the second + value. If it is not, then an + is thrown. + + The first value, expected to be greater + The second value, expected to be less + + + + Verifies that the first value is greater than the second + value. If it is not, then an + is thrown. + + The first value, expected to be greater + The second value, expected to be less + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Verifies that the first value is greater than the second + value. If it is not, then an + is thrown. + + The first value, expected to be greater + The second value, expected to be less + The message to display in case of failure + + + + Verifies that the first value is greater than the second + value. If it is not, then an + is thrown. + + The first value, expected to be greater + The second value, expected to be less + + + + Verifies that the first value is greater than the second + value. If it is not, then an + is thrown. + + The first value, expected to be greater + The second value, expected to be less + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Verifies that the first value is greater than the second + value. If it is not, then an + is thrown. + + The first value, expected to be greater + The second value, expected to be less + The message to display in case of failure + + + + Verifies that the first value is greater than the second + value. If it is not, then an + is thrown. + + The first value, expected to be greater + The second value, expected to be less + + + + Verifies that the first value is greater than the second + value. If it is not, then an + is thrown. + + The first value, expected to be greater + The second value, expected to be less + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Verifies that the first value is greater than the second + value. If it is not, then an + is thrown. + + The first value, expected to be greater + The second value, expected to be less + The message to display in case of failure + + + + Verifies that the first value is greater than the second + value. If it is not, then an + is thrown. + + The first value, expected to be greater + The second value, expected to be less + + + + Verifies that the first value is less than the second + value. If it is not, then an + is thrown. + + The first value, expected to be less + The second value, expected to be greater + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Verifies that the first value is less than the second + value. If it is not, then an + is thrown. + + The first value, expected to be less + The second value, expected to be greater + The message to display in case of failure + + + + Verifies that the first value is less than the second + value. If it is not, then an + is thrown. + + The first value, expected to be less + The second value, expected to be greater + + + + Verifies that the first value is less than the second + value. If it is not, then an + is thrown. + + The first value, expected to be less + The second value, expected to be greater + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Verifies that the first value is less than the second + value. If it is not, then an + is thrown. + + The first value, expected to be less + The second value, expected to be greater + The message to display in case of failure + + + + Verifies that the first value is less than the second + value. If it is not, then an + is thrown. + + The first value, expected to be less + The second value, expected to be greater + + + + Verifies that the first value is less than the second + value. If it is not, then an + is thrown. + + The first value, expected to be less + The second value, expected to be greater + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Verifies that the first value is less than the second + value. If it is not, then an + is thrown. + + The first value, expected to be less + The second value, expected to be greater + The message to display in case of failure + + + + Verifies that the first value is less than the second + value. If it is not, then an + is thrown. + + The first value, expected to be less + The second value, expected to be greater + + + + Verifies that the first value is less than the second + value. If it is not, then an + is thrown. + + The first value, expected to be less + The second value, expected to be greater + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Verifies that the first value is less than the second + value. If it is not, then an + is thrown. + + The first value, expected to be less + The second value, expected to be greater + The message to display in case of failure + + + + Verifies that the first value is less than the second + value. If it is not, then an + is thrown. + + The first value, expected to be less + The second value, expected to be greater + + + + Verifies that the first value is less than the second + value. If it is not, then an + is thrown. + + The first value, expected to be less + The second value, expected to be greater + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Verifies that the first value is less than the second + value. If it is not, then an + is thrown. + + The first value, expected to be less + The second value, expected to be greater + The message to display in case of failure + + + + Verifies that the first value is less than the second + value. If it is not, then an + is thrown. + + The first value, expected to be less + The second value, expected to be greater + + + + Verifies that the first value is less than the second + value. If it is not, then an + is thrown. + + The first value, expected to be less + The second value, expected to be greater + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Verifies that the first value is less than the second + value. If it is not, then an + is thrown. + + The first value, expected to be less + The second value, expected to be greater + The message to display in case of failure + + + + Verifies that the first value is less than the second + value. If it is not, then an + is thrown. + + The first value, expected to be less + The second value, expected to be greater + + + + Verifies that the first value is less than the second + value. If it is not, then an + is thrown. + + The first value, expected to be less + The second value, expected to be greater + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Verifies that the first value is less than the second + value. If it is not, then an + is thrown. + + The first value, expected to be less + The second value, expected to be greater + The message to display in case of failure + + + + Verifies that the first value is less than the second + value. If it is not, then an + is thrown. + + The first value, expected to be less + The second value, expected to be greater + + + + Verifies that the first value is less than the second + value. If it is not, then an + is thrown. + + The first value, expected to be less + The second value, expected to be greater + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Verifies that the first value is less than the second + value. If it is not, then an + is thrown. + + The first value, expected to be less + The second value, expected to be greater + The message to display in case of failure + + + + Verifies that the first value is less than the second + value. If it is not, then an + is thrown. + + The first value, expected to be less + The second value, expected to be greater + + + + Verifies that the first value is greater than or equal tothe second + value. If it is not, then an + is thrown. + + The first value, expected to be greater + The second value, expected to be less + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Verifies that the first value is greater than or equal tothe second + value. If it is not, then an + is thrown. + + The first value, expected to be greater + The second value, expected to be less + The message to display in case of failure + + + + Verifies that the first value is greater than or equal tothe second + value. If it is not, then an + is thrown. + + The first value, expected to be greater + The second value, expected to be less + + + + Verifies that the first value is greater than or equal tothe second + value. If it is not, then an + is thrown. + + The first value, expected to be greater + The second value, expected to be less + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Verifies that the first value is greater than or equal tothe second + value. If it is not, then an + is thrown. + + The first value, expected to be greater + The second value, expected to be less + The message to display in case of failure + + + + Verifies that the first value is greater than or equal tothe second + value. If it is not, then an + is thrown. + + The first value, expected to be greater + The second value, expected to be less + + + + Verifies that the first value is greater than or equal tothe second + value. If it is not, then an + is thrown. + + The first value, expected to be greater + The second value, expected to be less + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Verifies that the first value is greater than or equal tothe second + value. If it is not, then an + is thrown. + + The first value, expected to be greater + The second value, expected to be less + The message to display in case of failure + + + + Verifies that the first value is greater than or equal tothe second + value. If it is not, then an + is thrown. + + The first value, expected to be greater + The second value, expected to be less + + + + Verifies that the first value is greater than or equal tothe second + value. If it is not, then an + is thrown. + + The first value, expected to be greater + The second value, expected to be less + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Verifies that the first value is greater than or equal tothe second + value. If it is not, then an + is thrown. + + The first value, expected to be greater + The second value, expected to be less + The message to display in case of failure + + + + Verifies that the first value is greater than or equal tothe second + value. If it is not, then an + is thrown. + + The first value, expected to be greater + The second value, expected to be less + + + + Verifies that the first value is greater than or equal tothe second + value. If it is not, then an + is thrown. + + The first value, expected to be greater + The second value, expected to be less + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Verifies that the first value is greater than or equal tothe second + value. If it is not, then an + is thrown. + + The first value, expected to be greater + The second value, expected to be less + The message to display in case of failure + + + + Verifies that the first value is greater than or equal tothe second + value. If it is not, then an + is thrown. + + The first value, expected to be greater + The second value, expected to be less + + + + Verifies that the first value is greater than or equal tothe second + value. If it is not, then an + is thrown. + + The first value, expected to be greater + The second value, expected to be less + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Verifies that the first value is greater than or equal tothe second + value. If it is not, then an + is thrown. + + The first value, expected to be greater + The second value, expected to be less + The message to display in case of failure + + + + Verifies that the first value is greater than or equal tothe second + value. If it is not, then an + is thrown. + + The first value, expected to be greater + The second value, expected to be less + + + + Verifies that the first value is greater than or equal tothe second + value. If it is not, then an + is thrown. + + The first value, expected to be greater + The second value, expected to be less + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Verifies that the first value is greater than or equal tothe second + value. If it is not, then an + is thrown. + + The first value, expected to be greater + The second value, expected to be less + The message to display in case of failure + + + + Verifies that the first value is greater than or equal tothe second + value. If it is not, then an + is thrown. + + The first value, expected to be greater + The second value, expected to be less + + + + Verifies that the first value is greater than or equal tothe second + value. If it is not, then an + is thrown. + + The first value, expected to be greater + The second value, expected to be less + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Verifies that the first value is greater than or equal tothe second + value. If it is not, then an + is thrown. + + The first value, expected to be greater + The second value, expected to be less + The message to display in case of failure + + + + Verifies that the first value is greater than or equal tothe second + value. If it is not, then an + is thrown. + + The first value, expected to be greater + The second value, expected to be less + + + + Verifies that the first value is less than or equal to the second + value. If it is not, then an + is thrown. + + The first value, expected to be less + The second value, expected to be greater + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Verifies that the first value is less than or equal to the second + value. If it is not, then an + is thrown. + + The first value, expected to be less + The second value, expected to be greater + The message to display in case of failure + + + + Verifies that the first value is less than or equal to the second + value. If it is not, then an + is thrown. + + The first value, expected to be less + The second value, expected to be greater + + + + Verifies that the first value is less than or equal to the second + value. If it is not, then an + is thrown. + + The first value, expected to be less + The second value, expected to be greater + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Verifies that the first value is less than or equal to the second + value. If it is not, then an + is thrown. + + The first value, expected to be less + The second value, expected to be greater + The message to display in case of failure + + + + Verifies that the first value is less than or equal to the second + value. If it is not, then an + is thrown. + + The first value, expected to be less + The second value, expected to be greater + + + + Verifies that the first value is less than or equal to the second + value. If it is not, then an + is thrown. + + The first value, expected to be less + The second value, expected to be greater + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Verifies that the first value is less than or equal to the second + value. If it is not, then an + is thrown. + + The first value, expected to be less + The second value, expected to be greater + The message to display in case of failure + + + + Verifies that the first value is less than or equal to the second + value. If it is not, then an + is thrown. + + The first value, expected to be less + The second value, expected to be greater + + + + Verifies that the first value is less than or equal to the second + value. If it is not, then an + is thrown. + + The first value, expected to be less + The second value, expected to be greater + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Verifies that the first value is less than or equal to the second + value. If it is not, then an + is thrown. + + The first value, expected to be less + The second value, expected to be greater + The message to display in case of failure + + + + Verifies that the first value is less than or equal to the second + value. If it is not, then an + is thrown. + + The first value, expected to be less + The second value, expected to be greater + + + + Verifies that the first value is less than or equal to the second + value. If it is not, then an + is thrown. + + The first value, expected to be less + The second value, expected to be greater + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Verifies that the first value is less than or equal to the second + value. If it is not, then an + is thrown. + + The first value, expected to be less + The second value, expected to be greater + The message to display in case of failure + + + + Verifies that the first value is less than or equal to the second + value. If it is not, then an + is thrown. + + The first value, expected to be less + The second value, expected to be greater + + + + Verifies that the first value is less than or equal to the second + value. If it is not, then an + is thrown. + + The first value, expected to be less + The second value, expected to be greater + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Verifies that the first value is less than or equal to the second + value. If it is not, then an + is thrown. + + The first value, expected to be less + The second value, expected to be greater + The message to display in case of failure + + + + Verifies that the first value is less than or equal to the second + value. If it is not, then an + is thrown. + + The first value, expected to be less + The second value, expected to be greater + + + + Verifies that the first value is less than or equal to the second + value. If it is not, then an + is thrown. + + The first value, expected to be less + The second value, expected to be greater + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Verifies that the first value is less than or equal to the second + value. If it is not, then an + is thrown. + + The first value, expected to be less + The second value, expected to be greater + The message to display in case of failure + + + + Verifies that the first value is less than or equal to the second + value. If it is not, then an + is thrown. + + The first value, expected to be less + The second value, expected to be greater + + + + Verifies that the first value is less than or equal to the second + value. If it is not, then an + is thrown. + + The first value, expected to be less + The second value, expected to be greater + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Verifies that the first value is less than or equal to the second + value. If it is not, then an + is thrown. + + The first value, expected to be less + The second value, expected to be greater + The message to display in case of failure + + + + Verifies that the first value is less than or equal to the second + value. If it is not, then an + is thrown. + + The first value, expected to be less + The second value, expected to be greater + + + + Asserts that an object is contained in a list. + + The expected object + The list to be examined + The message to display in case of failure + Array of objects to be used in formatting the message + + + + Asserts that an object is contained in a list. + + The expected object + The list to be examined + The message to display in case of failure + + + + Asserts that an object is contained in a list. + + The expected object + The list to be examined + + + + Gets the number of assertions executed so far and + resets the counter to zero. + + + + + AssertionHelper is an optional base class for user tests, + allowing the use of shorter names for constraints and + asserts and avoiding conflict with the definition of + , from which it inherits much of its + behavior, in certain mock object frameworks. + + + + + Apply a constraint to an actual value, succeeding if the constraint + is satisfied and throwing an assertion exception on failure. Works + identically to Assert.That + + A Constraint to be applied + The actual value to test + + + + Apply a constraint to an actual value, succeeding if the constraint + is satisfied and throwing an assertion exception on failure. Works + identically to Assert.That. + + A Constraint to be applied + The actual value to test + The message that will be displayed on failure + + + + Apply a constraint to an actual value, succeeding if the constraint + is satisfied and throwing an assertion exception on failure. Works + identically to Assert.That + + A Constraint to be applied + The actual value to test + The message that will be displayed on failure + Arguments to be used in formatting the message + + + + Apply a constraint to an actual value, succeeding if the constraint + is satisfied and throwing an assertion exception on failure. + + A Constraint expression to be applied + An ActualValueDelegate returning the value to be tested + + + + Apply a constraint to an actual value, succeeding if the constraint + is satisfied and throwing an assertion exception on failure. + + A Constraint expression to be applied + An ActualValueDelegate returning the value to be tested + The message that will be displayed on failure + + + + Apply a constraint to an actual value, succeeding if the constraint + is satisfied and throwing an assertion exception on failure. + + An ActualValueDelegate returning the value to be tested + A Constraint expression to be applied + The message that will be displayed on failure + Arguments to be used in formatting the message + + + + Apply a constraint to a referenced value, succeeding if the constraint + is satisfied and throwing an assertion exception on failure. + + A Constraint to be applied + The actual value to test + + + + Apply a constraint to a referenced value, succeeding if the constraint + is satisfied and throwing an assertion exception on failure. + + A Constraint to be applied + The actual value to test + The message that will be displayed on failure + + + + Apply a constraint to a referenced value, succeeding if the constraint + is satisfied and throwing an assertion exception on failure. + + A Constraint to be applied + The actual value to test + The message that will be displayed on failure + Arguments to be used in formatting the message + + + + Asserts that a condition is true. If the condition is false the method throws + an . Works Identically to Assert.That. + + The evaluated condition + The message to display if the condition is false + Arguments to be used in formatting the message + + + + Asserts that a condition is true. If the condition is false the method throws + an . Works Identically to Assert.That. + + The evaluated condition + The message to display if the condition is false + + + + Asserts that a condition is true. If the condition is false the method throws + an . Works Identically Assert.That. + + The evaluated condition + + + + Asserts that the code represented by a delegate throws an exception + that satisfies the constraint provided. + + A TestDelegate to be executed + A ThrowsConstraint used in the test + + + + Returns a ListMapper based on a collection. + + The original collection + + + + + Provides static methods to express the assumptions + that must be met for a test to give a meaningful + result. If an assumption is not met, the test + should produce an inconclusive result. + + + + + The Equals method throws an AssertionException. This is done + to make sure there is no mistake by calling this function. + + + + + + + override the default ReferenceEquals to throw an AssertionException. This + implementation makes sure there is no mistake in calling this function + as part of Assert. + + + + + + + Apply a constraint to an actual value, succeeding if the constraint + is satisfied and throwing an InconclusiveException on failure. + + A Constraint expression to be applied + The actual value to test + + + + Apply a constraint to an actual value, succeeding if the constraint + is satisfied and throwing an InconclusiveException on failure. + + A Constraint expression to be applied + The actual value to test + The message that will be displayed on failure + + + + Apply a constraint to an actual value, succeeding if the constraint + is satisfied and throwing an InconclusiveException on failure. + + A Constraint expression to be applied + The actual value to test + The message that will be displayed on failure + Arguments to be used in formatting the message + + + + Apply a constraint to an actual value, succeeding if the constraint + is satisfied and throwing an InconclusiveException on failure. + + A Constraint expression to be applied + An ActualValueDelegate returning the value to be tested + + + + Apply a constraint to an actual value, succeeding if the constraint + is satisfied and throwing an InconclusiveException on failure. + + A Constraint expression to be applied + An ActualValueDelegate returning the value to be tested + The message that will be displayed on failure + + + + Apply a constraint to an actual value, succeeding if the constraint + is satisfied and throwing an InconclusiveException on failure. + + An ActualValueDelegate returning the value to be tested + A Constraint expression to be applied + The message that will be displayed on failure + Arguments to be used in formatting the message + + + + Apply a constraint to a referenced value, succeeding if the constraint + is satisfied and throwing an InconclusiveException on failure. + + A Constraint expression to be applied + The actual value to test + + + + Apply a constraint to a referenced value, succeeding if the constraint + is satisfied and throwing an InconclusiveException on failure. + + A Constraint expression to be applied + The actual value to test + The message that will be displayed on failure + + + + Apply a constraint to a referenced value, succeeding if the constraint + is satisfied and throwing an InconclusiveException on failure. + + A Constraint expression to be applied + The actual value to test + The message that will be displayed on failure + Arguments to be used in formatting the message + + + + Asserts that a condition is true. If the condition is false the method throws + an . + + The evaluated condition + The message to display if the condition is false + Arguments to be used in formatting the message + + + + Asserts that a condition is true. If the condition is false the method throws + an . + + The evaluated condition + The message to display if the condition is false + + + + Asserts that a condition is true. If the condition is false the + method throws an . + + The evaluated condition + + + + Asserts that the code represented by a delegate throws an exception + that satisfies the constraint provided. + + A TestDelegate to be executed + A ThrowsConstraint used in the test + + + + A set of Assert methods operationg on one or more collections + + + + + The Equals method throws an AssertionException. This is done + to make sure there is no mistake by calling this function. + + + + + + + override the default ReferenceEquals to throw an AssertionException. This + implementation makes sure there is no mistake in calling this function + as part of Assert. + + + + + + + Asserts that all items contained in collection are of the type specified by expectedType. + + IEnumerable containing objects to be considered + System.Type that all objects in collection must be instances of + + + + Asserts that all items contained in collection are of the type specified by expectedType. + + IEnumerable containing objects to be considered + System.Type that all objects in collection must be instances of + The message that will be displayed on failure + + + + Asserts that all items contained in collection are of the type specified by expectedType. + + IEnumerable containing objects to be considered + System.Type that all objects in collection must be instances of + The message that will be displayed on failure + Arguments to be used in formatting the message + + + + Asserts that all items contained in collection are not equal to null. + + IEnumerable containing objects to be considered + + + + Asserts that all items contained in collection are not equal to null. + + IEnumerable containing objects to be considered + The message that will be displayed on failure + + + + Asserts that all items contained in collection are not equal to null. + + IEnumerable of objects to be considered + The message that will be displayed on failure + Arguments to be used in formatting the message + + + + Ensures that every object contained in collection exists within the collection + once and only once. + + IEnumerable of objects to be considered + + + + Ensures that every object contained in collection exists within the collection + once and only once. + + IEnumerable of objects to be considered + The message that will be displayed on failure + + + + Ensures that every object contained in collection exists within the collection + once and only once. + + IEnumerable of objects to be considered + The message that will be displayed on failure + Arguments to be used in formatting the message + + + + Asserts that expected and actual are exactly equal. The collections must have the same count, + and contain the exact same objects in the same order. + + The first IEnumerable of objects to be considered + The second IEnumerable of objects to be considered + + + + Asserts that expected and actual are exactly equal. The collections must have the same count, + and contain the exact same objects in the same order. + If comparer is not null then it will be used to compare the objects. + + The first IEnumerable of objects to be considered + The second IEnumerable of objects to be considered + The IComparer to use in comparing objects from each IEnumerable + + + + Asserts that expected and actual are exactly equal. The collections must have the same count, + and contain the exact same objects in the same order. + + The first IEnumerable of objects to be considered + The second IEnumerable of objects to be considered + The message that will be displayed on failure + + + + Asserts that expected and actual are exactly equal. The collections must have the same count, + and contain the exact same objects in the same order. + If comparer is not null then it will be used to compare the objects. + + The first IEnumerable of objects to be considered + The second IEnumerable of objects to be considered + The IComparer to use in comparing objects from each IEnumerable + The message that will be displayed on failure + + + + Asserts that expected and actual are exactly equal. The collections must have the same count, + and contain the exact same objects in the same order. + + The first IEnumerable of objects to be considered + The second IEnumerable of objects to be considered + The message that will be displayed on failure + Arguments to be used in formatting the message + + + + Asserts that expected and actual are exactly equal. The collections must have the same count, + and contain the exact same objects in the same order. + If comparer is not null then it will be used to compare the objects. + + The first IEnumerable of objects to be considered + The second IEnumerable of objects to be considered + The IComparer to use in comparing objects from each IEnumerable + The message that will be displayed on failure + Arguments to be used in formatting the message + + + + Asserts that expected and actual are equivalent, containing the same objects but the match may be in any order. + + The first IEnumerable of objects to be considered + The second IEnumerable of objects to be considered + + + + Asserts that expected and actual are equivalent, containing the same objects but the match may be in any order. + + The first IEnumerable of objects to be considered + The second IEnumerable of objects to be considered + The message that will be displayed on failure + + + + Asserts that expected and actual are equivalent, containing the same objects but the match may be in any order. + + The first IEnumerable of objects to be considered + The second IEnumerable of objects to be considered + The message that will be displayed on failure + Arguments to be used in formatting the message + + + + Asserts that expected and actual are not exactly equal. + + The first IEnumerable of objects to be considered + The second IEnumerable of objects to be considered + + + + Asserts that expected and actual are not exactly equal. + If comparer is not null then it will be used to compare the objects. + + The first IEnumerable of objects to be considered + The second IEnumerable of objects to be considered + The IComparer to use in comparing objects from each IEnumerable + + + + Asserts that expected and actual are not exactly equal. + + The first IEnumerable of objects to be considered + The second IEnumerable of objects to be considered + The message that will be displayed on failure + + + + Asserts that expected and actual are not exactly equal. + If comparer is not null then it will be used to compare the objects. + + The first IEnumerable of objects to be considered + The second IEnumerable of objects to be considered + The IComparer to use in comparing objects from each IEnumerable + The message that will be displayed on failure + + + + Asserts that expected and actual are not exactly equal. + + The first IEnumerable of objects to be considered + The second IEnumerable of objects to be considered + The message that will be displayed on failure + Arguments to be used in formatting the message + + + + Asserts that expected and actual are not exactly equal. + If comparer is not null then it will be used to compare the objects. + + The first IEnumerable of objects to be considered + The second IEnumerable of objects to be considered + The IComparer to use in comparing objects from each IEnumerable + The message that will be displayed on failure + Arguments to be used in formatting the message + + + + Asserts that expected and actual are not equivalent. + + The first IEnumerable of objects to be considered + The second IEnumerable of objects to be considered + + + + Asserts that expected and actual are not equivalent. + + The first IEnumerable of objects to be considered + The second IEnumerable of objects to be considered + The message that will be displayed on failure + + + + Asserts that expected and actual are not equivalent. + + The first IEnumerable of objects to be considered + The second IEnumerable of objects to be considered + The message that will be displayed on failure + Arguments to be used in formatting the message + + + + Asserts that collection contains actual as an item. + + IEnumerable of objects to be considered + Object to be found within collection + + + + Asserts that collection contains actual as an item. + + IEnumerable of objects to be considered + Object to be found within collection + The message that will be displayed on failure + + + + Asserts that collection contains actual as an item. + + IEnumerable of objects to be considered + Object to be found within collection + The message that will be displayed on failure + Arguments to be used in formatting the message + + + + Asserts that collection does not contain actual as an item. + + IEnumerable of objects to be considered + Object that cannot exist within collection + + + + Asserts that collection does not contain actual as an item. + + IEnumerable of objects to be considered + Object that cannot exist within collection + The message that will be displayed on failure + + + + Asserts that collection does not contain actual as an item. + + IEnumerable of objects to be considered + Object that cannot exist within collection + The message that will be displayed on failure + Arguments to be used in formatting the message + + + + Asserts that superset is not a subject of subset. + + The IEnumerable superset to be considered + The IEnumerable subset to be considered + + + + Asserts that superset is not a subject of subset. + + The IEnumerable superset to be considered + The IEnumerable subset to be considered + The message that will be displayed on failure + + + + Asserts that superset is not a subject of subset. + + The IEnumerable superset to be considered + The IEnumerable subset to be considered + The message that will be displayed on failure + Arguments to be used in formatting the message + + + + Asserts that superset is a subset of subset. + + The IEnumerable superset to be considered + The IEnumerable subset to be considered + + + + Asserts that superset is a subset of subset. + + The IEnumerable superset to be considered + The IEnumerable subset to be considered + The message that will be displayed on failure + + + + Asserts that superset is a subset of subset. + + The IEnumerable superset to be considered + The IEnumerable subset to be considered + The message that will be displayed on failure + Arguments to be used in formatting the message + + + + Assert that an array, list or other collection is empty + + An array, list or other collection implementing IEnumerable + The message to be displayed on failure + Arguments to be used in formatting the message + + + + Assert that an array, list or other collection is empty + + An array, list or other collection implementing IEnumerable + The message to be displayed on failure + + + + Assert that an array,list or other collection is empty + + An array, list or other collection implementing IEnumerable + + + + Assert that an array, list or other collection is empty + + An array, list or other collection implementing IEnumerable + The message to be displayed on failure + Arguments to be used in formatting the message + + + + Assert that an array, list or other collection is empty + + An array, list or other collection implementing IEnumerable + The message to be displayed on failure + + + + Assert that an array,list or other collection is empty + + An array, list or other collection implementing IEnumerable + + + + Assert that an array, list or other collection is ordered + + An array, list or other collection implementing IEnumerable + The message to be displayed on failure + Arguments to be used in formatting the message + + + + Assert that an array, list or other collection is ordered + + An array, list or other collection implementing IEnumerable + The message to be displayed on failure + + + + Assert that an array, list or other collection is ordered + + An array, list or other collection implementing IEnumerable + + + + Assert that an array, list or other collection is ordered + + An array, list or other collection implementing IEnumerable + A custom comparer to perform the comparisons + The message to be displayed on failure + Arguments to be used in formatting the message + + + + Assert that an array, list or other collection is ordered + + An array, list or other collection implementing IEnumerable + A custom comparer to perform the comparisons + The message to be displayed on failure + + + + Assert that an array, list or other collection is ordered + + An array, list or other collection implementing IEnumerable + A custom comparer to perform the comparisons + + + + Static helper class used in the constraint-based syntax + + + + + Creates a new SubstringConstraint + + The value of the substring + A SubstringConstraint + + + + Creates a new CollectionContainsConstraint. + + The item that should be found. + A new CollectionContainsConstraint + + + + Summary description for DirectoryAssert + + + + + The Equals method throws an AssertionException. This is done + to make sure there is no mistake by calling this function. + + + + + + + override the default ReferenceEquals to throw an AssertionException. This + implementation makes sure there is no mistake in calling this function + as part of Assert. + + + + + + + We don't actually want any instances of this object, but some people + like to inherit from it to add other static methods. Hence, the + protected constructor disallows any instances of this object. + + + + + Verifies that two directories are equal. Two directories are considered + equal if both are null, or if both have the same value byte for byte. + If they are not equal an is thrown. + + A directory containing the value that is expected + A directory containing the actual value + The message to display if directories are not equal + Arguments to be used in formatting the message + + + + Verifies that two directories are equal. Two directories are considered + equal if both are null, or if both have the same value byte for byte. + If they are not equal an is thrown. + + A directory containing the value that is expected + A directory containing the actual value + The message to display if directories are not equal + + + + Verifies that two directories are equal. Two directories are considered + equal if both are null, or if both have the same value byte for byte. + If they are not equal an is thrown. + + A directory containing the value that is expected + A directory containing the actual value + + + + Verifies that two directories are equal. Two directories are considered + equal if both are null, or if both have the same value byte for byte. + If they are not equal an is thrown. + + A directory path string containing the value that is expected + A directory path string containing the actual value + The message to display if directories are not equal + Arguments to be used in formatting the message + + + + Verifies that two directories are equal. Two directories are considered + equal if both are null, or if both have the same value byte for byte. + If they are not equal an is thrown. + + A directory path string containing the value that is expected + A directory path string containing the actual value + The message to display if directories are not equal + + + + Verifies that two directories are equal. Two directories are considered + equal if both are null, or if both have the same value byte for byte. + If they are not equal an is thrown. + + A directory path string containing the value that is expected + A directory path string containing the actual value + + + + Asserts that two directories are not equal. If they are equal + an is thrown. + + A directory containing the value that is expected + A directory containing the actual value + The message to display if directories are not equal + Arguments to be used in formatting the message + + + + Asserts that two directories are not equal. If they are equal + an is thrown. + + A directory containing the value that is expected + A directory containing the actual value + The message to display if directories are not equal + + + + Asserts that two directories are not equal. If they are equal + an is thrown. + + A directory containing the value that is expected + A directory containing the actual value + + + + Asserts that two directories are not equal. If they are equal + an is thrown. + + A directory path string containing the value that is expected + A directory path string containing the actual value + The message to display if directories are equal + Arguments to be used in formatting the message + + + + Asserts that two directories are not equal. If they are equal + an is thrown. + + A directory path string containing the value that is expected + A directory path string containing the actual value + The message to display if directories are equal + + + + Asserts that two directories are not equal. If they are equal + an is thrown. + + A directory path string containing the value that is expected + A directory path string containing the actual value + + + + Asserts that the directory is empty. If it is not empty + an is thrown. + + A directory to search + The message to display if directories are not equal + Arguments to be used in formatting the message + + + + Asserts that the directory is empty. If it is not empty + an is thrown. + + A directory to search + The message to display if directories are not equal + + + + Asserts that the directory is empty. If it is not empty + an is thrown. + + A directory to search + + + + Asserts that the directory is empty. If it is not empty + an is thrown. + + A directory to search + The message to display if directories are not equal + Arguments to be used in formatting the message + + + + Asserts that the directory is empty. If it is not empty + an is thrown. + + A directory to search + The message to display if directories are not equal + + + + Asserts that the directory is empty. If it is not empty + an is thrown. + + A directory to search + + + + Asserts that the directory is not empty. If it is empty + an is thrown. + + A directory to search + The message to display if directories are not equal + Arguments to be used in formatting the message + + + + Asserts that the directory is not empty. If it is empty + an is thrown. + + A directory to search + The message to display if directories are not equal + + + + Asserts that the directory is not empty. If it is empty + an is thrown. + + A directory to search + + + + Asserts that the directory is not empty. If it is empty + an is thrown. + + A directory to search + The message to display if directories are not equal + Arguments to be used in formatting the message + + + + Asserts that the directory is not empty. If it is empty + an is thrown. + + A directory to search + The message to display if directories are not equal + + + + Asserts that the directory is not empty. If it is empty + an is thrown. + + A directory to search + + + + Asserts that path contains actual as a subdirectory or + an is thrown. + + A directory to search + sub-directory asserted to exist under directory + The message to display if directory is not within the path + Arguments to be used in formatting the message + + + + Asserts that path contains actual as a subdirectory or + an is thrown. + + A directory to search + sub-directory asserted to exist under directory + The message to display if directory is not within the path + + + + Asserts that path contains actual as a subdirectory or + an is thrown. + + A directory to search + sub-directory asserted to exist under directory + + + + Asserts that path contains actual as a subdirectory or + an is thrown. + + A directory to search + sub-directory asserted to exist under directory + The message to display if directory is not within the path + Arguments to be used in formatting the message + + + + Asserts that path contains actual as a subdirectory or + an is thrown. + + A directory to search + sub-directory asserted to exist under directory + The message to display if directory is not within the path + + + + Asserts that path contains actual as a subdirectory or + an is thrown. + + A directory to search + sub-directory asserted to exist under directory + + + + Asserts that path does not contain actual as a subdirectory or + an is thrown. + + A directory to search + sub-directory asserted to exist under directory + The message to display if directory is not within the path + Arguments to be used in formatting the message + + + + Asserts that path does not contain actual as a subdirectory or + an is thrown. + + A directory to search + sub-directory asserted to exist under directory + The message to display if directory is not within the path + + + + Asserts that path does not contain actual as a subdirectory or + an is thrown. + + A directory to search + sub-directory asserted to exist under directory + + + + Asserts that path does not contain actual as a subdirectory or + an is thrown. + + A directory to search + sub-directory asserted to exist under directory + The message to display if directory is not within the path + Arguments to be used in formatting the message + + + + Asserts that path does not contain actual as a subdirectory or + an is thrown. + + A directory to search + sub-directory asserted to exist under directory + The message to display if directory is not within the path + + + + Asserts that path does not contain actual as a subdirectory or + an is thrown. + + A directory to search + sub-directory asserted to exist under directory + + + + Summary description for FileAssert. + + + + + The Equals method throws an AssertionException. This is done + to make sure there is no mistake by calling this function. + + + + + + + override the default ReferenceEquals to throw an AssertionException. This + implementation makes sure there is no mistake in calling this function + as part of Assert. + + + + + + + We don't actually want any instances of this object, but some people + like to inherit from it to add other static methods. Hence, the + protected constructor disallows any instances of this object. + + + + + Verifies that two Streams are equal. Two Streams are considered + equal if both are null, or if both have the same value byte for byte. + If they are not equal an is thrown. + + The expected Stream + The actual Stream + The message to display if Streams are not equal + Arguments to be used in formatting the message + + + + Verifies that two Streams are equal. Two Streams are considered + equal if both are null, or if both have the same value byte for byte. + If they are not equal an is thrown. + + The expected Stream + The actual Stream + The message to display if objects are not equal + + + + Verifies that two Streams are equal. Two Streams are considered + equal if both are null, or if both have the same value byte for byte. + If they are not equal an is thrown. + + The expected Stream + The actual Stream + + + + Verifies that two files are equal. Two files are considered + equal if both are null, or if both have the same value byte for byte. + If they are not equal an is thrown. + + A file containing the value that is expected + A file containing the actual value + The message to display if Streams are not equal + Arguments to be used in formatting the message + + + + Verifies that two files are equal. Two files are considered + equal if both are null, or if both have the same value byte for byte. + If they are not equal an is thrown. + + A file containing the value that is expected + A file containing the actual value + The message to display if objects are not equal + + + + Verifies that two files are equal. Two files are considered + equal if both are null, or if both have the same value byte for byte. + If they are not equal an is thrown. + + A file containing the value that is expected + A file containing the actual value + + + + Verifies that two files are equal. Two files are considered + equal if both are null, or if both have the same value byte for byte. + If they are not equal an is thrown. + + The path to a file containing the value that is expected + The path to a file containing the actual value + The message to display if Streams are not equal + Arguments to be used in formatting the message + + + + Verifies that two files are equal. Two files are considered + equal if both are null, or if both have the same value byte for byte. + If they are not equal an is thrown. + + The path to a file containing the value that is expected + The path to a file containing the actual value + The message to display if objects are not equal + + + + Verifies that two files are equal. Two files are considered + equal if both are null, or if both have the same value byte for byte. + If they are not equal an is thrown. + + The path to a file containing the value that is expected + The path to a file containing the actual value + + + + Asserts that two Streams are not equal. If they are equal + an is thrown. + + The expected Stream + The actual Stream + The message to be displayed when the two Stream are the same. + Arguments to be used in formatting the message + + + + Asserts that two Streams are not equal. If they are equal + an is thrown. + + The expected Stream + The actual Stream + The message to be displayed when the Streams are the same. + + + + Asserts that two Streams are not equal. If they are equal + an is thrown. + + The expected Stream + The actual Stream + + + + Asserts that two files are not equal. If they are equal + an is thrown. + + A file containing the value that is expected + A file containing the actual value + The message to display if Streams are not equal + Arguments to be used in formatting the message + + + + Asserts that two files are not equal. If they are equal + an is thrown. + + A file containing the value that is expected + A file containing the actual value + The message to display if objects are not equal + + + + Asserts that two files are not equal. If they are equal + an is thrown. + + A file containing the value that is expected + A file containing the actual value + + + + Asserts that two files are not equal. If they are equal + an is thrown. + + The path to a file containing the value that is expected + The path to a file containing the actual value + The message to display if Streams are not equal + Arguments to be used in formatting the message + + + + Asserts that two files are not equal. If they are equal + an is thrown. + + The path to a file containing the value that is expected + The path to a file containing the actual value + The message to display if objects are not equal + + + + Asserts that two files are not equal. If they are equal + an is thrown. + + The path to a file containing the value that is expected + The path to a file containing the actual value + + + + GlobalSettings is a place for setting default values used + by the framework in performing asserts. + + + + + Default tolerance for floating point equality + + + + + Helper class with properties and methods that supply + a number of constraints used in Asserts. + + + + + Returns a ConstraintExpression, which will apply + the following constraint to all members of a collection, + succeeding only if a specified number of them succeed. + + + + + Returns a new PropertyConstraintExpression, which will either + test for the existence of the named property on the object + being tested or apply any following constraint to that property. + + + + + Returns a new AttributeConstraint checking for the + presence of a particular attribute on an object. + + + + + Returns a new AttributeConstraint checking for the + presence of a particular attribute on an object. + + + + + Returns a new CollectionContainsConstraint checking for the + presence of a particular object in the collection. + + + + + Returns a ConstraintExpression that negates any + following constraint. + + + + + Returns a ConstraintExpression, which will apply + the following constraint to all members of a collection, + succeeding if all of them succeed. + + + + + Returns a ConstraintExpression, which will apply + the following constraint to all members of a collection, + succeeding if at least one of them succeeds. + + + + + Returns a ConstraintExpression, which will apply + the following constraint to all members of a collection, + succeeding if all of them fail. + + + + + Returns a new ConstraintExpression, which will apply the following + constraint to the Length property of the object being tested. + + + + + Returns a new ConstraintExpression, which will apply the following + constraint to the Count property of the object being tested. + + + + + Returns a new ConstraintExpression, which will apply the following + constraint to the Message property of the object being tested. + + + + + Returns a new ConstraintExpression, which will apply the following + constraint to the InnerException property of the object being tested. + + + + + Interface implemented by a user fixture in order to + validate any expected exceptions. It is only called + for test methods marked with the ExpectedException + attribute. + + + + + Method to handle an expected exception + + The exception to be handled + + + + Helper class with properties and methods that supply + a number of constraints used in Asserts. + + + + + Returns a constraint that tests two items for equality + + + + + Returns a constraint that tests that two references are the same object + + + + + Returns a constraint that tests whether the + actual value is greater than the suppled argument + + + + + Returns a constraint that tests whether the + actual value is greater than or equal to the suppled argument + + + + + Returns a constraint that tests whether the + actual value is greater than or equal to the suppled argument + + + + + Returns a constraint that tests whether the + actual value is less than the suppled argument + + + + + Returns a constraint that tests whether the + actual value is less than or equal to the suppled argument + + + + + Returns a constraint that tests whether the + actual value is less than or equal to the suppled argument + + + + + Returns a constraint that tests whether the actual + value is of the exact type supplied as an argument. + + + + + Returns a constraint that tests whether the actual + value is of the exact type supplied as an argument. + + + + + Returns a constraint that tests whether the actual value + is of the type supplied as an argument or a derived type. + + + + + Returns a constraint that tests whether the actual value + is of the type supplied as an argument or a derived type. + + + + + Returns a constraint that tests whether the actual value + is of the type supplied as an argument or a derived type. + + + + + Returns a constraint that tests whether the actual value + is of the type supplied as an argument or a derived type. + + + + + Returns a constraint that tests whether the actual value + is assignable from the type supplied as an argument. + + + + + Returns a constraint that tests whether the actual value + is assignable from the type supplied as an argument. + + + + + Returns a constraint that tests whether the actual value + is assignable from the type supplied as an argument. + + + + + Returns a constraint that tests whether the actual value + is assignable from the type supplied as an argument. + + + + + Returns a constraint that tests whether the actual value + is a collection containing the same elements as the + collection supplied as an argument. + + + + + Returns a constraint that tests whether the actual value + is a subset of the collection supplied as an argument. + + + + + Returns a constraint that succeeds if the actual + value contains the substring supplied as an argument. + + + + + Returns a constraint that succeeds if the actual + value starts with the substring supplied as an argument. + + + + + Returns a constraint that succeeds if the actual + value ends with the substring supplied as an argument. + + + + + Returns a constraint that succeeds if the actual + value matches the Regex pattern supplied as an argument. + + + + + Returns a constraint that tests whether the path provided + is the same as an expected path after canonicalization. + + + + + Returns a constraint that tests whether the path provided + is the same path or under an expected path after canonicalization. + + + + + Returns a constraint that tests whether the path provided + is the same path or under an expected path after canonicalization. + + + + + Returns a constraint that tests whether the actual value falls + within a specified range. + + + + + Returns a ConstraintExpression that negates any + following constraint. + + + + + Returns a ConstraintExpression, which will apply + the following constraint to all members of a collection, + succeeding if all of them succeed. + + + + + Returns a constraint that tests for null + + + + + Returns a constraint that tests for True + + + + + Returns a constraint that tests for False + + + + + Returns a constraint that tests for a positive value + + + + + Returns a constraint that tests for a negative value + + + + + Returns a constraint that tests for NaN + + + + + Returns a constraint that tests for empty + + + + + Returns a constraint that tests whether a collection + contains all unique items. + + + + + Returns a constraint that tests whether an object graph is serializable in binary format. + + + + + Returns a constraint that tests whether an object graph is serializable in xml format. + + + + + Returns a constraint that tests whether a collection is ordered + + + + + The Iz class is a synonym for Is intended for use in VB, + which regards Is as a keyword. + + + + + The List class is a helper class with properties and methods + that supply a number of constraints used with lists and collections. + + + + + List.Map returns a ListMapper, which can be used to map + the original collection to another collection. + + + + + + + ListMapper is used to transform a collection used as an actual argument + producing another collection to be used in the assertion. + + + + + Construct a ListMapper based on a collection + + The collection to be transformed + + + + Produces a collection containing all the values of a property + + The collection of property values + + + + + Randomizer returns a set of random values in a repeatable + way, to allow re-running of tests if necessary. + + + + + Get a randomizer for a particular member, returning + one that has already been created if it exists. + This ensures that the same values are generated + each time the tests are reloaded. + + + + + Get a randomizer for a particular parameter, returning + one that has already been created if it exists. + This ensures that the same values are generated + each time the tests are reloaded. + + + + + Construct a randomizer using a random seed + + + + + Construct a randomizer using a specified seed + + + + + Return an array of random doubles between 0.0 and 1.0. + + + + + + + Return an array of random doubles with values in a specified range. + + + + + Return an array of random ints with values in a specified range. + + + + + Get a random seed for use in creating a randomizer. + + + + + The SpecialValue enum is used to represent TestCase arguments + that cannot be used as arguments to an Attribute. + + + + + Null represents a null value, which cannot be used as an + argument to an attriute under .NET 1.x + + + + + Basic Asserts on strings. + + + + + The Equals method throws an AssertionException. This is done + to make sure there is no mistake by calling this function. + + + + + + + override the default ReferenceEquals to throw an AssertionException. This + implementation makes sure there is no mistake in calling this function + as part of Assert. + + + + + + + Asserts that a string is found within another string. + + The expected string + The string to be examined + The message to display in case of failure + Arguments used in formatting the message + + + + Asserts that a string is found within another string. + + The expected string + The string to be examined + The message to display in case of failure + + + + Asserts that a string is found within another string. + + The expected string + The string to be examined + + + + Asserts that a string is not found within another string. + + The expected string + The string to be examined + The message to display in case of failure + Arguments used in formatting the message + + + + Asserts that a string is found within another string. + + The expected string + The string to be examined + The message to display in case of failure + + + + Asserts that a string is found within another string. + + The expected string + The string to be examined + + + + Asserts that a string starts with another string. + + The expected string + The string to be examined + The message to display in case of failure + Arguments used in formatting the message + + + + Asserts that a string starts with another string. + + The expected string + The string to be examined + The message to display in case of failure + + + + Asserts that a string starts with another string. + + The expected string + The string to be examined + + + + Asserts that a string does not start with another string. + + The expected string + The string to be examined + The message to display in case of failure + Arguments used in formatting the message + + + + Asserts that a string does not start with another string. + + The expected string + The string to be examined + The message to display in case of failure + + + + Asserts that a string does not start with another string. + + The expected string + The string to be examined + + + + Asserts that a string ends with another string. + + The expected string + The string to be examined + The message to display in case of failure + Arguments used in formatting the message + + + + Asserts that a string ends with another string. + + The expected string + The string to be examined + The message to display in case of failure + + + + Asserts that a string ends with another string. + + The expected string + The string to be examined + + + + Asserts that a string does not end with another string. + + The expected string + The string to be examined + The message to display in case of failure + Arguments used in formatting the message + + + + Asserts that a string does not end with another string. + + The expected string + The string to be examined + The message to display in case of failure + + + + Asserts that a string does not end with another string. + + The expected string + The string to be examined + + + + Asserts that two strings are equal, without regard to case. + + The expected string + The actual string + The message to display in case of failure + Arguments used in formatting the message + + + + Asserts that two strings are equal, without regard to case. + + The expected string + The actual string + The message to display in case of failure + + + + Asserts that two strings are equal, without regard to case. + + The expected string + The actual string + + + + Asserts that two strings are not equal, without regard to case. + + The expected string + The actual string + The message to display in case of failure + Arguments used in formatting the message + + + + Asserts that two strings are Notequal, without regard to case. + + The expected string + The actual string + The message to display in case of failure + + + + Asserts that two strings are not equal, without regard to case. + + The expected string + The actual string + + + + Asserts that a string matches an expected regular expression pattern. + + The regex pattern to be matched + The actual string + The message to display in case of failure + Arguments used in formatting the message + + + + Asserts that a string matches an expected regular expression pattern. + + The regex pattern to be matched + The actual string + The message to display in case of failure + + + + Asserts that a string matches an expected regular expression pattern. + + The regex pattern to be matched + The actual string + + + + Asserts that a string does not match an expected regular expression pattern. + + The regex pattern to be used + The actual string + The message to display in case of failure + Arguments used in formatting the message + + + + Asserts that a string does not match an expected regular expression pattern. + + The regex pattern to be used + The actual string + The message to display in case of failure + + + + Asserts that a string does not match an expected regular expression pattern. + + The regex pattern to be used + The actual string + + + + The TestCaseData class represents a set of arguments + and other parameter info to be used for a parameterized + test case. It provides a number of instance modifiers + for use in initializing the test case. + + Note: Instance modifiers are getters that return + the same instance after modifying it's state. + + + + + The argument list to be provided to the test + + + + + The expected result to be returned + + + + + Set to true if this has an expected result + + + + + The expected exception Type + + + + + The FullName of the expected exception + + + + + The name to be used for the test + + + + + The description of the test + + + + + A dictionary of properties, used to add information + to tests without requiring the class to change. + + + + + If true, indicates that the test case is to be ignored + + + + + If true, indicates that the test case is marked explicit + + + + + The reason for ignoring a test case + + + + + Initializes a new instance of the class. + + The arguments. + + + + Initializes a new instance of the class. + + The argument. + + + + Initializes a new instance of the class. + + The first argument. + The second argument. + + + + Initializes a new instance of the class. + + The first argument. + The second argument. + The third argument. + + + + Sets the expected result for the test + + The expected result + A modified TestCaseData + + + + Sets the expected exception type for the test + + Type of the expected exception. + The modified TestCaseData instance + + + + Sets the expected exception type for the test + + FullName of the expected exception. + The modified TestCaseData instance + + + + Sets the name of the test case + + The modified TestCaseData instance + + + + Sets the description for the test case + being constructed. + + The description. + The modified TestCaseData instance. + + + + Applies a category to the test + + + + + + + Applies a named property to the test + + + + + + + + Applies a named property to the test + + + + + + + + Applies a named property to the test + + + + + + + + Ignores this TestCase. + + + + + + Ignores this TestCase, specifying the reason. + + The reason. + + + + + Marks this TestCase as Explicit + + + + + + Marks this TestCase as Explicit, specifying the reason. + + The reason. + + + + + Gets the argument list to be provided to the test + + + + + Gets the expected result + + + + + Returns true if the result has been set + + + + + Gets the expected exception Type + + + + + Gets the FullName of the expected exception + + + + + Gets the name to be used for the test + + + + + Gets the description of the test + + + + + Gets a value indicating whether this is ignored. + + true if ignored; otherwise, false. + + + + Gets a value indicating whether this is explicit. + + true if explicit; otherwise, false. + + + + Gets the ignore reason. + + The ignore reason. + + + + Gets a list of categories associated with this test. + + + + + Gets the property dictionary for this test + + + + + Provide the context information of the current test + + + + + Constructs a TestContext using the provided context dictionary + + A context dictionary + + + + Get the current test context. This is created + as needed. The user may save the context for + use within a test, but it should not be used + outside the test for which it is created. + + + + + Gets a TestAdapter representing the currently executing test in this context. + + + + + Gets a ResultAdapter representing the current result for the test + executing in this context. + + + + + Gets the directory containing the current test assembly. + + + + + Gets the directory to be used for outputing files created + by this test run. + + + + + TestAdapter adapts a Test for consumption by + the user test code. + + + + + Constructs a TestAdapter for this context + + The context dictionary + + + + The name of the test. + + + + + The FullName of the test + + + + + The properties of the test. + + + + + ResultAdapter adapts a TestResult for consumption by + the user test code. + + + + + Construct a ResultAdapter for a context + + The context holding the result + + + + The TestState of current test. This maps to the ResultState + used in nunit.core and is subject to change in the future. + + + + + The TestStatus of current test. This enum will be used + in future versions of NUnit and so is to be preferred + to the TestState value. + + + + + Provides details about a test + + + + + Creates an instance of TestDetails + + The fixture that the test is a member of, if available. + The method that implements the test, if available. + The full name of the test. + A string representing the type of test, e.g. "Test Case". + Indicates if the test represents a suite of tests. + + + + The fixture that the test is a member of, if available. + + + + + The method that implements the test, if available. + + + + + The full name of the test. + + + + + A string representing the type of test, e.g. "Test Case". + + + + + Indicates if the test represents a suite of tests. + + + + + The ResultState enum indicates the result of running a test + + + + + The result is inconclusive + + + + + The test was not runnable. + + + + + The test has been skipped. + + + + + The test has been ignored. + + + + + The test succeeded + + + + + The test failed + + + + + The test encountered an unexpected exception + + + + + The test was cancelled by the user + + + + + The TestStatus enum indicates the result of running a test + + + + + The test was inconclusive + + + + + The test has skipped + + + + + The test succeeded + + + + + The test failed + + + + + Helper class with static methods used to supply constraints + that operate on strings. + + + + + Returns a constraint that succeeds if the actual + value contains the substring supplied as an argument. + + + + + Returns a constraint that fails if the actual + value contains the substring supplied as an argument. + + + + + Returns a constraint that succeeds if the actual + value starts with the substring supplied as an argument. + + + + + Returns a constraint that fails if the actual + value starts with the substring supplied as an argument. + + + + + Returns a constraint that succeeds if the actual + value ends with the substring supplied as an argument. + + + + + Returns a constraint that fails if the actual + value ends with the substring supplied as an argument. + + + + + Returns a constraint that succeeds if the actual + value matches the Regex pattern supplied as an argument. + + + + + Returns a constraint that fails if the actual + value matches the pattern supplied as an argument. + + + + + Returns a ConstraintExpression, which will apply + the following constraint to all members of a collection, + succeeding if all of them succeed. + + + + + TextMessageWriter writes constraint descriptions and messages + in displayable form as a text stream. It tailors the display + of individual message components to form the standard message + format of NUnit assertion failure messages. + + + + + Prefix used for the expected value line of a message + + + + + Prefix used for the actual value line of a message + + + + + Length of a message prefix + + + + + Construct a TextMessageWriter + + + + + Construct a TextMessageWriter, specifying a user message + and optional formatting arguments. + + + + + + + Method to write single line message with optional args, usually + written to precede the general failure message, at a givel + indentation level. + + The indentation level of the message + The message to be written + Any arguments used in formatting the message + + + + Display Expected and Actual lines for a constraint. This + is called by MessageWriter's default implementation of + WriteMessageTo and provides the generic two-line display. + + The constraint that failed + + + + Display Expected and Actual lines for given values. This + method may be called by constraints that need more control over + the display of actual and expected values than is provided + by the default implementation. + + The expected value + The actual value causing the failure + + + + Display Expected and Actual lines for given values, including + a tolerance value on the expected line. + + The expected value + The actual value causing the failure + The tolerance within which the test was made + + + + Display the expected and actual string values on separate lines. + If the mismatch parameter is >=0, an additional line is displayed + line containing a caret that points to the mismatch point. + + The expected string value + The actual string value + The point at which the strings don't match or -1 + If true, case is ignored in string comparisons + If true, clip the strings to fit the max line length + + + + Writes the text for a connector. + + The connector. + + + + Writes the text for a predicate. + + The predicate. + + + + Write the text for a modifier. + + The modifier. + + + + Writes the text for an expected value. + + The expected value. + + + + Writes the text for an actual value. + + The actual value. + + + + Writes the text for a generalized value. + + The value. + + + + Writes the text for a collection value, + starting at a particular point, to a max length + + The collection containing elements to write. + The starting point of the elements to write + The maximum number of elements to write + + + + Write the generic 'Expected' line for a constraint + + The constraint that failed + + + + Write the generic 'Expected' line for a given value + + The expected value + + + + Write the generic 'Expected' line for a given value + and tolerance. + + The expected value + The tolerance within which the test was made + + + + Write the generic 'Actual' line for a constraint + + The constraint for which the actual value is to be written + + + + Write the generic 'Actual' line for a given value + + The actual value causing a failure + + + + Gets or sets the maximum line length for this writer + + + + + Helper class with properties and methods that supply + constraints that operate on exceptions. + + + + + Creates a constraint specifying the exact type of exception expected + + + + + Creates a constraint specifying the exact type of exception expected + + + + + Creates a constraint specifying the type of exception expected + + + + + Creates a constraint specifying the type of exception expected + + + + + Creates a constraint specifying an expected exception + + + + + Creates a constraint specifying an exception with a given InnerException + + + + + Creates a constraint specifying an expected TargetInvocationException + + + + + Creates a constraint specifying an expected TargetInvocationException + + + + + Creates a constraint specifying an expected TargetInvocationException + + + + + Creates a constraint specifying that no exception is thrown + + + + Index: DamClients/DamUI/trunk/release/Install_Version/de-DE/DotSpatial.Projections.Forms.resources.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/DevExpress.XtraCharts.v12.2.UI.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/pt-BR/DotSpatial.Projections.Forms.resources.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/de-DE/DotSpatial.Symbology.Forms.resources.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/nl/DotSpatial.Projections.Forms.resources.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.Probabilistic.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.Dam.Forms.dll.config =================================================================== diff -u --- DamClients/DamUI/trunk/release/Install_Version/Deltares.Dam.Forms.dll.config (revision 0) +++ DamClients/DamUI/trunk/release/Install_Version/Deltares.Dam.Forms.dll.config (revision 2315) @@ -0,0 +1,57 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.Dam.DamWti.Tests.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/osr_csharp.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.DamClientsLibrary.Version.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.Dam.BenchmarkTests.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/datasource.xml =================================================================== diff -u --- DamClients/DamUI/trunk/release/Install_Version/datasource.xml (revision 0) +++ DamClients/DamUI/trunk/release/Install_Version/datasource.xml (revision 2315) @@ -0,0 +1,10 @@ + + + + + + + + + + \ No newline at end of file Index: DamClients/DamUI/trunk/release/Install_Version/DotSpatial.Data.Forms.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/zh-CN/DotSpatial.Controls.resources.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/DotSpatial.Extensions.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/OutputFileStability.xml =================================================================== diff -u --- DamClients/DamUI/trunk/release/Install_Version/OutputFileStability.xml (revision 0) +++ DamClients/DamUI/trunk/release/Install_Version/OutputFileStability.xml (revision 2315) @@ -0,0 +1,56 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file Index: DamClients/DamUI/trunk/release/Install_Version/DevExpress.Utils.v12.2.UI.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.Standard.Forms.Maps.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/CommandLine.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/de-DE/DotSpatial.Controls.resources.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/cs/DotSpatial.Projections.Forms.resources.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/ro/DotSpatial.Projections.Forms.resources.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/DevExpress.XtraBars.v12.2.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/CsvToDamx.exe.config =================================================================== diff -u --- DamClients/DamUI/trunk/release/Install_Version/CsvToDamx.exe.config (revision 0) +++ DamClients/DamUI/trunk/release/Install_Version/CsvToDamx.exe.config (revision 2315) @@ -0,0 +1,64 @@ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + DamLiveData + + + + Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.DamEngine.Data.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.Dam.Forms.pdb =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.DamPiping.SellmeijerVNKCalculator.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/DotSpatial.Topology.xml =================================================================== diff -u --- DamClients/DamUI/trunk/release/Install_Version/DotSpatial.Topology.xml (revision 0) +++ DamClients/DamUI/trunk/release/Install_Version/DotSpatial.Topology.xml (revision 2315) @@ -0,0 +1,24664 @@ + + + + DotSpatial.Topology + + + + + Constants representing the dimensions of a point, a curve and a surface. + Also, constants representing the dimensions of the empty point and + non-empty geometries, and a wildcard dimension meaning "any dimension". + + + + + Dimension value of a point (0). + + + + + Dimension value of a curve (1). + + + + + Dimension value of a surface (2). + + + + + Dimension value of a empty point (-1). + + + + + Dimension value of non-empty geometries (= {Point, Curve, A}). + + + + + Dimension value for any dimension (= {False, True}). + + + + + An abreviated list for quick classification + + + + + None specified or custom + + + + + Point + + + + + Line + + + + + Polygon + + + + + MultiPoint + + + + + A geometric angle mesured in degrees or radians + the angle will wrap around, so setting larger values will + result in an appropriate angle. + + + + + The value of 3.14159 or whatever from Math.PI + + + + + Creates a new instance of an angle with the radians specified + + The angle in radians + + + + Returns a new instance of the Angle class with the same angle as this object. + + Angle which has the same values + + + + False for anything that is not an angle. + Tests two angles to see if they have the same value. + + An object to test. + Boolean, true if the angles have the same value. + + + + Gets a hash code + + Int hash code + + + + Returns a new angle object with an angle of Value in radians + + The double value indicating the angle + An Angle structure with the specified value + + + + Returns a double specifying the radian value of the angle + + The angle structure to determine the angle of + A Double with the angle in radians + + + + Returns true if the two angles are equal to each other. + + An angle to compare + A second angle. + Boolean, true if they are equal. + + + + Returns true if the two angles are equal to each other. + + An angle to compare + A second angle. + Boolean, true if they are equal. + + + + Returns the sum of the two angles, cycling if greater than 2 pi. + + An angle to add + A second angle to add + A new Angle structure equal to the sum of the two angles + + + + Returns the difference of two angles. + + An angle to subtract from + The angle to subtract + A new angle structure with a sum equal to the two angles + + + + Divides angle A by angle B + + An angle to divide + An angle to divide into A + A new angle with the quotient of the division + + + + Multiplies angle A by Angle B. + + An angle to multiply + A second angle to multiply. + A new angle with the product of the two angles. + + + + Returns the mathematical Cos of the angle specified + + The Angle to find the cosign of + Double, the cosign of the angle specified + + + + Returns the mathematical Sin of the angle specified + + The Angle to find the Sin of + Double, the Sin of the Angle + + + + Returns the mathematical Tan of the angle specified + + The Angle to find the Tan of + Double, the Tan of the Angle + + + + Returns the mathematical ATan of the value specified + + The Double to find the ATan of + Angle, the ATan of the Value specified + + + + Returns the mathematical ACos of the value specified + + The Double to find the ACos of + Angle, the ACos of the Value specified + + + + Returns the mathematical ASin of the value specified + + The Double to find the ASin of + Angle, the ASin of the Value specified + + + + Gets or sets the angle in degrees, ranging from -360 to 360 + + + + + Gets or sets the angle in degrees ranging from 0 to 360 + + + + + Only allows values from -2PI to 2PI. + + + + + Buffer styles. + + + + + Specifies a round line buffer end cap endCapStyle (Default). + / + + + + Specifies a butt (or flat) line buffer end cap endCapStyle. + + + + + Specifies a square line buffer end cap endCapStyle. + + + + + The types of Precision Model which NTS supports. + + + + + Floating precision corresponds to the standard + double-precision floating-point representation, which is + based on the IEEE-754 standard + + + + + Floating single precision corresponds to the standard + single-precision floating-point representation, which is + based on the IEEE-754 standard + + + + + Fixed Precision indicates that coordinates have a fixed number of decimal places. + The number of decimal places is determined by the log10 of the scale factor. + + + + + A list of DE-9IM row indices clarifying the interior, boundary or exterior. + + + + + DE-9IM row index of the interior of the first point and column index of + the interior of the second point. Location value for the interior of a + point. + int value = 0; + + + + + DE-9IM row index of the boundary of the first point and column index of + the boundary of the second point. Location value for the boundary of a + point. + int value = 1; + + + + + DE-9IM row index of the exterior of the first point and column index of + the exterior of the second point. Location value for the exterior of a + point. + int value = 2; + + + + + Used for uninitialized location values. + int value = -1; + + + + + Standard ordinate index values. + + + + + X Ordinate = 0. + + + + + Y Ordinate = 1. + + + + + Z Ordinate = 2. + + + + + M Ordinate = 3. + + + + + Extends the class to allow reading values in the BigEndian format. + + + While BigEndianBinaryReader extends BinaryReader + adding methods for reading integer values + and double values in the BigEndian format, + this implementation overrides methods, such + and and more, + for reading ByteOrder.BigEndian values in the BigEndian format. + + + + + Initializes a new instance of the class. + + The stream. + + + + Initializes a new instance of the BEBinaryReader class. + + The supplied stream. + The character encoding. + encoding is null. + The stream does not support reading, the stream is null, or the stream is already closed. + + + + Reads a 2-byte signed integer from the current stream using big endian encoding + and advances the current position of the stream by two bytes. + + + A 2-byte signed integer read from the current stream. + + The stream is closed. + An I/O error occurs. + The end of the stream is reached. + + + + Reads a 4-byte signed integer from the current stream using big endian encoding + and advances the current position of the stream by four bytes. + + + A 4-byte signed integer read from the current stream. + + The stream is closed. + An I/O error occurs. + The end of the stream is reached. + + + + Reads an 8-byte signed integer from the current stream using big endian encoding + and advances the current position of the stream by eight bytes. + + + An 8-byte signed integer read from the current stream. + + The stream is closed. + An I/O error occurs. + The end of the stream is reached. + + + + Reads a 4-byte floating point value from the current stream using big endian encoding + and advances the current position of the stream by four bytes. + + + A 4-byte floating point value read from the current stream. + + The stream is closed. + An I/O error occurs. + The end of the stream is reached. + + + + Reads an 8-byte floating point value from the current stream using big endian encoding + and advances the current position of the stream by eight bytes. + + + An 8-byte floating point value read from the current stream. + + The stream is closed. + An I/O error occurs. + The end of the stream is reached. + + + + + + + Extends the class to allow writing values in the BigEndian format. + + + While BigEndianBinaryWriter extends + adding methods for writing integer values (BigEndianBinaryWriter.WriteIntBE) + and double values (BigEndianBinaryWriter.WriteDoubleBE) in the BigEndian format, + this implementation overrides methods, such BinaryWriter.Write(Int32) + and BinaryWriter.Write(Double)and more, + for writing T:ByteOrder.BigEndian values in the BigEndian format. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The supplied stream. + output is null. + + The stream does not support writing, or the stream is already closed. + + + + Initializes a new instance of the class. + + The supplied stream. + The character encoding. + output or encoding is null. + + The stream does not support writing, or the stream is already closed. + + + + Writes a two-byte signed integer to the current stream using BigEndian encoding + and advances the stream position by two bytes. + + The two-byte signed integer to write. + The stream is closed. + An I/O error occurs. + + + + Writes a four-byte signed integer to the current stream using BigEndian encoding + and advances the stream position by four bytes. + + The four-byte signed integer to write. + The stream is closed. + An I/O error occurs. + + + + Writes an eight-byte signed integer to the current stream using BigEndian encoding + and advances the stream position by eight bytes. + + The eight-byte signed integer to write. + The stream is closed. + An I/O error occurs. + + + + Writes a four-byte floating-point value to the current stream using BigEndian encoding + and advances the stream position by four bytes. + + The four-byte floating-point value to write. + The stream is closed. + An I/O error occurs. + + + + Writes an eight-byte floating-point value to the current stream using BigEndian encoding + and advances the stream position by eight bytes. + + The eight-byte floating-point value to write. + The stream is closed. + An I/O error occurs. + + + + Writes a length-prefixed string to this stream in the current encoding + of the , + and advances the current position of the stream in accordance + with the encoding used and the specific characters being written to the stream. + + The value to write. + The stream is closed. + An I/O error occurs. + value is null. + + + + Writes a decimal value to the current stream and advances the stream position by sixteen bytes. + + The decimal value to write. + The stream is closed. + An I/O error occurs. + + + + Byte order + + + + + Big Endian + + + + + Little Endian + + + + + The original idea of comming up with a coordinate that used public accessors and an + ICoordinate interface was actually quite slow, given that every access point was + multiplied across many instances. + + + + + An optional place holder for a measure value if needed + + + + + The X or horizontal, or longitudinal ordinate + + + + + The Y or vertical, or latitudinal ordinate + + + + + The Z or up or altitude ordinate + + + + + Creates an empty coordinate + + + + + Creates a 2D coordinate with NaN for the Z and M values + + + + + + + Creates a new coordinate with the specified values + + + + + + + + Creates a new coordinate with the values in X, Y, Z order, or X, Y order. + + + + + + Constructs a new instance of the coordinate + + + + + + Constructs a new instance of the coordinate + + + + + + Creates a new instance of Coordinate + + + + + Compares the X, Y and Z values with the specified item. + If the Z value is NaN then only the X and Y values are considered + + This should be either a Coordiante or an ICoordinate + Boolean, true if the two are equal + + + + returns the simple base.GetHashCode + + + + + + Returns the underlying two dimensional array of coordinates + + + + + + Returns Euclidean 2D distance from ICoordinate p. + + ICoordinate with which to do the distance comparison. + Double, the distance between the two locations. + + + + Returns whether the planar projections of the two Coordinates are equal. + + The ICoordinate with which to do the 2D comparison. + + true if the x- and y-coordinates are equal; + the Z coordinates do not have to be equal. + + + + + Returns true if other has the same values for x, y and z. + + The second ICoordiante for a 3D comparison + true if other is a ICoordinate with the same values for x, y and z. + + + + Returns the distance that is appropriate for N dimensions. In otherwords, if this point is + three dimensional, then all three dimensions will be used for calculating the distance. + + The coordinate to compare to this coordinate + A double valued distance measure that is invariant to the number of coordinates + The number of dimensions does not match between the points. + + + + Returns a string of the form (x, y, z) . + + string of the form (x, y, z) + + + + Compares this object with the specified object for order. + Since Coordinates are 2.5D, this routine ignores the z value when making the comparison. + Returns + -1 : this.x lowerthan other.x || ((this.x == other.x) AND (this.y lowerthan other.y)) + 0 : this.x == other.x AND this.y = other.y + 1 : this.x greaterthan other.x || ((this.x == other.x) AND (this.y greaterthan other.y)) + + Coordinate with which this Coordinate is being compared. + + A negative integer, zero, or a positive integer as this Coordinate + is less than, equal to, or greater than the specified Coordinate. + + + + + Compares this object with the specified object for order. + Since Coordinates are 2.5D, this routine ignores the z value when making the comparison. + Returns + -1 : this.x lowerthan other.x || ((this.x == other.x) AND (this.y lowerthan other.y)) + 0 : this.x == other.x AND this.y = other.y + 1 : this.x greaterthan other.x || ((this.x == other.x) AND (this.y greaterthan other.y)) + + Coordinate with which this Coordinate is being compared. + + A negative integer, zero, or a positive integer as this Coordinate + is less than, equal to, or greater than the specified Coordinate. + + + + + If either X or Y is defined as NaN, then this coordinate is considered empty. + + + + + + Duplicates this coordinate + + + + + + + + + + + + + + + + + + + + + + Overloaded + operator. + + + + + Overloaded + operator. + + + + + Overloaded + operator. + + + + + Overloaded * operator. + + + + + Overloaded * operator. + + + + + Overloaded * operator. + + + + + Overloaded - operator. + + + + + Overloaded - operator. + + + + + Overloaded - operator. + + + + + Overloaded / operator. + + + + + Overloaded / operator. + + + + + Overloaded / operator. + + + + + Gets a pre-defined coordinate that has double.NaN for all the values. + + + + + Gets or sets the double value associated with the specified ordinate index + + The zero-based integer index of the ordinate + A double value representing a single ordinate + + + + This is not a true length, but simply tests the Z value. If the Z value + is NaN then the value is 2. Otherwise this is 3. + + + + + Useful utility functions for handling Coordinate arrays. + + + + + Finds a in a list of s + which is not contained in another list of s. + + The s to test. + An array of s to test the input points against. + + A from + which is not in , or null. + + + + + Compares two arrays + in the forward direction of their coordinates, + using lexicographic ordering. + + + + + + + + Determines which orientation of the array is (overall) increasing. + In other words, determines which end of the array is "smaller" + (using the standard ordering on ). + Returns an integer indicating the increasing direction. + If the sequence is a palindrome, it is defined to be + oriented in a positive direction. + + The array of Coordinates to test. + + 1 if the array is smaller at the start or is a palindrome, + -1 if smaller at the end. + + + + + Determines whether two arrays of equal length + are equal in opposite directions. + + + + + + + + Creates a deep copy of the argument Coordinate array. + + Array of Coordinates. + Deep copy of the input. + + + + Converts the given of + s into a array. + + of coordinates. + + + If contains not only s. + + + + + Converts the given of + s into a array. + + of coordinates. + + + + + Returns whether Equals returns true for any two consecutive + coordinates in the given array. + + Array of Coordinates. + true if coord has repeated points; false otherwise. + + + + Returns either the given coordinate array if its length is greater than + the given amount, or an empty coordinate array. + + Length amount. + Array of Coordinates. + New Coordinate array. + + + + If the coordinate array argument has repeated points, + constructs a new array containing no repeated points. + Otherwise, returns the argument. + + + + + + + Reverses the coordinates in an array in-place. + + Array of Coordinates. + + + + Returns true if the two arrays are identical, both null, or pointwise + equal (as compared using Coordinate.Equals). + + First array of Coordinates. + Second array of Coordinates. + true if two Coordinates array are equals; false otherwise + + + + Returns true if the two arrays are identical, both null, or pointwise + equal, using a user-defined + for s. + + An array of s. + Another array of s. + + A for s. + + + + + + Returns the minimum coordinate, using the usual lexicographic comparison. + + Array to search. + The minimum coordinate in the array, found using CompareTo. + + + + + Shifts the positions of the coordinates until firstCoordinate is first. + + Array to rearrange. + Coordinate to make first. + + + + Returns the index of in . + The first position is 0; the second is 1; etc. + + A to search for. + A array to search. + The position of coordinate, or -1 if it is not found. + + + + Extracts a subsequence of the input array + from indices to (inclusive). + + The input array. + The index of the start of the subsequence to extract. + The index of the end of the subsequence to extract. + A subsequence of the input array. + + + + A comparator for arrays modulo their directionality. + E.g. if two coordinate arrays are identical but reversed + they will compare as equal under this ordering. + If the arrays are not equal, the ordering returned + is the ordering in the forward direction. + + + + + + + + + + + + + Compares two arrays + in the forward direction of their coordinates, + using lexicographic ordering. + + + + + Compares the specified s arrays. + + + + + + + + The ICoordinateSequence implementation that Geometrys use by default. + In this implementation, Coordinates returned by ToArray and Coordinate are live -- + modifications to them are actually changing the + CoordinateSequence's underlying data. + + + + + The internal representation of a list of coordinates inside a Geometry. + + There are some cases in which you might want Geometries to store their + points using something other than the NTS Coordinate class. For example, you + may want to experiment with another implementation, such as an array of x’s + and an array of y’s. or you might want to use your own coordinate class, one + that supports extra attributes like M-values. + + + You can do this by implementing the ICoordinateSequence and + ICoordinateSequenceFactory interfaces. You would then create a + GeometryFactory parameterized by your ICoordinateSequenceFactory, and use + this GeometryFactory to create new Geometries. All of these new Geometries + will use your ICoordinateSequence implementation. + An observation on performance: If your ICoordinateSequence is not based on an array + of Coordinates, it may incur a performance penalty when its ToArray() method + is called because the array needs to be built from scratch. + + + + + + Returns the ordinate of a coordinate in this sequence. + Ordinate indices 0 and 1 are assumed to be X and Y. + Ordinates indices greater than 1 have user-defined semantics + (for instance, they may contain other dimensions or measure values). + + The coordinate index in the sequence. + The ordinate index in the coordinate (in range [0, dimension-1]). + + + + + Sets the value for a given ordinate of a coordinate in this sequence. + + The coordinate index in the sequence. + The ordinate index in the coordinate (in range [0, dimension-1]). + The new ordinate value. + + + + Returns (possibly copies of) the Coordinates in this collection. + Whether or not the Coordinates returned are the actual underlying + Coordinates or merely copies depends on the implementation. Notice that + if this implementation does not store its data as an array of Coordinates, + this method will incur a performance penalty because the array needs to + be built from scratch. + + + + + + Expands the given Envelope to include the coordinates in the sequence. + Does not modify the original envelope, but rather returns a copy of the + original envelope after being modified. + + The envelope use as the starting point for expansion. This envelope will not be modified. + The newly created envelope that is the expanded version of the original. + + + + Returns the dimension (number of ordinates in each coordinate) for this sequence. + + + + + Direct accessor to an ICoordinate + + An integer index in this array sequence + An ICoordinate for the specified index + + + + Every time a member is added to, subtracted from, or edited in the sequence, + this VersionID is incremented. This doesn't uniquely separate this sequence + from other sequences, but rather acts as a way to rapidly track if changes + have occured against a cached version. + + + + + Increments the version with the understanding that we are using integers. If the user + uses too many version, it will cycle around. The statistical odds of accidentally + reaching the same value as a previous version should be small enough to prevent + conflicts. + + + + + Creates a new array sequence dimensioned with exactly 1 coordinate that is empty. + + + + + Creates a new array sequence dimensioned with exactly 1 coordinate, which is set to the coordinate + + The ICoordinate to use when constructing this sequence + + + + Creates a new CoordinateArraySequence whose members are + + The existing list whose members will be copied to the array. + + + + Constructs a sequence based on the given array (the array is not copied). + + The coordinate array that will be referenced. + + + + Constructs a sequence of a given size, populated with new Coordinates. + + The size of the sequence to create. + + + + Constructs a sequence based on the given array (the array is not copied). + + The coordinate array that will be referenced. + + + + Adds a single item to the array. This is very slow for arrays because it has to + copy all the values into a new array. + + + + + + Clears the array, reducing the measure to 1 empty coordinate. + + + + + Tests to see if the array contains the specified item + + the ICoordinate to test + True if the value is in the array. + + + + Creates a deep copy of the object. + + The deep copy. + + + + Copies all of the members from this sequence into the specifeid array. + + The array of Icoordinates to copy values to. + The starting index + + + + Expands the given Envelope to include the coordinates in the sequence. + Does not modify the original envelope, but rather returns a copy of the + original envelope after being modified. + + The envelope use as the starting point for expansion. This envelope will not be modified. + The newly created envelope that is the expanded version of the original. + + + + Returns an enumerator object for cycling through each of the various members of the array. + BEWARE! This will bypass the VersionID code. Since ICoordinateSequence does not contain + the GetEnumerator methods, using an ICoordinateSequence should safely advance the version + during changes. + + An Enumerator for this array. + + + + Returns the ordinate of a coordinate in this sequence. + Ordinate indices 0 and 1 are assumed to be X and Y. + Ordinates indices greater than 1 have user-defined semantics + (for instance, they may contain other dimensions or measure values). + + The coordinate index in the sequence. + The ordinate index in the coordinate (in range [0, dimension-1]). + + + + + For arrays, this is very inneficient. This will copy all the members + except for the item to a new array. + + The item to remove. + Boolean, true if a match was found and an item was removed, false otherwise. + + + + Sets the value for a given ordinate of a coordinate in this sequence. + + The coordinate index in the sequence. + The ordinate index in the coordinate (in range [0, dimension-1]). + The new ordinate value. + + + + This method exposes the internal Array of Coordinate Objects. + + + + + + Returns the string representation of the coordinate array. + + + + + + Returns the length of the coordinate sequence. + + + + + Returns the dimension (number of ordinates in each coordinate) for this sequence. + + + + + + CoordinateArraySequences are not ReadOnly + + + + + Direct accessor to an ICoordinate + + An integer index in this array sequence + An ICoordinate for the specified index + + + + Every time a member is added to, subtracted from, or edited in the sequence, + this VersionID is incremented. This doesn't uniquely separate this sequence + from other sequences, but rather acts as a way to rapidly track if changes + have occured against a cached version. + + + + + CoordinateArraySequenceEnumerator + + + + + Creates a new instance of CoordinateArraySequenceEnumerator + + + + + Does nothing + + + + + Advances the enumerator to the next member + + + + + + Resets the enumerator to the original position + + + + + Gets the current member + + + + + Creates CoordinateSequences represented as an array of Coordinates. + + + + + An object that knows how to build a particular implementation of + ICoordinateSequence from an array of Coordinates. + + + + + + Returns a CoordinateSequence based on the given array; whether or not the + array is copied is implementation-dependent. + + Coordinates array, which may not be null nor contain null elements + + + + Constructs a new coordinate sequence using a single coordinate. + + A single coordinate to be used in a coordinate sequence factory. + A valid ICoordinateSequence. + + + + Constructs either an array with 1 member or an empty list, depending on the implementation. + + A new seqeunce + + + + This appears to be part of a singleton for a coordinate array sequence factory + + + + + + + + + + Returns a CoordinateArraySequence based on the given array (the array is not copied). + + the coordinates, which may not be null nor contain null elements. + + + + + Constructs a new coordinate sequence using a single coordinate. + + A single coordinate to be used in a coordinate sequence factory. + A valid ICoordinateSequence. + + + + Constructs either an array with 1 member or an empty list, depending on the implementation. + + A new seqeunce + + + + + + + + + + + A lightweight class used to store coordinates + on the 2-dimensional Cartesian plane. + It is distinct from Point, which is a subclass of Geometry. + Unlike objects of type Point (which contain additional + information such as an envelope, a precision model, and spatial reference + system information), a Coordinate only contains ordinate values + and accessor methods. + Coordinates are two-dimensional points, with an additional + z-ordinate. NTS does not support any operations on the z-ordinate except + the basic accessor functions. Constructed coordinates will have a + z-ordinate of NaN. The standard comparison functions will ignore + the z-ordinate. + + + + + Creates a CoordinateF by using the X, Y and Z terms of a FloatVector + + + + + + Constructs a Coordinate at (x, y, z). + + X value. + Y value. + Z value. + Measure value. + + + + Constructs a Coordinate at (x, y, z). + + X value. + Y value. + Z value. + + + + Creates a Coordinate from any ICoordinate Interface + + The Vector.IPoint interface to construct a coordinate from + + + + Constructs a Coordinate at (0, 0, NaN). + + + + + Constructs a Coordinate at (x, y, NaN). + + X value. + Y value. + + + + Returns whether the planar projections of the two Coordinates are equal. + + ICoordinate with which to do the 2D comparison. + + true if the x- and y-coordinates are equal; + the Z coordinates do not have to be equal. + + + + + Returns true if other has the same values for the x and y ordinates. + Since Coordinates are 2.5D, this routine ignores the z value when making the comparison. + + Coordinate with which to do the comparison. + true if other is a Coordinate with the same values for the x and y ordinates. + + + + + + + + + + + + + + + + + + + + Compares this object with the specified object for order. + Since Coordinates are 2.5D, this routine ignores the z value when making the comparison. + Returns + -1 : this.x lowerthan other.x || ((this.x == other.x) AND (this.y lowerthan other.y)) + 0 : this.x == other.x AND this.y = other.y + 1 : this.x greaterthan other.x || ((this.x == other.x) AND (this.y greaterthan other.y)) + + Coordinate with which this Coordinate is being compared. + + A negative integer, zero, or a positive integer as this Coordinate + is less than, equal to, or greater than the specified Coordinate. + + + + + Returns true if other has the same values for x, y and z. + + ICoordinate with which to do the 3D comparison. + true if other is a ICoordinate with the same values for x, y and z. + + + + Returns a string of the form (x, y, z) . + + string of the form (x, y, z) + + + + Create a new object as copy of this instance. + + + + + + Creates a new ICoordinate copy of this instance + + + + + + Returns Euclidean 2D distance from ICoordinate p. + + ICoordinate with which to do the distance comparison. + Double, the distance between the two locations. + + + + Returns the distance that is appropriate for N dimensions. In otherwords, if this point is + three dimensional, then all three dimensions will be used for calculating the distance. + + The coordinate to compare to this coordinate + A double valued distance measure that is invariant to the number of coordinates + The number of dimensions does not match between the points. + + + + Return HashCode. + + + + + Return HashCode. + + Value from HashCode computation. + + + + Overloaded + operator. + + + + + Overloaded + operator. + + + + + Overloaded + operator. + + + + + Overloaded * operator. + + + + + Overloaded * operator. + + + + + Overloaded * operator. + + + + + Overloaded - operator. + + + + + Overloaded - operator. + + + + + Overloaded - operator. + + + + + Overloaded / operator. + + + + + Overloaded / operator. + + + + + Overloaded / operator. + + + + + Gets an array of double values for each of the ordinates + + + + + + Direct access to the coordinate works as a float. If you only have the interface, + it must involve conversions to and from a float. This may cause errors if the + value being set is outside the range of the float values. + + + + + Direct access to the Y coordinate as a float + + + + + Z coordinate. + + + + + A Measure coordinate + + + + + Gets/Sets Coordinates (x, y, z) values. + + + + + Gets or sets the double value corresponding to the specific ordinate + + + + + + + For now this is 3D + + + + + Gets or sets the values of this CoordinateF using an array of double values + + + + + A list of Coordinates, which may + be set to prevent repeated coordinates from occuring in the list. + + + + + Creates a new instance of a coordiante list + + + + + The basic constructor for a CoordinateArray allows repeated points + (i.e produces a CoordinateList with exactly the same set of points). + + Initial coordinates + + + + Constructs a new list from an array of Coordinates, + allowing caller to specify if repeated points are to be removed. + + Array of coordinates to load into the list. + If false, repeated points are removed. + + + + Returns a deep copy of this collection. + + The copied object. + + + + Add an array of coordinates. + + Coordinates to be inserted. + If set to false, repeated coordinates are collapsed. + If false, the array is added in reverse order. + + + + Add an array of coordinates. + + Coordinates to be inserted. + If set to false, repeated coordinates are collapsed. + + + + Add a coordinate. + + Coordinate to be inserted. + If set to false, repeated coordinates are collapsed. + + + + + + + + + + + Adds the entire range of coordinates, preventing coordinates with the identical 2D signiture from + being added immediately after it's duplicate. + + + + + + + Ensure this coordList is a ring, by adding the start point if necessary. + + + + + Returns the Coordinates in this collection. + + Coordinater as Coordinate[] array. + + + + An ICoordinateSequence based on a list instead of an array. + + + + + Creates a new instance of a CoordinateListSequence + + + + + + Creates a new instance of a CoordinateListSequence + + + + + Creates a new instance of a CoordinateListSequence + + If this is a List of ICoordinates, the sequence will be a shallow list. + Otherwise, a List is created and shallow copies of each coordinate is added. + + + + Creates a new instance of CoordinateListSequence + + The sequence to use + + + + Adds an item to the end of the CoordinateList + + An ICoordinate to add + + + + Clears the list entirely. + + + + + Creates a deep copy of this object + + CoordinateListSequence + + + + Tests wheather or not the specified ICoordinate is contained in the list. + + An ICoordinate to test + Boolean, true if the list contains the item. + + + + Copies all the members of this list into the specified array. + + The array to copy values to. + The 0 based integer index in the array at which copying begins + + + + Expands the given Envelope to include the coordinates in the sequence. + Does not modify the original envelope, but rather returns a copy of the + original envelope after being modified. + + The envelope use as the starting point for expansion. This envelope will not be modified. + The newly created envelope that is the expanded version of the original. + + + + Obtains an enumerator for cycling through the list. BEWARE! This + will return an underlying list enumerator, and so code that uses + a foreach process or an enumerator will bypass the Version incrementing code. + + An Enumerator object for cycling through the list. + + + + Gets a specific X, Y or Z value depending on the index specified and the ordinate specified + + + + + + + + Removes the specified ICoordinate from the list. + + An ICoordinate that should be removed from the list + Boolean, true if the item was successfully removed. + + + + Sets a specific X, Y or Z value depending on the index specified and the ordinate specified + + + + + + + + Copies all the members to an ICoordiante[] + + + + + + Increments the version with the understanding that we are using integers. If the user + uses too many version, it will cycle around. The statistical odds of accidentally + reaching the same value as a previous version should be small enough to prevent + conflicts. + + + + + Gets an integer representing the number of ICoordinates currently stored in this list + + + + + This always returns 0 + + + + + The CoordinateListSequence is not readonly + + + + + Direct accessor to an ICoordinate + + An integer index in this array sequence + An ICoordinate for the specified index + + + + This only works as long as an enumeration is not used on the CoordinateListSequence. + Since ICoordinateSequence does not support a GetEnumerator object, as long as you + are using an ICoordinateSequence interface, VersionID should work. + + + + + Creates CoordinateSequences represented as an array of Coordinates. + + + + + Creates an instance of the CoordinateListSequenceFactory + + + + + Returns a CoordinateArraySequence based on the given array (the array is not copied). + + the coordinates, which may not be null nor contain null elements. + + + + + + + + + + + Creates a new CoordinateListSequence and populates it with a single coordinate. + + + + + + + + + + + + + + CoordinateMismatchException + + + + + Creates a new instance of CoordinateMismatchException + + + + + Class containing static methods for conversions + between Dimension values and characters. + + + + + Converts the dimension value to a dimension symbol, + for example, True => 'T' + + Number that can be stored in the IntersectionMatrix. + Possible values are True, False, Dontcare, 0, 1, 2. + Character for use in the string representation of an IntersectionMatrix. + Possible values are T, F, *, 0, 1, 2. + + + + Converts the dimension symbol to a dimension value, + for example, '*' => Dontcare + + Character for use in the string representation of an IntersectionMatrix. + Possible values are T, F, *, 0, 1, 2. + Number that can be stored in the IntersectionMatrix. + Possible values are True, False, Dontcare, 0, 1, 2. + + + + This is enumerates not only the specific types, but very specifically + that the types are the Topology variety, and not simply the vector variety + + + + + A non-geometry rectangle that strictly shows extents + + + + + A collective group of geometries + + + + + A closed linestring that doesn't self intersect + + + + + Any linear collection of points joined by line segments + + + + + A collection of independant LineStrings that are not connected + + + + + A Grouping of points + + + + + A Collection of unconnected polygons + + + + + A single coordinate location + + + + + At least one Linear Ring shell with any number of linear ring "holes" + + + + + Any other type + + + + + Shapefile Shape types enumeration + + + + + Null Shape + + + + + Point + + + + + LineString + + + + + Polygon + + + + + MultiPoint + + + + + PointMZ + + + + + PolyLineMZ + + + + + PolygonMZ + + + + + MultiPointMZ + + + + + PointM + + + + + LineStringM + + + + + PolygonM + + + + + MultiPointM + + + + + MultiPatch + + + + + PointZ + + + + + LineStringZ + + + + + PolygonZ + + + + + MultiPointZ + + + + + Field Types + + + + + Integer + + + + + Integer List + + + + + Real + + + + + Real List + + + + + String + + + + + String List + + + + + Wide String + + + + + Side String List + + + + + Binary + + + + + Date + + + + + Time + + + + + DateTime + + + + + Invalid + + + + + Vector Geometry Types + + + + + Unknown + + + + + Well Known Binary Point + + + + + Well Known Binary LineString + + + + + Well Known Binary Polygon + + + + + Well Known Binary MultiPoint + + + + + Well Known Binary MultiLineString + + + + + Well Known Binary MultiPolygon + + + + + Well Known Binary Geometry Collection + + + + + Well Known Binary Linear Ring + /* non-standard, just for createGeometry() */ + + + + + Well Known Binary Point with Z value + + + + + Well Known Binary Line String with Z values + + + + + Well Known Binary Polygon with Z values + + + + + Well Known Binary MultiPoint with Z values + + + + + Well Known Binary LineString with z values + + + + + Well Known Binary MultiPolygon with z values + + + + + Defines a rectangular region of the 2D coordinate plane. + It is often used to represent the bounding box of a Geometry, + e.g. the minimum and maximum x and y values of the Coordinates. + Notice that Envelopes support infinite or half-infinite regions, by using the values of + Double.PositiveInfinity and Double.NegativeInfinity. + When Envelope objects are created or initialized, + the supplies extent values are automatically sorted into the correct order. + + + + + Defines a rectangular region of the 2D coordinate plane. + It is often used to represent the bounding box of a Geometry, + e.g. the minimum and maximum x and y values of the Coordinates. + Notice that Envelopes support infinite or half-infinite regions, by using the values of + Double.PositiveInfinity and Double.NegativeInfinity. + When Envelope objects are created or initialized, + the supplies extent values are automatically sorted into the correct order. + + + + + An IRectangle is not as specific to being a geometry, and can apply to anything as long as it is willing + to support a double valued height, width, X and Y value. + + + + + Gets or sets the difference between the maximum and minimum y values. + Setting this will change only the minimum Y value, leaving the Top alone + + max y - min y, or 0 if this is a null Envelope. + + + + Gets or Sets the difference between the maximum and minimum x values. + Setting this will change only the Maximum X value, and leave the minimum X alone + + max x - min x, or 0 if this is a null Envelope. + + + + In the precedent set by controls, envelopes support an X value and a width. + The X value represents the Minimum.X coordinate for this envelope. + + + + + In the precedent set by controls, envelopes support a Y value and a height. + the Y value represents the Top of the envelope, (Maximum.Y) and the Height + represents the span between Maximum and Minimum Y. + + + + + Creates a copy of the current envelope. + + An IEnvelope Interface that is a duplicate of this envelope + + + + Sets maxx to a value less than minx + usually, maxx = -1 and minx = 0, maxy = -1 and miny = 0 + + + + + True only if the M coordinates are not NaN and the max is greater than the min. + + Boolean + + + + True only of the Z ordinates are not NaN and the max is greater than the min. + + Boolean + + + + Because the envelope class attempts to protect users from accidentally manipulating + the minimum/maximum conditions in an undesirable way, the init method should effectively + initialize the existing envelope based on the new coordinates. This is how values + are "Set" for the envelope. It is expected that this method will do a check + to prevent larger values from being assigned to "maximum". + + The first coordinate to test + the second coordinate to test + + + + This is a coordinate defining the minimum bound in any number of dimensions + as controlled by NumOrdinates. + + + + + This is a coordinate defining the maximum bound in any number of dimensions + as controlled by NumOrdinates. + + + + + Gets the number of ordinates that define both coordinates of this envelope. + + + + + Returns true if this Envelope is a "null" envelope. + + + true if this Envelope is uninitialized + or is the envelope of the empty point. This is usually defined + as having a maxx less than a minx, like maxx = -1 and minx = 0. + + + + + Occurs when there is a basic change in the envelope. + + + + + Creates a null Envelope. + + + + + Creates an Envelope for a region defined by maximum and minimum values. + + The first x-value. + The second x-value. + The first y-value. + The second y-value. + + + + Creates an Envelope for a region defined by maximum and minimum values. + + The first x-value. + The second x-value. + The first y-value. + The second y-value. + The first z-value. + The second z-value. + + + + Creates an Envelope for a region defined by an Vector.IEnvelope + + The IEnvelope to create an envelope from + + + + Creates an Envelope for a region defined by two Coordinates. + + The first Coordinate. + The second Coordinate. + + + + Creates an Envelope for a region defined by a single Coordinate. + + The Coordinate. + + + + This is a special constructor. This will not fire the OnEnvelopeChanged + event, and expects values to be ordered as: + XMin, XMax, YMin, YMax, ZMin, ZMax, higher dimenions... + This constructor. + + The ordinal extents. + The minimum m value. + The max M value. + + + + This is a special constructor. This will not fire the OnEnvelopeChanged + event, and expects values to be ordered as: + XMin, XMax, YMin, YMax, ZMin, ZMax, higher dimenions... + This constructor sets M bounds to be 0. + + The ordinal extents. + + + + Initialize an Envelope of any dimension for a region defined by two Coordinates. + The number of ordinates (dimension) of the coordinates must match. M values + will also be considered. + + The first Coordinate. + The second Coordinate. + + + + This initializes the values without passing any coordinates and creates the default, 2D null envelope. + + + + + This is an internal method forcing assignments to the internal coordinates + + The coordinate to use for the minimum in X, Y, Z etc. + The coordinate to use for the maximum in X, Y, Z etc. + + + + Initialize to a null Envelope. + + + + + Initialize an Envelope for a region defined by maximum and minimum values. + + The first x-value. + The second x-value. + The first y-value. + The second y-value. + + + + This will set all 3 dimensions. Be warned, the Z dimensions are just place holders + for any topology opperations and do not have any true functionality. Whichever + is smaller becomes the minimum and whichever is larger becomes the maximum. + + An X coordinate + Another X coordinate + A Y coordinate + Another Y coordinate + A Z coordinate + Another Z coordinate + + + + Initialize an Envelope for a region defined by a single Coordinate. + + The Coordinate. + + + + Initialize an Envelope from an existing Envelope. + + The Envelope to initialize from. + + + + True only if the M coordinates are not NaN and the max is greater than the min. + + Boolean + + + + True only of the Z ordinates are not NaN and the max is greater than the min. + + Boolean + + + + Creates a copy of the current envelope. + + An object satisfying ICloneable + + + + Makes this Envelope a "null" envelope. + + Internaly, envelopes that vioate that sacred criteria of min being less than max + will be counted as a null case + + + + Creates a copy of the current envelope. + + An IEnvelope Interface that is a duplicate of this envelope + + + + Test the point q to see whether it intersects the Envelope + defined by p1-p2. + + One extremal point of the envelope. + Another extremal point of the envelope. + Point to test for intersection. + true if q intersects the envelope p1-p2. + + + + Test the envelope defined by p1-p2 for intersection + with the envelope defined by q1-q2 + + One extremal point of the envelope Point. + Another extremal point of the envelope Point. + One extremal point of the envelope Q. + Another extremal point of the envelope Q. + true if Q intersects Point + + + + Generates a string form of this envelope. + + + This should not be an extension method because it overrides ToString. + + + + Fires the EnvelopeChanged event + + + + + Specifies that this is in fact an envelope + + + + + Gets the Horizontal boundaries in geographic coordinates + + + + + Gets the vertical boundaries in geographic coordinates + + + + + Gets the minimum coordinate + + + + + Gets the maximum coordinate + + + + + Gets the number of ordinates for this envelope. + + + + + Returns true if this Envelope is a "null" envelope. + + + true if this Envelope is uninitialized + or is the envelope of the empty point. + + + + + Gets or sets the difference between the maximum and minimum y values. + Setting this will only change the _yMin value (leaving the top alone) + + max y - min y, or 0 if this is a null Envelope. + To resemble the precedent set by the dot net framework controls, this is left as a property + + + + Gets or Sets the difference between the maximum and minimum x values. + Setting this will change only the Maximum X value, and leave the minimum X alone + + max x - min x, or 0 if this is a null Envelope. + + + + Gets or sets the Left extent of the envelope, keeping the width the same. + In the precedent set by controls, envelopes support an X value and a width. + The X value represents the Minimum.X coordinate for this envelope. + + + + + Gets or sets the Y coordinate for the top of the envelope. (YMax) + In the precedent set by controls, envelopes support a Y value and a height. + the Y value represents the Top of the envelope, (Maximum.Y) and the Height + represents the span between Maximum and Minimum Y. + + + + + Occurs when there is a basic change in the envelope. + + + + + My concept for the Envelope is that there are several methods that are derived calculations. These are + so straight forward that it is unlikey that "new" implementations of those derived values will be needed + or wanted. However, we want lots of different kinds of things to be able to "become" an envelope + with a minimum of fuss. + + + + + Calculates the area of this envelope. Because the word Area, + like Volume, is dimension specific, this method only looks + at the X and Y ordinates, and requires at least 2 ordinates. + + The IEnvelope to use with this method + The 2D area as a double value. + + + + Gets a linear ring built clockwise around the border, starting from the TopLeft. + + The IEnvelope to use with this method + + + + Gets an array of 4 line segments working clockwise from the top segment. + + The IEnvelope to use with this method + + + + Gets the minY, which is Y - Height. + + The IEnvelope that this calculation is for. + + + + + Gets an ILineSegment from the top right corner to the bottom right corner + + The IEnvelope to use with this method + + + + Gets the bottom left corner of this rectangle as a 2D coordinate. + + The IEnvelope that this calculation is for. + An ICoordinate at the lower left corner of this rectangle + + + + Gets the bottom right corner of this rectangle as a 2D coordinate + + The IEnvelope that this calculation is for. + An ICoordinate at the lower right corner of this rectangle + + + + Gets the coordinate defining the center of this envelope + in all of the dimensions of this envelope. + + The IEnvelope to find the center for + An ICoordinate + + + + Gets the left value for this rectangle. This should be the + X coordinate, but is added for clarity. + + The IEnvelope that this calculation is for. + + + + + Gets an ILineSegment from the bottom left to the top left corners + + The IEnvelope that is being extended by this method + + + + Gets the right value, which is X + Width. + + The IEnvelope that this calculation is for. + + + + + Gets an ILineSegment from the bottom right corner to the bottom left corner + + The IEnvelope to use with this method + + + + Converts this envelope into a linear ring. + + The IEnvelope to use with this method + A Linear ring describing the border of this envelope. + + + + Gets an ILineSegment from the top left to the top right corners + + The IEnvelope to use with this method + + + + Calculates the TopLeft 2D coordinate from this envelope. + + The IEnvelope to use with this method + + + + + Technically an Evelope object is not actually a geometry. + This creates a polygon from the extents. + + The IEnvelope to use with this method + A Polygon, which technically qualifies as an IGeometry + + + + Calcualte the TopRight 2D Coordinate from this envelope + + The IEnvelope to use with this method + An ICoordinate in the position of maximum X, Maximum Y + + + + Changes the envelope extent by the specified amount relative + to it's current extent in that dimension (preserving the aspect ratio). + So Zoom(10) on a 100 unit wide envelope creates a 110 unit wide envlope, + while Zoom(-10) on a 100 unit wide envelope creates a 90 unit wide envelope. + Zoom(-100) on an envelope makes it 100% smaller, or effectively a point. + Tragically, a point cannot be "zoomed" back in, so a check should be used + to ensure that the envelope is not currently a point before attempting + to zoom in. + + The IEnvelope that this zoom method modifies + + Positive 50 makes the envelope 50% larger + Negative 50 makes the envelope 50% smaller + + + perCent = -50 compact the envelope a 50% (make it smaller). + perCent = 200 enlarge envelope by 2. + + + + + Returns a new envelope that is a copy of this envelope, but modified + to include the specified coordinate. + + + + + Calculates the union of the current box and the given box. + + + + + Moves the envelope to the indicated coordinate. + + The IEnvelope to use with this method + The new center coordinate. + + + + Resizes the envelope to the indicated point. + + The IEnvelope to use with this method + The new width. + The new height. + + + + Moves and resizes the current envelope. + + The IEnvelope to use with this method + The new centre coordinate. + The new width. + The new height. + + + + This handles setting the center and scale in N dimensions. The size is equivalent to the + span in each dimension, while the center is the central position in each dimension. The + envelope will have values in each dimension where either the existing envelope or both the + specified center and size values have been specified. If only the existing envelope + and a size is specified for dimension 3, for example, the existing center will be used. + + The envelope to modify + The center position. This can also be null. + The size (or span) in each dimension. This can also be null. + + + + Despite the naming of the extents, this will force the larger of the two x values + to become Xmax etc. + + The IEnvelope to use with this method + An X coordinate + A Y coordinate + A Z coordinate + Another X coordinate + Another Y coordinate + Another Z coordinate + + + + The two dimensional overload for consistency with other code. + Despite the names, this will force the smallest X coordinate given + to become maxX. + + The IEnvelope to use with this method + An X coordinate + A Y coordinate + Another X coordinate + Another Y coordinate + + + + Gets the maxY value, which should be Y. + + The IEnvelope that this calculation is for. + The double value representing the Max Y value of this rectangle + + + + Translates this envelope by given amounts in the X and Y direction. + + The IEnvelope to use with this method + The amount to translate along the X axis. + The amount to translate along the Y axis. + + + + Translates the envelope by given amounts up to the minimum dimension between + the envelope and the shift coordinate. (e.g., A 2D envelope will only + be shifted in 2 dimensions because it has no Z, while a 2D coordinate + can only shift a cube based on the X and Y positions, leaving the Z + info alone. + + The IEnvelope to use with this method + + This does nothing to a "NULL" envelope + + + + Overlaps is defined as intersecting, but having some part of each envelope that is also outside + of the other envelope. Therefore it would amount to saying "Intersects And Not Contains And Not Within" + + The IEnvelope to use with this method + + + + + + For a point, or coordinate, this is a degenerate case and + will simply perform an intersection test instead. + + The IEnvelope to use with this method + + + + + + For a point, or coordinate, this is a degenerate case and + will simply perform an intersection test instead. + + The IEnvelope to use with this method + The x coordinate + The y coordinate + Boolean, true if the specified point intersects with this envelope + + + + Evaluates if the specified coordinate is found inside or on the border. + This will test all the dimensions shared by both the envelope and point. + + + + + Returns true if the given point lies in or on the envelope. + + The IEnvelope that this is for + the x-coordinate of the point which this Envelope is + being checked for containing. + the y-coordinate of the point which this Envelope is + being checked for containing. + true if (x, y) lies in the interior or + on the boundary of this Envelope. + + + + Returns true if the other IEnvelope is within this envelope in all dimensions. + If the boundaries touch, this will true. This will test the number of + dimensions that is the smallest dimensionality. This will ignore M values. + + The first envelope (this object when extending) + the Envelope which this Envelope is being checked for containing. + true if other is contained in this Envelope. + + + + Computes the distance between this and another Envelope. + The distance between overlapping Envelopes is 0. Otherwise, the + distance is the hyper Euclidean distance between the closest points. + M values are ignored, but every dimension is considered, up to + the minimum of the number of ordinates between the two envelopes. + Use Distance with a dimension specified to force 2D distance calculations. + + The first envelope (this object when extending) + The other envelope to calculate the distance to + The distance between this and another Envelope. + Null cases produce a distance of -1 + + + + Sometimes only two dimensions are important, and the full dimensionality is not needed. + The Distance 2D performs the same distance check but only in X and Y, regardless + of how many dimensions exist in the envelopes. Both envelopes should have at least + two ordinates however. (Not a criteria of the Distance() method) + + The first envelope (this object when extending) + The other envelope to calculate the distance to + + + + + Calculates the distance specifically in 3D, even if the envelope + exists in higher dimensions. The NumOrdinates of both envelopes + must be at least 3. + + The first envelope (this object when extending) + The other envelope to calculate the distance to + + + + + Uses the specified distance to expand the envelope by that amount in all dimensions. + + + + + + + Uses the dimensions of the specified distances coordinate to + specify the amount to expand the envelopes in each ordinate. + This will apply the method to the minimum dimensions between + the distances coordinate and this envelope. (eg. A 2D + distances coordinate will not affect Z values in the envelope). + + The first envelope (this object when extending) + The distance to expand the envelope. + + + + Expands this envelope by a given distance in all directions. + Both positive and negative distances are supported. + + The first envelope (this object when extending) + The distance to expand the envelope along the the X axis. + The distance to expand the envelope along the the Y axis. + + + + Enlarges the boundary of the Envelope so that it contains (p). + Does nothing if (p) is already on or within the boundaries. + This executes to the minimum of dimensions between p and this envelope. + + The first envelope (this object when extending) + The Coordinate. + + + + Enlarges the boundary of the Envelope so that it contains + (x, y). Does nothing if (x, y) is already on or within the boundaries. + + The first envelope (this object when extending) + The value to lower the minimum x to or to raise the maximum x to. + The value to lower the minimum y to or to raise the maximum y to. + + + + Enlarges the boundary of the Envelope so that it contains + other. Does nothing if other is wholly on or + within the boundaries. + + The first envelope (this object when extending) + the Envelope to merge with. + + + + Returns the intersection of the specified segment with this bounding box. If there is no intersection, + then this returns null. If the intersection is a corner, then the LineSegment will be degenerate, + that is both the coordinates will be the same. Otherwise, the segment will be returned so that the + direction is the same as the original segment. + + The IEnvelope to use with this method + The LineSegment to intersect. + An ILineSegment that is cropped to fit within the bounding box. + + + + Finds an envelope that represents the intersection between this + envelope and the specified IEnvelope. The number of dimensions of the + returned envelope is the maximum of the NumOrdinates between the two envelopes, + since a 2D envelope will only constrain a cube in 2 dimensions, and allow the + z bounds to remain unaltered. + + The IEnvelope that is being extended by this method + An IEnvelope to compare against + an IEnvelope that bounds the intersection area + + + + Using an envelope intersection has some optimizations by checking against the envelope + of the geometry. In the worst case scenario, the envelope crops the geometry, and a new geometry is created. + This will be much faster if the envelope contains the geometries envelope, however, simply returning + the original geometry. + + The IEnvelope that is being extended by this method + A geometric intersection against the area of this envelope + A geometry, cropped to the space of this envelope if necessary. + + + + Check if the point p overlaps (lies inside) the region of this Envelope. + + The IEnvelope that is being extended by this method + the Coordinate to be tested. + true if the point overlaps this Envelope. + + + + Check if the point (x, y) overlaps (lies inside) the region of this Envelope. + + The IEnvelope that is being extended by this method + the x-ordinate of the point. + the y-ordinate of the point. + true if the point overlaps this Envelope. + + + + This should only be used if the Intersection is not actually required because it uses the Intersection method + and returns false if the return value is null. + + The IEnvelope that is being extended by this method + The segment to be tested against this envelope. + The line segment to compare against. + + + + Tests for intersection (any overlap) between the two envelopes. In cases of unequal + dimensions, the smaller dimension is used (e.g., if a 2D rectangle doesn't intersect + a cube in its own plane, this would return false.) + + The IEnvelope that is being extended by this method + the Envelope which this Envelope is + being checked for overlapping. + + + true if the Envelopes overlap. + + + + + EnumerableEM + + + + + cycles through any strong typed collection where the type implements ICLoneable + and clones each member, inserting that member into the new list. + + The type of the values in the list. + The original enumerable collection of type T. + A deep copy of the list. + + + + A Generic Safe Casting method that should simply exist as part of the core framework + + The type of the member to attempt to cast to. + The original object to attempt to System.Convert. + An output variable of type T. + + + + InsufficientDimensionsException + + + + + Creates a new instance of InsufficientDimensionsException + + + + + Creates a new instance of InsufficientDimesionsException, but specifies the name of the argument, + or a similar string like "both envelopes". + + The string name of the argument to introduce in to exception message + + + + X + + + + + Y + + + + + Z + + + + + Copies the X, Y and Z values from the CoordinateF without doing a conversion. + + X, Y Z + + + + Creates a new FloatVector3 with the specified values + + X + Y + Z + + + + Uses the X, Y and Z values from the coordinate to create a new FloatVector3 + + The coordinate to obtain X, Y and Z values from + + + + tests to see if the specified object has the same X, Y and Z values + + + + + + + Not sure what I should be doing here since Int can't really contain this much info very well + + + + + + Adds all the scalar members of the the two vectors + + Left hand side + Right hand side + + + + + Adds the specified v + + A FloatVector3 to add to this vector + + + + Subtracts all the scalar members of the the two vectors + + Left hand side + Right hand side + + + + + Subtracts the specified value + + A FloatVector3 + + + + Returns the Cross Product of two vectors lhs and V + + Vector, the first input vector + Vector, the second input vector + A FloatVector3 containing the cross product of lhs and V + + + + Multiplies all the scalar members of the the two vectors + + Left hand side + Right hand side + + + + + Multiplies the source vector by a scalar. + + + + + + + + Multiplies this vector by a scalar value. + + The scalar to multiply by + + + + Normalizes the vectors + + + + + Adds the vectors lhs and V using vector addition, which adds the corresponding components + + One vector to be added + A second vector to be added + The sum of the vectors + + + + Tests two float vectors for equality. + + The left hand side FloatVector3 to test. + The right hand side FloatVector3 to test. + Returns true if X, Y and Z are all equal. + + + + Tests two float vectors for inequality. + + The left hand side FloatVector3 to test. + The right hand side FloatVector3 to test. + Returns true if any of X, Y and Z are unequal. + + + + Returns the Cross Product of two vectors lhs and rhs + + Vector, the first input vector + Vector, the second input vector + A FloatVector3 containing the cross product of lhs and V + + + + Divides the components of vector lhs by the respective components + ov vector V and returns the resulting vector. + + FloatVector3 Dividend (Numbers to be divided) + FloatVector3 Divisor (Numbers to divide by) + A FloatVector3 quotient of lhs and V + To prevent divide by 0, if a 0 is in V, it will return 0 in the result + + + + Multiplies each component of vector lhs by the Scalar value + + A vector representing the vector to be multiplied + Double, the scalar value to mulitiply the vector components by + A FloatVector3 representing the vector product of vector lhs and the Scalar + + + + Returns the Inner Product also known as the dot product of two vectors, lhs and V + + The input vector + The vector to take the inner product against lhs + a Double containing the dot product of lhs and V + + + + Multiplies the vectors lhs and V using vector multiplication, + which adds the corresponding components + + A scalar to multpy to the vector + A vector to be multiplied + The scalar product for the vectors + + + + Multiplies each component of vector lhs by the Scalar value + + A vector representing the vector to be multiplied + Double, the scalar value to mulitiply the vector components by + A FloatVector3 representing the vector product of vector lhs and the Scalar + + + + Subtracts FloatVector3 V from FloatVector3 lhs + + A FloatVector3 to subtract from + A FloatVector3 to subtract + The FloatVector3 difference lhs - V + + + + Gets the length of the vector + + + + + Gets the square of length of this vector + + + + + Converts a Well-Known Binary byte data to a Geometry. + + + + + Initialize reader with a standard GeometryFactory. + + + + + Initialize reader with the given GeometryFactory. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Geometry builder. + + + + + Basic implementation of Geometry. + Clone returns a deep copy of the object. + + Binary Predicates: + Because it is not clear at this time what semantics for spatial + analysis methods involving GeometryCollections would be useful, + GeometryCollections are not supported as arguments to binary + predicates (other than ConvexHull) or the Relate method. + + + Set-Theoretic Methods: + The spatial analysis methods will + return the most specific class possible to represent the result. If the + result is homogeneous, a Point, LineString, or + Polygon will be returned if the result contains a single + element; otherwise, a MultiPoint, MultiLineString, + or MultiPolygon will be returned. If the result is + heterogeneous a GeometryCollection will be returned. + + + Representation of Computed Geometries: + The SFS states that the result + of a set-theoretic method is the "point-set" result of the usual + set-theoretic definition of the operation (SFS 3.2.21.1). However, there are + sometimes many ways of representing a point set as a Geometry. + The SFS does not specify an unambiguous representation of a given point set + returned from a spatial analysis method. One goal of NTS is to make this + specification precise and unambiguous. NTS will use a canonical form for + Geometrys returned from spatial analysis methods. The canonical + form is a Geometry which is simple and noded: + Simple means that the Geometry returned will be simple according to + the NTS definition of IsSimple. + Noded applies only to overlays involving LineStrings. It + means that all intersection points on LineStrings will be + present as endpoints of LineStrings in the result. + This definition implies that non-simple geometries which are arguments to + spatial analysis methods must be subjected to a line-dissolve process to + ensure that the results are simple. + + + Constructed Points And The Precision Model: + The results computed by the set-theoretic methods may + contain constructed points which are not present in the input Geometry + s. These new points arise from intersections between line segments in the + edges of the input Geometrys. In the general case it is not + possible to represent constructed points exactly. This is due to the fact + that the coordinates of an intersection point may contain twice as many bits + of precision as the coordinates of the input line segments. In order to + represent these constructed points explicitly, NTS must truncate them to fit + the PrecisionModel. + Unfortunately, truncating coordinates moves them slightly. Line segments + which would not be coincident in the exact result may become coincident in + the truncated representation. This in turn leads to "topology collapses" -- + situations where a computed element has a lower dimension than it would in + the exact result. + When NTS detects topology collapses during the computation of spatial + analysis methods, it will throw an exception. If possible the exception will + report the location of the collapse. + + + + and are not overridden, so that when two + topologically equal Geometries are added to Collections and Dictionaries, they + remain distinct. This behaviour is desired in many cases. + + + + + This has the methods and properties associated with any topology + + + + + Supports the specific methods associated with relationships, usually + returning a boolean style test if the relationship is true. + + + + Contains + + Returns true if other.within(this) returns true. + + The Geometry with which to compare this Geometry. + true if this Geometry contains other. + + + CoveredBy + + Returns true if this geometry is covered by the specified geometry. + + The CoveredBy predicate has the following equivalent definitions: + - Every point of this geometry is a point of the other geometry. + - The DE-9IM Intersection Matrix for the two geometries is T*F**F*** or *TF**F*** or **FT*F*** or **F*TF***. + - g.Covers(this) (CoveredBy is the inverse of Covers). + + Notice the difference between CoveredBy and Within: CoveredBy is a more inclusive relation. + + The Geometry with which to compare this Geometry. + true if this Geometry is covered by . + + + Covers + + Returns true if this geometry covers the specified geometry. + + The Covers predicate has the following equivalent definitions: + - Every point of the other geometry is a point of this geometry. + - The DE-9IM Intersection Matrix for the two geometries is T*****FF* or *T****FF* or ***T**FF* or ****T*FF*. + - g.CoveredBy(this) (Covers is the inverse of CoveredBy). + + Notice the difference between Covers and Contains: Covers is a more inclusive relation. + In particular, unlike Contains it does not distinguish between + points in the boundary and in the interior of geometries. + + + For most situations, Covers should be used in preference to Contains. + As an added benefit, Covers is more amenable to optimization, and hence should be more performant. + + The Geometry with which to compare this Geometry + true if this Geometry covers + + + Crosses + + Returns true if the DE-9IM intersection matrix for the two + Geometrys is + T*T****** (for a point and a curve, a point and an area or a line + and an area) 0******** (for two curves). + + The Geometry with which to compare this Geometry. + + true if the two Geometrys cross. + For this function to return true, the Geometry + s must be a point and a curve; a point and a surface; two curves; or a + curve and a surface. + + + + Disjoint + + Returns true if the DE-9IM intersection matrix for the two + Geometrys is DE-9IM: FF*FF****. + + The Geometry with which to compare this Geometry. + true if the two Geometrys are disjoint. + + + Intersects + + Returns true if disjoint returns false. + + The Geometry with which to compare this Geometry. + true if the two Geometrys intersect. + + + Overlaps + + Returns true if the DE-9IM intersection matrix for the two + Geometrys is + T*T***T** (for two points or two surfaces) + 1*T***T** (for two curves). + + The Geometry with which to compare this Geometry. + + true if the two Geometrys overlap. + For this function to return true, the Geometry + s must be two points, two curves or two surfaces. + + + + Relate + + Returns true if the elements in the DE-9IM intersection + matrix for the two Geometrys match the elements in intersectionPattern + , which may be: + 0 + 1 + 2 + T ( = 0, 1 or 2) + F ( = -1) + * ( = -1, 0, 1 or 2) + For more information on the DE-9IM, see the OpenGIS Simple Features + Specification. + + The Geometry with which to compare this Geometry. + The pattern against which to check the intersection matrix for the two Geometrys. + true if the DE-9IM intersection matrix for the two Geometrys match intersectionPattern. + + + + Returns the DE-9IM intersection matrix for the two Geometrys. + + The Geometry with which to compare this Geometry + + A matrix describing the intersections of the interiors, + boundaries and exteriors of the two Geometrys. + + + + Touches + + Returns true if the DE-9IM intersection matrix for the two + Geometrys is FT*******, F**T***** or F***T****. + + The Geometry with which to compare this Geometry. + + true if the two Geometrys touch; + Returns false if both Geometrys are points. + + + + Within + + Returns true if the DE-9IM intersection matrix for the two + Geometrys is T*F**F***. + + The Geometry with which to compare this Geometry. + true if this Geometry is within other. + + + + An interface for supporting the functions specific to geometry overlay opperations + + + + Difference + + Returns a Geometry representing the points making up this + Geometry that do not make up other. This method + returns the closure of the resultant Geometry. + + The Geometry with which to compute the difference. + The point set difference of this Geometry with other. + + + Intersection + + Returns a Geometry representing the points shared by this + Geometry and other. + + The Geometry with which to compute the intersection. + The points common to the two Geometrys. + + + SymmetricDifference + + Returns a set combining the points in this Geometry not in + other, and the points in other not in this + Geometry. This method returns the closure of the resultant + Geometry. + + The Geometry with which to compute the symmetric difference. + The point set symmetric difference of this Geometry with other. + + + Union + + Returns a Geometry representing all the points in this Geometry + and other. + + The Geometry with which to compute the union. + A set combining the points of this Geometry and the points of other. + + + + This is a lightweight version of the components that represent the strictly data related + commands. + + + + + This returns the index'th BasicGeometry where index is between 0 and NumGeometries - 1. + If there is only one geometry, this will return this object. + + An integer index between 0 and NumGeometries - 1 specifying the basic geometry + A BasicGeometry representing only the specific sub-geometry specified + + + + Returns the string that is the valid GML markup string. + + A String containing the valid GML + + + + Returns the Well-known Binary representation of this Geometry. + For a definition of the Well-known Binary format, see the OpenGIS Simple + Features Specification. + + The Well-known Binary representation of this Geometry. + + + ToString + + Returns the Well-known Text representation of this Geometry. + For a definition of the Well-known Text format, see the OpenGIS Simple + Features Specification. + + + The Well-known Text representation of this Geometry. + + + + + Forces the cached envelope to be re-calculated using the coordinates. + + + + Coordinates + + Using an IList guarantees that we can access indexed coordinates, but the actual implementation + can be either in the form of an array or a list. + + + + + Returns this Geometry's bounding box. If this Geometry is the empty point, + returns an empty Point. If the Geometry is a point, returns a non-empty Point. + Otherwise, returns a Polygon whose points are (minx, miny), (maxx, miny), + (maxx, maxy), (minx, maxy), (minx, miny). + + + + NumGeometries + + Returns the number of Geometries in a Geometry Collection, or 1, if the geometry is not a collection + + + + NumPoints + + Returns the count of this geometry's vertices. The geometries contained by + composite geometries must be geometries. That is, they must implement NumPoints. + + + + + Clarifies the subtype of geometry in string format in accordance with + OGC convenction, but most internal identification simply uses + the type identification. + + + + + Specifies either a Point, Line, Polygon or Empty feature type for simple flow control + + + + + Performs an operation with or on this Geometry's + coordinates. If you are using this method to modify the point, be sure + to call GeometryChanged() afterwards. Notice that you cannot use this + method to + modify this Geometry if its underlying CoordinateSequence's Get method + returns a copy of the Coordinate, rather than the actual Coordinate stored + (if it even stores Coordinates at all). + + The filter to apply to this Geometry's coordinates + + + + Performs an operation with or on this Geometry and its + subelement Geometrys (if any). + Only GeometryCollections and subclasses + have subelement Geometry's. + + + The filter to apply to this Geometry (and + its children, if it is a GeometryCollection). + + + + + Performs an operation with or on this Geometry and its + component Geometry's. Only GeometryCollections and + Polygons have component Geometry's; for Polygons they are the LinearRings + of the shell and holes. + + The filter to apply to this Geometry. + + + + Returns a buffer region around this Geometry having the given width. + The buffer of a Geometry is the Minkowski sum or difference of the Geometry with a disc of radius distance. + + + The width of the buffer, interpreted according to the + PrecisionModel of the Geometry. + + + All points whose distance from this Geometry + are less than or equal to distance. + + + + Buffer + + Returns a buffer region around this Geometry having the given width. + The buffer of a Geometry is the Minkowski sum or difference of the Geometry with a disc of radius distance. + + + The width of the buffer, interpreted according to the + PrecisionModel of the Geometry. + + Cap Style to use for compute buffer. + + All points whose distance from this Geometry + are less than or equal to distance. + + + + Buffer + + Returns a buffer region around this Geometry having the given + width and with a specified number of segments used to approximate curves. + The buffer of a Geometry is the Minkowski sum of the Geometry with + a disc of radius distance. Curves in the buffer polygon are + approximated with line segments. This method allows specifying the + accuracy of that approximation. + + + The width of the buffer, interpreted according to the + PrecisionModel of the Geometry. + + The number of segments to use to approximate a quadrant of a circle. + + All points whose distance from this Geometry + are less than or equal to distance. + + + + Buffer + + Returns a buffer region around this Geometry having the given + width and with a specified number of segments used to approximate curves. + The buffer of a Geometry is the Minkowski sum of the Geometry with + a disc of radius distance. Curves in the buffer polygon are + approximated with line segments. This method allows specifying the + accuracy of that approximation. + + + The width of the buffer, interpreted according to the + PrecisionModel of the Geometry. + + The number of segments to use to approximate a quadrant of a circle. + Cap Style to use for compute buffer. + + All points whose distance from this Geometry + are less than or equal to distance. + + + + + Clears any cached envelopes + + + + + Given the specified test point, this returns the closest point in this geometry. + + + + + + ConvexHull + + Returns the smallest convex Polygon that contains all the points in the Geometry. This obviously applies only to Geometry s which contain 3 or more points. + + the minimum-area convex polygon containing this Geometry's points. + + + + Returns whether this Geometry is greater than, equal to, + or less than another Geometry having the same class. + + A Geometry having the same class as this Geometry. + + A positive number, 0, or a negative number, depending on whether + this object is greater than, equal to, or less than o, as + defined in "Normal Form For Geometry" in the NTS Technical + Specifications. + + + + Distance + + Returns the minimum distance between this Geometry + and the Geometry g. + + The Geometry from which to compute the distance. + + + Equals + + Returns true if the DE-9IM intersection matrix for the two + Geometrys is T*F**FFF*. + + The Geometry with which to compare this Geometry. + true if the two Geometrys are equal. + + + EqualsExact + + Returns true if the two Geometrys are exactly equal, + up to a specified tolerance. + Two Geometries are exactly within a tolerance equal iff: + they have the same class, + they have the same values of Coordinates, + within the given tolerance distance, in their internal + Coordinate lists, in exactly the same order. + If this and the other Geometrys are + composites and any children are not Geometrys, returns + false. + + The Geometry with which to compare this Geometry + Distance at or below which two Coordinates will be considered equal. + + true if this and the other Geometry + are of the same class and have equal internal data. + + + + EqualsExact + + Returns true if the two Geometrys are exactly equal. + Two Geometries are exactly equal iff: + they have the same class, + they have the same values of Coordinates in their internal + Coordinate lists, in exactly the same order. + If this and the other Geometrys are + composites and any children are not Geometrys, returns + false. + This provides a stricter test of equality than equals. + + The Geometry with which to compare this Geometry. + + true if this and the other Geometry + are of the same class and have equal internal data. + + + + + Notifies this Geometry that its Coordinates have been changed by an external + party. When GeometryChanged is called, this method will be called for + this Geometry and its component Geometries. + + + + + Notifies this Geometry that its Coordinates have been changed by an external + party (using a CoordinateFilter, for example). The Geometry will flush + and/or update any information it has cached (such as its Envelope). + + + + GetGeometryN + + Returns an element Geometry from a GeometryCollection, + or this, if the geometry is not a collection. + + The index of the geometry element. + The n'th geometry contained in this geometry. + + + IsWithinDistance + + Tests whether the distance from this Geometry + to another is less than or equal to a specified value. + + the Geometry to check the distance to. + the distance value to compare. + true if the geometries are less than distance apart. + + + Normalize + + Converts this Geometry to normal form (or + canonical form ). Normal form is a unique representation for Geometry + s. It can be used to test whether two Geometrys are equal + in a way that is independent of the ordering of the coordinates within + them. Normal form equality is a stronger condition than topological + equality, but weaker than pointwise equality. The definitions for normal + form use the standard lexicographical ordering for coordinates. "Sorted in + order of coordinates" means the obvious extension of this ordering to + sequences of coordinates. + + + + + Returns the feature representation as GML 2.1.1 XML document. + This XML document is based on Geometry.xsd schema. + NO features or XLink are implemented here! + + + + + Rotates the geometry by the given radian angle around the Origin. + + Coordinate the geometry gets rotated around. + Rotation angle in radian. + + + Area + + Returns the area of this Geometry. + Areal Geometries have a non-zero area. + They override this function to compute the area. + Others return 0.0 + + The area of the Geometry. + + + Boundary + + Returns the boundary, or the empty point if this Geometry + is empty. For a discussion of this function, see the OpenGIS Simple + Features Specification. As stated in SFS Section 2.1.13.1, "the boundary + of a Geometry is a set of Geometries of the next lower dimension." + + The closure of the combinatorial boundary of this Geometry. + + + + Returns the dimension of this Geometrys inherent boundary. + + + The dimension of the boundary of the class implementing this + interface, whether or not this object is the empty point. Returns + Dimension.False if the boundary is the empty point. + + + + Centroid + + Computes the centroid of this Geometry. + The centroid is equal to the centroid of the set of component Geometries of highest + dimension (since the lower-dimension geometries contribute zero "weight" to the centroid). + + A Point which is the centroid of this Geometry. + + + Coordinate + + Returns a vertex of this Geometry + + + + Dimension + + Gets or sets the DotSpatial.Geometries.Dimensions of this Geometry. + + + + EnvelopeInternal + + Returns the interior geometry + + + + Factory + + Gets the factory which contains the context in whcih this geometry was created + + + + InteriorPoint + + Computes an interior point of this Geometry. An interior point is guaranteed + to lie in the interior of the Geometry, if it possible to calculate such a point + exactly. Otherwise, the point may lie on the boundary of the point. + + + + IsEmpty + + Returns whether or not the set of points in this geometry is empty + + + + IsRectangle + + Essentially is false for anything other than a polygon, which + does a check to see if the polygon in question is a rectangle. + + + + IsSimple + + Returns false if the Geometry not simple. Subclasses provide their own definition + of "simple". If this Geometry is empty, returns true. In general, the SFS specifications + of simplicity seem to follow the following rule: A Geometry is simple if the only + self-intersections are at boundary points. For all empty Geometrys, IsSimple==true. + + + + IsValid + + Tests the validity of this Geometry. Subclasses provide their own definition of "valid" + + + + Length + + Returns the length of this Geometry. Linear geometries return their length. + Areal geometries return their perimeter. Others return 0.0 + + + + + There used to be a class for precision model stuff, but for Interface purposes, this will be + communicated as a an enumeration which can later be converted into a full fledged PrecisionModel. + + + + SRID + + Gets/Sets the ID of the Spatial Reference System used by the Geometry. NTS supports Spatial Reference + System information in the simple way defined in the SFS. A Spatial Reference System ID (SRID) is present + in each Geometry object. Geometry provides basic accessor operations for this field, but no others. The SRID + is represented as an integer. + + + + UserData + + Gets/Sets the user data object for this point, if any. A simple scheme for applications to add their own custom + data to a Geometry. An example use might be to add an object representing a Coordinate Reference System. + Notice that user data objects are not present in geometries created by construction methods. + + + + + Creates a sort of default geometry object from the default geometry factory, or creates + a new one if one doesn't exist yet. + + + + + + + + + + + + + + + + A predefined with == . + + + + + + + Returns an element Geometry from a GeometryCollection, + or this, if the geometry is not a collection. + + The index of the geometry element. + The n'th geometry contained in this geometry. + + + + This returns the index'th BasicGeometry where index is between 0 and NumGeometries - 1. + If there is only one geometry, this will return this object. + + An integer index between 0 and NumGeometries - 1 specifying the basic geometry + A BasicGeometry representing only the specific sub-geometry specified + + + + Returns the minimum distance between this Geometry + and the Geometry g. + + The Geometry from which to compute the distance. + + + + Tests whether the distance from this Geometry + to another is less than or equal to a specified value. + + the Geometry to check the distance to. + the distance value to compare. + true if the geometries are less than distance apart. + + + + Given the specified test point, this returns the closest point in this geometry. + + + + + + + Notifies this Geometry that its Coordinates have been changed by an external + party (using a CoordinateFilter, for example). The Geometry will flush + and/or update any information it has cached (such as its Envelope). + + + + + Notifies this Geometry that its Coordinates have been changed by an external + party. When GeometryChanged is called, this method will be called for + this Geometry and its component Geometries. + + + + + Returns true if the DE-9IM intersection matrix for the two + Geometrys is FF*FF****. + + The Geometry with which to compare this Geometry. + true if the two Geometrys are disjoint. + + + + Returns true if the DE-9IM intersection matrix for the two + Geometrys is FT*******, F**T***** or F***T****. + + The Geometry with which to compare this Geometry. + + true if the two Geometrys touch; + Returns false if both Geometrys are points. + + + + + Returns true if disjoint returns false. + + The Geometry with which to compare this Geometry. + true if the two Geometrys intersect. + + + + Returns true if the DE-9IM intersection matrix for the two + Geometrys is + T*T****** (for a point and a curve, a point and an area or a line + and an area) 0******** (for two curves). + + The Geometry with which to compare this Geometry. + + true if the two Geometrys cross. + For this function to return true, the Geometry + s must be a point and a curve; a point and a surface; two curves; or a + curve and a surface. + + + + + Returns true if the DE-9IM intersection matrix for the two + Geometrys is T*F**F***. + + The Geometry with which to compare this Geometry. + true if this Geometry is within other. + + + + Returns true if the DE-9IM intersection matrix for the two + Geometrys is + T*T***T** (for two points or two surfaces) + 1*T***T** (for two curves). + + The Geometry with which to compare this Geometry. + + true if the two Geometrys overlap. + For this function to return true, the Geometry + s must be two points, two curves or two surfaces. + + + + + Returns true if this geometry covers the specified geometry. + + The Covers predicate has the following equivalent definitions: + - Every point of the other geometry is a point of this geometry. + - The DE-9IM Intersection Matrix for the two geometries is T*****FF* or *T****FF* or ***T**FF* or ****T*FF*. + - g.CoveredBy(this) (Covers is the inverse of CoveredBy). + + Notice the difference between Covers and Contains: Covers is a more inclusive relation. + In particular, unlike Contains it does not distinguish between + points in the boundary and in the interior of geometries. + + + For most situations, Covers should be used in preference to Contains. + As an added benefit, Covers is more amenable to optimization, and hence should be more performant. + + The Geometry with which to compare this Geometry + true if this Geometry covers + + + + + + Returns true if this geometry is covered by the specified geometry. + + The CoveredBy predicate has the following equivalent definitions: + - Every point of this geometry is a point of the other geometry. + - The DE-9IM Intersection Matrix for the two geometries is T*F**F*** or *TF**F*** or **FT*F*** or **F*TF***. + - g.Covers(this) (CoveredBy is the inverse of Covers). + + Notice the difference between CoveredBy and Within: CoveredBy is a more inclusive relation. + + The Geometry with which to compare this Geometry. + true if this Geometry is covered by . + + + + + + Returns true if the elements in the DE-9IM intersection + matrix for the two Geometrys match the elements in intersectionPattern + , which may be: + 0 + 1 + 2 + T ( = 0, 1 or 2) + F ( = -1) + * ( = -1, 0, 1 or 2) + For more information on the DE-9IM, see the OpenGIS Simple Features + Specification. + + The Geometry with which to compare this Geometry. + The pattern against which to check the intersection matrix for the two Geometrys. + true if the DE-9IM intersection matrix for the two Geometrys match intersectionPattern. + + + + Returns the DE-9IM intersection matrix for the two Geometrys. + + The Geometry with which to compare this Geometry + + A matrix describing the intersections of the interiors, + boundaries and exteriors of the two Geometrys. + + + + + Returns true if the DE-9IM intersection matrix for the two + Geometrys is T*F**FFF*. + + The Geometry with which to compare this Geometry. + true if the two Geometrys are equal. + + + + Returns the Well-known Text representation of this Geometry. + For a definition of the Well-known Text format, see the OpenGIS Simple + Features Specification. + + + The Well-known Text representation of this Geometry. + + + + + Returns the Well-known Binary representation of this Geometry. + For a definition of the Well-known Binary format, see the OpenGIS Simple + Features Specification. + + The Well-known Binary representation of this Geometry. + + + + Returns the feature representation as GML 2.1.1 XML document. + This XML document is based on Geometry.xsd schema. + NO features or XLink are implemented here! + + + + + Returns a GML string for this geometry + + A String with the GML + + + + Returns the smallest convex Polygon that contains all the + points in the Geometry. This obviously applies only to Geometry + s which contain 3 or more points. + + the minimum-area convex polygon containing this Geometry's points. + + + + Returns a Geometry representing the points shared by this + Geometry and other. + + The Geometry with which to compute the intersection. + The points common to the two Geometrys. + + + + Forces the cached envelope to be re-calculated using the coordinates. + + + + + Clears any cached envelopes + + + + + Returns a Geometry representing all the points in this Geometry + and other. + + The Geometry with which to compute the union. + A set combining the points of this Geometry and the points of other. + + + + Returns a Geometry representing the points making up this + Geometry that do not make up other. This method + returns the closure of the resultant Geometry. + + The Geometry with which to compute the difference. + The point set difference of this Geometry with other. + + + + Returns a set combining the points in this Geometry not in + other, and the points in other not in this + Geometry. This method returns the closure of the resultant + Geometry. + + The Geometry with which to compute the symmetric difference. + The point set symmetric difference of this Geometry with other. + + + + Returns true if the two Geometrys are exactly equal, + up to a specified tolerance. + Two Geometries are exactly within a tolerance equal iff: + they have the same class, + they have the same values of Coordinates, + within the given tolerance distance, in their internal + Coordinate lists, in exactly the same order. + If this and the other Geometrys are + composites and any children are not Geometrys, returns + false. + + The Geometry with which to compare this Geometry + Distance at or below which two Coordinates will be considered equal. + + true if this and the other Geometry + are of the same class and have equal internal data. + + + + + Returns true if the two Geometrys are exactly equal. + Two Geometries are exactly equal iff: + they have the same class, + they have the same values of Coordinates in their internal + Coordinate lists, in exactly the same order. + If this and the other Geometrys are + composites and any children are not Geometrys, returns + false. + This provides a stricter test of equality than equals. + + The Geometry with which to compare this Geometry. + + true if this and the other Geometry + are of the same class and have equal internal data. + + + + + Performs an operation with or on this Geometry's + coordinates. If you are using this method to modify the point, be sure + to call GeometryChanged() afterwards. Notice that you cannot use this + method to + modify this Geometry if its underlying CoordinateSequence's Get method + returns a copy of the Coordinate, rather than the actual Coordinate stored + (if it even stores Coordinates at all). + + The filter to apply to this Geometry's coordinates + + + + Performs an operation with or on this Geometry and its + subelement Geometrys (if any). + Only GeometryCollections and subclasses + have subelement Geometry's. + + + The filter to apply to this Geometry (and + its children, if it is a GeometryCollection). + + + + + Performs an operation with or on this Geometry and its + component Geometry's. Only GeometryCollections and + Polygons have component Geometry's; for Polygons they are the LinearRings + of the shell and holes. + + The filter to apply to this Geometry. + + + + + + + + + + Converts this Geometry to normal form (or + canonical form ). Normal form is a unique representation for Geometry + s. It can be used to test whether two Geometrys are equal + in a way that is independent of the ordering of the coordinates within + them. Normal form equality is a stronger condition than topological + equality, but weaker than pointwise equality. The definitions for normal + form use the standard lexicographical ordering for coordinates. "Sorted in + order of coordinates" means the obvious extension of this ordering to + sequences of coordinates. + + + + + Returns whether this Geometry is greater than, equal to, + or less than another Geometry. + If their classes are different, they are compared using the following + ordering: + Point (lowest), + MultiPoint, + LineString, + LinearRing, + MultiLineString, + Polygon, + MultiPolygon, + GeometryCollection (highest). + If the two Geometrys have the same class, their first + elements are compared. If those are the same, the second elements are + compared, etc. + + A Geometry with which to compare this Geometry + + A positive number, 0, or a negative number, depending on whether + this object is greater than, equal to, or less than o, as + defined in "Normal Form For Geometry" in the NTS Technical + Specifications. + + + + + Returns whether this Geometry is greater than, equal to, + or less than another Geometry having the same class. + + A Geometry having the same class as this Geometry. + + A positive number, 0, or a negative number, depending on whether + this object is greater than, equal to, or less than o, as + defined in "Normal Form For Geometry" in the NTS Technical + Specifications. + + + + + Returns a buffer region around this Geometry having the given + width and with a specified number of segments used to approximate curves. + The buffer of a Geometry is the Minkowski sum of the Geometry with + a disc of radius distance. Curves in the buffer polygon are + approximated with line segments. This method allows specifying the + accuracy of that approximation. + + + The width of the buffer, interpreted according to the + PrecisionModel of the Geometry. + + The number of segments to use to approximate a quadrant of a circle. + Cap Style to use for compute buffer. + + All points whose distance from this Geometry + are less than or equal to distance. + + + + + Returns a buffer region around this Geometry having the given + width and with a specified number of segments used to approximate curves. + The buffer of a Geometry is the Minkowski sum of the Geometry with + a disc of radius distance. Curves in the buffer polygon are + approximated with line segments. This method allows specifying the + accuracy of that approximation. + + + The width of the buffer, interpreted according to the + PrecisionModel of the Geometry. + + The number of segments to use to approximate a quadrant of a circle. + + All points whose distance from this Geometry + are less than or equal to distance. + + + + + Returns a buffer region around this Geometry having the given width. + The buffer of a Geometry is the Minkowski sum or difference of the Geometry with a disc of radius distance. + + + The width of the buffer, interpreted according to the + PrecisionModel of the Geometry. + + Cap Style to use for compute buffer. + + All points whose distance from this Geometry + are less than or equal to distance. + + + + + Returns a buffer region around this Geometry having the given width. + The buffer of a Geometry is the Minkowski sum or difference of the Geometry with a disc of radius distance. + + + The width of the buffer, interpreted according to the + PrecisionModel of the Geometry. + + + All points whose distance from this Geometry + are less than or equal to distance. + + + + + Returns true if other.within(this) returns true. + + The Geometry with which to compare this Geometry. + true if this Geometry contains other. + + + + Rotates the geometry by the given radian angle around the Origin. + + Coordinate the geometry gets rotated around. + Rotation angle in radian. + + + + This is convenient for casting troublesome basic geometries into fully fledged geometries + without having to parse them each time. It uses the constructors, and effectively the default factory. + + + + + + + Returns true if the array contains any non-empty Geometrys. + + an array of Geometrys; no elements may be null + + true if any of the Geometrys + IsEmpty methods return false. + + + + + Returns true if the array contains any null elements. + + an array to validate. + true if any of arrays elements are null. + + + + Returns the Well-known Text representation of this Geometry. + For a definition of the Well-known Text format, see the OpenGIS Simple + Features Specification. + + + The Well-known Text representation of this Geometry. + + + + + Allows each geometry to control any custom behavior that cannot be solved with MemberwiseClone. + The Coordinates of the geometry are already duplicated. + + + + + + Returns whether the two Geometrys are equal, from the point + of view of the EqualsExact method. Called by EqualsExact + . In general, two Geometry classes are considered to be + "equivalent" only if they are the same class. An exception is LineString + , which is considered to be equivalent to its subclasses. + + The Geometry with which to compare this Geometry for equality. + + true if the classes of the two Geometry + s are considered to be equal by the equalsExact method. + + + + + Throws an exception if g's class is GeometryCollection. + (Its subclasses do not trigger an exception). + + + The Geometry to check; + throws ArgumentException if g is a GeometryCollection + but not one of its subclasses. + + + + + Returns the minimum and maximum x and y values in this Geometry + , or a null Envelope if this Geometry is empty. + Unlike EnvelopeInternal, this method calculates the Envelope + each time it is called; EnvelopeInternal caches the result + of this method. + + + This Geometrys bounding box; if the Geometry + is empty, Envelope.IsNull will return true. + + + + + Returns the first non-zero result of CompareTo encountered as + the two Collections are iterated over. If, by the time one of + the iterations is complete, no non-zero result has been encountered, + returns 0 if the other iteration is also complete. If b + completes before a, a positive number is returned; if a + before b, a negative number. + + The left hand side ArrayList to compare. + The right hand side ArrayList to compare. + The first non-zero compareTo result, if any; otherwise, zero. + + + + + + + + + + + + + Rotates the given coordinate by the given radian angle around the Origin. + + Coordinate the geometry gets rotated around. + X-value of the coordinate that gets rotated. + Y-value of the coordinate that gets rotated. + Rotation angle in radian. + + + + + + + + + + + + Tests the specified IEnvelope for an intersection with this Geometry + + The IEnvelope to test + True if the envelope intersects this geometry + + + + Tests the specified location to see if it intersects with this geometry + + The double X coordinate to test + The double Y coordinate to test + Boolean, true if the specified coordinates intersect this geometry + + + + Returns this Geometrys bounding box. If this Geometry + is the empty point, returns an empty Point. If the Geometry + is a point, returns a non-empty Point. Otherwise, returns a + Polygon whose points are (minx, miny), (maxx, miny), (maxx, + maxy), (minx, maxy), (minx, miny). + + + An empty Point (for empty Geometrys), a + Point (for Points) or a Polygon + (in all other cases). + + + + + + + + + + Gets the factory which contains the context in which this point was created. + + The factory for this point. + + + + Gets/Sets the user data object for this point, if any. + A simple scheme for applications to add their own custom data to a Geometry. + An example use might be to add an object representing a Coordinate Reference System. + notice that user data objects are not present in geometries created by + construction methods. + + + + + Gets/Sets the ID of the Spatial Reference System used by the Geometry. + NTS supports Spatial Reference System information in the simple way + defined in the SFS. A Spatial Reference System ID (SRID) is present in + each Geometry object. Geometry provides basic + accessor operations for this field, but no others. The SRID is represented + as an integer. + + + + + Clarifies which subtype of geometry we are working with + + + + + Returns the PrecisionModel used by the Geometry. + + + the specification of the grid of allowable points, for this + Geometry and all other Geometrys. + + + + + Returns a vertex of this Geometry. + + + a Coordinate which is a vertex of this Geometry. + Returns null if this Geometry is empty. + + + + + Returns this Geometry s vertices. If you modify the coordinates + in this array, be sure to call GeometryChanged afterwards. + The Geometrys contained by composite Geometrys + must be Geometry's; that is, they must implement Coordinates. + + The vertices of this Geometry. + + + + Returns the count of this Geometrys vertices. The Geometry + s contained by composite Geometrys must be + Geometry's; that is, they must implement NumPoints. + + The number of vertices in this Geometry. + + + + Returns the number of Geometryes in a GeometryCollection, + or 1, if the geometry is not a collection. + + + + + Returns false if the Geometry not simple. + Subclasses provide their own definition of "simple". If + this Geometry is empty, returns true. + In general, the SFS specifications of simplicity seem to follow the + following rule: + A Geometry is simple if the only self-intersections are at boundary points. + For all empty Geometrys, IsSimple==true. + + + false if this Geometry has any points of + self-tangency, self-intersection or other anomalous points. + + + + + Tests the validity of this Geometry. + Subclasses provide their own definition of "valid". + + true if this Geometry is valid. + + + + Returns whether or not the set of points in this Geometry is empty. + + true if this Geometry equals the empty point. + + + + Returns the area of this Geometry. + Areal Geometries have a non-zero area. + They override this function to compute the area. + Others return 0.0 + + The area of the Geometry. + + + + Returns the length of this Geometry. + Linear geometries return their length. + Areal geometries return their perimeter. + They override this function to compute the length. + Others return 0.0 + + The length of the Geometry. + + + + Computes an interior point of this Geometry. + An interior point is guaranteed to lie in the interior of the Geometry, + if it possible to calculate such a point exactly. Otherwise, + the point may lie on the boundary of the point. + + A Point which is in the interior of this Geometry. + + + + Returns the dimension of this Geometry. + + + The dimension of the class implementing this interface, whether + or not this object is the empty point. + + + + + Returns the dimension of this Geometrys inherent boundary. + + + The dimension of the boundary of the class implementing this + interface, whether or not this object is the empty point. Returns + Dimension.False if the boundary is the empty point. + + + + + Returns the minimum and maximum x and y values in this Geometry + , or a null Envelope if this Geometry is empty. + + + This Geometrys bounding box; if the Geometry + is empty, Envelope.IsNull will return true. + + + + + Gets the IEnvelope that contains this geometry + + + + + + + + + + + Returns the boundary, or the empty point if this Geometry + is empty. For a discussion of this function, see the OpenGIS Simple + Features Specification. As stated in SFS Section 2.1.13.1, "the boundary + of a Geometry is a set of Geometries of the next lower dimension." + + The closure of the combinatorial boundary of this Geometry. + + + + Computes the centroid of this Geometry. + The centroid is equal to the centroid of the set of component Geometries of highest + dimension (since the lower-dimension geometries contribute zero "weight" to the centroid). + + A Point which is the centroid of this Geometry. + + + + This will be overridden by the specific feature type since this is abstract + + + + + Geometry classes support the concept of applying + an IGeometryComponentFilter filter to the Geometry. + The filter is applied to every component of the Geometry + which is itself a Geometry. + (For instance, all the LinearRings in Polygons are visited.) + An IGeometryComponentFilter filter can either + record information about the Geometry + or change the Geometry in some way. + IGeometryComponentFilter is an example of the Gang-of-Four Visitor pattern. + + + + + Performs an operation with or on geom. + + A Geometry to which the filter is applied. + + + + Basic implementation of GeometryCollection. + + + + + Specific topology functions for Mutigeometry code + + + + + Returns the number of geometries contained by this . + + + + + Returns the iTh element in the collection. + + + + + + + Return true if all features in collection are of the same type. + + + + + Gets a System.Array of all the geometries in this collection + + + + + Represents an empty GeometryCollection. + + + + + Internal representation of this GeometryCollection. + + + + + + + + The Geometrys for this GeometryCollection, + or null or an empty array to create the empty + point. Elements may be empty Geometrys, + but not nulls. + + + For create this is used a standard + with == . + + + + + This should only be used by derived classes because it does not actually set the geometries + + + + + This should only be used by derived classes because it does not actually set the geometries + + Specifies the factory that should be used when creating shapes in this multigeometry + + + + + + + The Geometrys for this GeometryCollection, + or null or an empty array to create the empty + point. Elements may be empty Geometrys, + but not nulls. + + + + + + If the input geometry is a singular basic geometry, this will become a collection of 1 geometry. + If the input geometry is a multi- basic geometry, this will simply ensure that each member + is upgraded to a full geometry. + + + + + + + Creates a new Geometry Collection + + + + + + + Given the specified test point, this checks each segment, and will + return the closest point on the specified segment. + + The point to test. + + + + + + + + + + + + This returns the index'th BasicGeometry where index is between 0 and NumGeometries - 1. + If there is only one geometry, this will return this object. + + An integer index between 0 and NumGeometries - 1 specifying the basic geometry + A BasicGeometry representing only the specific sub-geometry specified + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Returns a GeometryCollectionEnumerator: + this IEnumerator returns the parent geometry as first element. + In most cases is more useful the code + geometryCollectionInstance.Geometries.GetEnumerator(): + this returns an IEnumerator over geometries composing GeometryCollection. + + + + + + Handles the duplication process for geometry collections + + + + + + + + + + + Rotates the geometries of the GeometryCollection by the given radian angle around the Origin. + + Coordinate the geometries get rotated around. + Rotation angle in radian. + + + + + + + + + Collects all coordinates of all subgeometries into an Array. + Notice that while changes to the coordinate objects themselves + may modify the Geometries in place, the returned Array as such + is only a temporary container which is not synchronized back. + + The collected coordinates. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Uses an Enumeration to clarify the type of geometry + + + + + + + + + + + + + + + Returns the area of this GeometryCollection. + + + + + Returns the length of this GeometryCollection. + + + + + Return true if all features in collection are of the same type. + + + + + Returns the iTh element in the collection. + + + + + + + Returns the number of geometries contained by this . + + + + + Gets the Envelope that envelops this GeometryCollection + + + + + Iterates over all Geometry's in a GeometryCollection. + Implements a pre-order depth-first traversal of the GeometryCollection + (which may be nested). The original GeometryCollection is + returned as well (as the first object), as are all sub-collections. It is + simple to ignore the GeometryCollection objects if they are not + needed. + + + + + The number of Geometrys in the the GeometryCollection. + + + + + The GeometryCollection being iterated over. + + + + + Indicates whether or not the first element (the GeometryCollection + ) has been returned. + + + + + The index of the Geometry that will be returned when next + is called. + + + + + The iterator over a nested GeometryCollection, or null + if this GeometryCollectionIterator is not currently iterating + over a nested GeometryCollection. + + + + + Constructs an iterator over the given GeometryCollection. + + + The collection over which to iterate; also, the first + element returned by the iterator. + + + + + + + + + + + + + + + + + + + + + A GeometryCollectionNotSupportedException Class + + + + + Creates a new instance of GeometryCollectionNotSupportedException + + + + + Supplies a set of utility methods for building Geometry objects from lists + of Coordinates. + + + + + Factory for Geometry stuff + + + + + Generic constructor that parses a list and tries to form a working + object that implements MapWindow.Interfaces.IGeometry + + some list of things + An object that implements DotSpatial.Geometries.IGeometry + + + + Method to produce a point given a coordinate + + An object that implements DotSpatial.Geometries.ICoordinate + An object that implements DotSpatial.Geometries.IPoint + + + + Creates a new object that implements DotSpatial.Geometries.MultiLineString + given an array of objects that implement DotSpatial.Geometries.ILineStringBase + + The Array of objects that implement DotSpatial.Geometries.IlineStringBase + A new MultiLineString that implements IMultiLineString + + + + Creates an object that implements DotSpatial.Geometries.IGeometryCollection + from an array of objects that implement DotSpatial.Geometries.IGeometry + + An array of objects that implement DotSpatial.Geometries.IGeometry + A new object that implements DotSpatial.Geometries.IGeometryCollection + + + + Creates an object that implements DotSpatial.Geometries.IMultiPolygon from an array of + objects that implement DotSpatial.Geometries.IPolygon + + An Array of objects that implement DotSpatial.Geometries.IPolygon + An object that implements DotSpatial.Geometries.IMultiPolygon + + + + Creates an object that implements DotSpatial.Geometries.ILinearRing from an array of DotSpatial.Geometries.ICoordinates + + An array of objects that implement ICoordinate + An object that implements DotSpatial.Geometries.ILinearRing + + + + Creates an object that implements DotSpatial.Geometries.IMultiPoint from an array of objects that implement DotSpatial.Geometries.ICoordinate + + An array of objects that implement DotSpatial.Geometries.ICoordinate + An object that implements DotSpatial.Geometries.IMultiPoint + + + + Creates an object that implements DotSpatial.Geometries.IMultiPoint from an array of objects that implement DotSpatial.Geometries.ICoordinate + + An array of objects that implement DotSpatial.Geometries.ICoordinate + An object that implements DotSpatial.Geometries.IMultiPoint + + + + Creates an object that implements DotSpatial.Geometries.ILineString from an array of objects that implement DotSpatial.Geometries.ICoordinate + + An array of objects that implement DotSpatial.Geometries.ICoordinate + A DotSpatial.Geometries.ILineString + + + + Creates an object that implements DotSpatial.Geometries.IGeometry that is a copy + of the specified object that implements DotSpatial.Geometries.IGeometry + + An object that implements DotSpatial.Geometries.IGeometry + An copy of the original object that implements DotSpatial.Geometries.IGeometry + + + + Creates an object that implements DotSpatial.Geometries.IPolygon given a specified + DotSpatial.Geometries.ILinearRing shell and an array of + DotSpatial.Geometries.ILinearRing that represent the holes + + The outer perimeter of the polygon, represented by an object that implements DotSpatial.Geometries.ILinearRing + The interior holes in the polygon, represented by an array of objects that implements DotSpatial.Geometries.ILinearRing + An object that implements DotSpatial.Geometries.IPolygon + + + + Floating reference + + + + + + + + + + + + + + + + + + + + CoordinateSequenceFactory that can manufacture a coordinate sequence + + + + + A predefined with == . + + + + + A predefined with + == . + + A shortcut for . + + + + A predefined with + == . + + + + + A predefined with + == . + + + + + Constructs a GeometryFactory that generates Geometries having the given + PrecisionModel, spatial-reference ID, and CoordinateSequence implementation. + + + + + + + + Constructs a GeometryFactory object from any valid IGeometryFactory interface + + + + + + Constructs a GeometryFactory pertaining to a specific _coordinateSequenceFactory + using any valid IGeometryFactory and ICoordinateSequenceFactory interface + + An IGeometryFactory Interface + An ICoordianteSequenceFactory interface + + + + Constructs a GeometryFactory that generates Geometries having the given + CoordinateSequence implementation, a double-precision floating PrecisionModel and a + spatial-reference ID of 0. + + + + + + Constructs a GeometryFactory that generates Geometries having the given + {PrecisionModel} and the default CoordinateSequence + implementation. + + The PrecisionModel to use. + + + + Constructs a GeometryFactory that generates Geometries having the given + PrecisionModel and spatial-reference ID, and the default CoordinateSequence + implementation. + + The PrecisionModel to use. + The SRID to use. + + + + Constructs a GeometryFactory that generates Geometries having a floating + PrecisionModel and a spatial-reference ID of 0. + + + + + Creates a Point using the given Coordinate; a null Coordinate will create + an empty Geometry. + + + + + + Creates a MultiLineString using the given LineStrings; a null or empty + array will create an empty MultiLineString. + + LineStrings, each of which may be empty but not null- + + + + Creates a GeometryCollection using the given Geometries; a null or empty + array will create an empty GeometryCollection. + + Geometries, each of which may be empty but not null. + + + + Creates a MultiPolygon using the given Polygons; a null or empty array + will create an empty Polygon. The polygons must conform to the + assertions specified in the OpenGIS Simple Features + Specification for SQL. + + Polygons, each of which may be empty but not null. + + + + Creates a LinearRing using the given Coordinates; a null or empty array will + create an empty LinearRing. The points must form a closed and simple + linestring. Consecutive points must not be equal. + + An array without null elements, or an empty array, or null. + + + + Creates a MultiPoint using the given Points; a null or empty array will + create an empty MultiPoint. + + An array without null elements, or an empty array, or null. + + + + Creates an object that implements DotSpatial.Geometries.IMultiPoint from an array of objects that implement DotSpatial.Geometries.ICoordinate + + An array of objects that implement DotSpatial.Geometries.ICoordinate + An object that implements DotSpatial.Geometries.IMultiPoint + + + + Constructs a Polygon with the given exterior boundary and + interior boundaries. + + + The outer boundary of the new Polygon, or + null or an empty LinearRing if + the empty point is to be created. + + + The inner boundaries of the new Polygon, or + null or empty LinearRing s if + the empty point is to be created. + + + + + + Build an appropriate Geometry, MultiGeometry, or + GeometryCollection to contain the Geometrys in + it. + + If geomList contains a single Polygon, + the Polygon is returned. + If geomList contains several Polygons, a + MultiPolygon is returned. + If geomList contains some Polygons and + some LineStrings, a GeometryCollection is + returned. + If geomList is empty, an empty GeometryCollection + is returned. + Notice that this method does not "flatten" Geometries in the input, and hence if + any MultiGeometries are contained in the input a GeometryCollection containing + them will be returned. + + + The Geometrys to combine. + A Geometry of the "smallest", "most type-specific" class that can contain the elements of geomList. + + + + Creates a LineString using the given Coordinates; a null or empty array will + create an empty LineString. Consecutive points must not be equal. + + An array without null elements, or an empty array, or null. + + + + + + + + + A clone of g based on a CoordinateSequence created by this + GeometryFactory's CoordinateSequenceFactory. + + + + + + + + + + + + + Converts the List to an array. + + The List of Points to convert. + The List in array format. + + + + Converts the List to an array. + + The list of Geometry's to convert. + The List in array format. + + + + Converts the List to an array. + + The List of LinearRings to convert. + The List in array format. + + + + Converts the List to an array. + + The List of LineStrings to convert. + The List in array format. + + + + Converts the List to an array. + + The List of Polygons to convert. + The List in array format. + + + + Converts the List to an array. + + The List of MultiPolygons to convert. + The List in array format. + + + + Converts the List to an array. + + The List of MultiLineStrings to convert. + The List in array format. + + + + Converts the List to an array. + + The List of MultiPoints to convert. + The List in array format. + + + + If the Envelope is a null Envelope, returns an + empty Point. If the Envelope is a point, returns + a non-empty Point. If the Envelope is a + rectangle, returns a Polygon whose points are (minx, miny), + (maxx, miny), (maxx, maxy), (minx, maxy), (minx, miny). + + The Envelope to convert to a Geometry. + + An empty Point (for null Envelope + s), a Point (when min x = max x and min y = max y) or a + Polygon (in all other cases) + throws a TopologyException if coordinates + is not a closed linestring, that is, if the first and last coordinates + are not equal. + + + + + Creates a MultiPoint using the given CoordinateSequence; a null or empty CoordinateSequence will + create an empty MultiPoint. + + A CoordinateSequence possibly empty, or null. + + + + + + + + + + A default IGeometryFactory. + + + + + Returns the Fixed geometry factory + + + + + The floating IGeometryFactory + + + + + A floating Single IGeometryFactory + + + + + Returns the PrecisionModel that Geometries created by this factory + will be associated with. + + + + + + + + + + + + + + + A GeometryEditorOperation which modifies the coordinate list of a Geometry. + Operates on Geometry subclasses which contains a single coordinate list. + + + + + A interface which specifies an edit operation for Geometries. + + + + + Supports creating a new Geometry which is a modification of an existing one. + Geometry objects are intended to be treated as immutable. + This class allows you to "modify" a Geometry + by traversing it and creating a new Geometry with the same overall structure but + possibly modified components. + The following kinds of modifications can be made: + + The values of the coordinates may be changed. + Changing coordinate values may make the result Geometry invalid; + this is not checked by the GeometryEditor. + + The coordinate lists may be changed + (e.g. by adding or deleting coordinates). + The modifed coordinate lists must be consistent with their original parent component + (e.g. a LinearRing must always have at least 4 coordinates, and the first and last + coordinate must be equal). + + Components of the original point may be deleted + (e.g. holes may be removed from a Polygon, or LineStrings removed from a MultiLineString). + Deletions will be propagated up the component tree appropriately. + + Notice that all changes must be consistent with the original Geometry's structure + (e.g. a Polygon cannot be collapsed into a LineString). + The resulting Geometry is not checked for validity. + If validity needs to be enforced, the new Geometry's IsValid should be checked. + + + + + The factory used to create the modified Geometry. + + + + + Creates a new GeometryEditor object which will create + an edited Geometry with the same {GeometryFactory} as the input Geometry. + + + + + Creates a new GeometryEditor object which will create + the edited Geometry with the given GeometryFactory. + + The GeometryFactory to create the edited Geometry with. + + + + Edit the input Geometry with the given edit operation. + Clients will create subclasses of GeometryEditorOperation or + CoordinateOperation to perform required modifications. + + The Geometry to edit. + The edit operation to carry out. + A new Geometry which is the result of the editing. + + + + + + + + + + + + + + + + + + + + A GeometryEditorOperation which modifies the coordinate list of a Geometry. + Operates on Geometry subclasses which contains a single coordinate list. + + + + + A interface which specifies an edit operation for Geometries. + + + + + Edits a Geometry by returning a new Geometry with a modification. + The returned Geometry might be the same as the Geometry passed in. + + The Geometry to modify. + + The factory with which to construct the modified Geometry + (may be different to the factory of the input point). + + A new Geometry which is a modification of the input Geometry. + + + + + + + + + + + + Edits the array of Coordinates from a Geometry. + + The coordinate array to operate on. + The point containing the coordinate list. + An edited coordinate array (which may be the same as the input). + + + + Writes the GML representation of the features of Topology model. + Uses GML 2.1.1 Geometry.xsd schema for base for features. + + + + + Returns an XmlReader with feature informations. + Use XmlDocument.Load(XmlReader) for obtain a XmlDocument to work. + + + + + + + Writes a GML feature into a generic Stream, such a FileStream or other streams. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Sets corrent length for Byte Stream. + + + + + + + Sets corrent length for Byte Stream. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Formatter for double values of coordinates + + + + + This is the simpler interface to implement + + + + + This is a BasicGeometry that contains information about a specific point. + The easier way to do this is have the IPoint inherit the IBasicGeometry + and the store implementations for ICoordinate. + + + + + Adds any topology functions to the basic Vector ICoordinate + + + + + Return HashCode. + + + + + A Measure coordinate + + + + + A 1D coordinate only has a valid X. A 2D coordinate has X and Y, while a 3D coordinate + has X, Y, and Z. Presumably this is open ended and could support higher coordinates, + but this coordinate is not responsible for storing values beyond its dimension and + may cause exceptions if a value higher than the dimension is used. + + + + + Gets a double value for the specified zero based ordinate. + + The zero based integer ordinate. + A double value. + + + + Gets or sets the values as a one dimensional array of doubles. + + + + + The X coordinate + + + + + The Y coordinate + + + + + The Z coordinate + + + + + This supports some of the basic data-related capabilities of a polygon, but no topology functions. + Each of these uses the specifically different nomenclature so that the parallel concepts in a + full Polygon can return the appropriate datatype. Since Polygon will Implement IPolygonBase, it + is the responsibility of the developer to perform the necessary casts when returning this + set from the more complete topology classes. + + + + + Gets the list of Interior Rings in the form of ILineStringBase objects + + + + + Gets the exterior ring of the polygon as an ILineStringBase. + + + + + Gets the count of holes or interior rings + + + + + ICoordinateF + + + + + Gets or sets the X coordinate using a single precision floating point + + + + + Gets or sets the Y coordinate using a single precision floating point value + + + + + Gets or sets the Z coordinate using a single precision floating point value + + + + + Geometry classes support the concept of applying a + coordinate filter to every coordinate in the Geometry. A + coordinate filter can either record information about each coordinate or + change the coordinate in some way. Coordinate filters implement the + interface ICoordinateFilter. + ICoordinateFilter is an example of the Gang-of-Four Visitor pattern. + Coordinate filters can be + used to implement such things as coordinate transformations, centroid and + envelope computation, and many other functions. + + + + + Performs an operation with or on coord. + + Coordinate to which the filter is applied. + + + + GeometryCollection classes support the concept of + applying a IGeometryFilter to the Geometry. + The filter is applied to every element Geometry. + A IGeometryFilter can either record information about the Geometry + or change the Geometry in some way. + IGeometryFilter is an example of the Gang-of-Four Visitor pattern. + + + + + Performs an operation with or on geom. + + A Geometry to which the filter is applied. + + + + A Dimensionally Extended Nine-Intersection Model (DE-9IM) matrix. This class + can used to represent both computed DE-9IM's (like 212FF1FF2) as well as + patterns for matching them (like T*T******). + Methods are provided to: + Set and query the elements of the matrix in a convenient fashion + convert to and from the standard string representation (specified in + SFS Section 2.1.13.2). + Test to see if a matrix matches a given pattern string. + For a description of the DE-9IM, see the OpenGIS Simple Features + Specification for SQL. + + + + + Adds one matrix to another. + Addition is defined by taking the maximum dimension value of each position + in the summand matrices. + + The matrix to add. + + + + Changes the value of one of this IntersectionMatrixs + elements. + + + The row of this IntersectionMatrix, + indicating the interior, boundary or exterior of the first Geometry + + + The column of this IntersectionMatrix, + indicating the interior, boundary or exterior of the second Geometry + + + The new value of the element + + + + + Changes the elements of this IntersectionMatrix to the + dimension symbols in dimensionSymbols. + + + Nine dimension symbols to which to set this IntersectionMatrix + s elements. Possible values are {T, F, *, 0, 1, 2} + + + + + Changes the specified element to minimumDimensionValue if the + element is less. + + + The row of this IntersectionMatrix + , indicating the interior, boundary or exterior of the first Geometry. + + + The column of this IntersectionMatrix + , indicating the interior, boundary or exterior of the second Geometry. + + + The dimension value with which to compare the + element. The order of dimension values from least to greatest is + True, False, Dontcare, 0, 1, 2. + + + + + If row >= 0 and column >= 0, changes the specified element to minimumDimensionValue + if the element is less. Does nothing if row is smaller to 0 or column is smaller to 0. + + + + + + + + For each element in this IntersectionMatrix, changes the + element to the corresponding minimum dimension symbol if the element is + less. + + + Nine dimension symbols with which to + compare the elements of this IntersectionMatrix. The + order of dimension values from least to greatest is Dontcare, True, False, 0, 1, 2. + + + + + Changes the elements of this IntersectionMatrix to dimensionValue. + + + The dimension value to which to set this IntersectionMatrix + s elements. Possible values True, False, Dontcare, 0, 1, 2}. + + + + + Returns the value of one of this IntersectionMatrixs + elements. + + + The row of this IntersectionMatrix, indicating + the interior, boundary or exterior of the first Geometry. + + + The column of this IntersectionMatrix, + indicating the interior, boundary or exterior of the second Geometry. + + The dimension value at the given matrix position. + + + + Returns true if this IntersectionMatrix is + FF*FF****. + + + true if the two Geometrys related by + this IntersectionMatrix are disjoint. + + + + + Returns true if isDisjoint returns false. + + + true if the two Geometrys related by + this IntersectionMatrix intersect. + + + + + Returns true if this IntersectionMatrix is + FT*******, F**T***** or F***T****. + + The dimension of the first Geometry. + The dimension of the second Geometry. + + true if the two Geometry + s related by this IntersectionMatrix touch; Returns false + if both Geometrys are points. + + + + + Returns true if this IntersectionMatrix is + T*T****** (for a point and a curve, a point and an area or a line + and an area) 0******** (for two curves). + + The dimension of the first Geometry. + The dimension of the second Geometry. + + true if the two Geometry + s related by this IntersectionMatrix cross. For this + function to return true, the Geometrys must + be a point and a curve; a point and a surface; two curves; or a curve + and a surface. + + + + + Returns true if this IntersectionMatrix is + T*F**F***. + + true if the first Geometry is within the second. + + + + Returns true if this IntersectionMatrix is + T*****FF*. + + true if the first Geometry contains the second. + + + + Returns true if this IntersectionMatrix is T*****FF* + or *T****FF* or ***T**FF* or ****T*FF*. + + true if the first Geometry covers the second + + + + Returns true if this IntersectionMatrix is T*F**FFF*. + + The dimension of the first Geometry. + The dimension of the second Geometry. + + true if the two Geometry + s related by this IntersectionMatrix are equal; the + Geometrys must have the same dimension for this function + to return true. + + + + + Returns true if this IntersectionMatrix is + T*T***T** (for two points or two surfaces) + 1*T***T** (for two curves). + + The dimension of the first Geometry. + The dimension of the second Geometry. + + true if the two Geometry + s related by this IntersectionMatrix overlap. For this + function to return true, the Geometrys must + be two points, two curves or two surfaces. + + + + + Returns whether the elements of this IntersectionMatrix + satisfies the required dimension symbols. + + + Nine dimension symbols with which to + compare the elements of this IntersectionMatrix. Possible + values are {T, F, *, 0, 1, 2}. + + + true if this IntersectionMatrix + matches the required dimension symbols. + + + + + Transposes this IntersectionMatrix. + + This IntersectionMatrix as a convenience, + + + + Returns a nine-character String representation of this IntersectionMatrix. + + + The nine dimension symbols of this IntersectionMatrix + in row-major order. + + + + + A closed, non-self intersecting Linestring + + + + + This adds the basic functionality of a + + + + + Retrieves a topologically complete IPoint for the n'th coordinate in the + 0 based index of point values. + + Integer index specifying the point to retrieve + IPoint to retrieve + + + + Returns an ILineString that has its coordinates completely reversed + + + + + + Returns true if the given point is a vertex of this LineString. + + The Coordinate to check. + true if pt is one of this LineString's vertices. + + + + Gets a topologically complete IPoint for the first coordinate + + + + + Gets a topologically complete IPoint for the last coordinate + + + + + If the first coordinate is the same as the final coordinate, then the + linestring is closed. + + + + + If the coordinates listed for the linestring are both closed and simple then + they qualify as a linear ring. + + + + + Returns the value of the angle between the + and the . + + + + + Represents a line segment defined by two Coordinates. + Provides methods to compute various geometric properties + and relationships of line segments. + This class is designed to be easily mutable (to the extent of + having its contained points public). + This supports a common pattern of reusing a single LineSegment + object as a way of computing segment properties on the + segments defined by arrays or lists of Coordinates. + + + + + This is a low-level place holder for a linestring with only two points. + This does not inherit geometry (Use ILineString for those features). + The Idea is that this provides just enough information to communicate + the definition of a LineSegment. + + + + + The first of two coordinates that defines the segment + + + + + The second of two endpoints that defines the segment + + + + + Returns an ICoordinate for the point specified by index i. + + Integer point index. 0 returns the first point, 1 returns the second. + ICoordinate + + + + Sets the two coordinates to match the coordinates in the specified ILineSegment + + + + + + Sets the two coordinates of this ILineString based on the ICoordinate + values passed. + + An ICoordinate that specifies the startpoint of the segment + An ICoordinate that specifies the location of the endpoint of the segment + + + + Determines the orientation of a LineSegment relative to this segment. + The concept of orientation is specified as follows: + Given two line segments A and L, + A is to the left of a segment L if A lies wholly in the + closed half-plane lying to the left of L + A is to the right of a segment L if A lies wholly in the + closed half-plane lying to the right of L + otherwise, A has indeterminate orientation relative to L. This + happens if A is collinear with L or if A crosses the line determined by L. + + The LineSegment to compare. + + 1 if seg is to the left of this segment, + -1 if seg is to the right of this segment, + 0 if seg has indeterminate orientation relative to this segment. + + + + + Reverses the direction of the line segment. + + + + + Puts the line segment into a normalized form. + This is useful for using line segments in maps and indexes when + topological equality rather than exact equality is desired. + + + + + Computes the distance between this line segment and another one. + + + + + + + Computes the distance between this line segment and a point. + + + + + Computes the perpendicular distance between the (infinite) line defined + by this line segment and a point. + + + + + + + Compute the projection factor for the projection of the point p + onto this LineSegment. The projection factor is the constant k + by which the vector for this segment must be multiplied to + equal the vector for the projection of p. + + + + + + + Compute the projection of a point onto the line determined + by this line segment. + Notice that the projected point + may lie outside the line segment. If this is the case, + the projection factor will lie outside the range [0.0, 1.0]. + + + + + + + Project a line segment onto this line segment and return the resulting + line segment. The returned line segment will be a subset of + the target line line segment. This subset may be null, if + the segments are oriented in such a way that there is no projection. + Notice that the returned line may have zero length (i.e. the same endpoints). + This can happen for instance if the lines are perpendicular to one another. + + The line segment to project. + The projected line segment, or null if there is no overlap. + + + + Computes the closest point on this line segment to another point. + + The point to find the closest point to. + + A Coordinate which is the closest point on the line segment to the point p. + + + + + Computes the closest points on a line segment. + + + + A pair of Coordinates which are the closest points on the line segments. + + + + + Computes an intersection point between two segments, if there is one. + There may be 0, 1 or many intersection points between two segments. + If there are 0, null is returned. If there is 1 or more, a single one + is returned (chosen at the discretion of the algorithm). If + more information is required about the details of the intersection, + the {RobustLineIntersector} class should be used. + + + An intersection point, or null if there is none. + + + + Performs an intersection of this line segment with the specified envelope + + The envelope to compare against + An ILineSegment, or null if there is no intersection. + + + + Determines if any portion of this segment intersects the specified extent. + + The + Boolean, true if this line segment intersects the specified envelope + + + + Returns true if other is + topologically equal to this LineSegment (e.g. irrespective + of orientation). + + + A LineSegment with which to do the comparison. + + + true if other is a LineSegment + with the same values for the x and y ordinates. + + + + + Returns Well Known Text for a LineString with just 2 points + + String: Well Known Text + + + + Computes the length of the line segment. + + The length of the line segment. + + + + Tests whether the segment is horizontal. + + true if the segment is horizontal. + + + + Tests whether the segment is vertical. + + true if the segment is vertical. + + + + The angle this segment makes with the x-axis (in radians). + + + + + IMatrix + + + + + Performs the matrix multiplication against the specified matrix + + + + + + + Gets the number of rows + + + + + Gets the number of columns + + + + + Operations on 3D vectors can be carried out using a 4D Matrix. This interface + provides access to methods that are specific to 3D vector opperations. + + + + + IMatrix4 + + + + + Multiplies every value in the specified n x m matrix by the specified double inScalar. + + The double precision floating point to multiply all the members against + A new n x m matrix + + + + This replaces the underlying general multiplication with a more specific type. + + + + + + + Gets or sets the values for this matrix of double precision coordinates + + + + + Specifies amount to rotate + + + + + + + Multiplies the current matrix by a rotation matrix corresponding + to the specified angle to create rotation in the Z direction. + + The angle to rotate in degrees. + + + + + Rotates the current matrix around the Y axis by multiplying the + current matrix by a rotation matrix. + + + + + + + Translates the matrix by the specified amount in each of the directions + by multiplying by a translation matrix created from the specified values. + + The translation in the X coordinate + The translation in the Y coordinate + The translation in the Z coordinate + + + + + A type specific Geometry collection that deals with ILineStrings + + + + + Changes the default indexer to assume that the members are ILineString instead of simply IGeometry + + + + + + + A type specific MultiGeometry that specifically uses points + + + + + Gets or sets the point that resides at the specified index + + A zero-based integer index specifying the point to get or set + + + + + specifically for handling + + + + + A Dimensionally Extended Nine-Intersection Model (DE-9IM) matrix. This class + can used to represent both computed DE-9IM's (like 212FF1FF2) as well as + patterns for matching them (like T*T******). + Methods are provided to: + Set and query the elements of the matrix in a convenient fashion + convert to and from the standard string representation (specified in + SFS Section 2.1.13.2). + Test to see if a matrix matches a given pattern string. + For a description of the DE-9IM, see the OpenGIS Simple Features + Specification for SQL. + + + + + Internal representation of this IntersectionMatrix. + + + + + Creates an IntersectionMatrix with Null location values. + + + + + Creates an IntersectionMatrix with the given dimension + symbols. + + A string of nine dimension symbols in row major order. + + + + Creates an IntersectionMatrix with the same elements as + other. + + An IntersectionMatrix to copy. + + + + Adds one matrix to another. + Addition is defined by taking the maximum dimension value of each position + in the summand matrices. + + The matrix to add. + + + + Changes the value of one of this IntersectionMatrixs + elements. + + + The row of this IntersectionMatrix, + indicating the interior, boundary or exterior of the first Geometry + + + The column of this IntersectionMatrix, + indicating the interior, boundary or exterior of the second Geometry + + + The new value of the element + + + + + Changes the elements of this IntersectionMatrix to the + dimension symbols in dimensionSymbols. + + + Nine dimension symbols to which to set this IntersectionMatrix + s elements. Possible values are {T, F, *, 0, 1, 2} + + + + + Changes the specified element to minimumDimensionValue if the + element is less. + + + The row of this IntersectionMatrix + , indicating the interior, boundary or exterior of the first Geometry. + + + The column of this IntersectionMatrix + , indicating the interior, boundary or exterior of the second Geometry. + + + The dimension value with which to compare the + element. The order of dimension values from least to greatest is + True, False, Dontcare, 0, 1, 2. + + + + + If row >= 0 and column >= 0, changes the specified element to minimumDimensionValue + if the element is less. Does nothing if row is smaller to 0 or column is smaller to 0. + + + + + + + + For each element in this IntersectionMatrix, changes the + element to the corresponding minimum dimension symbol if the element is + less. + + + Nine dimension symbols with which to + compare the elements of this IntersectionMatrix. The + order of dimension values from least to greatest is Dontcare, True, False, 0, 1, 2. + + + + + Changes the elements of this IntersectionMatrix to dimensionValue. + + + The dimension value to which to set this IntersectionMatrix + s elements. Possible values True, False, Dontcare, 0, 1, 2}. + + + + + Returns the value of one of this IntersectionMatrixs + elements. + + + The row of this IntersectionMatrix, indicating + the interior, boundary or exterior of the first Geometry. + + + The column of this IntersectionMatrix, + indicating the interior, boundary or exterior of the second Geometry. + + The dimension value at the given matrix position. + + + + Returns true if this IntersectionMatrix is + FF*FF****. + + + true if the two Geometrys related by + this IntersectionMatrix are disjoint. + + + + + Returns true if isDisjoint returns false. + + + true if the two Geometrys related by + this IntersectionMatrix intersect. + + + + + Returns true if this IntersectionMatrix is + FT*******, F**T***** or F***T****. + + The dimension of the first Geometry. + The dimension of the second Geometry. + + true if the two Geometry + s related by this IntersectionMatrix touch; Returns false + if both Geometrys are points. + + + + + Returns true if this IntersectionMatrix is + T*T****** (for a point and a curve, a point and an area or a line + and an area) 0******** (for two curves). + + The dimension of the first Geometry. + The dimension of the second Geometry. + + true if the two Geometry + s related by this IntersectionMatrix cross. For this + function to return true, the Geometrys must + be a point and a curve; a point and a surface; two curves; or a curve + and a surface. + + + + + Returns true if this IntersectionMatrix is + T*F**F***. + + true if the first Geometry is within the second. + + + + Returns true if this IntersectionMatrix is + T*****FF*. + + true if the first Geometry contains the second. + + + + Returns true if this IntersectionMatrix is T*****FF* + or *T****FF* or ***T**FF* or ****T*FF*. + + true if the first Geometry covers the second + + + + Returns true if this IntersectionMatrix is T*F**FFF*. + + The dimension of the first Geometry. + The dimension of the second Geometry. + + true if the two Geometry + s related by this IntersectionMatrix are equal; the + Geometrys must have the same dimension for this function + to return true. + + + + + Returns true if this IntersectionMatrix is + T*T***T** (for two points or two surfaces) + 1*T***T** (for two curves). + + The dimension of the first Geometry. + The dimension of the second Geometry. + + true if the two Geometry + s related by this IntersectionMatrix overlap. For this + function to return true, the Geometrys must + be two points, two curves or two surfaces. + + + + + Returns whether the elements of this IntersectionMatrix + satisfies the required dimension symbols. + + + Nine dimension symbols with which to + compare the elements of this IntersectionMatrix. Possible + values are {T, F, *, 0, 1, 2}. + + + true if this IntersectionMatrix + matches the required dimension symbols. + + + + + Transposes this IntersectionMatrix. + + This IntersectionMatrix as a convenience, + + + + Returns a nine-character String representation of this IntersectionMatrix. + + + The nine dimension symbols of this IntersectionMatrix + in row-major order. + + + + + Returns true if the dimension value satisfies the dimension symbol. + + + A number that can be stored in the IntersectionMatrix + . Possible values are True, False, Dontcare, 0, 1, 2. + + + A character used in the string + representation of an IntersectionMatrix. Possible values + are T, F, *, 0, 1, 2. + + + True if the dimension symbol encompasses + the dimension value. + + + + + Returns true if each of the actual dimension symbols satisfies the + corresponding required dimension symbol. + + + Nine dimension symbols to validate. + Possible values are T, F, *, 0, 1, 2. + + + Nine dimension symbols to validate + against. Possible values are T, F, *, 0, 1, 2. + + + True if each of the required dimension + symbols encompass the corresponding actual dimension symbol. + + + + + See methods Get(int, int) and Set(int, int, int value) + + + + + This combines the full Topology.Geometry functions to the complete Vector.IPoint set of functions. + + + + + Full powered topology style Polygon + + + + + Gets a specific ILinearRing identified by the 0 based index n + + A 0 based integer index enumerating the rings + ILinearRing outlining the n'th hole in the polygon + + + + Gets the ILinearRing for the Exterior Ring. + + + + + Gets the System.Array of ILinearRings that make up the holes in the polygon. + + + + + ISize interface for expressing a length in the X, Y or Z directions + + + + + Gets or sets the size in the x direction or longitude + + + + + Gets or sets the size in the y direction or latitude + + + + + Gets or sets the size in the z direction or altitude + + + + + Contains a magnitude and direction + Supports more fundamental calculations than LineSegment, rather than topological functions + + + + + Transforms a point that has 3 dimensions by multiplying it by the + specified 3 x 3 matrix in the upper left, but treats the + bottom row as supplying the translation coordinates. + + + + + + + Rotations and transformations work by applying matrix mathematics, + so this creates a 1 x 4 version of this vector. The 4th value + is always 1, and allows for the translation terms to work. + + + + + + Returns the square of the distance of the vector without taking the square root + This is the same as doting the vector with itself + + Double, the square of the distance between the vectors + + + + Assuming the vector starts at the origin of 0, 0, 0, this function returns + a Point representing the tip of the vector. + + + + + Converts this vector to a coordinate by assuming that the X, Y and Z values + are the X, Y and Z values of the locaiton. + + An ICoordinate + + + + Returns a new segment from this vector, where the StartPoint is 0, 0, 0 + and the End Point is the tip of this vector + + An implementation of ILineSegment + + + + Normalizes the vector. + + + + + Returns the cross product of this vector with the specified vector V + + The vector to perform a cross product against + A vector result from the inner product + + + + Returns the dot product of this vector with V2 + + The vector to perform an inner product against + A Double result from the inner product + + + + Compares the values of each element, and if all the elements are equal, returns true. + + The vector to compare against this vector. + Boolean, true if all the elements have the same value. + + + + Override for definition of equality for vectors + + A vector to compare with + true if the X, Y, and Z coordinates are all equal + + + + Subtracts each element of V from each element of this vector + + Vector, the vector to subtract from this vector + A vector result from the subtraction + + + + Adds each of the elements of V to the elements of this vector + + Vector, the vector to add to this vector + A vector result from the addition + + + + Returns the scalar product of this vector against a scalar + + Double, a value to multiply against all the members of this vector + A vector multiplied by the scalar + + + + Rotates the vector about the X axis as though the tail of the vector were at the origin + + The angle in degrees to rotate counter-clockwise when looking at the origin from the positive axis. + A new IVector that has been rotated + + + + Rotates the vector about the Y axis as though the tail of the vector were at the origin + + The angle in degrees to rotate counter-clockwise when looking at the origin from the positive axis. + A new IVector that has been rotated + + + + Rotates the vector about the Z axis as though the tail of the vector were at the origin + + The angle in degrees to rotate counter-clockwise when looking at the origin from the positive axis. + A new IVector that has been rotated + + + + The Euclidean distance from the origin to the tip of the 3 dimensional vector + Setting the magntiude won't change the direction. + + + + + Returns the magnitude of the projection of the vector onto the X-Y plane + Setting this magnitude will not affect Z, which should be adjusted separately + + + + + Obtains the angle above the X-Y plane. Positive towards positive Z. + Values are in radians from -Pi/2 to Pi/2 + Setting this value when no magnitude exists results in a unit vector with angle phi in the X direction. + + + + + Represents the angle in the X-Y plane. 0 along the positive X axis, and increasing counterclockwise + Values are in Radians. Setting this value when no X-Y magnitude exists results in a unit vector + between X and Y, but does not affect Z, so you may have something other than a unit vector in 3-D. + Set theta before phi in order to obtain a unit vector in 3-D space. + + + + + Vector + + + + + Adds each of the elements of V to the elements of this vector + + Vector, the vector to add to this vector + A vector result from the addition + + + + Returns the cross product of this vector with the specified vector V + + The vector to perform a cross product against + A vector result from the inner product + + + + Returns the dot product of this vector with V2 + + The vector to perform an inner product against + A Double result from the inner product + + + + Returns the scalar product of this vector against a scalar + + Double, a value to multiply against all the members of this vector + A vector multiplied by the scalar + + + + Normalizes the vector. + + + + + Subtracts each element of V from each element of this vector + + Vector, the vector to subtract from this vector + A vector result from the subtraction + + + + The Euclidean distance from the origin to the tip of the 3 dimensional vector + Setting the magntiude won't change the direction. + + + + + A Depth object records the topological depth of the sides + of an Edge for up to two Geometries. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + A Depth object is null (has never been initialized) if all depths are null. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Normalize the depths for each point, if they are non-null. + A normalized depth + has depth values in the set { 0, 1 }. + Normalizing the depths + involves reducing the depths by the same amount so that at least + one of them is 0. If the remaining value is > 0, it is set to 1. + + + + + + + + + + + Calls GetDepth and SetDepth. + + + + + + + + + + + + + Models the end of an edge incident on a node. + EdgeEnds have a direction + determined by the direction of the ray from the initial + point to the next point. + EdgeEnds are IComparable under the ordering + "a has a greater angle with the x-axis than b". + This ordering is used to sort EdgeEnds around a node. + + + + + The parent edge of this edge end. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Implements the total order relation: + a has a greater angle with the positive x-axis than b. + Using the obvious algorithm of simply computing the angle is not robust, + since the angle calculation is obviously susceptible to roundoff. + A robust algorithm is: + - first compare the quadrant. If the quadrants + are different, it it trivial to determine which vector is "greater". + - if the vectors lie in the same quadrant, the computeOrientation function + can be used to decide the relative orientation of the vectors. + + + + + + Subclasses should override this if they are using labels + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The depth of each side (position) of this edge. + The 0 element of the array is never used. + + + + + Creates a new instance of a directed edge + + The edge to use in order to create a directed edge + A boolean that forces whether or not this edge is counted as forward + + + + Compute the label in the appropriate orientation for this DirEdge. + + + + + Retrieves an integer that describes the depth + + A Positions enumeration + An integer showing the depth + + + + Sets the depth value for this edge based on the specified position + + A Position + The integer depth to specify + Assigned depths do not match + + + + Set both edge depths. + One depth for a given side is provided. + The other is computed depending on the Location + transition and the depthDelta of the edge. + + + + + + + + + + + + + + + + + + + Computes the factor for the change in depth when moving from one location to another. + E.g. if crossing from the Interior to the Exterior the depth decreases, so the factor is -1. + + + + + Obtains the chaing in depth + + + + + Gets or sets the EdgeRing + + + + + Gets a boolean indicating whether this edge is directed forward + + + + + Gets a boolean that is true if this edge is in the result + + + + + This is an interior Area edge if + its label is an Area label for both Geometries + and for each Geometry both sides are in the interior. + + true if this is an interior Area edge. + + + + This edge is a line edge if + at least one of the labels is a line label + any labels which are not line labels have all Locations = Exterior. + + + + + Gets or sets a boolean that is true if this edge has been visited + + + + + Gets or sets the minimum Edge Ring + + + + + Gets or sets the next directed edge relative to this directed edge + + + + + Gets or sets a directed edge for Next Min + + + + + + + + + + VisitedEdge get property returns true if bot Visited + and Sym.Visited are true. + VisitedEdge set property marks both DirectedEdges attached to a given Edge. + This is used for edges corresponding to lines, which will only + appear oriented in a single direction in the result. + + + + + A DirectedEdgeStar is an ordered list of outgoing DirectedEdges around a node. + It supports labelling the edges as well as linking the edges to form both + MaximalEdgeRings and MinimalEdgeRings. + + + + + A EdgeEndStar is an ordered list of EdgeEnds around a node. + They are maintained in CCW order (starting with the positive x-axis) around the node + for efficient lookup and topology building. + + + + + A map which maintains the edges in sorted order around the node. + + + + + The location of the point for this star in Geometry i Areas. + + + + + Insert a EdgeEnd into this EdgeEndStar. + + + + + + Insert an EdgeEnd into the map, and clear the edgeList cache, + since the list of edges has now changed. + + + + + + + Iterator access to the ordered list of edges is optimized by + copying the map collection to a list. (This assumes that + once an iterator is requested, it is likely that insertion into + the map is complete). + + + + + Initializes the edges in the _edgeList + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets the EdgeMap + + + + + A list of all outgoing edges in the result, in CCW order. + + + + + The coordinate for the node this star is based at. + + + + + + + + + + + + + + + + + + + + A list of all outgoing edges in the result, in CCW order. + + + + + Insert a directed edge in the list. + + + + + + + + + + + + + + + + + + + + + + + + + Compute the labelling for all dirEdges in this star, as well + as the overall labelling. + + + + + + For each dirEdge in the star, merge the label . + + + + + Update incomplete dirEdge labels from the labelling for the node. + + + + + + Traverse the star of DirectedEdges, linking the included edges together. + To link two dirEdges, the next pointer for an incoming dirEdge + is set to the next outgoing edge. + DirEdges are only linked if: + they belong to an area (i.e. they have sides) + they are marked as being in the result + Edges are linked in CCW order (the order they are stored). + This means that rings have their face on the Right + (in other words, the topological location of the face is given by the RHS label of the DirectedEdge). + PRECONDITION: No pair of dirEdges are both marked as being in the result. + + + + + + + + + + + + + + + + Traverse the star of edges, maintaing the current location in the result + area at this node (if any). + If any L edges are found in the interior of the result, mark them as covered. + + + + + + + + + + + Compute the DirectedEdge depths for a subsequence of the edge array. + + The last depth assigned (from the R side of the last edge visited). + + + + + + + + + + + + + + + + + + + + A GraphComponent is the parent class for the objects' + that form a graph. Each GraphComponent can carry a + Label. + + + + + + + + + + + + + + + + Compute the contribution to an IM for this component. + + + + + Update the IM with the contribution for this component. + A component only contributes if it has a labelling for both parent geometries. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + A coordinate in this component (or null, if there are none). + + + + + An isolated component is one that does not intersect or touch any other + component. This is the case if the label has valid locations for + only a single Geometry. + + true if this component is isolated. + + + + + + + + + + + + + + + + + Updates an IM from the label for an edge. + Handles edges from both L and A geometries. + + + + + + + + + + + + + + Adds EdgeIntersections for one or both + intersections found for a segment of an edge to the edge intersection list. + + + + + + + + Add an EdgeIntersection for intersection intIndex. + An intersection that falls exactly on a vertex of the edge is normalized + to use the higher of the two possible segmentIndexes. + + + + + + + + + Update the IM with the contribution for this component. + A component only contributes if it has a labelling for both parent geometries. + + + + + + Equals is defined to be: + e1 equals e2 + iff + the coordinates of e1 are the same or the reverse of the coordinates in e2. + + + + + + Equals is defined to be: + e1 equals e2 + iff + the coordinates of e1 are the same or the reverse of the coordinates in e2. + + + + + + + + + + + + + + + + + + + + + + + + + + + + true if the coordinate sequences of the Edges are identical. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The depthDelta is the change in depth as an edge is crossed from R to L. + + The change in depth as the edge is crossed from R to L. + + + + + + + + + + + + + + + + + + + + + + + + An Edge is collapsed if it is an Area edge and it consists of + two segments which are equal and opposite (eg a zero-width V). + + + + + + + + + + + + + + + + + + + + An EdgeIntersection represents a point on an + edge which intersects with another edge. + The intersection may either be a single point, or a line segment + (in which case this point is the start of the line segment) + The label attached to this intersection point applies to + the edge from this point forwards, until the next + intersection or the end of the edge. + The intersection point must be precise. + + + + + + + + + + + + + + + + + + + + + + + + + -1 this EdgeIntersection is located before the argument location, + 0 this EdgeIntersection is at the argument location, + 1 this EdgeIntersection is located after the argument location. + + + + + + + + + + + + + + + + + + The point of intersection. + + + + + The index of the containing line segment in the parent edge. + + + + + The edge distance of this point along the containing line segment. + + + + + A list of edge intersections along an Edge. + + + + + + + + + + + Adds an intersection into the list, if it isn't already there. + The input segmentIndex and dist are expected to be normalized. + + + + + + + + Returns an iterator of EdgeIntersections. + + + + + + + + + + + + Adds entries for the first and last points of the edge to the list. + + + + + Creates new edges for all the edges that the intersections in this + list split the parent edge into. + Adds the edges to the input list (this is so a single list + can be used to accumulate all split edges for a Geometry). + + + + + + Create a new "split edge" with the section of points between + (and including) the two intersections. + The label for the new edge is the same as the label for the parent edge. + + + + + + + + + + + + + + + + + + A EdgeList is a list of Edges. It supports locating edges + that are pointwise equals to a target edge. + + + + + An index of the edges, for fast lookup. + a Quadtree is used, because this index needs to be dynamic + (e.g. allow insertions after queries). + An alternative would be to use an ordered set based on the values + of the edge coordinates. + + + + + Remove the selected Edge element from the list if present. + + Edge element to remove from list + + + + Insert an edge unless it is already in the list. + + + + + + + + + + + + If there is an edge equal to e already in the list, return it. + Otherwise return null. + + + + equal edge, if there is one already in the list, + null otherwise. + + + + + + + + + + + + + + + + + + If the edge e is already in the list, return its index. + + + + Index, if e is already in the list, + -1 otherwise. + + + + + + + + + + + + + + + + + + + + + + + Validates that a collection of SegmentStrings is correctly noded. + Throws an appropriate exception if an noding error is found. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Compute a LinearRing from the point list previously collected. + Test if the ring is a hole (i.e. if it is CCW) and set the hole flag + accordingly. + + + + + + + + + + + + + + + + + + + Collect all the points from the DirectedEdges of this ring into a contiguous list. + + + + + + + + + + + + + + + + + + + + + + Merge the RHS label from a DirectedEdge into the label for this EdgeRing. + The DirectedEdge label may be null. This is acceptable - it results + from a node which is NOT an intersection node between the Geometries + (e.g. the end node of a LinearRing). In this case the DirectedEdge label + does not contribute any information to the overall labelling, and is simply skipped. + + + + + + + + + + + + + + + This method will cause the ring to be computed. + It will also check any holes, if they have been assigned. + + + + + + Gets the inner geometry factory + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Returns the list of DirectedEdges that make up this EdgeRing. + + + + + The directed edge which starts the list of edges for this EdgeRing. + + + + + + + + + + A GeometryGraph is a graph that models a given Geometry. + + + + + The computation of the IntersectionMatrix relies on the use of a structure + called a "topology graph". The topology graph contains nodes and edges + corresponding to the nodes and line segments of a Geometry. Each + node and edge in the graph is labeled with its topological location relative to + the source point. + Notice that there is no requirement that points of self-intersection be a vertex. + Thus to obtain a correct topology graph, Geometrys must be + self-noded before constructing their graphs. + Two fundamental operations are supported by topology graphs: + Computing the intersections between all the edges and nodes of a single graph + Computing the intersections between the edges and nodes of two different graphs + + + + + Creates a new instance of a Planar Graph + + A node Factory + + + + Creates a new instance of a Planar Graph using a default NodeFactory + + + + + Adds a new EdgeEnd to the planar graph + + The EdgeEnd to add + + + + Add a set of edges to the graph. For each edge two DirectedEdges + will be created. DirectedEdges are NOT linked by this method. + + + + + + Adds the specified node to the geometry graph's NodeMap + + The node to add + The node after the addition + + + + Adds a new ICoordinate as though it were a Node to the node map + + An ICoordinate to add + The newly added node + + + + The node if found; null otherwise + + + + + + Returns the EdgeEnd which has edge e as its base edge + (MD 18 Feb 2002 - this should return a pair of edges). + + + The edge, if found null if the edge was not found. + + + + Returns the edge whose first two coordinates are p0 and p1. + + + + The edge, if found null if the edge was not found. + + + + Returns the edge which starts at p0 and whose first segment is + parallel to p1. + + + + The edge, if found null if the edge was not found. + + + + + + + + + + + + + + + + Adds a new EdgeEnd to the planar graph + + + + + + Link the DirectedEdges at the nodes of the graph. + This allows clients to link only a subset of nodes in the graph, for + efficiency (because they know that only a subset is of interest). + + + + + Link the DirectedEdges at the nodes of the graph. + This allows clients to link only a subset of nodes in the graph, for + efficiency (because they know that only a subset is of interest). + + + + + The coordinate pairs match if they define line segments lying in the same direction. + E.g. the segments are parallel and in the same quadrant + (as opposed to parallel and opposite!). + + + + + + + + + + + + + + + + + + + + + + + For nodes in the Collection, link the DirectedEdges at the node that are in the result. + This allows clients to link only a subset of nodes in the graph, for + efficiency (because they know that only a subset is of interest). + + + + + + Gets a list of edge ends + + + + + Gets or sets the list of edges. + + + + + Gets or sets the NodeMap for this graph + + + + + Gets a list of the actual values contained in the nodes + + + + + The lineEdgeMap is a map of the linestring components of the + parentGeometry to the edges which are derived from them. + This is used to efficiently perform findEdge queries + + + + + If this flag is true, the Boundary Determination Rule will used when deciding + whether nodes are in the boundary or not + + + + + + + + + + + + This method implements the Boundary Determination Rule + for determining whether + a component (node or edge) that appears multiple times in elements + of a MultiGeometry is in the boundary or the interior of the Geometry. + The SFS uses the "Mod-2 Rule", which this function implements. + An alternative (and possibly more intuitive) rule would be + the "At Most One Rule": + isInBoundary = (componentCount == 1) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The left and right topological location arguments assume that the ring is oriented CW. + If the ring is in the opposite orientation, + the left and right locations must be interchanged. + + + + + + + + + + + + + + + + + + + + Add an Edge computed externally. The label on the Edge is assumed + to be correct. + + + + + + Add a point computed externally. The point is assumed to be a + Point Geometry part, which has a location of INTERIOR. + + + + + + Compute self-nodes, taking advantage of the Geometry type to + minimize the number of intersection tests. (E.g. rings are + not tested for self-intersection, since they are assumed to be valid). + + The LineIntersector to use. + If false, intersection checks are optimized to not test rings for self-intersection. + The SegmentIntersector used, containing information about the intersections found. + + + + + + + + + + + + + + + + + + + + + Adds points using the mod-2 rule of SFS. This is used to add the boundary + points of dim-1 geometries (Curves/MultiCurves). According to the SFS, + an endpoint of a Curve is on the boundary + if it is in the boundaries of an odd number of Geometries. + + + + + + + + + + + + + Add a node for a self-intersection. + If the node is a potential boundary node (e.g. came from an edge which + is a boundary) then insert it as a potential boundary node. + Otherwise, just add it as a regular node. + + + + + + + + + + + + + + + + + + + + + + + + + + + + An EdgeSetIntersector computes all the intersections between the + edges in the set. It adds the computed intersections to each edge + they are found on. It may be used in two scenarios: + determining the internal intersections between a single set of edges + determining the mutual intersections between two different sets of edges + It uses a SegmentIntersector to compute the intersections between + segments and to record statistics about what kinds of intersections were found. + + + + + Computes all self-intersections between edges in a set of edges, + allowing client to choose whether self-intersections are computed. + + A list of edges to test for intersections. + The SegmentIntersector to use. + true if self-intersections are to be tested as well. + + + + Computes all mutual intersections between two sets of edges. + + + + + + + + + + + + + + + + + + + + + + + + MonotoneChains are a way of partitioning the segments of an edge to + allow for fast searching of intersections. + They have the following properties: + the segments within a monotone chain will never intersect each other, and + the envelope of any contiguous subset of the segments in a monotone chain + is simply the envelope of the endpoints of the subset. + Property 1 means that there is no need to test pairs of segments from within + the same monotone chain for intersection. + Property 2 allows + binary search to be used to find the intersection points of two monotone chains. + For many types of real-world data, these properties eliminate a large number of + segment comparisons, producing substantial speed gains. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + MonotoneChains are a way of partitioning the segments of an edge to + allow for fast searching of intersections. + They have the following properties: + the segments within a monotone chain will never intersect each other, and + the envelope of any contiguous subset of the segments in a monotone chain + is simply the envelope of the endpoints of the subset. + Property 1 means that there is no need to test pairs of segments from within + the same monotone chain for intersection. + Property 2 allows + binary search to be used to find the intersection points of two monotone chains. + For many types of real-world data, these properties eliminate a large number of + segment comparisons, producing substantial speed gains. + + + + + + + + + + + + + + + + + + + The index of the last point in the monotone chain. + + + + + + + + + + Testing only. + + + + + + + + + + + + + + + + + + + + + + + + + + + + A trivial intersection is an apparent self-intersection which in fact + is simply the point shared by adjacent line segments. + Notice that closed edges require a special check for the point shared by the beginning + and end segments. + + + + + + + + + This method is called by clients of the EdgeIntersector class to test for and add + intersections for two segments of the edges being intersected. + Notice that clients (such as MonotoneChainEdges) may choose not to intersect + certain pairs of segments for efficiency reasons. + + + + + + + + + + + + + + + + + + + + + + + + + The proper intersection point, or null if none was found. + + + + + + + + + + A proper intersection is an intersection which is interior to at least two + line segments. Notice that a proper intersection is not necessarily + in the interior of the entire Geometry, since another edge may have + an endpoint equal to the intersection, which according to SFS semantics + can result in the point being on the Boundary of the Geometry. + + + + + A proper interior intersection is a proper intersection which is not + contained in the set of boundary nodes set for this SegmentIntersector. + + + + + Finds all intersections in one or two sets of edges, + using the straightforward method of + comparing all segments. + This algorithm is too slow for production use, but is useful for testing purposes. + + + + + + + + + + + + + + + + + + + + + Performs a brute-force comparison of every segment in each Edge. + This has n^2 performance, and is about 100 times slower than using + monotone chains. + + + + + + + + Finds all intersections in one or two sets of edges, + using an x-axis sweepline algorithm in conjunction with Monotone Chains. + While still O(n^2) in the worst case, this algorithm + drastically improves the average-case time. + The use of MonotoneChains as the items in the index + seems to offer an improvement in performance over a sweep-line alone. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Because Delete Events have a link to their corresponding Insert event, + it is possible to compute exactly the range of events which must be + compared to a given Insert event object. + + + + + + + + + + + + + + + + + + + + Finds all intersections in one or two sets of edges, + using a simple x-axis sweepline algorithm. + While still O(n^2) in the worst case, this algorithm + drastically improves the average-case time. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Because Delete Events have a link to their corresponding Insert event, + it is possible to compute exactly the range of events which must be + compared to a given Insert event object. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ProjectionEvents are ordered first by their x-value, and then by their eventType. + It is important that Insert events are sorted before Delete events, so that + items whose Insert and Delete events occur at the same x-value will be + correctly handled. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + A Label indicates the topological relationship of a component + of a topology graph to a given Geometry. + This class supports labels for relationships to two Geometrys, + which is sufficient for algorithms for binary operations. + Topology graphs support the concept of labeling nodes and edges in the graph. + The label of a node or edge specifies its topological relationship to one or + more geometries. (In fact, since NTS operations have only two arguments labels + are required for only two geometries). A label for a node or edge has one or + two elements, depending on whether the node or edge occurs in one or both of the + input Geometrys. Elements contain attributes which categorize the + topological location of the node or edge relative to the parent + Geometry; that is, whether the node or edge is in the interior, + boundary or exterior of the Geometry. Attributes have a value + from the set {Interior, Boundary, Exterior}. In a node each + element has a single attribute On. For an edge each element has a + triplet of attributes Left, On, Right. + It is up to the client code to associate the 0 and 1 TopologyLocations + with specific geometries. + + + + + Construct a Label with a single location for both Geometries. + Initialize the locations to Null. + + + + + + Construct a Label with a single location for both Geometries. + Initialize the location for the Geometry index. + + + + + + + Construct a Label with On, Left and Right locations for both Geometries. + Initialize the locations for both Geometries to the given values. + + + + + + + + Construct a Label with On, Left and Right locations for both Geometries. + Initialize the locations for the given Geometry index. + + + + + + + + + Construct a Label with the same values as the argument for the + given Geometry index. + + + + + + + Construct a Label with the same values as the argument Label. + + + + + + Converts a Label to a Line label (that is, one with no side Locations). + + Label to convert. + Label as Line label. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Merge this label with another one. + Merging updates any null attributes of this label with the attributes from lbl. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Converts one GeometryLocation to a Line location. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Basic nodes do not compute IMs. + + + + + + Add the edge to the list of edges at this node. + + + + + + + + + + + + To merge labels for two nodes, + the merged location for each LabelElement is computed. + The location for the corresponding node LabelElement is set to the result, + as long as the location is non-null. + + + + + + + + + + + + + Updates the label of a node to BOUNDARY, + obeying the mod-2 boundaryDetermination rule. + + + + + + The location for a given eltIndex for a node will be one + of { Null, Interior, Boundary }. + A node may be on both the boundary and the interior of a point; + in this case, the rule is that the node is considered to be in the boundary. + The merged location is the maximum of the two input values. + + + + + + + + + + + + + + + + + + + A Coordinate for this node + + + + + Gets the edges for this node + + + + + Gets a boolean that is true if this node is isolated + + + + + + + + + + The basic node constructor does not allow for incident edges. + + + + + + A map of nodes, indexed by the coordinate of the node. + + + + + + + + + + + This method expects that a node has a coordinate value. + + + + + + + + + + + + + Adds a node for the start point of this EdgeEnd + (if one does not already exist in this map). + Adds the EdgeEnd to the (possibly new) node. + + + + + + The node if found; null otherwise. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + An indicator that a Location is on a GraphComponent (0) + + + + + An indicator that a Location is to the left of a GraphComponent (1) + + + + + An indicator that a Location is to the right of a GraphComponent (2) + + + + + An indicator that a Location is is parallel to x-axis of a GraphComponent (-1) + /// + + + + A Position indicates the position of a Location relative to a graph component + (Node, Edge, or Area). + + + + + Returns Positions.Left if the position is Positions.Right, + Positions.Right if the position is Left, or the position + otherwise. + + + + + + Utility functions for working with quadrants, which are numbered as follows: + + 1 | 0 + --+-- + 2 | 3 + + + + + + Only static methods! + + + + + Returns the quadrant of a directed line segment (specified as x and y + displacements, which cannot both be 0). + + + + + + + Returns the quadrant of a directed line segment from p0 to p1. + + + + + + + Returns true if the quadrants are 1 and 3, or 2 and 4. + + + + + + + Returns the right-hand quadrant of the halfplane defined by the two quadrants, + or -1 if the quadrants are opposite, or the quadrant if they are identical. + + + + + + + Returns whether the given quadrant lies within the given halfplane (specified + by its right-hand quadrant). + + + + + + + Returns true if the given quadrant is 0 or 1. + + + + + + A TopologyLocation is the labelling of a + GraphComponent's topological relationship to a single Geometry. + If the parent component is an area edge, each side and the edge itself + have a topological location. These locations are named: + On: on the edge + Left: left-hand side of the edge + Right: right-hand side + If the parent component is a line edge or node, there is a single + topological relationship attribute, On. + The possible values of a topological location are + { Location.Null, Location.Exterior, Location.Boundary, Location.Interior } + The labelling is stored in an array location[j] where + where j has the values On, Left, Right. + + + + + + + + + + + Constructs a TopologyLocation specifying how points on, to the left of, and to the + right of some GraphComponent relate to some Geometry. Possible values for the + parameters are Location.Null, Location.Exterior, Location.Boundary, + and Location.Interior. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Merge updates only the Null attributes of this object + with the attributes of another. + + + + + + + + + + + Get calls Get(Positions posIndex), + Set calls SetLocation(Positions locIndex, Locations locValue) + + + + + + + true if all locations are Null. + + + + + true if any locations are Null. + + + + + + + + + + + + + + + A TwoHorizontalEdgesException Class + + + + + Creates a new instance of TwoHorizontalEdgesException + + + + + Basic implementation of LinearRing. + The first and last point in the coordinate sequence must be equal. + Either orientation of the ring is allowed. + A valid ring must not self-intersect. + + + + + Basic implementation of LineString. + + + + + Represents an empty LineString. + + + + + The points of this LineString. + + + + + + + + The points of the linestring, or null + to create the empty point. Consecutive points may not be equal. + + + + + + Creates a new LineString using the default factory + + + The points of the linestring, or null + to create the empty point. Consecutive points may not be equal. + + + + + Creates a new topologically complete LineString from a LineStringBase + + + + + + Constructor + + + The points of the linestring, or null + to create the empty point. Consecutive points may not be equal. + + + + + + Creates an empty linestring using the specified factory. + + An IGeometryFactory to use when specifying this linestring. + + + + Rather than using the factory trends, this will create a coordinate sequence by simply using the specified list of coordinates. + + The list of coordinates to use as a new ICoordinateSequence + + + + Rather than using the factory trends, this will create a coordinate sequence by simply using the specified list of coordinates. + + The list of coordinates to use as a new ICoordinateSequence + + + + Applys a given ICoordinateFilter to this LineString + + + + + + + + + + + + + + + + + + Performs a CompareTo opperation assuming that the specified object is a LineString + + + + + + + Tests the coordinates of this LineString against another geometry and returns true if they are identical. + + + + + + + + Given the specified test point, this checks each segment, and will + return the closest point on the specified segment. + + The point to test. + + + + + Returns the N'th point as an Implementation of IPoint. The specific + implementation is just the DotSpatial.Geometries.Point + + + + + + + Returns true if the given point is a vertex of this LineString. + + The Coordinate to check. + true if pt is one of this LineString's vertices. + + + + Normalizes a LineString. A normalized linestring + has the first point which is not equal to it's reflected point + less than the reflected point. + + + + + Creates a whose coordinates are in the reverse order of this objects. + + A with coordinates in the reverse order. + + + + Returns the Envelope of this LineString + + An IEnvelope interface for the envelope containing this LineString + + + + Returns a copy of this ILineString + + + + + Returns the Nth coordinate of the coordinate sequence making up this LineString + + + + + + + Tests other and returns true if other is a LineString + + + + + + + Calculates a new linestring representing a linestring that is offset by + distance to the left. Negative distances will be to the right. The final + LineString may be shorter or longer than the original. Left is determined + by the vector direction of the segment between the 0th and 1st points. + Outside bends will be circular curves, rather than extended angles. + + The double distance to create the offset LineString + A valid ILineString interface created from calculations performed on this LineString + + + + Rotates the LineString by the given radian angle around the Origin. + + Coordinate the LineString gets rotated around. + Rotation angle in radian. + + + + Gets the integer count of the number of points in this LineString + + + + + + Gets the ICoordinate that exists at the Nth index + + + + + + + Gets the value of the angle between the + and the . + + + + + Gets a MultiPoint geometry that contains the StartPoint and Endpoint + + + + + Gets False if the LineString is closed, or Point (0) otherwise, representing the endpoints + + + + + Gets the 0th coordinate + + + + + Gets a System.Array of the coordinates + + + + + Gets the dimensionality of a Curve(1) + + + + + Gets the point corresponding to NumPoints-1 and returns it as an IPoint interface + + + + + This will always contain Line, even if it is technically empty + + + + + Gets a string that says "LineString" + + + + + Gets a boolean that is true if the EndPoint is geometrically equal to the StartPoint in 2 Dimensions + + + + + Gets a boolean value that returns true if the count of points in this LineString is 0. + + + + + Gets a boolean that is true if this LineString is both closed (has the same start and end point) + and simple (does not self-intersect) + + + + + Gets a boolean that is false if any part of this LineString intersects with itself. + + + + + Returns the length of this LineString + + The length of the polygon. + + + + Gets an integer count of the points. + + + + + Gets the 0 index point as a valid implementation of IPoint interface + + + + + Creates a new instance of a linear ring where the enumerable collection of + coordinates represents the set of coordinates to add to the ring. + + + + + + Creates a new instance of a linear ring where the enumerable collection of + coordinates represents the set of coordinates to add to the ring. + + + + + + Constructor + + + + + + Correct constructions with non-closed sequences. + + + + + Geometry Type + + + + + Gets a boolean that is true if the EndPoint is geometrically equal to the StartPoint in 2 Dimensions. + + + + + This will always contain Line, even if it is technically empty + + + + + Represents a line segment defined by two Coordinates. + Provides methods to compute various geometric properties + and relationships of line segments. + This class is designed to be easily mutable (to the extent of + having its contained points public). + This supports a common pattern of reusing a single LineSegment + object as a way of computing segment properties on the + segments defined by arrays or lists of Coordinates. + + + + + Creates an instance of LineSegment from two coordiantes + + The first point of the segment + The second point of the segment + + + + Creates a new instance of a LineSegment which implements + ILineSegment and ILineSegmentBase from an ILineSegmentBase + + + + + + Creates a new instance of a LineSegment which implements + ILineSegment and ILineSegmentBase + + + + + Retrieves the i'th coordiante. Since there are only two, + i can be either 0 or 1. + + Integer, specifies the coordiante + A topologically complete ICoordinate + + + + Defines a new LineSegment based on the previous line segment + + The ILineSegmentBase + + + + Sets the new coordinates using the ICoordinate interfaces specified + + The first endpoint + The second endpoint + + + + Determines the orientation of a LineSegment relative to this segment. + The concept of orientation is specified as follows: + Given two line segments A and L, + A is to the left of a segment L if A lies wholly in the + closed half-plane lying to the left of L + A is to the right of a segment L if A lies wholly in the + closed half-plane lying to the right of L + otherwise, A has indeterminate orientation relative to L. This + happens if A is collinear with L or if A crosses the line determined by L. + + The LineSegment to compare. + + 1 if seg is to the left of this segment, + -1 if seg is to the right of this segment, + 0 if seg has indeterminate orientation relative to this segment. + + + + + Reverses the direction of the line segment. + + + + + Puts the line segment into a normalized form. + This is useful for using line segments in maps and indexes when + topological equality rather than exact equality is desired. + + + + + Computes the distance between this line segment and another one. + + + + + + + Computes the distance between this line segment and a point. + + + + + Computes the perpendicular distance between the (infinite) line defined + by this line segment and a point. + + + + + + + Compute the projection factor for the projection of the point p + onto this LineSegment. The projection factor is the constant k + by which the vector for this segment must be multiplied to + equal the vector for the projection of p. + + + + + + + Compute the projection of a point onto the line determined + by this line segment. + Notice that the projected point + may lie outside the line segment. If this is the case, + the projection factor will lie outside the range [0.0, 1.0]. + + + + + + + Project a line segment onto this line segment and return the resulting + line segment. The returned line segment will be a subset of + the target line line segment. This subset may be null, if + the segments are oriented in such a way that there is no projection. + Notice that the returned line may have zero length (i.e. the same endpoints). + This can happen for instance if the lines are perpendicular to one another. + + The line segment to project. + The projected line segment, or null if there is no overlap. + + + + Computes the closest point on this line segment to another point. + + The point to find the closest point to. + + A Coordinate which is the closest point on the line segment to the point p. + + + + + Computes the closest points on a line segment. + + + + A pair of Coordinates which are the closest points on the line segments. + + + + + Computes an intersection point between two segments, if there is one. + There may be 0, 1 or many intersection points between two segments. + If there are 0, null is returned. If there is 1 or more, a single one + is returned (chosen at the discretion of the algorithm). If + more information is required about the details of the intersection, + the {RobustLineIntersector} class should be used. + + + An intersection point, or null if there is none. + + + + Performs an intersection of this line segment with the specified envelope + + The envelope to compare against + An ILineSegment, or null if there is no intersection. + + + + Determines if any portion of this segment intersects the specified extent. + + The + Boolean, true if this line segment intersects the specified envelope + + + + Compares this object with the specified object for order. + Uses the standard lexicographic ordering for the points in the LineSegment. + + + The LineSegment with which this LineSegment + is being compared. + + + A negative integer, zero, or a positive integer as this LineSegment + is less than, equal to, or greater than the specified LineSegment. + + + + + Returns true if other is + topologically equal to this LineSegment (e.g. irrespective + of orientation). + + + A LineSegment with which to do the comparison. + + + true if other is a LineSegment + with the same values for the x and y ordinates. + + + + + + + + + + + Returns true if o has the same values for its points. + + A LineSegment with which to do the comparison. + + true if o is a LineSegment + with the same values for the x and y ordinates. + + + + + + + + + + + + + + + + + + + + + Return HashCode. + + + + + returns the one of the ICoordinate that defines this linesegment + + + + + returns the ICoordianteBase defining the second endpoint of the segment + + + + + Computes the length of the line segment. + + The length of the line segment. + + + + Tests whether the segment is horizontal. + + true if the segment is horizontal. + + + + Tests whether the segment is vertical. + + true if the segment is vertical. + + + + The angle this segment makes with the x-axis (in radians). + + + + + + + + + + Converts the location value to a location symbol, for example, EXTERIOR => 'e'. + + + Either 'e', 'b', 'i' or '-'. + + + + Matrix4 + + + + + A 4 x 4 matrix is required for transformations in 3 dimensions + + + + + Creates a new squre identity matrix of the specified size + + The size of the matrix to create + + + + Creates a new instance of Matrix with m rows and n columns + + + + + Creates a matrix using the specified values. + + + + + + Matrix multiplication only works if the number of columns of the first matrix is the same + as the number of rows of the second matrix. The first matrix is this object, so this + will only work if inMatrix has the same number of rows as this matrix has columns. + + The IMatrix to multiply against this matrix + + + + + Multiplies this matrix by the specified scalar value. + + + + + + + Gets the number of rows + + + + + Gets the number of columns + + + + + Gets the number of rows + + + + + Gets the number of columns + + + + + Gets or sets the values for this matrix + + + + + Creates a new instance of Matrix4 that is an identity matrix + + + + + Rotates this matrix by the specified angle in degrees about the X axis. + + Specified the angle in degrees to rotate counter clockwise about the positive axis + + + + + Rotates this matrix by the specified angle in degrees about the Y axis. + + + + + + + Rotates this matrix by the specified angle in degrees about the Z axis. + + + + + + + Translates the matrix by the specified amount in each of the directions + by multiplying by a translation matrix created from the specified values. + + The translation in the X coordinate + The translation in the Y coordinate + The translation in the Z coordinate + + + + + Creates a 4 x 4 matrix that can be used to rotate a 3D vector about the X axis. + + The counter-clockwise angle of rotation when looking at the origin from the positive axis + A 4x4 rotation matrix + + + + Creates a 4 x 4 matrix that can be used to rotate a 3D vector about the Y axis. + + The counter-clockwise angle of rotation when looking at the origin from the positive axis + A 4x4 rotation matrix + + + + Creates a 4 x 4 matrix that can be used to rotate a 3D vector about the Z axis. + + The counter-clockwise angle of rotation when looking at the origin from the positive axis + A 4x4 rotation matrix + + + + Creates a 4 x 4 matrix where all the values represent an identity matrix except + that the bottom row has been set to be the translation values. The result is + that if a 3D vector is transformed by this matrix, the last row will + control the translation terms. + + The translation in the x direction + The translation in the y direction + The translation in the z direction + The translation matrix + + + + + + + + + Basic implementation of MultiLineString. + + + + + Represents an empty MultiLineString. + + + + + Constructs a multiLineString from the list of IBasicLineStrings, creating new full geometries where necessary. + + An IBasicLineString that is either a full IGeometry itself, or will be cast into one by this step + + + + Constructs a MultiLineString. + + + The LineStrings for this MultiLineString, + or null or an empty array to create the empty + point. Elements may be empty LineStrings, + but not nulls. + + + + + + This will attempt to create a new MultiLineString from the specified basic geometry. + + A Basic geometry that shoule be a LineString or MultiLineString + + + + This will attempt to create a new MultiLineString from the specified basic geometry. + + A Basic geometry that shoule be a LineString or MultiLineString + Any valid Geometry Factory + + + + Constructs a MultiLineString. + + + The LineStrings for this MultiLineString, + or null or an empty array to create the empty + point. Elements may be empty LineStrings, + but not nulls. + + + For create this is used a standard + with == . + + + + + Constructor for a MultiLineString that is empty + + + + + + + + + + + + + Creates a in the reverse order to this object. + Both the order of the component LineStrings + and the order of their coordinate sequences are reversed. + + a in the reverse order. + + + + Gets a value indicating whether this instance is closed. + + true if this instance is closed; otherwise, false. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Always returns FeatureTypes.Line + + + + + Gets the ILineString that corresponds to the specified index + + The integer index to get a linestring + An ILineString + + + + Models a collection of Points. + + + + + Represents an empty MultiPoint. + + + + + Constructs a MultiPoint. + + + The Points for this MultiPoint + , or null or an empty array to create the empty point. + Elements may be empty Points, but not nulls. + + + + + + This will attempt to create a new MultiPoint from the specified basic geometry. + + A Point or MultiPoint + + + + Creates new Multipoint using interface points + + + + + + Creates new Multipoint using interface points + + + + + + + + + + + + + + Converts an array of point interface variables into local points. + Eventually I hope to reduce the amount of "casting" necessary, in order + to allow as much as possible to occur via an interface. + + + + + + + Converts an array of point interface variables into local points. + Eventually I hope to reduce the amount of "casting" necessary, in order + to allow as much as possible to occur via an interface. + + + + + + + Returns the Coordinate at the given position. + + The index of the Coordinate to retrieve, beginning at 0. + + The nth Coordinate. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets or sets the point that resides at the specified index + + A zero-based integer index specifying the point to get or set + + + + + Basic implementation of MultiPolygon. + + + + + Represents an empty MultiPolygon. + + + + + Constructs a MultiPolygon. + + + The Polygons for this MultiPolygon + , or null or an empty array to create the empty point. + Elements may be empty Polygons, but not null + s. The polygons must conform to the assertions specified in the + OpenGIS Simple Features + Specification for SQL. + + + For create this is used a standard + with == . + + + + + This was added by Ted Dunsford to allow the construction of MultiPolygons + from an array of basic polygon interfaces. + + + + + + This will attempt to create a new MultiPolygon from the specified basic geometry. + + A Polygon or MultiPolygon + + + + This will attempt to create a new MultiPolygon from the specified basic geometry. + + A Polygon or MultiPolygon + An implementation of the IGeometryFactory interface + + + + Constructs a MultiPolygon. + + + The Polygons for this MultiPolygon + , or null or an empty array to create the empty point. + Elements may be empty Polygons, but not null + s. The polygons must conform to the assertions specified in the + OpenGIS Simple Features + Specification for SQL. + + + + + + + + + + + + + + Presuming that the specified basic geometry describes a MultiPolygon, this will perform the necessary + casting in order to create a MultiPolygon. If, in fact, it is only a BasicMultiPolygon, this will + create a new, fully functional MultiPolygon based on the same coordinates. + + The IBasicGeometry to turn into a MultiPolygon. + + + + + + + + + + + + + + Always returns "MultiPolygon" + + + + + Always Polygon + + + + + + + + + + + + + + + Basic implementation of Point. + + + + + Creates a null point with X = 0, Y = 0, which can have its properties set later. + + + + + Creates a null point with X = 0, Y = 0 but using the specified factory for + precision and SRID stuff. + + The factory to use when creating this geometry. + + + + Initializes a new instance of the Point class. + + The coordinate used for create this . + + For create this is used a standard + with == . + + + + + Initializes a new instance of the Point class. + + The coordinate used for create this . + + For create this is used a standard + with == . + + + + + Constructs a Point with the given coordinate. + + + Contains the single coordinate on which to base this Point, + or null to create the empty point. + + + + + + Initializes a new instance of the Point class. + + The x coordinate. + The y coordinate. + The z coordinate. + /// + For create this is used a standard + with set to . + + + + + Initializes a new instance of the Point class. + + The x coordinate. + The y coordinate. + /// + For create this is used a standard + with set to . + + + + + Represents an empty Point. + + + + + Performs an operation with or on this Geometry's + coordinates. If you are using this method to modify the point, be sure + to call GeometryChanged() afterwards. Notice that you cannot use this + method to + modify this Geometry if its underlying CoordinateSequence's Get method + returns a copy of the Coordinate, rather than the actual Coordinate stored + (if it even stores Coordinates at all). + + The filter to apply to this Geometry's coordinates + + + + Performs an operation with or on this Geometry and its + subelement Geometrys (if any). + Only GeometryCollections and subclasses + have subelement Geometry's. + + + The filter to apply to this Geometry (and + its children, if it is a GeometryCollection). + + + + + Performs an operation with or on this Geometry and its + component Geometry's. Only GeometryCollections and + Polygons have component Geometry's; for Polygons they are the LinearRings + of the shell and holes. + + The filter to apply to this Geometry. + + + + Returns whether this Geometry is greater than, equal to, + or less than another Geometry having the same class. + + A Geometry having the same class as this Geometry. + + A positive number, 0, or a negative number, depending on whether + this object is greater than, equal to, or less than o, as + defined in "Normal Form For Geometry" in the NTS Technical + Specifications. + + + + + Given the specified test point, this returns the closest point in this geometry. + + + + + + EqualsExact + + Returns true if the two Geometrys are exactly equal, + up to a specified tolerance. + Two Geometries are exactly within a tolerance equal iff: + they have the same class, + they have the same values of Coordinates, + within the given tolerance distance, in their internal + Coordinate lists, in exactly the same order. + If this and the other Geometrys are + composites and any children are not Geometrys, returns + false. + + The Geometry with which to compare this Geometry + Distance at or below which two Coordinates will be considered equal. + + true if this and the other Geometry + are of the same class and have equal internal data. + + + + Normalize + + Converts this Geometry to normal form (or + canonical form ). Normal form is a unique representation for Geometry + s. It can be used to test whether two Geometrys are equal + in a way that is independent of the ordering of the coordinates within + them. Normal form equality is a stronger condition than topological + equality, but weaker than pointwise equality. The definitions for normal + form use the standard lexicographical ordering for coordinates. "Sorted in + order of coordinates" means the obvious extension of this ordering to + sequences of coordinates. This does nothing for points. + + + + + Creates a copy of this Point with the same factory + specifications and values. + + + + + + + + + + + Calculates the vector distance. (This is a 2D operation) + + Any valid implementation of the ICoordinate Interface + The Euclidean distance between two points {Sqrt((X2 - X1)^2 + (Y2 - Y1)^2) + + + + Returns the distance that is appropriate for N dimensions. In otherwords, if this point is + three dimensional, then all three dimensions will be used for calculating the distance. + + The coordinate to compare to this coordinate + A double valued distance measure that is invariant to the number of coordinates + The number of dimensions does not match between the points. + + + + Tests to see if the X coordinate and Y coordinate are the same between this point and the + specified Coordinate + + Any valid implementation of the ICoordinate Interface + True if the coordinates are equal, false otherwise + + + + Tests to see if the X, Y, and Z coordinate are the same between this point and the + specified Coordinate + + Any valid implementation of the ICoordinate Interface + True if the coordinates are equal, false otherwise + + + + Rotates the point by the given radian angle around the Origin. + + Coordinate the point gets rotated around. + Rotation angle in radian. + + + + Sets the coordinate. + + The value to set. + + + + Creates an array of ordinate values that is the size of NumDimensions. This + will not include an M value. + + An Array of double values, with one value for each ordinate. + + + + Gets or sets the double value of the specific ordinate + + + + + + + This is an optional recordnumber index, used specifically for Shapefile points. + + + + Boundary + + Returns the boundary, or the empty point if this Geometry + is empty. For a discussion of this function, see the OpenGIS Simple + Features Specification. As stated in SFS Section 2.1.13.1, "the boundary + of a Geometry is a set of Geometries of the next lower dimension." + + The closure of the combinatorial boundary of this Geometry. + + + + Returns the dimension of this Geometrys inherent boundary. + + + The dimension of the boundary of the class implementing this + interface, whether or not this object is the empty point. Returns + Dimension.False if the boundary is the empty point. + + + + Coordinate + + Returns a vertex of this Geometry + + + + + People might access "Coordinates". If we spontaneously generate a list from + our single coordinate, thne we will have problems. + They cannot SET the coordinate like myPoint.Coordinates[0].X = 5. + + + + Dimension + + Gets or sets the DotSpatial.Geometries.Dimensions of this Geometry. + + + + + Gets the number of ordinates that are being used by the underlying coordinate for + this point. + + + + + Envelope containing this + + + + + This will always contain points, even if it is technically empty + + + + + returns Point + + + + IsEmpty + + Returns whether or not the set of points in this geometry is empty + + + + IsSimple + + Returns false if the Geometry not simple. Subclasses provide their own definition + of "simple". If this Geometry is empty, returns true. In general, the SFS specifications + of simplicity seem to follow the following rule: A Geometry is simple if the only + self-intersections are at boundary points. For all empty Geometrys, IsSimple==true. + + + + IsValid + + Tests the validity of this Geometry. Subclasses provide their own definition of "valid" + + + + + The measure coordinate + + + + + The integer number of points. In this case it is either 1 or 0 if the point is empty. + + + + + Gets or sets the ordinates directly as an array of double values for this point. + + + + + The X coordinate + + + + + The Y coordinate + + + + + The Z coordinate + + + + + Represents a linear polygon, which may include holes. + The shell and holes of the polygon are represented by {LinearRing}s. + In a valid polygon, holes may touch the shell or other holes at a single point. + However, no sequence of touching holes may split the polygon into two pieces. + The orientation of the rings in the polygon does not matter. + The shell and holes must conform to the assertions specified in the + OpenGIS Simple Features Specification for SQL. + + + + + Constructs a Polygon with the given exterior boundary. + + + The outer boundary of the new Polygon, + or null or an empty LinearRing if the empty + polygon is to be created. + + + + + + Constructs a Polygon with the given exterior boundary. + + + The outer boundary of the new Polygon, + or null or an empty LinearRing if the empty + polygon is to be created. + + + + + Generates a new polygon using the default geometry factory from the specified set of coordinates, + where the coordinates will become the polygon shell. + + The shell of the polygon expressed as an enumerable collection of ICoordinate + + + + Initializes a new instance of the Polygon class. + + + The outer boundary of the new Polygon, + or null or an empty LinearRing if the empty + point is to be created. + + + The inner boundaries of the new Polygon + , or null or empty LinearRings if the empty + point is to be created. + + + For create this is used a standard + with == . + + + + + Constructs a Polygon with the given exterior boundary and + interior boundaries. + + + The outer boundary of the new Polygon, + or null or an empty LinearRing if the empty + point is to be created. + + + The inner boundaries of the new Polygon + , or null or empty LinearRings if the empty + point is to be created. + + + Holes must not contain null elements + + + + Constructor for a polygon + + A simpler BasicPolygon to empower with topology functions + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Clears any cached envelopes + + + + + + + + + + + + + + + + + + + Given the specified test point, this checks each segment, and will + return the closest point on the specified segment. + + The point to test. + + + + + + + + + + + + + + + + + Occurs during the copy process and ensures that the shell and holes are all duplicated and not direct references + + + + + + + + + + + + Rotates the polygon by the given radian angle around the Origin. + + Coordinate the polygon gets rotated around. + Rotation angle in radian. + + + + + + + + + + + Hole data might actually already be cast appropriately, but it might need to be + converted into an array of linear rings. + + + + + + Represents an empty Polygon. + + + + + This is just the Shell, but modified to work with IBasicPolygon + + + + + Returns the area of this Polygon + + Area in Meters (by default) when using projected coordinates. + + + + + + + + + + + + + + + + + + + Gets all the coordinates for the polygon. Setting this assumes that all the coordintes + belong in the shell. + + + + + + + + + + This will always contain points, even if it is technically empty + + + + + Specifically returns a Polygon type + + + + + + + + + + + + + + + + + + + + + + + + + + Returns the perimeter of this Polygon. + + + + + + + + + + + For polygons, this returns the complete number of points, including all the points + from the outer ring as well as from the interior holes. + + + + + This returns a full ILinearRing geometry + + + + + PolygonException + + + + + Creates a new instance of PolygonException + + + + + Specifies the precision model of the Coordinates in a Geometry. + In other words, specifies the grid of allowable + points for all Geometrys. + The makePrecise method allows rounding a coordinate to + a "precise" value; that is, one whose + precision is known exactly. + Coordinates are assumed to be precise in geometries. + That is, the coordinates are assumed to be rounded to the + precision model given for the point. + NTS input routines automatically round coordinates to the precision model + before creating Geometries. + All internal operations + assume that coordinates are rounded to the precision model. + Constructive methods (such as bool operations) always round computed + coordinates to the appropriate precision model. + Currently three types of precision model are supported: + + Floating: represents full double precision floating point. + This is the default precision model used in NTS + FloatingSingle: represents single precision floating point. + Fixed: represents a model with a fixed number of decimal places. + + A Fixed Precision Model is specified by a scale factor. + The scale factor specifies the grid which numbers are rounded to. + Input coordinates are mapped to fixed coordinates according to the following + equations: + jtsPt.x = round((inputPt.x * scale ) / scale + jtsPt.y = round((inputPt.y * scale ) / scale + Coordinates are represented internally as double-precision values. + Since .NET uses the IEEE-394 floating point standard, this + provides 53 bits of precision. (Thus the maximum precisely representable + integer is 9, 007, 199, 254, 740, 992). + NTS methods currently do not handle inputs with different precision models. + + + + + The maximum precise value representable in a double. Since IEE754 + double-precision numbers allow 53 bits of mantissa, the value is equal to + 2^53 - 1. This provides almost 16 decimal digits of precision. + + + + + The type of PrecisionModel this represents. + + + + + The scale factor which determines the number of decimal places in fixed precision. + + + + + Creates a PrecisionModel with a default precision + of Floating. + + + + + Creates a PrecisionModel that specifies + an explicit precision model type. + If the model type is Fixed the scale factor will default to 1. + + + The type of the precision model. + + + + + Creates a PrecisionModel that specifies Fixed precision. + Fixed-precision coordinates are represented as precise internal coordinates, + which are rounded to the grid defined by the scale factor. + + + Amount by which to multiply a coordinate after subtracting + the offset, to obtain a precise coordinate. + + + + + Copy constructor to create a new PrecisionModel + from an existing one. + + + + + + Compares this PrecisionModel object with the specified object for order. + A PrecisionModel is greater than another if it provides greater precision. + The comparison is based on the value returned by the + {getMaximumSignificantDigits) method. + This comparison is not strictly accurate when comparing floating precision models + to fixed models; however, it is correct when both models are either floating or fixed. + + + The PrecisionModel with which this PrecisionModel + is being compared. + + + A negative integer, zero, or a positive integer as this PrecisionModel + is less than, equal to, or greater than the specified PrecisionModel. + + + + + Return HashCode. + + + + + Gets the type of this PrecisionModel. + + + + + + Sets internal to the precise representation of external. + + The original coordinate. + + The coordinate whose values will be changed to the + precise representation of external. + + + + + Returns the precise representation of external. + + The original coordinate. + + The coordinate whose values will be changed to the precise + representation of external + + + + + Returns the external representation of internal. + + The original coordinate. + + The coordinate whose values will be changed to the + external representation of internal. + + + + + Sets external to the external representation of internal. + + The original coordinate. + + The coordinate whose values will be changed to the + external representation of internal. + + + + + Rounds a numeric value to the PrecisionModel grid. + Symmetric Arithmetic Rounding is used, to provide + uniform rounding behaviour no matter where the number is + on the number line. + + + + + + Rounds a Coordinate to the PrecisionModel grid. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Tests whether the precision model supports floating point. + + true if the precision model supports floating point. + + + + Returns the maximum number of significant digits provided by this + precision model. + Intended for use by routines which need to print out precise values. + + + The maximum number of decimal places provided by this precision model. + + + + + Returns the multiplying factor used to obtain a precise coordinate. + This method is private because PrecisionModel is intended to + be an immutable (value) type. + + + the amount by which to multiply a coordinate after subtracting + the offset. + + + + + Returns the x-offset used to obtain a precise coordinate. + + + The amount by which to subtract the x-coordinate before + multiplying by the scale. + + + + + Returns the y-offset used to obtain a precise coordinate. + + + The amount by which to subtract the y-coordinate before + multiplying by the scale + + + + + SizeD is just like a Size class except that it has double valued measures, + and expresses sizes in three dimensions. + + + + + Creates a new instance of SizeD + + + + + Creates a new SizeD structure. + + X or longitude size + Y or latitude size + Z or altitude size + + + + Gets or sets the size in the x direction or longitude + + + + + Gets or sets the size in the y direction or latitude + + + + + Gets or sets the size in the z direction or altitude + + + + + Indicates an invalid or inconsistent topological situation encountered during processing + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Represents a planar triangle, and provides methods for calculating various + properties of triangles. + + + + + + + + + + + + + + + + + + + + + + + + + + + + The inCentre of a triangle is the point which is equidistant + from the sides of the triangle. This is also the point at which the bisectors + of the angles meet. + + + The point which is the InCentre of the triangle. + + + + + A framework for processes which transform an input Geometry into + an output Geometry, possibly changing its structure and type(s). + This class is a framework for implementing subclasses + which perform transformations on + various different Geometry subclasses. + It provides an easy way of applying specific transformations + to given point types, while allowing unhandled types to be simply copied. + Also, the framework handles ensuring that if subcomponents change type + the parent geometries types change appropriately to maintain valid structure. + Subclasses will override whichever TransformX methods + they need to to handle particular Geometry types. + A typically usage would be a transformation that may transform Polygons into + Polygons, LineStrings + or Points. This class would likely need to override the TransformMultiPolygon + method to ensure that if input Polygons change type the result is a GeometryCollection, + not a MultiPolygon. + The default behaviour of this class is to simply recursively transform + each Geometry component into an identical object by copying. + Notice that all TransformX methods may return null, + to avoid creating empty point objects. This will be handled correctly + by the transformer. + The Transform method itself will always + return a point object. + + + + + true if empty geometries should not be included in the result. + + + + + true if the type of the input should be preserved. + + + + + + + + + + + + + + + + + Convenience method which provides standard way of + creating a CoordinateSequence. + + The coordinate array to copy. + A coordinate sequence for the array. + + + + Convenience method which provides statndard way of copying {CoordinateSequence}s + + The sequence to copy. + A deep copy of the sequence. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Extracts all the 1-dimensional (LineString) components from a Geometry. + + + + + Constructs a LineExtracterFilter with a list in which to store LineStrings found. + + + + + + + + + + + + Extracts the linear components from a single point. + If more than one point is to be processed, it is more + efficient to create a single LineExtracterFilter instance + and pass it to multiple geometries. + + The point from which to extract linear components. + The list of linear components. + + + + Extracts all the 0-dimensional (Point) components from a Geometry. + + + + + Constructs a PointExtracterFilter with a list in which to store Points found. + + + + + + + + + + + + Returns the Point components from a single point. + If more than one point is to be processed, it is more + efficient to create a single PointExtracterFilter instance + and pass it to multiple geometries. + + + + + + Extracts all the 2-dimensional (Polygon) components from a Geometry. + + + + + Constructs a PolygonExtracterFilter with a list in which to store Polygons found. + + + + + + + + + + + + Returns the Polygon components from a single point. + If more than one point is to be processed, it is more + efficient to create a single PolygonExtracterFilter instance + and pass it to multiple geometries. + + + + + + A visitor to Geometry elements which can + be short-circuited by a given condition. + + + + + + + + + + + + + + + + + + + + + + + Unsupported geometry Exception + + + + + Creates a new instance of the unsupported geometry exception + + + + + Contains a magnitude and direction + Supports more fundamental calculations than LineSegment, rather than topological functions + + + + + Creates a new empty vector + + + + + Creates a new instance of a vector where the X, Y and Z terms are the same as the + specified coordinate. + + The ICoordinate to use + + + + Creates a new vector from the Point, assuming the tail of the vector is the origin + + The Point to create a vector from + + + + Creates a new vector from a line segment, assuming that the direction is from the start point to the end point + + A Topology.LineSegment object to turn into a vector + + + + Creates a vector that points from the start coordinate to the end coordinate and + uses the distance between the two coordinates to form its length. + + The start coordinate + The end coordinate for the vector + + + + Creates a mathematical vector from X1, Y1 to X2, Y2 + + Double, The X coordinate of the start point for the vector + Double, The Y coordinate of the start point for the vector + Double, the Z coordinate of the start point for the vector + Double, The X coordinate of the end point for the vector + Double, The Y coordinate of the end point for the vector + Double, the Z coordinate of the end point for the vector + + + + Creates a mathemtacal vector from the origin to the x, y, z coordinates + + Double, the X coordinate from the origin + Double, the Y coordinate from the origin + Double, the Z coordinate from the origin + + + + Creates a mathematical vector from the origin with the new magnitude and directions specified + + Double, the length of the vector + The angle in the x-y plane + The angle in the z direction + + + + Creates a mathematical vector in the X-Y plane with angle Theta + + Double, The magnitude of the vector + Angle, The direction measured counterclockwise from Positive X Axis + + + + Creates a new vector from a vector that can be longer or shorter than 3 ordinates. + If an X, Y or Z value is not specified, it will become 0. Values greater than + the Z ordinate are lost. + + + + + + Creates a new vector based on the first three values on the first row of the + matrix. This is useful for working with the result of a transformation matrix. + + An IMatrixD that should represent the vector + + + + Adds each of the elements of V to the elements of this vector + + Vector, the vector to add to this vector + A vector result from the addition + + + + Returns the square of the distance of the vector without taking the square root + This is the same as doting the vector with itself + + Double, the square of the distance between the vectors + + + + Rotates the vector about the X axis as though the tail of the vector were at the origin + + The angle in degrees to rotate counter-clockwise when looking at the origin from the positive axis. + A new Vector that has been rotated + + + + Rotates the vector about the Y axis as though the tail of the vector were at the origin + + The angle in degrees to rotate counter-clockwise when looking at the origin from the positive axis. + A new Vector that has been rotated + + + + Rotates the vector about the Z axis as though the tail of the vector were at the origin + + The angle in degrees to rotate counter-clockwise when looking at the origin from the positive axis. + A new Vector that has been rotated + + + + Assuming the vector starts at the origin of 0, 0, 0, this function returns + a Point representing the tip of the vector. + + + + + Returns a new segment from this vector, where the StartPoint is 0, 0, 0 + and the End Point is the tip of this vector + + + + + + Returns an ICoordinate from this vector, where the X, Y and Z value match the values in this vector + + an ICoordinate, where the X, Y and Z value match the values in this vector + + + + Transforms a point that has 3 dimensions by multiplying it by the + specified 3 x 3 matrix in the upper left, but treats the + bottom row as supplying the translation coordinates. + + + + + + + Rotations and transformations work by applying matrix mathematics, + so this creates a 1 x 4 version of this vector. The 4th value + is always 1, and allows for the translation terms to work. + + + + + + Subtracts each element of V from each element of this vector + + Vector, the vector to subtract from this vector + A vector result from the subtraction + + + + Normalizes the vector. + + + + + Returns the cross product of this vector with the specified vector V + + The vector to perform a cross product against + A vector result from the inner product + + + + Returns the dot product of this vector with V2 + + The vector to perform an inner product against + A Double result from the inner product + + + + Compares the values of each element, and if all the elements are equal, returns true. + + The vector to compare against this vector. + Boolean, true if all the elements have the same value. + + + + Override for definition of equality for vectors + + A vector to compare with + true if the X, Y, and Z coordinates are all equal + + + + Checks first to make sure that both objects are vectors. If they are, + then it checks to determine whether or not the X, Y and Z values are equal. + + The object to test against + + + + + Returns the hash code.. or something + + A hash code I guess + + + + Returns the scalar product of this vector against a scalar + + Double, a value to multiply against all the members of this vector + A vector multiplied by the scalar + + + + Adds the vectors U and V using vector addition, which adds the corresponding components + + One vector to be added + A second vector to be added + + + + + Returns the Cross Product of two vectors U and V + + Vector, the first input vector + Vector, the second input vector + A Vector containing the cross product of U and V + + + + Multiplies each component of vector U by the Scalar value + + A vector representing the vector to be multiplied + Double, the scalar value to mulitiply the vector components by + A Vector representing the vector product of vector U and the Scalar + + + + Returns the Inner Product also known as the dot product of two vectors, U and V + + The input vector + The vector to take the inner product against U + a Double containing the dot product of U and V + + + + Non-static version of taking the square distance for a vector + + The vector to find the square of the distance of + Double, the square of the distance + + + + Multiplies each component of vector U by the Scalar value + + A vector representing the vector to be multiplied + Double, the scalar value to mulitiply the vector components by + A Vector representing the vector product of vector U and the Scalar + + + + Subtracts Vector V from Vector U + + A Vector to subtract from + A Vector to subtract + The Vector difference U - V + + + + Adds the vectors U and V using vector addition, which adds the corresponding components + + One vector to be added + A second vector to be added + The sum of the vectors + + + + Tests equality of the X, Y, and Z members. + + The left hand side vector to test for equality. + The right hand side vector to test for equality. + Returns true if X, Y and Z are equal. + + + + Tests inequality of the X, Y and Z members. + + The left hand side vector to test inequality for. + The right hand side vector to test inequality for + Returns true if X, Y and Z are equal + + + + Returns the Cross Product of two vectors U and V + + Vector, the first input vector + Vector, the second input vector + A Vector containing the cross product of U and V + + + + Returns the Inner Product also known as the dot product of two vectors, U and V + + The input vector + The vector to take the inner product against U + a Double containing the dot product of U and V + + + + Multiplies the vectors U and V using vector multiplication, + which adds the corresponding components + + A scalar to multpy to the vector + A vector to be multiplied + The scalar product for the vectors + + + + Multiplies each component of vector U by the Scalar value + + A vector representing the vector to be multiplied + Double, the scalar value to mulitiply the vector components by + A Vector representing the vector product of vector U and the Scalar + + + + Subtracts Vector V from Vector U + + A Vector to subtract from + A Vector to subtract + The Vector difference U - V + + + + The Euclidean distance from the origin to the tip of the 3 dimensional vector + Setting the magntiude won't change the direction. + + + + + Returns the magnitude of the projection of the vector onto the base.X-Y plane + Setting this magnitude will not affect Z, which should be adjusted separately + + + + + Obtains the angle above the X-Y plane. Positive towards positive Z. + Values are in radians from -Pi/2 to Pi/2 + Setting this value when no magnitude exists results in a unit vector with angle phi in the X direction. + + + + + Represents the angle in the X-Y plane. 0 along the positive X axis, and increasing counterclockwise + Values are in Radians. Setting this value when no X-Y magnitude exists results in a unit vector + between X and Y, but does not affect Z, so you may have something other than a unit vector in 3-D. + Set theta before phi in order to obtain a unit vector in 3-D space. + + + + + WkbGeometryTypes + + + + + Point. + + + + + LineString. + + + + + Polygon. + + + + + MultiPoint. + + + + + MultiLineString. + + + + + MultiPolygon. + + + + + GeometryCollection. + + + + + Writes a Well-Known Binary byte data representation of a Geometry. + + + + + Standard byte size for each complex point. + Each complex point (LineString, Polygon, ...) contains: + 1 byte for ByteOrder and + 4 bytes for WKBType. + + + + + Initializes writer with LittleIndian byte order. + + + + + Initializes writer with the specified byte order. + + Encoding type + + + + Writes a WKB representation of a given point. + + + + + + + Writes a WKB representation of a given point. + + + + + + + + + + + + + + Writes LittleIndian ByteOrder. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Sets corrent length for Byte Stream. + + + + + + + Sets corrent length for Byte Stream. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Outputs the textual representation of a Geometry. + The WktWriter outputs coordinates rounded to the precision + model. No more than the maximum number of necessary decimal places will be + output. + The Well-known Text format is defined in the OpenGIS Simple Features Specification + (http://www.opengis.org/techno/specs.htm) for SQL. + A non-standard "LINEARRING" tag is used for LinearRings. The WKT spec does + not define a special tag for LinearRings. The standard tag to use is + "LINESTRING". + + + + + Generates the WKT for a Point. + + The point coordinate. + + + + + Generates the WKT for a N-point LineString. + + The sequence to output. + + + + + Generates the WKT for a 2-point LineString. + + The first coordinate. + The second coordinate. + + + + + Creates the NumberFormatInfo used to write doubles + with a sufficient number of decimal places. + + + The PrecisionModel used to determine + the number of decimal places to write. + + + A NumberFormatInfo that write double + s without scientific notation. + + + + + Returns a String of repeated characters. + + The character to repeat. + The number of times to repeat the character. + A string of characters. + + + + Converts a Geometry to its Well-known Text representation. + + A Geometry to process. + A Geometry Tagged Text string (see the OpenGIS Simple Features Specification). + + + + Converts a Geometry to its Well-known Text representation. + + A Geometry to process. + + + + + Same as write, but with newlines and spaces to make the + well-known text more readable. + + A Geometry to process + + A "Geometry Tagged Text" string (see the OpenGIS Simple + Features Specification), with newlines and spaces. + + + + + Same as write, but with newlines and spaces to make the + well-known text more readable. + + A Geometry to process + + + + + Converts a Geometry to its Well-known Text representation. + + A Geometry to process + + + + + + Converts a Geometry to <Geometry Tagged Text format, + then appends it to the writer. + + /he Geometry to process. + + /he output writer to append to. + + + + Converts a Coordinate to Point Tagged Text format, + then appends it to the writer. + + The Coordinate to process. + The output writer to append to. + + + + Converts a LineString to <LineString Tagged Text + format, then appends it to the writer. + + The LineString to process. + + The output writer to append to. + + + + Converts a LinearRing to <LinearRing Tagged Text + format, then appends it to the writer. + + The LinearRing to process. + + The output writer to append to. + + + + Converts a Polygon to Polygon Tagged Text format, + then appends it to the writer. + + The Polygon to process. + + The output writer to append to. + + + + Converts a MultiPoint to <MultiPoint Tagged Text + format, then appends it to the writer. + + The MultiPoint to process. + The output writer to append to. + + + + Converts a MultiLineString to MultiLineString Tagged + Text format, then appends it to the writer. + + The MultiLineString to process. + + The output writer to append to. + + + + Converts a MultiPolygon to MultiPolygon Tagged Text + format, then appends it to the writer. + + The MultiPolygon to process. + + The output writer to append to. + + + + Converts a GeometryCollection to GeometryCollection + Tagged Text format, then appends it to the writer. + + The GeometryCollection to process. + + The output writer to append to. + + + + Converts a Coordinate to Point Text format, then + appends it to the writer. + + The Coordinate to process. + The output writer to append to. + + + + Converts a Coordinate to Point format, then appends + it to the writer. + + The Coordinate to process. + The output writer to append to. + The PrecisionModel to use to convert + from a precise coordinate to an external coordinate. + + + + Converts a to a , + not in scientific notation. + + The to convert. + + The as a , + not in scientific notation. + + + + + Converts a LineString to <LineString Text format, then + appends it to the writer. + + The LineString to process. + + + The output writer to append to. + + + + Converts a Polygon to Polygon Text format, then + appends it to the writer. + + The Polygon to process. + + + The output writer to append to. + + + + Converts a MultiPoint to <MultiPoint Text format, then + appends it to the writer. + + The MultiPoint to process. + The output writer to append to. + + + + Converts a MultiLineString to <MultiLineString Text + format, then appends it to the writer. + + The MultiLineString to process. + + + The output writer to append to. + + + + Converts a MultiPolygon to <MultiPolygon Text format, + then appends it to the writer. + + The MultiPolygon to process. + + The output writer to append to. + + + + Converts a GeometryCollection to GeometryCollectionText + format, then appends it to the writer. + + The GeometryCollection to process. + + The output writer to append to. + + + + + + + + + + + A strongly-typed resource class, for looking up localized strings, etc. + + + + + Returns the cached ResourceManager instance used by this class. + + + + + Overrides the current thread's CurrentUICulture property for all + resource lookups using this strongly typed resource class. + + + + + Looks up a localized string similar to The argument %S cannot be negative.. + + + + + Looks up a localized string similar to The argument %S1 could not be successfully cast into %S2.. + + + + + Looks up a localized string similar to The argument %S was outside the range of accepted values.. + + + + + Looks up a localized string similar to The class %S is not supported.. + + + + + Looks up a localized string similar to The number of ordinates did not match between the dimensions, so the hyperdistance cannot be accurately calculated.. + + + + + Looks up a localized string similar to The same directed edge appeared more than once.. + + + + + Looks up a localized string similar to Geometry collections are not supported for this method.. + + + + + Looks up a localized string similar to The number of dimensions in at least one argument is insufficient for this calculation.. + + + + + Looks up a localized string similar to The number of dimensions in %S is insufficient for this calculation.. + + + + + Looks up a localized string similar to An invalid octant was specified: %S. + + + + + Looks up a localized string similar to The specified key already exists in the tree.. + + + + + Looks up a localized string similar to The specified key could not be found in the tree.. + + + + + Looks up a localized string similar to The size of the key did not match the size of the tree.. + + + + + Looks up a localized string similar to Found null Directed Edge in ring. + + + + + Looks up a localized string similar to Holes must not contain null elements. + + + + + Looks up a localized string similar to Shell is empty but holes are not. + + + + + Looks up a localized string similar to The ICollection is read-only.. + + + + + Looks up a localized string similar to Points in shell and hole appear to be equal. + + + + + Looks up a localized string similar to The code execution should never have reached this location.. + + + + + Looks up a localized string similar to Side location conflict at. + + + + + Looks up a localized string similar to Found single null side at. + + + + + Looks up a localized string similar to Assigned depths do not match. + + + + + Looks up a localized string similar to Found two horizontal edges incident on node.. + + + + + Looks up a localized string similar to Unsupported Geometry classes should be caught in the GeometryEditorOperation.. + + + + + Computes the centroid of an area point. + Algorithm: + Based on the usual algorithm for calculating + the centroid as a weighted sum of the centroids + of a decomposition of the area into (possibly overlapping) triangles. + The algorithm has been extended to handle holes and multi-polygons. + See + for further details of the basic approach. + + + + + Adds the area defined by a Geometry to the centroid total. + If the point has no area it does not contribute to the centroid. + + The point to add. + + + + Adds the area defined by an array of + coordinates. The array must be a ring; + i.e. end with the same coordinate as it starts with. + + An array of Coordinates. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Returns three times the centroid of the triangle p1-p2-p3. + The factor of 3 is + left in to permit division to be avoided until later. + + + + + Returns twice the signed area of the triangle p1-p2-p3, + positive if a, b, c are oriented Ccw, and negative if cw. + + + + + + + + + + + + + + + Computes the centroid of a linear point. + Algorithm: + Compute the average of the midpoints + of all line segments weighted by the segment length. + + + + + Adds the linestring(s) defined by a Geometry to the centroid total. + If the point is not linear it does not contribute to the centroid. + + The point to add. + + + + Adds the length defined by an array of coordinates. + + An array of Coordinates. + + + + + + + + + Computes the centroid of a point point. + Algorithm: + Compute the average of all points. + + + + + Adds the point(s) defined by a Geometry to the centroid total. + If the point is not of dimension 0 it does not contribute to the centroid. + + The point to add. + + + + Adds the length defined by a coordinate. + + A coordinate. + + + + + + + + + Specifies and implements various fundamental Computational Geometric algorithms. + The algorithms supplied in this class are robust for double-precision floating point. + + + + + A value that indicates an orientation of clockwise, or a right turn. + + + + + A value that indicates an orientation of clockwise, or a right turn. + + + + + A value that indicates an orientation of counterclockwise, or a left turn. + + + + + A value that indicates an orientation of counterclockwise, or a left turn. + + + + + A value that indicates an orientation of collinear, or no turn (straight). + + + + + A value that indicates an orientation of collinear, or no turn (straight). + + + + + Returns the index of the direction of the point q + relative to a vector specified by p1-p2. + + The origin point of the vector. + The final point of the vector. + The point to compute the direction to. + + 1 if q is counter-clockwise (left) from p1-p2, + -1 if q is clockwise (right) from p1-p2, + 0 if q is collinear with p1-p2. + + + + + Test whether a point lies inside a ring. + The ring may be oriented in either direction. + If the point lies on the ring boundary the result of this method is unspecified. + This algorithm does not attempt to first check the point against the envelope + of the ring. + + Point to check for ring inclusion. + Assumed to have first point identical to last point. + true if p is inside ring. + + + + Test whether a point lies on the line segments defined by a + list of coordinates. + + + + + true true if + the point is a vertex of the line or lies in the interior of a line + segment in the linestring. + + + + + Computes whether a ring defined by an array of s is oriented counter-clockwise. + The list of points is assumed to have the first and last points equal. + This will handle coordinate lists which contain repeated points. + This algorithm is only guaranteed to work with valid rings. + If the ring is invalid (e.g. self-crosses or touches), + the computed result may not be correct. + > + + + + + + Computes the orientation of a point q to the directed line segment p1-p2. + The orientation of a point relative to a directed line segment indicates + which way you turn to get to q after travelling from p1 to p2. + + + + + + 1 if q is counter-clockwise from p1-p2, + -1 if q is clockwise from p1-p2, + 0 if q is collinear with p1-p2- + + + + + Computes the distance from a point p to a line segment AB. + Notice: NON-ROBUST! + + The point to compute the distance for. + One point of the line. + Another point of the line (must be different to A). + The distance from p to line segment AB. + + + + Computes the perpendicular distance from a point p + to the (infinite) line containing the points AB + + The point to compute the distance for. + One point of the line. + Another point of the line (must be different to A). + The perpendicular distance from p to line AB. + + + + Computes the distance from a line segment AB to a line segment CD. + Notice: NON-ROBUST! + + A point of one line. + The second point of the line (must be different to A). + One point of the line. + Another point of the line (must be different to A). + The distance from line segment AB to line segment CD. + + + + Returns the signed area for a ring. The area is positive if the ring is oriented CW. + + + Area in Meters (by default) when using projected coordinates. + + + + Computes the length of a linestring specified by a sequence of points. + + The points specifying the linestring. + The length of the linestring. + + + + Computes the convex hull of a . + The convex hull is the smallest convex Geometry that contains all the + points in the input Geometry. + Uses the Graham Scan algorithm. + + + + + Create a new convex hull construction for the input Geometry. + + + + + + Create a new convex hull construction for the input array. + + + + + + + + + + + + + + Returns a Geometry that represents the convex hull of the input point. + The point will contain the minimal number of points needed to + represent the convex hull. In particular, no more than two consecutive + points will be collinear. + + + If the convex hull contains 3 or more points, a Polygon; + 2 points, a LineString; + 1 point, a Point; + 0 points, an empty GeometryCollection. + + + + + Uses a heuristic to reduce the number of points scanned to compute the hull. + The heuristic is to find a polygon guaranteed to + be in (or on) the hull, and eliminate all points inside it. + A quadrilateral defined by the extremal points + in the four orthogonal directions + can be used, but even more inclusive is + to use an octilateral defined by the points in the 8 cardinal directions. + Notice that even if the method used to determine the polygon vertices + is not 100% robust, this does not affect the robustness of the convex hull. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Whether the three coordinates are collinear + and c2 lies between c1 and c3 inclusive. + + + + + + + + + + + + + + + + + + + + + The vertices of a linear ring, which may or may not be flattened (i.e. vertices collinear). + A 2-vertex LineString if the vertices are collinear; + otherwise, a Polygon with unnecessary (collinear) vertices removed. + + + + + + The vertices of a linear ring, which may or may not be flattened (i.e. vertices collinear). + The coordinates with unnecessary (collinear) vertices removed. + + + + Compares s for their angle and distance + relative to an origin. + + + + + Initializes a new instance of the class. + + + + + + + + + + + + + + + + + + + + + + + Represents a homogeneous coordinate for 2-D coordinates. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Computes the (approximate) intersection point between two line segments + using homogeneous coordinates. + Notice that this algorithm is + not numerically stable; i.e. it can produce intersection points which + lie outside the envelope of the line segments themselves. In order + to increase the precision of the calculation input points should be normalized + before passing them to this routine. + + + + + + + + + + + + + + + + + + + + + + Direct access to x private field + + + + + Direct access to y private field + + + + + Direct access to w private field + + + + + + + + + + Computes a point in the interior of an area point. + Algorithm: + Find the intersections between the point + and the horizontal bisector of the area's envelope + Pick the midpoint of the largest intersection (the intersections + will be lines and points) + Notice: If a fixed precision model is used, + in some cases this method may return a point + which does not lie in the interior. + + + + + + + + + + + + + + + + + + + Tests the interior vertices (if any) + defined by a linear Geometry for the best inside point. + If a Geometry is not of dimension 1 it is not tested. + + The point to add. + + + + Adds a polygon. + + The polygon to add.> + + + + + + + + If point is a collection, the widest sub-point; otherwise, + the point itself. + + + + + + + + + + + + + + + + + + + Returns the centre point of the envelope. + + The envelope to analyze. + The centre of the envelope. + + + + + + + + + Computes a point in the interior of an linear point. + Algorithm: + Find an interior vertex which is closest to + the centroid of the linestring. + If there is no interior vertex, find the endpoint which is + closest to the centroid. + + + + + + + + + + + Tests the interior vertices (if any) + defined by a linear Geometry for the best inside point. + If a Geometry is not of dimension 1 it is not tested. + + The point to add. + + + + + + + + + + Tests the endpoint vertices + defined by a linear Geometry for the best inside point. + If a Geometry is not of dimension 1 it is not tested. + + The point to add. + + + + + + + + + + + + + + + + + + + + + Computes a point in the interior of an point point. + Algorithm: + Find a point which is closest to the centroid of the point. + + + + + + + + + + + Tests the point(s) defined by a Geometry for the best inside point. + If a Geometry is not of dimension 0 it is not tested. + + The point to add. + + + + + + + + + + + + + + + IntersectionTypes + + + + + No intersection occurs + + + + + The lines intersect in a single point + + + + + The lines intersect by overlapping + + + + + An interface for classes which test whether a Coordinate lies inside a ring. + + + + + + + + + + + + A LineIntersector is an algorithm that can both test whether + two line segments intersect and compute the intersection point + if they do. + The intersection point may be computed in a precise or non-precise manner. + Computing it precisely involves rounding it to an integer. (This assumes + that the input coordinates have been made precise by scaling them to + an integer grid.) + + + + + The indexes of the endpoints of the intersection lines, in order along + the corresponding line + + + + + If MakePrecise is true, computed intersection coordinates will be made precise + using Coordinate.MakePrecise. + + + + + + + + + + Computes the "edge distance" of an intersection point p along a segment. + The edge distance is a metric of the point along the edge. + The metric used is a robust and easy to compute metric function. + It is not equivalent to the usual Euclidean metric. + It relies on the fact that either the x or the y ordinates of the + points in the edge are unique, depending on whether the edge is longer in + the horizontal or vertical direction. + Notice: This function may produce incorrect distances + for inputs where p is not precisely on p1-p2 + (E.g. p = (139, 9) p1 = (139, 10), p2 = (280, 1) produces distanct 0.0, which is incorrect. + My hypothesis is that the function is safe to use for points which are the + result of rounding points which lie on the line, but not safe to use for truncated points. + + + + + This function is non-robust, since it may compute the square of large numbers. + Currently not sure how to improve this. + + + + + + + + + Compute the intersection of a point p and the line p1-p2. + This function computes the bool value of the hasIntersection test. + The actual value of the intersection (if there is one) + is equal to the value of p. + + + + + Computes the intersection of the lines p1-p2 and p3-p4. + This function computes both the bool value of the hasIntersection test + and the (approximate) value of the intersection point itself (if there is one). + + + + + + + + + + + + + + + + + + + + + Returns the intIndex'th intersection point. + + is 0 or 1. + The intIndex'th intersection point. + + + + + + + + + Test whether a point is a intersection point of two line segments. + Notice that if the intersection is a line segment, this method only tests for + equality with the endpoints of the intersection segment. + It does not return true if the input point is internal to the intersection segment. + + true if the input point is one of the intersection points. + + + + Tests whether either intersection point is an interior point of one of the input segments. + + + true if either intersection point is in the interior of one of the input segment. + + + + + Tests whether either intersection point is an interior point of the specified input segment. + + + true if either intersection point is in the interior of the input segment. + + + + + Computes the coordinate of the intIndex'th intersection point in the direction of + a specified input line segment. + + The segment index from 0 to 1. + The integer intersection index from 0 to 1. + + The coordinate of the intIndex'th intersection point in the direction of the specified input line segment. + + + + + Computes the index of the intIndex'th intersection point in the direction of + a specified input line segment, and returns the integer index. + + The integer segment index from 0 to 1. + The integer intersection index from 0 to 1. + + The integer index of the intersection point along the segment (0 or 1). + + + + + Computes the integer line index of the specified integer segment index. + + The integer index of the segment. + + + + Computes the "edge distance" of an intersection point along the specified input line segment. + + The integer segment index from 0 to 1. + The integer intersection index from 0 to 1. + The edge distance of the intersection point. + + + + Gets or sets the first intersection coordinate, if any. + + + + + Gets or sets the second intersection coordiante, if any. + + + + + Force computed intersection to be rounded to a given precision model + + + + + Force computed intersection to be rounded to a given precision model. + No getter is provided, because the precision model is not required to be specified. + + + + + Tests whether the input geometries intersect. + + true if the input geometries intersect. + + + + Returns the number of intersection points found. This will be either 0, 1 or 2. + + + + + Gets the array of intersection points + + + + + Gets or sets a two dimensional array of coordinates representing the input lines for the calculation + + + + + This is true if the intersection forms a line + + + + + Gets Whether this is both propper and has an intersection + + + + + Tests whether an intersection is proper. + The intersection between two line segments is considered proper if + they intersect in a single point in the interior of both segments + (e.g. the intersection is a single point and is not equal to any of the endpoints). + The intersection between a point and a line segment is considered proper + if the point lies in the interior of the segment (e.g. is not equal to either of the endpoints). + + true if the intersection is proper. + + + + Gets or sets the integer result + + + + + Implements IPointInRing + using a MonotoneChains and a BinTree index to increase performance. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The action for the internal iterator for performing + envelope select queries on a MonotoneChain. + + + + + These envelopes are used during the MonotoneChain search process. + + + + + This function can be overridden if the original chain is needed. + + + + + + + This is a convenience function which can be overridden to obtain the actual + line segment which is selected. + + + + + + + + + + + + + + + + + + + Computes the minimum diameter of a Geometry. + The minimum diameter is defined to be the + width of the smallest band that contains the point, + where a band is a strip of the plane defined + by two parallel lines. + This can be thought of as the smallest hole that the point can be + moved through, with a single rotation. + The first step in the algorithm is computing the convex hull of the Geometry. + If the input Geometry is known to be convex, a hint can be supplied to + avoid this computation. + + + + + Compute a minimum diameter for a giver Geometry. + + a Geometry. + + + + Compute a minimum diameter for a giver Geometry, + with a hint if + the Geometry is convex + (e.g. a convex Polygon or LinearRing, + or a two-point LineString, or a Point). + + a Geometry which is convex. + true if the input point is convex. + + + + + + + + + + + + + + + Compute the width information for a ring of Coordinates. + Leaves the width information in the instance variables. + + + + + + + + + + + + + + + + + + + + + + + Gets the length of the minimum diameter of the input Geometry. + + The length of the minimum diameter. + + + + Gets the Coordinate forming one end of the minimum diameter. + + A coordinate forming one end of the minimum diameter. + + + + Gets the segment forming the base of the minimum diameter. + + The segment forming the base of the minimum diameter. + + + + Gets a LineString which is a minimum diameter. + + A LineString which is a minimum diameter. + + + + Non-robust versions of various fundamental Computational Geometric algorithms, + FOR TESTING PURPOSES ONLY!. + The non-robustness is due to rounding error in floating point computation. + + + + + + + + + + + + + Computes whether a ring defined by an array of Coordinate is + oriented counter-clockwise. + This will handle coordinate lists which contain repeated points. + + an array of coordinates forming a ring. + + true if the ring is oriented counter-clockwise. + throws ArgumentException if the ring is degenerate (does not contain 3 different points) + + + + + + + + + + + + + + A non-robust version of LineIntersector. + + + + + + + + + + true if both numbers are positive or if both numbers are negative, + false if both numbers are zero. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + RParameter computes the parameter for the point p + in the parameterized equation + of the line from p1 to p2. + This is equal to the 'distance' of p along p1-p2. + + + + + + + + + + + + + + + Computes the topological relationship (Location) of a single point to a Geometry. + The algorithm obeys the SFS boundaryDetermination rule to correctly determine + whether the point lies on the boundary or not. + Notice that instances of this class are not reentrant. + + + + + Convenience method to test a point for intersection with a Geometry + + The coordinate to test. + The Geometry to test. + true if the point is in the interior or boundary of the Geometry. + + + + Computes the topological relationship ({Location}) of a single point to a Geometry. + It handles both single-element and multi-element Geometries. + The algorithm for multi-part Geometries takes into account the boundaryDetermination rule. + + The Location of the point relative to the input Geometry. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Implements an algorithm to compute the + sign of a 2x2 determinant for double precision values robustly. + It is a direct translation of code developed by Olivier Devillers. + + The original code carries the following copyright notice: + ************************************************************************ + Author : Olivier Devillers + Olivier.Devillers@sophia.inria.fr + http:/www.inria.fr:/prisme/personnel/devillers/anglais/determinant.html + ************************************************************************* + ************************************************************************* + Copyright (c) 1995 by INRIA Prisme Project + BP 93 06902 Sophia Antipolis Cedex, France. + All rights reserved + ************************************************************************* + + + + + + + + + + + + returns -1 if the determinant is negative, + returns 1 if the determinant is positive, + retunrs 0 if the determinant is null. + + + + + A robust version of LineIntersector. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + This method computes the actual value of the intersection point. + To obtain the maximum precision from the intersection calculation, + the coordinates are normalized by subtracting the minimum + ordinate values (in absolute value). This has the effect of + removing common significant digits from the calculation to + maintain more bits of precision. + + + + + + + + + + Normalize the supplied coordinates to + so that the midpoint of their intersection envelope + lies at the origin. + + + + + + + + + + Test whether a point lies in the envelopes of both input segments. + A correctly computed intersection point should return true + for this test. + Since this test is for debugging purposes only, no attempt is + made to optimize the envelope test. + + + true if the input point lies within both input segment envelopes. + + + + Computes whether a point + lies in the interior of an area Geometry. + The algorithm used is only guaranteed to return correct results + for points which are not on the boundary of the Geometry. + + + + + + + + + + Locate is the main location function. It handles both single-element + and multi-element Geometries. The algorithm for multi-element Geometries + is more complex, since it has to take into account the boundaryDetermination rule. + + The coordinate to locate. + The Geometry to locate the coordinate in. + + + + + + + + + + + + + + + + + + + + Tests whether a Coordinate lies inside + a ring, using a linear-time algorithm. + + + + + + + + + + + + + + + + + + + + + + + Implements PointInRing using a SIRtree index to increase performance. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + A ClassNotSupportedException Class + + + + + Creates a new instance of ClassNotSupportedException + + + + + + + + + + A visitor for items in an index. + + + + + + + + + + + + + + + + + + + + + + An BinTree (or "Binary Interval Tree") + is a 1-dimensional version of a quadtree. + It indexes 1-dimensional intervals (which of course may + be the projection of 2-D objects on an axis). + It supports range searching + (where the range may be a single point). + This implementation does not require specifying the extent of the inserted + items beforehand. It will automatically expand to accomodate any extent + of dataset. + This index is different to the Interval Tree of Edelsbrunner + or the Segment Tree of Bentley. + + + + + + + + + + Ensure that the Interval for the inserted item has non-zero extents. + Use the current minExtent to pad it, if necessary. + + + + + + + + + + + + + + + + + + + + + + + + + min and max may be the same value. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Compute the total number of nodes in the tree. + + The number of nodes in the tree. + + + + Represents an (1-dimensional) closed interval on the Real number line. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + A Key is a unique identifier for a node in a tree. + It contains a lower-left point and a level number. The level number + is the power of two for the size of the node envelope. + + + + + + + + + + + + + + + + + + Return a square envelope containing the argument envelope, + whose extent is a power of two and which is based at a power of 2. + + + + + + + + + + + + + + + + + + + + + + + + + + + + A node of a Bintree. + + + + + The base class for nodes in a Bintree. + + + + + Subnodes are numbered as follows: + 0 | 1 + + + + + Adds the specified object to the items list for this node. This will not affect child nodes. + + The object item to add to the list. + + + + + + + + + + + + + + + + + + + + + + + + + + Returns the index of the subnode that wholely contains the given interval. + If none does, returns -1. + + + + + + + Gets the count of all the items in this node, plus all the items in all of the child nodes + + + + + Gets an integer representing the maximum levels needed to be decended to account for all the child nodes + + + + + Gets a list of all the items currently stored in this node. This does not include + any items from child nodes. + + + + + Gets the count of this node plus all of the child nodes + + + + + Gets the array of all the sub-nodes below this node. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Returns the subnode containing the envelope. + Creates the node if + it does not already exist. + + + + + + Returns the smallest existing + node containing the envelope. + + + + + + + + + + + + Get the subnode for the index. + If it doesn't exist, create it. + + + + + + + + + + + + + + + + + The root node of a single Bintree. + It is centred at the origin, + and does not have a defined extent. + + + + + Insert an item into the tree this is the root of. + + + + + + + Insert an item which is known to be contained in the tree rooted at + the given Node. Lower levels of the tree will be created + if necessary to hold the item. + + + + + + + + The root node matches all searches. + + + + + + MonotoneChains are a way of partitioning the segments of a linestring to + allow for fast searching of intersections. + They have the following properties: + the segments within a monotone chain will never intersect each other + the envelope of any contiguous subset of the segments in a monotone chain + is equal to the envelope of the endpoints of the subset. + Property 1 means that there is no need to test pairs of segments from within + the same monotone chain for intersection. + Property 2 allows + binary search to be used to find the intersection points of two monotone chains. + For many types of real-world data, these properties eliminate a large number of + segment comparisons, producing substantial speed gains. + One of the goals of this implementation of MonotoneChains is to be + as space and time efficient as possible. One design choice that aids this + is that a MonotoneChain is based on a subarray of a list of points. + This means that new arrays of points (potentially very large) do not + have to be allocated. + MonotoneChains support the following kinds of queries: + Envelope select: determine all the segments in the chain which + intersect a given envelope. + Overlap: determine all the pairs of segments in two chains whose + envelopes overlap. + This implementation of MonotoneChains uses the concept of internal iterators + to return the resultsets for the above queries. + This has time and space advantages, since it + is not necessary to build lists of instantiated objects to represent the segments + returned by the query. + However, it does mean that the queries are not thread-safe. + + + + + + + + + + + + + + Gets a copy of the line segment located at the specified index. + + + + + + Determine all the line segments in the chain whose envelopes overlap + the searchEnvelope, and process them. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Return the subsequence of coordinates forming this chain. + Allocates a new array to hold the Coordinates. + + + + + A MonotoneChainBuilder implements static functions + to determine the monotone chains in a sequence of points. + + + + + Only static methods! + + + + + + + + + + + + + + + + + + + Return a list of the MonotoneChains + for the given list of coordinates. + + + + + + + Return an array containing lists of start/end indexes of the monotone chains + for the given list of coordinates. + The last entry in the array points to the end point of the point array, + for use as a sentinel. + + + + + + + + + + + The index of the last point in the monotone chain starting at start. + + + + + The action for the internal iterator for performing + overlap queries on a MonotoneChain. + + + + + This function can be overridden if the original chains are needed. + + + The index of the start of the overlapping segment from mc1. + + The index of the start of the overlapping segment from mc2. + + + + This is a convenience function which can be overridden to obtain the actual + line segments which overlap. + + + + + + + This envelope is used during the MonotoneChain search process. + + + + + This envelope is used during the MonotoneChain search process. + + + + + One overlapping segment. + + + + + The other overlapping segment. + + + + + A visitor for nodes and items in an index. + + + + + + + + + + + The basic insertion and query operations supported by classes + implementing spatial index algorithms. + A spatial index typically provides a primary filter for range rectangle queries. A + secondary filter is required to test for exact intersection. Of course, this + secondary filter may consist of other tests besides intersection, such as + testing other kinds of spatial relationships. + + + + + Adds a spatial item with an extent specified by the given Envelope to the index. + + + + + Queries the index for all items whose extents intersect the given search Envelope + Notice that some kinds of indexes may also return objects which do not in fact + intersect the query envelope. + + The envelope to query for. + A list of the items found by the query. + + + + Queries the index for all items whose extents intersect the given search , + and applies an to them. + Notice that some kinds of indexes may also return objects which do not in fact + intersect the query envelope. + + The envelope to query for. + A visitor object to apply to the items found. + + + + Removes a single item from the tree. + + The Envelope of the item to remove. + The item to remove. + true if the item was found. + + + + Bjoern Heckel's solution to the KD-Tree n-nearest-neighbor problem + + + + + Creates a new NearestNeighborList + + An integer indicating the maximum size for the cue + + + + Inserts an object with a given priority + + + + + + + + Removes the highest member from the cue and returns that object. + + + + + + Gets the minimum priority, or distance. Since we are looking for the maximum distance, or the + n maximum distances, we want to determine quickly the lowest distance currently contained + in the cue. + + + + + + Gets whether or not the length of the cue has reached the capacity + + + + + Gets the highest object in the nearest neighbor list + + + + + + Gets a boolean indicating whether or not the cue is empty + + + + + + Gets the length of the current list + + + + + Hyper-Point class supporting KdTree class + + + + + Constructs a new HyperPoint where numDimensions indicates the size of the array for the coordinates + + The number of dimensions + + + + Constructs a new HyperPoint where the specified array of doubles defines the internal coordinate values. + + The in coordinate to use when constructing this hyper point. + + + + A Static method for returning the square distance between two coordinates + + One coordinate + A second coordinate + A double representing the square distance + + + + Calculates the Euclidean distance between the two coordinates + + An ICoordinate + Another ICoordinate + A double representing the distance + + + + Calculates the distance in comparison with any coordinate. The coordinate with fewer dimensions + will determine the dimensionality for the comparison. + + + + + + + Calculates the square of the Euclidean distance between this point and the other point. + + Any valid implementation of ICoordinate + A double representing the distances. + + + + Gets or sets the actual values for this class. + + + + + Hyper-Rectangle class supporting KdTree class + + + + + Maximum values + + + + + Minimum values + + + + + Constructs a new instance of a rectangle binding structure based on a specified number of dimensions + + An integer representing the number of dimensions. For X, Y coordinates, this should be 2. + + + + Creates a new bounding rectangle based on the two coordinates specified. It is assumed that + the vmin and vmax coordinates have already been correctly calculated. + + + + + + + Creates a duplicate of this object + + An object duplicate of this object + + + + Creates a duplicate of this bounding box using the existing minimum and maximum. + + An HRect duplicate of this object + + + + Calculates the closest point on the hyper-extent to the specified point. + from Moore's eqn. 6.6 + + + + + + + This method calculates the furthest point on the rectangle + from the specified point. This is to determine if it is + possible for any of the members of the closer rectangle + to be positioned further away from the test point than + the points in the hyper-extent that is further from the point. + + + + + + + Calculates a new HRect object that has a nearly infinite bounds. + + THe number of dimensions to use + A new HRect where the minimum is negative infinity, and the maximum is positive infinity + Used in initial conditions of KdTree.nearest() + + + + If the specified HRect does not intersect this HRect, this returns null. Otherwise, + this will return a smaller rectangular region that represents the intersection + of the two bounding regions. + + Another HRect object to intersect with this one. + The HRect that represents the intersection area for the two bounding boxes. + currently unused + + + + Creates a string that represents this bounding box + + A String + + + + Gets the current hyper-volume. For 1D, this is Length. For 2D this is Area. For 3D this is Volume. + + + + + Gets or sets the minimum coordinate (containing the smaller value) in all dimensions. + + + + + Gets or sets the maximum coordinate + + + + + Gets the number of ordinates for this rectangular structure (based on the minimum HPoint) + + + + + K-D Tree node class + + + + + Constructs a new instance of the KDNode. + + A Hyper Point representing the key to use for storing this value + A valid object value to use for copying this. + The constructor is used only by class; other methods are static + + + + Creates a string representation of this node + + The depth of child nodes to search when creating the string. + A string representation of this node. + + + + Inserts a + + + + + + + + Method ins translated from 352.ins.c of Gonnet and Baeza-Yates + + + + Searches for a specific value + + + + + + Method srch translated from 352.srch.c of Gonnet and Baeza-Yates + + + + Searches for values in a range + + + + + + + + Method rsearch translated from 352.range.c of Gonnet and Baeza-Yates + + + + Method Nearest Neighbor from Andrew Moore's thesis. Numbered + comments are direct quotes from there. Step "SDL" is added to + make the algorithm work correctly. NearestNeighborList solution + courtesy of Bjoern Heckel. + + + + + + + + + + + + This method was written by Ted Dunsford by restructuring the nearest neighbor + algorithm presented by Andrew and Bjoern + + Since this is recursive, this represents the current node + The target is the HPoint that we are trying to calculate the farthest distance from + In this case, the hr is the hyper rectangle bounding the region that must contain the furthest point. + The maximum distance that we have calculated thus far, and will therefore be testing against. + The integer based level of that we have recursed to in the tree + The dimensionality of the kd tree + A list to contain the output, prioritized by distance + + + + Gets or sets whether this node has been _isDeleted + + + + + This is an adaptation of the Java KdTree library implemented by Levy + and Heckel. This simplified version is written by Marco A. Alvarez + + KdTree is a class supporting KD-tree insertion, deletion, equality + search, range search, and nearest neighbor(s) using double-precision + floating-point keys. Splitting dimension is chosen naively, by + depth modulo K. Semantics are as follows: + + Two different keys containing identical numbers should retrieve the + same value from a given KD-tree. Therefore keys are cloned when a + node is inserted. + + As with Hashtables, values inserted into a KD-tree are not + cloned. Modifying a value between insertion and retrieval will + therefore modify the value stored in the tree. + + + @author Simon Levy, Bjoern Heckel + Translation by Marco A. Alvarez + Adapted by Ted Dunsford to better suite the dot net framework by + changing comments to work in intellisense and extending some of the + basic objects to work more tightly with MapWindow. + + + + + Creates a new tree with the specified number of dimensions. + + An integer value specifying how many ordinates each key should have. + + + + Insert a node into the KD-tree. + + The array of double valued keys marking the position to insert this object into the tree + The object value to insert into the tree + if key.length mismatches the dimension of the tree (K) + if the key already exists in the tree + + Uses algorithm translated from 352.ins.c of + @Book{GonnetBaezaYates1991, + author = {G.H. Gonnet and R. Baeza-Yates}, + title = {Handbook of Algorithms and Data Structures}, + publisher = {Addison-Wesley}, + year = {1991} + + + + + Find the KD-tree node whose key is identical to the specified key. + This uses the algorithm translated from 352.srch.c of Connet and Baeza-Yates. + + The key identifying the node to search for + An object that is the node with a matching key, or null if no key was found. + if key.length mismatches the dimension of the tree (K) + + + + Deletes a node from the KD-tree. Instead of actually deleting the node and + rebuilding the tree, it marks the node as deleted. Hence, it is up to the + caller to rebuild the tree as needed for efficiency. + + The key to use to identify the node to delete + if key.length mismatches the dimension of the tree (K) + if the key was not found in the tree + + + + Find KD-tree node whose key is nearest neighbor to key. + Implements the Nearest Neighbor algorithm (Table 6.4) of + + key for KD-tree node + object at node nearest to key, or null on failure + if key.length mismatches the dimensions of the tree (K) + + @techreport{AndrewMooreNearestNeighbor, + author = {Andrew Moore}, + title = {An introductory tutorial on kd-trees}, + institution = {Robotics Institute, Carnegie Mellon University}, + year = {1991}, + number = {Technical Report No. 209, Computer Laboratory, + University of Cambridge}, + address = {Pittsburgh, PA} + + + + + Find KD-tree nodes whose keys are n nearest neighbors to + key. Uses algorithm above. Neighbors are returned in ascending + order of distance to key. + + key for KD-tree node + The Integer showing how many neighbors to find + An array of objects at the node nearest to the key + Mismatch if key length doesn't match the dimension for the tree + if n is negative or exceeds tree size + + + + Reverses the conventional nearest neighbor in order to obtain the furthest neighbor instead. + + The key for the KD-tree node + The object that corresponds to the furthest object + + + + Find KD-tree nodes whose keys are n farthest neighbors from + key. Neighbors are returned in descending order of distance to key. + + key for KD-tree node + The Integer showing how many neighbors to find + An array of objects at the node nearest to the key + Mismatch if key length doesn't match the dimension for the tree + if n is negative or exceeds tree size + + + + Search a range in the KD-tree. + + The lower bound in all ordinates for keys + Teh upper bound in all ordinates for keys + An array of objects whose keys fall in range [lowk, uppk] + Range search in a KD-tree. Uses algorithm translated from 352.range.c of Gonnet and Baeza-Yates. + Mismatch of the specified parameters compared with the tree or each other. + + + + Converts the value to a string + + A string + + + + Gets the number of members in this tree. + + + + + Gets the actual number of dimensions for this tree. + + + + + KeyDuplicateException is thrown when the KdTree.insert method + is invoked on a key already in the KdTree. + + @author Simon Levy + Translation by Marco A. Alvarez + + + + + KeyDuplicateException + + + + + Key-size mismatch exception supporting KdTree class + + @author Simon Levy + Translation by Marco A. Alvarez + + + + + KeyMissing Exception + + + + + KeySizeException is thrown when a KdTree method is invoked on a + key whose size (array length) mismatches the one used in the that + KdTree's constructor. + + @author Simon Levy + Translation by Marco A. Alvarez + + + + + KeySizeException + + + + + Bjoern Heckel's solution to the KD-Tree n-nearest-neighbor problem + + + + + Indicates whether removal should occur from the highest value or lowest value + + + + + + + + + + Creates a new NearestNeighborList + + An integer indicating the maximum size for the cue + + + + Inserts an item with a given priority + + + + + + + + Removes the highest member from the cue and returns that object. + + + + + + Gets the maximum priority + + + + + + Gets whether or not the length fo the cue has reached the capacity + + + + + Gets the highest object in the nearest neighbor list + + + + + + Gets a boolean indicating whether or not the cue is empty + + + + + + Gets the length of the current list + + + + + NeighborsOutOfRangeException + + + + + Creates a new NeighborsOutOfRangeException + + + + + This class implements a PriorityQueue. This class + is implemented in such a way that objects are added using an + add function. The add function takes + two parameters an object and a long. + + The object represents an item in the queue, the long indicates + its priority in the queue. The remove function in this class + returns the object first in the queue and that object is removed + from the queue permanently. + + @author Simon Levy + Translation by Marco A. Alvarez + + + + The maximum priority possible in this priority queue. + + + Holds the number of elements currently in the queue. + + + This contains the list of objects in the queue. + + + This contains the list of prioritys in the queue. + + + Creates a new PriorityQueue object. The + PriorityQueue object allows objects to be + entered into the queue and to leave in the order of + priority i.e the highest priority get's to leave first. + + + Creates a new PriorityQueue object. The + PriorityQueue object allows objects to + be entered into the queue an to leave in the order of + priority i.e the highest priority get's to leave first. + + @param capacity the initial capacity of the queue before + a resize + + + Creates a new PriorityQueue object. The + PriorityQueue object allows objects to + be entered into the queue an to leave in the order of + priority i.e the highest priority get's to leave first. + + @param capacity the initial capacity of the queue before + a resize + @param maxPriority is the maximum possible priority for + an object + + + This is an initializer for the object. It basically initializes + an array of long called value to represent the prioritys of + the objects, it also creates an array of objects to be used + in parallel with the array of longs, to represent the objects + entered, these can be used to sequence the data. + + @param size the initial capacity of the queue, it can be + resized + + + This function adds the given object into the PriorityQueue, + its priority is the long priority. The way in which priority can be + associated with the elements of the queue is by keeping the priority + and the elements array entrys parallel. + + @param element is the object that is to be entered into this + PriorityQueue + @param priority this is the priority that the object holds in the + PriorityQueue + + + Remove is a function to remove the element in the queue with the + maximum priority. Once the element is removed then it can never be + recovered from the queue with further calls. The lowest priority + object will leave last. + + @return the object with the highest priority or if it's empty + null + + + Bubble down is used to put the element at subscript 'pos' into + it's rightful place in the heap (i.e heap is another name + for PriorityQueue). If the priority of an element + at subscript 'pos' is less than it's children then it must + be put under one of these children, i.e the ones with the + maximum priority must come first. + + @param pos is the position within the arrays of the element + and priority + + + Bubble up is used to place an element relatively low in the + queue to it's rightful place higher in the queue, but only + if it's priority allows it to do so, similar to bubbleDown + only in the other direction this swaps out its parents. + + @param pos the position in the arrays of the object + to be bubbled up + + + This ensures that there is enough space to keep adding elements + to the priority queue. It is however advised to make the capacity + of the queue large enough so that this will not be used as it is + an expensive method. This will copy across from 0 as 'off' equals + 0 is contains some important data. + + + This method will empty the queue. This also helps garbage + collection by releasing any reference it has to the elements + in the queue. This starts from offset 1 as off equals 0 + for the elements array. + + + The number of elements in the queue. The length + indicates the number of elements that are currently + in the queue. + + @return the number of elements in the queue + + + + DoubleBits manipulates Double numbers + by using bit manipulation and bit-field extraction. + For some operations (such as determining the exponent) + this is more accurate than using mathematical operations + (which suffer from round-off error). + The algorithms and constants in this class + apply only to IEEE-754 double-precision floating point format. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + This computes the number of common most-significant bits in the mantissa. + It does not count the hidden bit, which is always 1. + It does not determine whether the numbers have the same exponent - if they do + not, the value computed by this function is meaningless. + + + The number of common most-significant mantissa bits. + + + + A representation of the Double bits formatted for easy readability. + + + + + + + + + + Determines the exponent for the number. + + + + + Determines the exponent for the number. + + + + + Provides a test for whether an interval is + so small it should be considered as zero for the purposes of + inserting it into a binary tree. + The reason this check is necessary is that round-off error can + cause the algorithm used to subdivide an interval to fail, by + computing a midpoint value which does not lie strictly between the + endpoints. + + + + + This value is chosen to be a few powers of 2 less than the + number of bits available in the double representation (i.e. 53). + This should allow enough extra precision for simple computations to be correct, + at least for comparison purposes. + + + + + Computes whether the interval [min, max] is effectively zero width. + I.e. the width of the interval is so much less than the + location of the interval that the midpoint of the interval cannot be + represented precisely. + + + + + A Key is a unique identifier for a node in a quadtree. + It contains a lower-left point and a level number. The level number + is the power of two for the size of the node envelope. + + + + + + + + + + + + + + + + + + Return a square envelope containing the argument envelope, + whose extent is a power of two and which is based at a power of 2. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Represents a node of a Quadtree. Nodes contain + items which have a spatial extent corresponding to the node's position + in the quadtree. + + + + + The base class for nodes in a Quadtree. + + + + + subquads are numbered as follows: + 2 | 3 + --+-- + 0 | 1 + + + + + Adds a new item to this node. + + The item to add to this node + + + + Insert items in this into the parameter! + + IList for adding items. + Parameter IList with this items. + + + + + + + + + + + Removes a single item from this subtree. + + The envelope containing the item. + The item to remove. + true if the item was found and removed. + + + + + + + + + + + + + + + + + + + + + + + + Returns the index of the subquad that wholly contains the given envelope. + If none does, returns -1. + + + + + + + Because more than one item can be stored in each node, this returns the total count of + items contained by this node and its child nodes. + + + + + Gets an integer representing how deem the deepest child of this node extends. + + + + + Gets or sets the array of 4 nodes represnting the spatial quadrants being used as children + 2 | 3 + --+-- + 0 | 1 + + + + + Gets a boolean indicating whehter or not this node links to any nodes below it in the tree + + + + + Each node can store multiple items. This tests whether or not there are items in this node. + + + + + If this node has no childern or items, then it can be pruned + + + + + If this node has an item, or if any of the children of this node has an item, then this is false. + + + + + Gets or sets the list of items that are stored in this node + + + + + Gets an integer representing this node and the count of all of the children in its subnodes + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Returns the subquad containing the envelope. + Creates the subquad if + it does not already exist. + + + + + + Returns the smallest existing + node containing the envelope. + + + + + + + + + + + + Get the subquad for the index. + If it doesn't exist, create it. + + + + + + + + + + + + + + + + + + A Quadtree is a spatial index structure for efficient querying + of 2D rectangles. If other kinds of spatial objects + need to be indexed they can be represented by their + envelopes + The quadtree structure is used to provide a primary filter + for range rectangle queries. The Query() method returns a list of + all objects which may intersect the query rectangle. Notice that + it may return objects which do not in fact intersect. + A secondary filter is required to test for exact intersection. + Of course, this secondary filter may consist of other tests besides + intersection, such as testing other kinds of spatial relationships. + This implementation does not require specifying the extent of the inserted + items beforehand. It will automatically expand to accomodate any extent + of dataset. + This data structure is also known as an MX-CIF quadtree + following the usage of Samet and others. + + + + + Root of Quadtree + + + + + minExtent is the minimum envelope extent of all items + inserted into the tree so far. It is used as a heuristic value + to construct non-zero envelopes for features with zero X and/or Y extent. + Start with a non-zero extent, in case the first feature inserted has + a zero extent in both directions. This value may be non-optimal, but + only one feature will be inserted with this value. + + + + + Constructs a Quadtree with zero items. + + + + + + + + + + + + Removes a single item from the tree. + + The Envelope of the item to remove. + The item to remove. + true if the item was found. + + + + + + + + + + + + + + + + + + Ensure that the envelope for the inserted item has non-zero extents. + Use the current minExtent to pad the envelope, if necessary. + + + + + + + Return a list of all items in the Quadtree. + + + + + + + + + + + Returns the number of levels in the tree. + + + + + Returns the number of items in the tree. + + + + + QuadRoot is the root of a single Quadtree. + It is centred at the origin, + and does not have a defined extent. + + + + + Insert an item into the quadtree this is the root of. + + + + + Insert an item which is known to be contained in the tree rooted at + the given QuadNode root. Lower levels of the tree will be created + if necessary to hold the item. + + + + + + + + + + + + A node of the STR tree. The children of this node are either more nodes + (AbstractNodes) or real data (ItemBoundables). If this node contains real data + (rather than nodes), then we say that this node is a "leaf node". + + + + + A spatial object in an AbstractSTRtree. + + + + + Returns a representation of space that encloses this Boundable, preferably + not much bigger than this Boundable's boundary yet fast to test for intersection + with the bounds of other Boundables. The class of object returned depends + on the subclass of AbstractSTRtree. + + + An Envelope (for STRtrees), an Interval (for SIRtrees), or other object + (for other subclasses of AbstractSTRtree). + + + + + Constructs an AbstractNode at the given level in the tree + + + 0 if this node is a leaf, 1 if a parent of a leaf, and so on; the + root node will have the highest level. + + + + + Returns a representation of space that encloses this Boundable, + preferably not much bigger than this Boundable's boundary yet fast to + test for intersection with the bounds of other Boundables. The class of + object returned depends on the subclass of AbstractSTRtree. + + + An Envelope (for STRtrees), an Interval (for SIRtrees), or other + object (for other subclasses of AbstractSTRtree). + + + + + Adds either an AbstractNode, or if this is a leaf node, a data object + (wrapped in an ItemBoundable). + + + + + + Returns either child AbstractNodes, or if this is a leaf node, real data (wrapped + in ItemBoundables). + + + + + Returns 0 if this node is a leaf, 1 if a parent of a leaf, and so on; the + root node will have the highest level. + + + + + Returns object fromComputeBounds() + + + + + Base class for STRtree and SIRtree. STR-packed R-trees are described in: + P. Rigaux, Michel Scholl and Agnes Voisard. Spatial Databases With + Application To GIS. Morgan Kaufmann, San Francisco, 2002. + + This implementation is based on Boundables rather than just AbstractNodes, + because the STR algorithm operates on both nodes and + data, both of which are treated here as Boundables. + + + + + + Constructs an AbstractSTRtree with the specified maximum number of child + nodes that a node may have. + + + + + + Creates parent nodes, grandparent nodes, and so forth up to the root + node, for the data that has been inserted into the tree. Can only be + called once, and thus can be called only after all of the data has been + inserted into the tree. + + + + + + + + + + + + Sorts the childBoundables then divides them into groups of size M, where + M is the node capacity. + + + + + + + + + + + + + + + + + + + + + + Creates the levels higher than the given level. + + The level to build on. + the level of the Boundables, or -1 if the boundables are item + boundables (that is, below level 0). + The root, which may be a ParentNode or a LeafNode. + + + + + + + + + + + + + + + + + + + + + + + + + Also builds the tree, if necessary. + + + + + + Also builds the tree, if necessary. + + + + + + + + + + + + + + + + + + + + + + + Also builds the tree, if necessary. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + -1 to get items. + + + + + + + + + + + + + + + + + Returns the maximum number of child nodes that a node may have. + + + + + + + + + + + + + + + A test for intersection between two bounds, necessary because subclasses + of AbstractSTRtree have different implementations of bounds. + + + + + A test for intersection between two bounds, necessary because subclasses + of AbstractSTRtree have different implementations of bounds. + + + + + For STRtrees, the bounds will be Envelopes; + for SIRtrees, Intervals; + for other subclasses of AbstractSTRtree, some other class. + + The bounds of one spatial object. + The bounds of another spatial object. + Whether the two bounds intersect. + + + + A contiguous portion of 1D-space. Used internally by SIRtree. + + + + + + + + + + + + + + + + + + + + + this + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Boundable wrapper for a non-Boundable spatial object. Used internally by + AbstractSTRtree. + + + + + + + + + + + + + + + + + + + + + + One-dimensional version of an STR-packed R-tree. SIR stands for + "Sort-Interval-Recursive". STR-packed R-trees are described in: + P. Rigaux, Michel Scholl and Agnes Voisard. Spatial Databases With + Application To GIS. Morgan Kaufmann, San Francisco, 2002. + + + + + Constructs an SIRtree with the default (10) node capacity. + + + + + Constructs an SIRtree with the given maximum number of child nodes that + a node may have. + + + + + + + + + + + + Inserts an item having the given bounds into the tree. + + + + + + + + Returns items whose bounds intersect the given value. + + + + + + Returns items whose bounds intersect the given bounds. + + Possibly equal to x2. + Possibly equal to x1. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + A query-only R-tree created using the Sort-Tile-Recursive (STR) algorithm. + For two-dimensional spatial data. + The STR packed R-tree is simple to implement and maximizes space + utilization; that is, as many leaves as possible are filled to capacity. + Overlap between nodes is far less than in a basic R-tree. However, once the + tree has been built (explicitly or on the first call to #query), items may + not be added or removed. + Described in: P. Rigaux, Michel Scholl and Agnes Voisard. Spatial Databases With + Application To GIS. Morgan Kaufmann, San Francisco, 2002. + + + + + Constructs an STRtree with the default (10) node capacity. + + + + + Constructs an STRtree with the given maximum number of child nodes that + a node may have. + + + + + Inserts an item having the given bounds into the tree. + + + + + + + Returns items whose bounds intersect the given envelope. + + + + + + Returns items whose bounds intersect the given envelope. + + + + + + + Removes a single item from the tree. + + The Envelope of the item to remove. + The item to remove. + true if the item was found. + + + + + + + + + + + + + + + + + + + + + + + + + + Creates the parent level for the given child level. First, orders the items + by the x-values of the midpoints, and groups them into vertical slices. + For each slice, orders the items by the y-values of the midpoints, and + group them into runs of size M (the node capacity). For each run, creates + a new (parent) node. + + + + + + + + + + + + + + + + + + + + + + + + + Must be sorted by the x-value of the envelope midpoints. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ProjectionEvents are ordered first by their x-value, and then by their eventType. + It is important that Insert events are sorted before Delete events, so that + items whose Insert and Delete events occur at the same x-value will be + correctly handled. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + A sweepline implements a sorted index on a set of intervals. + It is used to compute all overlaps between the interval in the index. + + + + + + + + + + + Because Delete Events have a link to their corresponding Insert event, + it is possible to compute exactly the range of events which must be + compared to a given Insert event object. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + NegativeInvalidException + + + + + This creates a new instance of an exception that occurs if a negative value was passed as an argument and this is invalid + + The name of the parameter that was negative + + + + Computes all intersections between segments in a set of s. + Intersections found are represented as s and added to the + s in which they occur. + As a final step in the noding a new set of segment strings split at the nodes may be returned. + + + + + Computes the noding for a collection of s. + Some Noders may add all these nodes to the input s; + others may only add some or none at all. + + + + + + Returns a of fully noded s. + The s have the same context as their parent. + + + + + + Computes the intersections between two line segments in s + and adds them to each string. + The is passed to a . + The method is called whenever the + detects that two s might intersect. + This class is an example of the Strategy pattern. + + + + + Computes the intersections between two line segments in s + and adds them to each string. + The is passed to a . + The method is called whenever the + detects that two s might intersect. + This class is an example of the Strategy pattern. + + + + + This method is called by clients + of the interface to process + intersections for two segments of the s being intersected. + + + + + + + + These variables keep track of what types of intersections were + found during ALL edges that have been intersected. + + + + + + + + + Initializes a new instance of the class. + + + + + + This method is called by clients + of the class to process + intersections for two segments of the being intersected. + Notice that some clients (such as s) may optimize away + this call for segment pairs which they have determined do not intersect + (e.g. by an disjoint envelope test). + + + + + + + + + + + + + + + + + A trivial intersection is an apparent self-intersection which in fact + is simply the point shared by adjacent line segments. + Notice that closed edges require a special check for the point shared by the beginning and end segments. + + + + + + + + + + + + + + + + + + + + A proper intersection is an intersection which is interior to at least two + line segments. Notice that a proper intersection is not necessarily + in the interior of the entire , since another edge may have + an endpoint equal to the intersection, which according to SFS semantics + can result in the point being on the Boundary of the . + + + + + A proper interior intersection is a proper intersection which is not + contained in the set of boundary nodes set for this . + + + + + An interior intersection is an intersection which is + in the interior of some segment. + + + + + Finds proper and interior intersections in a set of s, + and adds them as nodes. + + + + + Creates an intersection finder which finds all proper intersections. + + The to use. + + + + This method is called by clients + of the class to process + intersections for two segments of the s being intersected. + Notice that some clients (such as s) may optimize away + this call for segment pairs which they have determined do not intersect + (e.g. by an disjoint envelope test). + + + + + + + + + + + + + + A InvalidOctantException Class + + + + + Creates a new instance of InvalidOctantException + + + + + Nodes a set of s completely. + The set of s is fully noded; + i.e. noding is repeated until no further intersections are detected. + + Iterated noding using a precision model is not guaranteed to converge, + due to roundoff error. This problem is detected and an exception is thrown. + Clients can choose to rerun the noding using a lower precision model. + + + + + + + + + + + Initializes a new instance of the class. + + + + + + Returns a of fully noded s. + The s have the same context as their parent. + + + + + + Fully nodes a list of s, i.e. peforms noding iteratively + until no intersections are found between segments. + Maintains labelling of edges correctly through the noding. + + A collection of SegmentStrings to be noded. + If the iterated noding fails to converge. + + + + Node the input segment strings once + and create the split edges between the nodes. + + + + + + + Gets/Sets the maximum number of noding iterations performed before + the noding is aborted. Experience suggests that this should rarely need to be changed + from the default. The default is . + + + + + Nodes a set of s using a index based + on s and a . + The used should be something that supports + envelope (range) queries efficiently (such as a + or . + + + + + Base class for s which make a single pass to find intersections. + This allows using a custom + (which for instance may simply identify intersections, rather than insert them). + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The to use. + + + + Computes the noding for a collection of s. + Some Noders may add all these nodes to the input s; + others may only add some or none at all. + + + + + + Returns a of fully noded s. + The s have the same context as their parent. + + + + + + Gets/sets the to use with this noder. + A will normally add intersection nodes + to the input segment strings, but it may not - it may + simply record the presence of intersections. + However, some s may require that intersections be added. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The to use. + + + + Returns a of fully noded s. + The s have the same context as their parent. + + + + + + Computes the noding for a collection of s. + Some Noders may add all these nodes to the input s; + others may only add some or none at all. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class. + + The + + + + + + + + + + + + + Validates that a collection of s is correctly noded. + Throws an appropriate exception if an noding error is found. + + + + + Initializes a new instance of the class. + + The seg strings. + + + + + + + + + Checks if a segment string contains a segment pattern a-b-a (which implies a self-intersection). + + + + + + + + + + + + + + + + + + + Checks all pairs of segments for intersections at an interior point of a segment. + + + + + + + + + + + + + + + + + + + + + + + + + + true if there is an intersection point which is not an endpoint of the segment p0-p1. + + + + Checks for intersections between an endpoint of a segment string + and an interior vertex of another segment string + + + + + + + + + + + + Octants in the Cartesian plane. + Octants are numbered as follows: + + \2|1/ + 3 \|/ 0 + ---+-- + 4 /|\ 7 + /5|6\ + + If line segments lie along a coordinate axis, the octant is the lower of the two possible values. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Methods for computing and working with of the Cartesian plane. + + + + + Returns the octant of a directed line segment (specified as x and y + displacements, which cannot both be 0). + + + + + + + + Returns the octant of a directed line segment from p0 to p1. + + + + + + + + Allows comparing arrays in an orientation-independent way. + + + + + Creates a new } + for the given array. + + + + + + Compares two s for their relative order. + + + + -1 this one is smaller, or + 0 the two objects are equal, or + 1 this one is greater. + + + + + Computes the canonical orientation for a coordinate array. + + + + true if the points are oriented forwards, or + falseif the points are oriented in reverse. + + + + + Wraps a and transforms its input into the integer domain. + This is intended for use with Snap-Rounding noders, + which typically are only intended to work in the integer domain. + Offsets can be provided to increase the number of digits of available precision. + + + + + Initializes a new instance of the class. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Represents an intersection point between two s. + + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + + + + + + + + -1 this SegmentNode is located before the argument location, or + 0 this SegmentNode is at the argument location, or + 1 this SegmentNode is located after the argument location. + + + + + + + + + + + + + + + + + + + + + + + + A list of the s present along a noded . + + + + + Initializes a new instance of the class. + + The edge. + + + + Returns an iterator of SegmentNodes. + + An iterator of SegmentNodes. + + + + Adds an intersection into the list, if it isn't already there. + The input segmentIndex and dist are expected to be normalized. + + + + + + + Adds nodes for the first and last points of the edge. + + + + + Adds nodes for any collapsed edge pairs. + Collapsed edge pairs can be caused by inserted nodes, or they can be + pre-existing in the edge vertex list. + In order to provide the correct fully noded semantics, + the vertex at the base of a collapsed pair must also be added as a node. + + + + + Adds nodes for any collapsed edge pairs + which are pre-existing in the vertex list. + + + + + + Adds nodes for any collapsed edge pairs caused by inserted nodes + Collapsed edge pairs occur when the same coordinate is inserted as a node + both before and after an existing edge vertex. + To provide the correct fully noded semantics, + the vertex must be added as a node as well. + + + + + + + + + + + + + + + Creates new edges for all the edges that the intersections in this + list split the parent edge into. + Adds the edges to the provided argument list + (this is so a single list can be used to accumulate all split edges + for a set of s). + + + + + + Create a new "split edge" with the section of points between + (and including) the two intersections. + The label for the new edge is the same as the label for the parent edge. + + + + + + + + + + + + + + + + + + + + INCOMPLETE!!! + + + + + Consente di spostare l'enumeratore all'elemento successivo dell'insieme. + + + true se l'enumeratore è stato spostato correttamente in avanti in corrispondenza dell'elemento successivo; false se l'enumeratore ha raggiunto la fine dell'insieme. + + L'insieme è stato modificato dopo la creazione dell'enumeratore. + + + + Imposta l'enumeratore sulla propria posizione iniziale, ovvero prima del primo elemento nell'insieme. + + L'insieme è stato modificato dopo la creazione dell'enumeratore. + + + + Not implemented. + + This method is not implemented. + + + + Ottiene l'elemento corrente dell'insieme. + + + Elemento corrente nell'insieme. + L'enumeratore è posizionato prima del primo elemento o dopo l'ultimo elemento dell'insieme. + + + + Implements a robust method of comparing the relative position of two points along the same segment. + The coordinates are assumed to lie "near" the segment. + This means that this algorithm will only return correct results + if the input coordinates have the same precision and correspond to rounded values + of exact coordinates lying on the segment. + + + + + Compares two s for their relative position along a segment + lying in the specified . + + + + + + -1 if node0 occurs first, or + 0 if the two nodes are equal, or + 1 if node1 occurs first. + + + + + + + + + + + + + + + + + + + + + Represents a list of contiguous line segments, and supports noding the segments. + The line segments are represented by an array of s. + Intended to optimize the noding of contiguous segments by + reducing the number of allocated objects. + s can carry a context object, which is useful + for preserving topological or parentage information. + All noded substrings are initialized with the same context object. + + + + + + + + + + + + + + + + + + + Creates a new segment string from a list of vertices. + + The vertices of the segment string. + The user-defined data of this segment string (may be null). + + + + + + + + + + + Gets the octant of the segment starting at vertex index. + + + The index of the vertex starting the segment. + Must not be the last index in the vertex list + + The octant of the segment at the vertex + + + + Adds EdgeIntersections for one or both + intersections found for a segment of an edge to the edge intersection list. + + + + + + + Add an for intersection intIndex. + An intersection that falls exactly on a vertex + of the is normalized + to use the higher of the two possible segmentIndexes. + + + + + + + + + + + + + + + Gets/Sets the user-defined data for this segment string. + + + + + + + + + + + + + + + + + + + + + + + + + + Dissolves a noded collection of s to produce + a set of merged linework with unique segments. + A custom merging strategy can be applied when two identical (up to orientation) + strings are dissolved together. + The default merging strategy is simply to discard the merged string. + + A common use for this class is to merge noded edges + while preserving topological labelling. + + + + + + Creates a dissolver with a user-defined merge strategy. + + + + + + Creates a dissolver with the default merging strategy. + + + + + Dissolve all s in the input . + + + + + + + + + + + + + Dissolve the given . + + + + + + + + + + + + + Gets the collection of dissolved (i.e. unique) s + + + + + + + + + + Updates the context data of a + when an identical (up to orientation) one is found during dissolving. + + The segment string to update. + The segment string being dissolved. + + true if the strings are in the same direction, + false if they are opposite. + + + + + Nodes a set of s by + performing a brute-force comparison of every segment to every other one. + This has n^2 performance, so is too slow for use on large numbers of segments. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + + + + + Returns a of fully noded s. + The s have the same context as their parent. + + + + + + Computes the noding for a collection of s. + Some Noders may add all these nodes to the input s; + others may only add some or none at all. + + + + + + + + + + + + + Implements a "hot pixel" as used in the Snap Rounding algorithm. + A hot pixel contains the interior of the tolerance square and the boundary + minus the top and right segments. + The hot pixel operations are all computed in the integer domain + to avoid rounding problems. + + + + + Initializes a new instance of the class. + + + + + + + + Returns a "safe" envelope that is guaranteed to contain the hot pixel. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Tests whether the segment p0-p1 intersects the hot pixel tolerance square. + Because the tolerance square point set is partially open (along the + top and right) the test needs to be more sophisticated than + simply checking for any intersection. However, it + can take advantage of the fact that because the hot pixel edges + do not lie on the coordinate grid. It is sufficient to check + if there is at least one of: + - a proper intersection with the segment and any hot pixel edge. + - an intersection between the segment and both the left and bottom edges. + - an intersection between a segment endpoint and the hot pixel coordinate. + + + + + + + + + + + + + "Snaps" all s in a containing + s to a given . + + + + + Initializes a new instance of the class. + + + + + + Snaps (nodes) all interacting segments to this hot pixel. + The hot pixel may represent a vertex of an edge, + in which case this routine uses the optimization + of not noding the vertex itself + + The hot pixel to snap to. + The edge containing the vertex, if applicable, or null. + + true if a node was added for this pixel. + + + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Uses Snap Rounding to compute a rounded, + fully noded arrangement from a set of {@link SegmentString}s. + Implements the Snap Rounding technique described in Hobby, Guibas and Marimont, and Goodrich et al. + Snap Rounding assumes that all vertices lie on a uniform grid + (hence the precision model of the input must be fixed precision, + and all the input vertices must be rounded to that precision). + + This implementation uses a monotone chains and a spatial index to + speed up the intersection tests. + This implementation appears to be fully robust using an integer precision model. + It will function with non-integer precision models, but the + results are not 100% guaranteed to be correctly noded. + + + + + + Initializes a new instance of the class. + + The to use. + + + + Returns a of fully noded s. + The s have the same context as their parent. + + + + + + Computes the noding for a collection of s. + Some Noders may add all these nodes to the input s; + others may only add some or none at all. + + + + + + + + + + + + + Computes all interior intersections in the collection of s, + and returns their s. + + Does NOT node the segStrings. + + + + A list of Coordinates for the intersections. + + + + Computes nodes introduced as a result of snapping segments to snap points (hot pixels). + + + + + + Computes nodes introduced as a result of + snapping segments to vertices of other segments. + + + + + + Performs a brute-force comparison of every segment in each . + This has n^2 performance. + + + + + + Uses Snap Rounding to compute a rounded, + fully noded arrangement from a set of s. + Implements the Snap Rounding technique described in Hobby, Guibas and Marimont, and Goodrich et al. + Snap Rounding assumes that all vertices lie on a uniform grid + (hence the precision model of the input must be fixed precision, + and all the input vertices must be rounded to that precision). + + This implementation uses simple iteration over the line segments. + This implementation appears to be fully robust using an integer precision model. + It will function with non-integer precision models, but the + results are not 100% guaranteed to be correctly noded. + + + + + + Initializes a new instance of the class. + + The to use. + + + + Returns a of fully noded s. + The s have the same context as their parent. + + + + + + Computes the noding for a collection of s. + Some Noders may add all these nodes to the input s; + others may only add some or none at all. + + + + + + + + + + + + + Computes all interior intersections in the collection of s, + and returns their s. + Does NOT node the segStrings. + + + + A list of s for the intersections. + + + + Computes nodes introduced as a result of snapping segments to snap points (hot pixels). + + + + + + + + + + + + + + Computes nodes introduced as a result of + snapping segments to vertices of other segments. + + + + + + Performs a brute-force comparison of every segment in each . + This has n^2 performance. + + + + + + + Adds a new node (equal to the snap pt) to the segment + if the segment passes through the hot pixel. + + + + + + + + + Builds the buffer point for a given input point and precision model. + Allows setting the level of approximation for circular arcs, + and the precision model in which to carry out the computation. + When computing buffers in floating point double-precision + it can happen that the process of iterated noding can fail to converge (terminate). + In this case a TopologyException will be thrown. + Retrying the computation in a fixed precision + can produce more robust results. + + + + + Compute the change in depth as an edge is crossed from R to L. + + + + + + + + + + + + + + + + + + + + + + + + + + + + Inserted edges are checked to see if an identical edge already exists. + If so, the edge is not inserted, but its label is merged + with the existing edge. + + + + + + Completes the building of the input subgraphs by depth-labelling them, + and adds them to the . + The subgraph list must be sorted in rightmost-coordinate order. + + The subgraphs to build. + The PolygonBuilder which will build the final polygons. + + + + Gets/Sets the number of segments used to approximate a angle fillet. + + + + + Gets/Sets the precision model to use during the curve computation and noding, + if it is different to the precision model of the Geometry. + If the precision model is less than the precision of the Geometry precision model, + the Geometry must have previously been rounded to that precision. + + + + + + + + + + Computes the buffer of a point, for both positive and negative buffer distances. + In GIS, the buffer of a point is defined as + the Minkowski sum or difference of the point + with a circle with radius equal to the absolute value of the buffer distance. + In the CAD/CAM world buffers are known as offset curves. + Since true buffer curves may contain circular arcs, + computed buffer polygons can only be approximations to the true point. + The user can control the accuracy of the curve approximation by specifying + the number of linear segments with which to approximate a curve. + The end cap endCapStyle of a linear buffer may be specified. The + following end cap styles are supported: + + {CAP_ROUND} - the usual round end caps + {CAP_BUTT} - end caps are truncated flat at the line ends + {CAP_SQUARE} - end caps are squared off at the buffer distance beyond the line ends + + The computation uses an algorithm involving iterated noding and precision reduction + to provide a high degree of robustness. + + + + + Initializes a buffer computation for the given point. + + The point to buffer. + + + + Compute a reasonable scale factor to limit the precision of + a given combination of Geometry and buffer distance. + The scale factor is based on a heuristic. + + The Geometry being buffered. + The buffer distance. + The mzx # of digits that should be allowed by + the precision determined by the computed scale factor. + A scale factor that allows a reasonable amount of precision for the buffer computation. + + + + Computes the buffer of a point for a given buffer distance. + + The point to buffer. + The buffer distance. + The buffer of the input point. + + + + Computes the buffer of a point for a given buffer distance, + using the given Cap Style for borders of the point. + + The point to buffer. + The buffer distance. + Cap Style to use for compute buffer. + The buffer of the input point. + + + + Computes the buffer for a point for a given buffer distance + and accuracy of approximation. + + The point to buffer. + The buffer distance. + The number of segments used to approximate a quarter circle. + The buffer of the input point. + + + + Computes the buffer for a point for a given buffer distance + and accuracy of approximation. + + The point to buffer. + The buffer distance. + The number of segments used to approximate a quarter circle. + Cap Style to use for compute buffer. + The buffer of the input point. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Specifies the end cap endCapStyle of the generated buffer. + The styles supported are CapRound, CapButt, and CapSquare. + The default is CapRound. + + + + + + + + + + A connected subset of the graph of + DirectedEdges and Nodes. + Its edges will generate either + a single polygon in the complete buffer, with zero or more holes, or + one or more connected holes. + + + + + + + + + + BufferSubgraphs are compared on the x-value of their rightmost Coordinate. + This defines a partial ordering on the graphs such that: + g1 >= g2 - Ring(g2) does not contain Ring(g1) + where Polygon(g) is the buffer polygon that is built from g. + This relationship is used to sort the BufferSubgraphs so that shells are guaranteed to + be built before holes. + + + + + Creates the subgraph consisting of all edges reachable from this node. + Finds the edges in the graph and the rightmost coordinate. + + A node to start the graph traversal from. + + + + Adds all nodes and edges reachable from this node to the subgraph. + Uses an explicit stack to avoid a large depth of recursion. + + A node known to be in the subgraph. + + + + Adds the argument node and all its out edges to the subgraph + + The node to add. + The current set of nodes being traversed. + + + + + + + + + + + + + + + Compute depths for all dirEdges via breadth-first traversal of nodes in graph. + + Edge to start processing with. + + + + + + + + + + + + + + + + Find all edges whose depths indicates that they are in the result area(s). + Since we want polygon shells to be + oriented CW, choose dirEdges with the interior of the result on the RHS. + Mark them as being in the result. + Interior Area edges are the result of dimensional collapses. + They do not form part of the result area boundary. + + + + + + + + + + + + + + + Gets the rightmost coordinate in the edges of the subgraph. + + + + + Computes the raw offset curve for a + single Geometry component (ring, line or point). + A raw offset curve line is not noded - + it may contain self-intersections (and usually will). + The final buffer polygon is computed by forming a topological graph + of all the noded raw curves and tracing outside contours. + The points in the raw curve are rounded to the required precision model. + + + + + The default number of facets into which to divide a fillet of 90 degrees. + A value of 8 gives less than 2% max error in the buffer distance. + For a max error smaller of 1%, use QS = 12 + + + + + + + + + + + + + + + + + + This method handles single points as well as lines. + Lines are assumed to not be closed (the function will not + fail for closed lines, but will generate superfluous line caps). + + + + A List of Coordinate[]. + + + + This method handles the degenerate cases of single points and lines, + as well as rings. + + A List of Coordinate[]. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Add last offset point. + + + + + Compute an offset segment for an input segment on a given side and at a given distance. + The offset points are computed in full double precision, for accuracy. + + The segment to offset. + The side of the segment the offset lies on. + The offset distance. + The points computed for the offset segment. + + + + Add an end cap around point p1, terminating a line segment coming from p0. + + + + + + + Base point of curve. + Start point of fillet curve. + Endpoint of fillet curve. + + + + + + Adds points for a fillet. The start and end point for the fillet are not added - + the caller must add them if required. + + + + + Is -1 for a CW angle, 1 for a CCW angle. + + + + + Adds a CW circle around a point. + + + + + + + Adds a CW square around a point + + + + + + + + + + + + + + + + + Creates all the raw offset curves for a buffer of a Geometry. + Raw curves need to be noded together and polygonized to form the final buffer area. + + + + + + + + + + + + + Computes the set of raw offset curves for the buffer. + Each offset curve has an attached {Label} indicating + its left and right location. + + A Collection of SegmentStrings representing the raw buffer curves. + + + + + + + + + + + + Creates a {SegmentString} for a coordinate list which is a raw offset curve, + and adds it to the list of buffer curves. + The SegmentString is tagged with a Label giving the topology of the curve. + The curve may be oriented in either direction. + If the curve is oriented CW, the locations will be: + Left: Location.Exterior. + Right: Location.Interior. + + + + + + + + + + + + + + + + + Add a Point to the graph. + + + + + + + + + + + + + + + + + + Add an offset curve for a ring. + The side and left and right topological location arguments + assume that the ring is oriented CW. + If the ring is in the opposite orientation, + the left and right locations must be interchanged and the side flipped. + + The coordinates of the ring (must not contain repeated points). + The distance at which to create the buffer. + The side of the ring on which to construct the buffer line. + The location on the L side of the ring (if it is CW). + The location on the R side of the ring (if it is CW). + + + + The ringCoord is assumed to contain no repeated points. + It may be degenerate (i.e. contain only 1, 2, or 3 points). + In this case it has no area, and hence has a minimum diameter of 0. + + + + + + + + Tests whether a triangular ring would be eroded completely by the given + buffer distance. + This is a precise test. It uses the fact that the inner buffer of a + triangle converges on the inCentre of the triangle (the point + equidistant from all sides). If the buffer distance is greater than the + distance of the inCentre from a side, the triangle will be eroded completely. + This test is important, since it removes a problematic case where + the buffer distance is slightly larger than the inCentre distance. + In this case the triangle buffer curve "inverts" with incorrect topology, + producing an incorrect hole in the buffer. + + + + + + + + A RightmostEdgeFinder find the DirectedEdge in a list which has the highest coordinate, + and which is oriented L to R at that point. (I.e. the right side is on the RHS of the edge.) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Locates a subgraph inside a set of subgraphs, + in order to determine the outside depth of the subgraph. + The input subgraphs are assumed to have had depths + already calculated for their edges. + + + + + + + + + + + + + + + + + + Finds all non-horizontal segments intersecting the stabbing line. + The stabbing line is the ray to the right of stabbingRayLeftPt. + + The left-hand origin of the stabbing line. + A List of {DepthSegments} intersecting the stabbing line. + + + + Finds all non-horizontal segments intersecting the stabbing line + in the list of dirEdges. + The stabbing line is the ray to the right of stabbingRayLeftPt. + + The left-hand origin of the stabbing line. + + The current list of DepthSegments intersecting the stabbing line. + + + + Finds all non-horizontal segments intersecting the stabbing line + in the input dirEdge. + The stabbing line is the ray to the right of stabbingRayLeftPt. + + The left-hand origin of the stabbing line. + + The current list of DepthSegments intersecting the stabbing line. + + + + A segment from a directed edge which has been assigned a depth value + for its sides. + + + + + + + + + + + + Defines a comparision operation on DepthSegments + which orders them left to right: + DS1 smaller DS2 if DS1.seg is left of DS2.seg. + DS1 bigger DS2 if DS1.seg is right of DS2.seg. + + + + + + + Compare two collinear segments for left-most ordering. + If segs are vertical, use vertical ordering for comparison. + If segs are equal, return 0. + Segments are assumed to be directed so that the second coordinate is >= to the first + (e.g. up and to the right). + + The left hand side segment to compare. + The riht hand side segment to compare. + An integer, -1 if seg0 is less, 0 if they are the same, and 1 if seg0 is greater. + + + + + + + + + A ConnectedElementPointFilter extracts a single point + from each connected element in a Geometry + (e.g. a polygon, linestring or point) + and returns them in a list. The elements of the list are + com.vividsolutions.jts.operation.distance.GeometryLocations. + + + + + + + + + + + + + + + + + Returns a list containing a point from each Polygon, LineString, and Point + found inside the specified point. Thus, if the specified point is + not a GeometryCollection, an empty list will be returned. The elements of the list + are com.vividsolutions.jts.operation.distance.GeometryLocations. + + + + + Extracts a single point + from each connected element in a Geometry + (e.g. a polygon, linestring or point) + and returns them in a list + + + + + + + + + + + + + + + + + Returns a list containing a Coordinate from each Polygon, LineString, and Point + found inside the specified point. Thus, if the specified point is + not a GeometryCollection, an empty list will be returned. + + + + + Computes the distance and + closest points between two Geometrys. + The distance computation finds a pair of points in the input geometries + which have minimum distance between them. These points may + not be vertices of the geometries, but may lie in the interior of + a line segment. In this case the coordinate computed is a close + approximation to the exact point. + The algorithms used are straightforward O(n^2) + comparisons. This worst-case performance could be improved on + by using Voronoi techniques. + + + + + Constructs a that computes the distance and closest points between + the two specified geometries. + + + + + + + Constructs a that computes the distance and closest points between + the two specified geometries. + + + + The distance on which to terminate the search. + + + + Compute the distance between the closest points of two geometries. + + A Geometry. + Another Geometry. + The distance between the geometries. + + + + Test whether two geometries lie within a given distance of each other. + + + + + + + + + Compute the the closest points of two geometries. + The points are presented in the same order as the input Geometries. + + A Geometry. + Another Geometry. + The closest points in the geometries. + + + + Report the distance between the closest points on the input geometries. + + The distance between the geometries. + + + + Report the coordinates of the closest points in the input geometries. + The points are presented in the same order as the input Geometries. + + A pair of Coordinates of the closest points. + + + + Report the locations of the closest points in the input geometries. + The locations are presented in the same order as the input Geometries. + + A pair of {GeometryLocation}s for the closest points. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Represents the location of a point on a Geometry. + Maintains both the actual point location (which of course + may not be exact) as well as information about the component + and segment index where the point occurs. + Locations inside area Geometrys will not have an associated segment index, + so in this case the segment index will have the sentinel value of InsideArea. + + + + + Special value of segment-index for locations inside area geometries. These + locations do not have an associated segment index. + + + + + Constructs a GeometryLocation specifying a point on a point, as well as the + segment that the point is on (or InsideArea if the point is not on a segment). + + + + + + + + Constructs a GeometryLocation specifying a point inside an area point. + + + + + Returns the point associated with this location. + + + + + Returns the segment index for this location. If the location is inside an + area, the index will have the value InsideArea; + + + + + Returns the location. + + + + + Returns whether this GeometryLocation represents a point inside an area point. + + + + + The base class for operations that require GeometryGraphs. + + + + + The operation args into an array so they can be accessed by index. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Tests whether a Geometry is simple. + Only Geometrys whose definition allows them + to be simple or non-simple are tested. (E.g. Polygons must be simple + by definition, so no test is provided. To test whether a given Polygon is valid, + use Geometry.IsValid) + + + + + + + + + + + + + + + + + + + A MultiPoint is simple if it has no repeated points. + + + + + + + + + + + + For all edges, check if there are any intersections which are NOT at an endpoint. + The Geometry is not simple if there are intersections not at endpoints. + + + + + + Test that no edge intersection is the + endpoint of a closed line. To check this we compute the + degree of each endpoint. The degree of endpoints of closed lines + must be exactly 2. + + + + + + Add an endpoint to the map, creating an entry for it if none exists. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + A sequence of LineMergeDirectedEdges forming one of the lines that will + be output by the line-merging process. + + + + + Constructs an EdgeString with the given factory used to convert this EdgeString + to a LineString. + + + + + + Adds a directed edge which is known to form part of this line. + + + + + + Converts this EdgeString into a LineString. + + + + + + + + + + A com.vividsolutions.jts.planargraph.DirectedEdge of a LineMergeGraph. + + + + + Represents a directed edge in a PlanarGraph. A DirectedEdge may or + may not have a reference to a parent Edge (some applications of + planar graphs may not require explicit Edge objects to be created). Usually + a client using a PlanarGraph will subclass DirectedEdge + to add its own application-specific data and methods. + + + + + The base class for all graph component classes. + Maintains flags of use in generic graph algorithms. + Provides two flags: + marked - typically this is used to indicate a state that persists + for the course of the graph's lifetime. For instance, it can be + used to indicate that a component has been logically deleted from the graph. + visited - this is used to indicate that a component has been processed + or visited by an single graph algorithm. For instance, a breadth-first traversal of the + graph might use this to indicate that a node has already been traversed. + The visited flag may be set and cleared many times during the lifetime of a graph. + + + + + Sets the state + for all s in an . + + A to scan. + The state to set the flag to. + + + + Sets the state + for all s in an . + + A to scan. + The state to set the flag to. + + + + Finds the first + in a set + which has the specified state. + + A to scan. + The state to test. + The first found, or null if none found. + + + + Tests if a component has been visited during the course of a graph algorithm. + + + + + Tests if a component has been marked at some point during the processing + involving this graph. + + + + + Tests whether this component has been removed from its containing graph. + + + + + Constructs a DirectedEdge connecting the from node to the + to node. + + + + + Specifies this DirectedEdge's direction (given by an imaginary + line from the from node to directionPt). + + + Whether this DirectedEdge's direction is the same as or + opposite to that of the parent Edge (if any). + + + + + Returns 1 if this DirectedEdge has a greater angle with the + positive x-axis than b", 0 if the DirectedEdges are collinear, and -1 otherwise. + Using the obvious algorithm of simply computing the angle is not robust, + since the angle calculation is susceptible to roundoff. A robust algorithm + is: + first compare the quadrants. If the quadrants are different, it it + trivial to determine which vector is "greater". + if the vectors lie in the same quadrant, the robust + RobustCgAlgorithms.ComputeOrientation(Coordinate, Coordinate, Coordinate) + function can be used to decide the relative orientation of the vectors. + + + + + + + Returns a List containing the parent Edge (possibly null) for each of the given + DirectedEdges. + + + + + + + Returns 1 if this DirectedEdge has a greater angle with the + positive x-axis than b", 0 if the DirectedEdges are collinear, and -1 otherwise. + Using the obvious algorithm of simply computing the angle is not robust, + since the angle calculation is susceptible to roundoff. A robust algorithm + is: + first compare the quadrants. If the quadrants are different, it it + trivial to determine which vector is "greater". + if the vectors lie in the same quadrant, the robust + RobustCgAlgorithms.ComputeOrientation(Coordinate, Coordinate, Coordinate) + function can be used to decide the relative orientation of the vectors. + + + + + + + Writes a detailed string representation of this DirectedEdge to the given PrintStream. + + + + + + Removes this directed edge from its containing graph. + + + + + + + + + + + Returns this DirectedEdge's parent Edge, or null if it has none. + Associates this DirectedEdge with an Edge (possibly null, indicating no associated + Edge). + + + + + Returns 0, 1, 2, or 3, indicating the quadrant in which this DirectedEdge's + orientation lies. + + + + + returns a point representing the starting point for a line being drawn + in order to indicate the directed edges vector direction. + + + + + Returns a point to which an imaginary line is drawn from the from-node to + specify this DirectedEdge's orientation. + + + + + Returns whether the direction of the parent Edge (if any) is the same as that + of this Directed Edge. + + + + + Returns the node from which this DirectedEdge leaves. + + + + + Returns the node to which this DirectedEdge goes. + + + + + Returns the coordinate of the from-node. + + + + + Returns the angle that the start of this DirectedEdge makes with the + positive x-axis, in radians. + + + + + Returns the symmetric DirectedEdge -- the other DirectedEdge associated with + this DirectedEdge's parent Edge. + Sets this DirectedEdge's symmetric DirectedEdge, which runs in the opposite + direction. + + + + + Tests whether this component has been removed from its containing graph. + + + + + + Constructs a LineMergeDirectedEdge connecting the from node to the to node. + + + + + specifies this DirectedEdge's direction (given by an imaginary + line from the from node to directionPt). + + + whether this DirectedEdge's direction is the same as or + opposite to that of the parent Edge (if any). + + + + + Returns the directed edge that starts at this directed edge's end point, or null + if there are zero or multiple directed edges starting there. + + + + + An edge of a LineMergeGraph. The marked field indicates + whether this Edge has been logically deleted from the graph. + + + + + Represents an undirected edge of a {PlanarGraph}. An undirected edge + in fact simply acts as a central point of reference for two opposite + DirectedEdges. + Usually a client using a PlanarGraph will subclass Edge + to add its own application-specific data and methods. + + + + + Constructs an Edge whose DirectedEdges are not yet set. Be sure to call + SetDirectedEdges(DirectedEdge, DirectedEdge). + + + + + Constructs an Edge initialized with the given DirectedEdges, and for each + DirectedEdge: sets the Edge, sets the symmetric DirectedEdge, and adds + this Edge to its from-Node. + + + + + + + Initializes this Edge's two DirectedEdges, and for each DirectedEdge: sets the + Edge, sets the symmetric DirectedEdge, and adds this Edge to its from-Node. + + + + + + + Returns one of the DirectedEdges associated with this Edge. + + 0 or 1. + + + + + Returns the DirectedEdge that starts from the given node, or null if the + node is not one of the two nodes associated with this Edge. + + + + + + + If node is one of the two nodes associated with this Edge, + returns the other node; otherwise returns null. + + + + + + + Removes this edge from its containing graph. + + + + + The two DirectedEdges associated with this Edge. + + + + + Tests whether this component has been removed from its containing graph. + + + + + + The line sequencer class seems to need to se this directly + + + + + Constructs a LineMergeEdge with vertices given by the specified LineString. + + + + + + Returns the LineString specifying the vertices of this edge. + + + + + A planar graph of edges that is analyzed to sew the edges together. The + marked flag on com.vividsolutions.planargraph.Edges + and com.vividsolutions.planargraph.Nodes indicates whether they have been + logically deleted from the graph. + + + + + Represents a directed graph which is embeddable in a planar surface. + This class and the other classes in this package serve as a framework for + building planar graphs for specific algorithms. This class must be + subclassed to expose appropriate methods to construct the graph. This allows + controlling the types of graph components ({DirectedEdge}s, + Edges and Nodes) which can be added to the graph. An + application which uses the graph framework will almost always provide + subclasses for one or more graph components, which hold application-specific + data and graph algorithms. + + + + + Returns the Node at the given location, or null if no Node was there. + + + + + + + Adds a node to the map, replacing any that is already at that location. + Only subclasses can add Nodes, to ensure Nodes are of the right type. + + + + + + Adds the Edge and its DirectedEdges with this PlanarGraph. + Assumes that the Edge has already been created with its associated DirectEdges. + Only subclasses can add Edges, to ensure the edges added are of the right class. + + + + + + Adds the Edge to this PlanarGraph; only subclasses can add DirectedEdges, + to ensure the edges added are of the right class. + + + + + + Returns an IEnumerator over the Nodes in this PlanarGraph. + + + + + + Returns an Iterator over the DirectedEdges in this PlanarGraph, in the order in which they + were added. + + + + + + Returns an Iterator over the Edges in this PlanarGraph, in the order in which they + were added. + + + + + + Removes an Edge and its associated DirectedEdges from their from-Nodes and + from this PlanarGraph. Notice: This method does not remove the Nodes associated + with the Edge, even if the removal of the Edge reduces the degree of a + Node to zero. + + + + + + Removes DirectedEdge from its from-Node and from this PlanarGraph. Notice: + This method does not remove the Nodes associated with the DirectedEdge, + even if the removal of the DirectedEdge reduces the degree of a Node to + zero. + + + + + + Removes a node from the graph, along with any associated DirectedEdges and + Edges. + + + + + + Returns all Nodes with the given number of Edges around it. + + + + + + + Gets or sets the IList of directed edges + + + + + Returns the Nodes in this PlanarGraph. + + + + + Returns the Edges that have been added to this PlanarGraph. + + + + + Adds an Edge, DirectedEdges, and Nodes for the given LineString representation + of an edge. + + + + + + + + + + + + Sews together a set of fully noded LineStrings. Sewing stops at nodes of degree 1 + or 3 or more -- the exception is an isolated loop, which only has degree-2 nodes, + in which case a node is simply chosen as a starting point. The direction of each + merged LineString will be that of the majority of the LineStrings from which it + was derived. + Any dimension of Geometry is handled -- the constituent linework is extracted to + form the edges. The edges must be correctly noded; that is, they must only meet + at their endpoints. The LineMerger will still run on incorrectly noded input + but will not form polygons from incorrected noded edges. + + + + + Adds a collection of Geometries to be processed. May be called multiple times. + Any dimension of Geometry may be added; the constituent linework will be + extracted. + + + + + + Adds a Geometry to be processed. May be called multiple times. + Any dimension of Geometry may be added; the constituent linework will be + extracted. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Returns the LineStrings built by the merging process. + + + + + + + + + + + + + + + + + + + + + + Nodes a set of edges. + Takes one or more sets of edges and constructs a + new set of edges consisting of all the split edges created by + noding the input edges together. + + + + + + + + + + + + + + + + + + + + + + Forms NTS LineStrings out of a the graph of DirectedEdges + created by an OverlayOp. + + + + + + + + + + + + + + + + + A list of the LineStrings in the result of the specified overlay operation. + + + + + Find and mark L edges which are "covered" by the result area (if any). + L edges at nodes which also have A edges can be checked by checking + their depth at that node. + L edges at nodes which do not have A edges can be checked by doing a + point-in-polygon test with the previously computed result areas. + + + + + + + + + + + + + + + + + + + Collect edges from Area inputs which should be in the result but + which have not been included in a result area. + This happens ONLY: + during an intersection when the boundaries of two + areas touch in a line segment + OR as a result of a dimensional collapse. + + + + + + + + + + + + + + + + + + + + Label an isolated node with its relationship to the target point. + + + + + + + A ring of edges which may contain nodes of degree > 2. + A MaximalEdgeRing may represent two different spatial entities: + a single polygon possibly containing inversions (if the ring is oriented CW) + a single hole possibly containing exversions (if the ring is oriented CCW) + If the MaximalEdgeRing represents a polygon, + the interior of the polygon is strongly connected. + These are the form of rings used to define polygons under some spatial data models. + However, under the OGC SFS model, MinimalEdgeRings are required. + A MaximalEdgeRing can be converted to a list of MinimalEdgeRings using the + BuildMinimalRings() method. + + + + + + + + + + + + + + + + + + + + + + + + + + For all nodes in this EdgeRing, + link the DirectedEdges at the node to form minimalEdgeRings + + + + + + + + + + + A ring of edges with the property that no node + has degree greater than 2. These are the form of rings required + to represent polygons under the OGC SFS spatial data model. + + + + + + + + + + + + + + + + + + + + + + + + + + Creates nodes for use in the PlanarGraphs constructed during + overlay operations. + + + + + + + + + + + + The spatial functions supported by this class. + These operations implement various bool combinations of the resultants of the overlay. + + + + + + + + + + + + + + + + + + + + + + + + + Computes the overlay of two Geometrys. The overlay + can be used to determine any bool combination of the geometries. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + This method will handle arguments of Location.NULL correctly. + + true if the locations correspond to the opCode. + + + + + + + + + + + + + + + + + + + + + + + Insert an edge from one of the noded input graphs. + Checks edges that are inserted to see if an + identical edge already exists. + If so, the edge is not inserted, but its label is merged + with the existing edge. + + + + + + Update the labels for edges according to their depths. + For each edge, the depths are first normalized. + Then, if the depths for the edge are equal, + this edge must have collapsed into a line edge. + If the depths are not equal, update the label + with the locations corresponding to the depths + (i.e. a depth of 0 corresponds to a Location of Exterior, + a depth of 1 corresponds to Interior) + + + + + If edges which have undergone dimensional collapse are found, + replace them with a new edge which is a L edge + + + + + Copy all nodes from an arg point into this graph. + The node label in the arg point overrides any previously computed + label for that argIndex. + (E.g. a node may be an intersection node with + a previously computed label of Boundary, + but in the original arg Geometry it is actually + in the interior due to the Boundary Determination Rule) + + + + + + Compute initial labelling for all DirectedEdges at each node. + In this step, DirectedEdges will acquire a complete labelling + (i.e. one with labels for both Geometries) + only if they + are incident on a node which has edges for both Geometries + + + + + For nodes which have edges from only one Geometry incident on them, + the previous step will have left their dirEdges with no labelling for the other + Geometry. However, the sym dirEdge may have a labelling for the other + Geometry, so merge the two labels. + + + + + + + + + + Incomplete nodes are nodes whose labels are incomplete. + (e.g. the location for one Geometry is null). + These are either isolated nodes, + or nodes which have edges from only a single Geometry incident on them. + Isolated nodes are found because nodes in one graph which don't intersect + nodes in the other are not completely labelled by the initial process + of adding nodes to the nodeList. + To complete the labelling we need to check for nodes that lie in the + interior of edges, and in the interior of areas. + When each node labelling is completed, the labelling of the incident + edges is updated, to complete their labelling as well. + + + + + Label an isolated node with its relationship to the target point. + + + + + Find all edges whose label indicates that they are in the result area(s), + according to the operation being performed. Since we want polygon shells to be + oriented CW, choose dirEdges with the interior of the result on the RHS. + Mark them as being in the result. + Interior Area edges are the result of dimensional collapses. + They do not form part of the result area boundary. + + + + + If both a dirEdge and its sym are marked as being in the result, cancel + them out. + + + + + This method is used to decide if a point node should be included in the result or not. + + true if the coord point is covered by a result Line or Area point. + + + + This method is used to decide if an L edge should be included in the result or not. + + true if the coord point is covered by a result Area point. + + + + true if the coord is located in the interior or boundary of + a point in the list. + + + + + + + + + + + + + + + + + + + Constructs Points from the nodes of an overlay graph. + + + + + + + + + + + + + + + + A list of the Points in the result of the specified overlay operation. + + + + + + + + + + + + This method simplifies the resultant Geometry by finding and eliminating + "covered" points. + A point is covered if it is contained in another element Geometry + with higher dimension (e.g. a point might be contained in a polygon, + in which case the point can be eliminated from the resultant). + + + + + + + Forms Polygons out of a graph of {DirectedEdge}s. + The edges to use are marked as being in the result Area. + + + + + + + + + + + Add a complete graph. + The graph is assumed to contain one or more polygons, + possibly with holes. + + + + + + Add a set of edges and nodes, which form a graph. + The graph is assumed to contain one or more polygons, + possibly with holes. + + + + + + + For all DirectedEdges in result, form them into MaximalEdgeRings. + + + + + + + + + + + + + + + + This method takes a list of MinimalEdgeRings derived from a MaximalEdgeRing, + and tests whether they form a Polygon. This is the case if there is a single shell + in the list. In this case the shell is returned. + The other possibility is that they are a series of connected holes, in which case + no shell is returned. + + The shell EdgeRing, if there is one. + null, if all the rings are holes. + + + + This method assigns the holes for a Polygon (formed from a list of + MinimalEdgeRings) to its shell. + Determining the holes for a MinimalEdgeRing polygon serves two purposes: + it is faster than using a point-in-polygon check later on. + it ensures correctness, since if the PIP test was used the point + chosen might lie on the shell, which might return an incorrect result from the + PIP test. + + + + + + + For all rings in the input list, + determine whether the ring is a shell or a hole + and add it to the appropriate list. + Due to the way the DirectedEdges were linked, + a ring is a shell if it is oriented CW, a hole otherwise. + + + + + + + + This method determines finds a containing shell for all holes + which have not yet been assigned to a shell. + These "free" holes should + all be properly contained in their parent shells, so it is safe to use the + findEdgeRingContaining method. + (This is the case because any holes which are NOT + properly contained (i.e. are connected to their + parent shell) would have formed part of a MaximalEdgeRing + and been handled in a previous step). + + + + + + + Find the innermost enclosing shell EdgeRing containing the argument EdgeRing, if any. + The innermost enclosing ring is the smallest enclosing ring. + The algorithm used depends on the fact that: + ring A contains ring B iff envelope(ring A) contains envelope(ring B). + This routine is only safe to use if the chosen point of the hole + is known to be properly contained in a shell + (which is guaranteed to be the case if the hole does not touch its shell). + + + + Containing EdgeRing, if there is one, OR + null if no containing EdgeRing is found. + + + + + + + + + + + Checks the current set of shells (with their associated holes) to + see if any of them contain the point. + + + + + + + + + + + + This exception occurs when the same directed edge appears more than once in the same list + + + + + Creates a new instance of the Duplicate Edge Exception + + + + + Represents a ring of PolygonizeDirectedEdges which form + a ring of a polygon. The ring may be either an outer shell or a hole. + + + + + + + + + + + Find the innermost enclosing shell EdgeRing containing the argument EdgeRing, if any. + The innermost enclosing ring is the smallest enclosing ring. + The algorithm used depends on the fact that: + ring A contains ring B iff envelope(ring A) contains envelope(ring B). + This routine is only safe to use if the chosen point of the hole + is known to be properly contained in a shell + (which is guaranteed to be the case if the hole does not touch its shell). + + The EdgeRing to test. + The list of shells to test. + Containing EdgeRing, if there is one, OR + null if no containing EdgeRing is found. + + + + Finds a point in a list of points which is not contained in another list of points. + + The Coordinates to test. + An array of Coordinates to test the input points against. + A Coordinate from testPts which is not in pts, + or null. + + + + Tests whether a given point is in an array of points. + Uses a value-based test. + + A Coordinate for the test point. + An array of Coordinates to test, + true if the point is in the array. + + + + Adds a DirectedEdge which is known to form part of this ring. + + The DirectedEdge to add. + + + + Adds a hole to the polygon formed by this ring. + + The LinearRing forming the hole. + + + + + + + + + + + + Tests whether this ring is a hole. + Due to the way the edges in the polyongization graph are linked, + a ring is a hole if it is oriented counter-clockwise. + + true if this ring is a hole. + + + + Computes and returns the Polygon formed by this ring and any contained holes. + + + + + Tests if the LinearRing ring formed by this edge ring is topologically valid. + + + + + Computes and returns the list of coordinates which are contained in this ring. + The coordinatea are computed once only and cached. + + + + + Gets the coordinates for this ring as a LineString. + Used to return the coordinates in this ring + as a valid point, when it has been detected that the ring is topologically + invalid. + + + + + Returns this ring as a LinearRing, or null if an Exception occurs while + creating it (such as a topology problem). Details of problems are written to + standard output. + + + + + Add every linear element in a point into the polygonizer graph. + + + + + Creates a new instance of LineStringAdder + + + + + Applies the Filter to the specified geometry + + + + + + A null directed edge exception + + + + + An exception for when the directed edge was null + + + + + A DirectedEdge of a PolygonizeGraph, which represents + an edge of a polygon formed by the graph. + May be logically deleted from the graph by setting the marked flag. + + + + + Constructs a directed edge connecting the from node to the + to node. + + + + + Specifies this DirectedEdge's direction (given by an imaginary + line from the from node to directionPt). + + + Whether this DirectedEdge's direction is the same as or + opposite to that of the parent Edge (if any). + + + + + Returns the identifier attached to this directed edge. + Attaches an identifier to this directed edge. + + + + + Returns the next directed edge in the EdgeRing that this directed edge is a member of. + Sets the next directed edge in the EdgeRing that this directed edge is a member of. + + + + + Returns the ring of directed edges that this directed edge is + a member of, or null if the ring has not been set. + + + + + Gets/Sets the ring of directed edges that this directed edge is + a member of. + + + + + An edge of a polygonization graph. + + + + + + + + + + + + + + + + Represents a planar graph of edges that can be used to compute a + polygonization, and implements the algorithms to compute the + EdgeRings formed by the graph. + The marked flag on DirectedEdges is used to indicate that a directed edge + has be logically deleted from the graph. + + + + + Create a new polygonization graph. + + + + + + + + + + + + + + + + + + + + + Deletes all edges at a node. + + + + + + Add a LineString forming an edge of the polygon graph. + + The line to add. + + + + + + + + + + + + + + + + Convert the maximal edge rings found by the initial graph traversal + into the minimal edge rings required by NTS polygon topology rules. + + The list of start edges for the edgeRings to convert. + + + + Finds all nodes in a maximal edgering which are self-intersection nodes + + + + + The list of intersection nodes found, + or null if no intersection nodes were found. + + + + + Computes the EdgeRings formed by the edges in this graph. + + A list of the{EdgeRings found by the polygonization process. + + + + + + A List of the DirectedEdges in the graph. + A List of DirectedEdges, one for each edge ring found. + + + + Finds and removes all cut edges from the graph. + + A list of the LineStrings forming the removed cut edges. + + + + + + + + + + + + + + + + + Computes the next edge pointers going CCW around the given node, for the + given edgering label. + This algorithm has the effect of converting maximal edgerings into minimal edgerings + + + + + + + Traverse a ring of DirectedEdges, accumulating them into a list. + This assumes that all dangling directed edges have been removed + from the graph, so that there is always a next dirEdge. + + The DirectedEdge to start traversing at. + A List of DirectedEdges that form a ring. + + + + + + + + + + + Marks all edges from the graph which are "dangles". + Dangles are which are incident on a node with degree 1. + This process is recursive, since removing a dangling edge + may result in another edge becoming a dangle. + In order to handle large recursion depths efficiently, + an explicit recursion stack is used. + + A List containing the LineStrings that formed dangles. + + + + Polygonizes a set of Geometrys which contain linework that + represents the edges of a planar graph. + Any dimension of Geometry is handled - the constituent linework is extracted + to form the edges. + The edges must be correctly noded; that is, they must only meet + at their endpoints. The Polygonizer will still run on incorrectly noded input + but will not form polygons from incorrected noded edges. + The Polygonizer reports the follow kinds of errors: + Dangles - edges which have one or both ends which are not incident on another edge endpoint + Cut Edges - edges which are connected at both ends but which do not form part of polygon + Invalid Ring Lines - edges which form rings which are invalid + (e.g. the component lines contain a self-intersection). + + + + + Create a polygonizer with the same {GeometryFactory} + as the input Geometrys. + + + + + Add a collection of geometries to be polygonized. + May be called multiple times. + Any dimension of Geometry may be added; + the constituent linework will be extracted and used. + + A list of Geometrys with linework to be polygonized. + + + + Add a point to the linework to be polygonized. + May be called multiple times. + Any dimension of Geometry may be added; + the constituent linework will be extracted and used + + A Geometry with linework to be polygonized. + + + + Perform the polygonization, if it has not already been carried out. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Compute and returns the list of polygons formed by the polygonization. + + + + + Compute and returns the list of dangling lines found during polygonization. + + + + + Compute and returns the list of cut edges found during polygonization. + + + + + Compute and returns the list of lines forming invalid rings found during polygonization. + + + + + Optimized implementation of spatial predicate "contains" + for cases where the first Geometry is a rectangle. + As a further optimization, + this class can be used directly to test many geometries against a single rectangle. + + + + + Create a new contains computer for two geometries. + + A rectangular geometry. + + + + + + + + + + + + + + + + + + + + + + + + + + Given any valid implementation of ICoordinate, which + will basically provide an X, Y or Z values, this will determine + if the rectangle contains the point. + + + + + + + + + + + + + + + + + + + + + + Optimized implementation of spatial predicate "intersects" + for cases where the first {@link Geometry} is a rectangle. + As a further optimization, + this class can be used directly to test many geometries against a single + rectangle. + + + + + Crossover size at which brute-force intersection scanning + is slower than indexed intersection detection. + Must be determined empirically. Should err on the + safe side by making value smaller rather than larger. + + + + + Create a new intersects computer for a rectangle. + + A rectangular geometry. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Tests if any line segments in two sets of CoordinateSequences intersect. + Optimized for small geometry size. + Short-circuited to return as soon an intersection is found. + + + + + + + + + + + + + + + + + + + + An EdgeEndBuilder creates EdgeEnds for all the "split edges" + created by the intersections determined for an Edge. + Computes the EdgeEnds which arise from a noded Edge. + + + + + + + + + + + + Creates stub edges for all the intersections in this + Edge (if any) and inserts them into the graph. + + + + + + + Create a EdgeStub for the edge before the intersection eiCurr. + The previous intersection is provided + in case it is the endpoint for the stub edge. + Otherwise, the previous point from the parent edge will be the endpoint. + eiCurr will always be an EdgeIntersection, but eiPrev may be null. + + + + + + + + + Create a StubEdge for the edge after the intersection eiCurr. + The next intersection is provided + in case it is the endpoint for the stub edge. + Otherwise, the next point from the parent edge will be the endpoint. + eiCurr will always be an EdgeIntersection, but eiNext may be null. + + + + + + + + + A collection of EdgeStubs which obey the following invariant: + They originate at the same node and have the same direction. + Contains all EdgeEnds which start at the same point and are parallel. + + + + + + + + + + + + + + + + + + + + + + + This computes the overall edge label for the set of + edges in this EdgeStubBundle. It essentially merges + the ON and side labels for each edge. + These labels must be compatible + + + + + Compute the overall ON location for the list of EdgeStubs. + (This is essentially equivalent to computing the self-overlay of a single Geometry) + edgeStubs can be either on the boundary (eg Polygon edge) + OR in the interior (e.g. segment of a LineString) + of their parent Geometry. + In addition, GeometryCollections use the mod-2 rule to determine + whether a segment is on the boundary or not. + Finally, in GeometryCollections it can still occur that an edge is both + on the boundary and in the interior (e.g. a LineString segment lying on + top of a Polygon edge.) In this case as usual the Boundary is given precendence. + These observations result in the following rules for computing the ON location: + if there are an odd number of Bdy edges, the attribute is Bdy + if there are an even number >= 2 of Bdy edges, the attribute is Int + if there are any Int edges, the attribute is Int + otherwise, the attribute is Null. + + + + + + Compute the labelling for each side + + + + + + To compute the summary label for a side, the algorithm is: + FOR all edges + IF any edge's location is Interior for the side, side location = Interior + ELSE IF there is at least one Exterior attribute, side location = Exterior + ELSE side location = Null + Notice that it is possible for two sides to have apparently contradictory information + i.e. one edge side may indicate that it is in the interior of a point, while + another edge side may indicate the exterior of the same point. This is + not an incompatibility - GeometryCollections may contain two Polygons that touch + along an edge. This is the reason for Interior-primacy rule above - it + results in the summary label having the Geometry interior on both sides. + + + + + + + Update the IM with the contribution for the computed label for the EdgeStubs. + + + + + + + + + + + + + + + + + An ordered list of EdgeEndBundles around a RelateNode. + They are maintained in CCW order (starting with the positive x-axis) around the node + for efficient lookup and topology building. + + + + + Insert a EdgeEnd in order in the list. + If there is an existing EdgeStubBundle which is parallel, the EdgeEnd is + added to the bundle. Otherwise, a new EdgeEndBundle is created + to contain the EdgeEnd. + + + + + + Update the IM with the contribution for the EdgeStubs around the node. + + + + + + Computes the topological relationship between two Geometries. + RelateComputer does not need to build a complete graph structure to compute + the IntersectionMatrix. The relationship between the geometries can + be computed by simply examining the labelling of edges incident on each node. + RelateComputer does not currently support arbitrary GeometryCollections. + This is because GeometryCollections can contain overlapping Polygons. + In order to correct compute relate on overlapping Polygons, they + would first need to be noded and merged (if not explicitly, at least + implicitly). + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Copy all nodes from an arg point into this graph. + The node label in the arg point overrides any previously computed + label for that argIndex. + (E.g. a node may be an intersection node with + a computed label of Boundary, + but in the original arg Geometry it is actually + in the interior due to the Boundary Determination Rule) + + + + + + Insert nodes for all intersections on the edges of a Geometry. + Label the created nodes the same as the edge label if they do not already have a label. + This allows nodes created by either self-intersections or + mutual intersections to be labelled. + Endpoint nodes will already be labelled from when they were inserted. + + + + + + If the Geometries are disjoint, we need to enter their dimension and + boundary dimension in the Ext rows in the IM + + + + + + + + + + + Update the IM with the sum of the IMs for each component. + + + + + + Processes isolated edges by computing their labelling and adding them + to the isolated edges list. + Isolated edges are guaranteed not to touch the boundary of the target (since if they + did, they would have caused an intersection to be computed and hence would + not be isolated). + + + + + + + Label an isolated edge of a graph with its relationship to the target point. + If the target has dim 2 or 1, the edge can either be in the interior or the exterior. + If the target has dim 0, the edge must be in the exterior. + + + + + + + + Isolated nodes are nodes whose labels are incomplete + (e.g. the location for one Geometry is null). + This is the case because nodes in one graph which don't intersect + nodes in the other are not completely labelled by the initial process + of adding nodes to the nodeList. + To complete the labelling we need to check for nodes that lie in the + interior of edges, and in the interior of areas. + + + + + Label an isolated node with its relationship to the target point. + + + + + + + A RelateNode is a Node that maintains a list of EdgeStubs + for the edges that are incident on it. + + + + + + + + + + + + Update the IM with the contribution for this component. + A component only contributes if it has a labelling for both parent geometries. + + + + + Update the IM with the contribution for the EdgeEnds incident on this node. + + + + + + Used by the NodeMap in a RelateNodeGraph to create RelateNodes. + + + + + + + + + + + + Implements the simple graph of Nodes and EdgeEnd which is all that is + required to determine topological relationships between Geometries. + Also supports building a topological graph of a single Geometry, to + allow verification of valid topology. + It is not necessary to create a fully linked + PlanarGraph to determine relationships, since it is sufficient + to know how the Geometries interact locally around the nodes. + In fact, this is not even feasible, since it is not possible to compute + exact intersection points, and hence the topology around those nodes + cannot be computed robustly. + The only Nodes that are created are for improper intersections; + that is, nodes which occur at existing vertices of the Geometries. + Proper intersections (e.g. ones which occur between the interior of line segments) + have their topology determined implicitly, without creating a Node object + to represent them. + + + + + + + + + + + + + + + + + Insert nodes for all intersections on the edges of a Geometry. + Label the created nodes the same as the edge label if they do not already have a label. + This allows nodes created by either self-intersections or + mutual intersections to be labelled. + Endpoint nodes will already be labelled from when they were inserted. + Precondition: edge intersections have been computed. + + + + + + + Copy all nodes from an arg point into this graph. + The node label in the arg point overrides any previously computed + label for that argIndex. + (E.g. a node may be an intersection node with + a computed label of Boundary, + but in the original arg Geometry it is actually + in the interior due to the Boundary Determination Rule). + + + + + + + + + + + + + Implements the Relate() operation on Geometrys. + + + + + + + + + + + + + + + + + + + + + + + + + This class tests that the interior of an area + ( or ) + is connected. An area Geometry is invalid if the interior is disconnected. + This can happen if: + - a shell self-intersects, + - one or more holes form a connected chain touching a shell at two different points, + - one or more holes form a ring around a subset of the interior. + If a disconnected situation is found the location of the problem is recorded. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Form s in graph into Minimal EdgeRings. + (Minimal Edgerings must be used, because only they are guaranteed to provide + a correct isHole computation). + + + + + + + Mark all the edges for the edgeRings corresponding to the shells of the input polygons. + Only ONE ring gets marked for each shell - if there are others which remain unmarked + this indicates a disconnected interior. + + + + + + + + + + + + + + + + + + + + Check if any shell ring has an unvisited edge. + A shell ring is a ring which is not a hole and which has the interior + of the parent area on the RHS. + (Notice that there may be non-hole rings with the interior on the LHS, + since the interior of holes will also be polygonized into CW rings + by the LinkAllDirectedEdges() step). + + + true if there is an unvisited edge in a non-hole ring. + + + + + + + + + Checks that a {GeometryGraph} representing an area + (a Polygon or MultiPolygon ) + is consistent with the SFS semantics for area geometries. + Checks include: + Testing for rings which self-intersect (both properly and at nodes). + Testing for duplicate rings. + If an inconsistency if found the location of the problem is recorded. + + + + + + + + + + + Returns the intersection point, or null if none was found. + + + + + + + + + + Check all nodes to see if their labels are consistent. + If any are not, return false. + + + + + Checks for two duplicate rings in an area. + Duplicate rings are rings that are topologically equal + (that is, which have the same sequence of points up to point order). + If the area is topologically consistent (determined by calling the + isNodeConsistentArea, + duplicate rings can be found by checking for EdgeBundles which contain more than one EdgeEnd. + (This is because topologically consistent areas cannot have two rings sharing + the same line segment, unless the rings are equal). + The start point of one of the equal rings will be placed in invalidPoint. + Returns true if this area Geometry is topologically consistent but has two duplicate rings. + + + + + Implements the algorithsm required to compute the + method for s. + See the documentation for the various geometry types for a specification of validity. + + + + If the following condition is TRUE JTS will validate inverted shells and exverted holes (the Esri SDE model). + + + + + + + + + + Checks whether a coordinate is valid for processing. + Coordinates are valid iff their x and y ordinates are in the + range of the floating point representation. + + The coordinate to validate. + true if the coordinate is valid. + + + + Find a point from the list of testCoords + that is NOT a node in the edge for the list of searchCoords. + + + + + The point found, or null if none found. + + + + + + + + + + Checks validity of a Point. + + + + + + Checks validity of a LineString. + Almost anything goes for lineStrings! + + + + + + Checks validity of a LinearRing. + + + + + + Checks the validity of a polygon and sets the validErr flag. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Check that there is no ring which self-intersects (except of course at its endpoints). + This is required by OGC topology rules (but not by other models + such as Esri SDE, which allow inverted shells and exverted holes). + + + + + + Check that a ring does not self-intersect, except at its endpoints. + Algorithm is to count the number of times each node along edge occurs. + If any occur more than once, that must be a self-intersection. + + + + + Tests that each hole is inside the polygon shell. + This routine assumes that the holes have previously been tested + to ensure that all vertices lie on the shell or inside it. + A simple test of a single point in the hole can be used, + provide the point is chosen such that it does not lie on the + boundary of the shell. + + The polygon to be tested for hole inclusion. + A GeometryGraph incorporating the polygon. + + + + Tests that no hole is nested inside another hole. + This routine assumes that the holes are disjoint. + To ensure this, holes have previously been tested + to ensure that: + They do not partially overlap + (checked by checkRelateConsistency). + They are not identical + (checked by checkRelateConsistency). + + + + + Tests that no element polygon is wholly in the interior of another element polygon. + Preconditions: + Shells do not partially overlap. + Shells do not touch along an edge. + No duplicate rings exists. + This routine relies on the fact that while polygon shells may touch at one or + more vertices, they cannot touch at ALL vertices. + + + + + Check if a shell is incorrectly nested within a polygon. This is the case + if the shell is inside the polygon shell, but not inside a polygon hole. + (If the shell is inside a polygon hole, the nesting is valid.) + The algorithm used relies on the fact that the rings must be properly contained. + E.g. they cannot partially overlap (this has been previously checked by + CheckRelateConsistency). + + + + + This routine checks to see if a shell is properly contained in a hole. + It assumes that the edges of the shell and hole do not + properly intersect. + + + + + + null if the shell is properly contained, or + a Coordinate which is not inside the hole if it is not. + + + + + + + + + + + + Gets/Sets whether polygons using Self-Touching Rings to form + holes are reported as valid. + If this flag is set, the following Self-Touching conditions + are treated as being valid: + - The shell ring self-touches to create a hole touching the shell. + - A hole ring self-touches to create two holes touching at a point. + + + The default (following the OGC SFS standard) + is that this condition is not valid (false). + + + This does not affect whether Self-Touching Rings + disconnecting the polygon interior are considered valid + (these are considered to be invalid under the SFS, and many other + spatial models as well). + This includes "bow-tie" shells, + which self-touch at a single point causing the interior to be disconnected, + and "C-shaped" holes which self-touch at a single point causing an island to be formed. + + + States whether geometry with this condition is valid. + + + + + + + + + + + + + + Tests whether any of a set of LinearRings are + nested inside another ring in the set, using a Quadtree + index to speed up the comparisons. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Implements the appropriate checks for repeated points + (consecutive identical coordinates) as defined in the + NTS spec. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + A ShellHoleIdentityException Class + + + + + Creates a new instance of ShellHoleIdentityException + + + + + Tests whether any of a set of LinearRings are + nested inside another ring in the set, using a simple O(n^2) + comparison. + + + + + + + + + + + + + + + + + + + + + + + + + + + + Tests whether any of a set of LinearRings are + nested inside another ring in the set, using a SweepLineIndex + index to speed up the comparisons. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Contains information about the nature and location of a Geometry + validation error. + + + + + These messages must synch up with the indexes above + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Contains information about the nature and location of + a validation error. + + + + + Not used. + + + + + No longer used: + repeated points are considered valid as per the SFS. + + + + + Indicates that a hole of a polygon lies partially + or completely in the exterior of the shell. + + + + + Indicates that a hole lies + in the interior of another hole in the same polygon. + + + + + Indicates that the interior of a polygon is disjoint + (often caused by set of contiguous holes splitting + the polygon into two parts). + + + + + Indicates that two rings of a polygonal geometry intersect. + + + + + Indicates that a ring self-intersects. + + + + + Indicates that a polygon component of a + lies inside another polygonal component. + + + + + Indicates that a polygonal geometry + contains two rings which are identical. + + + + + Indicates that either: + - A contains a single point. + - A contains 2 or 3 points. + + + + + Indicates that the X or Y ordinate of + a is not a valid + numeric value (e.g. ). + + + + + Indicates that a ring is not correctly closed + (the first and the last coordinate are different). + + + + + Finds all connected s of a . + + + + + Initializes a new instance of the ConnectedSubgraphFinder class. + + The . + + + + + + + + + + Adds all nodes and edges reachable from this node to the subgraph. + Uses an explicit stack to avoid a large depth of recursion. + + + + + + + Adds the argument node and all its out edges to the subgraph. + + + + + + + + A sorted collection of DirectedEdges which leave a Node + in a PlanarGraph. + + + + + The underlying list of outgoing DirectedEdges. + + + + + Adds a new member to this DirectedEdgeStar. + + + + + + Drops a member of this DirectedEdgeStar. + + + + + + Returns an Iterator over the DirectedEdges, in ascending order by angle with the positive x-axis. + + + + + + + + + + Returns the zero-based index of the given Edge, after sorting in ascending order + by angle with the positive x-axis. + + + + + + + Returns the zero-based index of the given DirectedEdge, after sorting in ascending order + by angle with the positive x-axis. + + + + + + + Returns the remainder when i is divided by the number of edges in this + DirectedEdgeStar. + + + + + + + Returns the DirectedEdge on the left-hand side of the given DirectedEdge (which + must be a member of this DirectedEdgeStar). + + + + + + + The underlying list of outgoing Directed Edges + + + + + Returns the number of edges around the Node associated with this DirectedEdgeStar. + + + + + Returns the coordinate for the node at wich this star is based. + + + + + Returns the DirectedEdges, in ascending order by angle with the positive x-axis. + + + + + A node in a PlanarGraph is a location where 0 or more Edges + meet. A node is connected to each of its incident Edges via an outgoing + DirectedEdge. Some clients using a PlanarGraph may want to + subclass Node to add their own application-specific + data and methods. + + + + + The collection of DirectedEdges that leave this Node. + + + + + The location of this Node. + + + + + Constructs a Node with the given location. + + + + + + Constructs a Node with the given location and collection of outgoing DirectedEdges. + + + + + + + Returns all Edges that connect the two nodes (which are assumed to be different). + + + + + + + + Adds an outgoing DirectedEdge to this Node. + + + + + + Returns the zero-based index of the given Edge, after sorting in ascending order + by angle with the positive x-axis. + + + + + + + Removes this node from its containing graph. + + + + + + + + + + + Returns the location of this Node. + + + + + Returns the collection of DirectedEdges that leave this Node. + + + + + Returns the number of edges around this Node. + + + + + Tests whether this component has been removed from its containing graph. + + + + + + A map of Nodes, indexed by the coordinate of the node. + + + + + Adds a node to the map, replacing any that is already at that location. + + + The added node. + + + + Removes the Node at the given location, and returns it (or null if no Node was there). + + + + + + + Returns the Node at the given location, or null if no Node was there. + + + + + + + Returns an Iterator over the Nodes in this NodeMap, sorted in ascending order + by angle with the positive x-axis. + + + + + Returns the Nodes in this NodeMap, sorted in ascending order + by angle with the positive x-axis. + + + + + A subgraph of a . + A subgraph may contain any subset of s + from the parent graph. + It will also automatically contain all s + and s associated with those edges. + No new objects are created when edges are added - + all associated components must already exist in the parent graph. + + + + + + + + + + + + + + + + + + + + + + + + + Creates a new subgraph of the given . + + + + + + Gets the which this subgraph is part of. + + + + + + Adds an to the subgraph. + The associated s and s are also added. + + The to add. + + + + Returns an over the s in this graph, + in the order in which they were added. + + + + + + Returns an over the s in this graph, + in the order in which they were added. + + + + + + Returns an over the s in this graph. + + + + + + Tests whether an is contained in this subgraph. + + The to test. + true if the is contained in this subgraph. + + + + Determines the maximum number of common most-significant + bits in the mantissa of one or numbers. + Can be used to compute the double-precision number which + is represented by the common bits. + If there are no common bits, the number computed is 0.0. + + + + + Computes the bit pattern for the sign and exponent of a + double-precision number. + + + The bit pattern for the sign and exponent. + + + + This computes the number of common most-significant bits in the mantissas + of two double-precision numbers. + It does not count the hidden bit, which is always 1. + It does not determine whether the numbers have the same exponent - if they do + not, the value computed by this function is meaningless. + + + /// + The number of common most-significant mantissa bits. + + + + Zeroes the lower n bits of a bitstring. + + The bitstring to alter. + the number of bits to zero. + The zeroed bitstring. + + + + Extracts the i'th bit of a bitstring. + + The bitstring to extract from. + The bit to extract. + The value of the extracted bit. + + + + + + + + + + A representation of the Double bits formatted for easy readability + + + + + + + + + + + + Provides versions of Geometry spatial functions which use + common bit removal to reduce the likelihood of robustness problems. + In the current implementation no rounding is performed on the + reshifted result point, which means that it is possible + that the returned Geometry is invalid. + Client classes should check the validity of the returned result themselves. + + + + + Creates a new instance of class, which reshifts result Geometrys. + + + + + Creates a new instance of class, specifying whether + the result Geometrys should be reshifted. + + + + + + Computes the set-theoretic intersection of two Geometrys, using enhanced precision. + + The first Geometry. + The second Geometry. + The Geometry representing the set-theoretic intersection of the input Geometries. + + + + Computes the set-theoretic union of two Geometrys, using enhanced precision. + + The first Geometry. + The second Geometry. + The Geometry representing the set-theoretic union of the input Geometries. + + + + Computes the set-theoretic difference of two Geometrys, using enhanced precision. + + The first Geometry. + The second Geometry, to be subtracted from the first. + The Geometry representing the set-theoretic difference of the input Geometries. + + + Computes the set-theoretic symmetric difference of two geometries, + using enhanced precision. + + The first Geometry. + The second Geometry. + The Geometry representing the set-theoretic symmetric difference of the input Geometries. + + + + Computes the buffer a point, using enhanced precision. + + The Geometry to buffer. + The buffer distance. + The Geometry representing the buffer of the input Geometry. + + + + If required, returning the result to the orginal precision if required. + In this current implementation, no rounding is performed on the + reshifted result point, which means that it is possible + that the returned Geometry is invalid. + + The result Geometry to modify. + The result Geometry with the required precision. + + + + Computes a copy of the input Geometry with the calculated common bits + removed from each coordinate. + + The Geometry to remove common bits from. + A copy of the input Geometry with common bits removed. + + + + Computes a copy of each input Geometrys with the calculated common bits + removed from each coordinate. + + An IGeometry to remove common bits from. + An second IGeometry to remove common bits from. + + An array containing copies + of the input Geometry's with common bits removed. + + + + + Allow computing and removing common mantissa bits from one or more Geometries. + + + + + Add a point to the set of geometries whose common bits are + being computed. After this method has executed the + common coordinate reflects the common bits of all added + geometries. + + A Geometry to test for common bits. + + + + Removes the common coordinate bits from a Geometry. + The coordinates of the Geometry are changed. + + The Geometry from which to remove the common coordinate bits. + The shifted Geometry. + + + + Adds the common coordinate bits back into a Geometry. + The coordinates of the Geometry are changed. + + The Geometry to which to add the common coordinate bits. + + + + The common bits of the Coordinates in the supplied Geometries. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Provides versions of Geometry spatial functions which use + enhanced precision techniques to reduce the likelihood of robustness problems. + + + + + Only static methods! + + + + + Computes the set-theoretic intersection of two Geometrys, using enhanced precision. + + The first Geometry. + The second Geometry. + The Geometry representing the set-theoretic intersection of the input Geometries. + + + + Computes the set-theoretic union of two Geometrys, using enhanced precision. + + The first Geometry. + The second Geometry. + The Geometry representing the set-theoretic union of the input Geometries. + + + + Computes the set-theoretic difference of two Geometrys, using enhanced precision. + + The first Geometry. + The second Geometry. + The Geometry representing the set-theoretic difference of the input Geometries. + + + + Computes the set-theoretic symmetric difference of two Geometrys, using enhanced precision. + + The first Geometry. + The second Geometry. + The Geometry representing the set-theoretic symmetric difference of the input Geometries. + + + + Computes the buffer of a Geometry, using enhanced precision. + This method should no longer be necessary, since the buffer algorithm + now is highly robust. + + The first Geometry. + The buffer distance. + The Geometry representing the buffer of the input Geometry. + + + + Reduces the precision of a Geometry + according to the supplied {PrecisionModel}, without + attempting to preserve valid topology. + The topology of the resulting point may be invalid if + topological collapse occurs due to coordinates being shifted. + It is up to the client to check this and handle it if necessary. + Collapses may not matter for some uses. An example + is simplifying the input to the buffer algorithm. + The buffer algorithm does not depend on the validity of the input point. + + + + + + + + + + + + + + + + + + Sets whether the reduction will result in collapsed components + being removed completely, or simply being collapsed to an (invalid) + Geometry of the same type. + + + + + Gets/Sets whether the PrecisionModel of the new reduced Geometry + will be changed to be the PrecisionModel supplied to + specify the reduction. + The default is to not change the precision model. + + + + + + + + + + + + + + + + + + + + + + + + A ShouldNeverReachHereException Class + + + + + Creates a new instance of ShouldNeverReachHereException + + + + + Simplifies a line (sequence of points) using + the standard Douglas-Peucker algorithm. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Simplifies a Geometry using the standard Douglas-Peucker algorithm. + Ensures that any polygonal geometries returned are valid. + Simple lines are not guaranteed to remain simple after simplification. + Notice that in general D-P does not preserve topology - + e.g. polygons can be split, collapse to lines or disappear + holes can be created or disappear, + and lines can cross. + To simplify point while preserving topology use TopologySafeSimplifier. + (However, using D-P is significantly faster). + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Creates a valid area point from one that possibly has + bad topology (i.e. self-intersections). + Since buffer can handle invalid topology, but always returns + valid point, constructing a 0-width buffer "corrects" the + topology. + Notice this only works for area geometries, since buffer always returns + areas. This also may return empty geometries, if the input + has no actual area. + + An area point possibly containing self-intersections. + A valid area point. + + + + An index of LineSegments. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ItemVisitor subclass to reduce volume of query results. + + + + + + + + + + + + + + + + + + + + + + A LineSegment which is tagged with its location in a Geometry. + Used to index the segments in a point and recover the segment locations + from the index. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Simplifies a collection of TaggedLineStrings, preserving topology + (in the sense that no new intersections are introduced). + + + + + Simplify a collection of TaggedLineStrings. + + The collection of lines to simplify. + + + + Gets/Sets the distance tolerance for the simplification. + Points closer than this tolerance to a simplified segment may + be removed. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Simplifies a TaggedLineString, preserving topology + (in the sense that no new intersections are introduced). + Uses the recursive D-P algorithm. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Tests whether a segment is in a section of a TaggedLineString- + + + + + + + + + + + + + + + + + Remove the segs in the section of the line. + + + + + + + + + + + + + Simplifies a point, ensuring that + the result is a valid point having the + same dimension and number of components as the input. + The simplification uses a maximum distance difference algorithm + similar to the one used in the Douglas-Peucker algorithm. + In particular, if the input is an areal point + ( Polygon or MultiPolygon ) + The result has the same number of shells and holes (rings) as the input, + in the same order + The result rings touch at no more than the number of touching point in the input + (although they may touch at fewer points). + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + A utility for making programming assertions. + + + + + Only static methods! + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Executes a transformation function on each element of a collection + and returns the results in a new List. + + + + + Executes a function on each item in a + and returns the results in a new . + + + + + + + + Executes a function on each item in a + but does not accumulate the result. + + + + + + + Executes a function on each item in a + and collects all the entries for which the result + of the function is equal to true. + + + + + + + + The FunctionDelegate defines a structure taking a strong type in and passing a member of the same type back out. + + The type for the method. + The object parameter for the method. + An object of type T. + + + + + + + + + + + + + + + + + + + + Only static methods! + + + + + Convert the given numeric value (passed as string) of the base specified by baseIn + to the value specified by baseOut. + + Numeric value to be converted, as string. + Base of input value. + Base to use for conversion. + Converted value, as string. + + + + A CoordinateFilter that builds a set of Coordinates. + The set of coordinates contains no duplicate points. + + + + + + + + + + + Returns the gathered Coordinates. + + + + + Contains static methods and parameters that organize the major elements of + applying the Fortune linesweep methods + + + + + The default definition of a coordinate that uses double.NaN to clarify + that no value has yet been assigned to this vector. + + + + + Represents an infinite vector location + + + + + Boolean, true if the cleanup method should be called. This is unnecessary, for + the mapwindow implementation and will in fact cause the implementation to break + because infinities and other bad values start showing up. + + + + + Calculates the voronoi graph, but specifies a tolerance below which values should be considered equal. + + The original points to use during the calculation + A double value that controls the test for equality + This for Ben's code and should be passed as true if cleanup should be done. + A VoronoiGraph structure containing the output geometries + + + + Calculates a list of edges and junction vertices by using the specified points. + This defaults to not using any tolerance for determining if points are equal, + and will not use the cleanup algorithm, which breaks the HandleBoundaries + method in the Voronoi class. + + The original points to use during the calculation + A VoronoiGraph structure containing the output geometries + + + + Applies an optional cleanup method needed by Benjamine Ditter for + laser data calculations. This is not used by the MapWindow calculations + + The output voronoi graph created in the Compute Voronoi Graph section + A minimum left to right distance + The Voronoi Graph after it has been filtered. + + + + The HashSet is a dictionary that provides the optimized + + + + + Adds the specified object to the hash set collection + + The object to add + + + + Gets the enumerator of the items in the set + + + + + + Copies the members of this hash set to the specified array, starting at the specified index + + + + + + + Clears the entire set + + + + + Gets a boolean indicating if the specified item is in the set + + + + + + + Removes the specified item + + + + + + + Gets the integer count of members in this set + + + + + These sets can be modified + + + + + Contains several helpful tools that allow the voronoi polygon creation to work + + + + + Calculates the euclidean distance + + + + + + + + + + + + + + + + + + + + + + + A vector class, implementing all interesting features of vectors + + + + + This double controls the test for equality so that values that + are smaller than this value will be considered equal. + + + + + The x coordinate + + + + + The y coordinate + + + + + Creates a vector by reading a long array of vertices and assigning the vector based on that + + + + + + + Build a new vector + + The elements of the vector + + + + Transforms the vector into a coordinate with an x and y value + + + + + + True if any of the double values is not a number + + + + + Convert the vector into a reconstructable string representation + + A string from which the vector can be rebuilt + + + + Compares this vector with another one + + + + + + + Calculates the euclidean distance from this cell to another + + Vector2 stuff + + + + Retrieves a hashcode that is dependent on the elements + + The hashcode + + + + Get the scalar product of two vectors + + + + + Overrides equality to use the tolerant equality + + + + + + + + Overrides equality to use the tolerant equality test + + + + + + + + Calculates the vector sum of these two vectors + + One vector to add + The second vector to add + The vector sum of the specified vectors + + + + Calculates the vector sum of these two vectors + + One vector to add + The second vector to add + The vector sum of the specified vectors + + + + Multiplies the vector by a scalar + + The vector to modify + The double scale to multiply + A new Vector2 + + + + Multiplies the vector by a scalar. + + The double scale to multiply. + The vector to modify. + A new Vector2. + + + + Gets the dot product of this vector with itself + + + + + Will return the new root (unchanged except in start-up) + + + + + The Voronoi Edge represents a bisector between two of the original datapoints. The + LeftData and RightData represent those original points. VVertexA and VVertexB represent + the endpoints of the segment created using those original points. + + + + + An internal boolean for tracking some cleanup operations + + + + + The other original point in the dataset + + + + + One of the original points in the dataset + + + + + One of the endpoints for the segment that defines this edge + + + + + THe other endpoint for the segment that defines this edge + + + + + Adds VertexA and VertexB sequentially, so that if VertexA is defined, + then VertexB will become the specified vertex. + + + + + + + Boolean, true if both the VertexA and VertexB are infinite vectors + + + + + Indicates that one of the voronoi vertices for this edge is known, but no + intersection is found to bound the other edge, and it should extend to the + bounding box. + + + + + In the case where the line is infinite, this will return the + center between the left and right data points. + + + + + Calculates a vector direction that indicates the direction of this + knwon + + + + + Calculates the length of this edge + + + + + Voronoi Graph + + + + + The collection of VoronoiEdges. The Left and Right points are from the + original set of points that are bisected by the edge. The A and B + Vectors are the endpoints of the edge itself. + + + + + The vertices that join the voronoi polygon edges (not the original points) + + + + Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.Geotechnics.IO.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.Soilbase.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/NetTopologySuite.IO.MsSqlSpatial.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/DevExpress.BonusSkins.v12.2.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/nl-NL/Deltares.DamPiping.BlighCalculator.resources.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/shapefiletrace.log =================================================================== diff -u --- DamClients/DamUI/trunk/release/Install_Version/shapefiletrace.log (revision 0) +++ DamClients/DamUI/trunk/release/Install_Version/shapefiletrace.log (revision 2315) @@ -0,0 +1,3 @@ +Date: 8-4-2019, Error type: FeatureCoverageException, Message: For target dwp18_6, the shape file ..\..\..\data\Dam\Waterboards\Groot Salland\Binnenwaarts\GWS\gis-customdata\ShapeFiles\trafficload.shp does not contain information for point (192584,10 511740,30) +Date: 8-4-2019, Error type: FeatureCoverageException, Message: For target dwp18_6, the shape file ..\..\..\data\Dam\Waterboards\Groot Salland\Binnenwaarts\GWS\gis-customdata\ShapeFiles\PenetrationLength.shp does not contain information for point (192584,10 511740,30) +Date: 8-4-2019, Error type: FeatureCoverageException, Message: For target dwp18_6, the shape file ..\..\..\data\Dam\Waterboards\Groot Salland\Binnenwaarts\GWS\gis-customdata\ShapeFiles\TL_DegreeOfConsolidation.shp does not contain information for point (192584,10 511740,30) Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.DamEngine.Calculators.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/Packages.xml =================================================================== diff -u --- DamClients/DamUI/trunk/release/Install_Version/Packages.xml (revision 0) +++ DamClients/DamUI/trunk/release/Install_Version/Packages.xml (revision 2315) @@ -0,0 +1,43 @@ + + + + + + <module>0</module> + </package> + <package> + <title en="Basic, Uplift, Spencer" nl="Basic, Uplift, Spencer" /> + <module>0</module> + <module>1</module> + <module>2</module> + </package> + <package> + <title en="Full" nl="Volledig" /> + <module>0</module> + <module>1</module> + <module>2</module> + <module>3</module> + <module>5</module> + </package> +</packages> Index: DamClients/DamUI/trunk/release/Install_Version/DotSpatial.Data.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/th/DotSpatial.Projections.Forms.resources.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.DamEngine.Io.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.Geotechnics.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/de/DotSpatial.Projections.Forms.resources.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.Geometry.TestUtils.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/BruTile.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/DotSpatial.Serialization.pdb =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/GeoAPI.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/DevExpress.XtraPrinting.v12.2.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/SmartThreadPool.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/DevExpress.XtraLayout.v12.2.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.Dam.Tests.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.DamMacroStability.Calculator.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.Dam.DamWti.Tests.pdb =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/CommandLine.xml =================================================================== diff -u --- DamClients/DamUI/trunk/release/Install_Version/CommandLine.xml (revision 0) +++ DamClients/DamUI/trunk/release/Install_Version/CommandLine.xml (revision 2315) @@ -0,0 +1,868 @@ +<?xml version="1.0"?> +<doc> + <assembly> + <name>/home/giacomo/Projects/CommandLine/src/libcmdline/bin/Release/CommandLine</name> + </assembly> + <members> + <member name="T:CommandLine.BaseOptionAttribute"> + <summary> + Provides base properties for creating an attribute, used to define rules for command line parsing. + </summary> + </member> + <member name="P:CommandLine.BaseOptionAttribute.ShortName"> + <summary> + Short name of this command line option. You can use only one character. + </summary> + </member> + <member name="P:CommandLine.BaseOptionAttribute.LongName"> + <summary> + Long name of this command line option. This name is usually a single english word. + </summary> + </member> + <member name="P:CommandLine.BaseOptionAttribute.Required"> + <summary> + True if this command line option is required. + </summary> + </member> + <member name="P:CommandLine.BaseOptionAttribute.DefaultValue"> + <summary> + Gets or sets mapped property default value. + </summary> + </member> + <member name="P:CommandLine.BaseOptionAttribute.HelpText"> + <summary> + A short description of this command line option. Usually a sentence summary. + </summary> + </member> + <member name="T:CommandLine.HelpOptionAttribute"> + <summary> + Indicates the instance method that must be invoked when it becomes necessary show your help screen. + The method signature is an instance method with no parameters and <see cref="T:System.String" /> + return value. + </summary> + </member> + <member name="M:CommandLine.HelpOptionAttribute.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:CommandLine.HelpOptionAttribute" /> class. + </summary> + </member> + <member name="M:CommandLine.HelpOptionAttribute.#ctor(System.String,System.String)"> + <summary> + Initializes a new instance of the <see cref="T:CommandLine.HelpOptionAttribute" /> class. + Allows you to define short and long option names. + </summary> + <param name="shortName">The short name of the option or null if not used.</param> + <param name="longName">The long name of the option or null if not used.</param> + </member> + <member name="P:CommandLine.HelpOptionAttribute.Required"> + <summary> + Returns always false for this kind of option. + This behaviour can't be changed by design; if you try set <see cref="P:CommandLine.HelpOptionAttribute.Required" /> + an <see cref="T:System.InvalidOperationException" /> will be thrown. + </summary> + </member> + <member name="T:CommandLine.OptionArrayAttribute"> + <summary> + Models an option that can accept multiple values as separated arguments. + </summary> + </member> + <member name="M:CommandLine.OptionArrayAttribute.#ctor(System.String,System.String)"> + <summary> + Initializes a new instance of the <see cref="T:CommandLine.OptionArrayAttribute" /> class. + </summary> + <param name="shortName">The short name of the option or null if not used.</param> + <param name="longName">The long name of the option or null if not used.</param> + </member> + <member name="T:CommandLine.OptionAttribute"> + <summary> + Models an option specification. + </summary> + </member> + <member name="M:CommandLine.OptionAttribute.#ctor(System.String,System.String)"> + <summary> + Initializes a new instance of the <see cref="T:CommandLine.OptionAttribute" /> class. + </summary> + <param name="shortName">The short name of the option or null if not used.</param> + <param name="longName">The long name of the option or null if not used.</param> + </member> + <member name="P:CommandLine.OptionAttribute.MutuallyExclusiveSet"> + <summary> + Gets or sets the option's mutually exclusive set. + </summary> + </member> + <member name="T:CommandLine.OptionListAttribute"> + <summary> + Models an option that can accept multiple values. + Must be applied to a field compatible with an <see cref="!:System.Collections.Generic.IList<T>" /> interface + of <see cref="T:System.String" /> instances. + </summary> + </member> + <member name="M:CommandLine.OptionListAttribute.#ctor(System.String,System.String)"> + <summary> + Initializes a new instance of the <see cref="T:CommandLine.OptionListAttribute" /> class. + </summary> + <param name="shortName">The short name of the option or null if not used.</param> + <param name="longName">The long name of the option or null if not used.</param> + </member> + <member name="M:CommandLine.OptionListAttribute.#ctor(System.String,System.String,System.Char)"> + <summary> + Initializes a new instance of the <see cref="T:CommandLine.OptionListAttribute" /> class. + </summary> + <param name="shortName">The short name of the option or null if not used.</param> + <param name="longName">The long name of the option or null if not used.</param> + <param name="separator">Values separator character.</param> + </member> + <member name="P:CommandLine.OptionListAttribute.Separator"> + <summary> + Gets or sets the values separator character. + </summary> + </member> + <member name="T:CommandLine.ValueListAttribute"> + <summary> + Models a list of command line arguments that are not options. + Must be applied to a field compatible with an <see cref="!:System.Collections.Generic.IList<T>" /> interface + of <see cref="T:System.String" /> instances. + </summary> + </member> + <member name="M:CommandLine.ValueListAttribute.#ctor(System.Type)"> + <summary> + Initializes a new instance of the <see cref="T:CommandLine.ValueListAttribute" /> class. + </summary> + <param name="concreteType">A type that implements <see cref="!:System.Collections.Generic.IList<T>" />.</param> + <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="concreteType" /> is null.</exception> + </member> + <member name="P:CommandLine.ValueListAttribute.MaximumElements"> + <summary> + Gets or sets the maximum element allow for the list managed by <see cref="T:CommandLine.ValueListAttribute" /> type. + If lesser than 0, no upper bound is fixed. + If equal to 0, no elements are allowed. + </summary> + </member> + <member name="T:CommandLine.BadOptionInfo"> + <summary> + Models a bad parsed option. + </summary> + </member> + <member name="P:CommandLine.BadOptionInfo.ShortName"> + <summary> + The short name of the option + </summary> + <value>Returns the short name of the option.</value> + </member> + <member name="P:CommandLine.BadOptionInfo.LongName"> + <summary> + The long name of the option + </summary> + <value>Returns the long name of the option.</value> + </member> + <member name="T:CommandLine.ParsingError"> + <summary> + Models a parsing error. + </summary> + </member> + <member name="P:CommandLine.ParsingError.BadOption"> + <summary> + Gets or a the bad parsed option. + </summary> + <value> + The bad option. + </value> + </member> + <member name="P:CommandLine.ParsingError.ViolatesRequired"> + <summary> + Gets or sets a value indicating whether this <see cref="T:CommandLine.ParsingError" /> violates required. + </summary> + <value> + <c>true</c> if violates required; otherwise, <c>false</c>. + </value> + </member> + <member name="P:CommandLine.ParsingError.ViolatesFormat"> + <summary> + Gets or sets a value indicating whether this <see cref="T:CommandLine.ParsingError" /> violates format. + </summary> + <value> + <c>true</c> if violates format; otherwise, <c>false</c>. + </value> + </member> + <member name="P:CommandLine.ParsingError.ViolatesMutualExclusiveness"> + <summary> + Gets or sets a value indicating whether this <see cref="T:CommandLine.ParsingError" /> violates mutual exclusiveness. + </summary> + <value> + <c>true</c> if violates mutual exclusiveness; otherwise, <c>false</c>. + </value> + </member> + <member name="T:CommandLine.PostParsingState"> + <summary> + Models a type that records the parser state afeter parsing. + </summary> + </member> + <member name="P:CommandLine.PostParsingState.Errors"> + <summary> + Gets a list of parsing errors. + </summary> + <value> + Parsing errors. + </value> + </member> + <member name="T:CommandLine.ICommandLineParser"> + <summary> + Defines a basic interface to parse command line arguments. + </summary> + </member> + <member name="M:CommandLine.ICommandLineParser.ParseArguments(System.String[],System.Object)"> + <summary> + Parses a <see cref="T:System.String" /> array of command line arguments, setting values in <paramref name="options" /> + parameter instance's public fields decorated with appropriate attributes. + </summary> + <param name="args">A <see cref="T:System.String" /> array of command line arguments.</param> + <param name="options">An object's instance used to receive values. + Parsing rules are defined using <see cref="T:CommandLine.BaseOptionAttribute" /> derived types.</param> + <returns>True if parsing process succeed.</returns> + <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="args" /> is null.</exception> + <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="options" /> is null.</exception> + </member> + <member name="M:CommandLine.ICommandLineParser.ParseArguments(System.String[],System.Object,System.IO.TextWriter)"> + <summary> + Parses a <see cref="T:System.String" /> array of command line arguments, setting values in <paramref name="options" /> + parameter instance's public fields decorated with appropriate attributes. + This overload allows you to specify a <see cref="T:System.IO.TextWriter" /> derived instance for write text messages. + </summary> + <param name="args">A <see cref="T:System.String" /> array of command line arguments.</param> + <param name="options">An object's instance used to receive values. + Parsing rules are defined using <see cref="T:CommandLine.BaseOptionAttribute" /> derived types.</param> + <param name="helpWriter">Any instance derived from <see cref="T:System.IO.TextWriter" />, + usually <see cref="P:System.Console.Error" />. Setting this argument to null, will disable help screen.</param> + <returns>True if parsing process succeed.</returns> + <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="args" /> is null.</exception> + <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="options" /> is null.</exception> + </member> + <member name="T:CommandLine.CommandLineOptionsBase"> + <summary> + Provides the abstract base class for a strongly typed options target. Used when you need to get parsing errors. + </summary> + </member> + <member name="T:CommandLine.CommandLineParserException"> + <summary> + This exception is thrown when a generic parsing error occurs. + </summary> + </member> + <member name="T:CommandLine.CommandLineParserSettings"> + <summary> + Specifies a set of features to configure a <see cref="T:CommandLine.CommandLineParser" /> behavior. + </summary> + </member> + <member name="M:CommandLine.CommandLineParserSettings.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:CommandLine.CommandLineParserSettings" /> class. + </summary> + </member> + <member name="M:CommandLine.CommandLineParserSettings.#ctor(System.Boolean)"> + <summary> + Initializes a new instance of the <see cref="T:CommandLine.CommandLineParserSettings" /> class, + setting the case comparison behavior. + </summary> + <param name="caseSensitive">If set to true, parsing will be case sensitive.</param> + </member> + <member name="M:CommandLine.CommandLineParserSettings.#ctor(System.IO.TextWriter)"> + <summary> + Initializes a new instance of the <see cref="T:CommandLine.CommandLineParserSettings" /> class, + setting the <see cref="T:System.IO.TextWriter" /> used for help method output. + </summary> + <param name="helpWriter">Any instance derived from <see cref="T:System.IO.TextWriter" />, + default <see cref="P:System.Console.Error" />. Setting this argument to null, will disable help screen.</param> + </member> + <member name="M:CommandLine.CommandLineParserSettings.#ctor(System.Boolean,System.IO.TextWriter)"> + <summary> + Initializes a new instance of the <see cref="T:CommandLine.CommandLineParserSettings" /> class, + setting case comparison and help output options. + </summary> + <param name="caseSensitive">If set to true, parsing will be case sensitive.</param> + <param name="helpWriter">Any instance derived from <see cref="T:System.IO.TextWriter" />, + default <see cref="P:System.Console.Error" />. Setting this argument to null, will disable help screen.</param> + </member> + <member name="M:CommandLine.CommandLineParserSettings.#ctor(System.Boolean,System.Boolean)"> + <summary> + Initializes a new instance of the <see cref="T:CommandLine.CommandLineParserSettings" /> class, + setting case comparison and mutually exclusive behaviors. + </summary> + <param name="caseSensitive">If set to true, parsing will be case sensitive.</param> + <param name="mutuallyExclusive">If set to true, enable mutually exclusive behavior.</param> + </member> + <member name="M:CommandLine.CommandLineParserSettings.#ctor(System.Boolean,System.Boolean,System.IO.TextWriter)"> + <summary> + Initializes a new instance of the <see cref="T:CommandLine.CommandLineParserSettings" /> class, + setting case comparison, mutually exclusive behavior and help output option. + </summary> + <param name="caseSensitive">If set to true, parsing will be case sensitive.</param> + <param name="mutuallyExclusive">If set to true, enable mutually exclusive behavior.</param> + <param name="helpWriter">Any instance derived from <see cref="T:System.IO.TextWriter" />, + default <see cref="P:System.Console.Error" />. Setting this argument to null, will disable help screen.</param> + </member> + <member name="M:CommandLine.CommandLineParserSettings.#ctor(System.Boolean,System.Boolean,System.Boolean,System.IO.TextWriter)"> + <summary> + Initializes a new instance of the <see cref="T:CommandLine.CommandLineParserSettings" /> class, + setting case comparison, mutually exclusive behavior and help output option. + </summary> + <param name="caseSensitive">If set to true, parsing will be case sensitive.</param> + <param name="mutuallyExclusive">If set to true, enable mutually exclusive behavior.</param> + <param name="ignoreUnknownArguments">If set to true, allow the parser to skip unknown argument, otherwise return a parse failure</param> + <param name="helpWriter">Any instance derived from <see cref="T:System.IO.TextWriter" />, + default <see cref="P:System.Console.Error" />. Setting this argument to null, will disable help screen.</param> + </member> + <member name="P:CommandLine.CommandLineParserSettings.CaseSensitive"> + <summary> + Gets or sets the case comparison behavior. + Default is set to true. + </summary> + </member> + <member name="P:CommandLine.CommandLineParserSettings.MutuallyExclusive"> + <summary> + Gets or sets the mutually exclusive behavior. + Default is set to false. + </summary> + </member> + <member name="P:CommandLine.CommandLineParserSettings.HelpWriter"> + <summary> + Gets or sets the <see cref="T:System.IO.TextWriter" /> used for help method output. + Setting this property to null, will disable help screen. + </summary> + </member> + <member name="P:CommandLine.CommandLineParserSettings.IgnoreUnknownArguments"> + <summary> + Gets or sets a value indicating if the parser shall move on to the next argument and ignore the given argument if it + encounter an unknown arguments + </summary> + <value> + <c>true</c> to allow parsing the arguments with differents class options that do not have all the arguments. + </value> + <remarks> + This allows fragmented version class parsing, useful for project with addon where addons also requires command line arguments but + when these are unknown by the main program at build time. + </remarks> + </member> + <member name="T:CommandLine.CommandLineParser"> + <summary> + Provides methods to parse command line arguments. + Default implementation for <see cref="T:CommandLine.ICommandLineParser" />. + </summary> + </member> + <member name="M:CommandLine.CommandLineParser.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:CommandLine.CommandLineParser" /> class. + </summary> + </member> + <member name="M:CommandLine.CommandLineParser.#ctor(CommandLine.CommandLineParserSettings)"> + <summary> + Initializes a new instance of the <see cref="T:CommandLine.CommandLineParser" /> class, + configurable with a <see cref="T:CommandLine.CommandLineParserSettings" /> object. + </summary> + <param name="settings">The <see cref="T:CommandLine.CommandLineParserSettings" /> object is used to configure + aspects and behaviors of the parser.</param> + </member> + <member name="P:CommandLine.CommandLineParser.Default"> + <summary> + Singleton instance created with basic defaults. + </summary> + </member> + <member name="M:CommandLine.CommandLineParser.ParseArguments(System.String[],System.Object)"> + <summary> + Parses a <see cref="T:System.String" /> array of command line arguments, setting values in <paramref name="options" /> + parameter instance's public fields decorated with appropriate attributes. + </summary> + <param name="args">A <see cref="T:System.String" /> array of command line arguments.</param> + <param name="options">An object's instance used to receive values. + Parsing rules are defined using <see cref="T:CommandLine.BaseOptionAttribute" /> derived types.</param> + <returns>True if parsing process succeed.</returns> + <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="args" /> is null.</exception> + <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="options" /> is null.</exception> + </member> + <member name="M:CommandLine.CommandLineParser.ParseArguments(System.String[],System.Object,System.IO.TextWriter)"> + <summary> + Parses a <see cref="T:System.String" /> array of command line arguments, setting values in <paramref name="options" /> + parameter instance's public fields decorated with appropriate attributes. + This overload allows you to specify a <see cref="T:System.IO.TextWriter" /> derived instance for write text messages. + </summary> + <param name="args">A <see cref="T:System.String" /> array of command line arguments.</param> + <param name="options">An object's instance used to receive values. + Parsing rules are defined using <see cref="T:CommandLine.BaseOptionAttribute" /> derived types.</param> + <param name="helpWriter">Any instance derived from <see cref="T:System.IO.TextWriter" />, + usually <see cref="P:System.Console.Error" />. Setting this argument to null, will disable help screen.</param> + <returns>True if parsing process succeed.</returns> + <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="args" /> is null.</exception> + <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="options" /> is null.</exception> + </member> + <member name="T:CommandLine.Text.BaseSentenceBuilder"> + <summary> + Models an abstract sentence builder. + </summary> + </member> + <member name="P:CommandLine.Text.BaseSentenceBuilder.OptionWord"> + <summary> + Gets a string containing word 'option'. + </summary> + <value> + The word 'option'. + </value> + </member> + <member name="P:CommandLine.Text.BaseSentenceBuilder.AndWord"> + <summary> + Gets a string containing the word 'and'. + </summary> + <value> + The word 'and'. + </value> + </member> + <member name="P:CommandLine.Text.BaseSentenceBuilder.RequiredOptionMissingText"> + <summary> + Gets a string containing the sentence 'required option missing'. + </summary> + <value> + The sentence 'required option missing'. + </value> + </member> + <member name="P:CommandLine.Text.BaseSentenceBuilder.ViolatesFormatText"> + <summary> + Gets a string containing the sentence 'violates format'. + </summary> + <value> + The sentence 'violates format'. + </value> + </member> + <member name="P:CommandLine.Text.BaseSentenceBuilder.ViolatesMutualExclusivenessText"> + <summary> + Gets a string containing the sentence 'violates mutual exclusiveness'. + </summary> + <value> + The sentence 'violates mutual exclusiveness'. + </value> + </member> + <member name="P:CommandLine.Text.BaseSentenceBuilder.ErrorsHeadingText"> + <summary> + Gets a string containing the error heading text. + </summary> + <value> + The error heading text. + </value> + </member> + <member name="M:CommandLine.Text.BaseSentenceBuilder.CreateBuiltIn"> + <summary> + Creates the built in sentence builder. + </summary> + <returns> + The built in sentence builder. + </returns> + </member> + <member name="T:CommandLine.Text.EnglishSentenceBuilder"> + <summary> + Models an english sentence builder, currently the default one. + </summary> + </member> + <member name="P:CommandLine.Text.EnglishSentenceBuilder.OptionWord"> + <summary> + Gets a string containing word 'option' in english. + </summary> + <value> + The word 'option' in english. + </value> + </member> + <member name="P:CommandLine.Text.EnglishSentenceBuilder.AndWord"> + <summary> + Gets a string containing the word 'and' in english. + </summary> + <value> + The word 'and' in english. + </value> + </member> + <member name="P:CommandLine.Text.EnglishSentenceBuilder.RequiredOptionMissingText"> + <summary> + Gets a string containing the sentence 'required option missing' in english. + </summary> + <value> + The sentence 'required option missing' in english. + </value> + </member> + <member name="P:CommandLine.Text.EnglishSentenceBuilder.ViolatesFormatText"> + <summary> + Gets a string containing the sentence 'violates format' in english. + </summary> + <value> + The sentence 'violates format' in english. + </value> + </member> + <member name="P:CommandLine.Text.EnglishSentenceBuilder.ViolatesMutualExclusivenessText"> + <summary> + Gets a string containing the sentence 'violates mutual exclusiveness' in english. + </summary> + <value> + The sentence 'violates mutual exclusiveness' in english. + </value> + </member> + <member name="P:CommandLine.Text.EnglishSentenceBuilder.ErrorsHeadingText"> + <summary> + Gets a string containing the error heading text in english. + </summary> + <value> + The error heading text in english. + </value> + </member> + <member name="T:CommandLine.Text.CopyrightInfo"> + <summary> + Models the copyright informations part of an help text. + You can assign it where you assign any <see cref="T:System.String" /> instance. + </summary> + </member> + <member name="M:CommandLine.Text.CopyrightInfo.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:CommandLine.Text.CopyrightInfo" /> class. + </summary> + </member> + <member name="M:CommandLine.Text.CopyrightInfo.#ctor(System.String,System.Int32)"> + <summary> + Initializes a new instance of the <see cref="T:CommandLine.Text.CopyrightInfo" /> class + specifying author and year. + </summary> + <param name="author">The company or person holding the copyright.</param> + <param name="year">The year of coverage of copyright.</param> + <exception cref="T:System.ArgumentException">Thrown when parameter <paramref name="author" /> is null or empty string.</exception> + </member> + <member name="M:CommandLine.Text.CopyrightInfo.#ctor(System.String,System.Int32[])"> + <summary> + Initializes a new instance of the <see cref="T:CommandLine.Text.CopyrightInfo" /> class + specifying author and years. + </summary> + <param name="author">The company or person holding the copyright.</param> + <param name="years">The years of coverage of copyright.</param> + <exception cref="T:System.ArgumentException">Thrown when parameter <paramref name="author" /> is null or empty string.</exception> + <exception cref="T:System.ArgumentOutOfRangeException">Thrown when parameter <paramref name="years" /> is not supplied.</exception> + </member> + <member name="M:CommandLine.Text.CopyrightInfo.#ctor(System.Boolean,System.String,System.Int32[])"> + <summary> + Initializes a new instance of the <see cref="T:CommandLine.Text.CopyrightInfo" /> class + specifying symbol case, author and years. + </summary> + <param name="isSymbolUpper">The case of the copyright symbol.</param> + <param name="author">The company or person holding the copyright.</param> + <param name="years">The years of coverage of copyright.</param> + <exception cref="T:System.ArgumentException">Thrown when parameter <paramref name="author" /> is null or empty string.</exception> + <exception cref="T:System.ArgumentOutOfRangeException">Thrown when parameter <paramref name="years" /> is not supplied.</exception> + </member> + <member name="P:CommandLine.Text.CopyrightInfo.CopyrightWord"> + <summary> + When overridden in a derived class, allows to specify a different copyright word. + </summary> + </member> + <member name="M:CommandLine.Text.CopyrightInfo.ToString"> + <summary> + Returns the copyright informations as a <see cref="T:System.String" />. + </summary> + <returns>The <see cref="T:System.String" /> that contains the copyright informations.</returns> + </member> + <member name="M:CommandLine.Text.CopyrightInfo.FormatYears(System.Int32[])"> + <summary> + When overridden in a derived class, allows to specify a new algorithm to render copyright years + as a <see cref="T:System.String" /> instance. + </summary> + <param name="years">A <see cref="T:System.Int32" /> array of years.</param> + <returns>A <see cref="T:System.String" /> instance with copyright years.</returns> + </member> + <member name="M:CommandLine.Text.CopyrightInfo.op_Implicit(CommandLine.Text.CopyrightInfo)~System.String"> + <summary> + Converts the copyright informations to a <see cref="T:System.String" />. + </summary> + <param name="info">This <see cref="T:CommandLine.Text.CopyrightInfo" /> instance.</param> + <returns>The <see cref="T:System.String" /> that contains the copyright informations.</returns> + </member> + <member name="T:CommandLine.Text.HeadingInfo"> + <summary> + Models the heading informations part of an help text. + You can assign it where you assign any <see cref="T:System.String" /> instance. + </summary> + </member> + <member name="M:CommandLine.Text.HeadingInfo.#ctor(System.String)"> + <summary> + Initializes a new instance of the <see cref="T:CommandLine.Text.HeadingInfo" /> class + specifying program name. + </summary> + <param name="programName">The name of the program.</param> + <exception cref="T:System.ArgumentException">Thrown when parameter <paramref name="programName" /> is null or empty string.</exception> + </member> + <member name="M:CommandLine.Text.HeadingInfo.#ctor(System.String,System.String)"> + <summary> + Initializes a new instance of the <see cref="T:CommandLine.Text.HeadingInfo" /> class + specifying program name and version. + </summary> + <param name="programName">The name of the program.</param> + <param name="version">The version of the program.</param> + <exception cref="T:System.ArgumentException">Thrown when parameter <paramref name="programName" /> is null or empty string.</exception> + </member> + <member name="M:CommandLine.Text.HeadingInfo.ToString"> + <summary> + Returns the heading informations as a <see cref="T:System.String" />. + </summary> + <returns>The <see cref="T:System.String" /> that contains the heading informations.</returns> + </member> + <member name="M:CommandLine.Text.HeadingInfo.WriteMessage(System.String,System.IO.TextWriter)"> + <summary> + Writes out a string and a new line using the program name specified in the constructor + and <paramref name="message" /> parameter. + </summary> + <param name="message">The <see cref="T:System.String" /> message to write.</param> + <param name="writer">The target <see cref="T:System.IO.TextWriter" /> derived type.</param> + <exception cref="T:System.ArgumentException">Thrown when parameter <paramref name="message" /> is null or empty string.</exception> + <exception cref="T:System.ArgumentNullException">Thrown when parameter <paramref name="writer" /> is null.</exception> + </member> + <member name="M:CommandLine.Text.HeadingInfo.WriteMessage(System.String)"> + <summary> + Writes out a string and a new line using the program name specified in the constructor + and <paramref name="message" /> parameter to standard output stream. + </summary> + <param name="message">The <see cref="T:System.String" /> message to write.</param> + <exception cref="T:System.ArgumentException">Thrown when parameter <paramref name="message" /> is null or empty string.</exception> + </member> + <member name="M:CommandLine.Text.HeadingInfo.WriteError(System.String)"> + <summary> + Writes out a string and a new line using the program name specified in the constructor + and <paramref name="message" /> parameter to standard error stream. + </summary> + <param name="message">The <see cref="T:System.String" /> message to write.</param> + <exception cref="T:System.ArgumentException">Thrown when parameter <paramref name="message" /> is null or empty string.</exception> + </member> + <member name="M:CommandLine.Text.HeadingInfo.op_Implicit(CommandLine.Text.HeadingInfo)~System.String"> + <summary> + Converts the heading informations to a <see cref="T:System.String" />. + </summary> + <param name="info">This <see cref="T:CommandLine.Text.HeadingInfo" /> instance.</param> + <returns>The <see cref="T:System.String" /> that contains the heading informations.</returns> + </member> + <member name="T:CommandLine.Text.HandleParsingErrorsDelegate"> + <summary> + Handle parsing errors delegate. + </summary> + </member> + <member name="T:CommandLine.Text.FormatOptionHelpTextEventArgs"> + <summary> + Provides data for the FormatOptionHelpText event. + </summary> + </member> + <member name="M:CommandLine.Text.FormatOptionHelpTextEventArgs.#ctor(CommandLine.BaseOptionAttribute)"> + <summary> + Initializes a new instance of the <see cref="T:CommandLine.Text.FormatOptionHelpTextEventArgs" /> class. + </summary> + <param name="option">Option to format.</param> + </member> + <member name="P:CommandLine.Text.FormatOptionHelpTextEventArgs.Option"> + <summary> + Gets the option to format. + </summary> + </member> + <member name="T:CommandLine.Text.HelpText"> + <summary> + Models an help text and collects related informations. + You can assign it in place of a <see cref="T:System.String" /> instance. + </summary> + </member> + <member name="M:CommandLine.Text.HelpText.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:CommandLine.Text.HelpText" /> class. + </summary> + </member> + <member name="M:CommandLine.Text.HelpText.#ctor(CommandLine.Text.BaseSentenceBuilder)"> + <summary> + Initializes a new instance of the <see cref="T:CommandLine.Text.HelpText" /> class + specifying the sentence builder. + </summary> + <param name="sentenceBuilder"> + A <see cref="T:CommandLine.Text.BaseSentenceBuilder" /> instance. + </param> + </member> + <member name="M:CommandLine.Text.HelpText.#ctor(System.String)"> + <summary> + Initializes a new instance of the <see cref="T:CommandLine.Text.HelpText" /> class + specifying heading informations. + </summary> + <param name="heading">A string with heading information or + an instance of <see cref="T:CommandLine.Text.HeadingInfo" />.</param> + <exception cref="T:System.ArgumentException">Thrown when parameter <paramref name="heading" /> is null or empty string.</exception> + </member> + <member name="M:CommandLine.Text.HelpText.#ctor(CommandLine.Text.BaseSentenceBuilder,System.String)"> + <summary> + Initializes a new instance of the <see cref="T:CommandLine.Text.HelpText" /> class + specifying the sentence builder and heading informations. + </summary> + <param name="sentenceBuilder"> + A <see cref="T:CommandLine.Text.BaseSentenceBuilder" /> instance. + </param> + <param name="heading"> + A string with heading information or + an instance of <see cref="T:CommandLine.Text.HeadingInfo" />. + </param> + </member> + <member name="M:CommandLine.Text.HelpText.#ctor(System.String,System.String)"> + <summary> + Initializes a new instance of the <see cref="T:CommandLine.Text.HelpText" /> class + specifying heading and copyright informations. + </summary> + <param name="heading">A string with heading information or + an instance of <see cref="T:CommandLine.Text.HeadingInfo" />.</param> + <param name="copyright">A string with copyright information or + an instance of <see cref="T:CommandLine.Text.CopyrightInfo" />.</param> + <exception cref="T:System.ArgumentException">Thrown when one or more parameters <paramref name="heading" /> are null or empty strings.</exception> + </member> + <member name="M:CommandLine.Text.HelpText.#ctor(System.String,System.String,System.Object)"> + <summary> + Initializes a new instance of the <see cref="T:CommandLine.Text.HelpText" /> class + specifying heading and copyright informations. + </summary> + <param name="heading">A string with heading information or + an instance of <see cref="T:CommandLine.Text.HeadingInfo" />.</param> + <param name="copyright">A string with copyright information or + an instance of <see cref="T:CommandLine.Text.CopyrightInfo" />.</param> + <param name="options">The instance that collected command line arguments parsed with <see cref="T:CommandLine.CommandLineParser" /> class.</param> + <exception cref="T:System.ArgumentException">Thrown when one or more parameters <paramref name="heading" /> are null or empty strings.</exception> + </member> + <member name="T:CommandLine.Text.HelpText.MessageEnum"> + <summary> + Message type enumeration. + </summary> + </member> + <member name="F:CommandLine.Text.HelpText.MessageEnum.ParsingErrorViolatesFormat"> + <summary> + Parsing error due to a violation of the format of an option value. + </summary> + </member> + <member name="F:CommandLine.Text.HelpText.MessageEnum.ParsingErrorViolatesRequired"> + <summary> + Parsing error due to a violation of mandatory option. + </summary> + </member> + <member name="F:CommandLine.Text.HelpText.MessageEnum.ParsingErrorViolatesExclusiveness"> + <summary> + Parsing error due to a violation of the mutual exclusiveness of two or more option. + </summary> + </member> + <member name="E:CommandLine.Text.HelpText.FormatOptionHelpText"> + <summary> + Occurs when an option help text is formatted. + </summary> + </member> + <member name="P:CommandLine.Text.HelpText.Heading"> + <summary> + Sets the heading information string. + You can directly assign a <see cref="T:CommandLine.Text.HeadingInfo" /> instance. + </summary> + </member> + <member name="P:CommandLine.Text.HelpText.Copyright"> + <summary> + Sets the copyright information string. + You can directly assign a <see cref="T:CommandLine.Text.CopyrightInfo" /> instance. + </summary> + </member> + <member name="P:CommandLine.Text.HelpText.MaximumDisplayWidth"> + <summary> + Gets or sets the maximum width of the display. This determines word wrap when displaying the text. + </summary> + <value>The maximum width of the display.</value> + </member> + <member name="P:CommandLine.Text.HelpText.AddDashesToOption"> + <summary> + Gets or sets the format of options for adding or removing dashes. + It modifies behavior of <see cref="M:CommandLine.Text.HelpText.AddOptions(System.Object)" /> method. + </summary> + </member> + <member name="P:CommandLine.Text.HelpText.AdditionalNewLineAfterOption"> + <summary> + Gets or sets whether to add an additional line after the description of the option. + </summary> + </member> + <member name="M:CommandLine.Text.HelpText.AutoBuild(System.Object)"> + <summary> + Creates a new instance of the <see cref="T:CommandLine.Text.HelpText" /> class using common defaults. + </summary> + <returns> + An instance of <see cref="T:CommandLine.Text.HelpText" /> class. + </returns> + <param name="options"> + The instance that collected command line arguments parsed with <see cref="T:CommandLine.CommandLineParser" /> class. + </param> + </member> + <member name="M:CommandLine.Text.HelpText.AutoBuild(System.Object,CommandLine.Text.HandleParsingErrorsDelegate)"> + <summary> + Creates a new instance of the <see cref="T:CommandLine.Text.HelpText" /> class using common defaults. + </summary> + <returns> + An instance of <see cref="T:CommandLine.Text.HelpText" /> class. + </returns> + <param name="options"> + The instance that collected command line arguments parsed with <see cref="T:CommandLine.CommandLineParser" /> class. + </param> + <param name="errDelegate"> + A delegate used to customize the text block for reporting parsing errors. + </param> + </member> + <member name="M:CommandLine.Text.HelpText.AddPreOptionsLine(System.String)"> + <summary> + Adds a text line after copyright and before options usage informations. + </summary> + <param name="value">A <see cref="T:System.String" /> instance.</param> + <exception cref="T:System.ArgumentNullException">Thrown when parameter <paramref name="value" /> is null or empty string.</exception> + </member> + <member name="M:CommandLine.Text.HelpText.AddPostOptionsLine(System.String)"> + <summary> + Adds a text line at the bottom, after options usage informations. + </summary> + <param name="value">A <see cref="T:System.String" /> instance.</param> + <exception cref="T:System.ArgumentNullException">Thrown when parameter <paramref name="value" /> is null or empty string.</exception> + </member> + <member name="M:CommandLine.Text.HelpText.AddOptions(System.Object)"> + <summary> + Adds a text block with options usage informations. + </summary> + <param name="options">The instance that collected command line arguments parsed with <see cref="T:CommandLine.CommandLineParser" /> class.</param> + <exception cref="T:System.ArgumentNullException">Thrown when parameter <paramref name="options" /> is null.</exception> + </member> + <member name="M:CommandLine.Text.HelpText.AddOptions(System.Object,System.String)"> + <summary> + Adds a text block with options usage informations. + </summary> + <param name="options">The instance that collected command line arguments parsed with the <see cref="T:CommandLine.CommandLineParser" /> class.</param> + <param name="requiredWord">The word to use when the option is required.</param> + <exception cref="T:System.ArgumentNullException">Thrown when parameter <paramref name="options" /> is null.</exception> + <exception cref="T:System.ArgumentNullException">Thrown when parameter <paramref name="requiredWord" /> is null or empty string.</exception> + </member> + <member name="M:CommandLine.Text.HelpText.AddOptions(System.Object,System.String,System.Int32)"> + <summary> + Adds a text block with options usage informations. + </summary> + <param name="options">The instance that collected command line arguments parsed with the <see cref="T:CommandLine.CommandLineParser" /> class.</param> + <param name="requiredWord">The word to use when the option is required.</param> + <param name="maximumLength">The maximum length of the help documentation.</param> + <exception cref="T:System.ArgumentNullException">Thrown when parameter <paramref name="options" /> is null.</exception> + <exception cref="T:System.ArgumentNullException">Thrown when parameter <paramref name="requiredWord" /> is null or empty string.</exception> + </member> + <member name="M:CommandLine.Text.HelpText.RenderParsingErrorsText(CommandLine.CommandLineOptionsBase,System.Int32)"> + <summary> + Builds a string that contains a parsing error message. + </summary> + <param name="options"> + An options target <see cref="T:CommandLine.CommandLineOptionsBase" /> instance that collected command line arguments parsed with the <see cref="T:CommandLine.CommandLineParser" /> class. + </param> + <returns> + The <see cref="T:System.String" /> that contains the parsing error message. + </returns> + </member> + <member name="M:CommandLine.Text.HelpText.ToString"> + <summary> + Returns the help informations as a <see cref="T:System.String" />. + </summary> + <returns>The <see cref="T:System.String" /> that contains the help informations.</returns> + </member> + <member name="M:CommandLine.Text.HelpText.op_Implicit(CommandLine.Text.HelpText)~System.String"> + <summary> + Converts the help informations to a <see cref="T:System.String" />. + </summary> + <param name="info">This <see cref="T:CommandLine.Text.HelpText" /> instance.</param> + <returns>The <see cref="T:System.String" /> that contains the help informations.</returns> + </member> + </members> +</doc> Index: DamClients/DamUI/trunk/release/Install_Version/gdal_csharp.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.DamEngine.Io.pdb =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/DotSpatial.Serialization.xml =================================================================== diff -u --- DamClients/DamUI/trunk/release/Install_Version/DotSpatial.Serialization.xml (revision 0) +++ DamClients/DamUI/trunk/release/Install_Version/DotSpatial.Serialization.xml (revision 2315) @@ -0,0 +1,829 @@ +<?xml version="1.0"?> +<doc> + <assembly> + <name>DotSpatial.Serialization</name> + </assembly> + <members> + <member name="T:DotSpatial.Serialization.AssemblyMissingException"> + <summary> + This exception will occur if an assembly referenced by a saved map layer could not be found. + </summary> + </member> + <member name="M:DotSpatial.Serialization.AssemblyMissingException.#ctor(System.String)"> + <summary> + Initializes a new instance of the AssemblyMissingException. + </summary> + <param name="message">The string message to show as the error.</param> + </member> + <member name="M:DotSpatial.Serialization.AssemblyMissingException.#ctor(System.String,System.Exception)"> + <summary> + Initializes a new instance of the AssemblyMissingException. + </summary> + <param name="message">The string message to show as the error.</param> + <param name="innerException">The inner exception to send as part of this exception.</param> + </member> + <member name="M:DotSpatial.Serialization.AssemblyMissingException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> + <summary> + Initializes a new instance of the AssemblyMissingException. + </summary> + <param name="info">The SerializationInfo that holds the information about the serialized object about the exception being thrown.</param> + <param name="context">The StreamingContext that contains contextual information about the source or destination.</param> + </member> + <member name="T:DotSpatial.Serialization.BaseCollection`1"> + <summary> + BaseCollection + </summary> + </member> + <member name="F:DotSpatial.Serialization.BaseCollection`1._innerList"> + <summary> + Private storage for the inner list. + </summary> + </member> + <member name="M:DotSpatial.Serialization.BaseCollection`1.Add(`0)"> + <summary> + Adds an item to this base collection + </summary> + <param name="item"></param> + </member> + <member name="M:DotSpatial.Serialization.BaseCollection`1.Contains(`0)"> + <summary> + A boolean that is true if this set contains the specified item + </summary> + <param name="item"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Serialization.BaseCollection`1.CopyTo(`0[],System.Int32)"> + <summary> + Copies the items from this collection to the specified array + </summary> + <param name="array">The array to copy to</param> + <param name="arrayIndex">The zero based integer array index to start copying to</param> + </member> + <member name="M:DotSpatial.Serialization.BaseCollection`1.Move(`0,System.Int32)"> + <summary> + Moves the given item to the new position. + </summary> + <param name="item">Item that gets moved.</param> + <param name="newPosition">Position the item is moved to.</param> + </member> + <member name="M:DotSpatial.Serialization.BaseCollection`1.Remove(`0)"> + <summary> + Removes the specified item from the collection + </summary> + <param name="item">The item to remove from the collection</param> + <returns>Boolean, true if the remove operation is successful. </returns> + </member> + <member name="M:DotSpatial.Serialization.BaseCollection`1.GetEnumerator"> + <summary> + Returns a type specific enumerator + </summary> + <returns></returns> + </member> + <member name="M:DotSpatial.Serialization.BaseCollection`1.Clear"> + <summary> + Clears the list + </summary> + </member> + <member name="M:DotSpatial.Serialization.BaseCollection`1.OnInnerListSet"> + <summary> + After serialization, the inner list is directly set. This is uzed by the FeatureLayer, for instance, + to apply the new scheme. + </summary> + </member> + <member name="M:DotSpatial.Serialization.BaseCollection`1.OnClear"> + <summary> + Clears this collection + </summary> + </member> + <member name="M:DotSpatial.Serialization.BaseCollection`1.OnInsert(System.Int32,System.Object)"> + <summary> + Occurs when items are inserted + </summary> + <param name="index"></param> + <param name="value"></param> + </member> + <member name="M:DotSpatial.Serialization.BaseCollection`1.OnInsertComplete(System.Int32,System.Object)"> + <summary> + Occurs after a new item has been inserted, and fires IncludeComplete + </summary> + <param name="index"></param> + <param name="value"></param> + </member> + <member name="M:DotSpatial.Serialization.BaseCollection`1.OnRemoveComplete(System.Int32,System.Object)"> + <summary> + Fires after the remove operation, ensuring that OnExclude gets called + </summary> + <param name="index"></param> + <param name="value"></param> + </member> + <member name="M:DotSpatial.Serialization.BaseCollection`1.OnSet(System.Int32,System.Object,System.Object)"> + <summary> + Fires before the set operation ensuring the new item is included if necessary + </summary> + <param name="index"></param> + <param name="oldValue"></param> + <param name="newValue"></param> + </member> + <member name="M:DotSpatial.Serialization.BaseCollection`1.OnSetComplete(System.Int32,System.Object,System.Object)"> + <summary> + Fires after the set operation, ensuring that the item is removed + </summary> + <param name="index"></param> + <param name="oldValue"></param> + <param name="newValue"></param> + </member> + <member name="M:DotSpatial.Serialization.BaseCollection`1.OnInclude(`0)"> + <summary> + Occurs any time an item is added or inserted into the collection + and did not previously exist in the collection + </summary> + <param name="item"></param> + </member> + <member name="M:DotSpatial.Serialization.BaseCollection`1.OnMoved(`0,System.Int32)"> + <summary> + Occurs whenever a layer is moved. + </summary> + <param name="item">Layer that is moved.</param> + <param name="newPosition">Position the layer is moved to.</param> + </member> + <member name="M:DotSpatial.Serialization.BaseCollection`1.OnIncludeComplete(`0)"> + <summary> + Occurs after the item has been included either by set, insert, or addition. + </summary> + <param name="item"></param> + </member> + <member name="M:DotSpatial.Serialization.BaseCollection`1.OnExclude(`0)"> + <summary> + Occurs any time an item is removed from the collection and no longer + exists anywhere in the collection + </summary> + <param name="item"></param> + </member> + <member name="M:DotSpatial.Serialization.BaseCollection`1.Include(`0)"> + <summary> + Includes the specified item. This should be called BEFORE an item + is added to the list. + </summary> + <param name="item"></param> + </member> + <member name="M:DotSpatial.Serialization.BaseCollection`1.Exclude(`0)"> + <summary> + Exclude should be called AFTER the item is successfully removed from the list. + This allows any handlers that connect to the item to be removed in the event + that the item is no longer anywhere in the list. + </summary> + <param name="item">The item to be removed</param> + </member> + <member name="M:DotSpatial.Serialization.BaseCollection`1.#ctor"> + <summary> + Creates a new instance of BaseCollection + </summary> + </member> + <member name="P:DotSpatial.Serialization.BaseCollection`1.InnerList"> + <summary> + Gets or sets the inner list of T that actually controls the content for this BaseCollection. + </summary> + </member> + <member name="P:DotSpatial.Serialization.BaseCollection`1.IsReadOnly"> + <summary> + False + </summary> + </member> + <member name="P:DotSpatial.Serialization.BaseCollection`1.Count"> + <summary> + Returns the count of the inner list + </summary> + </member> + <member name="T:DotSpatial.Serialization.BaseCollection`1.BaseCollectionEnumerator`1"> + <summary> + Defines a new kind of enumerator designed to make the CollectionBase cooperate with strong type collections + </summary> + <typeparam name="TE">The enumerator type.</typeparam> + </member> + <member name="M:DotSpatial.Serialization.BaseCollection`1.BaseCollectionEnumerator`1.#ctor(System.Collections.IEnumerator)"> + <summary> + Creates the new enumerator + </summary> + <param name="innerEnumerator">A non type specific enumerator</param> + </member> + <member name="M:DotSpatial.Serialization.BaseCollection`1.BaseCollectionEnumerator`1.Dispose"> + <summary> + Does nothing + </summary> + </member> + <member name="M:DotSpatial.Serialization.BaseCollection`1.BaseCollectionEnumerator`1.MoveNext"> + <summary> + Moves to the next item in the collection + </summary> + <returns></returns> + </member> + <member name="M:DotSpatial.Serialization.BaseCollection`1.BaseCollectionEnumerator`1.Reset"> + <summary> + resets the enumerator + </summary> + </member> + <member name="P:DotSpatial.Serialization.BaseCollection`1.BaseCollectionEnumerator`1.Current"> + <summary> + The current item + </summary> + </member> + <member name="T:DotSpatial.Serialization.BaseList`1"> + <summary> + BaseList + </summary> + </member> + <member name="M:DotSpatial.Serialization.BaseList`1.IndexOf(`0)"> + <summary> + Gets the integer index of the specified item. + </summary> + <param name="item">The implementation of T to obtain the zero based integer index of.</param> + <returns>An integer that is -1 if the item is not found, or the zero based index.</returns> + </member> + <member name="M:DotSpatial.Serialization.BaseList`1.Insert(System.Int32,`0)"> + <summary> + If the read-only property is false, then this inserts the item to the specified index. + </summary> + <param name="index">The zero based integer index describing the target index for the item.</param> + <param name="item">The implementation of T to insert into this index.</param> + <exception cref="T:DotSpatial.Serialization.ReadOnlyException">If ReadOnly is true, then this method will cause an exception</exception> + </member> + <member name="M:DotSpatial.Serialization.BaseList`1.OnInsert(System.Int32,`0)"> + <summary> + This happens after an item of type T was added to the list + </summary> + </member> + <member name="M:DotSpatial.Serialization.BaseList`1.OnItemSet(System.Int32,`0,`0)"> + <summary> + This happens after a value has been updated in the list. + </summary> + <param name="index">The index where the replacement took place.</param> + <param name="oldItem">The item that was removed from the position.</param> + <param name="newItem">The new item that is replacing it in the list.</param> + </member> + <member name="M:DotSpatial.Serialization.BaseList`1.OnRemoveAt(System.Int32,`0)"> + <summary> + The happens after an item was removed from the specified index. + </summary> + <param name="index">The index the item was removed from.</param> + <param name="item">The item that was removed</param> + </member> + <member name="M:DotSpatial.Serialization.BaseList`1.RemoveAt(System.Int32)"> + <summary> + Removes the item from the specified index + </summary> + <param name="index">The zero based integer index</param> + </member> + <member name="P:DotSpatial.Serialization.BaseList`1.Item(System.Int32)"> + <summary> + Gets or sets the value of type T at the specified index + </summary> + <param name="index">The zero-base integer index marking the position of the item</param> + <returns>The item</returns> + </member> + <member name="T:DotSpatial.CloneableEM"> + <summary> + CloneableEM + </summary> + </member> + <member name="M:DotSpatial.CloneableEM.Copy``1(``0)"> + <summary> + The type parameter T is optional, so the intended use would be like: + ObjectType copy = myObject.Copy(); + </summary> + <typeparam name="T">The type of the object</typeparam> + <param name="original">The original object</param> + <returns>A new object of the same type as the type being copied.</returns> + </member> + <member name="T:DotSpatial.SerializeExtent"> + <summary> + Extent works like an envelope but is faster acting, has a minimum memory profile, only works in 2D and has no events. + </summary> + </member> + <member name="F:DotSpatial.SerializeExtent.XMax"> + <summary> + Max X + </summary> + </member> + <member name="F:DotSpatial.SerializeExtent.XMin"> + <summary> + Min X + </summary> + </member> + <member name="F:DotSpatial.SerializeExtent.YMax"> + <summary> + Max Y + </summary> + </member> + <member name="F:DotSpatial.SerializeExtent.YMin"> + <summary> + Min Y + </summary> + </member> + <member name="M:DotSpatial.SerializeExtent.#ctor"> + <summary> + Creates a new instance of Extent. This introduces no error checking and assumes + that the user knows what they are doing when working with this. + </summary> + </member> + <member name="M:DotSpatial.SerializeExtent.#ctor(System.Double,System.Double,System.Double,System.Double)"> + <summary> + Creates a new extent from the specified ordinates + </summary> + <param name="xMin"></param> + <param name="yMin"></param> + <param name="xMax"></param> + <param name="yMax"></param> + </member> + <member name="M:DotSpatial.SerializeExtent.#ctor(System.Double[],System.Int32)"> + <summary> + Given a long array of doubles, this builds an extent from a small part of that + xmin, ymin, xmax, ymax + </summary> + <param name="values"></param> + <param name="offset"></param> + </member> + <member name="M:DotSpatial.SerializeExtent.#ctor(System.Double[])"> + <summary> + XMin, YMin, XMax, YMax order + </summary> + <param name="values"></param> + </member> + <member name="M:DotSpatial.SerializeExtent.Clone"> + <summary> + Produces a clone, rather than using this same object. + </summary> + <returns></returns> + </member> + <member name="M:DotSpatial.SerializeExtent.IsEmpty"> + <summary> + If this is undefined, it will have a min that is larger than the max. + </summary> + <returns>Boolean, true if the envelope has not had values set for it yet.</returns> + </member> + <member name="T:DotSpatial.Serialization.Properties.Resources"> + <summary> + A strongly-typed resource class, for looking up localized strings, etc. + </summary> + </member> + <member name="P:DotSpatial.Serialization.Properties.Resources.ResourceManager"> + <summary> + Returns the cached ResourceManager instance used by this class. + </summary> + </member> + <member name="P:DotSpatial.Serialization.Properties.Resources.Culture"> + <summary> + Overrides the current thread's CurrentUICulture property for all + resource lookups using this strongly typed resource class. + </summary> + </member> + <member name="P:DotSpatial.Serialization.Properties.Resources.ReadOnly"> + <summary> + Looks up a localized string similar to The collection cannot be altered because it is read only.. + </summary> + </member> + <member name="T:DotSpatial.Serialization.QualifiedTypeName"> + <summary> + A class for parsing the components of the assembly qualified type name. + </summary> + </member> + <member name="M:DotSpatial.Serialization.QualifiedTypeName.#ctor(System.String)"> + <summary> + Reads in the full string, parsing out the separate elements. These are not always in the specified order, + and many times there are several optional elements. This class helps find the optional elements that are + necessary. This does not support mulitple enclosed types yet, like dictionaries or something. We needed + the single enclosed type for supporting the layer collection however. + </summary> + <param name="qualifiedName">The string qualified name.</param> + </member> + <member name="M:DotSpatial.Serialization.QualifiedTypeName.ToString"> + <summary> + Returns the full qualified type name as "TypeName, Assembly, Version=x, Culture=x, PublicKeyToken=x". + </summary> + <returns>The string expression with the full type name.</returns> + </member> + <member name="P:DotSpatial.Serialization.QualifiedTypeName.EnclosedName"> + <summary> + Gets or sets the name for the enclosed type. + </summary> + </member> + <member name="P:DotSpatial.Serialization.QualifiedTypeName.TypeName"> + <summary> + Gets or sets the TypeName + </summary> + </member> + <member name="P:DotSpatial.Serialization.QualifiedTypeName.Assembly"> + <summary> + Gets or sets the name of the assembly + </summary> + </member> + <member name="P:DotSpatial.Serialization.QualifiedTypeName.Version"> + <summary> + Gets or sets a System.Version for getting or setting the version. + </summary> + </member> + <member name="P:DotSpatial.Serialization.QualifiedTypeName.Culture"> + <summary> + Gets or sets the CultureInfo of the Culture + </summary> + </member> + <member name="P:DotSpatial.Serialization.QualifiedTypeName.PublicKeyToken"> + <summary> + Gets or sets the public key token for the strong name of the assembly. + </summary> + </member> + <member name="T:DotSpatial.Serialization.ReadOnlyException"> + <summary> + ReadOnlyException + </summary> + </member> + <member name="M:DotSpatial.Serialization.ReadOnlyException.#ctor"> + <summary> + Creates a new instance of ReadOnlyException + </summary> + </member> + <member name="M:DotSpatial.Serialization.ReadOnlyException.#ctor(System.String)"> + <summary> + Obsolete + </summary> + <param name="message"></param> + </member> + <member name="T:DotSpatial.Serialization.ReflectionHelper"> + <summary> + A set of utilities to automate some common reflection tasks. + </summary> + </member> + <member name="M:DotSpatial.Serialization.ReflectionHelper.FindDerivedClasses``1"> + <summary> + Searches the entire folder tree beginning at the entry assembly path for types that derive from the specified type. + </summary> + <typeparam name="T">The base class/interface type</typeparam> + <returns>A list of all types found in the search.</returns> + </member> + <member name="M:DotSpatial.Serialization.ReflectionHelper.FindDerivedClasses(System.Type)"> + <summary> + Searches the entire folder tree beginning at the entry assembly path for types that derive from the specified type. + </summary> + <param name="baseType">The base class/interface type.</param> + <returns>A list of all types found in the search.</returns> + </member> + <member name="T:DotSpatial.Serialization.SerializationFormatter"> + <summary> + Base class for formatters responsible for converting objects to and from string values. + </summary> + </member> + <member name="M:DotSpatial.Serialization.SerializationFormatter.ToString(System.Object)"> + <summary> + Converts an object to a string value. + </summary> + <param name="value">The object to convert.</param> + <returns>The string representation of the given object.</returns> + </member> + <member name="M:DotSpatial.Serialization.SerializationFormatter.FromString(System.String)"> + <summary> + Converts a string representation of an object back into the original object form. + </summary> + <param name="value">The string representation of an object.</param> + <returns>The object represented by the given string.</returns> + </member> + <member name="T:DotSpatial.Serialization.SerializationMap"> + <summary> + This class stores the reflected data required for serialization. + </summary> + </member> + <member name="M:DotSpatial.Serialization.SerializationMap.#cctor"> + <summary> + The static constructor creates a dictionary that maps an object type to a specific SerializationMap instance. + </summary> + </member> + <member name="M:DotSpatial.Serialization.SerializationMap.#ctor(System.Type)"> + <summary> + Creates a new instance of the SerializationMap class. + </summary> + <param name="forType">The type associated with this SerializationMap.</param> + </member> + <member name="M:DotSpatial.Serialization.SerializationMap.FromType(System.Type)"> + <summary> + This overload is used for objects that are marked with the <see cref="T:DotSpatial.Serialization.SerializeAttribute"/>. + </summary> + <param name="type">The type to generate a <c>SerializationMap</c> for.</param> + <returns>A new serialization map that can be used to serialize the given type.</returns> + </member> + <member name="M:DotSpatial.Serialization.SerializationMap.Serialize(System.Reflection.MemberInfo,System.String)"> + <summary> + The forward method that will serialize a property or field with the specified name. + The name does not have to be the same as the name of the member. + </summary> + <param name="memberInfo">The property or field information to serialize</param> + <param name="name">The name to remove</param> + <returns>The Serialization Map Entry created by the serialize method</returns> + </member> + <member name="P:DotSpatial.Serialization.SerializationMap.ForType"> + <summary> + The type that this serialization map instance is associated with. + </summary> + </member> + <member name="P:DotSpatial.Serialization.SerializationMap.Members"> + <summary> + The members that participate in serialization. + </summary> + </member> + <member name="T:DotSpatial.Serialization.SerializationMapEntry"> + <summary> + Contains the information needed to serialize a single property or field. + </summary> + </member> + <member name="M:DotSpatial.Serialization.SerializationMapEntry.#ctor(System.Reflection.MemberInfo,DotSpatial.Serialization.SerializeAttribute)"> + <summary> + Creates a new SerializationMapEntry instance. + </summary> + <param name="memberInfo">Info about the field or property to serialize.</param> + <param name="attribute">Details about how to serialize this member.</param> + </member> + <member name="M:DotSpatial.Serialization.SerializationMapEntry.AsConstructorArgument(System.Int32)"> + <summary> + Assigns the constructor argument index of this entry's attribute. + </summary> + <param name="index">The constructor argument index to assign</param> + </member> + <member name="M:DotSpatial.Serialization.SerializationMapEntry.WithFormatterType(System.Type)"> + <summary> + Assigns the formatter value of this entry's attribute. + </summary> + <param name="formatterType">The serialization formatter to use for the associated member.</param> + </member> + <member name="M:DotSpatial.Serialization.SerializationMapEntry.Equals(System.Object)"> + <summary> + Overrides the normal equality test to take into account serialization + </summary> + <param name="obj"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Serialization.SerializationMapEntry.GetHashCode"> + <summary> + Returns a numeric hash code austensibly uniquishly controlled by the member and attribute hash code. + </summary> + <returns></returns> + </member> + <member name="P:DotSpatial.Serialization.SerializationMapEntry.Member"> + <summary> + The <see cref="T:System.Reflection.FieldInfo"/> or <see cref="T:System.Reflection.PropertyInfo"/> instance for the associated member. + </summary> + </member> + <member name="P:DotSpatial.Serialization.SerializationMapEntry.Attribute"> + <summary> + The attribute that contains more details about how to serialize this member. + </summary> + </member> + <member name="T:DotSpatial.Serialization.SerializeAttribute"> + <summary> + This class contains details on how to serialize a field or property. + </summary> + </member> + <member name="M:DotSpatial.Serialization.SerializeAttribute.#ctor(System.String)"> + <summary> + Creates a new instance of the SerializeAttribute. + </summary> + <param name="name">The name to use when serializing the associated member.</param> + </member> + <member name="P:DotSpatial.Serialization.SerializeAttribute.Name"> + <summary> + The name to use when serializing the associated member. + </summary> + </member> + <member name="P:DotSpatial.Serialization.SerializeAttribute.ConstructorArgumentIndex"> + <summary> + The constructor argument index that the associated member represents. + The default value is -1, which indicates that the associated member is + not used as a constructor argument. + </summary> + </member> + <member name="P:DotSpatial.Serialization.SerializeAttribute.Formatter"> + <summary> + The type of the formatter to use for the associated value. + The type must be derived from <see cref="T:DotSpatial.Serialization.SerializationFormatter"/>. + </summary> + </member> + <member name="T:DotSpatial.Serialization.TypeNameManager"> + <summary> + In many cases, the explicit type name references a version or public key token that is expired, + even though the reference is still perfectly valid in the new instance. This type allows testing + for that eventuality, as well as working directly with the components of a fully qualified name. + </summary> + </member> + <member name="M:DotSpatial.Serialization.TypeNameManager.#ctor"> + <summary> + Initializes a new instance of the TypeManager class. + </summary> + </member> + <member name="M:DotSpatial.Serialization.TypeNameManager.UpdateTypename(System.String)"> + <summary> + Since the version, or even possibly the strong name may be dynamic, an older + reference may need to be updated with local assembly information. + </summary> + <param name="invalidTypeName">The invalidated type name, usually because the version is out of date.</param> + <returns>A string represnting the same type, but with a modern assmebly.</returns> + </member> + <member name="M:DotSpatial.Serialization.TypeNameManager.UpdateAssembly(System.String)"> + <summary> + This method searches the executable path, as well as sub-folders looking for an instance of + the specified assembly. Since this class is only needed if the fully qualified assembly name + is invalid, we have to assume that we are looking for something else. + </summary> + <param name="assembly">The string assembly name.</param> + </member> + <member name="T:DotSpatial.Serialization.XmlConstants"> + <summary> + A class that works like an enumeration to define several constants. + </summary> + </member> + <member name="F:DotSpatial.Serialization.XmlConstants.DICTIONARY"> + <summary> + dictionary + </summary> + </member> + <member name="F:DotSpatial.Serialization.XmlConstants.DICTIONARY_ENTRY"> + <summary> + entry + </summary> + </member> + <member name="F:DotSpatial.Serialization.XmlConstants.DICTIONARY_KEY"> + <summary> + key + </summary> + </member> + <member name="F:DotSpatial.Serialization.XmlConstants.DICTIONARY_VALUE"> + <summary> + value + </summary> + </member> + <member name="F:DotSpatial.Serialization.XmlConstants.ENUM"> + <summary> + enum + </summary> + </member> + <member name="F:DotSpatial.Serialization.XmlConstants.LIST"> + <summary> + list + </summary> + </member> + <member name="F:DotSpatial.Serialization.XmlConstants.OBJECT"> + <summary> + object + </summary> + </member> + <member name="F:DotSpatial.Serialization.XmlConstants.PRIMITIVE"> + <summary> + primitive + </summary> + </member> + <member name="F:DotSpatial.Serialization.XmlConstants.STRING"> + <summary> + string + </summary> + </member> + <member name="F:DotSpatial.Serialization.XmlConstants.ROOT"> + <summary> + root + </summary> + </member> + <member name="F:DotSpatial.Serialization.XmlConstants.MEMBER"> + <summary> + member + </summary> + </member> + <member name="F:DotSpatial.Serialization.XmlConstants.ITEM"> + <summary> + item + </summary> + </member> + <member name="F:DotSpatial.Serialization.XmlConstants.TYPE_CACHE"> + <summary> + types + </summary> + </member> + <member name="F:DotSpatial.Serialization.XmlConstants.TYPE_ID"> + <summary> + type + </summary> + </member> + <member name="F:DotSpatial.Serialization.XmlConstants.VALUE"> + <summary> + value + </summary> + </member> + <member name="F:DotSpatial.Serialization.XmlConstants.ARG"> + <summary> + arg + </summary> + </member> + <member name="F:DotSpatial.Serialization.XmlConstants.FORMATTER"> + <summary> + formatter + </summary> + </member> + <member name="F:DotSpatial.Serialization.XmlConstants.NAME"> + <summary> + name + </summary> + </member> + <member name="F:DotSpatial.Serialization.XmlConstants.KEY"> + <summary> + key + </summary> + </member> + <member name="F:DotSpatial.Serialization.XmlConstants.ID"> + <summary> + id + </summary> + </member> + <member name="F:DotSpatial.Serialization.XmlConstants.REF"> + <summary> + ref + </summary> + </member> + <member name="M:DotSpatial.Serialization.XmlConstants.GetMemberType(System.Reflection.MemberInfo)"> + <summary> + Returns a System.Type that corresponds to the MemberInfo, + regardless of whether the member is a field or property. + </summary> + <param name="memberInfo">The base class that can be either a FieldInfo or PropertyInfo</param> + <returns>The System.Type</returns> + </member> + <member name="T:DotSpatial.Serialization.XmlDeserializer"> + <summary> + Converts serialized XML into an object. + </summary> + </member> + <member name="M:DotSpatial.Serialization.XmlDeserializer.Deserialize``1(System.String)"> + <summary> + Converts the given XML string into an object. + </summary> + <typeparam name="T">The type to cast the returned object as.</typeparam> + <param name="xml">The serialized XML text.</param> + <returns>The object represented by the serialized XML.</returns> + </member> + <member name="M:DotSpatial.Serialization.XmlDeserializer.Deserialize``1(``0,System.String)"> + <summary> + Deserializes the given XML, writing the values into the given object. + </summary> + <typeparam name="T">The type of the given object.</typeparam> + <param name="existingObject">An existing object to fill with data.</param> + <param name="xml">The serialized XML text.</param> + </member> + <member name="M:DotSpatial.Serialization.XmlDeserializer.ReadObject(System.Xml.Linq.XElement,System.Object)"> + <summary> + Creates and populates an object from the given XML element. + </summary> + <param name="element">The element containing the object description</param> + <param name="parent">The parent.</param> + <returns> + A populated object specified by the given XML element. + </returns> + </member> + <member name="T:DotSpatial.Serialization.XmlHelper"> + <summary> + A class that helps with xml project serialization + </summary> + </member> + <member name="M:DotSpatial.Serialization.XmlHelper.EscapeInvalidCharacters(System.String)"> + <summary> + Some characters create problems in xml format by being interpreted by xml parsers as + content formatting tags. + </summary> + <param name="text">The string text of the unescaped original characters</param> + <returns>The modified string where the characters are replaced</returns> + </member> + <member name="M:DotSpatial.Serialization.XmlHelper.UnEscapeInvalidCharacters(System.String)"> + <summary> + This converts the invalid characters back to the original, unescaped text + </summary> + <param name="text">The string text of the escaped characters</param> + <returns>The unescaped string text</returns> + </member> + <member name="M:DotSpatial.Serialization.XmlHelper.IsValidEscapeSequence(System.String,System.Int32)"> + <summary> + This tests the string in the provided text parameter starting at the specified startIndex. + If the combination of characters builds one of the recognized escape sequences, then this + returns true. + </summary> + <param name="text">The string to test.</param> + <param name="startIndex">The zero based integer start index.</param> + <returns>A boolean that is true if the startIndex begins an escape sequence.</returns> + </member> + <member name="T:DotSpatial.Serialization.XmlSerializer"> + <summary> + Serializes data to XML. A valid serialization map must be available for all classes being serialized. + The serialization map is generally created at runtime from fields and properties marked with the + <see cref="T:DotSpatial.Serialization.SerializeAttribute"/>. For classes that cannot be directly marked up with attributes a + new map class can be created explicitly as needed. + </summary> + </member> + <member name="M:DotSpatial.Serialization.XmlSerializer.Serialize(System.Object)"> + <summary> + Converts an object into XML. + </summary> + <param name="value">The object to serialize.</param> + <returns>A string containing the serialization of the given object.</returns> + </member> + </members> +</doc> Index: DamClients/DamUI/trunk/release/Install_Version/DevExpress.Utils.v12.2.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/DevExpress.XtraGrid.v12.2.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/pt-BR/DotSpatial.Symbology.Forms.resources.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/MPipingCalc2.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.Dam.Tests.pdb =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.Authorization.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.DamPiping.BlighCalculator.pdb =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/TmpImportFiles/surfacelines.csv =================================================================== diff -u --- DamClients/DamUI/trunk/release/Install_Version/TmpImportFiles/surfacelines.csv (revision 0) +++ DamClients/DamUI/trunk/release/Install_Version/TmpImportFiles/surfacelines.csv (revision 2315) @@ -0,0 +1,3 @@ +LocationId;Geologischprofiel;X_GridPoint;Y_GridPoint;ScenarioClusterID;X1;Y1;Z1;.....;Xn;Yn;Zn;(Profiel) +D1;;63.310;0.000;1;0.000;0.000;0.680;21.110;0.000;1.120;31.600;0.000;1.300;31.730;0.000;1.610;32.210;0.000;1.670;35.580;0.000;1.580;40.480;0.000;1.940;47.860;0.000;3.790;50.110;0.000;4.460;51.750;0.000;4.662;52.630;0.000;4.770;54.250;0.000;4.690;55.170;0.000;4.460;58.850;0.000;2.980;60.290;0.000;2.460;63.310;0.000;1.360;67.900;0.000;1.070;69.410;0.000;0.600;69.800;0.000;0.480;70.530;0.000;0.000;70.820;0.000;-0.190;71.550;0.000;-0.600;72.370;0.000;-1.060;72.380;0.000;-1.170;72.550;0.000;-1.460;73.860;0.000;-1.390;73.990;0.000;-1.0;74.570;0.000;-0.840;74.970;0.000;-0.600;76.170;0.000;0.110;86.660;0.000;0.270;103.280;0.000;0.220;117.940;0.000;0.120 +D2;;63.310;0.000;1;0.000;0.000;0.680;21.110;0.000;1.120;31.600;0.000;1.300;31.730;0.000;1.610 Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.Dam.TestHelper.pdb =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/DevExpress.Charts.v12.2.Core.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/nl-NL/Deltares.DamEngine.Calculators.resources.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/DotSpatial.Projections.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/DotSpatial.Symbology.Forms.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.Dam.Version.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/DamWtiBenchmarkTestReports/README.txt =================================================================== diff -u --- DamClients/DamUI/trunk/release/Install_Version/DamWtiBenchmarkTestReports/README.txt (revision 0) +++ DamClients/DamUI/trunk/release/Install_Version/DamWtiBenchmarkTestReports/README.txt (revision 2315) @@ -0,0 +1,3 @@ +This folder contains benchmark test results. + +Disclaimer.. \ No newline at end of file Index: DamClients/DamUI/trunk/release/Install_Version/DotSpatial.Topology.pdb =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/nl-NL/Deltares.DamEngine.Interface.resources.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/nl-NL/Deltares.DamPiping.SellmeijerVNKCalculator.resources.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.DamEngine.Interface.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.DamEngine.Data.pdb =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.Geographic.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.Maps.Tests.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.Mathematics.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/en-US/DotSpatial.Symbology.Forms.resources.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/de-DE/DotSpatial.Symbology.resources.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/OutputFilePiping.xml =================================================================== diff -u --- DamClients/DamUI/trunk/release/Install_Version/OutputFilePiping.xml (revision 0) +++ DamClients/DamUI/trunk/release/Install_Version/OutputFilePiping.xml (revision 2315) @@ -0,0 +1,56 @@ +<?xml version="1.0" encoding="utf-8"?> +<Output xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> + <Results> + <CalculationResults> + <DesignResults BaseFileName="Basefilename1" CalculationSubDir="Subdir1" LocationName="Location 1" ScenarioName="Scenario 1" ProfileName="Profile 1" CalculationResult="0"> + <PipingDesignResults ResultMessage="no run made" UpliftFactor="0" HeaveFactor="0" BlighFactor="0" BlighHcritical="0.4" ExitPointX="34.21"> + <UpliftSituation IsUplift="true" Pl3MinUplift="0" Pl3HeadAdjusted="0" Pl3LocationXMinUplift="0" Pl4MinUplift="0" Pl4HeadAdjusted="0" Pl4LocationXMinUplift="0" /> + <RedesignedSurfaceLine Name="Surfaceline 1"> + <Points> + <Point X="0" Z="0" PointType="0" /> + <Point X="100" Z="10" PointType="5" /> + <Point X="120" Z="2" PointType="25" /> + </Points> + </RedesignedSurfaceLine> + </PipingDesignResults> + </DesignResults> + <DesignResults BaseFileName="Basefilename2" CalculationSubDir="Subdir2" LocationName="Location 2" ScenarioName="Scenario 2" ProfileName="Profile 2" CalculationResult="1"> + <PipingDesignResults ResultMessage="no run made" UpliftFactor="1.3" HeaveFactor="1.1" BlighFactor="1.03" BlighHcritical="0.4" ExitPointX="34.21"> + <UpliftSituation IsUplift="true" Pl3MinUplift="0.7" Pl3HeadAdjusted="0.2" Pl3LocationXMinUplift="2.2" Pl4MinUplift="4.7" Pl4HeadAdjusted="0.4" Pl4LocationXMinUplift="4.4" /> + <RedesignedSurfaceLine Name="Surfaceline 1"> + <Points> + <Point X="0" Z="0" PointType="0" /> + <Point X="100" Z="10" PointType="5" /> + <Point X="120" Z="2" PointType="25" /> + </Points> + </RedesignedSurfaceLine> + </PipingDesignResults> + </DesignResults> + <DesignResults BaseFileName="Basefilename3" CalculationSubDir="Subdir3" LocationName="Location 3" ScenarioName="Scenario 3" ProfileName="Profile 3" CalculationResult="2"> + <PipingDesignResults ResultMessage="no run made" UpliftFactor="2.6" HeaveFactor="2.2" BlighFactor="2.06" BlighHcritical="0.4" ExitPointX="34.21"> + <UpliftSituation IsUplift="true" Pl3MinUplift="1.4" Pl3HeadAdjusted="0.4" Pl3LocationXMinUplift="4.4" Pl4MinUplift="9.4" Pl4HeadAdjusted="0.8" Pl4LocationXMinUplift="8.8" /> + <RedesignedSurfaceLine Name="Surfaceline 1"> + <Points> + <Point X="0" Z="0" PointType="0" /> + <Point X="100" Z="10" PointType="5" /> + <Point X="120" Z="2" PointType="25" /> + </Points> + </RedesignedSurfaceLine> + </PipingDesignResults> + </DesignResults> + <DesignResults BaseFileName="Basefilename4" CalculationSubDir="Subdir4" LocationName="Location 4" ScenarioName="Scenario 4" ProfileName="Profile 4" CalculationResult="3"> + <PipingDesignResults ResultMessage="no run made" UpliftFactor="3.9000000000000004" HeaveFactor="3.3000000000000003" BlighFactor="3.09" BlighHcritical="0.4" ExitPointX="34.21"> + <UpliftSituation IsUplift="true" Pl3MinUplift="2.0999999999999996" Pl3HeadAdjusted="0.60000000000000009" Pl3LocationXMinUplift="6.6000000000000005" Pl4MinUplift="14.100000000000001" Pl4HeadAdjusted="1.2000000000000002" Pl4LocationXMinUplift="13.200000000000001" /> + <RedesignedSurfaceLine Name="Surfaceline 1"> + <Points> + <Point X="0" Z="0" PointType="0" /> + <Point X="100" Z="10" PointType="5" /> + <Point X="120" Z="2" PointType="25" /> + </Points> + </RedesignedSurfaceLine> + </PipingDesignResults> + </DesignResults> + </CalculationResults> + <OperationalOutputTimeSeries xsi:nil="true" /> + </Results> +</Output> \ No newline at end of file Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.Dam.Tests.dll.config =================================================================== diff -u --- DamClients/DamUI/trunk/release/Install_Version/Deltares.Dam.Tests.dll.config (revision 0) +++ DamClients/DamUI/trunk/release/Install_Version/Deltares.Dam.Tests.dll.config (revision 2315) @@ -0,0 +1,116 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +Copyright (C) Stichting Deltares 2018. All rights reserved. + +This file is part of the DAM - UI. + +The DAM - UI is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see <http://www.gnu.org/licenses/>. + +All names, logos, and references to "Deltares" are registered trademarks of +Stichting Deltares and remain full property of Stichting Deltares at all times. +All rights reserved. +--> +<configuration> + + <configSections> + + <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler,log4net" /> + + </configSections> + + <log4net> + + <appender name="console" type="log4net.Appender.ConsoleAppender, log4net"> + <layout type="log4net.Layout.PatternLayout,log4net"> + <param name="ConversionPattern" value="%d{ABSOLUTE} %-5p %c{1}:%L - %m%n" /> + </layout> + </appender> + + <appender name="fileAppender" type="log4net.Appender.FileAppender"> + <file value="log-file.txt" /> + <appendToFile value="true" /> + <layout type="log4net.Layout.PatternLayout"> + <conversionPattern value="%date [%thread] %-5level %logger [%property{NDC}] - %message%newline" /> + </layout> + </appender> + + <root> + + <!-- Set the level to DEBUG or ALL if you want to see a ton of informational and debug messages. --> + + <level value="WARN" /> + <appender-ref ref="console" /> + <appender-ref ref="fileAppender" /> + </root> + + </log4net> + +<startup><supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.5" /></startup> + <runtime> + <assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1"> + <dependentAssembly> + <assemblyIdentity name="DotSpatial.Symbology" publicKeyToken="6178c08da7998387" culture="neutral" /> + <bindingRedirect oldVersion="0.0.0.0-1.6.0.0" newVersion="1.6.0.0" /> + </dependentAssembly> + <dependentAssembly> + <assemblyIdentity name="DotSpatial.Controls" publicKeyToken="4d9e49339a7d240c" culture="neutral" /> + <bindingRedirect oldVersion="0.0.0.0-1.6.0.0" newVersion="1.6.0.0" /> + </dependentAssembly> + <dependentAssembly> + <assemblyIdentity name="DotSpatial.Data" publicKeyToken="c29dbf30e059ca9d" culture="neutral" /> + <bindingRedirect oldVersion="0.0.0.0-1.6.0.0" newVersion="1.6.0.0" /> + </dependentAssembly> + <dependentAssembly> + <assemblyIdentity name="DotSpatial.Projections" publicKeyToken="272632bddd08a38b" culture="neutral" /> + <bindingRedirect oldVersion="0.0.0.0-1.6.0.0" newVersion="1.6.0.0" /> + </dependentAssembly> + <dependentAssembly> + <assemblyIdentity name="DotSpatial.Topology" publicKeyToken="a66b5e9434ca3671" culture="neutral" /> + <bindingRedirect oldVersion="0.0.0.0-1.6.0.0" newVersion="1.6.0.0" /> + </dependentAssembly> + <dependentAssembly> + <assemblyIdentity name="System.Data.SQLite" publicKeyToken="db937bc2d44ff139" culture="neutral" /> + <bindingRedirect oldVersion="0.0.0.0-1.0.90.0" newVersion="1.0.90.0" /> + </dependentAssembly> + <dependentAssembly> + <assemblyIdentity name="DotSpatial.Serialization" publicKeyToken="441f200f827611e7" culture="neutral" /> + <bindingRedirect oldVersion="0.0.0.0-1.6.0.0" newVersion="1.6.0.0" /> + </dependentAssembly> + <dependentAssembly> + <assemblyIdentity name="Deltares.Mathematics" publicKeyToken="582f89ef4e0ea16b" culture="neutral" /> + <bindingRedirect oldVersion="0.0.0.0-18.1.0.1995" newVersion="18.1.0.1995" /> + </dependentAssembly> + <dependentAssembly> + <assemblyIdentity name="Deltares.Geometry" publicKeyToken="a2df6371dee9e0f4" culture="neutral" /> + <bindingRedirect oldVersion="0.0.0.0-18.1.0.2005" newVersion="18.1.0.2005" /> + </dependentAssembly> + <dependentAssembly> + <assemblyIdentity name="Deltares.Standard" publicKeyToken="31fe100197c68040" culture="neutral" /> + <bindingRedirect oldVersion="0.0.0.0-18.1.0.1995" newVersion="18.1.0.1995" /> + </dependentAssembly> + <dependentAssembly> + <assemblyIdentity name="Deltares.Geotechnics" publicKeyToken="704b73ead55eb267" culture="neutral" /> + <bindingRedirect oldVersion="0.0.0.0-18.1.0.2005" newVersion="18.1.0.2005" /> + </dependentAssembly> + <dependentAssembly> + <assemblyIdentity name="Deltares.Geographic" publicKeyToken="d4f3dcd34f9b7bc2" culture="neutral" /> + <bindingRedirect oldVersion="0.0.0.0-18.1.0.2001" newVersion="18.1.0.2001" /> + </dependentAssembly> + <dependentAssembly> + <assemblyIdentity name="Deltares.Probabilistic" publicKeyToken="1ad0f6a98dfa90ad" culture="neutral" /> + <bindingRedirect oldVersion="0.0.0.0-18.1.0.1999" newVersion="18.1.0.1999" /> + </dependentAssembly> + </assemblyBinding> + </runtime> +</configuration> Index: DamClients/DamUI/trunk/release/Install_Version/DotSpatial.Modeling.Forms.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.Geometry.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/zh-MO/DotSpatial.Modeling.Forms.resources.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/DotSpatial.Data.Rasters.GdalExtension.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/DotSpatial.Symbology.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.Geotechnics.Forms.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/MathNet.Numerics.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/nl-NL/Deltares.DamEngine.Data.resources.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.DamMacroStability.Calculator.pdb =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.DamPiping.Sellmeijer4ForcesCalculator.pdb =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/DevExpress.Data.v12.2.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/pt/DotSpatial.Projections.Forms.resources.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/Rhino.Mocks.xml =================================================================== diff -u --- DamClients/DamUI/trunk/release/Install_Version/Rhino.Mocks.xml (revision 0) +++ DamClients/DamUI/trunk/release/Install_Version/Rhino.Mocks.xml (revision 2315) @@ -0,0 +1,5624 @@ +<?xml version="1.0"?> +<doc> + <assembly> + <name>Rhino.Mocks</name> + </assembly> + <members> + <member name="T:Rhino.Mocks.Arg`1"> + <summary> + Defines constraints and return values for arguments of a mock. + Only use Arg inside a method call on a mock that is recording. + Example: + ExpectCall( + mock.foo( + Arg<int>.Is.GreaterThan(2), + Arg<string>.Is.Anything + )); + Use Arg.Text for string specific constraints + Use Arg<ListClass>.List for list specific constraints + </summary> + <typeparam name="T"></typeparam> + </member> + <member name="M:Rhino.Mocks.Arg`1.Matches(System.Linq.Expressions.Expression{System.Predicate{`0}})"> + <summary> + Register the predicate as a constraint for the current call. + </summary> + <param name="predicate">The predicate.</param> + <returns>default(T)</returns> + <example> + Allow you to use code to create constraints + <code> + demo.AssertWasCalled(x => x.Bar(Arg{string}.Matches(a => a.StartsWith("b") && a.Contains("ba")))); + </code> + </example> + </member> + <member name="M:Rhino.Mocks.Arg`1.Matches(Rhino.Mocks.Constraints.AbstractConstraint)"> + <summary> + Define a complex constraint for this argument by passing several constraints + combined with operators. (Use Is in simple cases.) + Example: Arg<string>.Matches(Is.Equal("Hello") || Text.EndsWith("u")); + </summary> + <param name="constraint">Constraints using Is, Text and List</param> + <returns>Dummy to satisfy the compiler</returns> + </member> + <member name="M:Rhino.Mocks.Arg`1.Ref(Rhino.Mocks.Constraints.AbstractConstraint,`0)"> + <summary> + Define a Ref argument. + </summary> + <param name="constraint">Constraints for this argument</param> + <param name="returnValue">value returned by the mock</param> + <returns></returns> + </member> + <member name="M:Rhino.Mocks.Arg`1.Out(`0)"> + <summary> + Define a out parameter. Use it together with the keyword out and use the + Dummy field available by the return value. + Example: mock.foo( out Arg<string>.Out("hello").Dummy ); + </summary> + <param name="returnValue"></param> + <returns></returns> + </member> + <member name="P:Rhino.Mocks.Arg`1.Is"> + <summary> + Define a simple constraint for this argument. (Use Matches in simple cases.) + Example: + Arg<int>.Is.Anthing + Arg<string>.Is.Equal("hello") + </summary> + </member> + <member name="P:Rhino.Mocks.Arg`1.List"> + <summary> + Define Constraints on list arguments. + </summary> + </member> + <member name="T:Rhino.Mocks.Arg"> + <summary> + Use the Arg class (without generic) to define Text constraints + </summary> + </member> + <member name="M:Rhino.Mocks.Arg.Is``1(``0)"> + <summary> + Evaluate an equal constraint for <see cref="T:System.IComparable"/>. + </summary> + <param name="arg">The object the parameter should equal to</param> + </member> + <member name="P:Rhino.Mocks.Arg.Text"> + <summary> + Define constraints on text arguments. + </summary> + </member> + <member name="T:Rhino.Mocks.ArgManager"> + <summary> + Used to manage the static state of the Arg<T> class"/> + </summary> + </member> + <member name="M:Rhino.Mocks.ArgManager.Clear"> + <summary> + Resets the static state + </summary> + </member> + <member name="M:Rhino.Mocks.ArgManager.GetAllReturnValues"> + <summary> + Returns return values for the out and ref parameters + Note: the array returned has the size of the number of out and ref + argument definitions + </summary> + <returns></returns> + </member> + <member name="M:Rhino.Mocks.ArgManager.GetAllConstraints"> + <summary> + Returns the constraints for all arguments. + Out arguments have an Is.Anything constraint and are also in the list. + </summary> + <returns></returns> + </member> + <member name="T:Rhino.Mocks.BackToRecordOptions"> + <summary> + What should BackToRecord clear + </summary> + </member> + <member name="F:Rhino.Mocks.BackToRecordOptions.None"> + <summary> + Retain all expectations and behaviors and return to mock + </summary> + </member> + <member name="F:Rhino.Mocks.BackToRecordOptions.Expectations"> + <summary> + All expectations + </summary> + </member> + <member name="F:Rhino.Mocks.BackToRecordOptions.EventSubscribers"> + <summary> + Event subscribers for this instance + </summary> + </member> + <member name="F:Rhino.Mocks.BackToRecordOptions.OriginalMethodsToCall"> + <summary> + Methods that should be forwarded to the base class implementation + </summary> + </member> + <member name="F:Rhino.Mocks.BackToRecordOptions.PropertyBehavior"> + <summary> + Properties that should behave like properties + </summary> + </member> + <member name="F:Rhino.Mocks.BackToRecordOptions.All"> + <summary> + Remove all the behavior of the object + </summary> + </member> + <member name="T:Rhino.Mocks.Constraints.AbstractConstraint"> + <summary> + Interface for constraints + </summary> + </member> + <member name="M:Rhino.Mocks.Constraints.AbstractConstraint.Eval(System.Object)"> + <summary> + Determines if the object pass the constraints + </summary> + </member> + <member name="M:Rhino.Mocks.Constraints.AbstractConstraint.op_BitwiseAnd(Rhino.Mocks.Constraints.AbstractConstraint,Rhino.Mocks.Constraints.AbstractConstraint)"> + <summary> + And operator for constraints + </summary> + </member> + <member name="M:Rhino.Mocks.Constraints.AbstractConstraint.op_LogicalNot(Rhino.Mocks.Constraints.AbstractConstraint)"> + <summary> + Not operator for constraints + </summary> + </member> + <member name="M:Rhino.Mocks.Constraints.AbstractConstraint.op_BitwiseOr(Rhino.Mocks.Constraints.AbstractConstraint,Rhino.Mocks.Constraints.AbstractConstraint)"> + <summary> + Or operator for constraints + </summary> + </member> + <member name="M:Rhino.Mocks.Constraints.AbstractConstraint.op_False(Rhino.Mocks.Constraints.AbstractConstraint)"> + <summary> + Allow overriding of || or && + </summary> + <param name="c"></param> + <returns></returns> + </member> + <member name="M:Rhino.Mocks.Constraints.AbstractConstraint.op_True(Rhino.Mocks.Constraints.AbstractConstraint)"> + <summary> + Allow overriding of || or && + </summary> + <param name="c"></param> + <returns></returns> + </member> + <member name="P:Rhino.Mocks.Constraints.AbstractConstraint.Message"> + <summary> + Gets the message for this constraint + </summary> + <value></value> + </member> + <member name="T:Rhino.Mocks.Constraints.PublicFieldIs"> + <summary> + Constrain that the public field has a specified value + </summary> + </member> + <member name="T:Rhino.Mocks.Constraints.PublicFieldConstraint"> + <summary> + Constrain that the public field matches another constraint. + </summary> + </member> + <member name="M:Rhino.Mocks.Constraints.PublicFieldConstraint.#ctor(System.String,Rhino.Mocks.Constraints.AbstractConstraint)"> + <summary> + Creates a new <see cref="T:Rhino.Mocks.Constraints.PublicFieldConstraint"/> instance. + </summary> + <param name="publicFieldName">Name of the public field.</param> + <param name="constraint">Constraint to place on the public field value.</param> + </member> + <member name="M:Rhino.Mocks.Constraints.PublicFieldConstraint.#ctor(System.Type,System.String,Rhino.Mocks.Constraints.AbstractConstraint)"> + <summary> + Creates a new <see cref="T:Rhino.Mocks.Constraints.PublicFieldConstraint"/> instance, specifying a disambiguating + <paramref name="declaringType"/> for the public field. + </summary> + <param name="declaringType">The type that declares the public field, used to disambiguate between public fields.</param> + <param name="publicFieldName">Name of the public field.</param> + <param name="constraint">Constraint to place on the public field value.</param> + </member> + <member name="M:Rhino.Mocks.Constraints.PublicFieldConstraint.Eval(System.Object)"> + <summary> + Determines if the object passes the constraint. + </summary> + </member> + <member name="P:Rhino.Mocks.Constraints.PublicFieldConstraint.Message"> + <summary> + Gets the message for this constraint + </summary> + <value></value> + </member> + <member name="M:Rhino.Mocks.Constraints.PublicFieldIs.#ctor(System.String,System.Object)"> + <summary> + Creates a new <see cref="T:Rhino.Mocks.Constraints.PublicFieldIs"/> instance. + </summary> + <param name="publicFieldName">Name of the public field.</param> + <param name="expectedValue">Expected value.</param> + </member> + <member name="M:Rhino.Mocks.Constraints.PublicFieldIs.#ctor(System.Type,System.String,System.Object)"> + <summary> + Creates a new <see cref="T:Rhino.Mocks.Constraints.PublicFieldIs"/> instance, specifying a disambiguating + <paramref name="declaringType"/> for the public field. + </summary> + <param name="declaringType">The type that declares the public field, used to disambiguate between public fields.</param> + <param name="publicFieldName">Name of the public field.</param> + <param name="expectedValue">Expected value.</param> + </member> + <member name="T:Rhino.Mocks.Constraints.PropertyIs"> + <summary> + Constrain that the property has a specified value + </summary> + </member> + <member name="T:Rhino.Mocks.Constraints.PropertyConstraint"> + <summary> + Constrain that the property matches another constraint. + </summary> + </member> + <member name="M:Rhino.Mocks.Constraints.PropertyConstraint.#ctor(System.String,Rhino.Mocks.Constraints.AbstractConstraint)"> + <summary> + Creates a new <see cref="T:Rhino.Mocks.Constraints.PropertyConstraint"/> instance. + </summary> + <param name="propertyName">Name of the property.</param> + <param name="constraint">Constraint to place on the property value.</param> + </member> + <member name="M:Rhino.Mocks.Constraints.PropertyConstraint.#ctor(System.Type,System.String,Rhino.Mocks.Constraints.AbstractConstraint)"> + <summary> + Creates a new <see cref="T:Rhino.Mocks.Constraints.PropertyConstraint"/> instance, specifying a disambiguating + <paramref name="declaringType"/> for the property. + </summary> + <param name="declaringType">The type that declares the property, used to disambiguate between properties.</param> + <param name="propertyName">Name of the property.</param> + <param name="constraint">Constraint to place on the property value.</param> + </member> + <member name="M:Rhino.Mocks.Constraints.PropertyConstraint.Eval(System.Object)"> + <summary> + Determines if the object passes the constraint. + </summary> + </member> + <member name="P:Rhino.Mocks.Constraints.PropertyConstraint.Message"> + <summary> + Gets the message for this constraint + </summary> + <value></value> + </member> + <member name="M:Rhino.Mocks.Constraints.PropertyIs.#ctor(System.String,System.Object)"> + <summary> + Creates a new <see cref="T:Rhino.Mocks.Constraints.PropertyIs"/> instance. + </summary> + <param name="propertyName">Name of the property.</param> + <param name="expectedValue">Expected value.</param> + </member> + <member name="M:Rhino.Mocks.Constraints.PropertyIs.#ctor(System.Type,System.String,System.Object)"> + <summary> + Creates a new <see cref="T:Rhino.Mocks.Constraints.PropertyIs"/> instance, specifying a disambiguating + <paramref name="declaringType"/> for the property. + </summary> + <param name="declaringType">The type that declares the property, used to disambiguate between properties.</param> + <param name="propertyName">Name of the property.</param> + <param name="expectedValue">Expected value.</param> + </member> + <member name="T:Rhino.Mocks.Constraints.TypeOf"> + <summary> + Constrain that the parameter must be of the specified type + </summary> + </member> + <member name="M:Rhino.Mocks.Constraints.TypeOf.#ctor(System.Type)"> + <summary> + Creates a new <see cref="T:Rhino.Mocks.Constraints.TypeOf"/> instance. + </summary> + <param name="type">Type.</param> + </member> + <member name="M:Rhino.Mocks.Constraints.TypeOf.Eval(System.Object)"> + <summary> + Determines if the object pass the constraints + </summary> + </member> + <member name="P:Rhino.Mocks.Constraints.TypeOf.Message"> + <summary> + Gets the message for this constraint + </summary> + <value></value> + </member> + <member name="T:Rhino.Mocks.Constraints.Same"> + <summary> + Constraint that determines whether an object is the same object as another. + </summary> + </member> + <member name="M:Rhino.Mocks.Constraints.Same.#ctor(System.Object)"> + <summary> + Creates a new <see cref="T:Rhino.Mocks.Constraints.Equal"/> instance. + </summary> + <param name="obj">Obj.</param> + </member> + <member name="M:Rhino.Mocks.Constraints.Same.Eval(System.Object)"> + <summary> + Determines if the object passes the constraints. + </summary> + </member> + <member name="P:Rhino.Mocks.Constraints.Same.Message"> + <summary> + Gets the message for this constraint. + </summary> + </member> + <member name="T:Rhino.Mocks.Constraints.PredicateConstraint`1"> + <summary> + Evaluate a parameter using constraints + </summary> + </member> + <member name="M:Rhino.Mocks.Constraints.PredicateConstraint`1.#ctor(System.Predicate{`0})"> + <summary> + Create new instance + </summary> + <param name="predicate"></param> + </member> + <member name="M:Rhino.Mocks.Constraints.PredicateConstraint`1.Eval(System.Object)"> + <summary> + Determines if the object pass the constraints + </summary> + </member> + <member name="P:Rhino.Mocks.Constraints.PredicateConstraint`1.Message"> + <summary> + Gets the message for this constraint + </summary> + <value></value> + </member> + <member name="T:Rhino.Mocks.Constraints.LambdaConstraint"> + <summary> + A constraint based on lambda expression, we are using Expression{T} + because we want to be able to get good error reporting on that. + </summary> + </member> + <member name="M:Rhino.Mocks.Constraints.LambdaConstraint.#ctor(System.Linq.Expressions.LambdaExpression)"> + <summary> + Initializes a new instance of the <see cref="T:Rhino.Mocks.Constraints.LambdaConstraint"/> class. + </summary> + <param name="expr">The expr.</param> + </member> + <member name="M:Rhino.Mocks.Constraints.LambdaConstraint.Eval(System.Object)"> + <summary> + Determines if the object pass the constraints + </summary> + <param name="obj"></param> + <returns></returns> + </member> + <member name="P:Rhino.Mocks.Constraints.LambdaConstraint.Message"> + <summary> + Gets the message for this constraint + </summary> + <value></value> + </member> + <member name="T:Rhino.Mocks.Constraints.CollectionEqual"> + <summary> + Constrain that the list contains the same items as the parameter list + </summary> + </member> + <member name="M:Rhino.Mocks.Constraints.CollectionEqual.#ctor(System.Collections.IEnumerable)"> + <summary> + Creates a new <see cref="T:Rhino.Mocks.Constraints.CollectionEqual"/> instance. + </summary> + <param name="collection">In list.</param> + </member> + <member name="M:Rhino.Mocks.Constraints.CollectionEqual.Eval(System.Object)"> + <summary> + Determines if the object pass the constraints + </summary> + </member> + <member name="P:Rhino.Mocks.Constraints.CollectionEqual.Message"> + <summary> + Gets the message for this constraint + </summary> + <value></value> + </member> + <member name="T:Rhino.Mocks.Constraints.OneOf"> + <summary> + Constrain that the parameter is one of the items in the list + </summary> + </member> + <member name="M:Rhino.Mocks.Constraints.OneOf.#ctor(System.Collections.IEnumerable)"> + <summary> + Creates a new <see cref="T:Rhino.Mocks.Constraints.OneOf"/> instance. + </summary> + <param name="collection">In list.</param> + </member> + <member name="M:Rhino.Mocks.Constraints.OneOf.Eval(System.Object)"> + <summary> + Determines if the object pass the constraints + </summary> + </member> + <member name="P:Rhino.Mocks.Constraints.OneOf.Message"> + <summary> + Gets the message for this constraint + </summary> + <value></value> + </member> + <member name="T:Rhino.Mocks.Constraints.IsIn"> + <summary> + Constrain that the object is inside the parameter list + </summary> + </member> + <member name="M:Rhino.Mocks.Constraints.IsIn.#ctor(System.Object)"> + <summary> + Creates a new <see cref="T:Rhino.Mocks.Constraints.IsIn"/> instance. + </summary> + <param name="inList">In list.</param> + </member> + <member name="M:Rhino.Mocks.Constraints.IsIn.Eval(System.Object)"> + <summary> + Determines if the object pass the constraints + </summary> + </member> + <member name="P:Rhino.Mocks.Constraints.IsIn.Message"> + <summary> + Gets the message for this constraint + </summary> + <value></value> + </member> + <member name="T:Rhino.Mocks.Constraints.CollectionCount"> + <summary> + Applies another AbstractConstraint to the collection count. + </summary> + </member> + <member name="M:Rhino.Mocks.Constraints.CollectionCount.#ctor(Rhino.Mocks.Constraints.AbstractConstraint)"> + <summary> + Creates a new <see cref="T:Rhino.Mocks.Constraints.CollectionCount"/> instance. + </summary> + <param name="constraint">The constraint that should be applied to the collection count.</param> + </member> + <member name="M:Rhino.Mocks.Constraints.CollectionCount.Eval(System.Object)"> + <summary> + Determines if the parameter conforms to this constraint. + </summary> + </member> + <member name="P:Rhino.Mocks.Constraints.CollectionCount.Message"> + <summary> + Gets the message for this constraint. + </summary> + </member> + <member name="T:Rhino.Mocks.Constraints.ListElement"> + <summary> + Applies another AbstractConstraint to a specific list element. + </summary> + </member> + <member name="M:Rhino.Mocks.Constraints.ListElement.#ctor(System.Int32,Rhino.Mocks.Constraints.AbstractConstraint)"> + <summary> + Creates a new <see cref="T:Rhino.Mocks.Constraints.ListElement"/> instance. + </summary> + <param name="index">The zero-based index of the list element.</param> + <param name="constraint">The constraint that should be applied to the list element.</param> + </member> + <member name="M:Rhino.Mocks.Constraints.ListElement.Eval(System.Object)"> + <summary> + Determines if the parameter conforms to this constraint. + </summary> + </member> + <member name="P:Rhino.Mocks.Constraints.ListElement.Message"> + <summary> + Gets the message for this constraint + </summary> + <value></value> + </member> + <member name="T:Rhino.Mocks.Constraints.KeyedListElement`1"> + <summary> + Applies another AbstractConstraint to a specific generic keyed list element. + </summary> + </member> + <member name="M:Rhino.Mocks.Constraints.KeyedListElement`1.#ctor(`0,Rhino.Mocks.Constraints.AbstractConstraint)"> + <summary> + Creates a new <see cref="T:KeyedListElement"/> instance. + </summary> + <param name="key">The key of the list element.</param> + <param name="constraint">The constraint that should be applied to the list element.</param> + </member> + <member name="M:Rhino.Mocks.Constraints.KeyedListElement`1.Eval(System.Object)"> + <summary> + Determines if the parameter conforms to this constraint. + </summary> + </member> + <member name="P:Rhino.Mocks.Constraints.KeyedListElement`1.Message"> + <summary> + Gets the message for this constraint + </summary> + <value></value> + </member> + <member name="T:Rhino.Mocks.Constraints.ContainsAll"> + <summary> + Constrains that all elements are in the parameter list + </summary> + </member> + <member name="M:Rhino.Mocks.Constraints.ContainsAll.#ctor(System.Collections.IEnumerable)"> + <summary> + Initializes a new instance of the <see cref="T:Rhino.Mocks.Constraints.ContainsAll"/> class. + </summary> + <param name="these">The these.</param> + </member> + <member name="M:Rhino.Mocks.Constraints.ContainsAll.Eval(System.Object)"> + <summary> + Determines if the object pass the constraints + </summary> + <param name="obj"></param> + <returns></returns> + </member> + <member name="P:Rhino.Mocks.Constraints.ContainsAll.Message"> + <summary> + Gets the message for this constraint + </summary> + <value></value> + </member> + <member name="T:Rhino.Mocks.Constraints.Or"> + <summary> + Combines two constraints, constraint pass if either is fine. + </summary> + </member> + <member name="M:Rhino.Mocks.Constraints.Or.#ctor(Rhino.Mocks.Constraints.AbstractConstraint,Rhino.Mocks.Constraints.AbstractConstraint)"> + <summary> + Creates a new <see cref="T:Rhino.Mocks.Constraints.And"/> instance. + </summary> + <param name="c1">C1.</param> + <param name="c2">C2.</param> + </member> + <member name="M:Rhino.Mocks.Constraints.Or.Eval(System.Object)"> + <summary> + Determines if the object pass the constraints + </summary> + </member> + <member name="P:Rhino.Mocks.Constraints.Or.Message"> + <summary> + Gets the message for this constraint + </summary> + <value></value> + </member> + <member name="T:Rhino.Mocks.Constraints.Not"> + <summary> + Negate a constraint + </summary> + </member> + <member name="M:Rhino.Mocks.Constraints.Not.#ctor(Rhino.Mocks.Constraints.AbstractConstraint)"> + <summary> + Creates a new <see cref="T:Rhino.Mocks.Constraints.And"/> instance. + </summary> + <param name="c1">C1.</param> + </member> + <member name="M:Rhino.Mocks.Constraints.Not.Eval(System.Object)"> + <summary> + Determines if the object pass the constraints + </summary> + </member> + <member name="P:Rhino.Mocks.Constraints.Not.Message"> + <summary> + Gets the message for this constraint + </summary> + <value></value> + </member> + <member name="T:Rhino.Mocks.Constraints.And"> + <summary> + Combines two constraints + </summary> + <remarks></remarks> + </member> + <member name="M:Rhino.Mocks.Constraints.And.#ctor(Rhino.Mocks.Constraints.AbstractConstraint,Rhino.Mocks.Constraints.AbstractConstraint)"> + <summary> + Creates a new <see cref="T:Rhino.Mocks.Constraints.And"/> instance. + </summary> + <param name="c1">C1.</param> + <param name="c2">C2.</param> + </member> + <member name="M:Rhino.Mocks.Constraints.And.Eval(System.Object)"> + <summary> + Determines if the object pass the constraints + </summary> + </member> + <member name="P:Rhino.Mocks.Constraints.And.Message"> + <summary> + Gets the message for this constraint + </summary> + <value></value> + </member> + <member name="T:Rhino.Mocks.Constraints.Like"> + <summary> + Constrain the argument to validate according to regex pattern + </summary> + </member> + <member name="M:Rhino.Mocks.Constraints.Like.#ctor(System.String)"> + <summary> + Creates a new <see cref="T:Rhino.Mocks.Constraints.Like"/> instance. + </summary> + <param name="pattern">Pattern.</param> + </member> + <member name="M:Rhino.Mocks.Constraints.Like.Eval(System.Object)"> + <summary> + Determines if the object pass the constraints + </summary> + </member> + <member name="P:Rhino.Mocks.Constraints.Like.Message"> + <summary> + Gets the message for this constraint + </summary> + <value></value> + </member> + <member name="T:Rhino.Mocks.Constraints.Contains"> + <summary> + Constraint that evaluate whatever an argument contains the specified string. + </summary> + </member> + <member name="M:Rhino.Mocks.Constraints.Contains.#ctor(System.String)"> + <summary> + Creates a new <see cref="T:Rhino.Mocks.Constraints.Contains"/> instance. + </summary> + <param name="innerString">Inner string.</param> + </member> + <member name="M:Rhino.Mocks.Constraints.Contains.Eval(System.Object)"> + <summary> + Determines if the object pass the constraints + </summary> + </member> + <member name="P:Rhino.Mocks.Constraints.Contains.Message"> + <summary> + Gets the message for this constraint + </summary> + <value></value> + </member> + <member name="T:Rhino.Mocks.Constraints.EndsWith"> + <summary> + Constraint that evaluate whatever an argument ends with the specified string + </summary> + </member> + <member name="M:Rhino.Mocks.Constraints.EndsWith.#ctor(System.String)"> + <summary> + Creates a new <see cref="T:Rhino.Mocks.Constraints.EndsWith"/> instance. + </summary> + <param name="end">End.</param> + </member> + <member name="M:Rhino.Mocks.Constraints.EndsWith.Eval(System.Object)"> + <summary> + Determines if the object pass the constraints + </summary> + </member> + <member name="P:Rhino.Mocks.Constraints.EndsWith.Message"> + <summary> + Gets the message for this constraint + </summary> + <value></value> + </member> + <member name="T:Rhino.Mocks.Constraints.StartsWith"> + <summary> + Constraint that evaluate whatever an argument start with the specified string + </summary> + </member> + <member name="M:Rhino.Mocks.Constraints.StartsWith.#ctor(System.String)"> + <summary> + Creates a new <see cref="T:Rhino.Mocks.Constraints.StartsWith"/> instance. + </summary> + <param name="start">Start.</param> + </member> + <member name="M:Rhino.Mocks.Constraints.StartsWith.Eval(System.Object)"> + <summary> + Determines if the object pass the constraints + </summary> + </member> + <member name="P:Rhino.Mocks.Constraints.StartsWith.Message"> + <summary> + Gets the message for this constraint + </summary> + <value></value> + </member> + <member name="T:Rhino.Mocks.Constraints.Equal"> + <summary> + Constraint that evaluate whatever an object equals another + </summary> + </member> + <member name="M:Rhino.Mocks.Constraints.Equal.#ctor(System.Object)"> + <summary> + Creates a new <see cref="T:Rhino.Mocks.Constraints.Equal"/> instance. + </summary> + <param name="obj">Obj.</param> + </member> + <member name="M:Rhino.Mocks.Constraints.Equal.Eval(System.Object)"> + <summary> + Determines if the object pass the constraints + </summary> + </member> + <member name="P:Rhino.Mocks.Constraints.Equal.Message"> + <summary> + Gets the message for this constraint + </summary> + <value></value> + </member> + <member name="T:Rhino.Mocks.Constraints.Anything"> + <summary> + Constraint that always returns true + </summary> + </member> + <member name="M:Rhino.Mocks.Constraints.Anything.Eval(System.Object)"> + <summary> + Determines if the object pass the constraints + </summary> + </member> + <member name="P:Rhino.Mocks.Constraints.Anything.Message"> + <summary> + Gets the message for this constraint + </summary> + <value></value> + </member> + <member name="T:Rhino.Mocks.Constraints.ComparingConstraint"> + <summary> + Constraint that evaluate whatever a comparable is greater than another + </summary> + </member> + <member name="M:Rhino.Mocks.Constraints.ComparingConstraint.#ctor(System.IComparable,System.Boolean,System.Boolean)"> + <summary> + Creates a new <see cref="T:Rhino.Mocks.Constraints.ComparingConstraint"/> instance. + </summary> + </member> + <member name="M:Rhino.Mocks.Constraints.ComparingConstraint.Eval(System.Object)"> + <summary> + Determines if the object pass the constraints + </summary> + </member> + <member name="P:Rhino.Mocks.Constraints.ComparingConstraint.Message"> + <summary> + Gets the message for this constraint + </summary> + <value></value> + </member> + <member name="M:Rhino.Mocks.Constraints.AllPropertiesMatchConstraint.#ctor(System.Object)"> + <summary> + Initializes a new constraint object. + </summary> + <param name="expected">The expected object, The actual object is passed in as a parameter to the <see cref="M:Rhino.Mocks.Constraints.AllPropertiesMatchConstraint.Eval(System.Object)"/> method</param> + </member> + <member name="M:Rhino.Mocks.Constraints.AllPropertiesMatchConstraint.Eval(System.Object)"> + <summary> + Evaluate this constraint. + </summary> + <param name="obj">The actual object that was passed in the method call to the mock.</param> + <returns>True when the constraint is met, else false.</returns> + </member> + <member name="M:Rhino.Mocks.Constraints.AllPropertiesMatchConstraint.CheckReferenceType(System.Object,System.Object)"> + <summary> + Checks if the properties of the <paramref name="actual"/> object + are the same as the properies of the <paramref name="expected"/> object. + </summary> + <param name="expected">The expected object</param> + <param name="actual">The actual object</param> + <returns>True when both objects have the same values, else False.</returns> + </member> + <member name="M:Rhino.Mocks.Constraints.AllPropertiesMatchConstraint.CheckValue(System.Object,System.Object)"> + <summary> + + </summary> + <param name="expected"></param> + <param name="actual"></param> + <returns></returns> + <remarks>This is the real heart of the beast.</remarks> + </member> + <member name="M:Rhino.Mocks.Constraints.AllPropertiesMatchConstraint.CheckProperties(System.Object,System.Object)"> + <summary> + Used by CheckReferenceType to check all properties of the reference type. + </summary> + <param name="expected">The expected object</param> + <param name="actual">The actual object</param> + <returns>True when both objects have the same values, else False.</returns> + </member> + <member name="M:Rhino.Mocks.Constraints.AllPropertiesMatchConstraint.CheckFields(System.Object,System.Object)"> + <summary> + Used by CheckReferenceType to check all fields of the reference type. + </summary> + <param name="expected">The expected object</param> + <param name="actual">The actual object</param> + <returns>True when both objects have the same values, else False.</returns> + </member> + <member name="M:Rhino.Mocks.Constraints.AllPropertiesMatchConstraint.CheckCollection(System.Collections.IEnumerable,System.Collections.IEnumerable)"> + <summary> + Checks the items of both collections + </summary> + <param name="expectedCollection">The expected collection</param> + <param name="actualCollection"></param> + <returns>True if both collections contain the same items in the same order.</returns> + </member> + <member name="M:Rhino.Mocks.Constraints.AllPropertiesMatchConstraint.BuildPropertyName"> + <summary> + Builds a propertyname from the Stack _properties like 'Order.Product.Price' + to be used in the error message. + </summary> + <returns>A nested property name.</returns> + </member> + <member name="P:Rhino.Mocks.Constraints.AllPropertiesMatchConstraint.Message"> + <summary> + Rhino.Mocks uses this property to generate an error message. + </summary> + <value> + A message telling the tester why the constraint failed. + </value> + </member> + <member name="T:Rhino.Mocks.Constraints.IsArg`1"> + <summary> + Provides access to the constraintes defined in the class <see cref="T:Rhino.Mocks.Constraints.Is"/> to be used in context + with the <see cref="T:Rhino.Mocks.Arg`1"/> syntax. + </summary> + <typeparam name="T">The type of the argument</typeparam> + </member> + <member name="M:Rhino.Mocks.Constraints.IsArg`1.GreaterThan(System.IComparable)"> + <summary> + Evaluate a greater than constraint for <see cref="T:System.IComparable"/>. + </summary> + <param name="objToCompare">The object the parameter should be greater than</param> + </member> + <member name="M:Rhino.Mocks.Constraints.IsArg`1.LessThan(System.IComparable)"> + <summary> + Evaluate a less than constraint for <see cref="T:System.IComparable"/>. + </summary> + <param name="objToCompare">The object the parameter should be less than</param> + </member> + <member name="M:Rhino.Mocks.Constraints.IsArg`1.LessThanOrEqual(System.IComparable)"> + <summary> + Evaluate a less than or equal constraint for <see cref="T:System.IComparable"/>. + </summary> + <param name="objToCompare">The object the parameter should be less than or equal to</param> + </member> + <member name="M:Rhino.Mocks.Constraints.IsArg`1.GreaterThanOrEqual(System.IComparable)"> + <summary> + Evaluate a greater than or equal constraint for <see cref="T:System.IComparable"/>. + </summary> + <param name="objToCompare">The object the parameter should be greater than or equal to</param> + </member> + <member name="M:Rhino.Mocks.Constraints.IsArg`1.Equal(System.Object)"> + <summary> + Evaluate an equal constraint for <see cref="T:System.IComparable"/>. + </summary> + <param name="obj">The object the parameter should equal to</param> + </member> + <member name="M:Rhino.Mocks.Constraints.IsArg`1.ConvertObjectTypeToMatch(System.IComparable)"> + <summary> + Converts the <see cref="T:System.IComparable"/>object type to a better match if this is a primitive type. + </summary> + <param name="obj">The obj.</param> + <returns></returns> + </member> + <member name="M:Rhino.Mocks.Constraints.IsArg`1.ConvertObjectTypeToMatch(System.Object)"> + <summary> + Converts the object type to match. + </summary> + <remarks> + Because of implicit conversions and the way ArgConstraints this method is needed to check + object type and potentially change the object type for a better "match" so that obj1.Equals(obj2) + will return the proper "answer" + </remarks> + <param name="obj">The obj.</param> + <returns></returns> + </member> + <member name="M:Rhino.Mocks.Constraints.IsArg`1.NotEqual(System.Object)"> + <summary> + Evaluate a not equal constraint for <see cref="T:System.IComparable"/>. + </summary> + <param name="obj">The object the parameter should not equal to</param> + </member> + <member name="M:Rhino.Mocks.Constraints.IsArg`1.Same(System.Object)"> + <summary> + Evaluate a same as constraint. + </summary> + <param name="obj">The object the parameter should the same as.</param> + </member> + <member name="M:Rhino.Mocks.Constraints.IsArg`1.NotSame(System.Object)"> + <summary> + Evaluate a not same as constraint. + </summary> + <param name="obj">The object the parameter should not be the same as.</param> + </member> + <member name="M:Rhino.Mocks.Constraints.IsArg`1.Equals(System.Object)"> + <summary> + Throws NotSupportedException. Don't use Equals to define constraints. Use Equal instead. + </summary> + <param name="obj"></param> + <returns></returns> + </member> + <member name="M:Rhino.Mocks.Constraints.IsArg`1.GetHashCode"> + <summary> + Serves as a hash function for a particular type. + </summary> + <returns> + A hash code for the current <see cref="T:System.Object"/>. + </returns> + </member> + <member name="P:Rhino.Mocks.Constraints.IsArg`1.Anything"> + <summary> + A constraints that accept anything + </summary> + <returns></returns> + </member> + <member name="P:Rhino.Mocks.Constraints.IsArg`1.Null"> + <summary> + A constraint that accept only nulls + </summary> + <returns></returns> + </member> + <member name="P:Rhino.Mocks.Constraints.IsArg`1.NotNull"> + <summary> + A constraint that accept only non null values + </summary> + <returns></returns> + </member> + <member name="P:Rhino.Mocks.Constraints.IsArg`1.TypeOf"> + <summary> + A constraint that accept only value of the specified type. + The check is performed on the type that has been defined + as the argument type. + </summary> + </member> + <member name="T:Rhino.Mocks.Constraints.ListArg`1"> + <summary> + Provides access to the constraints defined in the class <see cref="T:Rhino.Mocks.Constraints.Text"/> to be used in context + with the <see cref="T:Rhino.Mocks.Arg`1"/> syntax. + </summary> + </member> + <member name="M:Rhino.Mocks.Constraints.ListArg`1.IsIn(System.Object)"> + <summary> + Determines whether the specified object is in the parameter. + The parameter must be IEnumerable. + </summary> + <param name="obj">Obj.</param> + <returns></returns> + </member> + <member name="M:Rhino.Mocks.Constraints.ListArg`1.OneOf(System.Collections.IEnumerable)"> + <summary> + Determines whatever the parameter is in the collection. + </summary> + </member> + <member name="M:Rhino.Mocks.Constraints.ListArg`1.Equal(System.Collections.IEnumerable)"> + <summary> + Determines that the parameter collection is identical to the specified collection + </summary> + </member> + <member name="M:Rhino.Mocks.Constraints.ListArg`1.Count(Rhino.Mocks.Constraints.AbstractConstraint)"> + <summary> + Determines that the parameter collection has the specified number of elements. + </summary> + <param name="constraint">The constraint that should be applied to the collection count.</param> + </member> + <member name="M:Rhino.Mocks.Constraints.ListArg`1.Element(System.Int32,Rhino.Mocks.Constraints.AbstractConstraint)"> + <summary> + Determines that an element of the parameter collections conforms to another AbstractConstraint. + </summary> + <param name="index">The zero-based index of the list element.</param> + <param name="constraint">The constraint which should be applied to the list element.</param> + </member> + <member name="M:Rhino.Mocks.Constraints.ListArg`1.ContainsAll(System.Collections.IEnumerable)"> + <summary> + Determines that all elements of the specified collection are in the the parameter collection + </summary> + <param name="collection">The collection to compare against</param> + <returns>The constraint which should be applied to the list parameter.</returns> + </member> + <member name="M:Rhino.Mocks.Constraints.ListArg`1.Equals(System.Object)"> + <summary> + Throws NotSupportedException. Don't use Equals to define constraints. Use Equal instead. + </summary> + <param name="obj"></param> + <returns></returns> + </member> + <member name="M:Rhino.Mocks.Constraints.ListArg`1.GetHashCode"> + <summary> + Serves as a hash function for a particular type. + </summary> + <returns> + A hash code for the current <see cref="T:System.Object"/>. + </returns> + </member> + <member name="T:Rhino.Mocks.Constraints.OutRefArgDummy`1"> + <summary> + Provides a dummy field to pass as out or ref argument. + </summary> + <typeparam name="T"></typeparam> + </member> + <member name="F:Rhino.Mocks.Constraints.OutRefArgDummy`1.Dummy"> + <summary> + Dummy field to satisfy the compiler. Used for out and ref arguments. + </summary> + </member> + <member name="T:Rhino.Mocks.Constraints.PublicField"> + <summary> + Central location for constraints for object's public fields + </summary> + </member> + <member name="M:Rhino.Mocks.Constraints.PublicField.Value(System.String,System.Object)"> + <summary> + Constrains the parameter to have a public field with the specified value + </summary> + <param name="publicFieldName">Name of the public field.</param> + <param name="expectedValue">Expected value.</param> + <returns></returns> + </member> + <member name="M:Rhino.Mocks.Constraints.PublicField.Value(System.Type,System.String,System.Object)"> + <summary> + Constrains the parameter to have a public field with the specified value. + </summary> + <param name="declaringType">The type that declares the public field, used to disambiguate between public fields.</param> + <param name="publicFieldName">Name of the public field.</param> + <param name="expectedValue">Expected value.</param> + <returns></returns> + </member> + <member name="M:Rhino.Mocks.Constraints.PublicField.ValueConstraint(System.String,Rhino.Mocks.Constraints.AbstractConstraint)"> + <summary> + Constrains the parameter to have a public field satisfying a specified constraint. + </summary> + <param name="publicFieldName">Name of the public field.</param> + <param name="publicFieldConstraint">Constraint for the public field.</param> + </member> + <member name="M:Rhino.Mocks.Constraints.PublicField.ValueConstraint(System.Type,System.String,Rhino.Mocks.Constraints.AbstractConstraint)"> + <summary> + Constrains the parameter to have a public field satisfying a specified constraint. + </summary> + <param name="declaringType">The type that declares the public field, used to disambiguate between public fields.</param> + <param name="publicFieldName">Name of the public field.</param> + <param name="publicFieldConstraint">Constraint for the public field.</param> + </member> + <member name="M:Rhino.Mocks.Constraints.PublicField.IsNull(System.String)"> + <summary> + Determines whether the parameter has the specified public field and that it is null. + </summary> + <param name="publicFieldName">Name of the public field.</param> + <returns></returns> + </member> + <member name="M:Rhino.Mocks.Constraints.PublicField.IsNull(System.Type,System.String)"> + <summary> + Determines whether the parameter has the specified public field and that it is null. + </summary> + <param name="declaringType">The type that declares the public field, used to disambiguate between public fields.</param> + <param name="publicFieldName">Name of the public field.</param> + <returns></returns> + </member> + <member name="M:Rhino.Mocks.Constraints.PublicField.IsNotNull(System.String)"> + <summary> + Determines whether the parameter has the specified public field and that it is not null. + </summary> + <param name="publicFieldName">Name of the public field.</param> + <returns></returns> + </member> + <member name="M:Rhino.Mocks.Constraints.PublicField.IsNotNull(System.Type,System.String)"> + <summary> + Determines whether the parameter has the specified public field and that it is not null. + </summary> + <param name="declaringType">The type that declares the public field, used to disambiguate between public fields.</param> + <param name="publicFieldName">Name of the public field.</param> + <returns></returns> + </member> + <member name="T:Rhino.Mocks.Constraints.Is"> + <summary> + Central location for constraints + </summary> + </member> + <member name="M:Rhino.Mocks.Constraints.Is.GreaterThan(System.IComparable)"> + <summary> + Evaluate a greater than constraint for <see cref="T:System.IComparable"/>. + </summary> + <param name="objToCompare">The object the parameter should be greater than</param> + </member> + <member name="M:Rhino.Mocks.Constraints.Is.LessThan(System.IComparable)"> + <summary> + Evaluate a less than constraint for <see cref="T:System.IComparable"/>. + </summary> + <param name="objToCompare">The object the parameter should be less than</param> + </member> + <member name="M:Rhino.Mocks.Constraints.Is.LessThanOrEqual(System.IComparable)"> + <summary> + Evaluate a less than or equal constraint for <see cref="T:System.IComparable"/>. + </summary> + <param name="objToCompare">The object the parameter should be less than or equal to</param> + </member> + <member name="M:Rhino.Mocks.Constraints.Is.GreaterThanOrEqual(System.IComparable)"> + <summary> + Evaluate a greater than or equal constraint for <see cref="T:System.IComparable"/>. + </summary> + <param name="objToCompare">The object the parameter should be greater than or equal to</param> + </member> + <member name="M:Rhino.Mocks.Constraints.Is.Equal(System.Object)"> + <summary> + Evaluate an equal constraint for <see cref="T:System.IComparable"/>. + </summary> + <param name="obj">The object the parameter should equal to</param> + </member> + <member name="M:Rhino.Mocks.Constraints.Is.NotEqual(System.Object)"> + <summary> + Evaluate a not equal constraint for <see cref="T:System.IComparable"/>. + </summary> + <param name="obj">The object the parameter should not equal to</param> + </member> + <member name="M:Rhino.Mocks.Constraints.Is.Same(System.Object)"> + <summary> + Evaluate a same as constraint. + </summary> + <param name="obj">The object the parameter should the same as.</param> + </member> + <member name="M:Rhino.Mocks.Constraints.Is.NotSame(System.Object)"> + <summary> + Evaluate a not same as constraint. + </summary> + <param name="obj">The object the parameter should not be the same as.</param> + </member> + <member name="M:Rhino.Mocks.Constraints.Is.Anything"> + <summary> + A constraints that accept anything + </summary> + <returns></returns> + </member> + <member name="M:Rhino.Mocks.Constraints.Is.Null"> + <summary> + A constraint that accept only nulls + </summary> + <returns></returns> + </member> + <member name="M:Rhino.Mocks.Constraints.Is.NotNull"> + <summary> + A constraint that accept only non null values + </summary> + <returns></returns> + </member> + <member name="M:Rhino.Mocks.Constraints.Is.TypeOf(System.Type)"> + <summary> + A constraint that accept only value of the specified type + </summary> + </member> + <member name="M:Rhino.Mocks.Constraints.Is.TypeOf``1"> + <summary> + A constraint that accept only value of the specified type + </summary> + </member> + <member name="M:Rhino.Mocks.Constraints.Is.Matching``1(System.Predicate{``0})"> + <summary> + Evaluate a parameter using a predicate + </summary> + <param name="predicate">The predicate to use</param> + </member> + <member name="T:Rhino.Mocks.Constraints.List"> + <summary> + Central location for constraints about lists and collections + </summary> + </member> + <member name="M:Rhino.Mocks.Constraints.List.IsIn(System.Object)"> + <summary> + Determines whether the specified obj is in the parameter. + The parameter must be IEnumerable. + </summary> + <param name="obj">Obj.</param> + <returns></returns> + </member> + <member name="M:Rhino.Mocks.Constraints.List.OneOf(System.Collections.IEnumerable)"> + <summary> + Determines whatever the parameter is in the collection. + </summary> + </member> + <member name="M:Rhino.Mocks.Constraints.List.Equal(System.Collections.IEnumerable)"> + <summary> + Determines that the parameter collection is identical to the specified collection + </summary> + </member> + <member name="M:Rhino.Mocks.Constraints.List.Count(Rhino.Mocks.Constraints.AbstractConstraint)"> + <summary> + Determines that the parameter collection has the specified number of elements. + </summary> + <param name="constraint">The constraint that should be applied to the collection count.</param> + </member> + <member name="M:Rhino.Mocks.Constraints.List.Element(System.Int32,Rhino.Mocks.Constraints.AbstractConstraint)"> + <summary> + Determines that an element of the parameter collections conforms to another AbstractConstraint. + </summary> + <param name="index">The zero-based index of the list element.</param> + <param name="constraint">The constraint which should be applied to the list element.</param> + </member> + <member name="M:Rhino.Mocks.Constraints.List.Element``1(``0,Rhino.Mocks.Constraints.AbstractConstraint)"> + <summary> + Determines that an element of the parameter collections conforms to another AbstractConstraint. + </summary> + <param name="key">The key of the element.</param> + <param name="constraint">The constraint which should be applied to the element.</param> + </member> + <member name="M:Rhino.Mocks.Constraints.List.ContainsAll(System.Collections.IEnumerable)"> + <summary> + Determines that all elements of the specified collection are in the the parameter collection + </summary> + <param name="collection">The collection to compare against</param> + <returns>The constraint which should be applied to the list parameter.</returns> + </member> + <member name="T:Rhino.Mocks.Constraints.Property"> + <summary> + Central location for constraints for object's properties + </summary> + </member> + <member name="M:Rhino.Mocks.Constraints.Property.Value(System.String,System.Object)"> + <summary> + Constrains the parameter to have property with the specified value + </summary> + <param name="propertyName">Name of the property.</param> + <param name="expectedValue">Expected value.</param> + <returns></returns> + </member> + <member name="M:Rhino.Mocks.Constraints.Property.Value(System.Type,System.String,System.Object)"> + <summary> + Constrains the parameter to have property with the specified value. + </summary> + <param name="declaringType">The type that declares the property, used to disambiguate between properties.</param> + <param name="propertyName">Name of the property.</param> + <param name="expectedValue">Expected value.</param> + <returns></returns> + </member> + <member name="M:Rhino.Mocks.Constraints.Property.ValueConstraint(System.String,Rhino.Mocks.Constraints.AbstractConstraint)"> + <summary> + Constrains the parameter to have a property satisfying a specified constraint. + </summary> + <param name="propertyName">Name of the property.</param> + <param name="propertyConstraint">Constraint for the property.</param> + </member> + <member name="M:Rhino.Mocks.Constraints.Property.ValueConstraint(System.Type,System.String,Rhino.Mocks.Constraints.AbstractConstraint)"> + <summary> + Constrains the parameter to have a property satisfying a specified constraint. + </summary> + <param name="declaringType">The type that declares the property, used to disambiguate between properties.</param> + <param name="propertyName">Name of the property.</param> + <param name="propertyConstraint">Constraint for the property.</param> + </member> + <member name="M:Rhino.Mocks.Constraints.Property.IsNull(System.String)"> + <summary> + Determines whether the parameter has the specified property and that it is null. + </summary> + <param name="propertyName">Name of the property.</param> + <returns></returns> + </member> + <member name="M:Rhino.Mocks.Constraints.Property.IsNull(System.Type,System.String)"> + <summary> + Determines whether the parameter has the specified property and that it is null. + </summary> + <param name="declaringType">The type that declares the property, used to disambiguate between properties.</param> + <param name="propertyName">Name of the property.</param> + <returns></returns> + </member> + <member name="M:Rhino.Mocks.Constraints.Property.IsNotNull(System.String)"> + <summary> + Determines whether the parameter has the specified property and that it is not null. + </summary> + <param name="propertyName">Name of the property.</param> + <returns></returns> + </member> + <member name="M:Rhino.Mocks.Constraints.Property.IsNotNull(System.Type,System.String)"> + <summary> + Determines whether the parameter has the specified property and that it is not null. + </summary> + <param name="declaringType">The type that declares the property, used to disambiguate between properties.</param> + <param name="propertyName">Name of the property.</param> + <returns></returns> + </member> + <member name="M:Rhino.Mocks.Constraints.Property.AllPropertiesMatch(System.Object)"> + <summary> + constraints the parameter to have the exact same property values as the expected object. + </summary> + <param name="expected">An object, of the same type as the parameter, whose properties are set with the expected values.</param> + <returns>An instance of the constraint that will do the actual check.</returns> + <remarks> + The parameter's public property values and public field values will be matched against the expected object's + public property values and public field values. The first mismatch will be reported and no further matching is done. + The matching is recursive for any property or field that has properties or fields of it's own. + Collections are supported through IEnumerable, which means the constraint will check if the actual and expected + collection contain the same values in the same order, where the values contained by the collection can have properties + and fields of their own that will be checked as well because of the recursive nature of this constraint. + </remarks> + </member> + <member name="T:Rhino.Mocks.Constraints.Text"> + <summary> + Central location for all text related constraints + </summary> + </member> + <member name="M:Rhino.Mocks.Constraints.Text.StartsWith(System.String)"> + <summary> + Constrain the argument to starts with the specified string + </summary> + </member> + <member name="M:Rhino.Mocks.Constraints.Text.EndsWith(System.String)"> + <summary> + Constrain the argument to end with the specified string + </summary> + </member> + <member name="M:Rhino.Mocks.Constraints.Text.Contains(System.String)"> + <summary> + Constrain the argument to contain the specified string + </summary> + </member> + <member name="M:Rhino.Mocks.Constraints.Text.Like(System.String)"> + <summary> + Constrain the argument to validate according to regex pattern + </summary> + </member> + <member name="T:Rhino.Mocks.Constraints.TextArg"> + <summary> + Provides access to the constraintes defined in the class <see cref="T:Rhino.Mocks.Constraints.Text"/> to be used in context + with the <see cref="T:Rhino.Mocks.Arg"/> syntax. + </summary> + </member> + <member name="M:Rhino.Mocks.Constraints.TextArg.StartsWith(System.String)"> + <summary> + Constrain the argument to starts with the specified string + </summary> + <returns></returns> + </member> + <member name="M:Rhino.Mocks.Constraints.TextArg.EndsWith(System.String)"> + <summary> + Constrain the argument to end with the specified string + </summary> + </member> + <member name="M:Rhino.Mocks.Constraints.TextArg.Contains(System.String)"> + <summary> + Constrain the argument to contain the specified string + </summary> + </member> + <member name="M:Rhino.Mocks.Constraints.TextArg.Like(System.String)"> + <summary> + Constrain the argument to validate according to regex pattern + </summary> + </member> + <member name="M:Rhino.Mocks.Constraints.TextArg.Equals(System.Object)"> + <summary> + Throws NotSupportedException. Don't use Equals to define constraints. Use Equal instead. + </summary> + <param name="obj"></param> + <returns></returns> + </member> + <member name="M:Rhino.Mocks.Constraints.TextArg.GetHashCode"> + <summary> + Serves as a hash function for a particular type. + </summary> + <returns> + A hash code for the current <see cref="T:System.Object"/>. + </returns> + </member> + <member name="T:Rhino.Mocks.Delegates"> + <summary> + This class defines a lot of method signatures, which we will use + to allow compatability on net-2.0 + </summary> + </member> + <member name="T:Rhino.Mocks.Delegates.Action"> + <summary> + dummy + </summary> + </member> + <member name="T:Rhino.Mocks.Delegates.Function`1"> + <summary> + dummy + </summary> + </member> + <member name="T:Rhino.Mocks.Delegates.Function`2"> + <summary> + dummy + </summary> + </member> + <member name="T:Rhino.Mocks.Delegates.Action`2"> + <summary> + dummy + </summary> + </member> + <member name="T:Rhino.Mocks.Delegates.Function`3"> + <summary> + dummy + </summary> + </member> + <member name="T:Rhino.Mocks.Delegates.Action`3"> + <summary> + dummy + </summary> + </member> + <member name="T:Rhino.Mocks.Delegates.Function`4"> + <summary> + dummy + </summary> + </member> + <member name="T:Rhino.Mocks.Delegates.Action`4"> + <summary> + dummy + </summary> + </member> + <member name="T:Rhino.Mocks.Delegates.Function`5"> + <summary> + dummy + </summary> + </member> + <member name="T:Rhino.Mocks.Delegates.Action`5"> + <summary> + dummy + </summary> + </member> + <member name="T:Rhino.Mocks.Delegates.Function`6"> + <summary> + dummy + </summary> + </member> + <member name="T:Rhino.Mocks.Delegates.Action`6"> + <summary> + dummy + </summary> + <summary> + dummy + </summary> + </member> + <member name="T:Rhino.Mocks.Delegates.Function`7"> + <summary> + dummy + </summary> + </member> + <member name="T:Rhino.Mocks.Delegates.Action`7"> + <summary> + dummy + </summary> + </member> + <member name="T:Rhino.Mocks.Delegates.Function`8"> + <summary> + dummy + </summary> + </member> + <member name="T:Rhino.Mocks.Delegates.Action`8"> + <summary> + dummy + </summary> + </member> + <member name="T:Rhino.Mocks.Delegates.Function`9"> + <summary> + dummy + </summary> + </member> + <member name="T:Rhino.Mocks.Delegates.Action`9"> + <summary> + dummy + </summary> + </member> + <member name="T:Rhino.Mocks.Delegates.Function`10"> + <summary> + dummy + </summary> + </member> + <member name="T:Rhino.Mocks.Delegates.Action`10"> + <summary> + dummy + </summary> + </member> + <member name="T:Rhino.Mocks.Delegates.Function`11"> + <summary> + dummy + </summary> + </member> + <member name="T:Rhino.Mocks.DoNotExpect"> + <summary> + Allows expectations to be set on methods that should never be called. + For methods with void return value, you need to use LastCall or + DoNotExpect.Call() with a delegate. + </summary> + </member> + <member name="M:Rhino.Mocks.DoNotExpect.Call(System.Object)"> + <summary> + Sets LastCall.Repeat.Never() on /any/ proxy on /any/ repository on the current thread. + This method if not safe for multi threading scenarios. + </summary> + </member> + <member name="M:Rhino.Mocks.DoNotExpect.Call(Rhino.Mocks.Expect.Action)"> + <summary> + Accepts a delegate that will execute inside the method which + LastCall.Repeat.Never() will be applied to. + It is expected to be used with anonymous delegates / lambda expressions and only one + method should be called. + </summary> + <example> + IService mockSrv = mocks.CreateMock(typeof(IService)) as IService; + DoNotExpect.Call(delegate{ mockSrv.Stop(); }); + ... + </example> + </member> + <member name="T:Rhino.Mocks.Exceptions.ExpectationViolationException"> + <summary> + An expectaton violation was detected. + </summary> + </member> + <member name="M:Rhino.Mocks.Exceptions.ExpectationViolationException.#ctor(System.String)"> + <summary> + Creates a new <see cref="T:Rhino.Mocks.Exceptions.ExpectationViolationException"/> instance. + </summary> + <param name="message">Message.</param> + </member> + <member name="M:Rhino.Mocks.Exceptions.ExpectationViolationException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> + <summary> + Serialization constructor + </summary> + </member> + <member name="T:Rhino.Mocks.Exceptions.ObjectNotMockFromThisRepositoryException"> + <summary> + Signals that an object was call on a mock repository which doesn't + belong to this mock repository or not a mock + </summary> + </member> + <member name="M:Rhino.Mocks.Exceptions.ObjectNotMockFromThisRepositoryException.#ctor(System.String)"> + <summary> + Creates a new <see cref="T:Rhino.Mocks.Exceptions.ObjectNotMockFromThisRepositoryException"/> instance. + </summary> + <param name="message">Message.</param> + </member> + <member name="M:Rhino.Mocks.Exceptions.ObjectNotMockFromThisRepositoryException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> + <summary> + Serialization constructor + </summary> + </member> + <member name="T:Rhino.Mocks.Expect"> + <summary> + Allows to set expectation on methods that has return values. + For methods with void return value, you need to use LastCall + </summary> + </member> + <member name="M:Rhino.Mocks.Expect.Call``1(``0)"> + <summary> + The method options for the last call on /any/ proxy on /any/ repository on the current thread. + This method if not safe for multi threading scenarios, use <see cref="M:Rhino.Mocks.Expect.On(System.Object)"/>. + </summary> + </member> + <member name="M:Rhino.Mocks.Expect.Call(Rhino.Mocks.Expect.Action)"> + <summary> + Accepts a delegate that will execute inside the method, and then return the resulting + <see cref="T:Rhino.Mocks.Interfaces.IMethodOptions`1"/> instance. + It is expected to be used with anonymous delegates / lambda expressions and only one + method should be called. + </summary> + <example> + IService mockSrv = mocks.CreateMock(typeof(IService)) as IService; + Expect.Call(delegate{ mockSrv.Start(); }).Throw(new NetworkException()); + ... + </example> + </member> + <member name="M:Rhino.Mocks.Expect.On(System.Object)"> + <summary> + Get the method options for the last method call on the mockInstance. + </summary> + </member> + <member name="T:Rhino.Mocks.Expect.Action"> + <summary> + A delegate that can be used to get better syntax on Expect.Call(delegate { foo.DoSomething(); }); + </summary> + </member> + <member name="T:Rhino.Mocks.Expectations.AbstractExpectation"> + <summary> + Abstract class that holds common information for + expectations. + </summary> + </member> + <member name="T:Rhino.Mocks.Interfaces.IExpectation"> + <summary> + Interface to validate that a method call is correct. + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.IExpectation.IsExpected(System.Object[])"> + <summary> + Validate the arguments for the method. + This method can be called numerous times, so be careful about side effects + </summary> + <param name="args">The arguments with which the method was called</param> + </member> + <member name="M:Rhino.Mocks.Interfaces.IExpectation.AddActualCall"> + <summary> + Add an actual method call to this expectation + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.IExpectation.ReturnOrThrow(Castle.Core.Interceptor.IInvocation,System.Object[])"> + <summary> + Returns the return value or throw the exception and setup any output / ref parameters + that has been set. + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.IExpectation.BuildVerificationFailureMessage"> + <summary> + Builds the verification failure message. + </summary> + <returns></returns> + </member> + <member name="P:Rhino.Mocks.Interfaces.IExpectation.ErrorMessage"> + <summary> + Gets the error message. + </summary> + <value></value> + </member> + <member name="P:Rhino.Mocks.Interfaces.IExpectation.Expected"> + <summary> + Range of expected calls + </summary> + </member> + <member name="P:Rhino.Mocks.Interfaces.IExpectation.ActualCallsCount"> + <summary> + Number of call actually made for this method + </summary> + </member> + <member name="P:Rhino.Mocks.Interfaces.IExpectation.CanAcceptCalls"> + <summary> + If this expectation is still waiting for calls. + </summary> + </member> + <member name="P:Rhino.Mocks.Interfaces.IExpectation.ReturnValue"> + <summary> + The return value for a method matching this expectation + </summary> + </member> + <member name="P:Rhino.Mocks.Interfaces.IExpectation.ExceptionToThrow"> + <summary> + Gets or sets the exception to throw on a method matching this expectation. + </summary> + </member> + <member name="P:Rhino.Mocks.Interfaces.IExpectation.ActionsSatisfied"> + <summary> + Gets a value indicating whether this instance's action is staisfied. + A staisfied instance means that there are no more requirements from + this method. A method with non void return value must register either + a return value or an exception to throw. + </summary> + </member> + <member name="P:Rhino.Mocks.Interfaces.IExpectation.Method"> + <summary> + Gets the method this expectation is for. + </summary> + </member> + <member name="P:Rhino.Mocks.Interfaces.IExpectation.RepeatableOption"> + <summary> + Gets or sets what special condtions there are for this method + repeating. + </summary> + </member> + <member name="P:Rhino.Mocks.Interfaces.IExpectation.ExpectationSatisfied"> + <summary> + Gets a value indicating whether this expectation was satisfied + </summary> + </member> + <member name="P:Rhino.Mocks.Interfaces.IExpectation.HasReturnValue"> + <summary> + Specify whatever this expectation has a return value set + You can't check ReturnValue for this because a valid return value include null. + </summary> + </member> + <member name="P:Rhino.Mocks.Interfaces.IExpectation.ActionToExecute"> + <summary> + An action to execute when the method is matched. + </summary> + </member> + <member name="P:Rhino.Mocks.Interfaces.IExpectation.OutRefParams"> + <summary> + Set the out / ref parameters for the method call. + The indexing is zero based and ignores any non out/ref parameter. + It is possible not to pass all the parameters. This method can be called only once. + </summary> + </member> + <member name="P:Rhino.Mocks.Interfaces.IExpectation.Message"> + <summary> + Documentation Message + </summary> + </member> + <member name="P:Rhino.Mocks.Interfaces.IExpectation.Originalinvocation"> + <summary> + Gets the invocation for this expectation + </summary> + <value>The invocation.</value> + </member> + <member name="E:Rhino.Mocks.Interfaces.IExpectation.WhenCalled"> + <summary> + Occurs when the exceptation is match on a method call + </summary> + </member> + <member name="P:Rhino.Mocks.Interfaces.IExpectation.AllowTentativeReturn"> + <summary> + Allow to set the return value in the future, if it was already set. + </summary> + </member> + <member name="F:Rhino.Mocks.Expectations.AbstractExpectation.actualCallsCount"> + <summary> + Number of actuall calls made that passed this expectation + </summary> + </member> + <member name="F:Rhino.Mocks.Expectations.AbstractExpectation.expected"> + <summary> + Range of expected calls that should pass this expectation. + </summary> + </member> + <member name="F:Rhino.Mocks.Expectations.AbstractExpectation.returnValue"> + <summary> + The return value for a method matching this expectation + </summary> + </member> + <member name="F:Rhino.Mocks.Expectations.AbstractExpectation.exceptionToThrow"> + <summary> + The exception to throw on a method matching this expectation. + </summary> + </member> + <member name="F:Rhino.Mocks.Expectations.AbstractExpectation.method"> + <summary> + The method this expectation is for. + </summary> + </member> + <member name="F:Rhino.Mocks.Expectations.AbstractExpectation.returnValueSet"> + <summary> + The return value for this method was set + </summary> + </member> + <member name="F:Rhino.Mocks.Expectations.AbstractExpectation.repeatableOption"> + <summary> + Whether this method will repeat + unlimited number of times. + </summary> + </member> + <member name="F:Rhino.Mocks.Expectations.AbstractExpectation.actionToExecute"> + <summary> + A delegate that will be run when the + expectation is matched. + </summary> + </member> + <member name="F:Rhino.Mocks.Expectations.AbstractExpectation.matchingArgs"> + <summary> + The arguments that matched this expectation. + </summary> + </member> + <member name="F:Rhino.Mocks.Expectations.AbstractExpectation.message"> + <summary> + Documentation message + </summary> + </member> + <member name="F:Rhino.Mocks.Expectations.AbstractExpectation.originalInvocation"> + <summary> + The method originalInvocation + </summary> + </member> + <member name="M:Rhino.Mocks.Expectations.AbstractExpectation.GetHashCode"> + <summary> + Get the hash code + </summary> + </member> + <member name="M:Rhino.Mocks.Expectations.AbstractExpectation.AddActualCall"> + <summary> + Add an actual actualMethodCall call to this expectation + </summary> + </member> + <member name="M:Rhino.Mocks.Expectations.AbstractExpectation.BuildVerificationFailureMessage"> + <summary> + Builds the verification failure message. + </summary> + <returns></returns> + </member> + <member name="M:Rhino.Mocks.Expectations.AbstractExpectation.ReturnOrThrow(Castle.Core.Interceptor.IInvocation,System.Object[])"> + <summary> + Returns the return value or throw the exception and setup output / ref parameters + </summary> + </member> + <member name="M:Rhino.Mocks.Expectations.AbstractExpectation.IsExpected(System.Object[])"> + <summary> + Validate the arguments for the method on the child methods + </summary> + <param name="args">The arguments with which the method was called</param> + </member> + <member name="M:Rhino.Mocks.Expectations.AbstractExpectation.#ctor(Castle.Core.Interceptor.IInvocation,Rhino.Mocks.Impl.Range)"> + <summary> + Creates a new <see cref="T:Rhino.Mocks.Expectations.AbstractExpectation"/> instance. + </summary> + <param name="invocation">The originalInvocation for this method, required because it contains the generic type infromation</param> + <param name="expectedRange">Number of method calls for this expectations</param> + </member> + <member name="M:Rhino.Mocks.Expectations.AbstractExpectation.#ctor(Rhino.Mocks.Interfaces.IExpectation)"> + <summary> + Creates a new <see cref="T:Rhino.Mocks.Expectations.AbstractExpectation"/> instance. + </summary> + <param name="expectation">Expectation.</param> + </member> + <member name="M:Rhino.Mocks.Expectations.AbstractExpectation.DoIsExpected(System.Object[])"> + <summary> + Validate the arguments for the method on the child methods + </summary> + <param name="args">The arguments with which the method was called</param> + </member> + <member name="M:Rhino.Mocks.Expectations.AbstractExpectation.Equals(System.Object)"> + <summary> + Determines if this object equal to obj + </summary> + </member> + <member name="M:Rhino.Mocks.Expectations.AbstractExpectation.CreateErrorMessage(System.String)"> + <summary> + The error message for these arguments + </summary> + </member> + <member name="M:Rhino.Mocks.Expectations.AbstractExpectation.AssertDelegateArgumentsMatchMethod(System.Delegate)"> + <summary> + Asserts that the delegate has the same parameters as the expectation's method call + </summary> + </member> + <member name="P:Rhino.Mocks.Expectations.AbstractExpectation.OutRefParams"> + <summary> + Setter for the outpur / ref parameters for this expecataion. + Can only be set once. + </summary> + </member> + <member name="P:Rhino.Mocks.Expectations.AbstractExpectation.HasReturnValue"> + <summary> + Specify whether this expectation has a return value set + You can't check ReturnValue for this because a valid return value include null. + </summary> + </member> + <member name="P:Rhino.Mocks.Expectations.AbstractExpectation.Method"> + <summary> + Gets the method this expectation is for. + </summary> + </member> + <member name="P:Rhino.Mocks.Expectations.AbstractExpectation.Originalinvocation"> + <summary> + Gets the originalInvocation for this expectation + </summary> + <value>The originalInvocation.</value> + </member> + <member name="P:Rhino.Mocks.Expectations.AbstractExpectation.RepeatableOption"> + <summary> + Gets or sets what special condtions there are for this method + </summary> + </member> + <member name="P:Rhino.Mocks.Expectations.AbstractExpectation.Expected"> + <summary> + Range of expected calls + </summary> + </member> + <member name="P:Rhino.Mocks.Expectations.AbstractExpectation.ActualCallsCount"> + <summary> + Number of call actually made for this method + </summary> + </member> + <member name="P:Rhino.Mocks.Expectations.AbstractExpectation.CanAcceptCalls"> + <summary> + If this expectation is still waiting for calls. + </summary> + </member> + <member name="P:Rhino.Mocks.Expectations.AbstractExpectation.ExpectationSatisfied"> + <summary> + Gets a value indicating whether this expectation was satisfied + </summary> + </member> + <member name="P:Rhino.Mocks.Expectations.AbstractExpectation.ReturnValue"> + <summary> + The return value for a method matching this expectation + </summary> + </member> + <member name="P:Rhino.Mocks.Expectations.AbstractExpectation.ActionToExecute"> + <summary> + An action to execute when the method is matched. + </summary> + </member> + <member name="P:Rhino.Mocks.Expectations.AbstractExpectation.ExceptionToThrow"> + <summary> + Gets or sets the exception to throw on a method matching this expectation. + </summary> + </member> + <member name="P:Rhino.Mocks.Expectations.AbstractExpectation.ActionsSatisfied"> + <summary> + Gets a value indicating whether this instance's action is staisfied. + A staisfied instance means that there are no more requirements from + this method. A method with non void return value must register either + a return value or an exception to throw or an action to execute. + </summary> + </member> + <member name="P:Rhino.Mocks.Expectations.AbstractExpectation.Message"> + <summary> + Documentation message + </summary> + </member> + <member name="E:Rhino.Mocks.Expectations.AbstractExpectation.WhenCalled"> + <summary> + Occurs when the exceptation is match on a method call + </summary> + </member> + <member name="P:Rhino.Mocks.Expectations.AbstractExpectation.AllowTentativeReturn"> + <summary> + Allow to set the return value in the future, if it was already set. + </summary> + </member> + <member name="P:Rhino.Mocks.Expectations.AbstractExpectation.ErrorMessage"> + <summary> + Gets the error message. + </summary> + <value></value> + </member> + <member name="T:Rhino.Mocks.Expectations.AnyArgsExpectation"> + <summary> + Expectation that matches any arguments for the method. + </summary> + </member> + <member name="M:Rhino.Mocks.Expectations.AnyArgsExpectation.#ctor(Castle.Core.Interceptor.IInvocation,Rhino.Mocks.Impl.Range)"> + <summary> + Creates a new <see cref="T:Rhino.Mocks.Expectations.AnyArgsExpectation"/> instance. + </summary> + <param name="invocation">Invocation for this expectation</param> + <param name="expectedRange">Number of method calls for this expectations</param> + </member> + <member name="M:Rhino.Mocks.Expectations.AnyArgsExpectation.#ctor(Rhino.Mocks.Interfaces.IExpectation)"> + <summary> + Creates a new <see cref="T:Rhino.Mocks.Expectations.AnyArgsExpectation"/> instance. + </summary> + <param name="expectation">Expectation.</param> + </member> + <member name="M:Rhino.Mocks.Expectations.AnyArgsExpectation.DoIsExpected(System.Object[])"> + <summary> + Validate the arguments for the method. + </summary> + <param name="args">The arguments with which the method was called</param> + </member> + <member name="M:Rhino.Mocks.Expectations.AnyArgsExpectation.Equals(System.Object)"> + <summary> + Determines if the object equal to expectation + </summary> + </member> + <member name="M:Rhino.Mocks.Expectations.AnyArgsExpectation.GetHashCode"> + <summary> + Get the hash code + </summary> + </member> + <member name="P:Rhino.Mocks.Expectations.AnyArgsExpectation.ErrorMessage"> + <summary> + Gets the error message. + </summary> + <value></value> + </member> + <member name="T:Rhino.Mocks.Expectations.ArgsEqualExpectation"> + <summary> + Summary description for ArgsEqualExpectation. + </summary> + </member> + <member name="M:Rhino.Mocks.Expectations.ArgsEqualExpectation.#ctor(Castle.Core.Interceptor.IInvocation,System.Object[],Rhino.Mocks.Impl.Range)"> + <summary> + Creates a new <see cref="T:Rhino.Mocks.Expectations.ArgsEqualExpectation"/> instance. + </summary> + <param name="expectedArgs">Expected args.</param> + <param name="invocation">The invocation for this expectation</param> + <param name="expectedRange">Number of method calls for this expectations</param> + </member> + <member name="M:Rhino.Mocks.Expectations.ArgsEqualExpectation.DoIsExpected(System.Object[])"> + <summary> + Validate the arguments for the method. + </summary> + <param name="args">The arguments with which the method was called</param> + </member> + <member name="M:Rhino.Mocks.Expectations.ArgsEqualExpectation.Equals(System.Object)"> + <summary> + Determines if the object equal to expectation + </summary> + </member> + <member name="M:Rhino.Mocks.Expectations.ArgsEqualExpectation.GetHashCode"> + <summary> + Get the hash code + </summary> + </member> + <member name="P:Rhino.Mocks.Expectations.ArgsEqualExpectation.ErrorMessage"> + <summary> + Gets the error message. + </summary> + <value></value> + </member> + <member name="P:Rhino.Mocks.Expectations.ArgsEqualExpectation.ExpectedArgs"> + <summary> + Get the expected args. + </summary> + </member> + <member name="T:Rhino.Mocks.Expectations.CallbackExpectation"> + <summary> + Call a specified callback to verify the expectation + </summary> + </member> + <member name="M:Rhino.Mocks.Expectations.CallbackExpectation.#ctor(Rhino.Mocks.Interfaces.IExpectation,System.Delegate)"> + <summary> + Creates a new <see cref="T:Rhino.Mocks.Expectations.CallbackExpectation"/> instance. + </summary> + <param name="expectation">Expectation.</param> + <param name="callback">Callback.</param> + </member> + <member name="M:Rhino.Mocks.Expectations.CallbackExpectation.#ctor(Castle.Core.Interceptor.IInvocation,System.Delegate,Rhino.Mocks.Impl.Range)"> + <summary> + Creates a new <see cref="T:Rhino.Mocks.Expectations.CallbackExpectation"/> instance. + </summary> + <param name="invocation">Invocation for this expectation</param> + <param name="callback">Callback.</param> + <param name="expectedRange">Number of method calls for this expectations</param> + </member> + <member name="M:Rhino.Mocks.Expectations.CallbackExpectation.DoIsExpected(System.Object[])"> + <summary> + Validate the arguments for the method on the child methods + </summary> + <param name="args">The arguments with which the method was called</param> + </member> + <member name="M:Rhino.Mocks.Expectations.CallbackExpectation.Equals(System.Object)"> + <summary> + Determines if the object equal to expectation + </summary> + </member> + <member name="M:Rhino.Mocks.Expectations.CallbackExpectation.GetHashCode"> + <summary> + Get the hash code + </summary> + </member> + <member name="P:Rhino.Mocks.Expectations.CallbackExpectation.ErrorMessage"> + <summary> + Gets the error message. + </summary> + <value></value> + </member> + <member name="T:Rhino.Mocks.Expectations.ConstraintsExpectation"> + <summary> + Expect the method's arguments to match the contraints + </summary> + </member> + <member name="M:Rhino.Mocks.Expectations.ConstraintsExpectation.#ctor(Castle.Core.Interceptor.IInvocation,Rhino.Mocks.Constraints.AbstractConstraint[],Rhino.Mocks.Impl.Range)"> + <summary> + Creates a new <see cref="T:Rhino.Mocks.Expectations.ConstraintsExpectation"/> instance. + </summary> + <param name="invocation">Invocation for this expectation</param> + <param name="constraints">Constraints.</param> + <param name="expectedRange">Number of method calls for this expectations</param> + </member> + <member name="M:Rhino.Mocks.Expectations.ConstraintsExpectation.#ctor(Rhino.Mocks.Interfaces.IExpectation,Rhino.Mocks.Constraints.AbstractConstraint[])"> + <summary> + Creates a new <see cref="T:Rhino.Mocks.Expectations.ConstraintsExpectation"/> instance. + </summary> + <param name="expectation">Expectation.</param> + <param name="constraints">Constraints.</param> + </member> + <member name="M:Rhino.Mocks.Expectations.ConstraintsExpectation.DoIsExpected(System.Object[])"> + <summary> + Validate the arguments for the method. + </summary> + <param name="args">The arguments with which the method was called</param> + </member> + <member name="M:Rhino.Mocks.Expectations.ConstraintsExpectation.Equals(System.Object)"> + <summary> + Determines if the object equal to expectation + </summary> + </member> + <member name="M:Rhino.Mocks.Expectations.ConstraintsExpectation.GetHashCode"> + <summary> + Get the hash code + </summary> + </member> + <member name="P:Rhino.Mocks.Expectations.ConstraintsExpectation.ErrorMessage"> + <summary> + Gets the error message. + </summary> + <value></value> + </member> + <member name="T:Rhino.Mocks.Impl.Invocation.Actions.HandleEvent"> + <summary> + </summary> + </member> + <member name="T:Rhino.Mocks.Interfaces.IInvocationActionn"> + <summary> + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.IInvocationActionn.PerformAgainst(Castle.Core.Interceptor.IInvocation)"> + <summary> + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.Invocation.Actions.HandleEvent.#ctor(Rhino.Mocks.Interfaces.IMockedObject)"> + <summary> + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.Invocation.Actions.HandleEvent.PerformAgainst(Castle.Core.Interceptor.IInvocation)"> + <summary> + </summary> + </member> + <member name="T:Rhino.Mocks.Impl.Invocation.Actions.InvokeMethodAgainstMockedObject"> + <summary> + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.Invocation.Actions.InvokeMethodAgainstMockedObject.#ctor(Rhino.Mocks.Interfaces.IMockedObject)"> + <summary> + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.Invocation.Actions.InvokeMethodAgainstMockedObject.PerformAgainst(Castle.Core.Interceptor.IInvocation)"> + <summary> + </summary> + </member> + <member name="T:Rhino.Mocks.Impl.Invocation.Actions.InvokeProperty"> + <summary> + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.Invocation.Actions.InvokeProperty.#ctor(Rhino.Mocks.Interfaces.IMockedObject,Rhino.Mocks.MockRepository)"> + <summary> + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.Invocation.Actions.InvokeProperty.PerformAgainst(Castle.Core.Interceptor.IInvocation)"> + <summary> + </summary> + </member> + <member name="T:Rhino.Mocks.Impl.Invocation.Actions.Proceed"> + <summary> + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.Invocation.Actions.Proceed.PerformAgainst(Castle.Core.Interceptor.IInvocation)"> + <summary> + </summary> + </member> + <member name="T:Rhino.Mocks.Impl.Invocation.Actions.RegularInvocation"> + <summary> + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.Invocation.Actions.RegularInvocation.#ctor(Rhino.Mocks.MockRepository)"> + <summary> + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.Invocation.Actions.RegularInvocation.PerformAgainst(Castle.Core.Interceptor.IInvocation)"> + <summary> + </summary> + </member> + <member name="T:Rhino.Mocks.Impl.Invocation.InvocationVisitor"> + <summary> + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.Invocation.InvocationVisitor.#ctor(Rhino.Mocks.Impl.InvocationSpecifications.ISpecification{Castle.Core.Interceptor.IInvocation},Rhino.Mocks.Interfaces.IInvocationActionn)"> + <summary> + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.Invocation.InvocationVisitor.CanWorkWith(Castle.Core.Interceptor.IInvocation)"> + <summary> + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.Invocation.InvocationVisitor.RunAgainst(Castle.Core.Interceptor.IInvocation)"> + <summary> + </summary> + </member> + <member name="T:Rhino.Mocks.Impl.Invocation.InvocationVisitorsFactory"> + <summary> + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.Invocation.InvocationVisitorsFactory.CreateStandardInvocationVisitors(Rhino.Mocks.Interfaces.IMockedObject,Rhino.Mocks.MockRepository)"> + <summary> + </summary> + </member> + <member name="T:Rhino.Mocks.Impl.Invocation.Specifications.AndSpecification`1"> + <summary> + Summary for AndSpecification + </summary> + <typeparam name="T"></typeparam> + </member> + <member name="T:Rhino.Mocks.Impl.InvocationSpecifications.ISpecification`1"> + <summary> + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.InvocationSpecifications.ISpecification`1.IsSatisfiedBy(`0)"> + <summary> + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.Invocation.Specifications.AndSpecification`1.#ctor(Rhino.Mocks.Impl.InvocationSpecifications.ISpecification{`0},Rhino.Mocks.Impl.InvocationSpecifications.ISpecification{`0})"> + <summary> + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.Invocation.Specifications.AndSpecification`1.IsSatisfiedBy(`0)"> + <summary> + </summary> + </member> + <member name="T:Rhino.Mocks.Impl.Invocation.Specifications.FollowsEventNamingStandard"> + <summary> + Summary description for FollowsEventNamingStandard + </summary> + </member> + <member name="F:Rhino.Mocks.Impl.Invocation.Specifications.FollowsEventNamingStandard.AddPrefix"> + <summary> + </summary> + </member> + <member name="F:Rhino.Mocks.Impl.Invocation.Specifications.FollowsEventNamingStandard.RemovePrefix"> + <summary> + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.Invocation.Specifications.FollowsEventNamingStandard.IsSatisfiedBy(Castle.Core.Interceptor.IInvocation)"> + <summary> + </summary> + </member> + <member name="T:Rhino.Mocks.Impl.Invocation.Specifications.IsAnEventInvocation"> + <summary> + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.Invocation.Specifications.IsAnEventInvocation.IsSatisfiedBy(Castle.Core.Interceptor.IInvocation)"> + <summary> + </summary> + </member> + <member name="T:Rhino.Mocks.Impl.Invocation.Specifications.AnyInvocation"> + <summary> + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.Invocation.Specifications.AnyInvocation.IsSatisfiedBy(Castle.Core.Interceptor.IInvocation)"> + <summary> + </summary> + </member> + <member name="T:Rhino.Mocks.Impl.Invocation.Specifications.IsAnInvocationOfAMethodBelongingToObject"> + <summary> + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.Invocation.Specifications.IsAnInvocationOfAMethodBelongingToObject.IsSatisfiedBy(Castle.Core.Interceptor.IInvocation)"> + <summary> + </summary> + </member> + <member name="T:Rhino.Mocks.Impl.Invocation.Specifications.IsAnInvocationOnAMockedObject"> + <summary> + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.Invocation.Specifications.IsAnInvocationOnAMockedObject.IsSatisfiedBy(Castle.Core.Interceptor.IInvocation)"> + <summary> + </summary> + </member> + <member name="T:Rhino.Mocks.Impl.Invocation.Specifications.IsAPropertyInvocation"> + <summary> + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.Invocation.Specifications.IsAPropertyInvocation.#ctor(Rhino.Mocks.Interfaces.IMockedObject)"> + <summary> + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.Invocation.Specifications.IsAPropertyInvocation.IsSatisfiedBy(Castle.Core.Interceptor.IInvocation)"> + <summary> + </summary> + </member> + <member name="T:Rhino.Mocks.Impl.Invocation.Specifications.IsInvocationThatShouldTargetOriginal"> + <summary> + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.Invocation.Specifications.IsInvocationThatShouldTargetOriginal.#ctor(Rhino.Mocks.Interfaces.IMockedObject)"> + <summary> + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.Invocation.Specifications.IsInvocationThatShouldTargetOriginal.IsSatisfiedBy(Castle.Core.Interceptor.IInvocation)"> + <summary> + </summary> + </member> + <member name="T:Rhino.Mocks.Impl.Invocation.Specifications.NamedEventExistsOnDeclaringType"> + <summary> + Summary descritpion for NamedEventExistsOnDeclaringType + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.Invocation.Specifications.NamedEventExistsOnDeclaringType.IsSatisfiedBy(Castle.Core.Interceptor.IInvocation)"> + <summary> + </summary> + </member> + <member name="T:Rhino.Mocks.Impl.NullLogger"> + <summary> + Doesn't log anything, just makes happy noises + </summary> + </member> + <member name="T:Rhino.Mocks.Interfaces.IExpectationLogger"> + <summary> + Log expectations - allows to see what is going on inside Rhino Mocks + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.IExpectationLogger.LogRecordedExpectation(Castle.Core.Interceptor.IInvocation,Rhino.Mocks.Interfaces.IExpectation)"> + <summary> + Logs the expectation as is was recorded + </summary> + <param name="invocation">The invocation.</param> + <param name="expectation">The expectation.</param> + </member> + <member name="M:Rhino.Mocks.Interfaces.IExpectationLogger.LogReplayedExpectation(Castle.Core.Interceptor.IInvocation,Rhino.Mocks.Interfaces.IExpectation)"> + <summary> + Logs the expectation as it was recorded + </summary> + <param name="invocation">The invocation.</param> + <param name="expectation">The expectation.</param> + </member> + <member name="M:Rhino.Mocks.Interfaces.IExpectationLogger.LogUnexpectedMethodCall(Castle.Core.Interceptor.IInvocation,System.String)"> + <summary> + Logs the unexpected method call. + </summary> + <param name="invocation">The invocation.</param> + <param name="message">The message.</param> + </member> + <member name="M:Rhino.Mocks.Impl.NullLogger.LogRecordedExpectation(Castle.Core.Interceptor.IInvocation,Rhino.Mocks.Interfaces.IExpectation)"> + <summary> + Logs the expectation as is was recorded + </summary> + <param name="invocation">The invocation.</param> + <param name="expectation">The expectation.</param> + </member> + <member name="M:Rhino.Mocks.Impl.NullLogger.LogReplayedExpectation(Castle.Core.Interceptor.IInvocation,Rhino.Mocks.Interfaces.IExpectation)"> + <summary> + Logs the expectation as it was recorded + </summary> + <param name="invocation">The invocation.</param> + <param name="expectation">The expectation.</param> + </member> + <member name="M:Rhino.Mocks.Impl.NullLogger.LogUnexpectedMethodCall(Castle.Core.Interceptor.IInvocation,System.String)"> + <summary> + Logs the unexpected method call. + </summary> + <param name="invocation">The invocation.</param> + <param name="message">The message.</param> + </member> + <member name="T:Rhino.Mocks.Impl.RemotingMock.IRemotingProxyOperation"> + <summary> + Operation on a remoting proxy + </summary> + <remarks> + It is not possible to directly communicate to a real proxy via transparent proxy. + Transparent proxy impersonates a user type and only methods of that user type are callable. + The only methods that are guaranteed to exist on any transparent proxy are methods defined + in Object: namely ToString(), GetHashCode(), and Equals()). + + These three methods are the only way to tell the real proxy to do something. + Equals() is the most suitable of all, since it accepts an arbitrary object parameter. + The RemotingProxy code is built so that if it is compared to an IRemotingProxyOperation, + transparentProxy.Equals(operation) will call operation.Process(realProxy). + This way we can retrieve a real proxy from transparent proxy and perform + arbitrary operation on it. + </remarks> + </member> + <member name="T:Rhino.Mocks.Impl.RemotingMock.RemotingMockGenerator"> + <summary> + Generates remoting proxies and provides utility functions + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.RemotingMock.RemotingMockGenerator.CreateRemotingMock(System.Type,Castle.Core.Interceptor.IInterceptor,Rhino.Mocks.Interfaces.IMockedObject)"> + <summary> + Create the proxy using remoting + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.RemotingMock.RemotingMockGenerator.IsRemotingProxy(System.Object)"> + <summary> + Check whether an object is a transparent proxy with a RemotingProxy behind it + </summary> + <param name="obj">Object to check</param> + <returns>true if the object is a transparent proxy with a RemotingProxy instance behind it, false otherwise</returns> + <remarks>We use Equals() method to communicate with the real proxy behind the object. + See IRemotingProxyOperation for more details</remarks> + </member> + <member name="M:Rhino.Mocks.Impl.RemotingMock.RemotingMockGenerator.GetMockedObjectFromProxy(System.Object)"> + <summary> + Retrieve a mocked object from a transparent proxy + </summary> + <param name="proxy">Transparent proxy with a RemotingProxy instance behind it</param> + <returns>Mocked object associated with the proxy</returns> + <remarks>We use Equals() method to communicate with the real proxy behind the object. + See IRemotingProxyOperation for more details</remarks> + </member> + <member name="T:Rhino.Mocks.Impl.RemotingMock.RemotingInvocation"> + <summary> + Implementation of IInvocation based on remoting proxy + </summary> + <remarks>Some methods are marked NotSupported since they either don't make sense + for remoting proxies, or they are never called by Rhino Mocks</remarks> + </member> + <member name="T:Rhino.Mocks.Impl.TextWriterExpectationLogger"> + <summary> + Rudimetry implementation that simply logs methods calls as text. + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.TextWriterExpectationLogger.#ctor(System.IO.TextWriter)"> + <summary> + Initializes a new instance of the <see cref="T:Rhino.Mocks.Impl.TextWriterExpectationLogger"/> class. + </summary> + <param name="writer">The writer.</param> + </member> + <member name="M:Rhino.Mocks.Impl.TextWriterExpectationLogger.LogRecordedExpectation(Castle.Core.Interceptor.IInvocation,Rhino.Mocks.Interfaces.IExpectation)"> + <summary> + Logs the expectation as it was recorded + </summary> + <param name="invocation">The invocation.</param> + <param name="expectation">The expectation.</param> + </member> + <member name="M:Rhino.Mocks.Impl.TextWriterExpectationLogger.LogReplayedExpectation(Castle.Core.Interceptor.IInvocation,Rhino.Mocks.Interfaces.IExpectation)"> + <summary> + Logs the expectation as it was recorded + </summary> + <param name="invocation">The invocation.</param> + <param name="expectation">The expectation.</param> + </member> + <member name="M:Rhino.Mocks.Impl.TextWriterExpectationLogger.LogUnexpectedMethodCall(Castle.Core.Interceptor.IInvocation,System.String)"> + <summary> + Logs the unexpected method call. + </summary> + <param name="invocation">The invocation.</param> + <param name="message">The message.</param> + </member> + <member name="T:Rhino.Mocks.Impl.StubRecordMockState"> + <summary> + Behave like a stub, all properties and events acts normally, methods calls + return default values by default (but can use expectations to set them up), etc. + </summary> + </member> + <member name="T:Rhino.Mocks.Impl.RecordMockState"> + <summary> + Records all the expectations for a mock + </summary> + </member> + <member name="T:Rhino.Mocks.Interfaces.IMockState"> + <summary> + Different actions on this mock + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMockState.MethodCall(Castle.Core.Interceptor.IInvocation,System.Reflection.MethodInfo,System.Object[])"> + <summary> + Add a method call for this state' mock. + </summary> + <param name="invocation">The invocation for this method</param> + <param name="method">The method that was called</param> + <param name="args">The arguments this method was called with</param> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMockState.Verify"> + <summary> + Verify that this mock expectations have passed. + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMockState.Replay"> + <summary> + Verify that we can move to replay state and move + to the reply state. + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMockState.BackToRecord"> + <summary> + Gets a mock state that match the original mock state of the object. + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMockState.GetLastMethodOptions``1"> + <summary> + Get the options for the last method call + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMockState.SetExceptionToThrowOnVerify(System.Exception)"> + <summary> + Set the exception to throw when Verify is called. + This is used to report exception that may have happened but where caught in the code. + This way, they are reported anyway when Verify() is called. + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMockState.NotifyCallOnPropertyBehavior"> + <summary> + This method is called to indicate that a property behavior call. + This is done so we generate good error message in the common case of people using + Stubbed properties with Return(). + </summary> + </member> + <member name="P:Rhino.Mocks.Interfaces.IMockState.VerifyState"> + <summary> + Gets the matching verify state for this state + </summary> + </member> + <member name="P:Rhino.Mocks.Interfaces.IMockState.LastMethodOptions"> + <summary> + Get the options for the last method call + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.RecordMockState.GetLastMethodOptions``1"> + <summary> + Get the options for the last method call + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.RecordMockState.SetExceptionToThrowOnVerify(System.Exception)"> + <summary> + Set the exception to throw when Verify is called. + This is used to report exception that may have happened but where caught in the code. + This way, they are reported anyway when Verify() is called. + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.RecordMockState.NotifyCallOnPropertyBehavior"> + <summary> + This method is called to indicate that a property behavior call. + This is done so we generate good error message in the common case of people using + Stubbed properties with Return(). + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.RecordMockState.#ctor(Rhino.Mocks.Interfaces.IMockedObject,Rhino.Mocks.MockRepository)"> + <summary> + Creates a new <see cref="T:Rhino.Mocks.Impl.RecordMockState"/> instance. + </summary> + <param name="repository">Repository.</param> + <param name="mockedObject">The proxy that generates the method calls</param> + </member> + <member name="M:Rhino.Mocks.Impl.RecordMockState.MethodCall(Castle.Core.Interceptor.IInvocation,System.Reflection.MethodInfo,System.Object[])"> + <summary> + Add a method call for this state' mock. + </summary> + <param name="invocation">The invocation for this method</param> + <param name="method">The method that was called</param> + <param name="args">The arguments this method was called with</param> + </member> + <member name="M:Rhino.Mocks.Impl.RecordMockState.Replay"> + <summary> + Verify that we can move to replay state and move + to the reply state. + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.RecordMockState.DoReplay"> + <summary> + Verify that we can move to replay state and move + to the reply state. + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.RecordMockState.Verify"> + <summary> + Verify that this mock expectations have passed. + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.RecordMockState.BackToRecord"> + <summary> + Gets a mock state that match the original mock state of the object. + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.RecordMockState.AssertPreviousMethodIsClose"> + <summary> + Asserts the previous method is closed (had an expectation set on it so we can replay it correctly) + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.RecordMockState.GetDefaultCallCountRangeExpectation"> + <summary> + Get the default call count range expectation + </summary> + <returns></returns> + </member> + <member name="P:Rhino.Mocks.Impl.RecordMockState.LastExpectation"> + <summary> + Gets the last expectation. + </summary> + </member> + <member name="P:Rhino.Mocks.Impl.RecordMockState.MethodCallsCount"> + <summary> + Gets the total method calls count. + </summary> + </member> + <member name="P:Rhino.Mocks.Impl.RecordMockState.LastMethodOptions"> + <summary> + Get the options for the last method call + </summary> + </member> + <member name="P:Rhino.Mocks.Impl.RecordMockState.VerifyState"> + <summary> + Gets the matching verify state for this state + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.StubRecordMockState.#ctor(Rhino.Mocks.Interfaces.IMockedObject,Rhino.Mocks.MockRepository)"> + <summary> + Initializes a new instance of the <see cref="T:Rhino.Mocks.Impl.StubRecordMockState"/> class. + </summary> + <param name="mockedObject">The proxy that generates the method calls</param> + <param name="repository">Repository.</param> + </member> + <member name="M:Rhino.Mocks.Impl.StubRecordMockState.AssertPreviousMethodIsClose"> + <summary> + We don't care much about expectations here, so we will remove the expectation if + it is not closed. + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.StubRecordMockState.Replay"> + <summary> + Verify that we can move to replay state and move + to the reply state. + </summary> + <returns></returns> + </member> + <member name="M:Rhino.Mocks.Impl.StubRecordMockState.GetDefaultCallCountRangeExpectation"> + <summary> + Get the default call count range expectation + </summary> + <returns></returns> + </member> + <member name="T:Rhino.Mocks.Impl.StubReplayMockState"> + <summary> + Validate expectations on recorded methods, but in general completely ignoring them. + Similar to <seealso cref="T:Rhino.Mocks.Impl.ReplayDynamicMockState"/> except that it would return a + <seealso cref="T:Rhino.Mocks.Impl.StubRecordMockState"/> when BackToRecord is called. + </summary> + </member> + <member name="T:Rhino.Mocks.Impl.ReplayMockState"> + <summary> + Validate all expectations on a mock + </summary> + </member> + <member name="F:Rhino.Mocks.Impl.ReplayMockState.repository"> + <summary> + The repository for this state + </summary> + </member> + <member name="F:Rhino.Mocks.Impl.ReplayMockState.proxy"> + <summary> + The proxy object for this state + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.ReplayMockState.GetLastMethodOptions``1"> + <summary> + Get the options for the last method call + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.ReplayMockState.#ctor(Rhino.Mocks.Impl.RecordMockState)"> + <summary> + Creates a new <see cref="T:Rhino.Mocks.Impl.ReplayMockState"/> instance. + </summary> + <param name="previousState">The previous state for this method</param> + </member> + <member name="M:Rhino.Mocks.Impl.ReplayMockState.MethodCall(Castle.Core.Interceptor.IInvocation,System.Reflection.MethodInfo,System.Object[])"> + <summary> + Add a method call for this state' mock. + </summary> + <param name="invocation">The invocation for this method</param> + <param name="method">The method that was called</param> + <param name="args">The arguments this method was called with</param> + </member> + <member name="M:Rhino.Mocks.Impl.ReplayMockState.DoMethodCall(Castle.Core.Interceptor.IInvocation,System.Reflection.MethodInfo,System.Object[])"> + <summary> + Add a method call for this state' mock. + This allows derived method to cleanly get a the setupresult behavior while adding + their own. + </summary> + <param name="invocation">The invocation for this method</param> + <param name="method">The method that was called</param> + <param name="args">The arguments this method was called with</param> + </member> + <member name="M:Rhino.Mocks.Impl.ReplayMockState.SetExceptionToThrowOnVerify(System.Exception)"> + <summary> + Set the exception to throw when Verify is called. + This is used to report exception that may have happened but where caught in the code. + This way, they are reported anyway when Verify() is called. + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.ReplayMockState.NotifyCallOnPropertyBehavior"> + <summary> + not relevant + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.ReplayMockState.Verify"> + <summary> + Verify that this mock expectations have passed. + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.ReplayMockState.Replay"> + <summary> + Verify that we can move to replay state and move + to the reply state. + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.ReplayMockState.BackToRecord"> + <summary> + Gets a mock state that match the original mock state of the object. + </summary> + </member> + <member name="P:Rhino.Mocks.Impl.ReplayMockState.LastMethodOptions"> + <summary> + Get the options for the last method call + </summary> + </member> + <member name="P:Rhino.Mocks.Impl.ReplayMockState.VerifyState"> + <summary> + Gets the matching verify state for this state + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.StubReplayMockState.#ctor(Rhino.Mocks.Impl.RecordMockState)"> + <summary> + Initializes a new instance of the <see cref="T:Rhino.Mocks.Impl.StubReplayMockState"/> class. + </summary> + <param name="previousState">The previous state for this method</param> + </member> + <member name="M:Rhino.Mocks.Impl.StubReplayMockState.DoMethodCall(Castle.Core.Interceptor.IInvocation,System.Reflection.MethodInfo,System.Object[])"> + <summary> + Add a method call for this state' mock. + </summary> + <param name="invocation">The invocation for this method</param> + <param name="method">The method that was called</param> + <param name="args">The arguments this method was called with</param> + </member> + <member name="M:Rhino.Mocks.Impl.StubReplayMockState.BackToRecord"> + <summary> + Gets a mock state that matches the original mock state of the object. + </summary> + </member> + <member name="T:Rhino.Mocks.Impl.TraceWriterExpectationLogger"> + <summary> + Write rhino mocks log info to the trace + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.TraceWriterExpectationLogger.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:Rhino.Mocks.Impl.TraceWriterExpectationLogger"/> class. + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.TraceWriterExpectationLogger.#ctor(System.Boolean,System.Boolean,System.Boolean)"> + <summary> + Initializes a new instance of the <see cref="T:Rhino.Mocks.Impl.TraceWriterExpectationLogger"/> class. + </summary> + <param name="logRecorded">if set to <c>true</c> [log recorded].</param> + <param name="logReplayed">if set to <c>true</c> [log replayed].</param> + <param name="logUnexpected">if set to <c>true</c> [log unexpected].</param> + </member> + <member name="M:Rhino.Mocks.Impl.TraceWriterExpectationLogger.LogRecordedExpectation(Castle.Core.Interceptor.IInvocation,Rhino.Mocks.Interfaces.IExpectation)"> + <summary> + Logs the expectation as is was recorded + </summary> + <param name="invocation">The invocation.</param> + <param name="expectation">The expectation.</param> + </member> + <member name="M:Rhino.Mocks.Impl.TraceWriterExpectationLogger.LogReplayedExpectation(Castle.Core.Interceptor.IInvocation,Rhino.Mocks.Interfaces.IExpectation)"> + <summary> + Logs the expectation as it was recorded + </summary> + <param name="invocation">The invocation.</param> + <param name="expectation">The expectation.</param> + </member> + <member name="M:Rhino.Mocks.Impl.TraceWriterExpectationLogger.LogUnexpectedMethodCall(Castle.Core.Interceptor.IInvocation,System.String)"> + <summary> + Logs the unexpected method call. + </summary> + <param name="invocation">The invocation.</param> + <param name="message">The message.</param> + </member> + <member name="T:Rhino.Mocks.Impl.TraceWriterWithStackTraceExpectationWriter"> + <summary> + Writes log information as stack traces about rhino mocks activity + </summary> + </member> + <member name="F:Rhino.Mocks.Impl.TraceWriterWithStackTraceExpectationWriter.AlternativeWriter"> + <summary> + Allows to redirect output to a different location. + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.TraceWriterWithStackTraceExpectationWriter.LogRecordedExpectation(Castle.Core.Interceptor.IInvocation,Rhino.Mocks.Interfaces.IExpectation)"> + <summary> + Logs the expectation as is was recorded + </summary> + <param name="invocation">The invocation.</param> + <param name="expectation">The expectation.</param> + </member> + <member name="M:Rhino.Mocks.Impl.TraceWriterWithStackTraceExpectationWriter.LogReplayedExpectation(Castle.Core.Interceptor.IInvocation,Rhino.Mocks.Interfaces.IExpectation)"> + <summary> + Logs the expectation as it was recorded + </summary> + <param name="invocation">The invocation.</param> + <param name="expectation">The expectation.</param> + </member> + <member name="M:Rhino.Mocks.Impl.TraceWriterWithStackTraceExpectationWriter.LogUnexpectedMethodCall(Castle.Core.Interceptor.IInvocation,System.String)"> + <summary> + Logs the unexpected method call. + </summary> + <param name="invocation">The invocation.</param> + <param name="message">The message.</param> + </member> + <member name="T:Rhino.Mocks.Interfaces.IPartialMockMarker"> + <summary> + Marker interface used to indicate that this is a partial mock. + </summary> + </member> + <member name="T:Rhino.Mocks.Interfaces.OriginalCallOptions"> + <summary> + Options for CallOriginalMethod + </summary> + </member> + <member name="F:Rhino.Mocks.Interfaces.OriginalCallOptions.NoExpectation"> + <summary> + No expectation is created, the method will be called directly + </summary> + </member> + <member name="F:Rhino.Mocks.Interfaces.OriginalCallOptions.CreateExpectation"> + <summary> + Normal expectation is created, but when the method is later called, it will also call the original method + </summary> + </member> + <member name="T:Rhino.Mocks.MethodInvocation"> + <summary> + This is a data structure that is used by + <seealso cref="M:Rhino.Mocks.Interfaces.IMethodOptions`1.WhenCalled(System.Action{Rhino.Mocks.MethodInvocation})"/> to pass + the current method to the relevant delegate + </summary> + </member> + <member name="M:Rhino.Mocks.MethodInvocation.#ctor(Castle.Core.Interceptor.IInvocation)"> + <summary> + Initializes a new instance of the <see cref="T:Rhino.Mocks.MethodInvocation"/> class. + </summary> + <param name="invocation">The invocation.</param> + </member> + <member name="P:Rhino.Mocks.MethodInvocation.Arguments"> + <summary> + Gets the args for this method invocation + </summary> + </member> + <member name="P:Rhino.Mocks.MethodInvocation.Method"> + <summary> + Get the method that was caused this invocation + </summary> + </member> + <member name="P:Rhino.Mocks.MethodInvocation.ReturnValue"> + <summary> + Gets or sets the return value for this method invocation + </summary> + <value>The return value.</value> + </member> + <member name="T:Rhino.Mocks.MockRepository"> + <summary> + Adds optional new usage: + using(mockRepository.Record()) { + Expect.Call(mock.Method()).Return(retVal); + } + using(mockRepository.Playback()) { + // Execute code + } + N.B. mockRepository.ReplayAll() and mockRepository.VerifyAll() + calls are taken care of by Record/Playback + </summary> + <summary> + Creates proxied instances of types. + </summary> + </member> + <member name="M:Rhino.Mocks.MockRepository.GenerateStub``1(System.Object[])"> + <summary>Generates a stub without needing a <see cref="T:Rhino.Mocks.MockRepository"/></summary> + <param name="argumentsForConstructor">Arguments for <typeparamref name="T"/>'s constructor</param> + <typeparam name="T">The <see cref="T:System.Type"/> of stub to create.</typeparam> + <returns>The stub</returns> + <seealso cref="M:Rhino.Mocks.MockRepository.Stub``1(System.Object[])"/> + </member> + <member name="M:Rhino.Mocks.MockRepository.GenerateStub(System.Type,System.Object[])"> + <summary>Generates a stub without needing a <see cref="T:Rhino.Mocks.MockRepository"/></summary> + <param name="type">The <see cref="T:System.Type"/> of stub.</param> + <param name="argumentsForConstructor">Arguments for the <paramref name="type"/>'s constructor.</param> + <returns>The stub</returns> + <seealso cref="M:Rhino.Mocks.MockRepository.Stub(System.Type,System.Object[])"/> + </member> + <member name="M:Rhino.Mocks.MockRepository.GenerateMock``1(System.Object[])"> + <summary>Generate a mock object without needing a <see cref="T:Rhino.Mocks.MockRepository"/></summary> + <typeparam name="T">type <see cref="T:System.Type"/> of mock object to create.</typeparam> + <param name="argumentsForConstructor">Arguments for <typeparamref name="T"/>'s constructor</param> + <returns>the mock object</returns> + <seealso cref="M:Rhino.Mocks.MockRepository.DynamicMock``1(System.Object[])"/> + </member> + <member name="M:Rhino.Mocks.MockRepository.GenerateMock``2(System.Object[])"> + <summary>Generate a multi-mock object without needing a <see cref="T:Rhino.Mocks.MockRepository"/></summary> + <typeparam name="T">The <c>typeof</c> object to generate a mock for.</typeparam> + <typeparam name="TMultiMockInterface1">A second interface to generate a multi-mock for.</typeparam> + <param name="argumentsForConstructor">Arguments for <typeparamref name="T"/>'s constructor</param> + <returns>the multi-mock object</returns> + <seealso cref="M:Rhino.Mocks.MockRepository.DynamicMultiMock(System.Type,System.Type[],System.Object[])"/> + </member> + <member name="M:Rhino.Mocks.MockRepository.GenerateMock``3(System.Object[])"> + <summary>Generate a multi-mock object without without needing a <see cref="T:Rhino.Mocks.MockRepository"/></summary> + <typeparam name="T">The <c>typeof</c> object to generate a mock for.</typeparam> + <typeparam name="TMultiMockInterface1">An interface to generate a multi-mock for.</typeparam> + <typeparam name="TMultiMockInterface2">A second interface to generate a multi-mock for.</typeparam> + <param name="argumentsForConstructor">Arguments for <typeparamref name="T"/>'s constructor</param> + <returns>the multi-mock object</returns> + <seealso cref="M:Rhino.Mocks.MockRepository.DynamicMultiMock(System.Type,System.Type[],System.Object[])"/> + </member> + <member name="M:Rhino.Mocks.MockRepository.GenerateMock(System.Type,System.Type[],System.Object[])"> + <summary>Creates a multi-mock without without needing a <see cref="T:Rhino.Mocks.MockRepository"/></summary> + <param name="type">The type of mock to create, this can be a class</param> + <param name="extraTypes">Any extra interfaces to add to the multi-mock, these can only be interfaces.</param> + <param name="argumentsForConstructor">Arguments for <paramref name="type"/>'s constructor</param> + <returns>the multi-mock object</returns> + <seealso cref="M:Rhino.Mocks.MockRepository.DynamicMultiMock(System.Type,System.Type[],System.Object[])"/> + </member> + <member name="M:Rhino.Mocks.MockRepository.GenerateStrictMock``1(System.Object[])"> + <summary>Creates a strict mock without without needing a <see cref="T:Rhino.Mocks.MockRepository"/></summary> + <param name="argumentsForConstructor">Any arguments required for the <typeparamref name="T"/>'s constructor</param> + <typeparam name="T">The type of mock object to create.</typeparam> + <returns>The mock object with strict replay semantics</returns> + <seealso cref="M:Rhino.Mocks.MockRepository.StrictMock``1(System.Object[])"/> + </member> + <member name="M:Rhino.Mocks.MockRepository.GenerateStrictMock``2(System.Object[])"> + <summary>Creates a strict multi-mock without needing a <see cref="T:Rhino.Mocks.MockRepository"/></summary> + <param name="argumentsForConstructor">Any arguments required for the <typeparamref name="T"/>'s constructor</param> + <typeparam name="T">The type of mock object to create, this can be a class.</typeparam> + <typeparam name="TMultiMockInterface1">An interface to generate a multi-mock for, this must be an interface!</typeparam> + <returns>The multi-mock object with strict replay semantics</returns> + <seealso cref="M:Rhino.Mocks.MockRepository.StrictMultiMock(System.Type,System.Type[],System.Object[])"/> + </member> + <member name="M:Rhino.Mocks.MockRepository.GenerateStrictMock``3(System.Object[])"> + <summary>Creates a strict multi-mock without needing a <see cref="T:Rhino.Mocks.MockRepository"/></summary> + <param name="argumentsForConstructor">Any arguments required for the <typeparamref name="T"/>'s constructor</param> + <typeparam name="T">The type of mock object to create, this can be a class.</typeparam> + <typeparam name="TMultiMockInterface1">An interface to generate a multi-mock for, this must be an interface!</typeparam> + <typeparam name="TMultiMockInterface2">A second interface to generate a multi-mock for, this must be an interface!</typeparam> + <returns>The multi-mock object with strict replay semantics</returns> + <seealso cref="M:Rhino.Mocks.MockRepository.StrictMultiMock(System.Type,System.Type[],System.Object[])"/> + </member> + <member name="M:Rhino.Mocks.MockRepository.GenerateStrictMock(System.Type,System.Type[],System.Object[])"> + <summary>Creates a strict multi-mock without needing a <see cref="T:Rhino.Mocks.MockRepository"/></summary> + <param name="type">The type of mock object to create, this can be a class</param> + <param name="extraTypes">Any extra interfaces to generate a multi-mock for, these must be interaces!</param> + <param name="argumentsForConstructor">Any arguments for the <paramref name="type"/>'s constructor</param> + <returns>The strict multi-mock object</returns> + <seealso cref="M:Rhino.Mocks.MockRepository.StrictMultiMock(System.Type,System.Type[],System.Object[])"/> + </member> + <member name="M:Rhino.Mocks.MockRepository.GeneratePartialMock``1(System.Object[])"> + <summary> + </summary> + <param name="argumentsForConstructor"></param> + <typeparam name="T"></typeparam> + <returns></returns> + </member> + <member name="M:Rhino.Mocks.MockRepository.GeneratePartialMock``2(System.Object[])"> + <summary> + </summary> + <param name="argumentsForConstructor"></param> + <typeparam name="T"></typeparam> + <typeparam name="TMultiMockInterface1"></typeparam> + <returns></returns> + </member> + <member name="M:Rhino.Mocks.MockRepository.GeneratePartialMock``3(System.Object[])"> + <summary> + </summary> + <param name="argumentsForConstructor"></param> + <typeparam name="T"></typeparam> + <typeparam name="TMultiMockInterface1"></typeparam> + <typeparam name="TMultiMockInterface2"></typeparam> + <returns></returns> + </member> + <member name="M:Rhino.Mocks.MockRepository.GeneratePartialMock(System.Type,System.Type[],System.Object[])"> + <summary> + </summary> + <param name="type"></param> + <param name="extraTypes"></param> + <param name="argumentsForConstructor"></param> + <returns></returns> + </member> + <member name="M:Rhino.Mocks.MockRepository.GenerateDynamicMockWithRemoting``1(System.Object[])"> + <summary> + Generate a mock object with dynamic replay semantics and remoting without needing the mock repository + </summary> + </member> + <member name="M:Rhino.Mocks.MockRepository.GenerateStrictMockWithRemoting``1(System.Object[])"> + <summary> + Generate a mock object with strict replay semantics and remoting without needing the mock repository + </summary> + </member> + <member name="M:Rhino.Mocks.MockRepository.CreateMockInReplay``1(System.Func{Rhino.Mocks.MockRepository,``0})"> + <summary>Helper method to create a mock object without a repository instance and put the object back into replay mode.</summary> + <typeparam name="T">The type of mock object to create</typeparam> + <param name="createMock">A delegate that uses a mock repository instance to create the underlying mock</param> + <returns>The mock object in the replay mode.</returns> + </member> + <member name="M:Rhino.Mocks.MockRepository.Record"> + <summary> + </summary> + <returns></returns> + </member> + <member name="M:Rhino.Mocks.MockRepository.Playback"> + <summary> + </summary> + <returns></returns> + </member> + <member name="F:Rhino.Mocks.MockRepository.generatorMap"> + <summary> + This is a map of types to ProxyGenerators. + </summary> + </member> + <member name="F:Rhino.Mocks.MockRepository.lastRepository"> + <summary> + This is used to record the last repository that has a method called on it. + </summary> + </member> + <member name="F:Rhino.Mocks.MockRepository.lastMockedObject"> + <summary> + this is used to get to the last proxy on this repository. + </summary> + </member> + <member name="F:Rhino.Mocks.MockRepository.delegateProxies"> + <summary> + For mock delegates, maps the proxy instance from intercepted invocations + back to the delegate that was originally returned to client code, if any. + </summary> + </member> + <member name="F:Rhino.Mocks.MockRepository.proxies"> + <summary> + All the proxies in the mock repositories + </summary> + </member> + <member name="F:Rhino.Mocks.MockRepository.repeatableMethods"> + <summary> + This is here because we can't put it in any of the recorders, since repeatable methods + have no orderring, and if we try to handle them using the usual manner, we would get into + wierd situations where repeatable method that was defined in an orderring block doesn't + exists until we enter this block. + </summary> + </member> + <member name="M:Rhino.Mocks.MockRepository.#ctor"> + <summary> + Creates a new <see cref="T:Rhino.Mocks.MockRepository"/> instance. + </summary> + </member> + <member name="M:Rhino.Mocks.MockRepository.Ordered"> + <summary> + Move the repository to ordered mode + </summary> + </member> + <member name="M:Rhino.Mocks.MockRepository.Unordered"> + <summary> + Move the repository to un-ordered mode + </summary> + </member> + <member name="M:Rhino.Mocks.MockRepository.CreateMock(System.Type,System.Object[])"> + <summary> + Creates a mock for the specified type. + </summary> + <param name="type">Type.</param> + <param name="argumentsForConstructor">Arguments for the class' constructor, if mocking a concrete class</param> + </member> + <member name="M:Rhino.Mocks.MockRepository.StrictMock(System.Type,System.Object[])"> + <summary> + Creates a strict mock for the specified type. + </summary> + <param name="type">Type.</param> + <param name="argumentsForConstructor">Arguments for the class' constructor, if mocking a concrete class</param> + </member> + <member name="M:Rhino.Mocks.MockRepository.CreateMockWithRemoting(System.Type,System.Object[])"> + <summary> + Creates a remoting mock for the specified type. + </summary> + <param name="type">Type.</param> + <param name="argumentsForConstructor">Arguments for the class' constructor, if mocking a concrete class</param> + </member> + <member name="M:Rhino.Mocks.MockRepository.StrictMockWithRemoting(System.Type,System.Object[])"> + <summary> + Creates a strict remoting mock for the specified type. + </summary> + <param name="type">Type.</param> + <param name="argumentsForConstructor">Arguments for the class' constructor, if mocking a concrete class</param> + </member> + <member name="M:Rhino.Mocks.MockRepository.CreateMockWithRemoting``1(System.Object[])"> + <summary> + Creates a remoting mock for the specified type. + </summary> + <typeparam name="T"></typeparam> + <param name="argumentsForConstructor">Arguments for the class' constructor, if mocking a concrete class</param> + <returns></returns> + </member> + <member name="M:Rhino.Mocks.MockRepository.StrictMockWithRemoting``1(System.Object[])"> + <summary> + Creates a strict remoting mock for the specified type. + </summary> + <typeparam name="T"></typeparam> + <param name="argumentsForConstructor">Arguments for the class' constructor, if mocking a concrete class</param> + <returns></returns> + </member> + <member name="M:Rhino.Mocks.MockRepository.CreateMultiMock(System.Type,System.Type[])"> + <summary> + Creates a mock from several types, with strict semantics. + Only <paramref name="mainType"/> may be a class. + </summary> + </member> + <member name="M:Rhino.Mocks.MockRepository.StrictMultiMock(System.Type,System.Type[])"> + <summary> + Creates a strict mock from several types, with strict semantics. + Only <paramref name="mainType"/> may be a class. + </summary> + </member> + <member name="M:Rhino.Mocks.MockRepository.CreateMultiMock(System.Type,System.Type[],System.Object[])"> + <summary> + Creates a mock from several types, with strict semantics. + Only <paramref name="mainType"/> may be a class. + </summary> + <param name="mainType">The main type to mock.</param> + <param name="extraTypes">Extra interface types to mock.</param> + <param name="argumentsForConstructor">Arguments for the class' constructor, if mocking a concrete class.</param> + </member> + <member name="M:Rhino.Mocks.MockRepository.StrictMultiMock(System.Type,System.Type[],System.Object[])"> + <summary> + Creates a strict mock from several types, with strict semantics. + Only <paramref name="mainType"/> may be a class. + </summary> + <param name="mainType">The main type to mock.</param> + <param name="extraTypes">Extra interface types to mock.</param> + <param name="argumentsForConstructor">Arguments for the class' constructor, if mocking a concrete class.</param> + </member> + <member name="M:Rhino.Mocks.MockRepository.DynamicMultiMock(System.Type,System.Type[])"> + <summary> + Creates a mock from several types, with dynamic semantics. + Only <paramref name="mainType"/> may be a class. + </summary> + <param name="mainType">The main type to mock.</param> + <param name="extraTypes">Extra interface types to mock.</param> + </member> + <member name="M:Rhino.Mocks.MockRepository.DynamicMultiMock(System.Type,System.Type[],System.Object[])"> + <summary> + Creates a mock from several types, with dynamic semantics. + Only <paramref name="mainType"/> may be a class. + </summary> + <param name="mainType">The main type to mock.</param> + <param name="extraTypes">Extra interface types to mock.</param> + <param name="argumentsForConstructor">Arguments for the class' constructor, if mocking a concrete class.</param> + </member> + <member name="M:Rhino.Mocks.MockRepository.DynamicMock(System.Type,System.Object[])"> + <summary>Creates a dynamic mock for the specified type.</summary> + <param name="type">Type.</param> + <param name="argumentsForConstructor">Arguments for the class' constructor, if mocking a concrete class</param> + </member> + <member name="M:Rhino.Mocks.MockRepository.DynamicMockWithRemoting(System.Type,System.Object[])"> + <summary>Creates a dynamic mock for the specified type.</summary> + <param name="type">Type.</param> + <param name="argumentsForConstructor">Arguments for the class' constructor, if mocking a concrete class</param> + </member> + <member name="M:Rhino.Mocks.MockRepository.DynamicMockWithRemoting``1(System.Object[])"> + <summary>Creates a dynamic mock for the specified type.</summary> + <typeparam name="T"></typeparam> + <param name="argumentsForConstructor">Arguments for the class' constructor, if mocking a concrete class</param> + <returns></returns> + </member> + <member name="M:Rhino.Mocks.MockRepository.PartialMock(System.Type,System.Object[])"> + <summary>Creates a mock object that defaults to calling the class methods if no expectation is set on the method.</summary> + <param name="type">Type.</param> + <param name="argumentsForConstructor">Arguments for the class' constructor.</param> + </member> + <member name="M:Rhino.Mocks.MockRepository.PartialMultiMock(System.Type,System.Type[])"> + <summary>Creates a mock object that defaults to calling the class methods.</summary> + <param name="type">Type.</param> + <param name="extraTypes">Extra interface types to mock.</param> + </member> + <member name="M:Rhino.Mocks.MockRepository.PartialMultiMock(System.Type,System.Type[],System.Object[])"> + <summary>Creates a mock object that defaults to calling the class methods.</summary> + <param name="type">Type.</param> + <param name="extraTypes">Extra interface types to mock.</param> + <param name="argumentsForConstructor">Arguments for the class' constructor.</param> + </member> + <member name="M:Rhino.Mocks.MockRepository.RemotingMock(System.Type,Rhino.Mocks.MockRepository.CreateMockState)"> + <summary>Creates a mock object using remoting proxies</summary> + <param name="type">Type to mock - must be MarshalByRefObject</param> + <returns>Mock object</returns> + <remarks>Proxy mock can mock non-virtual methods, but not static methods</remarks> + <param name="factory">Creates the mock state for this proxy</param> + </member> + <member name="M:Rhino.Mocks.MockRepository.Replay(System.Object)"> + <summary> + Cause the mock state to change to replay, any further call is compared to the + ones that were called in the record state. + </summary> + <remarks>This method *cannot* be called from inside an ordering.</remarks> + <param name="obj">the object to move to replay state</param> + </member> + <member name="M:Rhino.Mocks.MockRepository.ReplayCore(System.Object,System.Boolean)"> + <summary> + Cause the mock state to change to replay, any further call is compared to the + ones that were called in the record state. + </summary> + <param name="obj">the object to move to replay state</param> + <param name="checkInsideOrdering"></param> + </member> + <member name="M:Rhino.Mocks.MockRepository.BackToRecord(System.Object)"> + <summary>Move the mocked object back to record state.<para>You can (and it's recommended) to run {Verify()} before you use this method.</para></summary> + <remarks>Will delete all current expectations!</remarks> + </member> + <member name="M:Rhino.Mocks.MockRepository.BackToRecord(System.Object,Rhino.Mocks.BackToRecordOptions)"> + <summary> + Move the mocked object back to record state. + Optionally, can delete all current expectations, but allows more granularity about how + it would behave with regard to the object state. + </summary> + </member> + <member name="M:Rhino.Mocks.MockRepository.Verify(System.Object)"> + <summary> + Verify that all the expectations for this object were fulfilled. + </summary> + <param name="obj">the object to verify the expectations for</param> + </member> + <member name="M:Rhino.Mocks.MockRepository.LastMethodCall``1(System.Object)"> + <summary> + Get the method options for the last call on + mockedInstance. + </summary> + <param name="mockedInstance">The mock object</param> + <returns>Method options for the last call</returns> + </member> + <member name="M:Rhino.Mocks.MockRepository.GetMockObjectFromInvocationProxy(System.Object)"> + <summary> + Maps an invocation proxy back to the mock object instance that was originally + returned to client code which might have been a delegate to this proxy. + </summary> + <param name="invocationProxy">The mock object proxy from the intercepted invocation</param> + <returns>The mock object</returns> + </member> + <member name="M:Rhino.Mocks.MockRepository.CreateMockObject(System.Type,Rhino.Mocks.MockRepository.CreateMockState,System.Type[],System.Object[])"> + <summary>This is provided to allow advance extention functionality, where Rhino Mocks standard functionality is not enough.</summary> + <param name="type">The type to mock</param> + <param name="factory">Delegate that create the first state of the mocked object (usualy the record state).</param> + <param name="extras">Additional types to be implemented, this can be only interfaces </param> + <param name="argumentsForConstructor">optional arguments for the constructor</param> + <returns></returns> + </member> + <member name="M:Rhino.Mocks.MockRepository.GetMockedObject(System.Object)"> + <summary> + Method: GetMockedObject + Get an IProxy from a mocked object instance, or throws if the + object is not a mock object. + </summary> + </member> + <member name="M:Rhino.Mocks.MockRepository.GetMockedObjectOrNull(System.Object)"> + <summary> + Method: GetMockedObjectOrNull + Get an IProxy from a mocked object instance, or null if the + object is not a mock object. + </summary> + </member> + <member name="M:Rhino.Mocks.MockRepository.PopRecorder"> + <summary>Pops the recorder.</summary> + </member> + <member name="M:Rhino.Mocks.MockRepository.PushRecorder(Rhino.Mocks.Interfaces.IMethodRecorder)"> + <summary>Pushes the recorder.</summary> + <param name="newRecorder">New recorder.</param> + </member> + <member name="M:Rhino.Mocks.MockRepository.BackToRecordAll"> + <summary> + All the mock objects in this repository will be moved + to record state. + </summary> + </member> + <member name="M:Rhino.Mocks.MockRepository.BackToRecordAll(Rhino.Mocks.BackToRecordOptions)"> + <summary> + All the mock objects in this repository will be moved + to record state. + </summary> + </member> + <member name="M:Rhino.Mocks.MockRepository.ReplayAll"> + <summary> + Replay all the mocks from this repository + </summary> + </member> + <member name="M:Rhino.Mocks.MockRepository.VerifyAll"> + <summary> + Verify all the mocks from this repository + </summary> + </member> + <member name="M:Rhino.Mocks.MockRepository.GetProxyGenerator(System.Type)"> + <summary> + Gets the proxy generator for a specific type. Having a single ProxyGenerator + with multiple types linearly degrades the performance so this implementation + keeps one ProxyGenerator per type. + </summary> + </member> + <member name="M:Rhino.Mocks.MockRepository.SetExceptionToBeThrownOnVerify(System.Object,Rhino.Mocks.Exceptions.ExpectationViolationException)"> + <summary>Set the exception to be thrown when verified is called.</summary> + </member> + <member name="M:Rhino.Mocks.MockRepository.CreateMock``1(System.Object[])"> + <summary> + Creates a mock for the spesified type with strict mocking semantics. + <para>Strict semantics means that any call that wasn't explicitly recorded is considered an error and would cause an exception to be thrown.</para> + </summary> + <param name="argumentsForConstructor">Arguments for the class' constructor, if mocking a concrete class</param> + </member> + <member name="M:Rhino.Mocks.MockRepository.StrictMock``1(System.Object[])"> + <summary> + Creates a mock for the spesified type with strict mocking semantics. + <para>Strict semantics means that any call that wasn't explicitly recorded is considered an error and would cause an exception to be thrown.</para> + </summary> + <param name="argumentsForConstructor">Arguments for the class' constructor, if mocking a concrete class</param> + </member> + <member name="M:Rhino.Mocks.MockRepository.DynamicMock``1(System.Object[])"> + <summary> + Creates a dynamic mock for the specified type. + </summary> + <param name="argumentsForConstructor">Arguments for the class' constructor, if mocking a concrete class</param> + </member> + <member name="M:Rhino.Mocks.MockRepository.CreateMultiMock``1(System.Type[])"> + <summary> + Creates a mock object from several types. + </summary> + </member> + <member name="M:Rhino.Mocks.MockRepository.StrictMultiMock``1(System.Type[])"> + <summary> + Creates a strict mock object from several types. + </summary> + </member> + <member name="M:Rhino.Mocks.MockRepository.DynamicMultiMock``1(System.Type[])"> + <summary> + Create a mock object from several types with dynamic semantics. + </summary> + </member> + <member name="M:Rhino.Mocks.MockRepository.PartialMultiMock``1(System.Type[])"> + <summary> + Create a mock object from several types with partial semantics. + </summary> + </member> + <member name="M:Rhino.Mocks.MockRepository.CreateMultiMock``1(System.Type[],System.Object[])"> + <summary> + Create a mock object from several types with strict semantics. + </summary> + <param name="extraTypes">Extra interface types to mock.</param> + <param name="argumentsForConstructor">Arguments for the class' constructor, if mocking a concrete class</param> + </member> + <member name="M:Rhino.Mocks.MockRepository.StrictMultiMock``1(System.Type[],System.Object[])"> + <summary> + Create a strict mock object from several types with strict semantics. + </summary> + <param name="extraTypes">Extra interface types to mock.</param> + <param name="argumentsForConstructor">Arguments for the class' constructor, if mocking a concrete class</param> + </member> + <member name="M:Rhino.Mocks.MockRepository.DynamicMultiMock``1(System.Type[],System.Object[])"> + <summary> + Create a mock object from several types with dynamic semantics. + </summary> + <param name="extraTypes">Extra interface types to mock.</param> + <param name="argumentsForConstructor">Arguments for the class' constructor, if mocking a concrete class</param> + </member> + <member name="M:Rhino.Mocks.MockRepository.PartialMultiMock``1(System.Type[],System.Object[])"> + <summary> + Create a mock object from several types with partial semantics. + </summary> + <param name="extraTypes">Extra interface types to mock.</param> + <param name="argumentsForConstructor">Arguments for the class' constructor, if mocking a concrete class</param> + </member> + <member name="M:Rhino.Mocks.MockRepository.PartialMock``1(System.Object[])"> + <summary> + Create a mock object with from a class that defaults to calling the class methods + </summary> + <param name="argumentsForConstructor">Arguments for the class' constructor, if mocking a concrete class</param> + </member> + <member name="M:Rhino.Mocks.MockRepository.Stub``1(System.Object[])"> + <summary> + Create a stub object, one that has properties and events ready for use, and + can have methods called on it. It requires an explicit step in order to create + an expectation for a stub. + </summary> + <param name="argumentsForConstructor">The arguments for constructor.</param> + </member> + <member name="M:Rhino.Mocks.MockRepository.Stub(System.Type,System.Object[])"> + <summary> + Create a stub object, one that has properties and events ready for use, and + can have methods called on it. It requires an explicit step in order to create + an expectation for a stub. + </summary> + <param name="type">The type.</param> + <param name="argumentsForConstructor">The arguments for constructor.</param> + <returns>The stub</returns> + </member> + <member name="M:Rhino.Mocks.MockRepository.IsInReplayMode(System.Object)"> + <summary> + Returns true if the passed mock is currently in replay mode. + </summary> + <param name="mock">The mock to test.</param> + <returns>True if the mock is in replay mode, false otherwise.</returns> + </member> + <member name="M:Rhino.Mocks.MockRepository.IsStub(System.Object)"> + <summary> + Determines whether the specified proxy is a stub. + </summary> + <param name="proxy">The proxy.</param> + </member> + <member name="M:Rhino.Mocks.MockRepository.RegisterPropertyBehaviorOn(Rhino.Mocks.Interfaces.IMockedObject)"> + <summary> + Register a call on a prperty behavior + </summary> + <param name="instance"></param> + </member> + <member name="P:Rhino.Mocks.MockRepository.Recorder"> + <summary> + Gets the recorder. + </summary> + <value></value> + </member> + <member name="P:Rhino.Mocks.MockRepository.Replayer"> + <summary> + Gets the replayer for this repository. + </summary> + <value></value> + </member> + <member name="P:Rhino.Mocks.MockRepository.LastMockedObject"> + <summary> + Gets the last proxy which had a method call. + </summary> + </member> + <member name="T:Rhino.Mocks.MockRepository.CreateMockState"> + <summary> + Delegate: CreateMockState + This is used internally to cleanly handle the creation of different + RecordMockStates. + </summary> + </member> + <member name="T:Rhino.Mocks.RhinoMocksExtensions"> + <summary> + A set of extension methods that adds Arrange Act Assert mode to Rhino Mocks + </summary> + </member> + <member name="M:Rhino.Mocks.RhinoMocksExtensions.Expect``1(``0,System.Action{``0})"> + <summary> + Create an expectation on this mock for this action to occur + </summary> + <typeparam name="T"></typeparam> + <param name="mock">The mock.</param> + <param name="action">The action.</param> + <returns></returns> + </member> + <member name="M:Rhino.Mocks.RhinoMocksExtensions.BackToRecord``1(``0)"> + <summary> + Reset all expectations on this mock object + </summary> + <typeparam name="T"></typeparam> + <param name="mock">The mock.</param> + </member> + <member name="M:Rhino.Mocks.RhinoMocksExtensions.BackToRecord``1(``0,Rhino.Mocks.BackToRecordOptions)"> + <summary> + Reset the selected expectation on this mock object + </summary> + <typeparam name="T"></typeparam> + <param name="mock">The mock.</param> + <param name="options">The options to reset the expectations on this mock.</param> + </member> + <member name="M:Rhino.Mocks.RhinoMocksExtensions.Replay``1(``0)"> + <summary> + Cause the mock state to change to replay, any further call is compared to the + ones that were called in the record state. + </summary> + <param name="mock">the mocked object to move to replay state</param> + </member> + <member name="M:Rhino.Mocks.RhinoMocksExtensions.GetMockRepository``1(``0)"> + <summary> + Gets the mock repository for this specificied mock object + </summary> + <typeparam name="T"></typeparam> + <param name="mock">The mock.</param> + <returns></returns> + </member> + <member name="M:Rhino.Mocks.RhinoMocksExtensions.Expect``2(``0,Rhino.Mocks.Function{``0,``1})"> + <summary> + Create an expectation on this mock for this action to occur + </summary> + <typeparam name="T"></typeparam> + <typeparam name="R"></typeparam> + <param name="mock">The mock.</param> + <param name="action">The action.</param> + <returns></returns> + </member> + <member name="M:Rhino.Mocks.RhinoMocksExtensions.Stub``1(``0,System.Action{``0})"> + <summary> + Tell the mock object to perform a certain action when a matching + method is called. + Does not create an expectation for this method. + </summary> + <typeparam name="T"></typeparam> + <param name="mock">The mock.</param> + <param name="action">The action.</param> + <returns></returns> + </member> + <member name="M:Rhino.Mocks.RhinoMocksExtensions.Stub``2(``0,Rhino.Mocks.Function{``0,``1})"> + <summary> + Tell the mock object to perform a certain action when a matching + method is called. + Does not create an expectation for this method. + </summary> + <typeparam name="T"></typeparam> + <typeparam name="R"></typeparam> + <param name="mock">The mock.</param> + <param name="action">The action.</param> + <returns></returns> + </member> + <member name="M:Rhino.Mocks.RhinoMocksExtensions.GetArgumentsForCallsMadeOn``1(``0,System.Action{``0})"> + <summary> + Gets the arguments for calls made on this mock object and the method that was called + in the action. + </summary> + <typeparam name="T"></typeparam> + <param name="mock">The mock.</param> + <param name="action">The action.</param> + <returns></returns> + <example> + Here we will get all the arguments for all the calls made to DoSomething(int) + <code> + var argsForCalls = foo54.GetArgumentsForCallsMadeOn(x => x.DoSomething(0)) + </code> + </example> + </member> + <member name="M:Rhino.Mocks.RhinoMocksExtensions.GetArgumentsForCallsMadeOn``1(``0,System.Action{``0},System.Action{Rhino.Mocks.Interfaces.IMethodOptions{System.Object}})"> + <summary> + Gets the arguments for calls made on this mock object and the method that was called + in the action and matches the given constraints + </summary> + <typeparam name="T"></typeparam> + <param name="mock">The mock.</param> + <param name="action">The action.</param> + <param name="setupConstraints">The setup constraints.</param> + <returns></returns> + <example> + Here we will get all the arguments for all the calls made to DoSomething(int) + <code> + var argsForCalls = foo54.GetArgumentsForCallsMadeOn(x => x.DoSomething(0)) + </code> + </example> + </member> + <member name="M:Rhino.Mocks.RhinoMocksExtensions.AssertWasCalled``1(``0,System.Action{``0})"> + <summary> + Asserts that a particular method was called on this mock object + </summary> + <typeparam name="T"></typeparam> + <param name="mock">The mock.</param> + <param name="action">The action.</param> + </member> + <member name="M:Rhino.Mocks.RhinoMocksExtensions.AssertWasCalled``1(``0,System.Action{``0},System.Action{Rhino.Mocks.Interfaces.IMethodOptions{System.Object}})"> + <summary> + Asserts that a particular method was called on this mock object that match + a particular constraint set. + </summary> + <typeparam name="T"></typeparam> + <param name="mock">The mock.</param> + <param name="action">The action.</param> + <param name="setupConstraints">The setup constraints.</param> + </member> + <member name="M:Rhino.Mocks.RhinoMocksExtensions.AssertWasCalled``1(``0,System.Func{``0,System.Object})"> + <summary> + Asserts that a particular method was called on this mock object that match + a particular constraint set. + </summary> + <typeparam name="T"></typeparam> + <param name="mock">The mock.</param> + <param name="action">The action.</param> + </member> + <member name="M:Rhino.Mocks.RhinoMocksExtensions.AssertWasCalled``1(``0,System.Func{``0,System.Object},System.Action{Rhino.Mocks.Interfaces.IMethodOptions{System.Object}})"> + <summary> + Asserts that a particular method was called on this mock object that match + a particular constraint set. + </summary> + <typeparam name="T"></typeparam> + <param name="mock">The mock.</param> + <param name="action">The action.</param> + <param name="setupConstraints">The setup constraints.</param> + </member> + <member name="M:Rhino.Mocks.RhinoMocksExtensions.AssertWasNotCalled``1(``0,System.Action{``0})"> + <summary> + Asserts that a particular method was NOT called on this mock object + </summary> + <typeparam name="T"></typeparam> + <param name="mock">The mock.</param> + <param name="action">The action.</param> + </member> + <member name="M:Rhino.Mocks.RhinoMocksExtensions.AssertWasNotCalled``1(``0,System.Action{``0},System.Action{Rhino.Mocks.Interfaces.IMethodOptions{System.Object}})"> + <summary> + Asserts that a particular method was NOT called on this mock object that match + a particular constraint set. + </summary> + <typeparam name="T"></typeparam> + <param name="mock">The mock.</param> + <param name="action">The action.</param> + <param name="setupConstraints">The setup constraints.</param> + </member> + <member name="M:Rhino.Mocks.RhinoMocksExtensions.AssertWasNotCalled``1(``0,System.Func{``0,System.Object})"> + <summary> + Asserts that a particular method was NOT called on this mock object + </summary> + <typeparam name="T"></typeparam> + <param name="mock">The mock.</param> + <param name="action">The action.</param> + </member> + <member name="M:Rhino.Mocks.RhinoMocksExtensions.AssertWasNotCalled``1(``0,System.Func{``0,System.Object},System.Action{Rhino.Mocks.Interfaces.IMethodOptions{System.Object}})"> + <summary> + Asserts that a particular method was NOT called on this mock object + </summary> + <typeparam name="T"></typeparam> + <param name="mock">The mock.</param> + <param name="action">The action.</param> + <param name="setupConstraints">The setup constraints.</param> + </member> + <member name="M:Rhino.Mocks.RhinoMocksExtensions.FindAppropriteType``1(Rhino.Mocks.Interfaces.IMockedObject)"> + <summary> + Finds the approprite implementation type of this item. + This is the class or an interface outside of the rhino mocks. + </summary> + <param name="mockedObj">The mocked obj.</param> + <returns></returns> + </member> + <member name="M:Rhino.Mocks.RhinoMocksExtensions.VerifyAllExpectations(System.Object)"> + <summary> + Verifies all expectations on this mock object + </summary> + <param name="mockObject">The mock object.</param> + </member> + <member name="M:Rhino.Mocks.RhinoMocksExtensions.GetEventRaiser``1(``0,System.Action{``0})"> + <summary> + Gets the event raiser for the event that was called in the action passed + </summary> + <typeparam name="TEventSource">The type of the event source.</typeparam> + <param name="mockObject">The mock object.</param> + <param name="eventSubscription">The event subscription.</param> + <returns></returns> + </member> + <member name="M:Rhino.Mocks.RhinoMocksExtensions.Raise``1(``0,System.Action{``0},System.Object,System.EventArgs)"> + <summary> + Raise the specified event using the passed arguments. + The even is extracted from the passed labmda + </summary> + <typeparam name="TEventSource">The type of the event source.</typeparam> + <param name="mockObject">The mock object.</param> + <param name="eventSubscription">The event subscription.</param> + <param name="sender">The sender.</param> + <param name="args">The <see cref="T:System.EventArgs"/> instance containing the event data.</param> + </member> + <member name="M:Rhino.Mocks.RhinoMocksExtensions.Raise``1(``0,System.Action{``0},System.Object[])"> + <summary> + Raise the specified event using the passed arguments. + The even is extracted from the passed labmda + </summary> + <typeparam name="TEventSource">The type of the event source.</typeparam> + <param name="mockObject">The mock object.</param> + <param name="eventSubscription">The event subscription.</param> + <param name="args">The args.</param> + </member> + <member name="M:Rhino.Mocks.RhinoMocksExtensions.AssertExactlySingleExpectaton``1(Rhino.Mocks.MockRepository,``0)"> + <summary>TODO: Make this better! It currently breaks down when mocking classes or + ABC's that call other virtual methods which are getting intercepted too. I wish + we could just walk Expression{Action{Action{T}} to assert only a single + method is being made. + + The workaround is to not call foo.AssertWasCalled .. rather foo.VerifyAllExpectations()</summary> + <typeparam name="T">The type of mock object</typeparam> + <param name="mocks">The mock repository</param> + <param name="mockToRecordExpectation">The actual mock object to assert expectations on.</param> + </member> + <member name="T:Rhino.Mocks.RhinoMocksExtensions.VoidType"> + <summary> + Fake type that disallow creating it. + Should have been System.Type, but we can't use it. + </summary> + </member> + <member name="T:Rhino.Mocks.Utilities.GenericsUtil"> + <summary> + Utility class for dealing with messing generics scenarios. + </summary> + </member> + <member name="M:Rhino.Mocks.Utilities.GenericsUtil.HasOpenGenericParam(System.Type)"> + <summary> + There are issues with trying to get this to work correctly with open generic types, since this is an edge case, + I am letting the runtime handle it. + </summary> + </member> + <member name="M:Rhino.Mocks.Utilities.GenericsUtil.GetRealType(System.Type,Castle.Core.Interceptor.IInvocation)"> + <summary> + Gets the real type, including de-constructing and constructing the type of generic + methods parameters. + </summary> + <param name="type">The type.</param> + <param name="invocation">The invocation.</param> + <returns></returns> + </member> + <member name="M:Rhino.Mocks.Utilities.GenericsUtil.ReconstructGenericType(System.Type,System.Collections.Generic.Dictionary{System.String,System.Type})"> + <summary> + Because we need to support complex types here (simple generics were handled above) we + need to be aware of the following scenarios: + List[T] and List[Foo[T]] + </summary> + </member> + <member name="T:Rhino.Mocks.Generated.ExpectationsList"> + <summary> + ExpectationsList + </summary> + </member> + <member name="T:Rhino.Mocks.Generated.ProxyMethodExpectationsDictionary"> + <summary> + Dictionary + </summary> + </member> + <member name="T:Rhino.Mocks.Generated.ProxyStateDictionary"> + <summary> + Dictionary class + </summary> + </member> + <member name="M:Rhino.Mocks.Generated.ProxyStateDictionary.#ctor"> + <summary> + Create a new instance of <c>ProxyStateDictionary</c> + </summary> + </member> + <member name="T:Rhino.Mocks.Impl.CreateMethodExpectation"> + <summary> + Allows to call a method and immediately get it's options. + </summary> + </member> + <member name="T:Rhino.Mocks.Interfaces.ICreateMethodExpectation"> + <summary> + Interface to allow calling a method and immediately get it's options. + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.ICreateMethodExpectation.Call``1(``0)"> + <summary> + Get the method options for the call + </summary> + <param name="ignored">The method call should go here, the return value is ignored</param> + </member> + <member name="M:Rhino.Mocks.Impl.CreateMethodExpectation.#ctor(Rhino.Mocks.Interfaces.IMockedObject,System.Object)"> + <summary> + Creates a new <see cref="T:Rhino.Mocks.Impl.CreateMethodExpectation"/> instance. + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.CreateMethodExpectation.Call``1(``0)"> + <summary> + Get the method options for the call + </summary> + <param name="ignored">The method call should go here, the return value is ignored</param> + </member> + <member name="T:Rhino.Mocks.Impl.CreateMethodExpectationForSetupResult"> + <summary> + Allows to call a method and immediately get it's options. + Set the expected number for the call to Any() + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.CreateMethodExpectationForSetupResult.#ctor(Rhino.Mocks.Interfaces.IMockedObject,System.Object)"> + <summary> + Creates a new <see cref="T:Rhino.Mocks.Impl.CreateMethodExpectationForSetupResult"/> instance. + </summary> + <param name="mockedObject">Proxy.</param> + <param name="mockedInstance">Mocked instance.</param> + </member> + <member name="M:Rhino.Mocks.Impl.CreateMethodExpectationForSetupResult.Call``1(``0)"> + <summary> + Get the method options for the call + </summary> + <param name="ignored">The method call should go here, the return value is ignored</param> + </member> + <member name="T:Rhino.Mocks.Impl.DelegateTargetInterfaceCreator"> + <summary> + This class is reponsible for taking a delegate and creating a wrapper + interface around it, so it can be mocked. + </summary> + </member> + <member name="F:Rhino.Mocks.Impl.DelegateTargetInterfaceCreator.moduleScope"> + <summary> + The scope for all the delegate interfaces create by this mock repository. + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.DelegateTargetInterfaceCreator.GetDelegateTargetInterface(System.Type)"> + <summary> + Gets a type with an "Invoke" method suitable for use as a target of the + specified delegate type. + </summary> + <param name="delegateType"></param> + <returns></returns> + </member> + <member name="T:Rhino.Mocks.Impl.EventRaiser"> + <summary> + Raise events for all subscribers for an event + </summary> + </member> + <member name="T:Rhino.Mocks.Interfaces.IEventRaiser"> + <summary> + Raise events for all subscribers for an event + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.IEventRaiser.Raise(System.Object[])"> + <summary> + Raise the event + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.IEventRaiser.Raise(System.Object,System.EventArgs)"> + <summary> + The most common form for the event handler signature + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.EventRaiser.Create(System.Object,System.String)"> + <summary> + Create an event raiser for the specified event on this instance. + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.EventRaiser.#ctor(Rhino.Mocks.Interfaces.IMockedObject,System.String)"> + <summary> + Creates a new instance of <c>EventRaiser</c> + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.EventRaiser.Raise(System.Object[])"> + <summary> + Raise the event + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.EventRaiser.Raise(System.Object,System.EventArgs)"> + <summary> + The most common signature for events + Here to allow intellisense to make better guesses about how + it should suggest parameters. + </summary> + </member> + <member name="T:Rhino.Mocks.Impl.MethodOptions`1"> + <summary> + Allows to define what would happen when a method + is called. + </summary> + </member> + <member name="T:Rhino.Mocks.Interfaces.IMethodOptions`1"> + <summary> + Allows to define what would happen when a method + is called. + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMethodOptions`1.Return(`0)"> + <summary> + Set the return value for the method. + </summary> + <param name="objToReturn">The object the method will return</param> + <returns>IRepeat that defines how many times the method will return this value</returns> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMethodOptions`1.TentativeReturn"> + <summary> + Allow to override this return value in the future + </summary> + <returns>IRepeat that defines how many times the method will return this value</returns> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMethodOptions`1.Throw(System.Exception)"> + <summary> + Throws the specified exception when the method is called. + </summary> + <param name="exception">Exception to throw</param> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMethodOptions`1.IgnoreArguments"> + <summary> + Ignores the arguments for this method. Any argument will be matched + againt this method. + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMethodOptions`1.Constraints(Rhino.Mocks.Constraints.AbstractConstraint[])"> + <summary> + Add constraints for the method's arguments. + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMethodOptions`1.Callback(System.Delegate)"> + <summary> + Set a callback method for the last call + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMethodOptions`1.Callback(Rhino.Mocks.Delegates.Function{System.Boolean})"> + <summary> + Set a delegate to be called when the expectation is matched. + The delegate return value will be returned from the expectation. + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMethodOptions`1.Callback``1(Rhino.Mocks.Delegates.Function{System.Boolean,``0})"> + <summary> + Set a delegate to be called when the expectation is matched. + The delegate return value will be returned from the expectation. + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMethodOptions`1.Callback``2(Rhino.Mocks.Delegates.Function{System.Boolean,``0,``1})"> + <summary> + Set a delegate to be called when the expectation is matched. + The delegate return value will be returned from the expectation. + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMethodOptions`1.Callback``3(Rhino.Mocks.Delegates.Function{System.Boolean,``0,``1,``2})"> + <summary> + Set a delegate to be called when the expectation is matched. + The delegate return value will be returned from the expectation. + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMethodOptions`1.Callback``4(Rhino.Mocks.Delegates.Function{System.Boolean,``0,``1,``2,``3})"> + <summary> + Set a delegate to be called when the expectation is matched. + The delegate return value will be returned from the expectation. + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMethodOptions`1.Callback``5(Rhino.Mocks.Delegates.Function{System.Boolean,``0,``1,``2,``3,``4})"> + <summary> + Set a delegate to be called when the expectation is matched. + The delegate return value will be returned from the expectation. + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMethodOptions`1.Callback``6(Rhino.Mocks.Delegates.Function{System.Boolean,``0,``1,``2,``3,``4,``5})"> + <summary> + Set a delegate to be called when the expectation is matched. + The delegate return value will be returned from the expectation. + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMethodOptions`1.Callback``7(Rhino.Mocks.Delegates.Function{System.Boolean,``0,``1,``2,``3,``4,``5,``6})"> + <summary> + Set a delegate to be called when the expectation is matched. + The delegate return value will be returned from the expectation. + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMethodOptions`1.Callback``8(Rhino.Mocks.Delegates.Function{System.Boolean,``0,``1,``2,``3,``4,``5,``6,``7})"> + <summary> + Set a delegate to be called when the expectation is matched. + The delegate return value will be returned from the expectation. + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMethodOptions`1.Callback``9(Rhino.Mocks.Delegates.Function{System.Boolean,``0,``1,``2,``3,``4,``5,``6,``7,``8})"> + <summary> + Set a delegate to be called when the expectation is matched. + The delegate return value will be returned from the expectation. + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMethodOptions`1.Callback``10(Rhino.Mocks.Delegates.Function{System.Boolean,``0,``1,``2,``3,``4,``5,``6,``7,``8,``9})"> + <summary> + Set a delegate to be called when the expectation is matched. + The delegate return value will be returned from the expectation. + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMethodOptions`1.Do(System.Delegate)"> + <summary> + Set a delegate to be called when the expectation is matched. + The delegate return value will be returned from the expectation. + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMethodOptions`1.WhenCalled(System.Action{Rhino.Mocks.MethodInvocation})"> + <summary> + Set a delegate to be called when the expectation is matched + and allow to optionally modify the invocation as needed + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMethodOptions`1.CallOriginalMethod"> + <summary> + Call the original method on the class, bypassing the mocking layers. + </summary> + <returns></returns> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMethodOptions`1.CallOriginalMethod(Rhino.Mocks.Interfaces.OriginalCallOptions)"> + <summary> + Call the original method on the class, optionally bypassing the mocking layers. + </summary> + <returns></returns> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMethodOptions`1.PropertyBehavior"> + <summary> + Use the property as a simple property, getting/setting the values without + causing mock expectations. + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMethodOptions`1.SetPropertyAndIgnoreArgument"> + <summary> + Expect last (property) call as property setting, ignore the argument given + </summary> + <returns></returns> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMethodOptions`1.SetPropertyWithArgument(`0)"> + <summary> + Expect last (property) call as property setting with a given argument. + </summary> + <param name="argument"></param> + <returns></returns> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMethodOptions`1.GetEventRaiser"> + <summary> + Get an event raiser for the last subscribed event. + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMethodOptions`1.OutRef(System.Object[])"> + <summary> + Set the parameter values for out and ref parameters. + This is done using zero based indexing, and _ignoring_ any non out/ref parameter. + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMethodOptions`1.Message(System.String)"> + <summary> + Documentation message for the expectation + </summary> + <param name="documentationMessage">Message</param> + </member> + <member name="P:Rhino.Mocks.Interfaces.IMethodOptions`1.Repeat"> + <summary> + Better syntax to define repeats. + </summary> + </member> + <member name="T:Rhino.Mocks.Interfaces.IRepeat`1"> + <summary> + Allows to specify the number of time for method calls + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.IRepeat`1.Twice"> + <summary> + Repeat the method twice. + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.IRepeat`1.Once"> + <summary> + Repeat the method once. + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.IRepeat`1.AtLeastOnce"> + <summary> + Repeat the method at least once, then repeat as many time as it would like. + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.IRepeat`1.Any"> + <summary> + Repeat the method any number of times. + This has special affects in that this method would now ignore orderring. + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.IRepeat`1.Times(System.Int32,System.Int32)"> + <summary> + Set the range to repeat an action. + </summary> + <param name="min">Min.</param> + <param name="max">Max.</param> + </member> + <member name="M:Rhino.Mocks.Interfaces.IRepeat`1.Times(System.Int32)"> + <summary> + Set the amount of times to repeat an action. + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.IRepeat`1.Never"> + <summary> + This method must not appear in the replay state. + This has special affects in that this method would now ignore orderring. + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.MethodOptions`1.#ctor(Rhino.Mocks.MockRepository,Rhino.Mocks.Impl.RecordMockState,Rhino.Mocks.Interfaces.IMockedObject,Rhino.Mocks.Interfaces.IExpectation)"> + <summary> + Creates a new <see cref="T:Rhino.Mocks.Interfaces.IMethodOptions`1"/> instance. + </summary> + <param name="repository">the repository for this expectation</param> + <param name="record">the recorder for this proxy</param> + <param name="proxy">the proxy for this expectation</param> + <param name="expectation">Expectation.</param> + </member> + <member name="M:Rhino.Mocks.Impl.MethodOptions`1.Constraints(Rhino.Mocks.Constraints.AbstractConstraint[])"> + <summary> + Add constraints for the method's arguments. + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.MethodOptions`1.Callback(System.Delegate)"> + <summary> + Set a callback method for the last call + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.MethodOptions`1.Callback(Rhino.Mocks.Delegates.Function{System.Boolean})"> + <summary> + Set a callback method for the last call + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.MethodOptions`1.Callback``1(Rhino.Mocks.Delegates.Function{System.Boolean,``0})"> + <summary> + Set a callback method for the last call + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.MethodOptions`1.Callback``2(Rhino.Mocks.Delegates.Function{System.Boolean,``0,``1})"> + <summary> + Set a callback method for the last call + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.MethodOptions`1.Callback``3(Rhino.Mocks.Delegates.Function{System.Boolean,``0,``1,``2})"> + <summary> + Set a callback method for the last call + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.MethodOptions`1.Callback``4(Rhino.Mocks.Delegates.Function{System.Boolean,``0,``1,``2,``3})"> + <summary> + Set a callback method for the last call + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.MethodOptions`1.Callback``5(Rhino.Mocks.Delegates.Function{System.Boolean,``0,``1,``2,``3,``4})"> + <summary> + Set a callback method for the last call + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.MethodOptions`1.Callback``6(Rhino.Mocks.Delegates.Function{System.Boolean,``0,``1,``2,``3,``4,``5})"> + <summary> + Set a callback method for the last call + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.MethodOptions`1.Callback``7(Rhino.Mocks.Delegates.Function{System.Boolean,``0,``1,``2,``3,``4,``5,``6})"> + <summary> + Set a callback method for the last call + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.MethodOptions`1.Callback``8(Rhino.Mocks.Delegates.Function{System.Boolean,``0,``1,``2,``3,``4,``5,``6,``7})"> + <summary> + Set a callback method for the last call + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.MethodOptions`1.Callback``9(Rhino.Mocks.Delegates.Function{System.Boolean,``0,``1,``2,``3,``4,``5,``6,``7,``8})"> + <summary> + Set a callback method for the last call + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.MethodOptions`1.Callback``10(Rhino.Mocks.Delegates.Function{System.Boolean,``0,``1,``2,``3,``4,``5,``6,``7,``8,``9})"> + <summary> + Set a callback method for the last call + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.MethodOptions`1.Do(System.Delegate)"> + <summary> + Set a delegate to be called when the expectation is matched. + The delegate return value will be returned from the expectation. + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.MethodOptions`1.WhenCalled(System.Action{Rhino.Mocks.MethodInvocation})"> + <summary> + Set a delegate to be called when the expectation is matched. + The delegate return value will be returned from the expectation. + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.MethodOptions`1.Return(`0)"> + <summary> + Set the return value for the method. + </summary> + <param name="objToReturn">The object the method will return</param> + <returns>IRepeat that defines how many times the method will return this value</returns> + </member> + <member name="M:Rhino.Mocks.Impl.MethodOptions`1.TentativeReturn"> + <summary> + Set the return value for the method, but allow to override this return value in the future + </summary> + <returns>IRepeat that defines how many times the method will return this value</returns> + </member> + <member name="M:Rhino.Mocks.Impl.MethodOptions`1.Throw(System.Exception)"> + <summary> + Throws the specified exception when the method is called. + </summary> + <param name="exception">Exception to throw</param> + </member> + <member name="M:Rhino.Mocks.Impl.MethodOptions`1.IgnoreArguments"> + <summary> + Ignores the arguments for this method. Any argument will be matched + againt this method. + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.MethodOptions`1.CallOriginalMethod"> + <summary> + Call the original method on the class, bypassing the mocking layers. + </summary> + <returns></returns> + </member> + <member name="M:Rhino.Mocks.Impl.MethodOptions`1.CallOriginalMethod(Rhino.Mocks.Interfaces.OriginalCallOptions)"> + <summary> + Call the original method on the class, optionally bypassing the mocking layers + </summary> + <returns></returns> + </member> + <member name="M:Rhino.Mocks.Impl.MethodOptions`1.PropertyBehavior"> + <summary> + Use the property as a simple property, getting/setting the values without + causing mock expectations. + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.MethodOptions`1.SetPropertyAndIgnoreArgument"> + <summary> + Expect last (property) call as property setting, ignore the argument given + </summary> + <returns></returns> + </member> + <member name="M:Rhino.Mocks.Impl.MethodOptions`1.SetPropertyWithArgument(`0)"> + <summary> + Expect last (property) call as property setting with a given argument. + </summary> + <param name="argument"></param> + <returns></returns> + </member> + <member name="M:Rhino.Mocks.Impl.MethodOptions`1.GetEventRaiser"> + <summary> + Gets the event raiser for the last event + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.MethodOptions`1.OutRef(System.Object[])"> + <summary> + Set the parameter values for out and ref parameters. + This is done using zero based indexing, and _ignoring_ any non out/ref parameter. + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.MethodOptions`1.Twice"> + <summary> + Repeat the method twice. + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.MethodOptions`1.Once"> + <summary> + Repeat the method once. + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.MethodOptions`1.AtLeastOnce"> + <summary> + Repeat the method at least once, then repeat as many time as it would like. + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.MethodOptions`1.Never"> + <summary> + This method must not appear in the replay state. + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.MethodOptions`1.Message(System.String)"> + <summary> + Documentation message for the expectation + </summary> + <param name="documentationMessage">Message</param> + </member> + <member name="M:Rhino.Mocks.Impl.MethodOptions`1.Any"> + <summary> + Repeat the method any number of times. + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.MethodOptions`1.Times(System.Int32,System.Int32)"> + <summary> + Set the range to repeat an action. + </summary> + <param name="min">Min.</param> + <param name="max">Max.</param> + </member> + <member name="M:Rhino.Mocks.Impl.MethodOptions`1.Times(System.Int32)"> + <summary> + Set the amount of times to repeat an action. + </summary> + </member> + <member name="P:Rhino.Mocks.Impl.MethodOptions`1.Repeat"> + <summary> + Better syntax to define repeats. + </summary> + </member> + <member name="T:Rhino.Mocks.Impl.MockedObjectsEquality"> + <summary> + This class will provide hash code for hashtables without needing + to call the GetHashCode() on the object, which may very well be mocked. + This class has no state so it is a singelton to avoid creating a lot of objects + that does the exact same thing. See flyweight patterns. + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.MockedObjectsEquality.GetHashCode(System.Object)"> + <summary> + Get the hash code for a proxy object without calling GetHashCode() + on the object. + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.MockedObjectsEquality.Compare(System.Object,System.Object)"> + <summary> + Compares two instances of mocked objects + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.MockedObjectsEquality.Equals(System.Object,System.Object)"> + <summary> + Compare two mocked objects + </summary> + </member> + <member name="P:Rhino.Mocks.Impl.MockedObjectsEquality.NextHashCode"> + <summary> + The next hash code value for a mock object. + This is safe for multi threading. + </summary> + </member> + <member name="P:Rhino.Mocks.Impl.MockedObjectsEquality.Instance"> + <summary> + The sole instance of <see cref="T:Rhino.Mocks.Impl.MockedObjectsEquality"/> + </summary> + </member> + <member name="T:Rhino.Mocks.Impl.ProxyInstance"> + <summary> + This is a dummy type that is used merely to give DynamicProxy the proxy instance that + it needs to create IProxy's types. + </summary> + </member> + <member name="T:Rhino.Mocks.Interfaces.IMockedObject"> + <summary> + Interface to find the repository of a mocked object + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMockedObject.ShouldCallOriginal(System.Reflection.MethodInfo)"> + <summary> + Return true if it should call the original method on the object + instead of pass it to the message chain. + </summary> + <param name="method">The method to call</param> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMockedObject.RegisterMethodForCallingOriginal(System.Reflection.MethodInfo)"> + <summary> + Register a method to be called on the object directly + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMockedObject.RegisterPropertyBehaviorFor(System.Reflection.PropertyInfo)"> + <summary> + Register a property on the object that will behave as a simple property + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMockedObject.IsPropertyMethod(System.Reflection.MethodInfo)"> + <summary> + Check if the method was registered as a property method. + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMockedObject.HandleProperty(System.Reflection.MethodInfo,System.Object[])"> + <summary> + Do get/set on the property, according to need. + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMockedObject.HandleEvent(System.Reflection.MethodInfo,System.Object[])"> + <summary> + Do add/remove on the event + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMockedObject.GetEventSubscribers(System.String)"> + <summary> + Get the subscribers of a spesific event + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMockedObject.GetDeclaringType(System.Reflection.MethodInfo)"> + <summary> + Gets the declaring type of the method, taking into acccount the possible generic + parameters that it was created with. + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMockedObject.ClearState(Rhino.Mocks.BackToRecordOptions)"> + <summary> + Clears the state of the object, remove original calls, property behavior, subscribed events, etc. + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMockedObject.GetCallArgumentsFor(System.Reflection.MethodInfo)"> + <summary> + Get all the method calls arguments that were made against this object with the specificed + method. + </summary> + <remarks> + Only method calls in replay mode are counted + </remarks> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMockedObject.MethodCall(System.Reflection.MethodInfo,System.Object[])"> + <summary> + Records the method call + </summary> + </member> + <member name="P:Rhino.Mocks.Interfaces.IMockedObject.DependentMocks"> + <summary> + Mocks that are tied to this mock lifestyle + </summary> + </member> + <member name="P:Rhino.Mocks.Interfaces.IMockedObject.ProxyHash"> + <summary> + The unique hash code of this mock, which is not related + to the value of the GetHashCode() call on the object. + </summary> + </member> + <member name="P:Rhino.Mocks.Interfaces.IMockedObject.Repository"> + <summary> + Gets the repository. + </summary> + </member> + <member name="P:Rhino.Mocks.Interfaces.IMockedObject.ImplementedTypes"> + <summary> + Gets the implemented types by this mocked object + </summary> + <value>The implemented.</value> + </member> + <member name="P:Rhino.Mocks.Interfaces.IMockedObject.ConstructorArguments"> + <summary> + Gets or sets the constructor arguments. + </summary> + <value>The constructor arguments.</value> + </member> + <member name="P:Rhino.Mocks.Interfaces.IMockedObject.MockedObjectInstance"> + <summary> + The mocked instance that this is representing + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.ProxyInstance.#ctor(Rhino.Mocks.MockRepository,System.Type[])"> + <summary> + Create a new instance of <see cref="T:Rhino.Mocks.Impl.ProxyInstance"/> + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.ProxyInstance.ShouldCallOriginal(System.Reflection.MethodInfo)"> + <summary> + Return true if it should call the original method on the object + instead of pass it to the message chain. + </summary> + <param name="method">The method to call</param> + </member> + <member name="M:Rhino.Mocks.Impl.ProxyInstance.RegisterMethodForCallingOriginal(System.Reflection.MethodInfo)"> + <summary> + Register a method to be called on the object directly + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.ProxyInstance.RegisterPropertyBehaviorFor(System.Reflection.PropertyInfo)"> + <summary> + Register a property on the object that will behave as a simple property + Return true if there is already a value for the property + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.ProxyInstance.IsPropertyMethod(System.Reflection.MethodInfo)"> + <summary> + Check if the method was registered as a property method. + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.ProxyInstance.HandleProperty(System.Reflection.MethodInfo,System.Object[])"> + <summary> + Do get/set on the property, according to need. + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.ProxyInstance.HandleEvent(System.Reflection.MethodInfo,System.Object[])"> + <summary> + Do add/remove on the event + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.ProxyInstance.GetEventSubscribers(System.String)"> + <summary> + Get the subscribers of a spesific event + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.ProxyInstance.GetDeclaringType(System.Reflection.MethodInfo)"> + <summary> + Gets the declaring type of the method, taking into acccount the possible generic + parameters that it was created with. + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.ProxyInstance.GetCallArgumentsFor(System.Reflection.MethodInfo)"> + <summary> + Get all the method calls arguments that were made against this object with the specificed + method. + </summary> + <param name="method"></param> + <returns></returns> + <remarks> + Only method calls in replay mode are counted + </remarks> + </member> + <member name="M:Rhino.Mocks.Impl.ProxyInstance.MethodCall(System.Reflection.MethodInfo,System.Object[])"> + <summary> + Records the method call + </summary> + <param name="method"></param> + <param name="args"></param> + </member> + <member name="M:Rhino.Mocks.Impl.ProxyInstance.ClearState(Rhino.Mocks.BackToRecordOptions)"> + <summary> + Clears the state of the object, remove original calls, property behavior, subscribed events, etc. + </summary> + </member> + <member name="P:Rhino.Mocks.Impl.ProxyInstance.DependentMocks"> + <summary> + Mocks that are tied to this mock lifestyle + </summary> + </member> + <member name="P:Rhino.Mocks.Impl.ProxyInstance.ProxyHash"> + <summary> + The unique hash code of this proxy, which is not related + to the value of the GetHashCode() call on the object. + </summary> + </member> + <member name="P:Rhino.Mocks.Impl.ProxyInstance.Repository"> + <summary> + Gets the repository. + </summary> + </member> + <member name="P:Rhino.Mocks.Impl.ProxyInstance.ConstructorArguments"> + <summary> + Gets or sets the constructor arguments. + </summary> + <value>The constructor arguments.</value> + </member> + <member name="P:Rhino.Mocks.Impl.ProxyInstance.MockedObjectInstance"> + <summary> + The mocked instance that this is representing + </summary> + </member> + <member name="P:Rhino.Mocks.Impl.ProxyInstance.ImplementedTypes"> + <summary> + Gets the implemented types by this mocked object + </summary> + <value>The implemented.</value> + </member> + <member name="T:Rhino.Mocks.Impl.Range"> + <summary> + Range for expected method calls + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.Range.#ctor(System.Int32,System.Nullable{System.Int32})"> + <summary> + Creates a new <see cref="T:Rhino.Mocks.Impl.Range"/> instance. + </summary> + <param name="min">Min.</param> + <param name="max">Max.</param> + </member> + <member name="M:Rhino.Mocks.Impl.Range.ToString"> + <summary> + Return the string representation of this range. + </summary> + </member> + <member name="P:Rhino.Mocks.Impl.Range.Min"> + <summary> + Gets or sets the min. + </summary> + <value></value> + </member> + <member name="P:Rhino.Mocks.Impl.Range.Max"> + <summary> + Gets or sets the max. + </summary> + <value></value> + </member> + <member name="T:Rhino.Mocks.Impl.RecordDynamicMockState"> + <summary> + Records all the expectations for a mock and + return a ReplayDynamicMockState when Replay() + is called. + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.RecordDynamicMockState.#ctor(Rhino.Mocks.Interfaces.IMockedObject,Rhino.Mocks.MockRepository)"> + <summary> + Creates a new <see cref="T:Rhino.Mocks.Impl.RecordDynamicMockState"/> instance. + </summary> + <param name="repository">Repository.</param> + <param name="mockedObject">The proxy that generates the method calls</param> + </member> + <member name="M:Rhino.Mocks.Impl.RecordDynamicMockState.DoReplay"> + <summary> + Verify that we can move to replay state and move + to the reply state. + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.RecordDynamicMockState.GetDefaultCallCountRangeExpectation"> + <summary> + Get the default call count range expectation + </summary> + <returns></returns> + </member> + <member name="M:Rhino.Mocks.Impl.RecordDynamicMockState.BackToRecord"> + <summary> + Gets a mock state that match the original mock state of the object. + </summary> + </member> + <member name="T:Rhino.Mocks.Impl.RecordPartialMockState"> + <summary> + Records all the expectations for a mock and + return a ReplayPartialMockState when Replay() + is called. + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.RecordPartialMockState.#ctor(Rhino.Mocks.Interfaces.IMockedObject,Rhino.Mocks.MockRepository)"> + <summary> + Creates a new <see cref="T:Rhino.Mocks.Impl.RecordDynamicMockState"/> instance. + </summary> + <param name="repository">Repository.</param> + <param name="mockedObject">The proxy that generates the method calls</param> + </member> + <member name="M:Rhino.Mocks.Impl.RecordPartialMockState.DoReplay"> + <summary> + Verify that we can move to replay state and move + to the reply state. + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.RecordPartialMockState.BackToRecord"> + <summary> + Gets a mock state that matches the original mock state of the object. + </summary> + </member> + <member name="T:Rhino.Mocks.Impl.RepeatableOption"> + <summary> + Options for special repeat option + </summary> + </member> + <member name="F:Rhino.Mocks.Impl.RepeatableOption.Normal"> + <summary> + This method can be called only as many times as the IMethodOptions.Expect allows. + </summary> + </member> + <member name="F:Rhino.Mocks.Impl.RepeatableOption.Never"> + <summary> + This method should never be called + </summary> + </member> + <member name="F:Rhino.Mocks.Impl.RepeatableOption.Any"> + <summary> + This method can be call any number of times + </summary> + </member> + <member name="F:Rhino.Mocks.Impl.RepeatableOption.OriginalCall"> + <summary> + This method will call the original method + </summary> + </member> + <member name="F:Rhino.Mocks.Impl.RepeatableOption.OriginalCallBypassingMocking"> + <summary> + This method will call the original method, bypassing the mocking layer + </summary> + </member> + <member name="F:Rhino.Mocks.Impl.RepeatableOption.PropertyBehavior"> + <summary> + This method will simulate simple property behavior + </summary> + </member> + <member name="T:Rhino.Mocks.Impl.ReplayDynamicMockState"> + <summary> + Validate all expectations on a mock and ignores calls to + any method that was not setup properly. + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.ReplayDynamicMockState.#ctor(Rhino.Mocks.Impl.RecordDynamicMockState)"> + <summary> + Creates a new <see cref="T:Rhino.Mocks.Impl.ReplayDynamicMockState"/> instance. + </summary> + <param name="previousState">The previous state for this method</param> + </member> + <member name="M:Rhino.Mocks.Impl.ReplayDynamicMockState.DoMethodCall(Castle.Core.Interceptor.IInvocation,System.Reflection.MethodInfo,System.Object[])"> + <summary> + Add a method call for this state' mock. + </summary> + <param name="invocation">The invocation for this method</param> + <param name="method">The method that was called</param> + <param name="args">The arguments this method was called with</param> + </member> + <member name="M:Rhino.Mocks.Impl.ReplayDynamicMockState.BackToRecord"> + <summary> + Gets a mock state that match the original mock state of the object. + </summary> + </member> + <member name="T:Rhino.Mocks.Impl.ReplayPartialMockState"> + <summary> + Validate all expectations on a mock and ignores calls to + any method that was not setup properly. + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.ReplayPartialMockState.#ctor(Rhino.Mocks.Impl.RecordPartialMockState)"> + <summary> + Creates a new <see cref="T:Rhino.Mocks.Impl.ReplayDynamicMockState"/> instance. + </summary> + <param name="previousState">The previous state for this method</param> + </member> + <member name="M:Rhino.Mocks.Impl.ReplayPartialMockState.DoMethodCall(Castle.Core.Interceptor.IInvocation,System.Reflection.MethodInfo,System.Object[])"> + <summary> + Add a method call for this state' mock. + </summary> + <param name="invocation">The invocation for this method</param> + <param name="method">The method that was called</param> + <param name="args">The arguments this method was called with</param> + </member> + <member name="M:Rhino.Mocks.Impl.ReplayPartialMockState.BackToRecord"> + <summary> + Gets a mock state that match the original mock state of the object. + </summary> + </member> + <member name="T:Rhino.Mocks.Impl.RhinoInterceptor"> + <summary> + Summary description for RhinoInterceptor. + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.RhinoInterceptor.#ctor(Rhino.Mocks.MockRepository,Rhino.Mocks.Interfaces.IMockedObject,System.Collections.Generic.IEnumerable{Rhino.Mocks.Impl.Invocation.InvocationVisitor})"> + <summary> + Creates a new <see cref="T:Rhino.Mocks.Impl.RhinoInterceptor"/> instance. + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.RhinoInterceptor.Intercept(Castle.Core.Interceptor.IInvocation)"> + <summary> + Intercept a method call and direct it to the repository. + </summary> + </member> + <member name="T:Rhino.Mocks.Impl.Validate"> + <summary> + Validate arguments for methods + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.Validate.IsNotNull(System.Object,System.String)"> + <summary> + Validate that the passed argument is not null. + </summary> + <param name="obj">The object to validate</param> + <param name="name">The name of the argument</param> + <exception cref="T:System.ArgumentNullException"> + If the obj is null, an ArgumentNullException with the passed name + is thrown. + </exception> + </member> + <member name="M:Rhino.Mocks.Impl.Validate.ArgsEqual(System.Object[],System.Object[])"> + <summary> + Validate that the arguments are equal. + </summary> + <param name="expectedArgs">Expected args.</param> + <param name="actualArgs">Actual Args.</param> + </member> + <member name="M:Rhino.Mocks.Impl.Validate.AreEqual(System.Object,System.Object)"> + <summary> + Validate that the two arguments are equals, including validation for + when the arguments are collections, in which case it will validate their values. + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.Validate.SafeEquals(System.Object,System.Object)"> + <summary> + This method is safe for use even if any of the objects is a mocked object + that override equals. + </summary> + </member> + <member name="T:Rhino.Mocks.Impl.VerifiedMockState"> + <summary> + Throw an object already verified when accessed + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.VerifiedMockState.#ctor(Rhino.Mocks.Interfaces.IMockState)"> + <summary> + Create a new instance of VerifiedMockState + </summary> + <param name="previous">The previous mock state, used to get the initial record state</param> + </member> + <member name="M:Rhino.Mocks.Impl.VerifiedMockState.MethodCall(Castle.Core.Interceptor.IInvocation,System.Reflection.MethodInfo,System.Object[])"> + <summary> + Add a method call for this state' mock. + </summary> + <param name="invocation">The invocation for this method</param> + <param name="method">The method that was called</param> + <param name="args">The arguments this method was called with</param> + </member> + <member name="M:Rhino.Mocks.Impl.VerifiedMockState.Verify"> + <summary> + Verify that this mock expectations have passed. + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.VerifiedMockState.Replay"> + <summary> + Verify that we can move to replay state and move + to the reply state. + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.VerifiedMockState.BackToRecord"> + <summary> + Gets a mock state that match the original mock state of the object. + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.VerifiedMockState.GetLastMethodOptions``1"> + <summary> + Get the options for the last method call + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.VerifiedMockState.SetExceptionToThrowOnVerify(System.Exception)"> + <summary> + Set the exception to throw when Verify is called. + This is used to report exception that may have happened but where caught in the code. + This way, they are reported anyway when Verify() is called. + </summary> + </member> + <member name="M:Rhino.Mocks.Impl.VerifiedMockState.NotifyCallOnPropertyBehavior"> + <summary> + not relevant + </summary> + </member> + <member name="P:Rhino.Mocks.Impl.VerifiedMockState.VerifyState"> + <summary> + Gets the matching verify state for this state + </summary> + </member> + <member name="P:Rhino.Mocks.Impl.VerifiedMockState.LastMethodOptions"> + <summary> + Get the options for the last method call + </summary> + </member> + <member name="T:Rhino.Mocks.Interfaces.IMethodRecorder"> + <summary> + Records the actions on all the mocks created by a repository. + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMethodRecorder.Record(System.Object,System.Reflection.MethodInfo,Rhino.Mocks.Interfaces.IExpectation)"> + <summary> + Records the specified call with the specified args on the mocked object. + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMethodRecorder.GetRecordedExpectation(Castle.Core.Interceptor.IInvocation,System.Object,System.Reflection.MethodInfo,System.Object[])"> + <summary> + Get the expectation for this method on this object with this arguments + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMethodRecorder.GetRepeatableExpectation(System.Object,System.Reflection.MethodInfo,System.Object[])"> + <summary> + This check the methods that were setup using the SetupResult.For() + or LastCall.Repeat.Any() and that bypass the whole expectation model. + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMethodRecorder.GetAllExpectationsForProxyAndMethod(System.Object,System.Reflection.MethodInfo)"> + <summary> + Gets the all expectations for a mocked object and method combination, + regardless of the expected arguments / callbacks / contraints. + </summary> + <param name="proxy">Mocked object.</param> + <param name="method">Method.</param> + <returns>List of all relevant expectation</returns> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMethodRecorder.GetAllExpectationsForProxy(System.Object)"> + <summary> + Gets the all expectations for proxy. + </summary> + <param name="proxy">Mocked object.</param> + <returns>List of all relevant expectation</returns> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMethodRecorder.RemoveAllRepeatableExpectationsForProxy(System.Object)"> + <summary> + Removes all the repeatable expectations for proxy. + </summary> + <param name="proxy">Mocked object.</param> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMethodRecorder.ReplaceExpectation(System.Object,System.Reflection.MethodInfo,Rhino.Mocks.Interfaces.IExpectation,Rhino.Mocks.Interfaces.IExpectation)"> + <summary> + Replaces the old expectation with the new expectation for the specified proxy/method pair. + This replace ALL expectations that equal to old expectations. + </summary> + <param name="proxy">Proxy.</param> + <param name="method">Method.</param> + <param name="oldExpectation">Old expectation.</param> + <param name="newExpectation">New expectation.</param> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMethodRecorder.AddRecorder(Rhino.Mocks.Interfaces.IMethodRecorder)"> + <summary> + Adds the recorder and turn it into the active recorder. + </summary> + <param name="recorder">Recorder.</param> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMethodRecorder.MoveToPreviousRecorder"> + <summary> + Moves to previous recorder. + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMethodRecorder.GetRecordedExpectationOrNull(System.Object,System.Reflection.MethodInfo,System.Object[])"> + <summary> + Gets the recorded expectation or null. + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMethodRecorder.GetExpectedCallsMessage"> + <summary> + Gets the next expected calls string. + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMethodRecorder.MoveToParentReplayer"> + <summary> + Moves to parent recorder. + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMethodRecorder.AddToRepeatableMethods(System.Object,System.Reflection.MethodInfo,Rhino.Mocks.Interfaces.IExpectation)"> + <summary> + Set the expectation so it can repeat any number of times. + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMethodRecorder.RemoveExpectation(Rhino.Mocks.Interfaces.IExpectation)"> + <summary> + Removes the expectation from the recorder + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMethodRecorder.ClearReplayerToCall(Rhino.Mocks.Interfaces.IMethodRecorder)"> + <summary> + Clear the replayer to call (and all its chain of replayers) + This also removes it from the list of expectations, so it will never be considered again + </summary> + </member> + <member name="M:Rhino.Mocks.Interfaces.IMethodRecorder.UnexpectedMethodCall(Castle.Core.Interceptor.IInvocation,System.Object,System.Reflection.MethodInfo,System.Object[])"> + <summary> + Get the expectation for this method on this object with this arguments + </summary> + </member> + <member name="P:Rhino.Mocks.Interfaces.IMethodRecorder.HasExpectations"> + <summary> + Gets a value indicating whether this instance has expectations that weren't satisfied yet. + </summary> + <value> + <c>true</c> if this instance has expectations; otherwise, <c>false</c>. + </value> + </member> + <member name="T:Rhino.Mocks.LastCall"> + <summary> + Allows to set various options for the last method call on + a specified object. + If the method has a return value, it's recommended to use Expect + </summary> + </member> + <member name="M:Rhino.Mocks.LastCall.On(System.Object)"> + <summary> + Allows to get an interface to work on the last call. + </summary> + <param name="mockedInstance">The mocked object</param> + <returns>Interface that allows to set options for the last method call on this object</returns> + </member> + <member name="M:Rhino.Mocks.LastCall.Return``1(``0)"> + <summary> + Set the return value for the method. + </summary> + <param name="objToReturn">The object the method will return</param> + <returns>IRepeat that defines how many times the method will return this value</returns> + </member> + <member name="M:Rhino.Mocks.LastCall.Return(System.Object)"> + <summary> + Set the return value for the method. This overload is needed for LastCall.Return(null) + </summary> + <param name="objToReturn">The object the method will return</param> + <returns>IRepeat that defines how many times the method will return this value</returns> + </member> + <member name="M:Rhino.Mocks.LastCall.Throw(System.Exception)"> + <summary> + Throws the specified exception when the method is called. + </summary> + <param name="exception">Exception to throw</param> + </member> + <member name="M:Rhino.Mocks.LastCall.IgnoreArguments"> + <summary> + Ignores the arguments for this method. Any argument will be matched + againt this method. + </summary> + </member> + <member name="M:Rhino.Mocks.LastCall.Constraints(Rhino.Mocks.Constraints.AbstractConstraint[])"> + <summary> + Add constraints for the method's arguments. + </summary> + </member> + <member name="M:Rhino.Mocks.LastCall.Callback(System.Delegate)"> + <summary> + Set a callback method for the last call + </summary> + </member> + <member name="M:Rhino.Mocks.LastCall.Callback(Rhino.Mocks.Delegates.Function{System.Boolean})"> + <summary> + Set a callback method for the last call + </summary> + </member> + <member name="M:Rhino.Mocks.LastCall.Callback``1(Rhino.Mocks.Delegates.Function{System.Boolean,``0})"> + <summary> + Set a callback method for the last call + </summary> + </member> + <member name="M:Rhino.Mocks.LastCall.Callback``2(Rhino.Mocks.Delegates.Function{System.Boolean,``0,``1})"> + <summary> + Set a callback method for the last call + </summary> + </member> + <member name="M:Rhino.Mocks.LastCall.Callback``3(Rhino.Mocks.Delegates.Function{System.Boolean,``0,``1,``2})"> + <summary> + Set a callback method for the last call + </summary> + </member> + <member name="M:Rhino.Mocks.LastCall.Callback``4(Rhino.Mocks.Delegates.Function{System.Boolean,``0,``1,``2,``3})"> + <summary> + Set a callback method for the last call + </summary> + </member> + <member name="M:Rhino.Mocks.LastCall.Callback``5(Rhino.Mocks.Delegates.Function{System.Boolean,``0,``1,``2,``3,``4})"> + <summary> + Set a callback method for the last call + </summary> + </member> + <member name="M:Rhino.Mocks.LastCall.Callback``6(Rhino.Mocks.Delegates.Function{System.Boolean,``0,``1,``2,``3,``4,``5})"> + <summary> + Set a callback method for the last call + </summary> + </member> + <member name="M:Rhino.Mocks.LastCall.Callback``7(Rhino.Mocks.Delegates.Function{System.Boolean,``0,``1,``2,``3,``4,``5,``6})"> + <summary> + Set a callback method for the last call + </summary> + </member> + <member name="M:Rhino.Mocks.LastCall.Callback``8(Rhino.Mocks.Delegates.Function{System.Boolean,``0,``1,``2,``3,``4,``5,``6,``7})"> + <summary> + Set a callback method for the last call + </summary> + </member> + <member name="M:Rhino.Mocks.LastCall.Callback``9(Rhino.Mocks.Delegates.Function{System.Boolean,``0,``1,``2,``3,``4,``5,``6,``7,``8})"> + <summary> + Set a callback method for the last call + </summary> + </member> + <member name="M:Rhino.Mocks.LastCall.Callback``10(Rhino.Mocks.Delegates.Function{System.Boolean,``0,``1,``2,``3,``4,``5,``6,``7,``8,``9})"> + <summary> + Set a callback method for the last call + </summary> + </member> + <member name="M:Rhino.Mocks.LastCall.CallOriginalMethod"> + <summary> + Call the original method on the class, bypassing the mocking layers, for the last call. + </summary> + </member> + <member name="M:Rhino.Mocks.LastCall.CallOriginalMethod(Rhino.Mocks.Interfaces.OriginalCallOptions)"> + <summary> + Call the original method on the class, optionally bypassing the mocking layers, for the last call. + </summary> + </member> + <member name="M:Rhino.Mocks.LastCall.Do(System.Delegate)"> + <summary> + Set a delegate to be called when the expectation is matched. + The delegate return value will be returned from the expectation. + </summary> + </member> + <member name="M:Rhino.Mocks.LastCall.GetEventRaiser"> + <summary> + Gets an interface that will raise the last event when called. + </summary> + </member> + <member name="M:Rhino.Mocks.LastCall.OutRef(System.Object[])"> + <summary> + Set the parameter values for out and ref parameters. + This is done using zero based indexing, and _ignoring_ any non out/ref parameter. + </summary> + </member> + <member name="M:Rhino.Mocks.LastCall.Message(System.String)"> + <summary> + Documentation message for the expectation + </summary> + <param name="documentationMessage">Message</param> + </member> + <member name="M:Rhino.Mocks.LastCall.PropertyBehavior"> + <summary> + Use the property as a simple property, getting/setting the values without + causing mock expectations. + </summary> + </member> + <member name="P:Rhino.Mocks.LastCall.Repeat"> + <summary> + Better syntax to define repeats. + </summary> + </member> + <member name="T:Rhino.Mocks.MethodRecorders.MethodRecorderBase"> + <summary> + Base class for method recorders, handle delegating to inner recorder if needed. + </summary> + </member> + <member name="F:Rhino.Mocks.MethodRecorders.MethodRecorderBase.recordedActions"> + <summary> + List of the expected actions on for this recorder + The legal values are: + * Expectations + * Method Recorders + </summary> + </member> + <member name="F:Rhino.Mocks.MethodRecorders.MethodRecorderBase.recorderToCall"> + <summary> + The current recorder. + </summary> + </member> + <member name="F:Rhino.Mocks.MethodRecorders.MethodRecorderBase.replayerToCall"> + <summary> + The current replayer; + </summary> + </member> + <member name="F:Rhino.Mocks.MethodRecorders.MethodRecorderBase.parentRecorder"> + <summary> + The parent recorder of this one, may be null. + </summary> + </member> + <member name="F:Rhino.Mocks.MethodRecorders.MethodRecorderBase.replayersToIgnoreForThisCall"> + <summary> + This contains a list of all the replayers that should be ignored + for a spesific method call. A replayer gets into this list by calling + ClearReplayerToCall() on its parent. This list is Clear()ed on each new invocation. + </summary> + </member> + <member name="F:Rhino.Mocks.MethodRecorders.MethodRecorderBase.repeatableMethods"> + <summary> + All the repeatable methods calls. + </summary> + </member> + <member name="F:Rhino.Mocks.MethodRecorders.MethodRecorderBase.recursionDepth"> + <summary> + Counts the recursion depth of the current expectation search stack + </summary> + </member> + <member name="M:Rhino.Mocks.MethodRecorders.MethodRecorderBase.#ctor(Rhino.Mocks.Generated.ProxyMethodExpectationsDictionary)"> + <summary> + Creates a new <see cref="T:Rhino.Mocks.MethodRecorders.MethodRecorderBase"/> instance. + </summary> + </member> + <member name="M:Rhino.Mocks.MethodRecorders.MethodRecorderBase.#ctor(Rhino.Mocks.Interfaces.IMethodRecorder,Rhino.Mocks.Generated.ProxyMethodExpectationsDictionary)"> + <summary> + Creates a new <see cref="T:Rhino.Mocks.MethodRecorders.MethodRecorderBase"/> instance. + </summary> + <param name="parentRecorder">Parent recorder.</param> + <param name="repeatableMethods">Repeatable methods</param> + </member> + <member name="M:Rhino.Mocks.MethodRecorders.MethodRecorderBase.Record(System.Object,System.Reflection.MethodInfo,Rhino.Mocks.Interfaces.IExpectation)"> + <summary> + Records the specified call with the specified args on the mocked object. + </summary> + </member> + <member name="M:Rhino.Mocks.MethodRecorders.MethodRecorderBase.GetRecordedExpectation(Castle.Core.Interceptor.IInvocation,System.Object,System.Reflection.MethodInfo,System.Object[])"> + <summary> + Get the expectation for this method on this object with this arguments + </summary> + </member> + <member name="M:Rhino.Mocks.MethodRecorders.MethodRecorderBase.GetAllExpectationsForProxyAndMethod(System.Object,System.Reflection.MethodInfo)"> + <summary> + Gets the all expectations for a mocked object and method combination, + regardless of the expected arguments / callbacks / contraints. + </summary> + <param name="proxy">Mocked object.</param> + <param name="method">Method.</param> + <returns>List of all relevant expectation</returns> + </member> + <member name="M:Rhino.Mocks.MethodRecorders.MethodRecorderBase.GetAllExpectationsForProxy(System.Object)"> + <summary> + Gets the all expectations for proxy. + </summary> + <param name="proxy">Mocked object.</param> + <returns>List of all relevant expectation</returns> + </member> + <member name="M:Rhino.Mocks.MethodRecorders.MethodRecorderBase.ReplaceExpectation(System.Object,System.Reflection.MethodInfo,Rhino.Mocks.Interfaces.IExpectation,Rhino.Mocks.Interfaces.IExpectation)"> + <summary> + Replaces the old expectation with the new expectation for the specified proxy/method pair. + This replace ALL expectations that equal to old expectations. + </summary> + <param name="proxy">Proxy.</param> + <param name="method">Method.</param> + <param name="oldExpectation">Old expectation.</param> + <param name="newExpectation">New expectation.</param> + </member> + <member name="M:Rhino.Mocks.MethodRecorders.MethodRecorderBase.RemoveAllRepeatableExpectationsForProxy(System.Object)"> + <summary> + Remove the all repeatable expectations for proxy. + </summary> + <param name="proxy">Mocked object.</param> + </member> + <member name="M:Rhino.Mocks.MethodRecorders.MethodRecorderBase.AddToRepeatableMethods(System.Object,System.Reflection.MethodInfo,Rhino.Mocks.Interfaces.IExpectation)"> + <summary> + Set the expectation so it can repeat any number of times. + </summary> + </member> + <member name="M:Rhino.Mocks.MethodRecorders.MethodRecorderBase.RemoveExpectation(Rhino.Mocks.Interfaces.IExpectation)"> + <summary> + Removes the expectation from the recorder + </summary> + </member> + <member name="M:Rhino.Mocks.MethodRecorders.MethodRecorderBase.AddRecorder(Rhino.Mocks.Interfaces.IMethodRecorder)"> + <summary> + Adds the recorder and turn it into the active recorder. + </summary> + <param name="recorder">Recorder.</param> + </member> + <member name="M:Rhino.Mocks.MethodRecorders.MethodRecorderBase.MoveToPreviousRecorder"> + <summary> + Moves to previous recorder. + </summary> + </member> + <member name="M:Rhino.Mocks.MethodRecorders.MethodRecorderBase.MoveToParentReplayer"> + <summary> + Moves to parent recorder. + </summary> + </member> + <member name="M:Rhino.Mocks.MethodRecorders.MethodRecorderBase.GetRecordedExpectationOrNull(System.Object,System.Reflection.MethodInfo,System.Object[])"> + <summary> + Gets the recorded expectation or null. + </summary> + </member> + <member name="M:Rhino.Mocks.MethodRecorders.MethodRecorderBase.ClearReplayerToCall(Rhino.Mocks.Interfaces.IMethodRecorder)"> + <summary> + Clear the replayer to call (and all its chain of replayers). + This also removes it from the list of expectations, so it will never be considered again + </summary> + </member> + <member name="M:Rhino.Mocks.MethodRecorders.MethodRecorderBase.UnexpectedMethodCall(Castle.Core.Interceptor.IInvocation,System.Object,System.Reflection.MethodInfo,System.Object[])"> + <summary> + Get the expectation for this method on this object with this arguments + </summary> + </member> + <member name="M:Rhino.Mocks.MethodRecorders.MethodRecorderBase.GetExpectedCallsMessage"> + <summary> + Gets the next expected calls string. + </summary> + </member> + <member name="M:Rhino.Mocks.MethodRecorders.MethodRecorderBase.DoGetRecordedExpectationOrNull(System.Object,System.Reflection.MethodInfo,System.Object[])"> + <summary> + Handles the real getting of the recorded expectation or null. + </summary> + </member> + <member name="M:Rhino.Mocks.MethodRecorders.MethodRecorderBase.DoRecord(System.Object,System.Reflection.MethodInfo,Rhino.Mocks.Interfaces.IExpectation)"> + <summary> + Handle the real execution of this method for the derived class + </summary> + </member> + <member name="M:Rhino.Mocks.MethodRecorders.MethodRecorderBase.DoGetRecordedExpectation(Castle.Core.Interceptor.IInvocation,System.Object,System.Reflection.MethodInfo,System.Object[])"> + <summary> + Handle the real execution of this method for the derived class + </summary> + </member> + <member name="M:Rhino.Mocks.MethodRecorders.MethodRecorderBase.DoGetAllExpectationsForProxy(System.Object)"> + <summary> + Handle the real execution of this method for the derived class + </summary> + </member> + <member name="M:Rhino.Mocks.MethodRecorders.MethodRecorderBase.DoReplaceExpectation(System.Object,System.Reflection.MethodInfo,Rhino.Mocks.Interfaces.IExpectation,Rhino.Mocks.Interfaces.IExpectation)"> + <summary> + Handle the real execution of this method for the derived class + </summary> + </member> + <member name="M:Rhino.Mocks.MethodRecorders.MethodRecorderBase.DoRemoveExpectation(Rhino.Mocks.Interfaces.IExpectation)"> + <summary> + Handle the real execution of this method for the derived class + </summary> + </member> + <member name="M:Rhino.Mocks.MethodRecorders.MethodRecorderBase.DoAddRecorder(Rhino.Mocks.Interfaces.IMethodRecorder)"> + <summary> + Handle the real execution of this method for the derived class + </summary> + </member> + <member name="M:Rhino.Mocks.MethodRecorders.MethodRecorderBase.ShouldConsiderThisReplayer(Rhino.Mocks.Interfaces.IMethodRecorder)"> + <summary> + Should this replayer be considered valid for this call? + </summary> + </member> + <member name="M:Rhino.Mocks.MethodRecorders.MethodRecorderBase.GetRepeatableExpectation(System.Object,System.Reflection.MethodInfo,System.Object[])"> + <summary> + This check the methods that were setup using the SetupResult.For() + or LastCall.Repeat.Any() and that bypass the whole expectation model. + </summary> + </member> + <member name="P:Rhino.Mocks.MethodRecorders.MethodRecorderBase.HasExpectations"> + <summary> + Gets a value indicating whether this instance has expectations that weren't satisfied yet. + </summary> + <value> + <c>true</c> if this instance has expectations; otherwise, <c>false</c>. + </value> + </member> + <member name="P:Rhino.Mocks.MethodRecorders.MethodRecorderBase.DoHasExpectations"> + <summary> + Handle the real execution of this method for the derived class + </summary> + </member> + <member name="T:Rhino.Mocks.MethodRecorders.OrderedMethodRecorder"> + <summary> + Ordered collection of methods, methods must arrive in specified order + in order to pass. + </summary> + </member> + <member name="T:Rhino.Mocks.MethodRecorders.UnorderedMethodRecorder"> + <summary> + Unordered collection of method records, any expectation that exist + will be matched. + </summary> + </member> + <member name="F:Rhino.Mocks.MethodRecorders.UnorderedMethodRecorder.parentRecorderRedirection"> + <summary> + The parent recorder we have redirected to. + Useful for certain edge cases in orderring. + See: FieldProblem_Entropy for the details. + </summary> + </member> + <member name="M:Rhino.Mocks.MethodRecorders.UnorderedMethodRecorder.#ctor(Rhino.Mocks.Interfaces.IMethodRecorder,Rhino.Mocks.Generated.ProxyMethodExpectationsDictionary)"> + <summary> + Creates a new <see cref="T:Rhino.Mocks.MethodRecorders.UnorderedMethodRecorder"/> instance. + </summary> + <param name="parentRecorder">Parent recorder.</param> + <param name="repeatableMethods">Repeatable methods</param> + </member> + <member name="M:Rhino.Mocks.MethodRecorders.UnorderedMethodRecorder.#ctor(Rhino.Mocks.Generated.ProxyMethodExpectationsDictionary)"> + <summary> + Creates a new <see cref="T:Rhino.Mocks.MethodRecorders.UnorderedMethodRecorder"/> instance. + </summary> + </member> + <member name="M:Rhino.Mocks.MethodRecorders.UnorderedMethodRecorder.DoRecord(System.Object,System.Reflection.MethodInfo,Rhino.Mocks.Interfaces.IExpectation)"> + <summary> + Records the specified call with the specified args on the mocked object. + </summary> + <param name="proxy">Mocked object.</param> + <param name="method">Method.</param> + <param name="expectation">Expectation.</param> + </member> + <member name="M:Rhino.Mocks.MethodRecorders.UnorderedMethodRecorder.DoGetRecordedExpectation(Castle.Core.Interceptor.IInvocation,System.Object,System.Reflection.MethodInfo,System.Object[])"> + <summary> + Get the expectation for this method on this object with this arguments + </summary> + <param name="invocation">Invocation for this method</param> + <param name="proxy">Mocked object.</param> + <param name="method">Method.</param> + <param name="args">Args.</param> + <returns>True is the call was recorded, false otherwise</returns> + </member> + <member name="M:Rhino.Mocks.MethodRecorders.UnorderedMethodRecorder.GetAllExpectationsForProxyAndMethod(System.Object,System.Reflection.MethodInfo)"> + <summary> + Gets the all expectations for a mocked object and method combination, + regardless of the expected arguments / callbacks / contraints. + </summary> + <param name="proxy">Mocked object.</param> + <param name="method">Method.</param> + <returns>List of all relevant expectation</returns> + </member> + <member name="M:Rhino.Mocks.MethodRecorders.UnorderedMethodRecorder.DoGetAllExpectationsForProxy(System.Object)"> + <summary> + Gets the all expectations for proxy. + </summary> + <param name="proxy">Mocked object.</param> + <returns>List of all relevant expectation</returns> + </member> + <member name="M:Rhino.Mocks.MethodRecorders.UnorderedMethodRecorder.DoReplaceExpectation(System.Object,System.Reflection.MethodInfo,Rhino.Mocks.Interfaces.IExpectation,Rhino.Mocks.Interfaces.IExpectation)"> + <summary> + Replaces the old expectation with the new expectation for the specified proxy/method pair. + This replace ALL expectations that equal to old expectations. + </summary> + <param name="proxy">Proxy.</param> + <param name="method">Method.</param> + <param name="oldExpectation">Old expectation.</param> + <param name="newExpectation">New expectation.</param> + </member> + <member name="M:Rhino.Mocks.MethodRecorders.UnorderedMethodRecorder.DoRemoveExpectation(Rhino.Mocks.Interfaces.IExpectation)"> + <summary> + Handle the real execution of this method for the derived class + </summary> + </member> + <member name="M:Rhino.Mocks.MethodRecorders.UnorderedMethodRecorder.DoGetRecordedExpectationOrNull(System.Object,System.Reflection.MethodInfo,System.Object[])"> + <summary> + Handles the real getting of the recorded expectation or null. + </summary> + </member> + <member name="M:Rhino.Mocks.MethodRecorders.UnorderedMethodRecorder.DoAddRecorder(Rhino.Mocks.Interfaces.IMethodRecorder)"> + <summary> + Handle the real execution of this method for the derived class + </summary> + </member> + <member name="M:Rhino.Mocks.MethodRecorders.UnorderedMethodRecorder.GetExpectedCallsMessage"> + <summary> + Gets the next expected calls string. + </summary> + </member> + <member name="M:Rhino.Mocks.MethodRecorders.UnorderedMethodRecorder.UnexpectedMethodCall(Castle.Core.Interceptor.IInvocation,System.Object,System.Reflection.MethodInfo,System.Object[])"> + <summary> + Create an exception for an unexpected method call. + </summary> + </member> + <member name="P:Rhino.Mocks.MethodRecorders.UnorderedMethodRecorder.DoHasExpectations"> + <summary> + Gets a value indicating whether this instance has expectations that weren't satisfied yet. + </summary> + <value> + <c>true</c> if this instance has expectations; otherwise, <c>false</c>. + </value> + </member> + <member name="M:Rhino.Mocks.MethodRecorders.OrderedMethodRecorder.#ctor(Rhino.Mocks.Interfaces.IMethodRecorder,Rhino.Mocks.Generated.ProxyMethodExpectationsDictionary)"> + <summary> + Creates a new <see cref="T:Rhino.Mocks.MethodRecorders.OrderedMethodRecorder"/> instance. + </summary> + <param name="parentRecorder">Parent recorder.</param> + <param name="repeatableMethods">Repetable methods</param> + </member> + <member name="M:Rhino.Mocks.MethodRecorders.OrderedMethodRecorder.#ctor(Rhino.Mocks.Generated.ProxyMethodExpectationsDictionary)"> + <summary> + Creates a new <see cref="T:Rhino.Mocks.MethodRecorders.OrderedMethodRecorder"/> instance. + </summary> + </member> + <member name="M:Rhino.Mocks.MethodRecorders.OrderedMethodRecorder.DoGetRecordedExpectationOrNull(System.Object,System.Reflection.MethodInfo,System.Object[])"> + <summary> + Handles the real getting of the recorded expectation or null. + </summary> + </member> + <member name="M:Rhino.Mocks.MethodRecorders.OrderedMethodRecorder.UnexpectedMethodCall(Castle.Core.Interceptor.IInvocation,System.Object,System.Reflection.MethodInfo,System.Object[])"> + <summary> + Get the expectation for this method on this object with this arguments + </summary> + </member> + <member name="M:Rhino.Mocks.MethodRecorders.OrderedMethodRecorder.GetExpectedCallsMessage"> + <summary> + Gets the next expected calls string. + </summary> + </member> + <member name="T:Rhino.Mocks.MethodRecorders.ProxyMethodExpectationTriplet"> + <summary> + Hold an expectation for a method call on an object + </summary> + </member> + <member name="M:Rhino.Mocks.MethodRecorders.ProxyMethodExpectationTriplet.#ctor(System.Object,System.Reflection.MethodInfo,Rhino.Mocks.Interfaces.IExpectation)"> + <summary> + Creates a new <see cref="T:Rhino.Mocks.MethodRecorders.ProxyMethodExpectationTriplet"/> instance. + </summary> + <param name="proxy">Proxy.</param> + <param name="method">Method.</param> + <param name="expectation">Expectation.</param> + </member> + <member name="M:Rhino.Mocks.MethodRecorders.ProxyMethodExpectationTriplet.Equals(System.Object)"> + <summary> + Determines if the object equal to this instance + </summary> + <param name="obj">Obj.</param> + <returns></returns> + </member> + <member name="M:Rhino.Mocks.MethodRecorders.ProxyMethodExpectationTriplet.GetHashCode"> + <summary> + Gets the hash code. + </summary> + <returns></returns> + </member> + <member name="P:Rhino.Mocks.MethodRecorders.ProxyMethodExpectationTriplet.Proxy"> + <summary> + Gets the proxy. + </summary> + <value></value> + </member> + <member name="P:Rhino.Mocks.MethodRecorders.ProxyMethodExpectationTriplet.Method"> + <summary> + Gets the method. + </summary> + <value></value> + </member> + <member name="P:Rhino.Mocks.MethodRecorders.ProxyMethodExpectationTriplet.Expectation"> + <summary> + Gets the expectation. + </summary> + <value></value> + </member> + <member name="T:Rhino.Mocks.MethodRecorders.ProxyMethodPair"> + <summary> + Holds a pair of mocked object and a method + and allows to compare them against each other. + This allows us to have a distinction between mockOne.MyMethod() and + mockTwo.MyMethod()... + </summary> + </member> + <member name="M:Rhino.Mocks.MethodRecorders.ProxyMethodPair.#ctor(System.Object,System.Reflection.MethodInfo)"> + <summary> + Creates a new <see cref="T:Rhino.Mocks.MethodRecorders.ProxyMethodPair"/> instance. + </summary> + <param name="proxy">Proxy.</param> + <param name="method">Method.</param> + </member> + <member name="M:Rhino.Mocks.MethodRecorders.ProxyMethodPair.Equals(System.Object)"> + <summary> + Determines whatever obj equals to this instance. + ProxyMethodPairs are equal when they point to the same /instance/ of + an object, and to the same method. + </summary> + <param name="obj">Obj.</param> + <returns></returns> + </member> + <member name="M:Rhino.Mocks.MethodRecorders.ProxyMethodPair.GetHashCode"> + <summary> + Gets the hash code. + </summary> + <returns></returns> + </member> + <member name="P:Rhino.Mocks.MethodRecorders.ProxyMethodPair.Proxy"> + <summary> + Gets the proxy. + </summary> + <value></value> + </member> + <member name="P:Rhino.Mocks.MethodRecorders.ProxyMethodPair.Method"> + <summary> + Gets the method. + </summary> + <value></value> + </member> + <member name="T:Rhino.Mocks.MethodRecorders.RecorderChanger"> + <summary> + Change the recorder from ordered to unordered and vice versa + </summary> + </member> + <member name="M:Rhino.Mocks.MethodRecorders.RecorderChanger.#ctor(Rhino.Mocks.MockRepository,Rhino.Mocks.Interfaces.IMethodRecorder,Rhino.Mocks.Interfaces.IMethodRecorder)"> + <summary> + Creates a new <see cref="T:Rhino.Mocks.MethodRecorders.RecorderChanger"/> instance. + </summary> + </member> + <member name="M:Rhino.Mocks.MethodRecorders.RecorderChanger.Dispose"> + <summary> + Disposes this instance. + </summary> + </member> + <member name="T:Rhino.Mocks.Mocker"> + <summary> + Accessor for the current mocker + </summary> + </member> + <member name="P:Rhino.Mocks.Mocker.Current"> + <summary> + The current mocker + </summary> + </member> + <member name="T:Rhino.Mocks.RhinoMocks"> + <summary> + Used for [assembly: InternalsVisibleTo(RhinoMocks.StrongName)] + Used for [assembly: InternalsVisibleTo(RhinoMocks.NormalName)] + </summary> + </member> + <member name="F:Rhino.Mocks.RhinoMocks.StrongName"> + <summary> + Strong name for the Dynamic Proxy assemblies. Used for InternalsVisibleTo specification. + </summary> + </member> + <member name="F:Rhino.Mocks.RhinoMocks.NormalName"> + <summary> + Normal name for dynamic proxy assemblies. Used for InternalsVisibleTo specification. + </summary> + </member> + <member name="F:Rhino.Mocks.RhinoMocks.Logger"> + <summary> + Logs all method calls for methods + </summary> + </member> + <member name="T:Rhino.Mocks.SetupResult"> + <summary> + Setup method calls to repeat any number of times. + </summary> + </member> + <member name="M:Rhino.Mocks.SetupResult.For``1(``0)"> + <summary> + Get the method options and set the last method call to repeat + any number of times. + This also means that the method would transcend ordering + </summary> + </member> + <member name="M:Rhino.Mocks.SetupResult.On(System.Object)"> + <summary> + Get the method options for the last method call on the mockInstance and set it + to repeat any number of times. + This also means that the method would transcend ordering + </summary> + </member> + <member name="T:Rhino.Mocks.Utilities.MethodCallUtil"> + <summary> + Utility class for working with method calls. + </summary> + </member> + <member name="M:Rhino.Mocks.Utilities.MethodCallUtil.StringPresentation(Castle.Core.Interceptor.IInvocation,Rhino.Mocks.Utilities.MethodCallUtil.FormatArgumnet,System.Reflection.MethodInfo,System.Object[])"> + <summary> + Return the string representation of a method call and its arguments. + </summary> + <param name="method">The method</param> + <param name="args">The method arguments</param> + <param name="invocation">Invocation of the method, used to get the generics arguments</param> + <param name="format">Delegate to format the parameter</param> + <returns>The string representation of this method call</returns> + </member> + <member name="M:Rhino.Mocks.Utilities.MethodCallUtil.StringPresentation(Castle.Core.Interceptor.IInvocation,System.Reflection.MethodInfo,System.Object[])"> + <summary> + Return the string representation of a method call and its arguments. + </summary> + <param name="invocation">The invocation of the method, used to get the generic parameters</param> + <param name="method">The method</param> + <param name="args">The method arguments</param> + <returns>The string representation of this method call</returns> + </member> + <member name="T:Rhino.Mocks.Utilities.MethodCallUtil.FormatArgumnet"> + <summary> + Delegate to format the argument for the string representation of + the method call. + </summary> + </member> + <member name="T:Rhino.Mocks.Utilities.ReturnValueUtil"> + <summary> + Utility to get the default value for a type + </summary> + </member> + <member name="M:Rhino.Mocks.Utilities.ReturnValueUtil.DefaultValue(System.Type,Castle.Core.Interceptor.IInvocation)"> + <summary> + The default value for a type. + Null for reference types and void + 0 for value types. + First element for enums + Note that we need to get the value even for opened generic types, such as those from + generic methods. + </summary> + <param name="type">Type.</param> + <param name="invocation">The invocation.</param> + <returns>the default value</returns> + </member> + <member name="T:Rhino.Mocks.With"> + <summary> + Allows easier access to MockRepository, works closely with Mocker.Current to + allow access to a context where the mock repository is automatially verified at + the end of the code block. + </summary> + </member> + <member name="M:Rhino.Mocks.With.Mocks(Rhino.Mocks.With.Proc)"> + <summary> + Initialize a code block where Mocker.Current is initialized. + At the end of the code block, all the expectation will be verified. + This overload will create a new MockRepository. + </summary> + <param name="methodCallThatHasMocks">The code that will be executed under the mock context</param> + </member> + <member name="M:Rhino.Mocks.With.Mocks(Rhino.Mocks.MockRepository,Rhino.Mocks.With.Proc)"> + <summary> + Initialize a code block where Mocker.Current is initialized. + At the end of the code block, all the expectation will be verified. + This overload will create a new MockRepository. + </summary> + <param name="mocks">The mock repository to use, at the end of the code block, VerifyAll() will be called on the repository.</param> + <param name="methodCallThatHasMocks">The code that will be executed under the mock context</param> + </member> + <member name="M:Rhino.Mocks.With.Mocks(Rhino.Mocks.MockRepository)"> + <summary> + Create a FluentMocker + </summary> + <param name="mocks">The mock repository to use.</param> + </member> + <member name="T:Rhino.Mocks.With.Proc"> + <summary> + A method with no arguments and no return value that will be called under the mock context. + </summary> + </member> + <member name="T:Rhino.Mocks.With.FluentMocker"> + <summary> + FluentMocker implements some kind of fluent interface attempt + for saying "With the Mocks [mocks], Expecting (in same order) [things] verify [that]." + </summary> + </member> + <member name="T:Rhino.Mocks.With.IMockVerifier"> + <summary> + Interface to verify previously defined expectations + </summary> + </member> + <member name="M:Rhino.Mocks.With.IMockVerifier.Verify(Rhino.Mocks.With.Proc)"> + <summary> + Verifies if a piece of code + </summary> + </member> + <member name="M:Rhino.Mocks.With.FluentMocker.Expecting(Rhino.Mocks.With.Proc)"> + <summary> + Defines unordered expectations + </summary> + <param name="methodCallsDescribingExpectations">A delegate describing the expectations</param> + <returns>an IMockVerifier</returns> + </member> + <member name="M:Rhino.Mocks.With.FluentMocker.ExpectingInSameOrder(Rhino.Mocks.With.Proc)"> + <summary> + Defines ordered expectations + </summary> + <param name="methodCallsDescribingExpectations">A delegate describing the expectations</param> + <returns>an IMockVerifier</returns> + </member> + <member name="M:Rhino.Mocks.With.FluentMocker.Verify(Rhino.Mocks.With.Proc)"> + <summary> + Verifies previously defined expectations + </summary> + </member> + <member name="T:Rhino.Mocks.Function`2"> + <summary> + This delegate is compatible with the System.Func{T,R} signature + We have to define our own to get compatability with 2.0 + </summary> + </member> + <member name="T:__ProtectAttribute"> + <summary> + This attribute is here so we can get better Pex integration + Using this means that Pex will not try to inspect the work of + the actual proxies being generated by Rhino Mocks + </summary> + </member> + </members> +</doc> Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.Dam.IntegrationTests.pdb =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.Standard.TestUtils.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.Geometry.Forms.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/it-IT/DotSpatial.Controls.resources.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/TmpImportFiles/locations.csv =================================================================== diff -u --- DamClients/DamUI/trunk/release/Install_Version/TmpImportFiles/locations.csv (revision 0) +++ DamClients/DamUI/trunk/release/Install_Version/TmpImportFiles/locations.csv (revision 2315) @@ -0,0 +1,3 @@ +location_id;surfaceline_id;segment_id;geo_x;geo_y;x_soilgeometry2D_origin;Pl1_id;polderlevel;polderlevellow;head_pl2;head_pl3;head_pl4;Grass_quality;Direction;Ophoogmateriaaldijk;Ophoogmateriaalberm;Sheetpile_x;Sheetpile_y;Sheetpile_z;Sheetpile_length;use_original_plline_assignments;PenetrationLength;TrafficLoad;minimal_circle_depth;dempingsfactor_pl3;dempingsfactor_pl4;PLLineCreationMethod;level_reduction_inside;level_reduction_outside;layer_height_distribution;layer_height_deviation;safety_factor_piping;safety_factor_stability_inner_slope;safety_factor_stability_outer_slope;probability_of_failure_stability_innerslope;probability_of_failure_stability_outerslope;probability_of_failure_piping;uplift_criterion_piping;uplift_criterion_stability;Materiaaltypedijk;bp_tp;bp_hbp;bp_lbp;Baggerdiepte;distance_to_entry_point;PLLineOffsetBelowDikeTopAtRiver;PLLineOffsetBelowDikeTopAtPolder;PLLineOffsetBelowShoulderBaseInside;PLLineOffsetBelowDikeToeAtPolder;PLLineOffsetDryBelowDikeTopAtRiver;PLLineOffsetDryBelowDikeTopAtPolder;PLLineOffsetDryBelowShoulderBaseInside;PLLineOffsetDryBelowDikeToeAtPolder;StabilityShoulderGrowSlope;StabilityShoulderGrowDeltaX;StabilitySlopeAdaptionDeltaX;detrimentfactor;DikeTableHeight;SlopeDampingPiezometricHeightPolderSide;StabilityDesignMethod;SlopeAdaptionStartCotangent;SlopeAdaptionEndCotangent;SlopeAdaptionStepCotangent; UseNewDikeTopWidth; NewDikeTopWidth;UseNewDikeSlopeInside;NewDikeSlopeInside;UseNewDikeSlopeOutside;NewDikeSlopeOutside;UseNewShoulderTopSlope;NewShoulderTopSlope;UseNewShoulderBaseSlope;NewShoulderBaseSlope;UseNewMaxHeightShoulderAsFraction;NewMaxHeightShoulderAsFraction;UseNewMinDistanceDikeToeStartDitch;NewMinDistanceDikeToeStartDitch;UseNewDitchDefinition;NewWidthDitchBottom;newSlopeAngleDitch;NewDepthDitch;ZoneType;ForbiddenZoneFactor;ZoneAreaRestSlopeCrestWidth;PLLineOffsetBelowDikeCrestMiddle;PLLineOffsetFactorBelowShoulderCrest;UsePLLineOffsetDryBelowDikeCrestMiddle;PLLineOffsetDryBelowDikeCrestMiddle;UsePLLineOffsetDryFactorBelowShoulderCrest;PLLineOffsetDryFactorBelowShoulderCrest;IntrusionVerticalWaterPressure;TL_DegreeOfConsolidation +16-1-1-C-3-Z;16-1-1-C-3-Z;1043;124330;441312;1;16-1-1-C-3-Z;0.9;0.2;13.056;0.9;0.8;1;1;klei;klei2;1;2;3;12;TRUE;1.3;10;1.5;30;40;ExpertKnowledgeRRD;1;2;Uniform;0.1;1.2;1.3;1.4;0.01;0.02;0.03;1.1;1.2;klei;1.0;1.1;1.2;2.0;2.1;0.5;0.6;0.1;0.2;0.6;1.6;0.2;0.3;2.0;0.2;0.5;0.9;3.5;0.01;OptimizedSlopeAndShoulderAdaption;3.0;6.0;0.5;TRUE;1.8;TRUE;1.9;TRUE;2.9;TRUE;2.8;TRUE;2.7;TRUE;0.6;TRUE;2.6;TRUE;1.1;1.2;1.3;ZoneAreas;0.5;1.6;1.0;0.1;TRUE;1.1;FALSE;0.11;Standard;10.1 +25-2-2-A-1-A;25-2-2-A-1-A;106;66586;424173;2;25-2-2-A-1-A;-0.25;-0.25;0.8727;-0.25;-0.25;1;1;klei;klei2;1;2;3;12;FALSE;1.3;10;1.5;30;40;ExpertKnowledgeRRD;1;2;Uniform;0.1;1.2;1.3;1.4;0.01;0.02;0.03;1.1;1.2;klei;1.0;1.1;1.2;2.0;2.1;0.5;0.6;0.1;0.2;0.6;1.6;0.2;0.3;2.0;0.2;0.5;0.9;3.5;0.2;SlopeAdaptionBeforeShoulderAdaption;4.5;6.5;0.25;FALSE;0.8;FALSE;0.9;FALSE;1.9;FALSE;1.8;FALSE;1.7;FALSE;0.7;FALSE;1.6;FALSE;1.4;1.5;1.6;ForbiddenZone;0.9;2.1; 1.1;0.11;FALSE; 1.0;TRUE;0.1;SemiTimeDependent;55.5 Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.Dam.Application.exe =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/DotSpatial.Topology.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.DamEngine.Interface.pdb =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.Dam.TestHelper.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/NetTopologySuite.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/ja-JP/DotSpatial.Projections.Forms.resources.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/Rhino.Mocks.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/PowerCollections.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/it/DotSpatial.Symbology.Forms.resources.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/el/DotSpatial.Projections.Forms.resources.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/FirebirdSql.Data.FirebirdClient.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/TmpImportFiles/characteristicpoints.csv =================================================================== diff -u --- DamClients/DamUI/trunk/release/Install_Version/TmpImportFiles/characteristicpoints.csv (revision 0) +++ DamClients/DamUI/trunk/release/Install_Version/TmpImportFiles/characteristicpoints.csv (revision 2315) @@ -0,0 +1,2 @@ +LocationId;X_Maaiveld binnenwaarts;Y_Maaiveld binnenwaarts;Z_Maaiveld binnenwaarts;X_Insteek sloot polderzijde;Y_Insteek sloot polderzijde;Z_Insteek sloot polderzijde;X_Slootbodem polderzijde;Y_Slootbodem polderzijde;Z_Slootbodem polderzijde;X_Slootbodem dijkzijde;Y_Slootbodem dijkzijde;Z_Slootbodem dijkzijde;X_Insteek sloot dijkzijde;Y_Insteek sloot dijkzijde;Z_Insteek sloot dijkzijde;X_Teen dijk binnenwaarts;Y_Teen dijk binnenwaarts;Z_Teen dijk binnenwaarts;X_Kruin binnenberm;Y_Kruin binnenberm;Z_Kruin binnenberm;X_Insteek binnenberm;Y_Insteek binnenberm;Z_Insteek binnenberm;X_Kruin binnentalud;Y_Kruin binnentalud;Z_Kruin binnentalud;X_Verkeersbelasting kant binnenwaarts;Y_Verkeersbelasting kant binnenwaarts;Z_Verkeersbelasting kant binnenwaarts;X_Verkeersbelasting kant buitenwaarts;Y_Verkeersbelasting kant buitenwaarts;Z_Verkeersbelasting kant buitenwaarts;X_Kruin buitentalud;Y_Kruin buitentalud;Z_Kruin buitentalud;X_Insteek buitenberm;Y_Insteek buitenberm;Z_Insteek buitenberm;X_Kruin buitenberm;Y_Kruin buitenberm;Z_Kruin buitenberm;X_Teen dijk buitenwaarts;Y_Teen dijk buitenwaarts;Z_Teen dijk buitenwaarts;X_Maaiveld buitenwaarts;Y_Maaiveld buitenwaarts;Z_Maaiveld buitenwaarts;X_Dijktafelhoogte;Y_Dijktafelhoogte;Z_Dijktafelhoogte;Volgnummer +D1;117.94;0;0.12;-1;-1;-1;73.99;0;-1.0;72.55;0;-1.46;67.9;0;1.07;63.31;0;1.36;-1;-1;-1;-1;-1;-1;55.17;0;4.46;54.25;0;4.69;51.75;0;4.662;50.11;0;4.46;40.48;0;1.94;32.21;0;1.67;31.6;0;1.3;0;0;0.68;52.63;0;4.77;1 Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.Maps.pdb =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/lt/DotSpatial.Projections.Forms.resources.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/DevExpress.XtraRichEdit.v12.2.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/KellermanSoftware.Compare-NET-Objects.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.WTIPiping.Merged.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/DevExpress.XtraTreeList.v12.2.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/DGeoStability.exe =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/DotSpatial.Mono.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/log4net.xml =================================================================== diff -u --- DamClients/DamUI/trunk/release/Install_Version/log4net.xml (revision 0) +++ DamClients/DamUI/trunk/release/Install_Version/log4net.xml (revision 2315) @@ -0,0 +1,31814 @@ +<?xml version="1.0"?> +<doc> + <assembly> + <name>log4net</name> + </assembly> + <members> + <member name="T:log4net.Appender.AdoNetAppender"> + <summary> + Appender that logs to a database. + </summary> + <remarks> + <para> + <see cref="T:log4net.Appender.AdoNetAppender"/> appends logging events to a table within a + database. The appender can be configured to specify the connection + string by setting the <see cref="P:log4net.Appender.AdoNetAppender.ConnectionString"/> property. + The connection type (provider) can be specified by setting the <see cref="P:log4net.Appender.AdoNetAppender.ConnectionType"/> + property. For more information on database connection strings for + your specific database see <a href="http://www.connectionstrings.com/">http://www.connectionstrings.com/</a>. + </para> + <para> + Records are written into the database either using a prepared + statement or a stored procedure. The <see cref="P:log4net.Appender.AdoNetAppender.CommandType"/> property + is set to <see cref="F:System.Data.CommandType.Text"/> (<c>System.Data.CommandType.Text</c>) to specify a prepared statement + or to <see cref="F:System.Data.CommandType.StoredProcedure"/> (<c>System.Data.CommandType.StoredProcedure</c>) to specify a stored + procedure. + </para> + <para> + The prepared statement text or the name of the stored procedure + must be set in the <see cref="P:log4net.Appender.AdoNetAppender.CommandText"/> property. + </para> + <para> + The prepared statement or stored procedure can take a number + of parameters. Parameters are added using the <see cref="M:log4net.Appender.AdoNetAppender.AddParameter(log4net.Appender.AdoNetAppenderParameter)"/> + method. This adds a single <see cref="T:log4net.Appender.AdoNetAppenderParameter"/> to the + ordered list of parameters. The <see cref="T:log4net.Appender.AdoNetAppenderParameter"/> + type may be subclassed if required to provide database specific + functionality. The <see cref="T:log4net.Appender.AdoNetAppenderParameter"/> specifies + the parameter name, database type, size, and how the value should + be generated using a <see cref="T:log4net.Layout.ILayout"/>. + </para> + </remarks> + <example> + An example of a SQL Server table that could be logged to: + <code lang="SQL"> + CREATE TABLE [dbo].[Log] ( + [ID] [int] IDENTITY (1, 1) NOT NULL , + [Date] [datetime] NOT NULL , + [Thread] [varchar] (255) NOT NULL , + [Level] [varchar] (20) NOT NULL , + [Logger] [varchar] (255) NOT NULL , + [Message] [varchar] (4000) NOT NULL + ) ON [PRIMARY] + </code> + </example> + <example> + An example configuration to log to the above table: + <code lang="XML" escaped="true"> + <appender name="AdoNetAppender_SqlServer" type="log4net.Appender.AdoNetAppender"> + <connectionType value="System.Data.SqlClient.SqlConnection, System.Data, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089"/> + <connectionString value="data source=SQLSVR;initial catalog=test_log4net;integrated security=false;persist security info=True;User ID=sa;Password=sa"/> + <commandText value="INSERT INTO Log ([Date],[Thread],[Level],[Logger],[Message]) VALUES (@log_date, @thread, @log_level, @logger, @message)"/> + <parameter> + <parameterName value="@log_date"/> + <dbType value="DateTime"/> + <layout type="log4net.Layout.PatternLayout" value="%date{yyyy'-'MM'-'dd HH':'mm':'ss'.'fff}"/> + </parameter> + <parameter> + <parameterName value="@thread"/> + <dbType value="String"/> + <size value="255"/> + <layout type="log4net.Layout.PatternLayout" value="%thread"/> + </parameter> + <parameter> + <parameterName value="@log_level"/> + <dbType value="String"/> + <size value="50"/> + <layout type="log4net.Layout.PatternLayout" value="%level"/> + </parameter> + <parameter> + <parameterName value="@logger"/> + <dbType value="String"/> + <size value="255"/> + <layout type="log4net.Layout.PatternLayout" value="%logger"/> + </parameter> + <parameter> + <parameterName value="@message"/> + <dbType value="String"/> + <size value="4000"/> + <layout type="log4net.Layout.PatternLayout" value="%message"/> + </parameter> + </appender> + </code> + </example> + <author>Julian Biddle</author> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + <author>Lance Nehring</author> + </member> + <member name="T:log4net.Appender.BufferingAppenderSkeleton"> + <summary> + Abstract base class implementation of <see cref="T:log4net.Appender.IAppender"/> that + buffers events in a fixed size buffer. + </summary> + <remarks> + <para> + This base class should be used by appenders that need to buffer a + number of events before logging them. For example the <see cref="T:log4net.Appender.AdoNetAppender"/> + buffers events and then submits the entire contents of the buffer to + the underlying database in one go. + </para> + <para> + Subclasses should override the <see cref="M:SendBuffer(LoggingEvent[])"/> + method to deliver the buffered events. + </para> + <para>The BufferingAppenderSkeleton maintains a fixed size cyclic + buffer of events. The size of the buffer is set using + the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> property. + </para> + <para>A <see cref="T:log4net.Core.ITriggeringEventEvaluator"/> is used to inspect + each event as it arrives in the appender. If the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> + triggers, then the current buffer is sent immediately + (see <see cref="M:SendBuffer(LoggingEvent[])"/>). Otherwise the event + is stored in the buffer. For example, an evaluator can be used to + deliver the events immediately when an ERROR event arrives. + </para> + <para> + The buffering appender can be configured in a <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> mode. + By default the appender is NOT lossy. When the buffer is full all + the buffered events are sent with <see cref="M:SendBuffer(LoggingEvent[])"/>. + If the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> property is set to <c>true</c> then the + buffer will not be sent when it is full, and new events arriving + in the appender will overwrite the oldest event in the buffer. + In lossy mode the buffer will only be sent when the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> + triggers. This can be useful behavior when you need to know about + ERROR events but not about events with a lower level, configure an + evaluator that will trigger when an ERROR event arrives, the whole + buffer will be sent which gives a history of events leading up to + the ERROR event. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="T:log4net.Appender.AppenderSkeleton"> + <summary> + Abstract base class implementation of <see cref="T:log4net.Appender.IAppender"/>. + </summary> + <remarks> + <para> + This class provides the code for common functionality, such + as support for threshold filtering and support for general filters. + </para> + <para> + Appenders can also implement the <see cref="T:log4net.Core.IOptionHandler"/> interface. Therefore + they would require that the <see cref="M:IOptionHandler.ActivateOptions()"/> method + be called after the appenders properties have been configured. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="T:log4net.Appender.IAppender"> + <summary> + Implement this interface for your own strategies for printing log statements. + </summary> + <remarks> + <para> + Implementors should consider extending the <see cref="T:log4net.Appender.AppenderSkeleton"/> + class which provides a default implementation of this interface. + </para> + <para> + Appenders can also implement the <see cref="T:log4net.Core.IOptionHandler"/> interface. Therefore + they would require that the <see cref="M:IOptionHandler.ActivateOptions()"/> method + be called after the appenders properties have been configured. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Appender.IAppender.Close"> + <summary> + Closes the appender and releases resources. + </summary> + <remarks> + <para> + Releases any resources allocated within the appender such as file handles, + network connections, etc. + </para> + <para> + It is a programming error to append to a closed appender. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.IAppender.DoAppend(log4net.Core.LoggingEvent)"> + <summary> + Log the logging event in Appender specific way. + </summary> + <param name="loggingEvent">The event to log</param> + <remarks> + <para> + This method is called to log a message into this appender. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.IAppender.Name"> + <summary> + Gets or sets the name of this appender. + </summary> + <value>The name of the appender.</value> + <remarks> + <para>The name uniquely identifies the appender.</para> + </remarks> + </member> + <member name="T:log4net.Appender.IBulkAppender"> + <summary> + Interface for appenders that support bulk logging. + </summary> + <remarks> + <para> + This interface extends the <see cref="T:log4net.Appender.IAppender"/> interface to + support bulk logging of <see cref="T:log4net.Core.LoggingEvent"/> objects. Appenders + should only implement this interface if they can bulk log efficiently. + </para> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="M:log4net.Appender.IBulkAppender.DoAppend(log4net.Core.LoggingEvent[])"> + <summary> + Log the array of logging events in Appender specific way. + </summary> + <param name="loggingEvents">The events to log</param> + <remarks> + <para> + This method is called to log an array of events into this appender. + </para> + </remarks> + </member> + <member name="T:log4net.Core.IOptionHandler"> + <summary> + Interface used to delay activate a configured object. + </summary> + <remarks> + <para> + This allows an object to defer activation of its options until all + options have been set. This is required for components which have + related options that remain ambiguous until all are set. + </para> + <para> + If a component implements this interface then the <see cref="M:log4net.Core.IOptionHandler.ActivateOptions"/> method + must be called by the container after its all the configured properties have been set + and before the component can be used. + </para> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="M:log4net.Core.IOptionHandler.ActivateOptions"> + <summary> + Activate the options that were previously set with calls to properties. + </summary> + <remarks> + <para> + This allows an object to defer activation of its options until all + options have been set. This is required for components which have + related options that remain ambiguous until all are set. + </para> + <para> + If a component implements this interface then this method must be called + after its properties have been set before the component can be used. + </para> + </remarks> + </member> + <member name="F:log4net.Appender.AppenderSkeleton.c_renderBufferSize"> + <summary> + Initial buffer size + </summary> + </member> + <member name="F:log4net.Appender.AppenderSkeleton.c_renderBufferMaxCapacity"> + <summary> + Maximum buffer size before it is recycled + </summary> + </member> + <member name="M:log4net.Appender.AppenderSkeleton.#ctor"> + <summary> + Default constructor + </summary> + <remarks> + <para>Empty default constructor</para> + </remarks> + </member> + <member name="M:log4net.Appender.AppenderSkeleton.Finalize"> + <summary> + Finalizes this appender by calling the implementation's + <see cref="M:log4net.Appender.AppenderSkeleton.Close"/> method. + </summary> + <remarks> + <para> + If this appender has not been closed then the <c>Finalize</c> method + will call <see cref="M:log4net.Appender.AppenderSkeleton.Close"/>. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.AppenderSkeleton.ActivateOptions"> + <summary> + Initialize the appender based on the options set + </summary> + <remarks> + <para> + This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object + activation scheme. The <see cref="M:log4net.Appender.AppenderSkeleton.ActivateOptions"/> method must + be called on this object after the configuration properties have + been set. Until <see cref="M:log4net.Appender.AppenderSkeleton.ActivateOptions"/> is called this + object is in an undefined state and must not be used. + </para> + <para> + If any of the configuration properties are modified then + <see cref="M:log4net.Appender.AppenderSkeleton.ActivateOptions"/> must be called again. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.AppenderSkeleton.Close"> + <summary> + Closes the appender and release resources. + </summary> + <remarks> + <para> + Release any resources allocated within the appender such as file handles, + network connections, etc. + </para> + <para> + It is a programming error to append to a closed appender. + </para> + <para> + This method cannot be overridden by subclasses. This method + delegates the closing of the appender to the <see cref="M:log4net.Appender.AppenderSkeleton.OnClose"/> + method which must be overridden in the subclass. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent)"> + <summary> + Performs threshold checks and invokes filters before + delegating actual logging to the subclasses specific + <see cref="M:Append(LoggingEvent)"/> method. + </summary> + <param name="loggingEvent">The event to log.</param> + <remarks> + <para> + This method cannot be overridden by derived classes. A + derived class should override the <see cref="M:Append(LoggingEvent)"/> method + which is called by this method. + </para> + <para> + The implementation of this method is as follows: + </para> + <para> + <list type="bullet"> + <item> + <description> + Checks that the severity of the <paramref name="loggingEvent"/> + is greater than or equal to the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> of this + appender.</description> + </item> + <item> + <description> + Checks that the <see cref="T:log4net.Filter.IFilter"/> chain accepts the + <paramref name="loggingEvent"/>. + </description> + </item> + <item> + <description> + Calls <see cref="M:PreAppendCheck()"/> and checks that + it returns <c>true</c>.</description> + </item> + </list> + </para> + <para> + If all of the above steps succeed then the <paramref name="loggingEvent"/> + will be passed to the abstract <see cref="M:Append(LoggingEvent)"/> method. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent[])"> + <summary> + Performs threshold checks and invokes filters before + delegating actual logging to the subclasses specific + <see cref="M:Append(LoggingEvent[])"/> method. + </summary> + <param name="loggingEvents">The array of events to log.</param> + <remarks> + <para> + This method cannot be overridden by derived classes. A + derived class should override the <see cref="M:Append(LoggingEvent[])"/> method + which is called by this method. + </para> + <para> + The implementation of this method is as follows: + </para> + <para> + <list type="bullet"> + <item> + <description> + Checks that the severity of the <paramref name="loggingEvents"/> + is greater than or equal to the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> of this + appender.</description> + </item> + <item> + <description> + Checks that the <see cref="T:log4net.Filter.IFilter"/> chain accepts the + <paramref name="loggingEvents"/>. + </description> + </item> + <item> + <description> + Calls <see cref="M:PreAppendCheck()"/> and checks that + it returns <c>true</c>.</description> + </item> + </list> + </para> + <para> + If all of the above steps succeed then the <paramref name="loggingEvents"/> + will be passed to the <see cref="M:Append(LoggingEvent[])"/> method. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.AppenderSkeleton.FilterEvent(log4net.Core.LoggingEvent)"> + <summary> + Test if the logging event should we output by this appender + </summary> + <param name="loggingEvent">the event to test</param> + <returns><c>true</c> if the event should be output, <c>false</c> if the event should be ignored</returns> + <remarks> + <para> + This method checks the logging event against the threshold level set + on this appender and also against the filters specified on this + appender. + </para> + <para> + The implementation of this method is as follows: + </para> + <para> + <list type="bullet"> + <item> + <description> + Checks that the severity of the <paramref name="loggingEvent"/> + is greater than or equal to the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> of this + appender.</description> + </item> + <item> + <description> + Checks that the <see cref="T:log4net.Filter.IFilter"/> chain accepts the + <paramref name="loggingEvent"/>. + </description> + </item> + </list> + </para> + </remarks> + </member> + <member name="M:log4net.Appender.AppenderSkeleton.AddFilter(log4net.Filter.IFilter)"> + <summary> + Adds a filter to the end of the filter chain. + </summary> + <param name="filter">the filter to add to this appender</param> + <remarks> + <para> + The Filters are organized in a linked list. + </para> + <para> + Setting this property causes the new filter to be pushed onto the + back of the filter chain. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.AppenderSkeleton.ClearFilters"> + <summary> + Clears the filter list for this appender. + </summary> + <remarks> + <para> + Clears the filter list for this appender. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.AppenderSkeleton.IsAsSevereAsThreshold(log4net.Core.Level)"> + <summary> + Checks if the message level is below this appender's threshold. + </summary> + <param name="level"><see cref="T:log4net.Core.Level"/> to test against.</param> + <remarks> + <para> + If there is no threshold set, then the return value is always <c>true</c>. + </para> + </remarks> + <returns> + <c>true</c> if the <paramref name="level"/> meets the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> + requirements of this appender. + </returns> + </member> + <member name="M:log4net.Appender.AppenderSkeleton.OnClose"> + <summary> + Is called when the appender is closed. Derived classes should override + this method if resources need to be released. + </summary> + <remarks> + <para> + Releases any resources allocated within the appender such as file handles, + network connections, etc. + </para> + <para> + It is a programming error to append to a closed appender. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.AppenderSkeleton.Append(log4net.Core.LoggingEvent)"> + <summary> + Subclasses of <see cref="T:log4net.Appender.AppenderSkeleton"/> should implement this method + to perform actual logging. + </summary> + <param name="loggingEvent">The event to append.</param> + <remarks> + <para> + A subclass must implement this method to perform + logging of the <paramref name="loggingEvent"/>. + </para> + <para>This method will be called by <see cref="M:DoAppend(LoggingEvent)"/> + if all the conditions listed for that method are met. + </para> + <para> + To restrict the logging of events in the appender + override the <see cref="M:PreAppendCheck()"/> method. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.AppenderSkeleton.Append(log4net.Core.LoggingEvent[])"> + <summary> + Append a bulk array of logging events. + </summary> + <param name="loggingEvents">the array of logging events</param> + <remarks> + <para> + This base class implementation calls the <see cref="M:Append(LoggingEvent)"/> + method for each element in the bulk array. + </para> + <para> + A sub class that can better process a bulk array of events should + override this method in addition to <see cref="M:Append(LoggingEvent)"/>. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.AppenderSkeleton.PreAppendCheck"> + <summary> + Called before <see cref="M:Append(LoggingEvent)"/> as a precondition. + </summary> + <remarks> + <para> + This method is called by <see cref="M:DoAppend(LoggingEvent)"/> + before the call to the abstract <see cref="M:Append(LoggingEvent)"/> method. + </para> + <para> + This method can be overridden in a subclass to extend the checks + made before the event is passed to the <see cref="M:Append(LoggingEvent)"/> method. + </para> + <para> + A subclass should ensure that they delegate this call to + this base class if it is overridden. + </para> + </remarks> + <returns><c>true</c> if the call to <see cref="M:Append(LoggingEvent)"/> should proceed.</returns> + </member> + <member name="M:log4net.Appender.AppenderSkeleton.RenderLoggingEvent(log4net.Core.LoggingEvent)"> + <summary> + Renders the <see cref="T:log4net.Core.LoggingEvent"/> to a string. + </summary> + <param name="loggingEvent">The event to render.</param> + <returns>The event rendered as a string.</returns> + <remarks> + <para> + Helper method to render a <see cref="T:log4net.Core.LoggingEvent"/> to + a string. This appender must have a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/> + set to render the <paramref name="loggingEvent"/> to + a string. + </para> + <para>If there is exception data in the logging event and + the layout does not process the exception, this method + will append the exception text to the rendered string. + </para> + <para> + Where possible use the alternative version of this method + <see cref="M:RenderLoggingEvent(TextWriter,LoggingEvent)"/>. + That method streams the rendering onto an existing Writer + which can give better performance if the caller already has + a <see cref="T:System.IO.TextWriter"/> open and ready for writing. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.AppenderSkeleton.RenderLoggingEvent(System.IO.TextWriter,log4net.Core.LoggingEvent)"> + <summary> + Renders the <see cref="T:log4net.Core.LoggingEvent"/> to a string. + </summary> + <param name="loggingEvent">The event to render.</param> + <param name="writer">The TextWriter to write the formatted event to</param> + <remarks> + <para> + Helper method to render a <see cref="T:log4net.Core.LoggingEvent"/> to + a string. This appender must have a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/> + set to render the <paramref name="loggingEvent"/> to + a string. + </para> + <para>If there is exception data in the logging event and + the layout does not process the exception, this method + will append the exception text to the rendered string. + </para> + <para> + Use this method in preference to <see cref="M:RenderLoggingEvent(LoggingEvent)"/> + where possible. If, however, the caller needs to render the event + to a string then <see cref="M:RenderLoggingEvent(LoggingEvent)"/> does + provide an efficient mechanism for doing so. + </para> + </remarks> + </member> + <member name="F:log4net.Appender.AppenderSkeleton.m_layout"> + <summary> + The layout of this appender. + </summary> + <remarks> + See <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/> for more information. + </remarks> + </member> + <member name="F:log4net.Appender.AppenderSkeleton.m_name"> + <summary> + The name of this appender. + </summary> + <remarks> + See <see cref="P:log4net.Appender.AppenderSkeleton.Name"/> for more information. + </remarks> + </member> + <member name="F:log4net.Appender.AppenderSkeleton.m_threshold"> + <summary> + The level threshold of this appender. + </summary> + <remarks> + <para> + There is no level threshold filtering by default. + </para> + <para> + See <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> for more information. + </para> + </remarks> + </member> + <member name="F:log4net.Appender.AppenderSkeleton.m_errorHandler"> + <summary> + It is assumed and enforced that errorHandler is never null. + </summary> + <remarks> + <para> + It is assumed and enforced that errorHandler is never null. + </para> + <para> + See <see cref="P:log4net.Appender.AppenderSkeleton.ErrorHandler"/> for more information. + </para> + </remarks> + </member> + <member name="F:log4net.Appender.AppenderSkeleton.m_headFilter"> + <summary> + The first filter in the filter chain. + </summary> + <remarks> + <para> + Set to <c>null</c> initially. + </para> + <para> + See <see cref="T:log4net.Filter.IFilter"/> for more information. + </para> + </remarks> + </member> + <member name="F:log4net.Appender.AppenderSkeleton.m_tailFilter"> + <summary> + The last filter in the filter chain. + </summary> + <remarks> + See <see cref="T:log4net.Filter.IFilter"/> for more information. + </remarks> + </member> + <member name="F:log4net.Appender.AppenderSkeleton.m_closed"> + <summary> + Flag indicating if this appender is closed. + </summary> + <remarks> + See <see cref="M:log4net.Appender.AppenderSkeleton.Close"/> for more information. + </remarks> + </member> + <member name="F:log4net.Appender.AppenderSkeleton.m_recursiveGuard"> + <summary> + The guard prevents an appender from repeatedly calling its own DoAppend method + </summary> + </member> + <member name="F:log4net.Appender.AppenderSkeleton.m_renderWriter"> + <summary> + StringWriter used to render events + </summary> + </member> + <member name="F:log4net.Appender.AppenderSkeleton.declaringType"> + <summary> + The fully qualified type of the AppenderSkeleton class. + </summary> + <remarks> + Used by the internal logger to record the Type of the + log message. + </remarks> + </member> + <member name="P:log4net.Appender.AppenderSkeleton.Threshold"> + <summary> + Gets or sets the threshold <see cref="T:log4net.Core.Level"/> of this appender. + </summary> + <value> + The threshold <see cref="T:log4net.Core.Level"/> of the appender. + </value> + <remarks> + <para> + All log events with lower level than the threshold level are ignored + by the appender. + </para> + <para> + In configuration files this option is specified by setting the + value of the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> option to a level + string, such as "DEBUG", "INFO" and so on. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.AppenderSkeleton.ErrorHandler"> + <summary> + Gets or sets the <see cref="T:log4net.Core.IErrorHandler"/> for this appender. + </summary> + <value>The <see cref="T:log4net.Core.IErrorHandler"/> of the appender</value> + <remarks> + <para> + The <see cref="T:log4net.Appender.AppenderSkeleton"/> provides a default + implementation for the <see cref="P:log4net.Appender.AppenderSkeleton.ErrorHandler"/> property. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.AppenderSkeleton.FilterHead"> + <summary> + The filter chain. + </summary> + <value>The head of the filter chain filter chain.</value> + <remarks> + <para> + Returns the head Filter. The Filters are organized in a linked list + and so all Filters on this Appender are available through the result. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.AppenderSkeleton.Layout"> + <summary> + Gets or sets the <see cref="T:log4net.Layout.ILayout"/> for this appender. + </summary> + <value>The layout of the appender.</value> + <remarks> + <para> + See <see cref="P:log4net.Appender.AppenderSkeleton.RequiresLayout"/> for more information. + </para> + </remarks> + <seealso cref="P:log4net.Appender.AppenderSkeleton.RequiresLayout"/> + </member> + <member name="P:log4net.Appender.AppenderSkeleton.Name"> + <summary> + Gets or sets the name of this appender. + </summary> + <value>The name of the appender.</value> + <remarks> + <para> + The name uniquely identifies the appender. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.AppenderSkeleton.RequiresLayout"> + <summary> + Tests if this appender requires a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/> to be set. + </summary> + <remarks> + <para> + In the rather exceptional case, where the appender + implementation admits a layout but can also work without it, + then the appender should return <c>true</c>. + </para> + <para> + This default implementation always returns <c>false</c>. + </para> + </remarks> + <returns> + <c>true</c> if the appender requires a layout object, otherwise <c>false</c>. + </returns> + </member> + <member name="F:log4net.Appender.BufferingAppenderSkeleton.DEFAULT_BUFFER_SIZE"> + <summary> + The default buffer size. + </summary> + <remarks> + The default size of the cyclic buffer used to store events. + This is set to 512 by default. + </remarks> + </member> + <member name="M:log4net.Appender.BufferingAppenderSkeleton.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:log4net.Appender.BufferingAppenderSkeleton"/> class. + </summary> + <remarks> + <para> + Protected default constructor to allow subclassing. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.BufferingAppenderSkeleton.#ctor(System.Boolean)"> + <summary> + Initializes a new instance of the <see cref="T:log4net.Appender.BufferingAppenderSkeleton"/> class. + </summary> + <param name="eventMustBeFixed">the events passed through this appender must be + fixed by the time that they arrive in the derived class' <c>SendBuffer</c> method.</param> + <remarks> + <para> + Protected constructor to allow subclassing. + </para> + <para> + The <paramref name="eventMustBeFixed"/> should be set if the subclass + expects the events delivered to be fixed even if the + <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> is set to zero, i.e. when no buffering occurs. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.BufferingAppenderSkeleton.Flush"> + <summary> + Flush the currently buffered events + </summary> + <remarks> + <para> + Flushes any events that have been buffered. + </para> + <para> + If the appender is buffering in <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> mode then the contents + of the buffer will NOT be flushed to the appender. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.BufferingAppenderSkeleton.Flush(System.Boolean)"> + <summary> + Flush the currently buffered events + </summary> + <param name="flushLossyBuffer">set to <c>true</c> to flush the buffer of lossy events</param> + <remarks> + <para> + Flushes events that have been buffered. If <paramref name="flushLossyBuffer"/> is + <c>false</c> then events will only be flushed if this buffer is non-lossy mode. + </para> + <para> + If the appender is buffering in <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> mode then the contents + of the buffer will only be flushed if <paramref name="flushLossyBuffer"/> is <c>true</c>. + In this case the contents of the buffer will be tested against the + <see cref="P:log4net.Appender.BufferingAppenderSkeleton.LossyEvaluator"/> and if triggering will be output. All other buffered + events will be discarded. + </para> + <para> + If <paramref name="flushLossyBuffer"/> is <c>true</c> then the buffer will always + be emptied by calling this method. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.BufferingAppenderSkeleton.ActivateOptions"> + <summary> + Initialize the appender based on the options set + </summary> + <remarks> + <para> + This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object + activation scheme. The <see cref="M:log4net.Appender.BufferingAppenderSkeleton.ActivateOptions"/> method must + be called on this object after the configuration properties have + been set. Until <see cref="M:log4net.Appender.BufferingAppenderSkeleton.ActivateOptions"/> is called this + object is in an undefined state and must not be used. + </para> + <para> + If any of the configuration properties are modified then + <see cref="M:log4net.Appender.BufferingAppenderSkeleton.ActivateOptions"/> must be called again. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.BufferingAppenderSkeleton.OnClose"> + <summary> + Close this appender instance. + </summary> + <remarks> + <para> + Close this appender instance. If this appender is marked + as not <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> then the remaining events in + the buffer must be sent when the appender is closed. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.BufferingAppenderSkeleton.Append(log4net.Core.LoggingEvent)"> + <summary> + This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method. + </summary> + <param name="loggingEvent">the event to log</param> + <remarks> + <para> + Stores the <paramref name="loggingEvent"/> in the cyclic buffer. + </para> + <para> + The buffer will be sent (i.e. passed to the <see cref="M:log4net.Appender.BufferingAppenderSkeleton.SendBuffer(log4net.Core.LoggingEvent[])"/> + method) if one of the following conditions is met: + </para> + <list type="bullet"> + <item> + <description>The cyclic buffer is full and this appender is + marked as not lossy (see <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/>)</description> + </item> + <item> + <description>An <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> is set and + it is triggered for the <paramref name="loggingEvent"/> + specified.</description> + </item> + </list> + <para> + Before the event is stored in the buffer it is fixed + (see <see cref="M:LoggingEvent.FixVolatileData(FixFlags)"/>) to ensure that + any data referenced by the event will be valid when the buffer + is processed. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.BufferingAppenderSkeleton.SendFromBuffer(log4net.Core.LoggingEvent,log4net.Util.CyclicBuffer)"> + <summary> + Sends the contents of the buffer. + </summary> + <param name="firstLoggingEvent">The first logging event.</param> + <param name="buffer">The buffer containing the events that need to be send.</param> + <remarks> + <para> + The subclass must override <see cref="M:SendBuffer(LoggingEvent[])"/>. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.BufferingAppenderSkeleton.SendBuffer(log4net.Core.LoggingEvent[])"> + <summary> + Sends the events. + </summary> + <param name="events">The events that need to be send.</param> + <remarks> + <para> + The subclass must override this method to process the buffered events. + </para> + </remarks> + </member> + <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_bufferSize"> + <summary> + The size of the cyclic buffer used to hold the logging events. + </summary> + <remarks> + Set to <see cref="F:log4net.Appender.BufferingAppenderSkeleton.DEFAULT_BUFFER_SIZE"/> by default. + </remarks> + </member> + <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_cb"> + <summary> + The cyclic buffer used to store the logging events. + </summary> + </member> + <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_evaluator"> + <summary> + The triggering event evaluator that causes the buffer to be sent immediately. + </summary> + <remarks> + The object that is used to determine if an event causes the entire + buffer to be sent immediately. This field can be <c>null</c>, which + indicates that event triggering is not to be done. The evaluator + can be set using the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> property. If this appender + has the <see cref="F:log4net.Appender.BufferingAppenderSkeleton.m_lossy"/> (<see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> property) set to + <c>true</c> then an <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> must be set. + </remarks> + </member> + <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_lossy"> + <summary> + Indicates if the appender should overwrite events in the cyclic buffer + when it becomes full, or if the buffer should be flushed when the + buffer is full. + </summary> + <remarks> + If this field is set to <c>true</c> then an <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> must + be set. + </remarks> + </member> + <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_lossyEvaluator"> + <summary> + The triggering event evaluator filters discarded events. + </summary> + <remarks> + The object that is used to determine if an event that is discarded should + really be discarded or if it should be sent to the appenders. + This field can be <c>null</c>, which indicates that all discarded events will + be discarded. + </remarks> + </member> + <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_fixFlags"> + <summary> + Value indicating which fields in the event should be fixed + </summary> + <remarks> + By default all fields are fixed + </remarks> + </member> + <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_eventMustBeFixed"> + <summary> + The events delivered to the subclass must be fixed. + </summary> + </member> + <member name="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"> + <summary> + Gets or sets a value that indicates whether the appender is lossy. + </summary> + <value> + <c>true</c> if the appender is lossy, otherwise <c>false</c>. The default is <c>false</c>. + </value> + <remarks> + <para> + This appender uses a buffer to store logging events before + delivering them. A triggering event causes the whole buffer + to be send to the remote sink. If the buffer overruns before + a triggering event then logging events could be lost. Set + <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> to <c>false</c> to prevent logging events + from being lost. + </para> + <para>If <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> is set to <c>true</c> then an + <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> must be specified.</para> + </remarks> + </member> + <member name="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"> + <summary> + Gets or sets the size of the cyclic buffer used to hold the + logging events. + </summary> + <value> + The size of the cyclic buffer used to hold the logging events. + </value> + <remarks> + <para> + The <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> option takes a positive integer + representing the maximum number of logging events to collect in + a cyclic buffer. When the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> is reached, + oldest events are deleted as new events are added to the + buffer. By default the size of the cyclic buffer is 512 events. + </para> + <para> + If the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> is set to a value less than + or equal to 1 then no buffering will occur. The logging event + will be delivered synchronously (depending on the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> + and <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> properties). Otherwise the event will + be buffered. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"> + <summary> + Gets or sets the <see cref="T:log4net.Core.ITriggeringEventEvaluator"/> that causes the + buffer to be sent immediately. + </summary> + <value> + The <see cref="T:log4net.Core.ITriggeringEventEvaluator"/> that causes the buffer to be + sent immediately. + </value> + <remarks> + <para> + The evaluator will be called for each event that is appended to this + appender. If the evaluator triggers then the current buffer will + immediately be sent (see <see cref="M:SendBuffer(LoggingEvent[])"/>). + </para> + <para>If <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> is set to <c>true</c> then an + <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> must be specified.</para> + </remarks> + </member> + <member name="P:log4net.Appender.BufferingAppenderSkeleton.LossyEvaluator"> + <summary> + Gets or sets the value of the <see cref="T:log4net.Core.ITriggeringEventEvaluator"/> to use. + </summary> + <value> + The value of the <see cref="T:log4net.Core.ITriggeringEventEvaluator"/> to use. + </value> + <remarks> + <para> + The evaluator will be called for each event that is discarded from this + appender. If the evaluator triggers then the current buffer will immediately + be sent (see <see cref="M:SendBuffer(LoggingEvent[])"/>). + </para> + </remarks> + </member> + <member name="P:log4net.Appender.BufferingAppenderSkeleton.OnlyFixPartialEventData"> + <summary> + Gets or sets a value indicating if only part of the logging event data + should be fixed. + </summary> + <value> + <c>true</c> if the appender should only fix part of the logging event + data, otherwise <c>false</c>. The default is <c>false</c>. + </value> + <remarks> + <para> + Setting this property to <c>true</c> will cause only part of the + event data to be fixed and serialized. This will improve performance. + </para> + <para> + See <see cref="M:LoggingEvent.FixVolatileData(FixFlags)"/> for more information. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.BufferingAppenderSkeleton.Fix"> + <summary> + Gets or sets a the fields that will be fixed in the event + </summary> + <value> + The event fields that will be fixed before the event is buffered + </value> + <remarks> + <para> + The logging event needs to have certain thread specific values + captured before it can be buffered. See <see cref="P:log4net.Core.LoggingEvent.Fix"/> + for details. + </para> + </remarks> + <seealso cref="P:log4net.Core.LoggingEvent.Fix"/> + </member> + <member name="M:log4net.Appender.AdoNetAppender.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:log4net.Appender.AdoNetAppender"/> class. + </summary> + <remarks> + Public default constructor to initialize a new instance of this class. + </remarks> + </member> + <member name="M:log4net.Appender.AdoNetAppender.ActivateOptions"> + <summary> + Initialize the appender based on the options set + </summary> + <remarks> + <para> + This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object + activation scheme. The <see cref="M:log4net.Appender.AdoNetAppender.ActivateOptions"/> method must + be called on this object after the configuration properties have + been set. Until <see cref="M:log4net.Appender.AdoNetAppender.ActivateOptions"/> is called this + object is in an undefined state and must not be used. + </para> + <para> + If any of the configuration properties are modified then + <see cref="M:log4net.Appender.AdoNetAppender.ActivateOptions"/> must be called again. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.AdoNetAppender.OnClose"> + <summary> + Override the parent method to close the database + </summary> + <remarks> + <para> + Closes the database command and database connection. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.AdoNetAppender.SendBuffer(log4net.Core.LoggingEvent[])"> + <summary> + Inserts the events into the database. + </summary> + <param name="events">The events to insert into the database.</param> + <remarks> + <para> + Insert all the events specified in the <paramref name="events"/> + array into the database. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.AdoNetAppender.AddParameter(log4net.Appender.AdoNetAppenderParameter)"> + <summary> + Adds a parameter to the command. + </summary> + <param name="parameter">The parameter to add to the command.</param> + <remarks> + <para> + Adds a parameter to the ordered list of command parameters. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.AdoNetAppender.SendBuffer(System.Data.IDbTransaction,log4net.Core.LoggingEvent[])"> + <summary> + Writes the events to the database using the transaction specified. + </summary> + <param name="dbTran">The transaction that the events will be executed under.</param> + <param name="events">The array of events to insert into the database.</param> + <remarks> + <para> + The transaction argument can be <c>null</c> if the appender has been + configured not to use transactions. See <see cref="P:log4net.Appender.AdoNetAppender.UseTransactions"/> + property for more information. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.AdoNetAppender.GetLogStatement(log4net.Core.LoggingEvent)"> + <summary> + Formats the log message into database statement text. + </summary> + <param name="logEvent">The event being logged.</param> + <remarks> + This method can be overridden by subclasses to provide + more control over the format of the database statement. + </remarks> + <returns> + Text that can be passed to a <see cref="T:System.Data.IDbCommand"/>. + </returns> + </member> + <member name="M:log4net.Appender.AdoNetAppender.CreateConnection(System.Type,System.String)"> + <summary> + Creates an <see cref="T:System.Data.IDbConnection"/> instance used to connect to the database. + </summary> + <remarks> + This method is called whenever a new IDbConnection is needed (i.e. when a reconnect is necessary). + </remarks> + <param name="connectionType">The <see cref="T:System.Type"/> of the <see cref="T:System.Data.IDbConnection"/> object.</param> + <param name="connectionString">The connectionString output from the ResolveConnectionString method.</param> + <returns>An <see cref="T:System.Data.IDbConnection"/> instance with a valid connection string.</returns> + </member> + <member name="M:log4net.Appender.AdoNetAppender.ResolveConnectionString(System.String@)"> + <summary> + Resolves the connection string from the ConnectionString, ConnectionStringName, or AppSettingsKey + property. + </summary> + <remarks> + ConnectiongStringName is only supported on .NET 2.0 and higher. + </remarks> + <param name="connectionStringContext">Additional information describing the connection string.</param> + <returns>A connection string used to connect to the database.</returns> + </member> + <member name="M:log4net.Appender.AdoNetAppender.ResolveConnectionType"> + <summary> + Retrieves the class type of the ADO.NET provider. + </summary> + <remarks> + <para> + Gets the Type of the ADO.NET provider to use to connect to the + database. This method resolves the type specified in the + <see cref="P:log4net.Appender.AdoNetAppender.ConnectionType"/> property. + </para> + <para> + Subclasses can override this method to return a different type + if necessary. + </para> + </remarks> + <returns>The <see cref="T:System.Type"/> of the ADO.NET provider</returns> + </member> + <member name="M:log4net.Appender.AdoNetAppender.InitializeDatabaseCommand"> + <summary> + Prepares the database command and initialize the parameters. + </summary> + </member> + <member name="M:log4net.Appender.AdoNetAppender.InitializeDatabaseConnection"> + <summary> + Connects to the database. + </summary> + </member> + <member name="M:log4net.Appender.AdoNetAppender.DisposeCommand(System.Boolean)"> + <summary> + Cleanup the existing command. + </summary> + <param name="ignoreException"> + If true, a message will be written using LogLog.Warn if an exception is encountered when calling Dispose. + </param> + </member> + <member name="M:log4net.Appender.AdoNetAppender.DiposeConnection"> + <summary> + Cleanup the existing connection. + </summary> + <remarks> + Calls the IDbConnection's <see cref="M:System.Data.IDbConnection.Close"/> method. + </remarks> + </member> + <member name="F:log4net.Appender.AdoNetAppender.m_usePreparedCommand"> + <summary> + Flag to indicate if we are using a command object + </summary> + <remarks> + <para> + Set to <c>true</c> when the appender is to use a prepared + statement or stored procedure to insert into the database. + </para> + </remarks> + </member> + <member name="F:log4net.Appender.AdoNetAppender.m_parameters"> + <summary> + The list of <see cref="T:log4net.Appender.AdoNetAppenderParameter"/> objects. + </summary> + <remarks> + <para> + The list of <see cref="T:log4net.Appender.AdoNetAppenderParameter"/> objects. + </para> + </remarks> + </member> + <member name="F:log4net.Appender.AdoNetAppender.m_securityContext"> + <summary> + The security context to use for privileged calls + </summary> + </member> + <member name="F:log4net.Appender.AdoNetAppender.m_dbConnection"> + <summary> + The <see cref="T:System.Data.IDbConnection"/> that will be used + to insert logging events into a database. + </summary> + </member> + <member name="F:log4net.Appender.AdoNetAppender.m_dbCommand"> + <summary> + The database command. + </summary> + </member> + <member name="F:log4net.Appender.AdoNetAppender.m_connectionString"> + <summary> + Database connection string. + </summary> + </member> + <member name="F:log4net.Appender.AdoNetAppender.m_appSettingsKey"> + <summary> + The appSettings key from App.Config that contains the connection string. + </summary> + </member> + <member name="F:log4net.Appender.AdoNetAppender.m_connectionStringName"> + <summary> + The connectionStrings key from App.Config that contains the connection string. + </summary> + </member> + <member name="F:log4net.Appender.AdoNetAppender.m_connectionType"> + <summary> + String type name of the <see cref="T:System.Data.IDbConnection"/> type name. + </summary> + </member> + <member name="F:log4net.Appender.AdoNetAppender.m_commandText"> + <summary> + The text of the command. + </summary> + </member> + <member name="F:log4net.Appender.AdoNetAppender.m_commandType"> + <summary> + The command type. + </summary> + </member> + <member name="F:log4net.Appender.AdoNetAppender.m_useTransactions"> + <summary> + Indicates whether to use transactions when writing to the database. + </summary> + </member> + <member name="F:log4net.Appender.AdoNetAppender.m_reconnectOnError"> + <summary> + Indicates whether to use transactions when writing to the database. + </summary> + </member> + <member name="F:log4net.Appender.AdoNetAppender.declaringType"> + <summary> + The fully qualified type of the AdoNetAppender class. + </summary> + <remarks> + Used by the internal logger to record the Type of the + log message. + </remarks> + </member> + <member name="P:log4net.Appender.AdoNetAppender.ConnectionString"> + <summary> + Gets or sets the database connection string that is used to connect to + the database. + </summary> + <value> + The database connection string used to connect to the database. + </value> + <remarks> + <para> + The connections string is specific to the connection type. + See <see cref="P:log4net.Appender.AdoNetAppender.ConnectionType"/> for more information. + </para> + </remarks> + <example>Connection string for MS Access via ODBC: + <code>"DSN=MS Access Database;UID=admin;PWD=;SystemDB=C:\data\System.mdw;SafeTransactions = 0;FIL=MS Access;DriverID = 25;DBQ=C:\data\train33.mdb"</code> + </example> + <example>Another connection string for MS Access via ODBC: + <code>"Driver={Microsoft Access Driver (*.mdb)};DBQ=C:\Work\cvs_root\log4net-1.2\access.mdb;UID=;PWD=;"</code> + </example> + <example>Connection string for MS Access via OLE DB: + <code>"Provider=Microsoft.Jet.OLEDB.4.0;Data Source=C:\Work\cvs_root\log4net-1.2\access.mdb;User Id=;Password=;"</code> + </example> + </member> + <member name="P:log4net.Appender.AdoNetAppender.AppSettingsKey"> + <summary> + The appSettings key from App.Config that contains the connection string. + </summary> + </member> + <member name="P:log4net.Appender.AdoNetAppender.ConnectionStringName"> + <summary> + The connectionStrings key from App.Config that contains the connection string. + </summary> + <remarks> + This property requires at least .NET 2.0. + </remarks> + </member> + <member name="P:log4net.Appender.AdoNetAppender.ConnectionType"> + <summary> + Gets or sets the type name of the <see cref="T:System.Data.IDbConnection"/> connection + that should be created. + </summary> + <value> + The type name of the <see cref="T:System.Data.IDbConnection"/> connection. + </value> + <remarks> + <para> + The type name of the ADO.NET provider to use. + </para> + <para> + The default is to use the OLE DB provider. + </para> + </remarks> + <example>Use the OLE DB Provider. This is the default value. + <code>System.Data.OleDb.OleDbConnection, System.Data, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</code> + </example> + <example>Use the MS SQL Server Provider. + <code>System.Data.SqlClient.SqlConnection, System.Data, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</code> + </example> + <example>Use the ODBC Provider. + <code>Microsoft.Data.Odbc.OdbcConnection,Microsoft.Data.Odbc,version=1.0.3300.0,publicKeyToken=b77a5c561934e089,culture=neutral</code> + This is an optional package that you can download from + <a href="http://msdn.microsoft.com/downloads">http://msdn.microsoft.com/downloads</a> + search for <b>ODBC .NET Data Provider</b>. + </example> + <example>Use the Oracle Provider. + <code>System.Data.OracleClient.OracleConnection, System.Data.OracleClient, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</code> + This is an optional package that you can download from + <a href="http://msdn.microsoft.com/downloads">http://msdn.microsoft.com/downloads</a> + search for <b>.NET Managed Provider for Oracle</b>. + </example> + </member> + <member name="P:log4net.Appender.AdoNetAppender.CommandText"> + <summary> + Gets or sets the command text that is used to insert logging events + into the database. + </summary> + <value> + The command text used to insert logging events into the database. + </value> + <remarks> + <para> + Either the text of the prepared statement or the + name of the stored procedure to execute to write into + the database. + </para> + <para> + The <see cref="P:log4net.Appender.AdoNetAppender.CommandType"/> property determines if + this text is a prepared statement or a stored procedure. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.AdoNetAppender.CommandType"> + <summary> + Gets or sets the command type to execute. + </summary> + <value> + The command type to execute. + </value> + <remarks> + <para> + This value may be either <see cref="F:System.Data.CommandType.Text"/> (<c>System.Data.CommandType.Text</c>) to specify + that the <see cref="P:log4net.Appender.AdoNetAppender.CommandText"/> is a prepared statement to execute, + or <see cref="F:System.Data.CommandType.StoredProcedure"/> (<c>System.Data.CommandType.StoredProcedure</c>) to specify that the + <see cref="P:log4net.Appender.AdoNetAppender.CommandText"/> property is the name of a stored procedure + to execute. + </para> + <para> + The default value is <see cref="F:System.Data.CommandType.Text"/> (<c>System.Data.CommandType.Text</c>). + </para> + </remarks> + </member> + <member name="P:log4net.Appender.AdoNetAppender.UseTransactions"> + <summary> + Should transactions be used to insert logging events in the database. + </summary> + <value> + <c>true</c> if transactions should be used to insert logging events in + the database, otherwise <c>false</c>. The default value is <c>true</c>. + </value> + <remarks> + <para> + Gets or sets a value that indicates whether transactions should be used + to insert logging events in the database. + </para> + <para> + When set a single transaction will be used to insert the buffered events + into the database. Otherwise each event will be inserted without using + an explicit transaction. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.AdoNetAppender.SecurityContext"> + <summary> + Gets or sets the <see cref="P:log4net.Appender.AdoNetAppender.SecurityContext"/> used to call the NetSend method. + </summary> + <value> + The <see cref="P:log4net.Appender.AdoNetAppender.SecurityContext"/> used to call the NetSend method. + </value> + <remarks> + <para> + Unless a <see cref="P:log4net.Appender.AdoNetAppender.SecurityContext"/> specified here for this appender + the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is queried for the + security context to use. The default behavior is to use the security context + of the current thread. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.AdoNetAppender.ReconnectOnError"> + <summary> + Should this appender try to reconnect to the database on error. + </summary> + <value> + <c>true</c> if the appender should try to reconnect to the database after an + error has occurred, otherwise <c>false</c>. The default value is <c>false</c>, + i.e. not to try to reconnect. + </value> + <remarks> + <para> + The default behaviour is for the appender not to try to reconnect to the + database if an error occurs. Subsequent logging events are discarded. + </para> + <para> + To force the appender to attempt to reconnect to the database set this + property to <c>true</c>. + </para> + <note> + When the appender attempts to connect to the database there may be a + delay of up to the connection timeout specified in the connection string. + This delay will block the calling application's thread. + Until the connection can be reestablished this potential delay may occur multiple times. + </note> + </remarks> + </member> + <member name="P:log4net.Appender.AdoNetAppender.Connection"> + <summary> + Gets or sets the underlying <see cref="T:System.Data.IDbConnection"/>. + </summary> + <value> + The underlying <see cref="T:System.Data.IDbConnection"/>. + </value> + <remarks> + <see cref="T:log4net.Appender.AdoNetAppender"/> creates a <see cref="T:System.Data.IDbConnection"/> to insert + logging events into a database. Classes deriving from <see cref="T:log4net.Appender.AdoNetAppender"/> + can use this property to get or set this <see cref="T:System.Data.IDbConnection"/>. Use the + underlying <see cref="T:System.Data.IDbConnection"/> returned from <see cref="P:log4net.Appender.AdoNetAppender.Connection"/> if + you require access beyond that which <see cref="T:log4net.Appender.AdoNetAppender"/> provides. + </remarks> + </member> + <member name="T:log4net.Appender.AdoNetAppenderParameter"> + <summary> + Parameter type used by the <see cref="T:log4net.Appender.AdoNetAppender"/>. + </summary> + <remarks> + <para> + This class provides the basic database parameter properties + as defined by the <see cref="T:System.Data.IDbDataParameter"/> interface. + </para> + <para>This type can be subclassed to provide database specific + functionality. The two methods that are called externally are + <see cref="M:log4net.Appender.AdoNetAppenderParameter.Prepare(System.Data.IDbCommand)"/> and <see cref="M:log4net.Appender.AdoNetAppenderParameter.FormatValue(System.Data.IDbCommand,log4net.Core.LoggingEvent)"/>. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.AdoNetAppenderParameter.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:log4net.Appender.AdoNetAppenderParameter"/> class. + </summary> + <remarks> + Default constructor for the AdoNetAppenderParameter class. + </remarks> + </member> + <member name="M:log4net.Appender.AdoNetAppenderParameter.Prepare(System.Data.IDbCommand)"> + <summary> + Prepare the specified database command object. + </summary> + <param name="command">The command to prepare.</param> + <remarks> + <para> + Prepares the database command object by adding + this parameter to its collection of parameters. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.AdoNetAppenderParameter.FormatValue(System.Data.IDbCommand,log4net.Core.LoggingEvent)"> + <summary> + Renders the logging event and set the parameter value in the command. + </summary> + <param name="command">The command containing the parameter.</param> + <param name="loggingEvent">The event to be rendered.</param> + <remarks> + <para> + Renders the logging event using this parameters layout + object. Sets the value of the parameter on the command object. + </para> + </remarks> + </member> + <member name="F:log4net.Appender.AdoNetAppenderParameter.m_parameterName"> + <summary> + The name of this parameter. + </summary> + </member> + <member name="F:log4net.Appender.AdoNetAppenderParameter.m_dbType"> + <summary> + The database type for this parameter. + </summary> + </member> + <member name="F:log4net.Appender.AdoNetAppenderParameter.m_inferType"> + <summary> + Flag to infer type rather than use the DbType + </summary> + </member> + <member name="F:log4net.Appender.AdoNetAppenderParameter.m_precision"> + <summary> + The precision for this parameter. + </summary> + </member> + <member name="F:log4net.Appender.AdoNetAppenderParameter.m_scale"> + <summary> + The scale for this parameter. + </summary> + </member> + <member name="F:log4net.Appender.AdoNetAppenderParameter.m_size"> + <summary> + The size for this parameter. + </summary> + </member> + <member name="F:log4net.Appender.AdoNetAppenderParameter.m_layout"> + <summary> + The <see cref="T:log4net.Layout.IRawLayout"/> to use to render the + logging event into an object for this parameter. + </summary> + </member> + <member name="P:log4net.Appender.AdoNetAppenderParameter.ParameterName"> + <summary> + Gets or sets the name of this parameter. + </summary> + <value> + The name of this parameter. + </value> + <remarks> + <para> + The name of this parameter. The parameter name + must match up to a named parameter to the SQL stored procedure + or prepared statement. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.AdoNetAppenderParameter.DbType"> + <summary> + Gets or sets the database type for this parameter. + </summary> + <value> + The database type for this parameter. + </value> + <remarks> + <para> + The database type for this parameter. This property should + be set to the database type from the <see cref="P:log4net.Appender.AdoNetAppenderParameter.DbType"/> + enumeration. See <see cref="P:System.Data.IDataParameter.DbType"/>. + </para> + <para> + This property is optional. If not specified the ADO.NET provider + will attempt to infer the type from the value. + </para> + </remarks> + <seealso cref="P:System.Data.IDataParameter.DbType"/> + </member> + <member name="P:log4net.Appender.AdoNetAppenderParameter.Precision"> + <summary> + Gets or sets the precision for this parameter. + </summary> + <value> + The precision for this parameter. + </value> + <remarks> + <para> + The maximum number of digits used to represent the Value. + </para> + <para> + This property is optional. If not specified the ADO.NET provider + will attempt to infer the precision from the value. + </para> + </remarks> + <seealso cref="P:System.Data.IDbDataParameter.Precision"/> + </member> + <member name="P:log4net.Appender.AdoNetAppenderParameter.Scale"> + <summary> + Gets or sets the scale for this parameter. + </summary> + <value> + The scale for this parameter. + </value> + <remarks> + <para> + The number of decimal places to which Value is resolved. + </para> + <para> + This property is optional. If not specified the ADO.NET provider + will attempt to infer the scale from the value. + </para> + </remarks> + <seealso cref="P:System.Data.IDbDataParameter.Scale"/> + </member> + <member name="P:log4net.Appender.AdoNetAppenderParameter.Size"> + <summary> + Gets or sets the size for this parameter. + </summary> + <value> + The size for this parameter. + </value> + <remarks> + <para> + The maximum size, in bytes, of the data within the column. + </para> + <para> + This property is optional. If not specified the ADO.NET provider + will attempt to infer the size from the value. + </para> + <para> + For BLOB data types like VARCHAR(max) it may be impossible to infer the value automatically, use -1 as the size in this case. + </para> + </remarks> + <seealso cref="P:System.Data.IDbDataParameter.Size"/> + </member> + <member name="P:log4net.Appender.AdoNetAppenderParameter.Layout"> + <summary> + Gets or sets the <see cref="T:log4net.Layout.IRawLayout"/> to use to + render the logging event into an object for this + parameter. + </summary> + <value> + The <see cref="T:log4net.Layout.IRawLayout"/> used to render the + logging event into an object for this parameter. + </value> + <remarks> + <para> + The <see cref="T:log4net.Layout.IRawLayout"/> that renders the value for this + parameter. + </para> + <para> + The <see cref="T:log4net.Layout.RawLayoutConverter"/> can be used to adapt + any <see cref="T:log4net.Layout.ILayout"/> into a <see cref="T:log4net.Layout.IRawLayout"/> + for use in the property. + </para> + </remarks> + </member> + <member name="T:log4net.Appender.AnsiColorTerminalAppender"> + <summary> + Appends logging events to the terminal using ANSI color escape sequences. + </summary> + <remarks> + <para> + AnsiColorTerminalAppender appends log events to the standard output stream + or the error output stream using a layout specified by the + user. It also allows the color of a specific level of message to be set. + </para> + <note> + This appender expects the terminal to understand the VT100 control set + in order to interpret the color codes. If the terminal or console does not + understand the control codes the behavior is not defined. + </note> + <para> + By default, all output is written to the console's standard output stream. + The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> property can be set to direct the output to the + error stream. + </para> + <para> + NOTE: This appender writes each message to the <c>System.Console.Out</c> or + <c>System.Console.Error</c> that is set at the time the event is appended. + Therefore it is possible to programmatically redirect the output of this appender + (for example NUnit does this to capture program output). While this is the desired + behavior of this appender it may have security implications in your application. + </para> + <para> + When configuring the ANSI colored terminal appender, a mapping should be + specified to map a logging level to a color. For example: + </para> + <code lang="XML" escaped="true"> + <mapping> + <level value="ERROR"/> + <foreColor value="White"/> + <backColor value="Red"/> + <attributes value="Bright,Underscore"/> + </mapping> + <mapping> + <level value="DEBUG"/> + <backColor value="Green"/> + </mapping> + </code> + <para> + The Level is the standard log4net logging level and ForeColor and BackColor can be any + of the following values: + <list type="bullet"> + <item><term>Blue</term><description></description></item> + <item><term>Green</term><description></description></item> + <item><term>Red</term><description></description></item> + <item><term>White</term><description></description></item> + <item><term>Yellow</term><description></description></item> + <item><term>Purple</term><description></description></item> + <item><term>Cyan</term><description></description></item> + </list> + These color values cannot be combined together to make new colors. + </para> + <para> + The attributes can be any combination of the following: + <list type="bullet"> + <item><term>Bright</term><description>foreground is brighter</description></item> + <item><term>Dim</term><description>foreground is dimmer</description></item> + <item><term>Underscore</term><description>message is underlined</description></item> + <item><term>Blink</term><description>foreground is blinking (does not work on all terminals)</description></item> + <item><term>Reverse</term><description>foreground and background are reversed</description></item> + <item><term>Hidden</term><description>output is hidden</description></item> + <item><term>Strikethrough</term><description>message has a line through it</description></item> + </list> + While any of these attributes may be combined together not all combinations + work well together, for example setting both <i>Bright</i> and <i>Dim</i> attributes makes + no sense. + </para> + </remarks> + <author>Patrick Wagstrom</author> + <author>Nicko Cadell</author> + </member> + <member name="F:log4net.Appender.AnsiColorTerminalAppender.ConsoleOut"> + <summary> + The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> to use when writing to the Console + standard output stream. + </summary> + <remarks> + <para> + The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> to use when writing to the Console + standard output stream. + </para> + </remarks> + </member> + <member name="F:log4net.Appender.AnsiColorTerminalAppender.ConsoleError"> + <summary> + The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> to use when writing to the Console + standard error output stream. + </summary> + <remarks> + <para> + The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> to use when writing to the Console + standard error output stream. + </para> + </remarks> + </member> + <member name="F:log4net.Appender.AnsiColorTerminalAppender.PostEventCodes"> + <summary> + Ansi code to reset terminal + </summary> + </member> + <member name="M:log4net.Appender.AnsiColorTerminalAppender.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:log4net.Appender.AnsiColorTerminalAppender"/> class. + </summary> + <remarks> + The instance of the <see cref="T:log4net.Appender.AnsiColorTerminalAppender"/> class is set up to write + to the standard output stream. + </remarks> + </member> + <member name="M:log4net.Appender.AnsiColorTerminalAppender.AddMapping(log4net.Appender.AnsiColorTerminalAppender.LevelColors)"> + <summary> + Add a mapping of level to color + </summary> + <param name="mapping">The mapping to add</param> + <remarks> + <para> + Add a <see cref="T:log4net.Appender.AnsiColorTerminalAppender.LevelColors"/> mapping to this appender. + Each mapping defines the foreground and background colours + for a level. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.AnsiColorTerminalAppender.Append(log4net.Core.LoggingEvent)"> + <summary> + This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method. + </summary> + <param name="loggingEvent">The event to log.</param> + <remarks> + <para> + Writes the event to the console. + </para> + <para> + The format of the output will depend on the appender's layout. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.AnsiColorTerminalAppender.ActivateOptions"> + <summary> + Initialize the options for this appender + </summary> + <remarks> + <para> + Initialize the level to color mappings set on this appender. + </para> + </remarks> + </member> + <member name="F:log4net.Appender.AnsiColorTerminalAppender.m_writeToErrorStream"> + <summary> + Flag to write output to the error stream rather than the standard output stream + </summary> + </member> + <member name="F:log4net.Appender.AnsiColorTerminalAppender.m_levelMapping"> + <summary> + Mapping from level object to color value + </summary> + </member> + <member name="P:log4net.Appender.AnsiColorTerminalAppender.Target"> + <summary> + Target is the value of the console output stream. + </summary> + <value> + Target is the value of the console output stream. + This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>. + </value> + <remarks> + <para> + Target is the value of the console output stream. + This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.AnsiColorTerminalAppender.RequiresLayout"> + <summary> + This appender requires a <see cref="N:log4net.Layout"/> to be set. + </summary> + <value><c>true</c></value> + <remarks> + <para> + This appender requires a <see cref="N:log4net.Layout"/> to be set. + </para> + </remarks> + </member> + <member name="T:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes"> + <summary> + The enum of possible display attributes + </summary> + <remarks> + <para> + The following flags can be combined together to + form the ANSI color attributes. + </para> + </remarks> + <seealso cref="T:log4net.Appender.AnsiColorTerminalAppender"/> + </member> + <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Bright"> + <summary> + text is bright + </summary> + </member> + <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Dim"> + <summary> + text is dim + </summary> + </member> + <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Underscore"> + <summary> + text is underlined + </summary> + </member> + <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Blink"> + <summary> + text is blinking + </summary> + <remarks> + Not all terminals support this attribute + </remarks> + </member> + <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Reverse"> + <summary> + text and background colors are reversed + </summary> + </member> + <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Hidden"> + <summary> + text is hidden + </summary> + </member> + <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Strikethrough"> + <summary> + text is displayed with a strikethrough + </summary> + </member> + <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Light"> + <summary> + text color is light + </summary> + </member> + <member name="T:log4net.Appender.AnsiColorTerminalAppender.AnsiColor"> + <summary> + The enum of possible foreground or background color values for + use with the color mapping method + </summary> + <remarks> + <para> + The output can be in one for the following ANSI colors. + </para> + </remarks> + <seealso cref="T:log4net.Appender.AnsiColorTerminalAppender"/> + </member> + <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Black"> + <summary> + color is black + </summary> + </member> + <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Red"> + <summary> + color is red + </summary> + </member> + <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Green"> + <summary> + color is green + </summary> + </member> + <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Yellow"> + <summary> + color is yellow + </summary> + </member> + <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Blue"> + <summary> + color is blue + </summary> + </member> + <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Magenta"> + <summary> + color is magenta + </summary> + </member> + <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Cyan"> + <summary> + color is cyan + </summary> + </member> + <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.White"> + <summary> + color is white + </summary> + </member> + <member name="T:log4net.Appender.AnsiColorTerminalAppender.LevelColors"> + <summary> + A class to act as a mapping between the level that a logging call is made at and + the color it should be displayed as. + </summary> + <remarks> + <para> + Defines the mapping between a level and the color it should be displayed in. + </para> + </remarks> + </member> + <member name="T:log4net.Util.LevelMappingEntry"> + <summary> + An entry in the <see cref="T:log4net.Util.LevelMapping"/> + </summary> + <remarks> + <para> + This is an abstract base class for types that are stored in the + <see cref="T:log4net.Util.LevelMapping"/> object. + </para> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="M:log4net.Util.LevelMappingEntry.#ctor"> + <summary> + Default protected constructor + </summary> + <remarks> + <para> + Default protected constructor + </para> + </remarks> + </member> + <member name="M:log4net.Util.LevelMappingEntry.ActivateOptions"> + <summary> + Initialize any options defined on this entry + </summary> + <remarks> + <para> + Should be overridden by any classes that need to initialise based on their options + </para> + </remarks> + </member> + <member name="P:log4net.Util.LevelMappingEntry.Level"> + <summary> + The level that is the key for this mapping + </summary> + <value> + The <see cref="P:log4net.Util.LevelMappingEntry.Level"/> that is the key for this mapping + </value> + <remarks> + <para> + Get or set the <see cref="P:log4net.Util.LevelMappingEntry.Level"/> that is the key for this + mapping subclass. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.AnsiColorTerminalAppender.LevelColors.ActivateOptions"> + <summary> + Initialize the options for the object + </summary> + <remarks> + <para> + Combine the <see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.ForeColor"/> and <see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.BackColor"/> together + and append the attributes. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.ForeColor"> + <summary> + The mapped foreground color for the specified level + </summary> + <remarks> + <para> + Required property. + The mapped foreground color for the specified level + </para> + </remarks> + </member> + <member name="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.BackColor"> + <summary> + The mapped background color for the specified level + </summary> + <remarks> + <para> + Required property. + The mapped background color for the specified level + </para> + </remarks> + </member> + <member name="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.Attributes"> + <summary> + The color attributes for the specified level + </summary> + <remarks> + <para> + Required property. + The color attributes for the specified level + </para> + </remarks> + </member> + <member name="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.CombinedColor"> + <summary> + The combined <see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.ForeColor"/>, <see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.BackColor"/> and + <see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.Attributes"/> suitable for setting the ansi terminal color. + </summary> + </member> + <member name="T:log4net.Appender.AppenderCollection"> + <summary> + A strongly-typed collection of <see cref="T:log4net.Appender.IAppender"/> objects. + </summary> + <author>Nicko Cadell</author> + </member> + <member name="M:log4net.Appender.AppenderCollection.ReadOnly(log4net.Appender.AppenderCollection)"> + <summary> + Creates a read-only wrapper for a <c>AppenderCollection</c> instance. + </summary> + <param name="list">list to create a readonly wrapper arround</param> + <returns> + An <c>AppenderCollection</c> wrapper that is read-only. + </returns> + </member> + <member name="F:log4net.Appender.AppenderCollection.EmptyCollection"> + <summary> + An empty readonly static AppenderCollection + </summary> + </member> + <member name="M:log4net.Appender.AppenderCollection.#ctor"> + <summary> + Initializes a new instance of the <c>AppenderCollection</c> class + that is empty and has the default initial capacity. + </summary> + </member> + <member name="M:log4net.Appender.AppenderCollection.#ctor(System.Int32)"> + <summary> + Initializes a new instance of the <c>AppenderCollection</c> class + that has the specified initial capacity. + </summary> + <param name="capacity"> + The number of elements that the new <c>AppenderCollection</c> is initially capable of storing. + </param> + </member> + <member name="M:log4net.Appender.AppenderCollection.#ctor(log4net.Appender.AppenderCollection)"> + <summary> + Initializes a new instance of the <c>AppenderCollection</c> class + that contains elements copied from the specified <c>AppenderCollection</c>. + </summary> + <param name="c">The <c>AppenderCollection</c> whose elements are copied to the new collection.</param> + </member> + <member name="M:log4net.Appender.AppenderCollection.#ctor(log4net.Appender.IAppender[])"> + <summary> + Initializes a new instance of the <c>AppenderCollection</c> class + that contains elements copied from the specified <see cref="T:log4net.Appender.IAppender"/> array. + </summary> + <param name="a">The <see cref="T:log4net.Appender.IAppender"/> array whose elements are copied to the new list.</param> + </member> + <member name="M:log4net.Appender.AppenderCollection.#ctor(System.Collections.ICollection)"> + <summary> + Initializes a new instance of the <c>AppenderCollection</c> class + that contains elements copied from the specified <see cref="T:log4net.Appender.IAppender"/> collection. + </summary> + <param name="col">The <see cref="T:log4net.Appender.IAppender"/> collection whose elements are copied to the new list.</param> + </member> + <member name="M:log4net.Appender.AppenderCollection.#ctor(log4net.Appender.AppenderCollection.Tag)"> + <summary> + Allow subclasses to avoid our default constructors + </summary> + <param name="tag"></param> + <exclude/> + </member> + <member name="M:log4net.Appender.AppenderCollection.CopyTo(log4net.Appender.IAppender[])"> + <summary> + Copies the entire <c>AppenderCollection</c> to a one-dimensional + <see cref="T:log4net.Appender.IAppender"/> array. + </summary> + <param name="array">The one-dimensional <see cref="T:log4net.Appender.IAppender"/> array to copy to.</param> + </member> + <member name="M:log4net.Appender.AppenderCollection.CopyTo(log4net.Appender.IAppender[],System.Int32)"> + <summary> + Copies the entire <c>AppenderCollection</c> to a one-dimensional + <see cref="T:log4net.Appender.IAppender"/> array, starting at the specified index of the target array. + </summary> + <param name="array">The one-dimensional <see cref="T:log4net.Appender.IAppender"/> array to copy to.</param> + <param name="start">The zero-based index in <paramref name="array"/> at which copying begins.</param> + </member> + <member name="M:log4net.Appender.AppenderCollection.Add(log4net.Appender.IAppender)"> + <summary> + Adds a <see cref="T:log4net.Appender.IAppender"/> to the end of the <c>AppenderCollection</c>. + </summary> + <param name="item">The <see cref="T:log4net.Appender.IAppender"/> to be added to the end of the <c>AppenderCollection</c>.</param> + <returns>The index at which the value has been added.</returns> + </member> + <member name="M:log4net.Appender.AppenderCollection.Clear"> + <summary> + Removes all elements from the <c>AppenderCollection</c>. + </summary> + </member> + <member name="M:log4net.Appender.AppenderCollection.Clone"> + <summary> + Creates a shallow copy of the <see cref="T:log4net.Appender.AppenderCollection"/>. + </summary> + <returns>A new <see cref="T:log4net.Appender.AppenderCollection"/> with a shallow copy of the collection data.</returns> + </member> + <member name="M:log4net.Appender.AppenderCollection.Contains(log4net.Appender.IAppender)"> + <summary> + Determines whether a given <see cref="T:log4net.Appender.IAppender"/> is in the <c>AppenderCollection</c>. + </summary> + <param name="item">The <see cref="T:log4net.Appender.IAppender"/> to check for.</param> + <returns><c>true</c> if <paramref name="item"/> is found in the <c>AppenderCollection</c>; otherwise, <c>false</c>.</returns> + </member> + <member name="M:log4net.Appender.AppenderCollection.IndexOf(log4net.Appender.IAppender)"> + <summary> + Returns the zero-based index of the first occurrence of a <see cref="T:log4net.Appender.IAppender"/> + in the <c>AppenderCollection</c>. + </summary> + <param name="item">The <see cref="T:log4net.Appender.IAppender"/> to locate in the <c>AppenderCollection</c>.</param> + <returns> + The zero-based index of the first occurrence of <paramref name="item"/> + in the entire <c>AppenderCollection</c>, if found; otherwise, -1. + </returns> + </member> + <member name="M:log4net.Appender.AppenderCollection.Insert(System.Int32,log4net.Appender.IAppender)"> + <summary> + Inserts an element into the <c>AppenderCollection</c> at the specified index. + </summary> + <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param> + <param name="item">The <see cref="T:log4net.Appender.IAppender"/> to insert.</param> + <exception cref="T:System.ArgumentOutOfRangeException"> + <para><paramref name="index"/> is less than zero</para> + <para>-or-</para> + <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para> + </exception> + </member> + <member name="M:log4net.Appender.AppenderCollection.Remove(log4net.Appender.IAppender)"> + <summary> + Removes the first occurrence of a specific <see cref="T:log4net.Appender.IAppender"/> from the <c>AppenderCollection</c>. + </summary> + <param name="item">The <see cref="T:log4net.Appender.IAppender"/> to remove from the <c>AppenderCollection</c>.</param> + <exception cref="T:System.ArgumentException"> + The specified <see cref="T:log4net.Appender.IAppender"/> was not found in the <c>AppenderCollection</c>. + </exception> + </member> + <member name="M:log4net.Appender.AppenderCollection.RemoveAt(System.Int32)"> + <summary> + Removes the element at the specified index of the <c>AppenderCollection</c>. + </summary> + <param name="index">The zero-based index of the element to remove.</param> + <exception cref="T:System.ArgumentOutOfRangeException"> + <para><paramref name="index"/> is less than zero</para> + <para>-or-</para> + <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para> + </exception> + </member> + <member name="M:log4net.Appender.AppenderCollection.GetEnumerator"> + <summary> + Returns an enumerator that can iterate through the <c>AppenderCollection</c>. + </summary> + <returns>An <see cref="T:log4net.Appender.AppenderCollection.Enumerator"/> for the entire <c>AppenderCollection</c>.</returns> + </member> + <member name="M:log4net.Appender.AppenderCollection.AddRange(log4net.Appender.AppenderCollection)"> + <summary> + Adds the elements of another <c>AppenderCollection</c> to the current <c>AppenderCollection</c>. + </summary> + <param name="x">The <c>AppenderCollection</c> whose elements should be added to the end of the current <c>AppenderCollection</c>.</param> + <returns>The new <see cref="P:log4net.Appender.AppenderCollection.Count"/> of the <c>AppenderCollection</c>.</returns> + </member> + <member name="M:log4net.Appender.AppenderCollection.AddRange(log4net.Appender.IAppender[])"> + <summary> + Adds the elements of a <see cref="T:log4net.Appender.IAppender"/> array to the current <c>AppenderCollection</c>. + </summary> + <param name="x">The <see cref="T:log4net.Appender.IAppender"/> array whose elements should be added to the end of the <c>AppenderCollection</c>.</param> + <returns>The new <see cref="P:log4net.Appender.AppenderCollection.Count"/> of the <c>AppenderCollection</c>.</returns> + </member> + <member name="M:log4net.Appender.AppenderCollection.AddRange(System.Collections.ICollection)"> + <summary> + Adds the elements of a <see cref="T:log4net.Appender.IAppender"/> collection to the current <c>AppenderCollection</c>. + </summary> + <param name="col">The <see cref="T:log4net.Appender.IAppender"/> collection whose elements should be added to the end of the <c>AppenderCollection</c>.</param> + <returns>The new <see cref="P:log4net.Appender.AppenderCollection.Count"/> of the <c>AppenderCollection</c>.</returns> + </member> + <member name="M:log4net.Appender.AppenderCollection.TrimToSize"> + <summary> + Sets the capacity to the actual number of elements. + </summary> + </member> + <member name="M:log4net.Appender.AppenderCollection.ToArray"> + <summary> + Return the collection elements as an array + </summary> + <returns>the array</returns> + </member> + <member name="M:log4net.Appender.AppenderCollection.ValidateIndex(System.Int32)"> + <exception cref="T:System.ArgumentOutOfRangeException"> + <para><paramref name="i"/> is less than zero</para> + <para>-or-</para> + <para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para> + </exception> + </member> + <member name="M:log4net.Appender.AppenderCollection.ValidateIndex(System.Int32,System.Boolean)"> + <exception cref="T:System.ArgumentOutOfRangeException"> + <para><paramref name="i"/> is less than zero</para> + <para>-or-</para> + <para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para> + </exception> + </member> + <member name="P:log4net.Appender.AppenderCollection.Count"> + <summary> + Gets the number of elements actually contained in the <c>AppenderCollection</c>. + </summary> + </member> + <member name="P:log4net.Appender.AppenderCollection.IsSynchronized"> + <summary> + Gets a value indicating whether access to the collection is synchronized (thread-safe). + </summary> + <returns>true if access to the ICollection is synchronized (thread-safe); otherwise, false.</returns> + </member> + <member name="P:log4net.Appender.AppenderCollection.SyncRoot"> + <summary> + Gets an object that can be used to synchronize access to the collection. + </summary> + </member> + <member name="P:log4net.Appender.AppenderCollection.Item(System.Int32)"> + <summary> + Gets or sets the <see cref="T:log4net.Appender.IAppender"/> at the specified index. + </summary> + <param name="index">The zero-based index of the element to get or set.</param> + <exception cref="T:System.ArgumentOutOfRangeException"> + <para><paramref name="index"/> is less than zero</para> + <para>-or-</para> + <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para> + </exception> + </member> + <member name="P:log4net.Appender.AppenderCollection.IsFixedSize"> + <summary> + Gets a value indicating whether the collection has a fixed size. + </summary> + <value>true if the collection has a fixed size; otherwise, false. The default is false</value> + </member> + <member name="P:log4net.Appender.AppenderCollection.IsReadOnly"> + <summary> + Gets a value indicating whether the IList is read-only. + </summary> + <value>true if the collection is read-only; otherwise, false. The default is false</value> + </member> + <member name="P:log4net.Appender.AppenderCollection.Capacity"> + <summary> + Gets or sets the number of elements the <c>AppenderCollection</c> can contain. + </summary> + </member> + <member name="T:log4net.Appender.AppenderCollection.IAppenderCollectionEnumerator"> + <summary> + Supports type-safe iteration over a <see cref="T:log4net.Appender.AppenderCollection"/>. + </summary> + <exclude/> + </member> + <member name="M:log4net.Appender.AppenderCollection.IAppenderCollectionEnumerator.MoveNext"> + <summary> + Advances the enumerator to the next element in the collection. + </summary> + <returns> + <c>true</c> if the enumerator was successfully advanced to the next element; + <c>false</c> if the enumerator has passed the end of the collection. + </returns> + <exception cref="T:System.InvalidOperationException"> + The collection was modified after the enumerator was created. + </exception> + </member> + <member name="M:log4net.Appender.AppenderCollection.IAppenderCollectionEnumerator.Reset"> + <summary> + Sets the enumerator to its initial position, before the first element in the collection. + </summary> + </member> + <member name="P:log4net.Appender.AppenderCollection.IAppenderCollectionEnumerator.Current"> + <summary> + Gets the current element in the collection. + </summary> + </member> + <member name="T:log4net.Appender.AppenderCollection.Tag"> + <summary> + Type visible only to our subclasses + Used to access protected constructor + </summary> + <exclude/> + </member> + <member name="F:log4net.Appender.AppenderCollection.Tag.Default"> + <summary> + A value + </summary> + </member> + <member name="T:log4net.Appender.AppenderCollection.Enumerator"> + <summary> + Supports simple iteration over a <see cref="T:log4net.Appender.AppenderCollection"/>. + </summary> + <exclude/> + </member> + <member name="M:log4net.Appender.AppenderCollection.Enumerator.#ctor(log4net.Appender.AppenderCollection)"> + <summary> + Initializes a new instance of the <c>Enumerator</c> class. + </summary> + <param name="tc"></param> + </member> + <member name="M:log4net.Appender.AppenderCollection.Enumerator.MoveNext"> + <summary> + Advances the enumerator to the next element in the collection. + </summary> + <returns> + <c>true</c> if the enumerator was successfully advanced to the next element; + <c>false</c> if the enumerator has passed the end of the collection. + </returns> + <exception cref="T:System.InvalidOperationException"> + The collection was modified after the enumerator was created. + </exception> + </member> + <member name="M:log4net.Appender.AppenderCollection.Enumerator.Reset"> + <summary> + Sets the enumerator to its initial position, before the first element in the collection. + </summary> + </member> + <member name="P:log4net.Appender.AppenderCollection.Enumerator.Current"> + <summary> + Gets the current element in the collection. + </summary> + </member> + <member name="T:log4net.Appender.AppenderCollection.ReadOnlyAppenderCollection"> + <exclude/> + </member> + <member name="T:log4net.Appender.AspNetTraceAppender"> + <summary> + <para> + Appends log events to the ASP.NET <see cref="T:System.Web.TraceContext"/> system. + </para> + </summary> + <remarks> + <para> + Diagnostic information and tracing messages that you specify are appended to the output + of the page that is sent to the requesting browser. Optionally, you can view this information + from a separate trace viewer (Trace.axd) that displays trace information for every page in a + given application. + </para> + <para> + Trace statements are processed and displayed only when tracing is enabled. You can control + whether tracing is displayed to a page, to the trace viewer, or both. + </para> + <para> + The logging event is passed to the <see cref="M:TraceContext.Write(string)"/> or + <see cref="M:TraceContext.Warn(string)"/> method depending on the level of the logging event. + The event's logger name is the default value for the category parameter of the Write/Warn method. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + <author>Ron Grabowski</author> + </member> + <member name="M:log4net.Appender.AspNetTraceAppender.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:log4net.Appender.AspNetTraceAppender"/> class. + </summary> + <remarks> + <para> + Default constructor. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.AspNetTraceAppender.Append(log4net.Core.LoggingEvent)"> + <summary> + Write the logging event to the ASP.NET trace + </summary> + <param name="loggingEvent">the event to log</param> + <remarks> + <para> + Write the logging event to the ASP.NET trace + <c>HttpContext.Current.Trace</c> + (<see cref="T:System.Web.TraceContext"/>). + </para> + </remarks> + </member> + <member name="F:log4net.Appender.AspNetTraceAppender.m_category"> + <summary> + Defaults to %logger + </summary> + </member> + <member name="P:log4net.Appender.AspNetTraceAppender.RequiresLayout"> + <summary> + This appender requires a <see cref="N:log4net.Layout"/> to be set. + </summary> + <value><c>true</c></value> + <remarks> + <para> + This appender requires a <see cref="N:log4net.Layout"/> to be set. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.AspNetTraceAppender.Category"> + <summary> + The category parameter sent to the Trace method. + </summary> + <remarks> + <para> + Defaults to %logger which will use the logger name of the current + <see cref="T:log4net.Core.LoggingEvent"/> as the category parameter. + </para> + <para> + </para> + </remarks> + </member> + <member name="T:log4net.Appender.BufferingForwardingAppender"> + <summary> + Buffers events and then forwards them to attached appenders. + </summary> + <remarks> + <para> + The events are buffered in this appender until conditions are + met to allow the appender to deliver the events to the attached + appenders. See <see cref="T:log4net.Appender.BufferingAppenderSkeleton"/> for the + conditions that cause the buffer to be sent. + </para> + <para>The forwarding appender can be used to specify different + thresholds and filters for the same appender at different locations + within the hierarchy. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="T:log4net.Core.IAppenderAttachable"> + <summary> + Interface for attaching appenders to objects. + </summary> + <remarks> + <para> + Interface for attaching, removing and retrieving appenders. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Core.IAppenderAttachable.AddAppender(log4net.Appender.IAppender)"> + <summary> + Attaches an appender. + </summary> + <param name="appender">The appender to add.</param> + <remarks> + <para> + Add the specified appender. The implementation may + choose to allow or deny duplicate appenders. + </para> + </remarks> + </member> + <member name="M:log4net.Core.IAppenderAttachable.GetAppender(System.String)"> + <summary> + Gets an attached appender with the specified name. + </summary> + <param name="name">The name of the appender to get.</param> + <returns> + The appender with the name specified, or <c>null</c> if no appender with the + specified name is found. + </returns> + <remarks> + <para> + Returns an attached appender with the <paramref name="name"/> specified. + If no appender with the specified name is found <c>null</c> will be + returned. + </para> + </remarks> + </member> + <member name="M:log4net.Core.IAppenderAttachable.RemoveAllAppenders"> + <summary> + Removes all attached appenders. + </summary> + <remarks> + <para> + Removes and closes all attached appenders + </para> + </remarks> + </member> + <member name="M:log4net.Core.IAppenderAttachable.RemoveAppender(log4net.Appender.IAppender)"> + <summary> + Removes the specified appender from the list of attached appenders. + </summary> + <param name="appender">The appender to remove.</param> + <returns>The appender removed from the list</returns> + <remarks> + <para> + The appender removed is not closed. + If you are discarding the appender you must call + <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed. + </para> + </remarks> + </member> + <member name="M:log4net.Core.IAppenderAttachable.RemoveAppender(System.String)"> + <summary> + Removes the appender with the specified name from the list of appenders. + </summary> + <param name="name">The name of the appender to remove.</param> + <returns>The appender removed from the list</returns> + <remarks> + <para> + The appender removed is not closed. + If you are discarding the appender you must call + <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed. + </para> + </remarks> + </member> + <member name="P:log4net.Core.IAppenderAttachable.Appenders"> + <summary> + Gets all attached appenders. + </summary> + <value> + A collection of attached appenders. + </value> + <remarks> + <para> + Gets a collection of attached appenders. + If there are no attached appenders the + implementation should return an empty + collection rather than <c>null</c>. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.BufferingForwardingAppender.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:log4net.Appender.BufferingForwardingAppender"/> class. + </summary> + <remarks> + <para> + Default constructor. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.BufferingForwardingAppender.OnClose"> + <summary> + Closes the appender and releases resources. + </summary> + <remarks> + <para> + Releases any resources allocated within the appender such as file handles, + network connections, etc. + </para> + <para> + It is a programming error to append to a closed appender. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.BufferingForwardingAppender.SendBuffer(log4net.Core.LoggingEvent[])"> + <summary> + Send the events. + </summary> + <param name="events">The events that need to be send.</param> + <remarks> + <para> + Forwards the events to the attached appenders. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.BufferingForwardingAppender.AddAppender(log4net.Appender.IAppender)"> + <summary> + Adds an <see cref="T:log4net.Appender.IAppender"/> to the list of appenders of this + instance. + </summary> + <param name="newAppender">The <see cref="T:log4net.Appender.IAppender"/> to add to this appender.</param> + <remarks> + <para> + If the specified <see cref="T:log4net.Appender.IAppender"/> is already in the list of + appenders, then it won't be added again. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.BufferingForwardingAppender.GetAppender(System.String)"> + <summary> + Looks for the appender with the specified name. + </summary> + <param name="name">The name of the appender to lookup.</param> + <returns> + The appender with the specified name, or <c>null</c>. + </returns> + <remarks> + <para> + Get the named appender attached to this buffering appender. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.BufferingForwardingAppender.RemoveAllAppenders"> + <summary> + Removes all previously added appenders from this appender. + </summary> + <remarks> + <para> + This is useful when re-reading configuration information. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.BufferingForwardingAppender.RemoveAppender(log4net.Appender.IAppender)"> + <summary> + Removes the specified appender from the list of appenders. + </summary> + <param name="appender">The appender to remove.</param> + <returns>The appender removed from the list</returns> + <remarks> + The appender removed is not closed. + If you are discarding the appender you must call + <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed. + </remarks> + </member> + <member name="M:log4net.Appender.BufferingForwardingAppender.RemoveAppender(System.String)"> + <summary> + Removes the appender with the specified name from the list of appenders. + </summary> + <param name="name">The name of the appender to remove.</param> + <returns>The appender removed from the list</returns> + <remarks> + The appender removed is not closed. + If you are discarding the appender you must call + <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed. + </remarks> + </member> + <member name="F:log4net.Appender.BufferingForwardingAppender.m_appenderAttachedImpl"> + <summary> + Implementation of the <see cref="T:log4net.Core.IAppenderAttachable"/> interface + </summary> + </member> + <member name="P:log4net.Appender.BufferingForwardingAppender.Appenders"> + <summary> + Gets the appenders contained in this appender as an + <see cref="T:System.Collections.ICollection"/>. + </summary> + <remarks> + If no appenders can be found, then an <see cref="T:log4net.Util.EmptyCollection"/> + is returned. + </remarks> + <returns> + A collection of the appenders in this appender. + </returns> + </member> + <member name="T:log4net.Appender.ColoredConsoleAppender"> + <summary> + Appends logging events to the console. + </summary> + <remarks> + <para> + ColoredConsoleAppender appends log events to the standard output stream + or the error output stream using a layout specified by the + user. It also allows the color of a specific type of message to be set. + </para> + <para> + By default, all output is written to the console's standard output stream. + The <see cref="P:log4net.Appender.ColoredConsoleAppender.Target"/> property can be set to direct the output to the + error stream. + </para> + <para> + NOTE: This appender writes directly to the application's attached console + not to the <c>System.Console.Out</c> or <c>System.Console.Error</c> <c>TextWriter</c>. + The <c>System.Console.Out</c> and <c>System.Console.Error</c> streams can be + programmatically redirected (for example NUnit does this to capture program output). + This appender will ignore these redirections because it needs to use Win32 + API calls to colorize the output. To respect these redirections the <see cref="T:log4net.Appender.ConsoleAppender"/> + must be used. + </para> + <para> + When configuring the colored console appender, mapping should be + specified to map a logging level to a color. For example: + </para> + <code lang="XML" escaped="true"> + <mapping> + <level value="ERROR"/> + <foreColor value="White"/> + <backColor value="Red, HighIntensity"/> + </mapping> + <mapping> + <level value="DEBUG"/> + <backColor value="Green"/> + </mapping> + </code> + <para> + The Level is the standard log4net logging level and ForeColor and BackColor can be any + combination of the following values: + <list type="bullet"> + <item><term>Blue</term><description></description></item> + <item><term>Green</term><description></description></item> + <item><term>Red</term><description></description></item> + <item><term>White</term><description></description></item> + <item><term>Yellow</term><description></description></item> + <item><term>Purple</term><description></description></item> + <item><term>Cyan</term><description></description></item> + <item><term>HighIntensity</term><description></description></item> + </list> + </para> + </remarks> + <author>Rick Hobbs</author> + <author>Nicko Cadell</author> + </member> + <member name="F:log4net.Appender.ColoredConsoleAppender.ConsoleOut"> + <summary> + The <see cref="P:log4net.Appender.ColoredConsoleAppender.Target"/> to use when writing to the Console + standard output stream. + </summary> + <remarks> + <para> + The <see cref="P:log4net.Appender.ColoredConsoleAppender.Target"/> to use when writing to the Console + standard output stream. + </para> + </remarks> + </member> + <member name="F:log4net.Appender.ColoredConsoleAppender.ConsoleError"> + <summary> + The <see cref="P:log4net.Appender.ColoredConsoleAppender.Target"/> to use when writing to the Console + standard error output stream. + </summary> + <remarks> + <para> + The <see cref="P:log4net.Appender.ColoredConsoleAppender.Target"/> to use when writing to the Console + standard error output stream. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.ColoredConsoleAppender.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:log4net.Appender.ColoredConsoleAppender"/> class. + </summary> + <remarks> + The instance of the <see cref="T:log4net.Appender.ColoredConsoleAppender"/> class is set up to write + to the standard output stream. + </remarks> + </member> + <member name="M:log4net.Appender.ColoredConsoleAppender.#ctor(log4net.Layout.ILayout)"> + <summary> + Initializes a new instance of the <see cref="T:log4net.Appender.ColoredConsoleAppender"/> class + with the specified layout. + </summary> + <param name="layout">the layout to use for this appender</param> + <remarks> + The instance of the <see cref="T:log4net.Appender.ColoredConsoleAppender"/> class is set up to write + to the standard output stream. + </remarks> + </member> + <member name="M:log4net.Appender.ColoredConsoleAppender.#ctor(log4net.Layout.ILayout,System.Boolean)"> + <summary> + Initializes a new instance of the <see cref="T:log4net.Appender.ColoredConsoleAppender"/> class + with the specified layout. + </summary> + <param name="layout">the layout to use for this appender</param> + <param name="writeToErrorStream">flag set to <c>true</c> to write to the console error stream</param> + <remarks> + When <paramref name="writeToErrorStream"/> is set to <c>true</c>, output is written to + the standard error output stream. Otherwise, output is written to the standard + output stream. + </remarks> + </member> + <member name="M:log4net.Appender.ColoredConsoleAppender.AddMapping(log4net.Appender.ColoredConsoleAppender.LevelColors)"> + <summary> + Add a mapping of level to color - done by the config file + </summary> + <param name="mapping">The mapping to add</param> + <remarks> + <para> + Add a <see cref="T:log4net.Appender.ColoredConsoleAppender.LevelColors"/> mapping to this appender. + Each mapping defines the foreground and background colors + for a level. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.ColoredConsoleAppender.Append(log4net.Core.LoggingEvent)"> + <summary> + This method is called by the <see cref="M:AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent)"/> method. + </summary> + <param name="loggingEvent">The event to log.</param> + <remarks> + <para> + Writes the event to the console. + </para> + <para> + The format of the output will depend on the appender's layout. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.ColoredConsoleAppender.ActivateOptions"> + <summary> + Initialize the options for this appender + </summary> + <remarks> + <para> + Initialize the level to color mappings set on this appender. + </para> + </remarks> + </member> + <member name="F:log4net.Appender.ColoredConsoleAppender.m_writeToErrorStream"> + <summary> + Flag to write output to the error stream rather than the standard output stream + </summary> + </member> + <member name="F:log4net.Appender.ColoredConsoleAppender.m_levelMapping"> + <summary> + Mapping from level object to color value + </summary> + </member> + <member name="F:log4net.Appender.ColoredConsoleAppender.m_consoleOutputWriter"> + <summary> + The console output stream writer to write to + </summary> + <remarks> + <para> + This writer is not thread safe. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.ColoredConsoleAppender.Target"> + <summary> + Target is the value of the console output stream. + This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>. + </summary> + <value> + Target is the value of the console output stream. + This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>. + </value> + <remarks> + <para> + Target is the value of the console output stream. + This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.ColoredConsoleAppender.RequiresLayout"> + <summary> + This appender requires a <see cref="N:log4net.Layout"/> to be set. + </summary> + <value><c>true</c></value> + <remarks> + <para> + This appender requires a <see cref="N:log4net.Layout"/> to be set. + </para> + </remarks> + </member> + <member name="T:log4net.Appender.ColoredConsoleAppender.Colors"> + <summary> + The enum of possible color values for use with the color mapping method + </summary> + <remarks> + <para> + The following flags can be combined together to + form the colors. + </para> + </remarks> + <seealso cref="T:log4net.Appender.ColoredConsoleAppender"/> + </member> + <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Blue"> + <summary> + color is blue + </summary> + </member> + <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Green"> + <summary> + color is green + </summary> + </member> + <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Red"> + <summary> + color is red + </summary> + </member> + <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.White"> + <summary> + color is white + </summary> + </member> + <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Yellow"> + <summary> + color is yellow + </summary> + </member> + <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Purple"> + <summary> + color is purple + </summary> + </member> + <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Cyan"> + <summary> + color is cyan + </summary> + </member> + <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.HighIntensity"> + <summary> + color is intensified + </summary> + </member> + <member name="T:log4net.Appender.ColoredConsoleAppender.LevelColors"> + <summary> + A class to act as a mapping between the level that a logging call is made at and + the color it should be displayed as. + </summary> + <remarks> + <para> + Defines the mapping between a level and the color it should be displayed in. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.ColoredConsoleAppender.LevelColors.ActivateOptions"> + <summary> + Initialize the options for the object + </summary> + <remarks> + <para> + Combine the <see cref="P:log4net.Appender.ColoredConsoleAppender.LevelColors.ForeColor"/> and <see cref="P:log4net.Appender.ColoredConsoleAppender.LevelColors.BackColor"/> together. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.ColoredConsoleAppender.LevelColors.ForeColor"> + <summary> + The mapped foreground color for the specified level + </summary> + <remarks> + <para> + Required property. + The mapped foreground color for the specified level. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.ColoredConsoleAppender.LevelColors.BackColor"> + <summary> + The mapped background color for the specified level + </summary> + <remarks> + <para> + Required property. + The mapped background color for the specified level. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.ColoredConsoleAppender.LevelColors.CombinedColor"> + <summary> + The combined <see cref="P:log4net.Appender.ColoredConsoleAppender.LevelColors.ForeColor"/> and <see cref="P:log4net.Appender.ColoredConsoleAppender.LevelColors.BackColor"/> suitable for + setting the console color. + </summary> + </member> + <member name="T:log4net.Appender.ConsoleAppender"> + <summary> + Appends logging events to the console. + </summary> + <remarks> + <para> + ConsoleAppender appends log events to the standard output stream + or the error output stream using a layout specified by the + user. + </para> + <para> + By default, all output is written to the console's standard output stream. + The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> property can be set to direct the output to the + error stream. + </para> + <para> + NOTE: This appender writes each message to the <c>System.Console.Out</c> or + <c>System.Console.Error</c> that is set at the time the event is appended. + Therefore it is possible to programmatically redirect the output of this appender + (for example NUnit does this to capture program output). While this is the desired + behavior of this appender it may have security implications in your application. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="F:log4net.Appender.ConsoleAppender.ConsoleOut"> + <summary> + The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> to use when writing to the Console + standard output stream. + </summary> + <remarks> + <para> + The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> to use when writing to the Console + standard output stream. + </para> + </remarks> + </member> + <member name="F:log4net.Appender.ConsoleAppender.ConsoleError"> + <summary> + The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> to use when writing to the Console + standard error output stream. + </summary> + <remarks> + <para> + The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> to use when writing to the Console + standard error output stream. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.ConsoleAppender.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:log4net.Appender.ConsoleAppender"/> class. + </summary> + <remarks> + The instance of the <see cref="T:log4net.Appender.ConsoleAppender"/> class is set up to write + to the standard output stream. + </remarks> + </member> + <member name="M:log4net.Appender.ConsoleAppender.#ctor(log4net.Layout.ILayout)"> + <summary> + Initializes a new instance of the <see cref="T:log4net.Appender.ConsoleAppender"/> class + with the specified layout. + </summary> + <param name="layout">the layout to use for this appender</param> + <remarks> + The instance of the <see cref="T:log4net.Appender.ConsoleAppender"/> class is set up to write + to the standard output stream. + </remarks> + </member> + <member name="M:log4net.Appender.ConsoleAppender.#ctor(log4net.Layout.ILayout,System.Boolean)"> + <summary> + Initializes a new instance of the <see cref="T:log4net.Appender.ConsoleAppender"/> class + with the specified layout. + </summary> + <param name="layout">the layout to use for this appender</param> + <param name="writeToErrorStream">flag set to <c>true</c> to write to the console error stream</param> + <remarks> + When <paramref name="writeToErrorStream"/> is set to <c>true</c>, output is written to + the standard error output stream. Otherwise, output is written to the standard + output stream. + </remarks> + </member> + <member name="M:log4net.Appender.ConsoleAppender.Append(log4net.Core.LoggingEvent)"> + <summary> + This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method. + </summary> + <param name="loggingEvent">The event to log.</param> + <remarks> + <para> + Writes the event to the console. + </para> + <para> + The format of the output will depend on the appender's layout. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.ConsoleAppender.Target"> + <summary> + Target is the value of the console output stream. + This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>. + </summary> + <value> + Target is the value of the console output stream. + This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>. + </value> + <remarks> + <para> + Target is the value of the console output stream. + This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.ConsoleAppender.RequiresLayout"> + <summary> + This appender requires a <see cref="N:log4net.Layout"/> to be set. + </summary> + <value><c>true</c></value> + <remarks> + <para> + This appender requires a <see cref="N:log4net.Layout"/> to be set. + </para> + </remarks> + </member> + <member name="T:log4net.Appender.DebugAppender"> + <summary> + Appends log events to the <see cref="T:System.Diagnostics.Debug"/> system. + </summary> + <remarks> + <para> + The application configuration file can be used to control what listeners + are actually used. See the MSDN documentation for the + <see cref="T:System.Diagnostics.Debug"/> class for details on configuring the + debug system. + </para> + <para> + Events are written using the <see cref="M:System.Diagnostics.Debug.Write(string,string)"/> + method. The event's logger name is passed as the value for the category name to the Write method. + </para> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="M:log4net.Appender.DebugAppender.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:log4net.Appender.DebugAppender"/>. + </summary> + <remarks> + <para> + Default constructor. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.DebugAppender.#ctor(log4net.Layout.ILayout)"> + <summary> + Initializes a new instance of the <see cref="T:log4net.Appender.DebugAppender"/> + with a specified layout. + </summary> + <param name="layout">The layout to use with this appender.</param> + <remarks> + <para> + Obsolete constructor. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.DebugAppender.Append(log4net.Core.LoggingEvent)"> + <summary> + Writes the logging event to the <see cref="T:System.Diagnostics.Debug"/> system. + </summary> + <param name="loggingEvent">The event to log.</param> + <remarks> + <para> + Writes the logging event to the <see cref="T:System.Diagnostics.Debug"/> system. + If <see cref="P:log4net.Appender.DebugAppender.ImmediateFlush"/> is <c>true</c> then the <see cref="M:System.Diagnostics.Debug.Flush"/> + is called. + </para> + </remarks> + </member> + <member name="F:log4net.Appender.DebugAppender.m_immediateFlush"> + <summary> + Immediate flush means that the underlying writer or output stream + will be flushed at the end of each append operation. + </summary> + <remarks> + <para> + Immediate flush is slower but ensures that each append request is + actually written. If <see cref="P:log4net.Appender.DebugAppender.ImmediateFlush"/> is set to + <c>false</c>, then there is a good chance that the last few + logs events are not actually written to persistent media if and + when the application crashes. + </para> + <para> + The default value is <c>true</c>.</para> + </remarks> + </member> + <member name="P:log4net.Appender.DebugAppender.ImmediateFlush"> + <summary> + Gets or sets a value that indicates whether the appender will + flush at the end of each write. + </summary> + <remarks> + <para>The default behavior is to flush at the end of each + write. If the option is set to<c>false</c>, then the underlying + stream can defer writing to physical medium to a later time. + </para> + <para> + Avoiding the flush operation at the end of each append results + in a performance gain of 10 to 20 percent. However, there is safety + trade-off involved in skipping flushing. Indeed, when flushing is + skipped, then it is likely that the last few log events will not + be recorded on disk when the application exits. This is a high + price to pay even for a 20% performance gain. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.DebugAppender.RequiresLayout"> + <summary> + This appender requires a <see cref="N:log4net.Layout"/> to be set. + </summary> + <value><c>true</c></value> + <remarks> + <para> + This appender requires a <see cref="N:log4net.Layout"/> to be set. + </para> + </remarks> + </member> + <member name="T:log4net.Appender.EventLogAppender"> + <summary> + Writes events to the system event log. + </summary> + <remarks> + <para> + The appender will fail if you try to write using an event source that doesn't exist unless it is running with local administrator privileges. + See also http://logging.apache.org/log4net/release/faq.html#trouble-EventLog + </para> + <para> + The <c>EventID</c> of the event log entry can be + set using the <c>EventID</c> property (<see cref="P:log4net.Core.LoggingEvent.Properties"/>) + on the <see cref="T:log4net.Core.LoggingEvent"/>. + </para> + <para> + The <c>Category</c> of the event log entry can be + set using the <c>Category</c> property (<see cref="P:log4net.Core.LoggingEvent.Properties"/>) + on the <see cref="T:log4net.Core.LoggingEvent"/>. + </para> + <para> + There is a limit of 32K characters for an event log message + </para> + <para> + When configuring the EventLogAppender a mapping can be + specified to map a logging level to an event log entry type. For example: + </para> + <code lang="XML"> + <mapping> + <level value="ERROR" /> + <eventLogEntryType value="Error" /> + </mapping> + <mapping> + <level value="DEBUG" /> + <eventLogEntryType value="Information" /> + </mapping> + </code> + <para> + The Level is the standard log4net logging level and eventLogEntryType can be any value + from the <see cref="T:System.Diagnostics.EventLogEntryType"/> enum, i.e.: + <list type="bullet"> + <item><term>Error</term><description>an error event</description></item> + <item><term>Warning</term><description>a warning event</description></item> + <item><term>Information</term><description>an informational event</description></item> + </list> + </para> + </remarks> + <author>Aspi Havewala</author> + <author>Douglas de la Torre</author> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + <author>Thomas Voss</author> + </member> + <member name="M:log4net.Appender.EventLogAppender.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:log4net.Appender.EventLogAppender"/> class. + </summary> + <remarks> + <para> + Default constructor. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.EventLogAppender.#ctor(log4net.Layout.ILayout)"> + <summary> + Initializes a new instance of the <see cref="T:log4net.Appender.EventLogAppender"/> class + with the specified <see cref="T:log4net.Layout.ILayout"/>. + </summary> + <param name="layout">The <see cref="T:log4net.Layout.ILayout"/> to use with this appender.</param> + <remarks> + <para> + Obsolete constructor. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.EventLogAppender.AddMapping(log4net.Appender.EventLogAppender.Level2EventLogEntryType)"> + <summary> + Add a mapping of level to <see cref="T:System.Diagnostics.EventLogEntryType"/> - done by the config file + </summary> + <param name="mapping">The mapping to add</param> + <remarks> + <para> + Add a <see cref="T:log4net.Appender.EventLogAppender.Level2EventLogEntryType"/> mapping to this appender. + Each mapping defines the event log entry type for a level. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.EventLogAppender.ActivateOptions"> + <summary> + Initialize the appender based on the options set + </summary> + <remarks> + <para> + This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object + activation scheme. The <see cref="M:log4net.Appender.EventLogAppender.ActivateOptions"/> method must + be called on this object after the configuration properties have + been set. Until <see cref="M:log4net.Appender.EventLogAppender.ActivateOptions"/> is called this + object is in an undefined state and must not be used. + </para> + <para> + If any of the configuration properties are modified then + <see cref="M:log4net.Appender.EventLogAppender.ActivateOptions"/> must be called again. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.EventLogAppender.CreateEventSource(System.String,System.String,System.String)"> + <summary> + Create an event log source + </summary> + <remarks> + Uses different API calls under NET_2_0 + </remarks> + </member> + <member name="M:log4net.Appender.EventLogAppender.Append(log4net.Core.LoggingEvent)"> + <summary> + This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> + method. + </summary> + <param name="loggingEvent">the event to log</param> + <remarks> + <para>Writes the event to the system event log using the + <see cref="P:log4net.Appender.EventLogAppender.ApplicationName"/>.</para> + + <para>If the event has an <c>EventID</c> property (see <see cref="P:log4net.Core.LoggingEvent.Properties"/>) + set then this integer will be used as the event log event id.</para> + + <para> + There is a limit of 32K characters for an event log message + </para> + </remarks> + </member> + <member name="M:log4net.Appender.EventLogAppender.GetEntryType(log4net.Core.Level)"> + <summary> + Get the equivalent <see cref="T:System.Diagnostics.EventLogEntryType"/> for a <see cref="T:log4net.Core.Level"/> <paramref name="level"/> + </summary> + <param name="level">the Level to convert to an EventLogEntryType</param> + <returns>The equivalent <see cref="T:System.Diagnostics.EventLogEntryType"/> for a <see cref="T:log4net.Core.Level"/> <paramref name="level"/></returns> + <remarks> + Because there are fewer applicable <see cref="T:System.Diagnostics.EventLogEntryType"/> + values to use in logging levels than there are in the + <see cref="T:log4net.Core.Level"/> this is a one way mapping. There is + a loss of information during the conversion. + </remarks> + </member> + <member name="F:log4net.Appender.EventLogAppender.m_logName"> + <summary> + The log name is the section in the event logs where the messages + are stored. + </summary> + </member> + <member name="F:log4net.Appender.EventLogAppender.m_applicationName"> + <summary> + Name of the application to use when logging. This appears in the + application column of the event log named by <see cref="F:log4net.Appender.EventLogAppender.m_logName"/>. + </summary> + </member> + <member name="F:log4net.Appender.EventLogAppender.m_machineName"> + <summary> + The name of the machine which holds the event log. This is + currently only allowed to be '.' i.e. the current machine. + </summary> + </member> + <member name="F:log4net.Appender.EventLogAppender.m_levelMapping"> + <summary> + Mapping from level object to EventLogEntryType + </summary> + </member> + <member name="F:log4net.Appender.EventLogAppender.m_securityContext"> + <summary> + The security context to use for privileged calls + </summary> + </member> + <member name="F:log4net.Appender.EventLogAppender.m_eventId"> + <summary> + The event ID to use unless one is explicitly specified via the <c>LoggingEvent</c>'s properties. + </summary> + </member> + <member name="F:log4net.Appender.EventLogAppender.m_category"> + <summary> + The event category to use unless one is explicitly specified via the <c>LoggingEvent</c>'s properties. + </summary> + </member> + <member name="F:log4net.Appender.EventLogAppender.declaringType"> + <summary> + The fully qualified type of the EventLogAppender class. + </summary> + <remarks> + Used by the internal logger to record the Type of the + log message. + </remarks> + </member> + <member name="F:log4net.Appender.EventLogAppender.MAX_EVENTLOG_MESSAGE_SIZE_DEFAULT"> + <summary> + The maximum size supported by default. + </summary> + <remarks> + http://msdn.microsoft.com/en-us/library/xzwc042w(v=vs.100).aspx + The 32766 documented max size is two bytes shy of 32K (I'm assuming 32766 + may leave space for a two byte null terminator of #0#0). The 32766 max + length is what the .NET 4.0 source code checks for, but this is WRONG! + Strings with a length > 31839 on Windows Vista or higher can CORRUPT + the event log! See: System.Diagnostics.EventLogInternal.InternalWriteEvent() + for the use of the 32766 max size. + </remarks> + </member> + <member name="F:log4net.Appender.EventLogAppender.MAX_EVENTLOG_MESSAGE_SIZE_VISTA_OR_NEWER"> + <summary> + The maximum size supported by a windows operating system that is vista + or newer. + </summary> + <remarks> + See ReportEvent API: + http://msdn.microsoft.com/en-us/library/aa363679(VS.85).aspx + ReportEvent's lpStrings parameter: + "A pointer to a buffer containing an array of + null-terminated strings that are merged into the message before Event Viewer + displays the string to the user. This parameter must be a valid pointer + (or NULL), even if wNumStrings is zero. Each string is limited to 31,839 characters." + + Going beyond the size of 31839 will (at some point) corrupt the event log on Windows + Vista or higher! It may succeed for a while...but you will eventually run into the + error: "System.ComponentModel.Win32Exception : A device attached to the system is + not functioning", and the event log will then be corrupt (I was able to corrupt + an event log using a length of 31877 on Windows 7). + + The max size for Windows Vista or higher is documented here: + http://msdn.microsoft.com/en-us/library/xzwc042w(v=vs.100).aspx. + Going over this size may succeed a few times but the buffer will overrun and + eventually corrupt the log (based on testing). + + The maxEventMsgSize size is based on the max buffer size of the lpStrings parameter of the ReportEvent API. + The documented max size for EventLog.WriteEntry for Windows Vista and higher is 31839, but I'm leaving room for a + terminator of #0#0, as we cannot see the source of ReportEvent (though we could use an API monitor to examine the + buffer, given enough time). + </remarks> + </member> + <member name="F:log4net.Appender.EventLogAppender.MAX_EVENTLOG_MESSAGE_SIZE"> + <summary> + The maximum size that the operating system supports for + a event log message. + </summary> + <remarks> + Used to determine the maximum string length that can be written + to the operating system event log and eventually truncate a string + that exceeds the limits. + </remarks> + </member> + <member name="M:log4net.Appender.EventLogAppender.GetMaxEventLogMessageSize"> + <summary> + This method determines the maximum event log message size allowed for + the current environment. + </summary> + <returns></returns> + </member> + <member name="P:log4net.Appender.EventLogAppender.LogName"> + <summary> + The name of the log where messages will be stored. + </summary> + <value> + The string name of the log where messages will be stored. + </value> + <remarks> + <para>This is the name of the log as it appears in the Event Viewer + tree. The default value is to log into the <c>Application</c> + log, this is where most applications write their events. However + if you need a separate log for your application (or applications) + then you should set the <see cref="P:log4net.Appender.EventLogAppender.LogName"/> appropriately.</para> + <para>This should not be used to distinguish your event log messages + from those of other applications, the <see cref="P:log4net.Appender.EventLogAppender.ApplicationName"/> + property should be used to distinguish events. This property should be + used to group together events into a single log. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.EventLogAppender.ApplicationName"> + <summary> + Property used to set the Application name. This appears in the + event logs when logging. + </summary> + <value> + The string used to distinguish events from different sources. + </value> + <remarks> + Sets the event log source property. + </remarks> + </member> + <member name="P:log4net.Appender.EventLogAppender.MachineName"> + <summary> + This property is used to return the name of the computer to use + when accessing the event logs. Currently, this is the current + computer, denoted by a dot "." + </summary> + <value> + The string name of the machine holding the event log that + will be logged into. + </value> + <remarks> + This property cannot be changed. It is currently set to '.' + i.e. the local machine. This may be changed in future. + </remarks> + </member> + <member name="P:log4net.Appender.EventLogAppender.SecurityContext"> + <summary> + Gets or sets the <see cref="P:log4net.Appender.EventLogAppender.SecurityContext"/> used to write to the EventLog. + </summary> + <value> + The <see cref="P:log4net.Appender.EventLogAppender.SecurityContext"/> used to write to the EventLog. + </value> + <remarks> + <para> + The system security context used to write to the EventLog. + </para> + <para> + Unless a <see cref="P:log4net.Appender.EventLogAppender.SecurityContext"/> specified here for this appender + the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is queried for the + security context to use. The default behavior is to use the security context + of the current thread. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.EventLogAppender.EventId"> + <summary> + Gets or sets the <c>EventId</c> to use unless one is explicitly specified via the <c>LoggingEvent</c>'s properties. + </summary> + <remarks> + <para> + The <c>EventID</c> of the event log entry will normally be + set using the <c>EventID</c> property (<see cref="P:log4net.Core.LoggingEvent.Properties"/>) + on the <see cref="T:log4net.Core.LoggingEvent"/>. + This property provides the fallback value which defaults to 0. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.EventLogAppender.Category"> + <summary> + Gets or sets the <c>Category</c> to use unless one is explicitly specified via the <c>LoggingEvent</c>'s properties. + </summary> + <remarks> + <para> + The <c>Category</c> of the event log entry will normally be + set using the <c>Category</c> property (<see cref="P:log4net.Core.LoggingEvent.Properties"/>) + on the <see cref="T:log4net.Core.LoggingEvent"/>. + This property provides the fallback value which defaults to 0. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.EventLogAppender.RequiresLayout"> + <summary> + This appender requires a <see cref="N:log4net.Layout"/> to be set. + </summary> + <value><c>true</c></value> + <remarks> + <para> + This appender requires a <see cref="N:log4net.Layout"/> to be set. + </para> + </remarks> + </member> + <member name="T:log4net.Appender.EventLogAppender.Level2EventLogEntryType"> + <summary> + A class to act as a mapping between the level that a logging call is made at and + the color it should be displayed as. + </summary> + <remarks> + <para> + Defines the mapping between a level and its event log entry type. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.EventLogAppender.Level2EventLogEntryType.EventLogEntryType"> + <summary> + The <see cref="P:log4net.Appender.EventLogAppender.Level2EventLogEntryType.EventLogEntryType"/> for this entry + </summary> + <remarks> + <para> + Required property. + The <see cref="P:log4net.Appender.EventLogAppender.Level2EventLogEntryType.EventLogEntryType"/> for this entry + </para> + </remarks> + </member> + <member name="T:log4net.Appender.FileAppender"> + <summary> + Appends logging events to a file. + </summary> + <remarks> + <para> + Logging events are sent to the file specified by + the <see cref="P:log4net.Appender.FileAppender.File"/> property. + </para> + <para> + The file can be opened in either append or overwrite mode + by specifying the <see cref="P:log4net.Appender.FileAppender.AppendToFile"/> property. + If the file path is relative it is taken as relative from + the application base directory. The file encoding can be + specified by setting the <see cref="P:log4net.Appender.FileAppender.Encoding"/> property. + </para> + <para> + The layout's <see cref="P:log4net.Layout.ILayout.Header"/> and <see cref="P:log4net.Layout.ILayout.Footer"/> + values will be written each time the file is opened and closed + respectively. If the <see cref="P:log4net.Appender.FileAppender.AppendToFile"/> property is <see langword="true"/> + then the file may contain multiple copies of the header and footer. + </para> + <para> + This appender will first try to open the file for writing when <see cref="M:log4net.Appender.FileAppender.ActivateOptions"/> + is called. This will typically be during configuration. + If the file cannot be opened for writing the appender will attempt + to open the file again each time a message is logged to the appender. + If the file cannot be opened for writing when a message is logged then + the message will be discarded by this appender. + </para> + <para> + The <see cref="T:log4net.Appender.FileAppender"/> supports pluggable file locking models via + the <see cref="P:log4net.Appender.FileAppender.LockingModel"/> property. + The default behavior, implemented by <see cref="T:log4net.Appender.FileAppender.ExclusiveLock"/> + is to obtain an exclusive write lock on the file until this appender is closed. + The alternative models only hold a + write lock while the appender is writing a logging event (<see cref="T:log4net.Appender.FileAppender.MinimalLock"/>) + or synchronize by using a named system wide Mutex (<see cref="T:log4net.Appender.FileAppender.InterProcessLock"/>). + </para> + <para> + All locking strategies have issues and you should seriously consider using a different strategy that + avoids having multiple processes logging to the same file. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + <author>Rodrigo B. de Oliveira</author> + <author>Douglas de la Torre</author> + <author>Niall Daley</author> + </member> + <member name="T:log4net.Appender.TextWriterAppender"> + <summary> + Sends logging events to a <see cref="T:System.IO.TextWriter"/>. + </summary> + <remarks> + <para> + An Appender that writes to a <see cref="T:System.IO.TextWriter"/>. + </para> + <para> + This appender may be used stand alone if initialized with an appropriate + writer, however it is typically used as a base class for an appender that + can open a <see cref="T:System.IO.TextWriter"/> to write to. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + <author>Douglas de la Torre</author> + </member> + <member name="M:log4net.Appender.TextWriterAppender.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:log4net.Appender.TextWriterAppender"/> class. + </summary> + <remarks> + <para> + Default constructor. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.TextWriterAppender.#ctor(log4net.Layout.ILayout,System.IO.Stream)"> + <summary> + Initializes a new instance of the <see cref="T:log4net.Appender.TextWriterAppender"/> class and + sets the output destination to a new <see cref="T:System.IO.StreamWriter"/> initialized + with the specified <see cref="T:System.IO.Stream"/>. + </summary> + <param name="layout">The layout to use with this appender.</param> + <param name="os">The <see cref="T:System.IO.Stream"/> to output to.</param> + <remarks> + <para> + Obsolete constructor. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.TextWriterAppender.#ctor(log4net.Layout.ILayout,System.IO.TextWriter)"> + <summary> + Initializes a new instance of the <see cref="T:log4net.Appender.TextWriterAppender"/> class and sets + the output destination to the specified <see cref="T:System.IO.StreamWriter"/>. + </summary> + <param name="layout">The layout to use with this appender</param> + <param name="writer">The <see cref="T:System.IO.TextWriter"/> to output to</param> + <remarks> + The <see cref="T:System.IO.TextWriter"/> must have been previously opened. + </remarks> + <remarks> + <para> + Obsolete constructor. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.TextWriterAppender.PreAppendCheck"> + <summary> + This method determines if there is a sense in attempting to append. + </summary> + <remarks> + <para> + This method checks if an output target has been set and if a + layout has been set. + </para> + </remarks> + <returns><c>false</c> if any of the preconditions fail.</returns> + </member> + <member name="M:log4net.Appender.TextWriterAppender.Append(log4net.Core.LoggingEvent)"> + <summary> + This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> + method. + </summary> + <param name="loggingEvent">The event to log.</param> + <remarks> + <para> + Writes a log statement to the output stream if the output stream exists + and is writable. + </para> + <para> + The format of the output will depend on the appender's layout. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.TextWriterAppender.Append(log4net.Core.LoggingEvent[])"> + <summary> + This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent[])"/> + method. + </summary> + <param name="loggingEvents">The array of events to log.</param> + <remarks> + <para> + This method writes all the bulk logged events to the output writer + before flushing the stream. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.TextWriterAppender.OnClose"> + <summary> + Close this appender instance. The underlying stream or writer is also closed. + </summary> + <remarks> + Closed appenders cannot be reused. + </remarks> + </member> + <member name="M:log4net.Appender.TextWriterAppender.WriteFooterAndCloseWriter"> + <summary> + Writes the footer and closes the underlying <see cref="T:System.IO.TextWriter"/>. + </summary> + <remarks> + <para> + Writes the footer and closes the underlying <see cref="T:System.IO.TextWriter"/>. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.TextWriterAppender.CloseWriter"> + <summary> + Closes the underlying <see cref="T:System.IO.TextWriter"/>. + </summary> + <remarks> + <para> + Closes the underlying <see cref="T:System.IO.TextWriter"/>. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.TextWriterAppender.Reset"> + <summary> + Clears internal references to the underlying <see cref="T:System.IO.TextWriter"/> + and other variables. + </summary> + <remarks> + <para> + Subclasses can override this method for an alternate closing behavior. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.TextWriterAppender.WriteFooter"> + <summary> + Writes a footer as produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Footer"/> property. + </summary> + <remarks> + <para> + Writes a footer as produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Footer"/> property. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.TextWriterAppender.WriteHeader"> + <summary> + Writes a header produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Header"/> property. + </summary> + <remarks> + <para> + Writes a header produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Header"/> property. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.TextWriterAppender.PrepareWriter"> + <summary> + Called to allow a subclass to lazily initialize the writer + </summary> + <remarks> + <para> + This method is called when an event is logged and the <see cref="P:log4net.Appender.TextWriterAppender.Writer"/> or + <see cref="P:log4net.Appender.TextWriterAppender.QuietWriter"/> have not been set. This allows a subclass to + attempt to initialize the writer multiple times. + </para> + </remarks> + </member> + <member name="F:log4net.Appender.TextWriterAppender.m_qtw"> + <summary> + This is the <see cref="T:log4net.Util.QuietTextWriter"/> where logging events + will be written to. + </summary> + </member> + <member name="F:log4net.Appender.TextWriterAppender.m_immediateFlush"> + <summary> + Immediate flush means that the underlying <see cref="T:System.IO.TextWriter"/> + or output stream will be flushed at the end of each append operation. + </summary> + <remarks> + <para> + Immediate flush is slower but ensures that each append request is + actually written. If <see cref="P:log4net.Appender.TextWriterAppender.ImmediateFlush"/> is set to + <c>false</c>, then there is a good chance that the last few + logging events are not actually persisted if and when the application + crashes. + </para> + <para> + The default value is <c>true</c>. + </para> + </remarks> + </member> + <member name="F:log4net.Appender.TextWriterAppender.declaringType"> + <summary> + The fully qualified type of the TextWriterAppender class. + </summary> + <remarks> + Used by the internal logger to record the Type of the + log message. + </remarks> + </member> + <member name="P:log4net.Appender.TextWriterAppender.ImmediateFlush"> + <summary> + Gets or set whether the appender will flush at the end + of each append operation. + </summary> + <value> + <para> + The default behavior is to flush at the end of each + append operation. + </para> + <para> + If this option is set to <c>false</c>, then the underlying + stream can defer persisting the logging event to a later + time. + </para> + </value> + <remarks> + Avoiding the flush operation at the end of each append results in + a performance gain of 10 to 20 percent. However, there is safety + trade-off involved in skipping flushing. Indeed, when flushing is + skipped, then it is likely that the last few log events will not + be recorded on disk when the application exits. This is a high + price to pay even for a 20% performance gain. + </remarks> + </member> + <member name="P:log4net.Appender.TextWriterAppender.Writer"> + <summary> + Sets the <see cref="T:System.IO.TextWriter"/> where the log output will go. + </summary> + <remarks> + <para> + The specified <see cref="T:System.IO.TextWriter"/> must be open and writable. + </para> + <para> + The <see cref="T:System.IO.TextWriter"/> will be closed when the appender + instance is closed. + </para> + <para> + <b>Note:</b> Logging to an unopened <see cref="T:System.IO.TextWriter"/> will fail. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.TextWriterAppender.ErrorHandler"> + <summary> + Gets or set the <see cref="T:log4net.Core.IErrorHandler"/> and the underlying + <see cref="T:log4net.Util.QuietTextWriter"/>, if any, for this appender. + </summary> + <value> + The <see cref="T:log4net.Core.IErrorHandler"/> for this appender. + </value> + </member> + <member name="P:log4net.Appender.TextWriterAppender.RequiresLayout"> + <summary> + This appender requires a <see cref="N:log4net.Layout"/> to be set. + </summary> + <value><c>true</c></value> + <remarks> + <para> + This appender requires a <see cref="N:log4net.Layout"/> to be set. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.TextWriterAppender.QuietWriter"> + <summary> + Gets or sets the <see cref="T:log4net.Util.QuietTextWriter"/> where logging events + will be written to. + </summary> + <value> + The <see cref="T:log4net.Util.QuietTextWriter"/> where logging events are written. + </value> + <remarks> + <para> + This is the <see cref="T:log4net.Util.QuietTextWriter"/> where logging events + will be written to. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.FileAppender.#ctor"> + <summary> + Default constructor + </summary> + <remarks> + <para> + Default constructor + </para> + </remarks> + </member> + <member name="M:log4net.Appender.FileAppender.#ctor(log4net.Layout.ILayout,System.String,System.Boolean)"> + <summary> + Construct a new appender using the layout, file and append mode. + </summary> + <param name="layout">the layout to use with this appender</param> + <param name="filename">the full path to the file to write to</param> + <param name="append">flag to indicate if the file should be appended to</param> + <remarks> + <para> + Obsolete constructor. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.FileAppender.#ctor(log4net.Layout.ILayout,System.String)"> + <summary> + Construct a new appender using the layout and file specified. + The file will be appended to. + </summary> + <param name="layout">the layout to use with this appender</param> + <param name="filename">the full path to the file to write to</param> + <remarks> + <para> + Obsolete constructor. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.FileAppender.ActivateOptions"> + <summary> + Activate the options on the file appender. + </summary> + <remarks> + <para> + This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object + activation scheme. The <see cref="M:log4net.Appender.FileAppender.ActivateOptions"/> method must + be called on this object after the configuration properties have + been set. Until <see cref="M:log4net.Appender.FileAppender.ActivateOptions"/> is called this + object is in an undefined state and must not be used. + </para> + <para> + If any of the configuration properties are modified then + <see cref="M:log4net.Appender.FileAppender.ActivateOptions"/> must be called again. + </para> + <para> + This will cause the file to be opened. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.FileAppender.Reset"> + <summary> + Closes any previously opened file and calls the parent's <see cref="M:log4net.Appender.TextWriterAppender.Reset"/>. + </summary> + <remarks> + <para> + Resets the filename and the file stream. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.FileAppender.PrepareWriter"> + <summary> + Called to initialize the file writer + </summary> + <remarks> + <para> + Will be called for each logged message until the file is + successfully opened. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.FileAppender.Append(log4net.Core.LoggingEvent)"> + <summary> + This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> + method. + </summary> + <param name="loggingEvent">The event to log.</param> + <remarks> + <para> + Writes a log statement to the output stream if the output stream exists + and is writable. + </para> + <para> + The format of the output will depend on the appender's layout. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.FileAppender.Append(log4net.Core.LoggingEvent[])"> + <summary> + This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent[])"/> + method. + </summary> + <param name="loggingEvents">The array of events to log.</param> + <remarks> + <para> + Acquires the output file locks once before writing all the events to + the stream. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.FileAppender.WriteFooter"> + <summary> + Writes a footer as produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Footer"/> property. + </summary> + <remarks> + <para> + Writes a footer as produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Footer"/> property. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.FileAppender.WriteHeader"> + <summary> + Writes a header produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Header"/> property. + </summary> + <remarks> + <para> + Writes a header produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Header"/> property. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.FileAppender.CloseWriter"> + <summary> + Closes the underlying <see cref="T:System.IO.TextWriter"/>. + </summary> + <remarks> + <para> + Closes the underlying <see cref="T:System.IO.TextWriter"/>. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.FileAppender.CloseFile"> + <summary> + Closes the previously opened file. + </summary> + <remarks> + <para> + Writes the <see cref="P:log4net.Layout.ILayout.Footer"/> to the file and then + closes the file. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.FileAppender.SafeOpenFile(System.String,System.Boolean)"> + <summary> + Sets and <i>opens</i> the file where the log output will go. The specified file must be writable. + </summary> + <param name="fileName">The path to the log file. Must be a fully qualified path.</param> + <param name="append">If true will append to fileName. Otherwise will truncate fileName</param> + <remarks> + <para> + Calls <see cref="M:log4net.Appender.FileAppender.OpenFile(System.String,System.Boolean)"/> but guarantees not to throw an exception. + Errors are passed to the <see cref="P:log4net.Appender.TextWriterAppender.ErrorHandler"/>. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.FileAppender.OpenFile(System.String,System.Boolean)"> + <summary> + Sets and <i>opens</i> the file where the log output will go. The specified file must be writable. + </summary> + <param name="fileName">The path to the log file. Must be a fully qualified path.</param> + <param name="append">If true will append to fileName. Otherwise will truncate fileName</param> + <remarks> + <para> + If there was already an opened file, then the previous file + is closed first. + </para> + <para> + This method will ensure that the directory structure + for the <paramref name="fileName"/> specified exists. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.FileAppender.SetQWForFiles(System.IO.Stream)"> + <summary> + Sets the quiet writer used for file output + </summary> + <param name="fileStream">the file stream that has been opened for writing</param> + <remarks> + <para> + This implementation of <see cref="M:SetQWForFiles(Stream)"/> creates a <see cref="T:System.IO.StreamWriter"/> + over the <paramref name="fileStream"/> and passes it to the + <see cref="M:SetQWForFiles(TextWriter)"/> method. + </para> + <para> + This method can be overridden by sub classes that want to wrap the + <see cref="T:System.IO.Stream"/> in some way, for example to encrypt the output + data using a <c>System.Security.Cryptography.CryptoStream</c>. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.FileAppender.SetQWForFiles(System.IO.TextWriter)"> + <summary> + Sets the quiet writer being used. + </summary> + <param name="writer">the writer over the file stream that has been opened for writing</param> + <remarks> + <para> + This method can be overridden by sub classes that want to + wrap the <see cref="T:System.IO.TextWriter"/> in some way. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.FileAppender.ConvertToFullPath(System.String)"> + <summary> + Convert a path into a fully qualified path. + </summary> + <param name="path">The path to convert.</param> + <returns>The fully qualified path.</returns> + <remarks> + <para> + Converts the path specified to a fully + qualified path. If the path is relative it is + taken as relative from the application base + directory. + </para> + </remarks> + </member> + <member name="F:log4net.Appender.FileAppender.m_appendToFile"> + <summary> + Flag to indicate if we should append to the file + or overwrite the file. The default is to append. + </summary> + </member> + <member name="F:log4net.Appender.FileAppender.m_fileName"> + <summary> + The name of the log file. + </summary> + </member> + <member name="F:log4net.Appender.FileAppender.m_encoding"> + <summary> + The encoding to use for the file stream. + </summary> + </member> + <member name="F:log4net.Appender.FileAppender.m_securityContext"> + <summary> + The security context to use for privileged calls + </summary> + </member> + <member name="F:log4net.Appender.FileAppender.m_stream"> + <summary> + The stream to log to. Has added locking semantics + </summary> + </member> + <member name="F:log4net.Appender.FileAppender.m_lockingModel"> + <summary> + The locking model to use + </summary> + </member> + <member name="F:log4net.Appender.FileAppender.declaringType"> + <summary> + The fully qualified type of the FileAppender class. + </summary> + <remarks> + Used by the internal logger to record the Type of the + log message. + </remarks> + </member> + <member name="P:log4net.Appender.FileAppender.File"> + <summary> + Gets or sets the path to the file that logging will be written to. + </summary> + <value> + The path to the file that logging will be written to. + </value> + <remarks> + <para> + If the path is relative it is taken as relative from + the application base directory. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.FileAppender.AppendToFile"> + <summary> + Gets or sets a flag that indicates whether the file should be + appended to or overwritten. + </summary> + <value> + Indicates whether the file should be appended to or overwritten. + </value> + <remarks> + <para> + If the value is set to false then the file will be overwritten, if + it is set to true then the file will be appended to. + </para> + The default value is true. + </remarks> + </member> + <member name="P:log4net.Appender.FileAppender.Encoding"> + <summary> + Gets or sets <see cref="P:log4net.Appender.FileAppender.Encoding"/> used to write to the file. + </summary> + <value> + The <see cref="P:log4net.Appender.FileAppender.Encoding"/> used to write to the file. + </value> + <remarks> + <para> + The default encoding set is <see cref="P:System.Text.Encoding.Default"/> + which is the encoding for the system's current ANSI code page. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.FileAppender.SecurityContext"> + <summary> + Gets or sets the <see cref="P:log4net.Appender.FileAppender.SecurityContext"/> used to write to the file. + </summary> + <value> + The <see cref="P:log4net.Appender.FileAppender.SecurityContext"/> used to write to the file. + </value> + <remarks> + <para> + Unless a <see cref="P:log4net.Appender.FileAppender.SecurityContext"/> specified here for this appender + the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is queried for the + security context to use. The default behavior is to use the security context + of the current thread. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.FileAppender.LockingModel"> + <summary> + Gets or sets the <see cref="P:log4net.Appender.FileAppender.LockingModel"/> used to handle locking of the file. + </summary> + <value> + The <see cref="P:log4net.Appender.FileAppender.LockingModel"/> used to lock the file. + </value> + <remarks> + <para> + Gets or sets the <see cref="P:log4net.Appender.FileAppender.LockingModel"/> used to handle locking of the file. + </para> + <para> + There are three built in locking models, <see cref="T:log4net.Appender.FileAppender.ExclusiveLock"/>, <see cref="T:log4net.Appender.FileAppender.MinimalLock"/> and <see cref="T:log4net.Appender.FileAppender.InterProcessLock"/> . + The first locks the file from the start of logging to the end, the + second locks only for the minimal amount of time when logging each message + and the last synchronizes processes using a named system wide Mutex. + </para> + <para> + The default locking model is the <see cref="T:log4net.Appender.FileAppender.ExclusiveLock"/>. + </para> + </remarks> + </member> + <member name="T:log4net.Appender.FileAppender.LockingStream"> + <summary> + Write only <see cref="T:System.IO.Stream"/> that uses the <see cref="T:log4net.Appender.FileAppender.LockingModelBase"/> + to manage access to an underlying resource. + </summary> + </member> + <member name="M:log4net.Appender.FileAppender.LockingStream.BeginWrite(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)"> + <summary> + True asynchronous writes are not supported, the implementation forces a synchronous write. + </summary> + </member> + <member name="T:log4net.Core.LogException"> + <summary> + Exception base type for log4net. + </summary> + <remarks> + <para> + This type extends <see cref="T:System.ApplicationException"/>. It + does not add any new functionality but does differentiate the + type of exception being thrown. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Core.LogException.#ctor"> + <summary> + Constructor + </summary> + <remarks> + <para> + Initializes a new instance of the <see cref="T:log4net.Core.LogException"/> class. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LogException.#ctor(System.String)"> + <summary> + Constructor + </summary> + <param name="message">A message to include with the exception.</param> + <remarks> + <para> + Initializes a new instance of the <see cref="T:log4net.Core.LogException"/> class with + the specified message. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LogException.#ctor(System.String,System.Exception)"> + <summary> + Constructor + </summary> + <param name="message">A message to include with the exception.</param> + <param name="innerException">A nested exception to include.</param> + <remarks> + <para> + Initializes a new instance of the <see cref="T:log4net.Core.LogException"/> class + with the specified message and inner exception. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LogException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> + <summary> + Serialization constructor + </summary> + <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param> + <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param> + <remarks> + <para> + Initializes a new instance of the <see cref="T:log4net.Core.LogException"/> class + with serialized data. + </para> + </remarks> + </member> + <member name="T:log4net.Appender.FileAppender.LockingModelBase"> + <summary> + Locking model base class + </summary> + <remarks> + <para> + Base class for the locking models available to the <see cref="T:log4net.Appender.FileAppender"/> derived loggers. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.FileAppender.LockingModelBase.OpenFile(System.String,System.Boolean,System.Text.Encoding)"> + <summary> + Open the output file + </summary> + <param name="filename">The filename to use</param> + <param name="append">Whether to append to the file, or overwrite</param> + <param name="encoding">The encoding to use</param> + <remarks> + <para> + Open the file specified and prepare for logging. + No writes will be made until <see cref="M:log4net.Appender.FileAppender.LockingModelBase.AcquireLock"/> is called. + Must be called before any calls to <see cref="M:log4net.Appender.FileAppender.LockingModelBase.AcquireLock"/>, + <see cref="M:log4net.Appender.FileAppender.LockingModelBase.ReleaseLock"/> and <see cref="M:log4net.Appender.FileAppender.LockingModelBase.CloseFile"/>. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.FileAppender.LockingModelBase.CloseFile"> + <summary> + Close the file + </summary> + <remarks> + <para> + Close the file. No further writes will be made. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.FileAppender.LockingModelBase.AcquireLock"> + <summary> + Acquire the lock on the file + </summary> + <returns>A stream that is ready to be written to.</returns> + <remarks> + <para> + Acquire the lock on the file in preparation for writing to it. + Return a stream pointing to the file. <see cref="M:log4net.Appender.FileAppender.LockingModelBase.ReleaseLock"/> + must be called to release the lock on the output file. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.FileAppender.LockingModelBase.ReleaseLock"> + <summary> + Release the lock on the file + </summary> + <remarks> + <para> + Release the lock on the file. No further writes will be made to the + stream until <see cref="M:log4net.Appender.FileAppender.LockingModelBase.AcquireLock"/> is called again. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.FileAppender.LockingModelBase.CreateStream(System.String,System.Boolean,System.IO.FileShare)"> + <summary> + Helper method that creates a FileStream under CurrentAppender's SecurityContext. + </summary> + <remarks> + <para> + Typically called during OpenFile or AcquireLock. + </para> + <para> + If the directory portion of the <paramref name="filename"/> does not exist, it is created + via Directory.CreateDirecctory. + </para> + </remarks> + <param name="filename"></param> + <param name="append"></param> + <param name="fileShare"></param> + <returns></returns> + </member> + <member name="M:log4net.Appender.FileAppender.LockingModelBase.CloseStream(System.IO.Stream)"> + <summary> + Helper method to close <paramref name="stream"/> under CurrentAppender's SecurityContext. + </summary> + <remarks> + Does not set <paramref name="stream"/> to null. + </remarks> + <param name="stream"></param> + </member> + <member name="P:log4net.Appender.FileAppender.LockingModelBase.CurrentAppender"> + <summary> + Gets or sets the <see cref="T:log4net.Appender.FileAppender"/> for this LockingModel + </summary> + <value> + The <see cref="T:log4net.Appender.FileAppender"/> for this LockingModel + </value> + <remarks> + <para> + The file appender this locking model is attached to and working on + behalf of. + </para> + <para> + The file appender is used to locate the security context and the error handler to use. + </para> + <para> + The value of this property will be set before <see cref="M:log4net.Appender.FileAppender.LockingModelBase.OpenFile(System.String,System.Boolean,System.Text.Encoding)"/> is + called. + </para> + </remarks> + </member> + <member name="T:log4net.Appender.FileAppender.ExclusiveLock"> + <summary> + Hold an exclusive lock on the output file + </summary> + <remarks> + <para> + Open the file once for writing and hold it open until <see cref="M:log4net.Appender.FileAppender.ExclusiveLock.CloseFile"/> is called. + Maintains an exclusive lock on the file during this time. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.FileAppender.ExclusiveLock.OpenFile(System.String,System.Boolean,System.Text.Encoding)"> + <summary> + Open the file specified and prepare for logging. + </summary> + <param name="filename">The filename to use</param> + <param name="append">Whether to append to the file, or overwrite</param> + <param name="encoding">The encoding to use</param> + <remarks> + <para> + Open the file specified and prepare for logging. + No writes will be made until <see cref="M:log4net.Appender.FileAppender.ExclusiveLock.AcquireLock"/> is called. + Must be called before any calls to <see cref="M:log4net.Appender.FileAppender.ExclusiveLock.AcquireLock"/>, + <see cref="M:log4net.Appender.FileAppender.ExclusiveLock.ReleaseLock"/> and <see cref="M:log4net.Appender.FileAppender.ExclusiveLock.CloseFile"/>. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.FileAppender.ExclusiveLock.CloseFile"> + <summary> + Close the file + </summary> + <remarks> + <para> + Close the file. No further writes will be made. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.FileAppender.ExclusiveLock.AcquireLock"> + <summary> + Acquire the lock on the file + </summary> + <returns>A stream that is ready to be written to.</returns> + <remarks> + <para> + Does nothing. The lock is already taken + </para> + </remarks> + </member> + <member name="M:log4net.Appender.FileAppender.ExclusiveLock.ReleaseLock"> + <summary> + Release the lock on the file + </summary> + <remarks> + <para> + Does nothing. The lock will be released when the file is closed. + </para> + </remarks> + </member> + <member name="T:log4net.Appender.FileAppender.MinimalLock"> + <summary> + Acquires the file lock for each write + </summary> + <remarks> + <para> + Opens the file once for each <see cref="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock"/>/<see cref="M:log4net.Appender.FileAppender.MinimalLock.ReleaseLock"/> cycle, + thus holding the lock for the minimal amount of time. This method of locking + is considerably slower than <see cref="T:log4net.Appender.FileAppender.ExclusiveLock"/> but allows + other processes to move/delete the log file whilst logging continues. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.FileAppender.MinimalLock.OpenFile(System.String,System.Boolean,System.Text.Encoding)"> + <summary> + Prepares to open the file when the first message is logged. + </summary> + <param name="filename">The filename to use</param> + <param name="append">Whether to append to the file, or overwrite</param> + <param name="encoding">The encoding to use</param> + <remarks> + <para> + Open the file specified and prepare for logging. + No writes will be made until <see cref="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock"/> is called. + Must be called before any calls to <see cref="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock"/>, + <see cref="M:log4net.Appender.FileAppender.MinimalLock.ReleaseLock"/> and <see cref="M:log4net.Appender.FileAppender.MinimalLock.CloseFile"/>. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.FileAppender.MinimalLock.CloseFile"> + <summary> + Close the file + </summary> + <remarks> + <para> + Close the file. No further writes will be made. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock"> + <summary> + Acquire the lock on the file + </summary> + <returns>A stream that is ready to be written to.</returns> + <remarks> + <para> + Acquire the lock on the file in preparation for writing to it. + Return a stream pointing to the file. <see cref="M:log4net.Appender.FileAppender.MinimalLock.ReleaseLock"/> + must be called to release the lock on the output file. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.FileAppender.MinimalLock.ReleaseLock"> + <summary> + Release the lock on the file + </summary> + <remarks> + <para> + Release the lock on the file. No further writes will be made to the + stream until <see cref="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock"/> is called again. + </para> + </remarks> + </member> + <member name="T:log4net.Appender.FileAppender.InterProcessLock"> + <summary> + Provides cross-process file locking. + </summary> + <author>Ron Grabowski</author> + <author>Steve Wranovsky</author> + </member> + <member name="M:log4net.Appender.FileAppender.InterProcessLock.OpenFile(System.String,System.Boolean,System.Text.Encoding)"> + <summary> + Open the file specified and prepare for logging. + </summary> + <param name="filename">The filename to use</param> + <param name="append">Whether to append to the file, or overwrite</param> + <param name="encoding">The encoding to use</param> + <remarks> + <para> + Open the file specified and prepare for logging. + No writes will be made until <see cref="M:log4net.Appender.FileAppender.InterProcessLock.AcquireLock"/> is called. + Must be called before any calls to <see cref="M:log4net.Appender.FileAppender.InterProcessLock.AcquireLock"/>, + -<see cref="M:log4net.Appender.FileAppender.InterProcessLock.ReleaseLock"/> and <see cref="M:log4net.Appender.FileAppender.InterProcessLock.CloseFile"/>. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.FileAppender.InterProcessLock.CloseFile"> + <summary> + Close the file + </summary> + <remarks> + <para> + Close the file. No further writes will be made. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.FileAppender.InterProcessLock.AcquireLock"> + <summary> + Acquire the lock on the file + </summary> + <returns>A stream that is ready to be written to.</returns> + <remarks> + <para> + Does nothing. The lock is already taken + </para> + </remarks> + </member> + <member name="M:log4net.Appender.FileAppender.InterProcessLock.ReleaseLock"> + <summary> + + </summary> + </member> + <member name="T:log4net.Appender.ForwardingAppender"> + <summary> + This appender forwards logging events to attached appenders. + </summary> + <remarks> + <para> + The forwarding appender can be used to specify different thresholds + and filters for the same appender at different locations within the hierarchy. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Appender.ForwardingAppender.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:log4net.Appender.ForwardingAppender"/> class. + </summary> + <remarks> + <para> + Default constructor. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.ForwardingAppender.OnClose"> + <summary> + Closes the appender and releases resources. + </summary> + <remarks> + <para> + Releases any resources allocated within the appender such as file handles, + network connections, etc. + </para> + <para> + It is a programming error to append to a closed appender. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.ForwardingAppender.Append(log4net.Core.LoggingEvent)"> + <summary> + Forward the logging event to the attached appenders + </summary> + <param name="loggingEvent">The event to log.</param> + <remarks> + <para> + Delivers the logging event to all the attached appenders. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.ForwardingAppender.Append(log4net.Core.LoggingEvent[])"> + <summary> + Forward the logging events to the attached appenders + </summary> + <param name="loggingEvents">The array of events to log.</param> + <remarks> + <para> + Delivers the logging events to all the attached appenders. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.ForwardingAppender.AddAppender(log4net.Appender.IAppender)"> + <summary> + Adds an <see cref="T:log4net.Appender.IAppender"/> to the list of appenders of this + instance. + </summary> + <param name="newAppender">The <see cref="T:log4net.Appender.IAppender"/> to add to this appender.</param> + <remarks> + <para> + If the specified <see cref="T:log4net.Appender.IAppender"/> is already in the list of + appenders, then it won't be added again. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.ForwardingAppender.GetAppender(System.String)"> + <summary> + Looks for the appender with the specified name. + </summary> + <param name="name">The name of the appender to lookup.</param> + <returns> + The appender with the specified name, or <c>null</c>. + </returns> + <remarks> + <para> + Get the named appender attached to this appender. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.ForwardingAppender.RemoveAllAppenders"> + <summary> + Removes all previously added appenders from this appender. + </summary> + <remarks> + <para> + This is useful when re-reading configuration information. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.ForwardingAppender.RemoveAppender(log4net.Appender.IAppender)"> + <summary> + Removes the specified appender from the list of appenders. + </summary> + <param name="appender">The appender to remove.</param> + <returns>The appender removed from the list</returns> + <remarks> + The appender removed is not closed. + If you are discarding the appender you must call + <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed. + </remarks> + </member> + <member name="M:log4net.Appender.ForwardingAppender.RemoveAppender(System.String)"> + <summary> + Removes the appender with the specified name from the list of appenders. + </summary> + <param name="name">The name of the appender to remove.</param> + <returns>The appender removed from the list</returns> + <remarks> + The appender removed is not closed. + If you are discarding the appender you must call + <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed. + </remarks> + </member> + <member name="F:log4net.Appender.ForwardingAppender.m_appenderAttachedImpl"> + <summary> + Implementation of the <see cref="T:log4net.Core.IAppenderAttachable"/> interface + </summary> + </member> + <member name="P:log4net.Appender.ForwardingAppender.Appenders"> + <summary> + Gets the appenders contained in this appender as an + <see cref="T:System.Collections.ICollection"/>. + </summary> + <remarks> + If no appenders can be found, then an <see cref="T:log4net.Util.EmptyCollection"/> + is returned. + </remarks> + <returns> + A collection of the appenders in this appender. + </returns> + </member> + <member name="T:log4net.Appender.LocalSyslogAppender"> + <summary> + Logs events to a local syslog service. + </summary> + <remarks> + <note> + This appender uses the POSIX libc library functions <c>openlog</c>, <c>syslog</c>, and <c>closelog</c>. + If these functions are not available on the local system then this appender will not work! + </note> + <para> + The functions <c>openlog</c>, <c>syslog</c>, and <c>closelog</c> are specified in SUSv2 and + POSIX 1003.1-2001 standards. These are used to log messages to the local syslog service. + </para> + <para> + This appender talks to a local syslog service. If you need to log to a remote syslog + daemon and you cannot configure your local syslog service to do this you may be + able to use the <see cref="T:log4net.Appender.RemoteSyslogAppender"/> to log via UDP. + </para> + <para> + Syslog messages must have a facility and and a severity. The severity + is derived from the Level of the logging event. + The facility must be chosen from the set of defined syslog + <see cref="T:log4net.Appender.LocalSyslogAppender.SyslogFacility"/> values. The facilities list is predefined + and cannot be extended. + </para> + <para> + An identifier is specified with each log message. This can be specified + by setting the <see cref="P:log4net.Appender.LocalSyslogAppender.Identity"/> property. The identity (also know + as the tag) must not contain white space. The default value for the + identity is the application name (from <see cref="P:log4net.Util.SystemInfo.ApplicationFriendlyName"/>). + </para> + </remarks> + <author>Rob Lyon</author> + <author>Nicko Cadell</author> + </member> + <member name="M:log4net.Appender.LocalSyslogAppender.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:log4net.Appender.LocalSyslogAppender"/> class. + </summary> + <remarks> + This instance of the <see cref="T:log4net.Appender.LocalSyslogAppender"/> class is set up to write + to a local syslog service. + </remarks> + </member> + <member name="M:log4net.Appender.LocalSyslogAppender.AddMapping(log4net.Appender.LocalSyslogAppender.LevelSeverity)"> + <summary> + Add a mapping of level to severity + </summary> + <param name="mapping">The mapping to add</param> + <remarks> + <para> + Adds a <see cref="T:log4net.Appender.LocalSyslogAppender.LevelSeverity"/> to this appender. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.LocalSyslogAppender.ActivateOptions"> + <summary> + Initialize the appender based on the options set. + </summary> + <remarks> + <para> + This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object + activation scheme. The <see cref="M:log4net.Appender.LocalSyslogAppender.ActivateOptions"/> method must + be called on this object after the configuration properties have + been set. Until <see cref="M:log4net.Appender.LocalSyslogAppender.ActivateOptions"/> is called this + object is in an undefined state and must not be used. + </para> + <para> + If any of the configuration properties are modified then + <see cref="M:log4net.Appender.LocalSyslogAppender.ActivateOptions"/> must be called again. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.LocalSyslogAppender.Append(log4net.Core.LoggingEvent)"> + <summary> + This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method. + </summary> + <param name="loggingEvent">The event to log.</param> + <remarks> + <para> + Writes the event to a remote syslog daemon. + </para> + <para> + The format of the output will depend on the appender's layout. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.LocalSyslogAppender.OnClose"> + <summary> + Close the syslog when the appender is closed + </summary> + <remarks> + <para> + Close the syslog when the appender is closed + </para> + </remarks> + </member> + <member name="M:log4net.Appender.LocalSyslogAppender.GetSeverity(log4net.Core.Level)"> + <summary> + Translates a log4net level to a syslog severity. + </summary> + <param name="level">A log4net level.</param> + <returns>A syslog severity.</returns> + <remarks> + <para> + Translates a log4net level to a syslog severity. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.LocalSyslogAppender.GeneratePriority(log4net.Appender.LocalSyslogAppender.SyslogFacility,log4net.Appender.LocalSyslogAppender.SyslogSeverity)"> + <summary> + Generate a syslog priority. + </summary> + <param name="facility">The syslog facility.</param> + <param name="severity">The syslog severity.</param> + <returns>A syslog priority.</returns> + </member> + <member name="F:log4net.Appender.LocalSyslogAppender.m_facility"> + <summary> + The facility. The default facility is <see cref="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.User"/>. + </summary> + </member> + <member name="F:log4net.Appender.LocalSyslogAppender.m_identity"> + <summary> + The message identity + </summary> + </member> + <member name="F:log4net.Appender.LocalSyslogAppender.m_handleToIdentity"> + <summary> + Marshaled handle to the identity string. We have to hold on to the + string as the <c>openlog</c> and <c>syslog</c> APIs just hold the + pointer to the ident and dereference it for each log message. + </summary> + </member> + <member name="F:log4net.Appender.LocalSyslogAppender.m_levelMapping"> + <summary> + Mapping from level object to syslog severity + </summary> + </member> + <member name="M:log4net.Appender.LocalSyslogAppender.openlog(System.IntPtr,System.Int32,log4net.Appender.LocalSyslogAppender.SyslogFacility)"> + <summary> + Open connection to system logger. + </summary> + </member> + <member name="M:log4net.Appender.LocalSyslogAppender.syslog(System.Int32,System.String,System.String)"> + <summary> + Generate a log message. + </summary> + <remarks> + <para> + The libc syslog method takes a format string and a variable argument list similar + to the classic printf function. As this type of vararg list is not supported + by C# we need to specify the arguments explicitly. Here we have specified the + format string with a single message argument. The caller must set the format + string to <c>"%s"</c>. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.LocalSyslogAppender.closelog"> + <summary> + Close descriptor used to write to system logger. + </summary> + </member> + <member name="P:log4net.Appender.LocalSyslogAppender.Identity"> + <summary> + Message identity + </summary> + <remarks> + <para> + An identifier is specified with each log message. This can be specified + by setting the <see cref="P:log4net.Appender.LocalSyslogAppender.Identity"/> property. The identity (also know + as the tag) must not contain white space. The default value for the + identity is the application name (from <see cref="P:log4net.Util.SystemInfo.ApplicationFriendlyName"/>). + </para> + </remarks> + </member> + <member name="P:log4net.Appender.LocalSyslogAppender.Facility"> + <summary> + Syslog facility + </summary> + <remarks> + Set to one of the <see cref="T:log4net.Appender.LocalSyslogAppender.SyslogFacility"/> values. The list of + facilities is predefined and cannot be extended. The default value + is <see cref="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.User"/>. + </remarks> + </member> + <member name="P:log4net.Appender.LocalSyslogAppender.RequiresLayout"> + <summary> + This appender requires a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/> to be set. + </summary> + <value><c>true</c></value> + <remarks> + <para> + This appender requires a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/> to be set. + </para> + </remarks> + </member> + <member name="T:log4net.Appender.LocalSyslogAppender.SyslogSeverity"> + <summary> + syslog severities + </summary> + <remarks> + <para> + The log4net Level maps to a syslog severity using the + <see cref="M:log4net.Appender.LocalSyslogAppender.AddMapping(log4net.Appender.LocalSyslogAppender.LevelSeverity)"/> method and the <see cref="T:log4net.Appender.LocalSyslogAppender.LevelSeverity"/> + class. The severity is set on <see cref="P:log4net.Appender.LocalSyslogAppender.LevelSeverity.Severity"/>. + </para> + </remarks> + </member> + <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Emergency"> + <summary> + system is unusable + </summary> + </member> + <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Alert"> + <summary> + action must be taken immediately + </summary> + </member> + <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Critical"> + <summary> + critical conditions + </summary> + </member> + <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Error"> + <summary> + error conditions + </summary> + </member> + <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Warning"> + <summary> + warning conditions + </summary> + </member> + <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Notice"> + <summary> + normal but significant condition + </summary> + </member> + <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Informational"> + <summary> + informational + </summary> + </member> + <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Debug"> + <summary> + debug-level messages + </summary> + </member> + <member name="T:log4net.Appender.LocalSyslogAppender.SyslogFacility"> + <summary> + syslog facilities + </summary> + <remarks> + <para> + The syslog facility defines which subsystem the logging comes from. + This is set on the <see cref="P:log4net.Appender.LocalSyslogAppender.Facility"/> property. + </para> + </remarks> + </member> + <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Kernel"> + <summary> + kernel messages + </summary> + </member> + <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.User"> + <summary> + random user-level messages + </summary> + </member> + <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Mail"> + <summary> + mail system + </summary> + </member> + <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Daemons"> + <summary> + system daemons + </summary> + </member> + <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Authorization"> + <summary> + security/authorization messages + </summary> + </member> + <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Syslog"> + <summary> + messages generated internally by syslogd + </summary> + </member> + <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Printer"> + <summary> + line printer subsystem + </summary> + </member> + <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.News"> + <summary> + network news subsystem + </summary> + </member> + <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Uucp"> + <summary> + UUCP subsystem + </summary> + </member> + <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Clock"> + <summary> + clock (cron/at) daemon + </summary> + </member> + <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Authorization2"> + <summary> + security/authorization messages (private) + </summary> + </member> + <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Ftp"> + <summary> + ftp daemon + </summary> + </member> + <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Ntp"> + <summary> + NTP subsystem + </summary> + </member> + <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Audit"> + <summary> + log audit + </summary> + </member> + <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Alert"> + <summary> + log alert + </summary> + </member> + <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Clock2"> + <summary> + clock daemon + </summary> + </member> + <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local0"> + <summary> + reserved for local use + </summary> + </member> + <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local1"> + <summary> + reserved for local use + </summary> + </member> + <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local2"> + <summary> + reserved for local use + </summary> + </member> + <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local3"> + <summary> + reserved for local use + </summary> + </member> + <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local4"> + <summary> + reserved for local use + </summary> + </member> + <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local5"> + <summary> + reserved for local use + </summary> + </member> + <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local6"> + <summary> + reserved for local use + </summary> + </member> + <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local7"> + <summary> + reserved for local use + </summary> + </member> + <member name="T:log4net.Appender.LocalSyslogAppender.LevelSeverity"> + <summary> + A class to act as a mapping between the level that a logging call is made at and + the syslog severity that is should be logged at. + </summary> + <remarks> + <para> + A class to act as a mapping between the level that a logging call is made at and + the syslog severity that is should be logged at. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.LocalSyslogAppender.LevelSeverity.Severity"> + <summary> + The mapped syslog severity for the specified level + </summary> + <remarks> + <para> + Required property. + The mapped syslog severity for the specified level + </para> + </remarks> + </member> + <member name="T:log4net.Appender.ManagedColoredConsoleAppender"> + <summary> + Appends colorful logging events to the console, using the .NET 2 + built-in capabilities. + </summary> + <remarks> + <para> + ManagedColoredConsoleAppender appends log events to the standard output stream + or the error output stream using a layout specified by the + user. It also allows the color of a specific type of message to be set. + </para> + <para> + By default, all output is written to the console's standard output stream. + The <see cref="P:log4net.Appender.ManagedColoredConsoleAppender.Target"/> property can be set to direct the output to the + error stream. + </para> + <para> + When configuring the colored console appender, mappings should be + specified to map logging levels to colors. For example: + </para> + <code lang="XML" escaped="true"> + <mapping> + <level value="ERROR"/> + <foreColor value="DarkRed"/> + <backColor value="White"/> + </mapping> + <mapping> + <level value="WARN"/> + <foreColor value="Yellow"/> + </mapping> + <mapping> + <level value="INFO"/> + <foreColor value="White"/> + </mapping> + <mapping> + <level value="DEBUG"/> + <foreColor value="Blue"/> + </mapping> + </code> + <para> + The Level is the standard log4net logging level while + ForeColor and BackColor are the values of <see cref="T:System.ConsoleColor"/> + enumeration. + </para> + <para> + Based on the ColoredConsoleAppender + </para> + </remarks> + <author>Rick Hobbs</author> + <author>Nicko Cadell</author> + <author>Pavlos Touboulidis</author> + </member> + <member name="F:log4net.Appender.ManagedColoredConsoleAppender.ConsoleOut"> + <summary> + The <see cref="P:log4net.Appender.ManagedColoredConsoleAppender.Target"/> to use when writing to the Console + standard output stream. + </summary> + <remarks> + <para> + The <see cref="P:log4net.Appender.ManagedColoredConsoleAppender.Target"/> to use when writing to the Console + standard output stream. + </para> + </remarks> + </member> + <member name="F:log4net.Appender.ManagedColoredConsoleAppender.ConsoleError"> + <summary> + The <see cref="P:log4net.Appender.ManagedColoredConsoleAppender.Target"/> to use when writing to the Console + standard error output stream. + </summary> + <remarks> + <para> + The <see cref="P:log4net.Appender.ManagedColoredConsoleAppender.Target"/> to use when writing to the Console + standard error output stream. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.ManagedColoredConsoleAppender.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:log4net.Appender.ManagedColoredConsoleAppender"/> class. + </summary> + <remarks> + The instance of the <see cref="T:log4net.Appender.ManagedColoredConsoleAppender"/> class is set up to write + to the standard output stream. + </remarks> + </member> + <member name="M:log4net.Appender.ManagedColoredConsoleAppender.AddMapping(log4net.Appender.ManagedColoredConsoleAppender.LevelColors)"> + <summary> + Add a mapping of level to color - done by the config file + </summary> + <param name="mapping">The mapping to add</param> + <remarks> + <para> + Add a <see cref="T:log4net.Appender.ManagedColoredConsoleAppender.LevelColors"/> mapping to this appender. + Each mapping defines the foreground and background colors + for a level. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.ManagedColoredConsoleAppender.Append(log4net.Core.LoggingEvent)"> + <summary> + This method is called by the <see cref="M:AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent)"/> method. + </summary> + <param name="loggingEvent">The event to log.</param> + <remarks> + <para> + Writes the event to the console. + </para> + <para> + The format of the output will depend on the appender's layout. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.ManagedColoredConsoleAppender.ActivateOptions"> + <summary> + Initialize the options for this appender + </summary> + <remarks> + <para> + Initialize the level to color mappings set on this appender. + </para> + </remarks> + </member> + <member name="F:log4net.Appender.ManagedColoredConsoleAppender.m_writeToErrorStream"> + <summary> + Flag to write output to the error stream rather than the standard output stream + </summary> + </member> + <member name="F:log4net.Appender.ManagedColoredConsoleAppender.m_levelMapping"> + <summary> + Mapping from level object to color value + </summary> + </member> + <member name="P:log4net.Appender.ManagedColoredConsoleAppender.Target"> + <summary> + Target is the value of the console output stream. + This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>. + </summary> + <value> + Target is the value of the console output stream. + This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>. + </value> + <remarks> + <para> + Target is the value of the console output stream. + This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.ManagedColoredConsoleAppender.RequiresLayout"> + <summary> + This appender requires a <see cref="N:log4net.Layout"/> to be set. + </summary> + <value><c>true</c></value> + <remarks> + <para> + This appender requires a <see cref="N:log4net.Layout"/> to be set. + </para> + </remarks> + </member> + <member name="T:log4net.Appender.ManagedColoredConsoleAppender.LevelColors"> + <summary> + A class to act as a mapping between the level that a logging call is made at and + the color it should be displayed as. + </summary> + <remarks> + <para> + Defines the mapping between a level and the color it should be displayed in. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.ManagedColoredConsoleAppender.LevelColors.ForeColor"> + <summary> + The mapped foreground color for the specified level + </summary> + <remarks> + <para> + Required property. + The mapped foreground color for the specified level. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.ManagedColoredConsoleAppender.LevelColors.BackColor"> + <summary> + The mapped background color for the specified level + </summary> + <remarks> + <para> + Required property. + The mapped background color for the specified level. + </para> + </remarks> + </member> + <member name="T:log4net.Appender.MemoryAppender"> + <summary> + Stores logging events in an array. + </summary> + <remarks> + <para> + The memory appender stores all the logging events + that are appended in an in-memory array. + </para> + <para> + Use the <see cref="M:log4net.Appender.MemoryAppender.GetEvents"/> method to get + the current list of events that have been appended. + </para> + <para> + Use the <see cref="M:Clear()"/> method to clear the + current list of events. + </para> + </remarks> + <author>Julian Biddle</author> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Appender.MemoryAppender.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:log4net.Appender.MemoryAppender"/> class. + </summary> + <remarks> + <para> + Default constructor. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.MemoryAppender.GetEvents"> + <summary> + Gets the events that have been logged. + </summary> + <returns>The events that have been logged</returns> + <remarks> + <para> + Gets the events that have been logged. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.MemoryAppender.Append(log4net.Core.LoggingEvent)"> + <summary> + This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method. + </summary> + <param name="loggingEvent">the event to log</param> + <remarks> + <para>Stores the <paramref name="loggingEvent"/> in the events list.</para> + </remarks> + </member> + <member name="M:log4net.Appender.MemoryAppender.Clear"> + <summary> + Clear the list of events + </summary> + <remarks> + Clear the list of events + </remarks> + </member> + <member name="F:log4net.Appender.MemoryAppender.m_eventsList"> + <summary> + The list of events that have been appended. + </summary> + </member> + <member name="F:log4net.Appender.MemoryAppender.m_fixFlags"> + <summary> + Value indicating which fields in the event should be fixed + </summary> + <remarks> + By default all fields are fixed + </remarks> + </member> + <member name="P:log4net.Appender.MemoryAppender.OnlyFixPartialEventData"> + <summary> + Gets or sets a value indicating whether only part of the logging event + data should be fixed. + </summary> + <value> + <c>true</c> if the appender should only fix part of the logging event + data, otherwise <c>false</c>. The default is <c>false</c>. + </value> + <remarks> + <para> + Setting this property to <c>true</c> will cause only part of the event + data to be fixed and stored in the appender, hereby improving performance. + </para> + <para> + See <see cref="M:LoggingEvent.FixVolatileData(bool)"/> for more information. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.MemoryAppender.Fix"> + <summary> + Gets or sets the fields that will be fixed in the event + </summary> + <remarks> + <para> + The logging event needs to have certain thread specific values + captured before it can be buffered. See <see cref="P:log4net.Core.LoggingEvent.Fix"/> + for details. + </para> + </remarks> + </member> + <member name="T:log4net.Appender.NetSendAppender"> + <summary> + Logs entries by sending network messages using the + <see cref="M:log4net.Appender.NetSendAppender.NetMessageBufferSend(System.String,System.String,System.String,System.String,System.Int32)"/> native function. + </summary> + <remarks> + <para> + You can send messages only to names that are active + on the network. If you send the message to a user name, + that user must be logged on and running the Messenger + service to receive the message. + </para> + <para> + The receiver will get a top most window displaying the + messages one at a time, therefore this appender should + not be used to deliver a high volume of messages. + </para> + <para> + The following table lists some possible uses for this appender : + </para> + <para> + <list type="table"> + <listheader> + <term>Action</term> + <description>Property Value(s)</description> + </listheader> + <item> + <term>Send a message to a user account on the local machine</term> + <description> + <para> + <see cref="P:log4net.Appender.NetSendAppender.Server"/> = <name of the local machine> + </para> + <para> + <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> = <user name> + </para> + </description> + </item> + <item> + <term>Send a message to a user account on a remote machine</term> + <description> + <para> + <see cref="P:log4net.Appender.NetSendAppender.Server"/> = <name of the remote machine> + </para> + <para> + <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> = <user name> + </para> + </description> + </item> + <item> + <term>Send a message to a domain user account</term> + <description> + <para> + <see cref="P:log4net.Appender.NetSendAppender.Server"/> = <name of a domain controller | uninitialized> + </para> + <para> + <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> = <user name> + </para> + </description> + </item> + <item> + <term>Send a message to all the names in a workgroup or domain</term> + <description> + <para> + <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> = <workgroup name | domain name>* + </para> + </description> + </item> + <item> + <term>Send a message from the local machine to a remote machine</term> + <description> + <para> + <see cref="P:log4net.Appender.NetSendAppender.Server"/> = <name of the local machine | uninitialized> + </para> + <para> + <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> = <name of the remote machine> + </para> + </description> + </item> + </list> + </para> + <para> + <b>Note :</b> security restrictions apply for sending + network messages, see <see cref="M:log4net.Appender.NetSendAppender.NetMessageBufferSend(System.String,System.String,System.String,System.String,System.Int32)"/> + for more information. + </para> + </remarks> + <example> + <para> + An example configuration section to log information + using this appender from the local machine, named + LOCAL_PC, to machine OPERATOR_PC : + </para> + <code lang="XML" escaped="true"> + <appender name="NetSendAppender_Operator" type="log4net.Appender.NetSendAppender"> + <server value="LOCAL_PC"/> + <recipient value="OPERATOR_PC"/> + <layout type="log4net.Layout.PatternLayout" value="%-5p %c [%x] - %m%n"/> + </appender> + </code> + </example> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="F:log4net.Appender.NetSendAppender.m_server"> + <summary> + The DNS or NetBIOS name of the server on which the function is to execute. + </summary> + </member> + <member name="F:log4net.Appender.NetSendAppender.m_sender"> + <summary> + The sender of the network message. + </summary> + </member> + <member name="F:log4net.Appender.NetSendAppender.m_recipient"> + <summary> + The message alias to which the message should be sent. + </summary> + </member> + <member name="F:log4net.Appender.NetSendAppender.m_securityContext"> + <summary> + The security context to use for privileged calls + </summary> + </member> + <member name="M:log4net.Appender.NetSendAppender.#ctor"> + <summary> + Initializes the appender. + </summary> + <remarks> + The default constructor initializes all fields to their default values. + </remarks> + </member> + <member name="M:log4net.Appender.NetSendAppender.ActivateOptions"> + <summary> + Initialize the appender based on the options set. + </summary> + <remarks> + <para> + This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object + activation scheme. The <see cref="M:log4net.Appender.NetSendAppender.ActivateOptions"/> method must + be called on this object after the configuration properties have + been set. Until <see cref="M:log4net.Appender.NetSendAppender.ActivateOptions"/> is called this + object is in an undefined state and must not be used. + </para> + <para> + If any of the configuration properties are modified then + <see cref="M:log4net.Appender.NetSendAppender.ActivateOptions"/> must be called again. + </para> + <para> + The appender will be ignored if no <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> was specified. + </para> + </remarks> + <exception cref="T:System.ArgumentNullException">The required property <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> was not specified.</exception> + </member> + <member name="M:log4net.Appender.NetSendAppender.Append(log4net.Core.LoggingEvent)"> + <summary> + This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method. + </summary> + <param name="loggingEvent">The event to log.</param> + <remarks> + <para> + Sends the event using a network message. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.NetSendAppender.NetMessageBufferSend(System.String,System.String,System.String,System.String,System.Int32)"> + <summary> + Sends a buffer of information to a registered message alias. + </summary> + <param name="serverName">The DNS or NetBIOS name of the server on which the function is to execute.</param> + <param name="msgName">The message alias to which the message buffer should be sent</param> + <param name="fromName">The originator of the message.</param> + <param name="buffer">The message text.</param> + <param name="bufferSize">The length, in bytes, of the message text.</param> + <remarks> + <para> + The following restrictions apply for sending network messages: + </para> + <para> + <list type="table"> + <listheader> + <term>Platform</term> + <description>Requirements</description> + </listheader> + <item> + <term>Windows NT</term> + <description> + <para> + No special group membership is required to send a network message. + </para> + <para> + Admin, Accounts, Print, or Server Operator group membership is required to + successfully send a network message on a remote server. + </para> + </description> + </item> + <item> + <term>Windows 2000 or later</term> + <description> + <para> + If you send a message on a domain controller that is running Active Directory, + access is allowed or denied based on the access control list (ACL) for the securable + object. The default ACL permits only Domain Admins and Account Operators to send a network message. + </para> + <para> + On a member server or workstation, only Administrators and Server Operators can send a network message. + </para> + </description> + </item> + </list> + </para> + <para> + For more information see <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/netmgmt/netmgmt/security_requirements_for_the_network_management_functions.asp">Security Requirements for the Network Management Functions</a>. + </para> + </remarks> + <returns> + <para> + If the function succeeds, the return value is zero. + </para> + </returns> + </member> + <member name="P:log4net.Appender.NetSendAppender.Sender"> + <summary> + Gets or sets the sender of the message. + </summary> + <value> + The sender of the message. + </value> + <remarks> + If this property is not specified, the message is sent from the local computer. + </remarks> + </member> + <member name="P:log4net.Appender.NetSendAppender.Recipient"> + <summary> + Gets or sets the message alias to which the message should be sent. + </summary> + <value> + The recipient of the message. + </value> + <remarks> + This property should always be specified in order to send a message. + </remarks> + </member> + <member name="P:log4net.Appender.NetSendAppender.Server"> + <summary> + Gets or sets the DNS or NetBIOS name of the remote server on which the function is to execute. + </summary> + <value> + DNS or NetBIOS name of the remote server on which the function is to execute. + </value> + <remarks> + <para> + For Windows NT 4.0 and earlier, the string should begin with \\. + </para> + <para> + If this property is not specified, the local computer is used. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.NetSendAppender.SecurityContext"> + <summary> + Gets or sets the <see cref="P:log4net.Appender.NetSendAppender.SecurityContext"/> used to call the NetSend method. + </summary> + <value> + The <see cref="P:log4net.Appender.NetSendAppender.SecurityContext"/> used to call the NetSend method. + </value> + <remarks> + <para> + Unless a <see cref="P:log4net.Appender.NetSendAppender.SecurityContext"/> specified here for this appender + the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is queried for the + security context to use. The default behavior is to use the security context + of the current thread. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.NetSendAppender.RequiresLayout"> + <summary> + This appender requires a <see cref="N:log4net.Layout"/> to be set. + </summary> + <value><c>true</c></value> + <remarks> + <para> + This appender requires a <see cref="N:log4net.Layout"/> to be set. + </para> + </remarks> + </member> + <member name="T:log4net.Appender.OutputDebugStringAppender"> + <summary> + Appends log events to the OutputDebugString system. + </summary> + <remarks> + <para> + OutputDebugStringAppender appends log events to the + OutputDebugString system. + </para> + <para> + The string is passed to the native <c>OutputDebugString</c> + function. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Appender.OutputDebugStringAppender.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:log4net.Appender.OutputDebugStringAppender"/> class. + </summary> + <remarks> + <para> + Default constructor. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.OutputDebugStringAppender.Append(log4net.Core.LoggingEvent)"> + <summary> + Write the logging event to the output debug string API + </summary> + <param name="loggingEvent">the event to log</param> + <remarks> + <para> + Write the logging event to the output debug string API + </para> + </remarks> + </member> + <member name="M:log4net.Appender.OutputDebugStringAppender.OutputDebugString(System.String)"> + <summary> + Stub for OutputDebugString native method + </summary> + <param name="message">the string to output</param> + <remarks> + <para> + Stub for OutputDebugString native method + </para> + </remarks> + </member> + <member name="P:log4net.Appender.OutputDebugStringAppender.RequiresLayout"> + <summary> + This appender requires a <see cref="N:log4net.Layout"/> to be set. + </summary> + <value><c>true</c></value> + <remarks> + <para> + This appender requires a <see cref="N:log4net.Layout"/> to be set. + </para> + </remarks> + </member> + <member name="T:log4net.Appender.RemoteSyslogAppender"> + <summary> + Logs events to a remote syslog daemon. + </summary> + <remarks> + <para> + The BSD syslog protocol is used to remotely log to + a syslog daemon. The syslogd listens for for messages + on UDP port 514. + </para> + <para> + The syslog UDP protocol is not authenticated. Most syslog daemons + do not accept remote log messages because of the security implications. + You may be able to use the LocalSyslogAppender to talk to a local + syslog service. + </para> + <para> + There is an RFC 3164 that claims to document the BSD Syslog Protocol. + This RFC can be seen here: http://www.faqs.org/rfcs/rfc3164.html. + This appender generates what the RFC calls an "Original Device Message", + i.e. does not include the TIMESTAMP or HOSTNAME fields. By observation + this format of message will be accepted by all current syslog daemon + implementations. The daemon will attach the current time and the source + hostname or IP address to any messages received. + </para> + <para> + Syslog messages must have a facility and and a severity. The severity + is derived from the Level of the logging event. + The facility must be chosen from the set of defined syslog + <see cref="T:log4net.Appender.RemoteSyslogAppender.SyslogFacility"/> values. The facilities list is predefined + and cannot be extended. + </para> + <para> + An identifier is specified with each log message. This can be specified + by setting the <see cref="P:log4net.Appender.RemoteSyslogAppender.Identity"/> property. The identity (also know + as the tag) must not contain white space. The default value for the + identity is the application name (from <see cref="P:log4net.Core.LoggingEvent.Domain"/>). + </para> + </remarks> + <author>Rob Lyon</author> + <author>Nicko Cadell</author> + </member> + <member name="T:log4net.Appender.UdpAppender"> + <summary> + Sends logging events as connectionless UDP datagrams to a remote host or a + multicast group using an <see cref="T:System.Net.Sockets.UdpClient"/>. + </summary> + <remarks> + <para> + UDP guarantees neither that messages arrive, nor that they arrive in the correct order. + </para> + <para> + To view the logging results, a custom application can be developed that listens for logging + events. + </para> + <para> + When decoding events send via this appender remember to use the same encoding + to decode the events as was used to send the events. See the <see cref="P:log4net.Appender.UdpAppender.Encoding"/> + property to specify the encoding to use. + </para> + </remarks> + <example> + This example shows how to log receive logging events that are sent + on IP address 244.0.0.1 and port 8080 to the console. The event is + encoded in the packet as a unicode string and it is decoded as such. + <code lang="C#"> + IPEndPoint remoteEndPoint = new IPEndPoint(IPAddress.Any, 0); + UdpClient udpClient; + byte[] buffer; + string loggingEvent; + + try + { + udpClient = new UdpClient(8080); + + while(true) + { + buffer = udpClient.Receive(ref remoteEndPoint); + loggingEvent = System.Text.Encoding.Unicode.GetString(buffer); + Console.WriteLine(loggingEvent); + } + } + catch(Exception e) + { + Console.WriteLine(e.ToString()); + } + </code> + <code lang="Visual Basic"> + Dim remoteEndPoint as IPEndPoint + Dim udpClient as UdpClient + Dim buffer as Byte() + Dim loggingEvent as String + + Try + remoteEndPoint = new IPEndPoint(IPAddress.Any, 0) + udpClient = new UdpClient(8080) + + While True + buffer = udpClient.Receive(ByRef remoteEndPoint) + loggingEvent = System.Text.Encoding.Unicode.GetString(buffer) + Console.WriteLine(loggingEvent) + Wend + Catch e As Exception + Console.WriteLine(e.ToString()) + End Try + </code> + <para> + An example configuration section to log information using this appender to the + IP 224.0.0.1 on port 8080: + </para> + <code lang="XML" escaped="true"> + <appender name="UdpAppender" type="log4net.Appender.UdpAppender"> + <remoteAddress value="224.0.0.1"/> + <remotePort value="8080"/> + <layout type="log4net.Layout.PatternLayout" value="%-5level %logger [%ndc] - %message%newline"/> + </appender> + </code> + </example> + <author>Gert Driesen</author> + <author>Nicko Cadell</author> + </member> + <member name="M:log4net.Appender.UdpAppender.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:log4net.Appender.UdpAppender"/> class. + </summary> + <remarks> + The default constructor initializes all fields to their default values. + </remarks> + </member> + <member name="M:log4net.Appender.UdpAppender.ActivateOptions"> + <summary> + Initialize the appender based on the options set. + </summary> + <remarks> + <para> + This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object + activation scheme. The <see cref="M:log4net.Appender.UdpAppender.ActivateOptions"/> method must + be called on this object after the configuration properties have + been set. Until <see cref="M:log4net.Appender.UdpAppender.ActivateOptions"/> is called this + object is in an undefined state and must not be used. + </para> + <para> + If any of the configuration properties are modified then + <see cref="M:log4net.Appender.UdpAppender.ActivateOptions"/> must be called again. + </para> + <para> + The appender will be ignored if no <see cref="P:log4net.Appender.UdpAppender.RemoteAddress"/> was specified or + an invalid remote or local TCP port number was specified. + </para> + </remarks> + <exception cref="T:System.ArgumentNullException">The required property <see cref="P:log4net.Appender.UdpAppender.RemoteAddress"/> was not specified.</exception> + <exception cref="T:System.ArgumentOutOfRangeException">The TCP port number assigned to <see cref="P:log4net.Appender.UdpAppender.LocalPort"/> or <see cref="P:log4net.Appender.UdpAppender.RemotePort"/> is less than <see cref="F:System.Net.IPEndPoint.MinPort"/> or greater than <see cref="F:System.Net.IPEndPoint.MaxPort"/>.</exception> + </member> + <member name="M:log4net.Appender.UdpAppender.Append(log4net.Core.LoggingEvent)"> + <summary> + This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method. + </summary> + <param name="loggingEvent">The event to log.</param> + <remarks> + <para> + Sends the event using an UDP datagram. + </para> + <para> + Exceptions are passed to the <see cref="P:log4net.Appender.AppenderSkeleton.ErrorHandler"/>. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.UdpAppender.OnClose"> + <summary> + Closes the UDP connection and releases all resources associated with + this <see cref="T:log4net.Appender.UdpAppender"/> instance. + </summary> + <remarks> + <para> + Disables the underlying <see cref="T:System.Net.Sockets.UdpClient"/> and releases all managed + and unmanaged resources associated with the <see cref="T:log4net.Appender.UdpAppender"/>. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.UdpAppender.InitializeClientConnection"> + <summary> + Initializes the underlying <see cref="T:System.Net.Sockets.UdpClient"/> connection. + </summary> + <remarks> + <para> + The underlying <see cref="T:System.Net.Sockets.UdpClient"/> is initialized and binds to the + port number from which you intend to communicate. + </para> + <para> + Exceptions are passed to the <see cref="P:log4net.Appender.AppenderSkeleton.ErrorHandler"/>. + </para> + </remarks> + </member> + <member name="F:log4net.Appender.UdpAppender.m_remoteAddress"> + <summary> + The IP address of the remote host or multicast group to which + the logging event will be sent. + </summary> + </member> + <member name="F:log4net.Appender.UdpAppender.m_remotePort"> + <summary> + The TCP port number of the remote host or multicast group to + which the logging event will be sent. + </summary> + </member> + <member name="F:log4net.Appender.UdpAppender.m_remoteEndPoint"> + <summary> + The cached remote endpoint to which the logging events will be sent. + </summary> + </member> + <member name="F:log4net.Appender.UdpAppender.m_localPort"> + <summary> + The TCP port number from which the <see cref="T:System.Net.Sockets.UdpClient"/> will communicate. + </summary> + </member> + <member name="F:log4net.Appender.UdpAppender.m_client"> + <summary> + The <see cref="T:System.Net.Sockets.UdpClient"/> instance that will be used for sending the + logging events. + </summary> + </member> + <member name="F:log4net.Appender.UdpAppender.m_encoding"> + <summary> + The encoding to use for the packet. + </summary> + </member> + <member name="P:log4net.Appender.UdpAppender.RemoteAddress"> + <summary> + Gets or sets the IP address of the remote host or multicast group to which + the underlying <see cref="T:System.Net.Sockets.UdpClient"/> should sent the logging event. + </summary> + <value> + The IP address of the remote host or multicast group to which the logging event + will be sent. + </value> + <remarks> + <para> + Multicast addresses are identified by IP class <b>D</b> addresses (in the range 224.0.0.0 to + 239.255.255.255). Multicast packets can pass across different networks through routers, so + it is possible to use multicasts in an Internet scenario as long as your network provider + supports multicasting. + </para> + <para> + Hosts that want to receive particular multicast messages must register their interest by joining + the multicast group. Multicast messages are not sent to networks where no host has joined + the multicast group. Class <b>D</b> IP addresses are used for multicast groups, to differentiate + them from normal host addresses, allowing nodes to easily detect if a message is of interest. + </para> + <para> + Static multicast addresses that are needed globally are assigned by IANA. A few examples are listed in the table below: + </para> + <para> + <list type="table"> + <listheader> + <term>IP Address</term> + <description>Description</description> + </listheader> + <item> + <term>224.0.0.1</term> + <description> + <para> + Sends a message to all system on the subnet. + </para> + </description> + </item> + <item> + <term>224.0.0.2</term> + <description> + <para> + Sends a message to all routers on the subnet. + </para> + </description> + </item> + <item> + <term>224.0.0.12</term> + <description> + <para> + The DHCP server answers messages on the IP address 224.0.0.12, but only on a subnet. + </para> + </description> + </item> + </list> + </para> + <para> + A complete list of actually reserved multicast addresses and their owners in the ranges + defined by RFC 3171 can be found at the <A href="http://www.iana.org/assignments/multicast-addresses">IANA web site</A>. + </para> + <para> + The address range 239.0.0.0 to 239.255.255.255 is reserved for administrative scope-relative + addresses. These addresses can be reused with other local groups. Routers are typically + configured with filters to prevent multicast traffic in this range from flowing outside + of the local network. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.UdpAppender.RemotePort"> + <summary> + Gets or sets the TCP port number of the remote host or multicast group to which + the underlying <see cref="T:System.Net.Sockets.UdpClient"/> should sent the logging event. + </summary> + <value> + An integer value in the range <see cref="F:System.Net.IPEndPoint.MinPort"/> to <see cref="F:System.Net.IPEndPoint.MaxPort"/> + indicating the TCP port number of the remote host or multicast group to which the logging event + will be sent. + </value> + <remarks> + The underlying <see cref="T:System.Net.Sockets.UdpClient"/> will send messages to this TCP port number + on the remote host or multicast group. + </remarks> + <exception cref="T:System.ArgumentOutOfRangeException">The value specified is less than <see cref="F:System.Net.IPEndPoint.MinPort"/> or greater than <see cref="F:System.Net.IPEndPoint.MaxPort"/>.</exception> + </member> + <member name="P:log4net.Appender.UdpAppender.LocalPort"> + <summary> + Gets or sets the TCP port number from which the underlying <see cref="T:System.Net.Sockets.UdpClient"/> will communicate. + </summary> + <value> + An integer value in the range <see cref="F:System.Net.IPEndPoint.MinPort"/> to <see cref="F:System.Net.IPEndPoint.MaxPort"/> + indicating the TCP port number from which the underlying <see cref="T:System.Net.Sockets.UdpClient"/> will communicate. + </value> + <remarks> + <para> + The underlying <see cref="T:System.Net.Sockets.UdpClient"/> will bind to this port for sending messages. + </para> + <para> + Setting the value to 0 (the default) will cause the udp client not to bind to + a local port. + </para> + </remarks> + <exception cref="T:System.ArgumentOutOfRangeException">The value specified is less than <see cref="F:System.Net.IPEndPoint.MinPort"/> or greater than <see cref="F:System.Net.IPEndPoint.MaxPort"/>.</exception> + </member> + <member name="P:log4net.Appender.UdpAppender.Encoding"> + <summary> + Gets or sets <see cref="P:log4net.Appender.UdpAppender.Encoding"/> used to write the packets. + </summary> + <value> + The <see cref="P:log4net.Appender.UdpAppender.Encoding"/> used to write the packets. + </value> + <remarks> + <para> + The <see cref="P:log4net.Appender.UdpAppender.Encoding"/> used to write the packets. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.UdpAppender.Client"> + <summary> + Gets or sets the underlying <see cref="T:System.Net.Sockets.UdpClient"/>. + </summary> + <value> + The underlying <see cref="T:System.Net.Sockets.UdpClient"/>. + </value> + <remarks> + <see cref="T:log4net.Appender.UdpAppender"/> creates a <see cref="T:System.Net.Sockets.UdpClient"/> to send logging events + over a network. Classes deriving from <see cref="T:log4net.Appender.UdpAppender"/> can use this + property to get or set this <see cref="T:System.Net.Sockets.UdpClient"/>. Use the underlying <see cref="T:System.Net.Sockets.UdpClient"/> + returned from <see cref="P:log4net.Appender.UdpAppender.Client"/> if you require access beyond that which + <see cref="T:log4net.Appender.UdpAppender"/> provides. + </remarks> + </member> + <member name="P:log4net.Appender.UdpAppender.RemoteEndPoint"> + <summary> + Gets or sets the cached remote endpoint to which the logging events should be sent. + </summary> + <value> + The cached remote endpoint to which the logging events will be sent. + </value> + <remarks> + The <see cref="M:log4net.Appender.UdpAppender.ActivateOptions"/> method will initialize the remote endpoint + with the values of the <see cref="P:log4net.Appender.UdpAppender.RemoteAddress"/> and <see cref="P:log4net.Appender.UdpAppender.RemotePort"/> + properties. + </remarks> + </member> + <member name="P:log4net.Appender.UdpAppender.RequiresLayout"> + <summary> + This appender requires a <see cref="N:log4net.Layout"/> to be set. + </summary> + <value><c>true</c></value> + <remarks> + <para> + This appender requires a <see cref="N:log4net.Layout"/> to be set. + </para> + </remarks> + </member> + <member name="F:log4net.Appender.RemoteSyslogAppender.DefaultSyslogPort"> + <summary> + Syslog port 514 + </summary> + </member> + <member name="F:log4net.Appender.RemoteSyslogAppender.c_renderBufferSize"> + <summary> + Initial buffer size + </summary> + </member> + <member name="F:log4net.Appender.RemoteSyslogAppender.c_renderBufferMaxCapacity"> + <summary> + Maximum buffer size before it is recycled + </summary> + </member> + <member name="M:log4net.Appender.RemoteSyslogAppender.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:log4net.Appender.RemoteSyslogAppender"/> class. + </summary> + <remarks> + This instance of the <see cref="T:log4net.Appender.RemoteSyslogAppender"/> class is set up to write + to a remote syslog daemon. + </remarks> + </member> + <member name="M:log4net.Appender.RemoteSyslogAppender.AddMapping(log4net.Appender.RemoteSyslogAppender.LevelSeverity)"> + <summary> + Add a mapping of level to severity + </summary> + <param name="mapping">The mapping to add</param> + <remarks> + <para> + Add a <see cref="T:log4net.Appender.RemoteSyslogAppender.LevelSeverity"/> mapping to this appender. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.RemoteSyslogAppender.Append(log4net.Core.LoggingEvent)"> + <summary> + This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method. + </summary> + <param name="loggingEvent">The event to log.</param> + <remarks> + <para> + Writes the event to a remote syslog daemon. + </para> + <para> + The format of the output will depend on the appender's layout. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.RemoteSyslogAppender.ActivateOptions"> + <summary> + Initialize the options for this appender + </summary> + <remarks> + <para> + Initialize the level to syslog severity mappings set on this appender. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.RemoteSyslogAppender.GetSeverity(log4net.Core.Level)"> + <summary> + Translates a log4net level to a syslog severity. + </summary> + <param name="level">A log4net level.</param> + <returns>A syslog severity.</returns> + <remarks> + <para> + Translates a log4net level to a syslog severity. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.RemoteSyslogAppender.GeneratePriority(log4net.Appender.RemoteSyslogAppender.SyslogFacility,log4net.Appender.RemoteSyslogAppender.SyslogSeverity)"> + <summary> + Generate a syslog priority. + </summary> + <param name="facility">The syslog facility.</param> + <param name="severity">The syslog severity.</param> + <returns>A syslog priority.</returns> + <remarks> + <para> + Generate a syslog priority. + </para> + </remarks> + </member> + <member name="F:log4net.Appender.RemoteSyslogAppender.m_facility"> + <summary> + The facility. The default facility is <see cref="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.User"/>. + </summary> + </member> + <member name="F:log4net.Appender.RemoteSyslogAppender.m_identity"> + <summary> + The message identity + </summary> + </member> + <member name="F:log4net.Appender.RemoteSyslogAppender.m_levelMapping"> + <summary> + Mapping from level object to syslog severity + </summary> + </member> + <member name="P:log4net.Appender.RemoteSyslogAppender.Identity"> + <summary> + Message identity + </summary> + <remarks> + <para> + An identifier is specified with each log message. This can be specified + by setting the <see cref="P:log4net.Appender.RemoteSyslogAppender.Identity"/> property. The identity (also know + as the tag) must not contain white space. The default value for the + identity is the application name (from <see cref="P:log4net.Core.LoggingEvent.Domain"/>). + </para> + </remarks> + </member> + <member name="P:log4net.Appender.RemoteSyslogAppender.Facility"> + <summary> + Syslog facility + </summary> + <remarks> + Set to one of the <see cref="T:log4net.Appender.RemoteSyslogAppender.SyslogFacility"/> values. The list of + facilities is predefined and cannot be extended. The default value + is <see cref="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.User"/>. + </remarks> + </member> + <member name="T:log4net.Appender.RemoteSyslogAppender.SyslogSeverity"> + <summary> + syslog severities + </summary> + <remarks> + <para> + The syslog severities. + </para> + </remarks> + </member> + <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Emergency"> + <summary> + system is unusable + </summary> + </member> + <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Alert"> + <summary> + action must be taken immediately + </summary> + </member> + <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Critical"> + <summary> + critical conditions + </summary> + </member> + <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Error"> + <summary> + error conditions + </summary> + </member> + <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Warning"> + <summary> + warning conditions + </summary> + </member> + <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Notice"> + <summary> + normal but significant condition + </summary> + </member> + <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Informational"> + <summary> + informational + </summary> + </member> + <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Debug"> + <summary> + debug-level messages + </summary> + </member> + <member name="T:log4net.Appender.RemoteSyslogAppender.SyslogFacility"> + <summary> + syslog facilities + </summary> + <remarks> + <para> + The syslog facilities + </para> + </remarks> + </member> + <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Kernel"> + <summary> + kernel messages + </summary> + </member> + <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.User"> + <summary> + random user-level messages + </summary> + </member> + <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Mail"> + <summary> + mail system + </summary> + </member> + <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Daemons"> + <summary> + system daemons + </summary> + </member> + <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Authorization"> + <summary> + security/authorization messages + </summary> + </member> + <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Syslog"> + <summary> + messages generated internally by syslogd + </summary> + </member> + <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Printer"> + <summary> + line printer subsystem + </summary> + </member> + <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.News"> + <summary> + network news subsystem + </summary> + </member> + <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Uucp"> + <summary> + UUCP subsystem + </summary> + </member> + <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Clock"> + <summary> + clock (cron/at) daemon + </summary> + </member> + <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Authorization2"> + <summary> + security/authorization messages (private) + </summary> + </member> + <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Ftp"> + <summary> + ftp daemon + </summary> + </member> + <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Ntp"> + <summary> + NTP subsystem + </summary> + </member> + <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Audit"> + <summary> + log audit + </summary> + </member> + <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Alert"> + <summary> + log alert + </summary> + </member> + <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Clock2"> + <summary> + clock daemon + </summary> + </member> + <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local0"> + <summary> + reserved for local use + </summary> + </member> + <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local1"> + <summary> + reserved for local use + </summary> + </member> + <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local2"> + <summary> + reserved for local use + </summary> + </member> + <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local3"> + <summary> + reserved for local use + </summary> + </member> + <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local4"> + <summary> + reserved for local use + </summary> + </member> + <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local5"> + <summary> + reserved for local use + </summary> + </member> + <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local6"> + <summary> + reserved for local use + </summary> + </member> + <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local7"> + <summary> + reserved for local use + </summary> + </member> + <member name="T:log4net.Appender.RemoteSyslogAppender.LevelSeverity"> + <summary> + A class to act as a mapping between the level that a logging call is made at and + the syslog severity that is should be logged at. + </summary> + <remarks> + <para> + A class to act as a mapping between the level that a logging call is made at and + the syslog severity that is should be logged at. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.RemoteSyslogAppender.LevelSeverity.Severity"> + <summary> + The mapped syslog severity for the specified level + </summary> + <remarks> + <para> + Required property. + The mapped syslog severity for the specified level + </para> + </remarks> + </member> + <member name="T:log4net.Appender.RemotingAppender"> + <summary> + Delivers logging events to a remote logging sink. + </summary> + <remarks> + <para> + This Appender is designed to deliver events to a remote sink. + That is any object that implements the <see cref="T:log4net.Appender.RemotingAppender.IRemoteLoggingSink"/> + interface. It delivers the events using .NET remoting. The + object to deliver events to is specified by setting the + appenders <see cref="P:log4net.Appender.RemotingAppender.Sink"/> property.</para> + <para> + The RemotingAppender buffers events before sending them. This allows it to + make more efficient use of the remoting infrastructure.</para> + <para> + Once the buffer is full the events are still not sent immediately. + They are scheduled to be sent using a pool thread. The effect is that + the send occurs asynchronously. This is very important for a + number of non obvious reasons. The remoting infrastructure will + flow thread local variables (stored in the <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/>), + if they are marked as <see cref="T:System.Runtime.Remoting.Messaging.ILogicalThreadAffinative"/>, across the + remoting boundary. If the server is not contactable then + the remoting infrastructure will clear the <see cref="T:System.Runtime.Remoting.Messaging.ILogicalThreadAffinative"/> + objects from the <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/>. To prevent a logging failure from + having side effects on the calling application the remoting call must be made + from a separate thread to the one used by the application. A <see cref="T:System.Threading.ThreadPool"/> + thread is used for this. If no <see cref="T:System.Threading.ThreadPool"/> thread is available then + the events will block in the thread pool manager until a thread is available.</para> + <para> + Because the events are sent asynchronously using pool threads it is possible to close + this appender before all the queued events have been sent. + When closing the appender attempts to wait until all the queued events have been sent, but + this will timeout after 30 seconds regardless.</para> + <para> + If this appender is being closed because the <see cref="E:System.AppDomain.ProcessExit"/> + event has fired it may not be possible to send all the queued events. During process + exit the runtime limits the time that a <see cref="E:System.AppDomain.ProcessExit"/> + event handler is allowed to run for. If the runtime terminates the threads before + the queued events have been sent then they will be lost. To ensure that all events + are sent the appender must be closed before the application exits. See + <see cref="M:log4net.Core.LoggerManager.Shutdown"/> for details on how to shutdown + log4net programmatically.</para> + </remarks> + <seealso cref="T:log4net.Appender.RemotingAppender.IRemoteLoggingSink"/> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + <author>Daniel Cazzulino</author> + </member> + <member name="M:log4net.Appender.RemotingAppender.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:log4net.Appender.RemotingAppender"/> class. + </summary> + <remarks> + <para> + Default constructor. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.RemotingAppender.ActivateOptions"> + <summary> + Initialize the appender based on the options set + </summary> + <remarks> + <para> + This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object + activation scheme. The <see cref="M:log4net.Appender.RemotingAppender.ActivateOptions"/> method must + be called on this object after the configuration properties have + been set. Until <see cref="M:log4net.Appender.RemotingAppender.ActivateOptions"/> is called this + object is in an undefined state and must not be used. + </para> + <para> + If any of the configuration properties are modified then + <see cref="M:log4net.Appender.RemotingAppender.ActivateOptions"/> must be called again. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.RemotingAppender.SendBuffer(log4net.Core.LoggingEvent[])"> + <summary> + Send the contents of the buffer to the remote sink. + </summary> + <remarks> + The events are not sent immediately. They are scheduled to be sent + using a pool thread. The effect is that the send occurs asynchronously. + This is very important for a number of non obvious reasons. The remoting + infrastructure will flow thread local variables (stored in the <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/>), + if they are marked as <see cref="T:System.Runtime.Remoting.Messaging.ILogicalThreadAffinative"/>, across the + remoting boundary. If the server is not contactable then + the remoting infrastructure will clear the <see cref="T:System.Runtime.Remoting.Messaging.ILogicalThreadAffinative"/> + objects from the <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/>. To prevent a logging failure from + having side effects on the calling application the remoting call must be made + from a separate thread to the one used by the application. A <see cref="T:System.Threading.ThreadPool"/> + thread is used for this. If no <see cref="T:System.Threading.ThreadPool"/> thread is available then + the events will block in the thread pool manager until a thread is available. + </remarks> + <param name="events">The events to send.</param> + </member> + <member name="M:log4net.Appender.RemotingAppender.OnClose"> + <summary> + Override base class close. + </summary> + <remarks> + <para> + This method waits while there are queued work items. The events are + sent asynchronously using <see cref="T:System.Threading.ThreadPool"/> work items. These items + will be sent once a thread pool thread is available to send them, therefore + it is possible to close the appender before all the queued events have been + sent.</para> + <para> + This method attempts to wait until all the queued events have been sent, but this + method will timeout after 30 seconds regardless.</para> + <para> + If the appender is being closed because the <see cref="E:System.AppDomain.ProcessExit"/> + event has fired it may not be possible to send all the queued events. During process + exit the runtime limits the time that a <see cref="E:System.AppDomain.ProcessExit"/> + event handler is allowed to run for.</para> + </remarks> + </member> + <member name="M:log4net.Appender.RemotingAppender.BeginAsyncSend"> + <summary> + A work item is being queued into the thread pool + </summary> + </member> + <member name="M:log4net.Appender.RemotingAppender.EndAsyncSend"> + <summary> + A work item from the thread pool has completed + </summary> + </member> + <member name="M:log4net.Appender.RemotingAppender.SendBufferCallback(System.Object)"> + <summary> + Send the contents of the buffer to the remote sink. + </summary> + <remarks> + This method is designed to be used with the <see cref="T:System.Threading.ThreadPool"/>. + This method expects to be passed an array of <see cref="T:log4net.Core.LoggingEvent"/> + objects in the state param. + </remarks> + <param name="state">the logging events to send</param> + </member> + <member name="F:log4net.Appender.RemotingAppender.m_sinkUrl"> + <summary> + The URL of the remote sink. + </summary> + </member> + <member name="F:log4net.Appender.RemotingAppender.m_sinkObj"> + <summary> + The local proxy (.NET remoting) for the remote logging sink. + </summary> + </member> + <member name="F:log4net.Appender.RemotingAppender.m_queuedCallbackCount"> + <summary> + The number of queued callbacks currently waiting or executing + </summary> + </member> + <member name="F:log4net.Appender.RemotingAppender.m_workQueueEmptyEvent"> + <summary> + Event used to signal when there are no queued work items + </summary> + <remarks> + This event is set when there are no queued work items. In this + state it is safe to close the appender. + </remarks> + </member> + <member name="P:log4net.Appender.RemotingAppender.Sink"> + <summary> + Gets or sets the URL of the well-known object that will accept + the logging events. + </summary> + <value> + The well-known URL of the remote sink. + </value> + <remarks> + <para> + The URL of the remoting sink that will accept logging events. + The sink must implement the <see cref="T:log4net.Appender.RemotingAppender.IRemoteLoggingSink"/> + interface. + </para> + </remarks> + </member> + <member name="T:log4net.Appender.RemotingAppender.IRemoteLoggingSink"> + <summary> + Interface used to deliver <see cref="T:log4net.Core.LoggingEvent"/> objects to a remote sink. + </summary> + <remarks> + This interface must be implemented by a remoting sink + if the <see cref="T:log4net.Appender.RemotingAppender"/> is to be used + to deliver logging events to the sink. + </remarks> + </member> + <member name="M:log4net.Appender.RemotingAppender.IRemoteLoggingSink.LogEvents(log4net.Core.LoggingEvent[])"> + <summary> + Delivers logging events to the remote sink + </summary> + <param name="events">Array of events to log.</param> + <remarks> + <para> + Delivers logging events to the remote sink + </para> + </remarks> + </member> + <member name="T:log4net.Appender.RollingFileAppender"> + <summary> + Appender that rolls log files based on size or date or both. + </summary> + <remarks> + <para> + RollingFileAppender can roll log files based on size or date or both + depending on the setting of the <see cref="P:log4net.Appender.RollingFileAppender.RollingStyle"/> property. + When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Size"/> the log file will be rolled + once its size exceeds the <see cref="P:log4net.Appender.RollingFileAppender.MaximumFileSize"/>. + When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Date"/> the log file will be rolled + once the date boundary specified in the <see cref="P:log4net.Appender.RollingFileAppender.DatePattern"/> property + is crossed. + When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Composite"/> the log file will be + rolled once the date boundary specified in the <see cref="P:log4net.Appender.RollingFileAppender.DatePattern"/> property + is crossed, but within a date boundary the file will also be rolled + once its size exceeds the <see cref="P:log4net.Appender.RollingFileAppender.MaximumFileSize"/>. + When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Once"/> the log file will be rolled when + the appender is configured. This effectively means that the log file can be + rolled once per program execution. + </para> + <para> + A of few additional optional features have been added: + <list type="bullet"> + <item>Attach date pattern for current log file <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/></item> + <item>Backup number increments for newer files <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/></item> + <item>Infinite number of backups by file size <see cref="P:log4net.Appender.RollingFileAppender.MaxSizeRollBackups"/></item> + </list> + </para> + + <note> + <para> + For large or infinite numbers of backup files a <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/> + greater than zero is highly recommended, otherwise all the backup files need + to be renamed each time a new backup is created. + </para> + <para> + When Date/Time based rolling is used setting <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/> + to <see langword="true"/> will reduce the number of file renamings to few or none. + </para> + </note> + + <note type="caution"> + <para> + Changing <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/> or <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/> without clearing + the log file directory of backup files will cause unexpected and unwanted side effects. + </para> + </note> + + <para> + If Date/Time based rolling is enabled this appender will attempt to roll existing files + in the directory without a Date/Time tag based on the last write date of the base log file. + The appender only rolls the log file when a message is logged. If Date/Time based rolling + is enabled then the appender will not roll the log file at the Date/Time boundary but + at the point when the next message is logged after the boundary has been crossed. + </para> + + <para> + The <see cref="T:log4net.Appender.RollingFileAppender"/> extends the <see cref="T:log4net.Appender.FileAppender"/> and + has the same behavior when opening the log file. + The appender will first try to open the file for writing when <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/> + is called. This will typically be during configuration. + If the file cannot be opened for writing the appender will attempt + to open the file again each time a message is logged to the appender. + If the file cannot be opened for writing when a message is logged then + the message will be discarded by this appender. + </para> + <para> + When rolling a backup file necessitates deleting an older backup file the + file to be deleted is moved to a temporary name before being deleted. + </para> + + <note type="caution"> + <para> + A maximum number of backup files when rolling on date/time boundaries is not supported. + </para> + </note> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + <author>Aspi Havewala</author> + <author>Douglas de la Torre</author> + <author>Edward Smit</author> + </member> + <member name="M:log4net.Appender.RollingFileAppender.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:log4net.Appender.RollingFileAppender"/> class. + </summary> + <remarks> + <para> + Default constructor. + </para> + </remarks> + </member> + <member name="F:log4net.Appender.RollingFileAppender.declaringType"> + <summary> + The fully qualified type of the RollingFileAppender class. + </summary> + <remarks> + Used by the internal logger to record the Type of the + log message. + </remarks> + </member> + <member name="M:log4net.Appender.RollingFileAppender.SetQWForFiles(System.IO.TextWriter)"> + <summary> + Sets the quiet writer being used. + </summary> + <remarks> + This method can be overridden by sub classes. + </remarks> + <param name="writer">the writer to set</param> + </member> + <member name="M:log4net.Appender.RollingFileAppender.Append(log4net.Core.LoggingEvent)"> + <summary> + Write out a logging event. + </summary> + <param name="loggingEvent">the event to write to file.</param> + <remarks> + <para> + Handles append time behavior for RollingFileAppender. This checks + if a roll over either by date (checked first) or time (checked second) + is need and then appends to the file last. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.RollingFileAppender.Append(log4net.Core.LoggingEvent[])"> + <summary> + Write out an array of logging events. + </summary> + <param name="loggingEvents">the events to write to file.</param> + <remarks> + <para> + Handles append time behavior for RollingFileAppender. This checks + if a roll over either by date (checked first) or time (checked second) + is need and then appends to the file last. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.RollingFileAppender.AdjustFileBeforeAppend"> + <summary> + Performs any required rolling before outputting the next event + </summary> + <remarks> + <para> + Handles append time behavior for RollingFileAppender. This checks + if a roll over either by date (checked first) or time (checked second) + is need and then appends to the file last. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.RollingFileAppender.OpenFile(System.String,System.Boolean)"> + <summary> + Creates and opens the file for logging. If <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/> + is false then the fully qualified name is determined and used. + </summary> + <param name="fileName">the name of the file to open</param> + <param name="append">true to append to existing file</param> + <remarks> + <para>This method will ensure that the directory structure + for the <paramref name="fileName"/> specified exists.</para> + </remarks> + </member> + <member name="M:log4net.Appender.RollingFileAppender.GetNextOutputFileName(System.String)"> + <summary> + Get the current output file name + </summary> + <param name="fileName">the base file name</param> + <returns>the output file name</returns> + <remarks> + The output file name is based on the base fileName specified. + If <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/> is set then the output + file name is the same as the base file passed in. Otherwise + the output file depends on the date pattern, on the count + direction or both. + </remarks> + </member> + <member name="M:log4net.Appender.RollingFileAppender.DetermineCurSizeRollBackups"> + <summary> + Determines curSizeRollBackups (only within the current roll point) + </summary> + </member> + <member name="M:log4net.Appender.RollingFileAppender.GetWildcardPatternForFile(System.String)"> + <summary> + Generates a wildcard pattern that can be used to find all files + that are similar to the base file name. + </summary> + <param name="baseFileName"></param> + <returns></returns> + </member> + <member name="M:log4net.Appender.RollingFileAppender.GetExistingFiles(System.String)"> + <summary> + Builds a list of filenames for all files matching the base filename plus a file + pattern. + </summary> + <param name="baseFilePath"></param> + <returns></returns> + </member> + <member name="M:log4net.Appender.RollingFileAppender.RollOverIfDateBoundaryCrossing"> + <summary> + Initiates a roll over if needed for crossing a date boundary since the last run. + </summary> + </member> + <member name="M:log4net.Appender.RollingFileAppender.ExistingInit"> + <summary> + Initializes based on existing conditions at time of <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/>. + </summary> + <remarks> + <para> + Initializes based on existing conditions at time of <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/>. + The following is done + <list type="bullet"> + <item>determine curSizeRollBackups (only within the current roll point)</item> + <item>initiates a roll over if needed for crossing a date boundary since the last run.</item> + </list> + </para> + </remarks> + </member> + <member name="M:log4net.Appender.RollingFileAppender.InitializeFromOneFile(System.String,System.String)"> + <summary> + Does the work of bumping the 'current' file counter higher + to the highest count when an incremental file name is seen. + The highest count is either the first file (when count direction + is greater than 0) or the last file (when count direction less than 0). + In either case, we want to know the highest count that is present. + </summary> + <param name="baseFile"></param> + <param name="curFileName"></param> + </member> + <member name="M:log4net.Appender.RollingFileAppender.GetBackUpIndex(System.String)"> + <summary> + Attempts to extract a number from the end of the file name that indicates + the number of the times the file has been rolled over. + </summary> + <remarks> + Certain date pattern extensions like yyyyMMdd will be parsed as valid backup indexes. + </remarks> + <param name="curFileName"></param> + <returns></returns> + </member> + <member name="M:log4net.Appender.RollingFileAppender.InitializeRollBackups(System.String,System.Collections.ArrayList)"> + <summary> + Takes a list of files and a base file name, and looks for + 'incremented' versions of the base file. Bumps the max + count up to the highest count seen. + </summary> + <param name="baseFile"></param> + <param name="arrayFiles"></param> + </member> + <member name="M:log4net.Appender.RollingFileAppender.ComputeCheckPeriod(System.String)"> + <summary> + Calculates the RollPoint for the datePattern supplied. + </summary> + <param name="datePattern">the date pattern to calculate the check period for</param> + <returns>The RollPoint that is most accurate for the date pattern supplied</returns> + <remarks> + Essentially the date pattern is examined to determine what the + most suitable roll point is. The roll point chosen is the roll point + with the smallest period that can be detected using the date pattern + supplied. i.e. if the date pattern only outputs the year, month, day + and hour then the smallest roll point that can be detected would be + and hourly roll point as minutes could not be detected. + </remarks> + </member> + <member name="M:log4net.Appender.RollingFileAppender.ActivateOptions"> + <summary> + Initialize the appender based on the options set + </summary> + <remarks> + <para> + This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object + activation scheme. The <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/> method must + be called on this object after the configuration properties have + been set. Until <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/> is called this + object is in an undefined state and must not be used. + </para> + <para> + If any of the configuration properties are modified then + <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/> must be called again. + </para> + <para> + Sets initial conditions including date/time roll over information, first check, + scheduledFilename, and calls <see cref="M:log4net.Appender.RollingFileAppender.ExistingInit"/> to initialize + the current number of backups. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.RollingFileAppender.CombinePath(System.String,System.String)"> + <summary> + + </summary> + <param name="path1"></param> + <param name="path2">.1, .2, .3, etc.</param> + <returns></returns> + </member> + <member name="M:log4net.Appender.RollingFileAppender.RollOverTime(System.Boolean)"> + <summary> + Rollover the file(s) to date/time tagged file(s). + </summary> + <param name="fileIsOpen">set to true if the file to be rolled is currently open</param> + <remarks> + <para> + Rollover the file(s) to date/time tagged file(s). + Resets curSizeRollBackups. + If fileIsOpen is set then the new file is opened (through SafeOpenFile). + </para> + </remarks> + </member> + <member name="M:log4net.Appender.RollingFileAppender.RollFile(System.String,System.String)"> + <summary> + Renames file <paramref name="fromFile"/> to file <paramref name="toFile"/>. + </summary> + <param name="fromFile">Name of existing file to roll.</param> + <param name="toFile">New name for file.</param> + <remarks> + <para> + Renames file <paramref name="fromFile"/> to file <paramref name="toFile"/>. It + also checks for existence of target file and deletes if it does. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.RollingFileAppender.FileExists(System.String)"> + <summary> + Test if a file exists at a specified path + </summary> + <param name="path">the path to the file</param> + <returns>true if the file exists</returns> + <remarks> + <para> + Test if a file exists at a specified path + </para> + </remarks> + </member> + <member name="M:log4net.Appender.RollingFileAppender.DeleteFile(System.String)"> + <summary> + Deletes the specified file if it exists. + </summary> + <param name="fileName">The file to delete.</param> + <remarks> + <para> + Delete a file if is exists. + The file is first moved to a new filename then deleted. + This allows the file to be removed even when it cannot + be deleted, but it still can be moved. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.RollingFileAppender.RollOverSize"> + <summary> + Implements file roll base on file size. + </summary> + <remarks> + <para> + If the maximum number of size based backups is reached + (<c>curSizeRollBackups == maxSizeRollBackups</c>) then the oldest + file is deleted -- its index determined by the sign of countDirection. + If <c>countDirection</c> < 0, then files + {<c>File.1</c>, ..., <c>File.curSizeRollBackups -1</c>} + are renamed to {<c>File.2</c>, ..., + <c>File.curSizeRollBackups</c>}. Moreover, <c>File</c> is + renamed <c>File.1</c> and closed. + </para> + <para> + A new file is created to receive further log output. + </para> + <para> + If <c>maxSizeRollBackups</c> is equal to zero, then the + <c>File</c> is truncated with no backup files created. + </para> + <para> + If <c>maxSizeRollBackups</c> < 0, then <c>File</c> is + renamed if needed and no files are deleted. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.RollingFileAppender.RollOverRenameFiles(System.String)"> + <summary> + Implements file roll. + </summary> + <param name="baseFileName">the base name to rename</param> + <remarks> + <para> + If the maximum number of size based backups is reached + (<c>curSizeRollBackups == maxSizeRollBackups</c>) then the oldest + file is deleted -- its index determined by the sign of countDirection. + If <c>countDirection</c> < 0, then files + {<c>File.1</c>, ..., <c>File.curSizeRollBackups -1</c>} + are renamed to {<c>File.2</c>, ..., + <c>File.curSizeRollBackups</c>}. + </para> + <para> + If <c>maxSizeRollBackups</c> is equal to zero, then the + <c>File</c> is truncated with no backup files created. + </para> + <para> + If <c>maxSizeRollBackups</c> < 0, then <c>File</c> is + renamed if needed and no files are deleted. + </para> + <para> + This is called by <see cref="M:log4net.Appender.RollingFileAppender.RollOverSize"/> to rename the files. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.RollingFileAppender.NextCheckDate(System.DateTime,log4net.Appender.RollingFileAppender.RollPoint)"> + <summary> + Get the start time of the next window for the current rollpoint + </summary> + <param name="currentDateTime">the current date</param> + <param name="rollPoint">the type of roll point we are working with</param> + <returns>the start time for the next roll point an interval after the currentDateTime date</returns> + <remarks> + <para> + Returns the date of the next roll point after the currentDateTime date passed to the method. + </para> + <para> + The basic strategy is to subtract the time parts that are less significant + than the rollpoint from the current time. This should roll the time back to + the start of the time window for the current rollpoint. Then we add 1 window + worth of time and get the start time of the next window for the rollpoint. + </para> + </remarks> + </member> + <member name="F:log4net.Appender.RollingFileAppender.m_dateTime"> + <summary> + This object supplies the current date/time. Allows test code to plug in + a method to control this class when testing date/time based rolling. The default + implementation uses the underlying value of DateTime.Now. + </summary> + </member> + <member name="F:log4net.Appender.RollingFileAppender.m_datePattern"> + <summary> + The date pattern. By default, the pattern is set to <c>".yyyy-MM-dd"</c> + meaning daily rollover. + </summary> + </member> + <member name="F:log4net.Appender.RollingFileAppender.m_scheduledFilename"> + <summary> + The actual formatted filename that is currently being written to + or will be the file transferred to on roll over + (based on staticLogFileName). + </summary> + </member> + <member name="F:log4net.Appender.RollingFileAppender.m_nextCheck"> + <summary> + The timestamp when we shall next recompute the filename. + </summary> + </member> + <member name="F:log4net.Appender.RollingFileAppender.m_now"> + <summary> + Holds date of last roll over + </summary> + </member> + <member name="F:log4net.Appender.RollingFileAppender.m_rollPoint"> + <summary> + The type of rolling done + </summary> + </member> + <member name="F:log4net.Appender.RollingFileAppender.m_maxFileSize"> + <summary> + The default maximum file size is 10MB + </summary> + </member> + <member name="F:log4net.Appender.RollingFileAppender.m_maxSizeRollBackups"> + <summary> + There is zero backup files by default + </summary> + </member> + <member name="F:log4net.Appender.RollingFileAppender.m_curSizeRollBackups"> + <summary> + How many sized based backups have been made so far + </summary> + </member> + <member name="F:log4net.Appender.RollingFileAppender.m_countDirection"> + <summary> + The rolling file count direction. + </summary> + </member> + <member name="F:log4net.Appender.RollingFileAppender.m_rollingStyle"> + <summary> + The rolling mode used in this appender. + </summary> + </member> + <member name="F:log4net.Appender.RollingFileAppender.m_rollDate"> + <summary> + Cache flag set if we are rolling by date. + </summary> + </member> + <member name="F:log4net.Appender.RollingFileAppender.m_rollSize"> + <summary> + Cache flag set if we are rolling by size. + </summary> + </member> + <member name="F:log4net.Appender.RollingFileAppender.m_staticLogFileName"> + <summary> + Value indicating whether to always log to the same file. + </summary> + </member> + <member name="F:log4net.Appender.RollingFileAppender.m_preserveLogFileNameExtension"> + <summary> + Value indicating whether to preserve the file name extension when rolling. + </summary> + </member> + <member name="F:log4net.Appender.RollingFileAppender.m_baseFileName"> + <summary> + FileName provided in configuration. Used for rolling properly + </summary> + </member> + <member name="F:log4net.Appender.RollingFileAppender.s_date1970"> + <summary> + The 1st of January 1970 in UTC + </summary> + </member> + <member name="P:log4net.Appender.RollingFileAppender.DateTimeStrategy"> + <summary> + Gets or sets the strategy for determining the current date and time. The default + implementation is to use LocalDateTime which internally calls through to DateTime.Now. + DateTime.UtcNow may be used on frameworks newer than .NET 1.0 by specifying + <see cref="T:log4net.Appender.RollingFileAppender.UniversalDateTime"/>. + </summary> + <value> + An implementation of the <see cref="T:log4net.Appender.RollingFileAppender.IDateTime"/> interface which returns the current date and time. + </value> + <remarks> + <para> + Gets or sets the <see cref="T:log4net.Appender.RollingFileAppender.IDateTime"/> used to return the current date and time. + </para> + <para> + There are two built strategies for determining the current date and time, + <see cref="T:log4net.Appender.RollingFileAppender.LocalDateTime"/> + and <see cref="T:log4net.Appender.RollingFileAppender.UniversalDateTime"/>. + </para> + <para> + The default strategy is <see cref="T:log4net.Appender.RollingFileAppender.LocalDateTime"/>. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.RollingFileAppender.DatePattern"> + <summary> + Gets or sets the date pattern to be used for generating file names + when rolling over on date. + </summary> + <value> + The date pattern to be used for generating file names when rolling + over on date. + </value> + <remarks> + <para> + Takes a string in the same format as expected by + <see cref="T:log4net.DateFormatter.SimpleDateFormatter"/>. + </para> + <para> + This property determines the rollover schedule when rolling over + on date. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.RollingFileAppender.MaxSizeRollBackups"> + <summary> + Gets or sets the maximum number of backup files that are kept before + the oldest is erased. + </summary> + <value> + The maximum number of backup files that are kept before the oldest is + erased. + </value> + <remarks> + <para> + If set to zero, then there will be no backup files and the log file + will be truncated when it reaches <see cref="P:log4net.Appender.RollingFileAppender.MaxFileSize"/>. + </para> + <para> + If a negative number is supplied then no deletions will be made. Note + that this could result in very slow performance as a large number of + files are rolled over unless <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/> is used. + </para> + <para> + The maximum applies to <b>each</b> time based group of files and + <b>not</b> the total. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.RollingFileAppender.MaxFileSize"> + <summary> + Gets or sets the maximum size that the output file is allowed to reach + before being rolled over to backup files. + </summary> + <value> + The maximum size in bytes that the output file is allowed to reach before being + rolled over to backup files. + </value> + <remarks> + <para> + This property is equivalent to <see cref="P:log4net.Appender.RollingFileAppender.MaximumFileSize"/> except + that it is required for differentiating the setter taking a + <see cref="T:System.Int64"/> argument from the setter taking a <see cref="T:System.String"/> + argument. + </para> + <para> + The default maximum file size is 10MB (10*1024*1024). + </para> + </remarks> + </member> + <member name="P:log4net.Appender.RollingFileAppender.MaximumFileSize"> + <summary> + Gets or sets the maximum size that the output file is allowed to reach + before being rolled over to backup files. + </summary> + <value> + The maximum size that the output file is allowed to reach before being + rolled over to backup files. + </value> + <remarks> + <para> + This property allows you to specify the maximum size with the + suffixes "KB", "MB" or "GB" so that the size is interpreted being + expressed respectively in kilobytes, megabytes or gigabytes. + </para> + <para> + For example, the value "10KB" will be interpreted as 10240 bytes. + </para> + <para> + The default maximum file size is 10MB. + </para> + <para> + If you have the option to set the maximum file size programmatically + consider using the <see cref="P:log4net.Appender.RollingFileAppender.MaxFileSize"/> property instead as this + allows you to set the size in bytes as a <see cref="T:System.Int64"/>. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.RollingFileAppender.CountDirection"> + <summary> + Gets or sets the rolling file count direction. + </summary> + <value> + The rolling file count direction. + </value> + <remarks> + <para> + Indicates if the current file is the lowest numbered file or the + highest numbered file. + </para> + <para> + By default newer files have lower numbers (<see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/> < 0), + i.e. log.1 is most recent, log.5 is the 5th backup, etc... + </para> + <para> + <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/> >= 0 does the opposite i.e. + log.1 is the first backup made, log.5 is the 5th backup made, etc. + For infinite backups use <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/> >= 0 to reduce + rollover costs. + </para> + <para>The default file count direction is -1.</para> + </remarks> + </member> + <member name="P:log4net.Appender.RollingFileAppender.RollingStyle"> + <summary> + Gets or sets the rolling style. + </summary> + <value>The rolling style.</value> + <remarks> + <para> + The default rolling style is <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Composite"/>. + </para> + <para> + When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Once"/> this appender's + <see cref="P:log4net.Appender.FileAppender.AppendToFile"/> property is set to <c>false</c>, otherwise + the appender would append to a single file rather than rolling + the file each time it is opened. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.RollingFileAppender.PreserveLogFileNameExtension"> + <summary> + Gets or sets a value indicating whether to preserve the file name extension when rolling. + </summary> + <value> + <c>true</c> if the file name extension should be preserved. + </value> + <remarks> + <para> + By default file.log is rolled to file.log.yyyy-MM-dd or file.log.curSizeRollBackup. + However, under Windows the new file name will loose any program associations as the + extension is changed. Optionally file.log can be renamed to file.yyyy-MM-dd.log or + file.curSizeRollBackup.log to maintain any program associations. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.RollingFileAppender.StaticLogFileName"> + <summary> + Gets or sets a value indicating whether to always log to + the same file. + </summary> + <value> + <c>true</c> if always should be logged to the same file, otherwise <c>false</c>. + </value> + <remarks> + <para> + By default file.log is always the current file. Optionally + file.log.yyyy-mm-dd for current formatted datePattern can by the currently + logging file (or file.log.curSizeRollBackup or even + file.log.yyyy-mm-dd.curSizeRollBackup). + </para> + <para> + This will make time based rollovers with a large number of backups + much faster as the appender it won't have to rename all the backups! + </para> + </remarks> + </member> + <member name="T:log4net.Appender.RollingFileAppender.RollingMode"> + <summary> + Style of rolling to use + </summary> + <remarks> + <para> + Style of rolling to use + </para> + </remarks> + </member> + <member name="F:log4net.Appender.RollingFileAppender.RollingMode.Once"> + <summary> + Roll files once per program execution + </summary> + <remarks> + <para> + Roll files once per program execution. + Well really once each time this appender is + configured. + </para> + <para> + Setting this option also sets <c>AppendToFile</c> to + <c>false</c> on the <c>RollingFileAppender</c>, otherwise + this appender would just be a normal file appender. + </para> + </remarks> + </member> + <member name="F:log4net.Appender.RollingFileAppender.RollingMode.Size"> + <summary> + Roll files based only on the size of the file + </summary> + </member> + <member name="F:log4net.Appender.RollingFileAppender.RollingMode.Date"> + <summary> + Roll files based only on the date + </summary> + </member> + <member name="F:log4net.Appender.RollingFileAppender.RollingMode.Composite"> + <summary> + Roll files based on both the size and date of the file + </summary> + </member> + <member name="T:log4net.Appender.RollingFileAppender.RollPoint"> + <summary> + The code assumes that the following 'time' constants are in a increasing sequence. + </summary> + <remarks> + <para> + The code assumes that the following 'time' constants are in a increasing sequence. + </para> + </remarks> + </member> + <member name="F:log4net.Appender.RollingFileAppender.RollPoint.InvalidRollPoint"> + <summary> + Roll the log not based on the date + </summary> + </member> + <member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfMinute"> + <summary> + Roll the log for each minute + </summary> + </member> + <member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfHour"> + <summary> + Roll the log for each hour + </summary> + </member> + <member name="F:log4net.Appender.RollingFileAppender.RollPoint.HalfDay"> + <summary> + Roll the log twice a day (midday and midnight) + </summary> + </member> + <member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfDay"> + <summary> + Roll the log each day (midnight) + </summary> + </member> + <member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfWeek"> + <summary> + Roll the log each week + </summary> + </member> + <member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfMonth"> + <summary> + Roll the log each month + </summary> + </member> + <member name="T:log4net.Appender.RollingFileAppender.IDateTime"> + <summary> + This interface is used to supply Date/Time information to the <see cref="T:log4net.Appender.RollingFileAppender"/>. + </summary> + <remarks> + This interface is used to supply Date/Time information to the <see cref="T:log4net.Appender.RollingFileAppender"/>. + Used primarily to allow test classes to plug themselves in so they can + supply test date/times. + </remarks> + </member> + <member name="P:log4net.Appender.RollingFileAppender.IDateTime.Now"> + <summary> + Gets the <i>current</i> time. + </summary> + <value>The <i>current</i> time.</value> + <remarks> + <para> + Gets the <i>current</i> time. + </para> + </remarks> + </member> + <member name="T:log4net.Appender.RollingFileAppender.LocalDateTime"> + <summary> + Default implementation of <see cref="T:log4net.Appender.RollingFileAppender.IDateTime"/> that returns the current time. + </summary> + </member> + <member name="P:log4net.Appender.RollingFileAppender.LocalDateTime.Now"> + <summary> + Gets the <b>current</b> time. + </summary> + <value>The <b>current</b> time.</value> + <remarks> + <para> + Gets the <b>current</b> time. + </para> + </remarks> + </member> + <member name="T:log4net.Appender.RollingFileAppender.UniversalDateTime"> + <summary> + Implementation of <see cref="T:log4net.Appender.RollingFileAppender.IDateTime"/> that returns the current time as the coordinated universal time (UTC). + </summary> + </member> + <member name="P:log4net.Appender.RollingFileAppender.UniversalDateTime.Now"> + <summary> + Gets the <b>current</b> time. + </summary> + <value>The <b>current</b> time.</value> + <remarks> + <para> + Gets the <b>current</b> time. + </para> + </remarks> + </member> + <member name="T:log4net.Appender.SmtpAppender"> + <summary> + Send an e-mail when a specific logging event occurs, typically on errors + or fatal errors. + </summary> + <remarks> + <para> + The number of logging events delivered in this e-mail depend on + the value of <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> option. The + <see cref="T:log4net.Appender.SmtpAppender"/> keeps only the last + <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> logging events in its + cyclic buffer. This keeps memory requirements at a reasonable level while + still delivering useful application context. + </para> + <note type="caution"> + Authentication and setting the server Port are only available on the MS .NET 1.1 runtime. + For these features to be enabled you need to ensure that you are using a version of + the log4net assembly that is built against the MS .NET 1.1 framework and that you are + running the your application on the MS .NET 1.1 runtime. On all other platforms only sending + unauthenticated messages to a server listening on port 25 (the default) is supported. + </note> + <para> + Authentication is supported by setting the <see cref="P:log4net.Appender.SmtpAppender.Authentication"/> property to + either <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/> or <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Ntlm"/>. + If using <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/> authentication then the <see cref="P:log4net.Appender.SmtpAppender.Username"/> + and <see cref="P:log4net.Appender.SmtpAppender.Password"/> properties must also be set. + </para> + <para> + To set the SMTP server port use the <see cref="P:log4net.Appender.SmtpAppender.Port"/> property. The default port is 25. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Appender.SmtpAppender.#ctor"> + <summary> + Default constructor + </summary> + <remarks> + <para> + Default constructor + </para> + </remarks> + </member> + <member name="M:log4net.Appender.SmtpAppender.SendBuffer(log4net.Core.LoggingEvent[])"> + <summary> + Sends the contents of the cyclic buffer as an e-mail message. + </summary> + <param name="events">The logging events to send.</param> + </member> + <member name="M:log4net.Appender.SmtpAppender.SendEmail(System.String)"> + <summary> + Send the email message + </summary> + <param name="messageBody">the body text to include in the mail</param> + </member> + <member name="P:log4net.Appender.SmtpAppender.To"> + <summary> + Gets or sets a comma- or semicolon-delimited list of recipient e-mail addresses (use semicolon on .NET 1.1 and comma for later versions). + </summary> + <value> + <para> + For .NET 1.1 (System.Web.Mail): A semicolon-delimited list of e-mail addresses. + </para> + <para> + For .NET 2.0 (System.Net.Mail): A comma-delimited list of e-mail addresses. + </para> + </value> + <remarks> + <para> + For .NET 1.1 (System.Web.Mail): A semicolon-delimited list of e-mail addresses. + </para> + <para> + For .NET 2.0 (System.Net.Mail): A comma-delimited list of e-mail addresses. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.SmtpAppender.Cc"> + <summary> + Gets or sets a comma- or semicolon-delimited list of recipient e-mail addresses + that will be carbon copied (use semicolon on .NET 1.1 and comma for later versions). + </summary> + <value> + <para> + For .NET 1.1 (System.Web.Mail): A semicolon-delimited list of e-mail addresses. + </para> + <para> + For .NET 2.0 (System.Net.Mail): A comma-delimited list of e-mail addresses. + </para> + </value> + <remarks> + <para> + For .NET 1.1 (System.Web.Mail): A semicolon-delimited list of e-mail addresses. + </para> + <para> + For .NET 2.0 (System.Net.Mail): A comma-delimited list of e-mail addresses. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.SmtpAppender.Bcc"> + <summary> + Gets or sets a semicolon-delimited list of recipient e-mail addresses + that will be blind carbon copied. + </summary> + <value> + A semicolon-delimited list of e-mail addresses. + </value> + <remarks> + <para> + A semicolon-delimited list of recipient e-mail addresses. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.SmtpAppender.From"> + <summary> + Gets or sets the e-mail address of the sender. + </summary> + <value> + The e-mail address of the sender. + </value> + <remarks> + <para> + The e-mail address of the sender. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.SmtpAppender.Subject"> + <summary> + Gets or sets the subject line of the e-mail message. + </summary> + <value> + The subject line of the e-mail message. + </value> + <remarks> + <para> + The subject line of the e-mail message. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.SmtpAppender.SmtpHost"> + <summary> + Gets or sets the name of the SMTP relay mail server to use to send + the e-mail messages. + </summary> + <value> + The name of the e-mail relay server. If SmtpServer is not set, the + name of the local SMTP server is used. + </value> + <remarks> + <para> + The name of the e-mail relay server. If SmtpServer is not set, the + name of the local SMTP server is used. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.SmtpAppender.LocationInfo"> + <summary> + Obsolete + </summary> + <remarks> + Use the BufferingAppenderSkeleton Fix methods instead + </remarks> + <remarks> + <para> + Obsolete property. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.SmtpAppender.Authentication"> + <summary> + The mode to use to authentication with the SMTP server + </summary> + <remarks> + <note type="caution">Authentication is only available on the MS .NET 1.1 runtime.</note> + <para> + Valid Authentication mode values are: <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.None"/>, + <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/>, and <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Ntlm"/>. + The default value is <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.None"/>. When using + <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/> you must specify the <see cref="P:log4net.Appender.SmtpAppender.Username"/> + and <see cref="P:log4net.Appender.SmtpAppender.Password"/> to use to authenticate. + When using <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Ntlm"/> the Windows credentials for the current + thread, if impersonating, or the process will be used to authenticate. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.SmtpAppender.Username"> + <summary> + The username to use to authenticate with the SMTP server + </summary> + <remarks> + <note type="caution">Authentication is only available on the MS .NET 1.1 runtime.</note> + <para> + A <see cref="P:log4net.Appender.SmtpAppender.Username"/> and <see cref="P:log4net.Appender.SmtpAppender.Password"/> must be specified when + <see cref="P:log4net.Appender.SmtpAppender.Authentication"/> is set to <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/>, + otherwise the username will be ignored. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.SmtpAppender.Password"> + <summary> + The password to use to authenticate with the SMTP server + </summary> + <remarks> + <note type="caution">Authentication is only available on the MS .NET 1.1 runtime.</note> + <para> + A <see cref="P:log4net.Appender.SmtpAppender.Username"/> and <see cref="P:log4net.Appender.SmtpAppender.Password"/> must be specified when + <see cref="P:log4net.Appender.SmtpAppender.Authentication"/> is set to <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/>, + otherwise the password will be ignored. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.SmtpAppender.Port"> + <summary> + The port on which the SMTP server is listening + </summary> + <remarks> + <note type="caution">Server Port is only available on the MS .NET 1.1 runtime.</note> + <para> + The port on which the SMTP server is listening. The default + port is <c>25</c>. The Port can only be changed when running on + the MS .NET 1.1 runtime. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.SmtpAppender.Priority"> + <summary> + Gets or sets the priority of the e-mail message + </summary> + <value> + One of the <see cref="T:System.Net.Mail.MailPriority"/> values. + </value> + <remarks> + <para> + Sets the priority of the e-mails generated by this + appender. The default priority is <see cref="F:System.Net.Mail.MailPriority.Normal"/>. + </para> + <para> + If you are using this appender to report errors then + you may want to set the priority to <see cref="F:System.Net.Mail.MailPriority.High"/>. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.SmtpAppender.EnableSsl"> + <summary> + Enable or disable use of SSL when sending e-mail message + </summary> + <remarks> + This is available on MS .NET 2.0 runtime and higher + </remarks> + </member> + <member name="P:log4net.Appender.SmtpAppender.ReplyTo"> + <summary> + Gets or sets the reply-to e-mail address. + </summary> + <remarks> + This is available on MS .NET 2.0 runtime and higher + </remarks> + </member> + <member name="P:log4net.Appender.SmtpAppender.SubjectEncoding"> + <summary> + Gets or sets the subject encoding to be used. + </summary> + <remarks> + The default encoding is the operating system's current ANSI codepage. + </remarks> + </member> + <member name="P:log4net.Appender.SmtpAppender.BodyEncoding"> + <summary> + Gets or sets the body encoding to be used. + </summary> + <remarks> + The default encoding is the operating system's current ANSI codepage. + </remarks> + </member> + <member name="P:log4net.Appender.SmtpAppender.RequiresLayout"> + <summary> + This appender requires a <see cref="N:log4net.Layout"/> to be set. + </summary> + <value><c>true</c></value> + <remarks> + <para> + This appender requires a <see cref="N:log4net.Layout"/> to be set. + </para> + </remarks> + </member> + <member name="T:log4net.Appender.SmtpAppender.SmtpAuthentication"> + <summary> + Values for the <see cref="P:log4net.Appender.SmtpAppender.Authentication"/> property. + </summary> + <remarks> + <para> + SMTP authentication modes. + </para> + </remarks> + </member> + <member name="F:log4net.Appender.SmtpAppender.SmtpAuthentication.None"> + <summary> + No authentication + </summary> + </member> + <member name="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"> + <summary> + Basic authentication. + </summary> + <remarks> + Requires a username and password to be supplied + </remarks> + </member> + <member name="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Ntlm"> + <summary> + Integrated authentication + </summary> + <remarks> + Uses the Windows credentials from the current thread or process to authenticate. + </remarks> + </member> + <member name="T:log4net.Appender.SmtpPickupDirAppender"> + <summary> + Send an email when a specific logging event occurs, typically on errors + or fatal errors. Rather than sending via smtp it writes a file into the + directory specified by <see cref="P:log4net.Appender.SmtpPickupDirAppender.PickupDir"/>. This allows services such + as the IIS SMTP agent to manage sending the messages. + </summary> + <remarks> + <para> + The configuration for this appender is identical to that of the <c>SMTPAppender</c>, + except that instead of specifying the <c>SMTPAppender.SMTPHost</c> you specify + <see cref="P:log4net.Appender.SmtpPickupDirAppender.PickupDir"/>. + </para> + <para> + The number of logging events delivered in this e-mail depend on + the value of <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> option. The + <see cref="T:log4net.Appender.SmtpPickupDirAppender"/> keeps only the last + <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> logging events in its + cyclic buffer. This keeps memory requirements at a reasonable level while + still delivering useful application context. + </para> + </remarks> + <author>Niall Daley</author> + <author>Nicko Cadell</author> + </member> + <member name="M:log4net.Appender.SmtpPickupDirAppender.#ctor"> + <summary> + Default constructor + </summary> + <remarks> + <para> + Default constructor + </para> + </remarks> + </member> + <member name="M:log4net.Appender.SmtpPickupDirAppender.SendBuffer(log4net.Core.LoggingEvent[])"> + <summary> + Sends the contents of the cyclic buffer as an e-mail message. + </summary> + <param name="events">The logging events to send.</param> + <remarks> + <para> + Sends the contents of the cyclic buffer as an e-mail message. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.SmtpPickupDirAppender.ActivateOptions"> + <summary> + Activate the options on this appender. + </summary> + <remarks> + <para> + This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object + activation scheme. The <see cref="M:log4net.Appender.SmtpPickupDirAppender.ActivateOptions"/> method must + be called on this object after the configuration properties have + been set. Until <see cref="M:log4net.Appender.SmtpPickupDirAppender.ActivateOptions"/> is called this + object is in an undefined state and must not be used. + </para> + <para> + If any of the configuration properties are modified then + <see cref="M:log4net.Appender.SmtpPickupDirAppender.ActivateOptions"/> must be called again. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.SmtpPickupDirAppender.ConvertToFullPath(System.String)"> + <summary> + Convert a path into a fully qualified path. + </summary> + <param name="path">The path to convert.</param> + <returns>The fully qualified path.</returns> + <remarks> + <para> + Converts the path specified to a fully + qualified path. If the path is relative it is + taken as relative from the application base + directory. + </para> + </remarks> + </member> + <member name="F:log4net.Appender.SmtpPickupDirAppender.m_securityContext"> + <summary> + The security context to use for privileged calls + </summary> + </member> + <member name="P:log4net.Appender.SmtpPickupDirAppender.To"> + <summary> + Gets or sets a semicolon-delimited list of recipient e-mail addresses. + </summary> + <value> + A semicolon-delimited list of e-mail addresses. + </value> + <remarks> + <para> + A semicolon-delimited list of e-mail addresses. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.SmtpPickupDirAppender.From"> + <summary> + Gets or sets the e-mail address of the sender. + </summary> + <value> + The e-mail address of the sender. + </value> + <remarks> + <para> + The e-mail address of the sender. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.SmtpPickupDirAppender.Subject"> + <summary> + Gets or sets the subject line of the e-mail message. + </summary> + <value> + The subject line of the e-mail message. + </value> + <remarks> + <para> + The subject line of the e-mail message. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.SmtpPickupDirAppender.PickupDir"> + <summary> + Gets or sets the path to write the messages to. + </summary> + <remarks> + <para> + Gets or sets the path to write the messages to. This should be the same + as that used by the agent sending the messages. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.SmtpPickupDirAppender.SecurityContext"> + <summary> + Gets or sets the <see cref="P:log4net.Appender.SmtpPickupDirAppender.SecurityContext"/> used to write to the pickup directory. + </summary> + <value> + The <see cref="P:log4net.Appender.SmtpPickupDirAppender.SecurityContext"/> used to write to the pickup directory. + </value> + <remarks> + <para> + Unless a <see cref="P:log4net.Appender.SmtpPickupDirAppender.SecurityContext"/> specified here for this appender + the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is queried for the + security context to use. The default behavior is to use the security context + of the current thread. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.SmtpPickupDirAppender.RequiresLayout"> + <summary> + This appender requires a <see cref="N:log4net.Layout"/> to be set. + </summary> + <value><c>true</c></value> + <remarks> + <para> + This appender requires a <see cref="N:log4net.Layout"/> to be set. + </para> + </remarks> + </member> + <member name="T:log4net.Appender.TelnetAppender"> + <summary> + Appender that allows clients to connect via Telnet to receive log messages + </summary> + <remarks> + <para> + The TelnetAppender accepts socket connections and streams logging messages + back to the client. + The output is provided in a telnet-friendly way so that a log can be monitored + over a TCP/IP socket. + This allows simple remote monitoring of application logging. + </para> + <para> + The default <see cref="P:log4net.Appender.TelnetAppender.Port"/> is 23 (the telnet port). + </para> + </remarks> + <author>Keith Long</author> + <author>Nicko Cadell</author> + </member> + <member name="M:log4net.Appender.TelnetAppender.#ctor"> + <summary> + Default constructor + </summary> + <remarks> + <para> + Default constructor + </para> + </remarks> + </member> + <member name="F:log4net.Appender.TelnetAppender.declaringType"> + <summary> + The fully qualified type of the TelnetAppender class. + </summary> + <remarks> + Used by the internal logger to record the Type of the + log message. + </remarks> + </member> + <member name="M:log4net.Appender.TelnetAppender.OnClose"> + <summary> + Overrides the parent method to close the socket handler + </summary> + <remarks> + <para> + Closes all the outstanding connections. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.TelnetAppender.ActivateOptions"> + <summary> + Initialize the appender based on the options set. + </summary> + <remarks> + <para> + This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object + activation scheme. The <see cref="M:log4net.Appender.TelnetAppender.ActivateOptions"/> method must + be called on this object after the configuration properties have + been set. Until <see cref="M:log4net.Appender.TelnetAppender.ActivateOptions"/> is called this + object is in an undefined state and must not be used. + </para> + <para> + If any of the configuration properties are modified then + <see cref="M:log4net.Appender.TelnetAppender.ActivateOptions"/> must be called again. + </para> + <para> + Create the socket handler and wait for connections + </para> + </remarks> + </member> + <member name="M:log4net.Appender.TelnetAppender.Append(log4net.Core.LoggingEvent)"> + <summary> + Writes the logging event to each connected client. + </summary> + <param name="loggingEvent">The event to log.</param> + <remarks> + <para> + Writes the logging event to each connected client. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.TelnetAppender.Port"> + <summary> + Gets or sets the TCP port number on which this <see cref="T:log4net.Appender.TelnetAppender"/> will listen for connections. + </summary> + <value> + An integer value in the range <see cref="F:System.Net.IPEndPoint.MinPort"/> to <see cref="F:System.Net.IPEndPoint.MaxPort"/> + indicating the TCP port number on which this <see cref="T:log4net.Appender.TelnetAppender"/> will listen for connections. + </value> + <remarks> + <para> + The default value is 23 (the telnet port). + </para> + </remarks> + <exception cref="T:System.ArgumentOutOfRangeException">The value specified is less than <see cref="F:System.Net.IPEndPoint.MinPort"/> + or greater than <see cref="F:System.Net.IPEndPoint.MaxPort"/>.</exception> + </member> + <member name="P:log4net.Appender.TelnetAppender.RequiresLayout"> + <summary> + This appender requires a <see cref="N:log4net.Layout"/> to be set. + </summary> + <value><c>true</c></value> + <remarks> + <para> + This appender requires a <see cref="N:log4net.Layout"/> to be set. + </para> + </remarks> + </member> + <member name="T:log4net.Appender.TelnetAppender.SocketHandler"> + <summary> + Helper class to manage connected clients + </summary> + <remarks> + <para> + The SocketHandler class is used to accept connections from + clients. It is threaded so that clients can connect/disconnect + asynchronously. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.TelnetAppender.SocketHandler.#ctor(System.Int32)"> + <summary> + Opens a new server port on <paramref ref="port"/> + </summary> + <param name="port">the local port to listen on for connections</param> + <remarks> + <para> + Creates a socket handler on the specified local server port. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.TelnetAppender.SocketHandler.Send(System.String)"> + <summary> + Sends a string message to each of the connected clients + </summary> + <param name="message">the text to send</param> + <remarks> + <para> + Sends a string message to each of the connected clients + </para> + </remarks> + </member> + <member name="M:log4net.Appender.TelnetAppender.SocketHandler.AddClient(log4net.Appender.TelnetAppender.SocketHandler.SocketClient)"> + <summary> + Add a client to the internal clients list + </summary> + <param name="client">client to add</param> + </member> + <member name="M:log4net.Appender.TelnetAppender.SocketHandler.RemoveClient(log4net.Appender.TelnetAppender.SocketHandler.SocketClient)"> + <summary> + Remove a client from the internal clients list + </summary> + <param name="client">client to remove</param> + </member> + <member name="M:log4net.Appender.TelnetAppender.SocketHandler.OnConnect(System.IAsyncResult)"> + <summary> + Callback used to accept a connection on the server socket + </summary> + <param name="asyncResult">The result of the asynchronous operation</param> + <remarks> + <para> + On connection adds to the list of connections + if there are two many open connections you will be disconnected + </para> + </remarks> + </member> + <member name="M:log4net.Appender.TelnetAppender.SocketHandler.Dispose"> + <summary> + Close all network connections + </summary> + <remarks> + <para> + Make sure we close all network connections + </para> + </remarks> + </member> + <member name="P:log4net.Appender.TelnetAppender.SocketHandler.HasConnections"> + <summary> + Test if this handler has active connections + </summary> + <value> + <c>true</c> if this handler has active connections + </value> + <remarks> + <para> + This property will be <c>true</c> while this handler has + active connections, that is at least one connection that + the handler will attempt to send a message to. + </para> + </remarks> + </member> + <member name="T:log4net.Appender.TelnetAppender.SocketHandler.SocketClient"> + <summary> + Class that represents a client connected to this handler + </summary> + <remarks> + <para> + Class that represents a client connected to this handler + </para> + </remarks> + </member> + <member name="M:log4net.Appender.TelnetAppender.SocketHandler.SocketClient.#ctor(System.Net.Sockets.Socket)"> + <summary> + Create this <see cref="T:log4net.Appender.TelnetAppender.SocketHandler.SocketClient"/> for the specified <see cref="T:System.Net.Sockets.Socket"/> + </summary> + <param name="socket">the client's socket</param> + <remarks> + <para> + Opens a stream writer on the socket. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.TelnetAppender.SocketHandler.SocketClient.Send(System.String)"> + <summary> + Write a string to the client + </summary> + <param name="message">string to send</param> + <remarks> + <para> + Write a string to the client + </para> + </remarks> + </member> + <member name="M:log4net.Appender.TelnetAppender.SocketHandler.SocketClient.Dispose"> + <summary> + Cleanup the clients connection + </summary> + <remarks> + <para> + Close the socket connection. + </para> + </remarks> + </member> + <member name="T:log4net.Appender.TraceAppender"> + <summary> + Appends log events to the <see cref="T:System.Diagnostics.Trace"/> system. + </summary> + <remarks> + <para> + The application configuration file can be used to control what listeners + are actually used. See the MSDN documentation for the + <see cref="T:System.Diagnostics.Trace"/> class for details on configuring the + trace system. + </para> + <para> + Events are written using the <c>System.Diagnostics.Trace.Write(string,string)</c> + method. The event's logger name is the default value for the category parameter + of the Write method. + </para> + <para> + <b>Compact Framework</b><br/> + The Compact Framework does not support the <see cref="T:System.Diagnostics.Trace"/> + class for any operation except <c>Assert</c>. When using the Compact Framework this + appender will write to the <see cref="T:System.Diagnostics.Debug"/> system rather than + the Trace system. This appender will therefore behave like the <see cref="T:log4net.Appender.DebugAppender"/>. + </para> + </remarks> + <author>Douglas de la Torre</author> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + <author>Ron Grabowski</author> + </member> + <member name="M:log4net.Appender.TraceAppender.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:log4net.Appender.TraceAppender"/>. + </summary> + <remarks> + <para> + Default constructor. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.TraceAppender.#ctor(log4net.Layout.ILayout)"> + <summary> + Initializes a new instance of the <see cref="T:log4net.Appender.TraceAppender"/> + with a specified layout. + </summary> + <param name="layout">The layout to use with this appender.</param> + <remarks> + <para> + Obsolete constructor. + </para> + </remarks> + </member> + <member name="M:log4net.Appender.TraceAppender.Append(log4net.Core.LoggingEvent)"> + <summary> + Writes the logging event to the <see cref="T:System.Diagnostics.Trace"/> system. + </summary> + <param name="loggingEvent">The event to log.</param> + <remarks> + <para> + Writes the logging event to the <see cref="T:System.Diagnostics.Trace"/> system. + </para> + </remarks> + </member> + <member name="F:log4net.Appender.TraceAppender.m_immediateFlush"> + <summary> + Immediate flush means that the underlying writer or output stream + will be flushed at the end of each append operation. + </summary> + <remarks> + <para> + Immediate flush is slower but ensures that each append request is + actually written. If <see cref="P:log4net.Appender.TraceAppender.ImmediateFlush"/> is set to + <c>false</c>, then there is a good chance that the last few + logs events are not actually written to persistent media if and + when the application crashes. + </para> + <para> + The default value is <c>true</c>.</para> + </remarks> + </member> + <member name="F:log4net.Appender.TraceAppender.m_category"> + <summary> + Defaults to %logger + </summary> + </member> + <member name="P:log4net.Appender.TraceAppender.ImmediateFlush"> + <summary> + Gets or sets a value that indicates whether the appender will + flush at the end of each write. + </summary> + <remarks> + <para>The default behavior is to flush at the end of each + write. If the option is set to<c>false</c>, then the underlying + stream can defer writing to physical medium to a later time. + </para> + <para> + Avoiding the flush operation at the end of each append results + in a performance gain of 10 to 20 percent. However, there is safety + trade-off involved in skipping flushing. Indeed, when flushing is + skipped, then it is likely that the last few log events will not + be recorded on disk when the application exits. This is a high + price to pay even for a 20% performance gain. + </para> + </remarks> + </member> + <member name="P:log4net.Appender.TraceAppender.Category"> + <summary> + The category parameter sent to the Trace method. + </summary> + <remarks> + <para> + Defaults to %logger which will use the logger name of the current + <see cref="T:log4net.Core.LoggingEvent"/> as the category parameter. + </para> + <para> + </para> + </remarks> + </member> + <member name="P:log4net.Appender.TraceAppender.RequiresLayout"> + <summary> + This appender requires a <see cref="N:log4net.Layout"/> to be set. + </summary> + <value><c>true</c></value> + <remarks> + <para> + This appender requires a <see cref="N:log4net.Layout"/> to be set. + </para> + </remarks> + </member> + <member name="T:log4net.Config.AliasDomainAttribute"> + <summary> + Assembly level attribute that specifies a domain to alias to this assembly's repository. + </summary> + <remarks> + <para> + <b>AliasDomainAttribute is obsolete. Use AliasRepositoryAttribute instead of AliasDomainAttribute.</b> + </para> + <para> + An assembly's logger repository is defined by its <see cref="T:log4net.Config.DomainAttribute"/>, + however this can be overridden by an assembly loaded before the target assembly. + </para> + <para> + An assembly can alias another assembly's domain to its repository by + specifying this attribute with the name of the target domain. + </para> + <para> + This attribute can only be specified on the assembly and may be used + as many times as necessary to alias all the required domains. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="T:log4net.Config.AliasRepositoryAttribute"> + <summary> + Assembly level attribute that specifies a repository to alias to this assembly's repository. + </summary> + <remarks> + <para> + An assembly's logger repository is defined by its <see cref="T:log4net.Config.RepositoryAttribute"/>, + however this can be overridden by an assembly loaded before the target assembly. + </para> + <para> + An assembly can alias another assembly's repository to its repository by + specifying this attribute with the name of the target repository. + </para> + <para> + This attribute can only be specified on the assembly and may be used + as many times as necessary to alias all the required repositories. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Config.AliasRepositoryAttribute.#ctor(System.String)"> + <summary> + Initializes a new instance of the <see cref="T:log4net.Config.AliasRepositoryAttribute"/> class with + the specified repository to alias to this assembly's repository. + </summary> + <param name="name">The repository to alias to this assemby's repository.</param> + <remarks> + <para> + Initializes a new instance of the <see cref="T:log4net.Config.AliasRepositoryAttribute"/> class with + the specified repository to alias to this assembly's repository. + </para> + </remarks> + </member> + <member name="P:log4net.Config.AliasRepositoryAttribute.Name"> + <summary> + Gets or sets the repository to alias to this assemby's repository. + </summary> + <value> + The repository to alias to this assemby's repository. + </value> + <remarks> + <para> + The name of the repository to alias to this assemby's repository. + </para> + </remarks> + </member> + <member name="M:log4net.Config.AliasDomainAttribute.#ctor(System.String)"> + <summary> + Initializes a new instance of the <see cref="T:log4net.Config.AliasDomainAttribute"/> class with + the specified domain to alias to this assembly's repository. + </summary> + <param name="name">The domain to alias to this assemby's repository.</param> + <remarks> + <para> + Obsolete. Use <see cref="T:log4net.Config.AliasRepositoryAttribute"/> instead of <see cref="T:log4net.Config.AliasDomainAttribute"/>. + </para> + </remarks> + </member> + <member name="T:log4net.Config.BasicConfigurator"> + <summary> + Use this class to quickly configure a <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>. + </summary> + <remarks> + <para> + Allows very simple programmatic configuration of log4net. + </para> + <para> + Only one appender can be configured using this configurator. + The appender is set at the root of the hierarchy and all logging + events will be delivered to that appender. + </para> + <para> + Appenders can also implement the <see cref="T:log4net.Core.IOptionHandler"/> interface. Therefore + they would require that the <see cref="M:log4net.Core.IOptionHandler.ActivateOptions()"/> method + be called after the appenders properties have been configured. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="F:log4net.Config.BasicConfigurator.declaringType"> + <summary> + The fully qualified type of the BasicConfigurator class. + </summary> + <remarks> + Used by the internal logger to record the Type of the + log message. + </remarks> + </member> + <member name="M:log4net.Config.BasicConfigurator.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:log4net.Config.BasicConfigurator"/> class. + </summary> + <remarks> + <para> + Uses a private access modifier to prevent instantiation of this class. + </para> + </remarks> + </member> + <member name="M:log4net.Config.BasicConfigurator.Configure"> + <summary> + Initializes the log4net system with a default configuration. + </summary> + <remarks> + <para> + Initializes the log4net logging system using a <see cref="T:log4net.Appender.ConsoleAppender"/> + that will write to <c>Console.Out</c>. The log messages are + formatted using the <see cref="T:log4net.Layout.PatternLayout"/> layout object + with the <see cref="F:log4net.Layout.PatternLayout.DetailConversionPattern"/> + layout style. + </para> + </remarks> + </member> + <member name="M:log4net.Config.BasicConfigurator.Configure(log4net.Appender.IAppender)"> + <summary> + Initializes the log4net system using the specified appender. + </summary> + <param name="appender">The appender to use to log all logging events.</param> + <remarks> + <para> + Initializes the log4net system using the specified appender. + </para> + </remarks> + </member> + <member name="M:log4net.Config.BasicConfigurator.Configure(log4net.Appender.IAppender[])"> + <summary> + Initializes the log4net system using the specified appenders. + </summary> + <param name="appenders">The appenders to use to log all logging events.</param> + <remarks> + <para> + Initializes the log4net system using the specified appenders. + </para> + </remarks> + </member> + <member name="M:log4net.Config.BasicConfigurator.Configure(log4net.Repository.ILoggerRepository)"> + <summary> + Initializes the <see cref="T:log4net.Repository.ILoggerRepository"/> with a default configuration. + </summary> + <param name="repository">The repository to configure.</param> + <remarks> + <para> + Initializes the specified repository using a <see cref="T:log4net.Appender.ConsoleAppender"/> + that will write to <c>Console.Out</c>. The log messages are + formatted using the <see cref="T:log4net.Layout.PatternLayout"/> layout object + with the <see cref="F:log4net.Layout.PatternLayout.DetailConversionPattern"/> + layout style. + </para> + </remarks> + </member> + <member name="M:log4net.Config.BasicConfigurator.Configure(log4net.Repository.ILoggerRepository,log4net.Appender.IAppender)"> + <summary> + Initializes the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified appender. + </summary> + <param name="repository">The repository to configure.</param> + <param name="appender">The appender to use to log all logging events.</param> + <remarks> + <para> + Initializes the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified appender. + </para> + </remarks> + </member> + <member name="M:log4net.Config.BasicConfigurator.Configure(log4net.Repository.ILoggerRepository,log4net.Appender.IAppender[])"> + <summary> + Initializes the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified appenders. + </summary> + <param name="repository">The repository to configure.</param> + <param name="appenders">The appenders to use to log all logging events.</param> + <remarks> + <para> + Initializes the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified appender. + </para> + </remarks> + </member> + <member name="T:log4net.Config.ConfiguratorAttribute"> + <summary> + Base class for all log4net configuration attributes. + </summary> + <remarks> + This is an abstract class that must be extended by + specific configurators. This attribute allows the + configurator to be parameterized by an assembly level + attribute. + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Config.ConfiguratorAttribute.#ctor(System.Int32)"> + <summary> + Constructor used by subclasses. + </summary> + <param name="priority">the ordering priority for this configurator</param> + <remarks> + <para> + The <paramref name="priority"/> is used to order the configurator + attributes before they are invoked. Higher priority configurators are executed + before lower priority ones. + </para> + </remarks> + </member> + <member name="M:log4net.Config.ConfiguratorAttribute.Configure(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)"> + <summary> + Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly. + </summary> + <param name="sourceAssembly">The assembly that this attribute was defined on.</param> + <param name="targetRepository">The repository to configure.</param> + <remarks> + <para> + Abstract method implemented by a subclass. When this method is called + the subclass should configure the <paramref name="targetRepository"/>. + </para> + </remarks> + </member> + <member name="M:log4net.Config.ConfiguratorAttribute.CompareTo(System.Object)"> + <summary> + Compare this instance to another ConfiguratorAttribute + </summary> + <param name="obj">the object to compare to</param> + <returns>see <see cref="M:System.IComparable.CompareTo(System.Object)"/></returns> + <remarks> + <para> + Compares the priorities of the two <see cref="T:log4net.Config.ConfiguratorAttribute"/> instances. + Sorts by priority in descending order. Objects with the same priority are + randomly ordered. + </para> + </remarks> + </member> + <member name="T:log4net.Config.DomainAttribute"> + <summary> + Assembly level attribute that specifies the logging domain for the assembly. + </summary> + <remarks> + <para> + <b>DomainAttribute is obsolete. Use RepositoryAttribute instead of DomainAttribute.</b> + </para> + <para> + Assemblies are mapped to logging domains. Each domain has its own + logging repository. This attribute specified on the assembly controls + the configuration of the domain. The <see cref="P:log4net.Config.RepositoryAttribute.Name"/> property specifies the name + of the domain that this assembly is a part of. The <see cref="P:log4net.Config.RepositoryAttribute.RepositoryType"/> + specifies the type of the repository objects to create for the domain. If + this attribute is not specified and a <see cref="P:log4net.Config.RepositoryAttribute.Name"/> is not specified + then the assembly will be part of the default shared logging domain. + </para> + <para> + This attribute can only be specified on the assembly and may only be used + once per assembly. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="T:log4net.Config.RepositoryAttribute"> + <summary> + Assembly level attribute that specifies the logging repository for the assembly. + </summary> + <remarks> + <para> + Assemblies are mapped to logging repository. This attribute specified + on the assembly controls + the configuration of the repository. The <see cref="P:log4net.Config.RepositoryAttribute.Name"/> property specifies the name + of the repository that this assembly is a part of. The <see cref="P:log4net.Config.RepositoryAttribute.RepositoryType"/> + specifies the type of the <see cref="T:log4net.Repository.ILoggerRepository"/> object + to create for the assembly. If this attribute is not specified or a <see cref="P:log4net.Config.RepositoryAttribute.Name"/> + is not specified then the assembly will be part of the default shared logging repository. + </para> + <para> + This attribute can only be specified on the assembly and may only be used + once per assembly. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Config.RepositoryAttribute.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:log4net.Config.RepositoryAttribute"/> class. + </summary> + <remarks> + <para> + Default constructor. + </para> + </remarks> + </member> + <member name="M:log4net.Config.RepositoryAttribute.#ctor(System.String)"> + <summary> + Initialize a new instance of the <see cref="T:log4net.Config.RepositoryAttribute"/> class + with the name of the repository. + </summary> + <param name="name">The name of the repository.</param> + <remarks> + <para> + Initialize the attribute with the name for the assembly's repository. + </para> + </remarks> + </member> + <member name="P:log4net.Config.RepositoryAttribute.Name"> + <summary> + Gets or sets the name of the logging repository. + </summary> + <value> + The string name to use as the name of the repository associated with this + assembly. + </value> + <remarks> + <para> + This value does not have to be unique. Several assemblies can share the + same repository. They will share the logging configuration of the repository. + </para> + </remarks> + </member> + <member name="P:log4net.Config.RepositoryAttribute.RepositoryType"> + <summary> + Gets or sets the type of repository to create for this assembly. + </summary> + <value> + The type of repository to create for this assembly. + </value> + <remarks> + <para> + The type of the repository to create for the assembly. + The type must implement the <see cref="T:log4net.Repository.ILoggerRepository"/> + interface. + </para> + <para> + This will be the type of repository created when + the repository is created. If multiple assemblies reference the + same repository then the repository is only created once using the + <see cref="P:log4net.Config.RepositoryAttribute.RepositoryType"/> of the first assembly to call into the + repository. + </para> + </remarks> + </member> + <member name="M:log4net.Config.DomainAttribute.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:log4net.Config.DomainAttribute"/> class. + </summary> + <remarks> + <para> + Obsolete. Use RepositoryAttribute instead of DomainAttribute. + </para> + </remarks> + </member> + <member name="M:log4net.Config.DomainAttribute.#ctor(System.String)"> + <summary> + Initialize a new instance of the <see cref="T:log4net.Config.DomainAttribute"/> class + with the name of the domain. + </summary> + <param name="name">The name of the domain.</param> + <remarks> + <para> + Obsolete. Use RepositoryAttribute instead of DomainAttribute. + </para> + </remarks> + </member> + <member name="T:log4net.Config.DOMConfigurator"> + <summary> + Use this class to initialize the log4net environment using an Xml tree. + </summary> + <remarks> + <para> + <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b> + </para> + <para> + Configures a <see cref="T:log4net.Repository.ILoggerRepository"/> using an Xml tree. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Config.DOMConfigurator.#ctor"> + <summary> + Private constructor + </summary> + </member> + <member name="M:log4net.Config.DOMConfigurator.Configure"> + <summary> + Automatically configures the log4net system based on the + application's configuration settings. + </summary> + <remarks> + <para> + <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b> + </para> + Each application has a configuration file. This has the + same name as the application with '.config' appended. + This file is XML and calling this function prompts the + configurator to look in that file for a section called + <c>log4net</c> that contains the configuration data. + </remarks> + </member> + <member name="M:log4net.Config.DOMConfigurator.Configure(log4net.Repository.ILoggerRepository)"> + <summary> + Automatically configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using settings + stored in the application's configuration file. + </summary> + <remarks> + <para> + <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b> + </para> + Each application has a configuration file. This has the + same name as the application with '.config' appended. + This file is XML and calling this function prompts the + configurator to look in that file for a section called + <c>log4net</c> that contains the configuration data. + </remarks> + <param name="repository">The repository to configure.</param> + </member> + <member name="M:log4net.Config.DOMConfigurator.Configure(System.Xml.XmlElement)"> + <summary> + Configures log4net using a <c>log4net</c> element + </summary> + <remarks> + <para> + <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b> + </para> + Loads the log4net configuration from the XML element + supplied as <paramref name="element"/>. + </remarks> + <param name="element">The element to parse.</param> + </member> + <member name="M:log4net.Config.DOMConfigurator.Configure(log4net.Repository.ILoggerRepository,System.Xml.XmlElement)"> + <summary> + Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified XML + element. + </summary> + <remarks> + <para> + <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b> + </para> + Loads the log4net configuration from the XML element + supplied as <paramref name="element"/>. + </remarks> + <param name="repository">The repository to configure.</param> + <param name="element">The element to parse.</param> + </member> + <member name="M:log4net.Config.DOMConfigurator.Configure(System.IO.FileInfo)"> + <summary> + Configures log4net using the specified configuration file. + </summary> + <param name="configFile">The XML file to load the configuration from.</param> + <remarks> + <para> + <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b> + </para> + <para> + The configuration file must be valid XML. It must contain + at least one element called <c>log4net</c> that holds + the log4net configuration data. + </para> + <para> + The log4net configuration file can possible be specified in the application's + configuration file (either <c>MyAppName.exe.config</c> for a + normal application on <c>Web.config</c> for an ASP.NET application). + </para> + <example> + The following example configures log4net using a configuration file, of which the + location is stored in the application's configuration file : + </example> + <code lang="C#"> + using log4net.Config; + using System.IO; + using System.Configuration; + + ... + + DOMConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"])); + </code> + <para> + In the <c>.config</c> file, the path to the log4net can be specified like this : + </para> + <code lang="XML" escaped="true"> + <configuration> + <appSettings> + <add key="log4net-config-file" value="log.config"/> + </appSettings> + </configuration> + </code> + </remarks> + </member> + <member name="M:log4net.Config.DOMConfigurator.Configure(System.IO.Stream)"> + <summary> + Configures log4net using the specified configuration file. + </summary> + <param name="configStream">A stream to load the XML configuration from.</param> + <remarks> + <para> + <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b> + </para> + <para> + The configuration data must be valid XML. It must contain + at least one element called <c>log4net</c> that holds + the log4net configuration data. + </para> + <para> + Note that this method will NOT close the stream parameter. + </para> + </remarks> + </member> + <member name="M:log4net.Config.DOMConfigurator.Configure(log4net.Repository.ILoggerRepository,System.IO.FileInfo)"> + <summary> + Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified configuration + file. + </summary> + <param name="repository">The repository to configure.</param> + <param name="configFile">The XML file to load the configuration from.</param> + <remarks> + <para> + <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b> + </para> + <para> + The configuration file must be valid XML. It must contain + at least one element called <c>log4net</c> that holds + the configuration data. + </para> + <para> + The log4net configuration file can possible be specified in the application's + configuration file (either <c>MyAppName.exe.config</c> for a + normal application on <c>Web.config</c> for an ASP.NET application). + </para> + <example> + The following example configures log4net using a configuration file, of which the + location is stored in the application's configuration file : + </example> + <code lang="C#"> + using log4net.Config; + using System.IO; + using System.Configuration; + + ... + + DOMConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"])); + </code> + <para> + In the <c>.config</c> file, the path to the log4net can be specified like this : + </para> + <code lang="XML" escaped="true"> + <configuration> + <appSettings> + <add key="log4net-config-file" value="log.config"/> + </appSettings> + </configuration> + </code> + </remarks> + </member> + <member name="M:log4net.Config.DOMConfigurator.Configure(log4net.Repository.ILoggerRepository,System.IO.Stream)"> + <summary> + Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified configuration + file. + </summary> + <param name="repository">The repository to configure.</param> + <param name="configStream">The stream to load the XML configuration from.</param> + <remarks> + <para> + <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b> + </para> + <para> + The configuration data must be valid XML. It must contain + at least one element called <c>log4net</c> that holds + the configuration data. + </para> + <para> + Note that this method will NOT close the stream parameter. + </para> + </remarks> + </member> + <member name="M:log4net.Config.DOMConfigurator.ConfigureAndWatch(System.IO.FileInfo)"> + <summary> + Configures log4net using the file specified, monitors the file for changes + and reloads the configuration if a change is detected. + </summary> + <param name="configFile">The XML file to load the configuration from.</param> + <remarks> + <para> + <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b> + </para> + <para> + The configuration file must be valid XML. It must contain + at least one element called <c>log4net</c> that holds + the configuration data. + </para> + <para> + The configuration file will be monitored using a <see cref="T:System.IO.FileSystemWatcher"/> + and depends on the behavior of that class. + </para> + <para> + For more information on how to configure log4net using + a separate configuration file, see <see cref="M:Configure(FileInfo)"/>. + </para> + </remarks> + <seealso cref="M:Configure(FileInfo)"/> + </member> + <member name="M:log4net.Config.DOMConfigurator.ConfigureAndWatch(log4net.Repository.ILoggerRepository,System.IO.FileInfo)"> + <summary> + Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the file specified, + monitors the file for changes and reloads the configuration if a change + is detected. + </summary> + <param name="repository">The repository to configure.</param> + <param name="configFile">The XML file to load the configuration from.</param> + <remarks> + <para> + <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b> + </para> + <para> + The configuration file must be valid XML. It must contain + at least one element called <c>log4net</c> that holds + the configuration data. + </para> + <para> + The configuration file will be monitored using a <see cref="T:System.IO.FileSystemWatcher"/> + and depends on the behavior of that class. + </para> + <para> + For more information on how to configure log4net using + a separate configuration file, see <see cref="M:Configure(FileInfo)"/>. + </para> + </remarks> + <seealso cref="M:Configure(FileInfo)"/> + </member> + <member name="T:log4net.Config.DOMConfiguratorAttribute"> + <summary> + Assembly level attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/>. + </summary> + <remarks> + <para> + <b>AliasDomainAttribute is obsolete. Use AliasRepositoryAttribute instead of AliasDomainAttribute.</b> + </para> + <para> + This attribute may only be used at the assembly scope and can only + be used once per assembly. + </para> + <para> + Use this attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/> + without calling one of the <see cref="M:XmlConfigurator.Configure()"/> + methods. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="T:log4net.Config.XmlConfiguratorAttribute"> + <summary> + Assembly level attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/>. + </summary> + <remarks> + <para> + This attribute may only be used at the assembly scope and can only + be used once per assembly. + </para> + <para> + Use this attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/> + without calling one of the <see cref="M:XmlConfigurator.Configure()"/> + methods. + </para> + <para> + If neither of the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> or <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> + properties are set the configuration is loaded from the application's .config file. + If set the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> property takes priority over the + <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> property. The <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> property + specifies a path to a file to load the config from. The path is relative to the + application's base directory; <see cref="P:System.AppDomain.BaseDirectory"/>. + The <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> property is used as a postfix to the assembly file name. + The config file must be located in the application's base directory; <see cref="P:System.AppDomain.BaseDirectory"/>. + For example in a console application setting the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> to + <c>config</c> has the same effect as not specifying the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> or + <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> properties. + </para> + <para> + The <see cref="P:log4net.Config.XmlConfiguratorAttribute.Watch"/> property can be set to cause the <see cref="T:log4net.Config.XmlConfigurator"/> + to watch the configuration file for changes. + </para> + <note> + <para> + Log4net will only look for assembly level configuration attributes once. + When using the log4net assembly level attributes to control the configuration + of log4net you must ensure that the first call to any of the + <see cref="T:log4net.Core.LoggerManager"/> methods is made from the assembly with the configuration + attributes. + </para> + <para> + If you cannot guarantee the order in which log4net calls will be made from + different assemblies you must use programmatic configuration instead, i.e. + call the <see cref="M:XmlConfigurator.Configure()"/> method directly. + </para> + </note> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Config.XmlConfiguratorAttribute.#ctor"> + <summary> + Default constructor + </summary> + <remarks> + <para> + Default constructor + </para> + </remarks> + </member> + <member name="M:log4net.Config.XmlConfiguratorAttribute.Configure(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)"> + <summary> + Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly. + </summary> + <param name="sourceAssembly">The assembly that this attribute was defined on.</param> + <param name="targetRepository">The repository to configure.</param> + <remarks> + <para> + Configure the repository using the <see cref="T:log4net.Config.XmlConfigurator"/>. + The <paramref name="targetRepository"/> specified must extend the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> + class otherwise the <see cref="T:log4net.Config.XmlConfigurator"/> will not be able to + configure it. + </para> + </remarks> + <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="targetRepository"/> does not extend <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>.</exception> + </member> + <member name="M:log4net.Config.XmlConfiguratorAttribute.ConfigureFromFile(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)"> + <summary> + Attempt to load configuration from the local file system + </summary> + <param name="sourceAssembly">The assembly that this attribute was defined on.</param> + <param name="targetRepository">The repository to configure.</param> + </member> + <member name="M:log4net.Config.XmlConfiguratorAttribute.ConfigureFromFile(log4net.Repository.ILoggerRepository,System.IO.FileInfo)"> + <summary> + Configure the specified repository using a <see cref="T:System.IO.FileInfo"/> + </summary> + <param name="targetRepository">The repository to configure.</param> + <param name="configFile">the FileInfo pointing to the config file</param> + </member> + <member name="M:log4net.Config.XmlConfiguratorAttribute.ConfigureFromUri(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)"> + <summary> + Attempt to load configuration from a URI + </summary> + <param name="sourceAssembly">The assembly that this attribute was defined on.</param> + <param name="targetRepository">The repository to configure.</param> + </member> + <member name="F:log4net.Config.XmlConfiguratorAttribute.declaringType"> + <summary> + The fully qualified type of the XmlConfiguratorAttribute class. + </summary> + <remarks> + Used by the internal logger to record the Type of the + log message. + </remarks> + </member> + <member name="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"> + <summary> + Gets or sets the filename of the configuration file. + </summary> + <value> + The filename of the configuration file. + </value> + <remarks> + <para> + If specified, this is the name of the configuration file to use with + the <see cref="T:log4net.Config.XmlConfigurator"/>. This file path is relative to the + <b>application base</b> directory (<see cref="P:System.AppDomain.BaseDirectory"/>). + </para> + <para> + The <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> takes priority over the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/>. + </para> + </remarks> + </member> + <member name="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"> + <summary> + Gets or sets the extension of the configuration file. + </summary> + <value> + The extension of the configuration file. + </value> + <remarks> + <para> + If specified this is the extension for the configuration file. + The path to the config file is built by using the <b>application + base</b> directory (<see cref="P:System.AppDomain.BaseDirectory"/>), + the <b>assembly file name</b> and the config file extension. + </para> + <para> + If the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> is set to <c>MyExt</c> then + possible config file names would be: <c>MyConsoleApp.exe.MyExt</c> or + <c>MyClassLibrary.dll.MyExt</c>. + </para> + <para> + The <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> takes priority over the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/>. + </para> + </remarks> + </member> + <member name="P:log4net.Config.XmlConfiguratorAttribute.Watch"> + <summary> + Gets or sets a value indicating whether to watch the configuration file. + </summary> + <value> + <c>true</c> if the configuration should be watched, <c>false</c> otherwise. + </value> + <remarks> + <para> + If this flag is specified and set to <c>true</c> then the framework + will watch the configuration file and will reload the config each time + the file is modified. + </para> + <para> + The config file can only be watched if it is loaded from local disk. + In a No-Touch (Smart Client) deployment where the application is downloaded + from a web server the config file may not reside on the local disk + and therefore it may not be able to watch it. + </para> + <note> + Watching configuration is not supported on the SSCLI. + </note> + </remarks> + </member> + <member name="T:log4net.Config.Log4NetConfigurationSectionHandler"> + <summary> + Class to register for the log4net section of the configuration file + </summary> + <remarks> + The log4net section of the configuration file needs to have a section + handler registered. This is the section handler used. It simply returns + the XML element that is the root of the section. + </remarks> + <example> + Example of registering the log4net section handler : + <code lang="XML" escaped="true"> + <configuration> + <configSections> + <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net" /> + </configSections> + <log4net> + log4net configuration XML goes here + </log4net> + </configuration> + </code> + </example> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Config.Log4NetConfigurationSectionHandler.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/> class. + </summary> + <remarks> + <para> + Default constructor. + </para> + </remarks> + </member> + <member name="M:log4net.Config.Log4NetConfigurationSectionHandler.Create(System.Object,System.Object,System.Xml.XmlNode)"> + <summary> + Parses the configuration section. + </summary> + <param name="parent">The configuration settings in a corresponding parent configuration section.</param> + <param name="configContext">The configuration context when called from the ASP.NET configuration system. Otherwise, this parameter is reserved and is a null reference.</param> + <param name="section">The <see cref="T:System.Xml.XmlNode"/> for the log4net section.</param> + <returns>The <see cref="T:System.Xml.XmlNode"/> for the log4net section.</returns> + <remarks> + <para> + Returns the <see cref="T:System.Xml.XmlNode"/> containing the configuration data, + </para> + </remarks> + </member> + <member name="T:log4net.Config.PluginAttribute"> + <summary> + Assembly level attribute that specifies a plugin to attach to + the repository. + </summary> + <remarks> + <para> + Specifies the type of a plugin to create and attach to the + assembly's repository. The plugin type must implement the + <see cref="T:log4net.Plugin.IPlugin"/> interface. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="T:log4net.Plugin.IPluginFactory"> + <summary> + Interface used to create plugins. + </summary> + <remarks> + <para> + Interface used to create a plugin. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Plugin.IPluginFactory.CreatePlugin"> + <summary> + Creates the plugin object. + </summary> + <returns>the new plugin instance</returns> + <remarks> + <para> + Create and return a new plugin instance. + </para> + </remarks> + </member> + <member name="M:log4net.Config.PluginAttribute.#ctor(System.String)"> + <summary> + Initializes a new instance of the <see cref="T:log4net.Config.PluginAttribute"/> class + with the specified type. + </summary> + <param name="typeName">The type name of plugin to create.</param> + <remarks> + <para> + Create the attribute with the plugin type specified. + </para> + <para> + Where possible use the constructor that takes a <see cref="T:System.Type"/>. + </para> + </remarks> + </member> + <member name="M:log4net.Config.PluginAttribute.#ctor(System.Type)"> + <summary> + Initializes a new instance of the <see cref="T:log4net.Config.PluginAttribute"/> class + with the specified type. + </summary> + <param name="type">The type of plugin to create.</param> + <remarks> + <para> + Create the attribute with the plugin type specified. + </para> + </remarks> + </member> + <member name="M:log4net.Config.PluginAttribute.CreatePlugin"> + <summary> + Creates the plugin object defined by this attribute. + </summary> + <remarks> + <para> + Creates the instance of the <see cref="T:log4net.Plugin.IPlugin"/> object as + specified by this attribute. + </para> + </remarks> + <returns>The plugin object.</returns> + </member> + <member name="M:log4net.Config.PluginAttribute.ToString"> + <summary> + Returns a representation of the properties of this object. + </summary> + <remarks> + <para> + Overrides base class <see cref="M:Object.ToString()" /> method to + return a representation of the properties of this object. + </para> + </remarks> + <returns>A representation of the properties of this object</returns> + </member> + <member name="P:log4net.Config.PluginAttribute.Type"> + <summary> + Gets or sets the type for the plugin. + </summary> + <value> + The type for the plugin. + </value> + <remarks> + <para> + The type for the plugin. + </para> + </remarks> + </member> + <member name="P:log4net.Config.PluginAttribute.TypeName"> + <summary> + Gets or sets the type name for the plugin. + </summary> + <value> + The type name for the plugin. + </value> + <remarks> + <para> + The type name for the plugin. + </para> + <para> + Where possible use the <see cref="P:log4net.Config.PluginAttribute.Type"/> property instead. + </para> + </remarks> + </member> + <member name="T:log4net.Config.SecurityContextProviderAttribute"> + <summary> + Assembly level attribute to configure the <see cref="T:log4net.Core.SecurityContextProvider"/>. + </summary> + <remarks> + <para> + This attribute may only be used at the assembly scope and can only + be used once per assembly. + </para> + <para> + Use this attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/> + without calling one of the <see cref="M:XmlConfigurator.Configure()"/> + methods. + </para> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="M:log4net.Config.SecurityContextProviderAttribute.#ctor(System.Type)"> + <summary> + Construct provider attribute with type specified + </summary> + <param name="providerType">the type of the provider to use</param> + <remarks> + <para> + The provider specified must subclass the <see cref="T:log4net.Core.SecurityContextProvider"/> + class. + </para> + </remarks> + </member> + <member name="M:log4net.Config.SecurityContextProviderAttribute.Configure(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)"> + <summary> + Configures the SecurityContextProvider + </summary> + <param name="sourceAssembly">The assembly that this attribute was defined on.</param> + <param name="targetRepository">The repository to configure.</param> + <remarks> + <para> + Creates a provider instance from the <see cref="P:log4net.Config.SecurityContextProviderAttribute.ProviderType"/> specified. + Sets this as the default security context provider <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/>. + </para> + </remarks> + </member> + <member name="F:log4net.Config.SecurityContextProviderAttribute.declaringType"> + <summary> + The fully qualified type of the SecurityContextProviderAttribute class. + </summary> + <remarks> + Used by the internal logger to record the Type of the + log message. + </remarks> + </member> + <member name="P:log4net.Config.SecurityContextProviderAttribute.ProviderType"> + <summary> + Gets or sets the type of the provider to use. + </summary> + <value> + the type of the provider to use. + </value> + <remarks> + <para> + The provider specified must subclass the <see cref="T:log4net.Core.SecurityContextProvider"/> + class. + </para> + </remarks> + </member> + <member name="T:log4net.Config.XmlConfigurator"> + <summary> + Use this class to initialize the log4net environment using an Xml tree. + </summary> + <remarks> + <para> + Configures a <see cref="T:log4net.Repository.ILoggerRepository"/> using an Xml tree. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Config.XmlConfigurator.#ctor"> + <summary> + Private constructor + </summary> + </member> + <member name="M:log4net.Config.XmlConfigurator.Configure"> + <summary> + Automatically configures the log4net system based on the + application's configuration settings. + </summary> + <remarks> + <para> + Each application has a configuration file. This has the + same name as the application with '.config' appended. + This file is XML and calling this function prompts the + configurator to look in that file for a section called + <c>log4net</c> that contains the configuration data. + </para> + <para> + To use this method to configure log4net you must specify + the <see cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/> section + handler for the <c>log4net</c> configuration section. See the + <see cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/> for an example. + </para> + </remarks> + <seealso cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/> + </member> + <member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository)"> + <summary> + Automatically configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using settings + stored in the application's configuration file. + </summary> + <remarks> + <para> + Each application has a configuration file. This has the + same name as the application with '.config' appended. + This file is XML and calling this function prompts the + configurator to look in that file for a section called + <c>log4net</c> that contains the configuration data. + </para> + <para> + To use this method to configure log4net you must specify + the <see cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/> section + handler for the <c>log4net</c> configuration section. See the + <see cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/> for an example. + </para> + </remarks> + <param name="repository">The repository to configure.</param> + </member> + <member name="M:log4net.Config.XmlConfigurator.Configure(System.Xml.XmlElement)"> + <summary> + Configures log4net using a <c>log4net</c> element + </summary> + <remarks> + <para> + Loads the log4net configuration from the XML element + supplied as <paramref name="element"/>. + </para> + </remarks> + <param name="element">The element to parse.</param> + </member> + <member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository,System.Xml.XmlElement)"> + <summary> + Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified XML + element. + </summary> + <remarks> + Loads the log4net configuration from the XML element + supplied as <paramref name="element"/>. + </remarks> + <param name="repository">The repository to configure.</param> + <param name="element">The element to parse.</param> + </member> + <member name="M:log4net.Config.XmlConfigurator.Configure(System.IO.FileInfo)"> + <summary> + Configures log4net using the specified configuration file. + </summary> + <param name="configFile">The XML file to load the configuration from.</param> + <remarks> + <para> + The configuration file must be valid XML. It must contain + at least one element called <c>log4net</c> that holds + the log4net configuration data. + </para> + <para> + The log4net configuration file can possible be specified in the application's + configuration file (either <c>MyAppName.exe.config</c> for a + normal application on <c>Web.config</c> for an ASP.NET application). + </para> + <para> + The first element matching <c><configuration></c> will be read as the + configuration. If this file is also a .NET .config file then you must specify + a configuration section for the <c>log4net</c> element otherwise .NET will + complain. Set the type for the section handler to <see cref="T:System.Configuration.IgnoreSectionHandler"/>, for example: + <code lang="XML" escaped="true"> + <configSections> + <section name="log4net" type="System.Configuration.IgnoreSectionHandler"/> + </configSections> + </code> + </para> + <example> + The following example configures log4net using a configuration file, of which the + location is stored in the application's configuration file : + </example> + <code lang="C#"> + using log4net.Config; + using System.IO; + using System.Configuration; + + ... + + XmlConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"])); + </code> + <para> + In the <c>.config</c> file, the path to the log4net can be specified like this : + </para> + <code lang="XML" escaped="true"> + <configuration> + <appSettings> + <add key="log4net-config-file" value="log.config"/> + </appSettings> + </configuration> + </code> + </remarks> + </member> + <member name="M:log4net.Config.XmlConfigurator.Configure(System.Uri)"> + <summary> + Configures log4net using the specified configuration URI. + </summary> + <param name="configUri">A URI to load the XML configuration from.</param> + <remarks> + <para> + The configuration data must be valid XML. It must contain + at least one element called <c>log4net</c> that holds + the log4net configuration data. + </para> + <para> + The <see cref="T:System.Net.WebRequest"/> must support the URI scheme specified. + </para> + </remarks> + </member> + <member name="M:log4net.Config.XmlConfigurator.Configure(System.IO.Stream)"> + <summary> + Configures log4net using the specified configuration data stream. + </summary> + <param name="configStream">A stream to load the XML configuration from.</param> + <remarks> + <para> + The configuration data must be valid XML. It must contain + at least one element called <c>log4net</c> that holds + the log4net configuration data. + </para> + <para> + Note that this method will NOT close the stream parameter. + </para> + </remarks> + </member> + <member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository,System.IO.FileInfo)"> + <summary> + Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified configuration + file. + </summary> + <param name="repository">The repository to configure.</param> + <param name="configFile">The XML file to load the configuration from.</param> + <remarks> + <para> + The configuration file must be valid XML. It must contain + at least one element called <c>log4net</c> that holds + the configuration data. + </para> + <para> + The log4net configuration file can possible be specified in the application's + configuration file (either <c>MyAppName.exe.config</c> for a + normal application on <c>Web.config</c> for an ASP.NET application). + </para> + <para> + The first element matching <c><configuration></c> will be read as the + configuration. If this file is also a .NET .config file then you must specify + a configuration section for the <c>log4net</c> element otherwise .NET will + complain. Set the type for the section handler to <see cref="T:System.Configuration.IgnoreSectionHandler"/>, for example: + <code lang="XML" escaped="true"> + <configSections> + <section name="log4net" type="System.Configuration.IgnoreSectionHandler"/> + </configSections> + </code> + </para> + <example> + The following example configures log4net using a configuration file, of which the + location is stored in the application's configuration file : + </example> + <code lang="C#"> + using log4net.Config; + using System.IO; + using System.Configuration; + + ... + + XmlConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"])); + </code> + <para> + In the <c>.config</c> file, the path to the log4net can be specified like this : + </para> + <code lang="XML" escaped="true"> + <configuration> + <appSettings> + <add key="log4net-config-file" value="log.config"/> + </appSettings> + </configuration> + </code> + </remarks> + </member> + <member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository,System.Uri)"> + <summary> + Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified configuration + URI. + </summary> + <param name="repository">The repository to configure.</param> + <param name="configUri">A URI to load the XML configuration from.</param> + <remarks> + <para> + The configuration data must be valid XML. It must contain + at least one element called <c>log4net</c> that holds + the configuration data. + </para> + <para> + The <see cref="T:System.Net.WebRequest"/> must support the URI scheme specified. + </para> + </remarks> + </member> + <member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository,System.IO.Stream)"> + <summary> + Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified configuration + file. + </summary> + <param name="repository">The repository to configure.</param> + <param name="configStream">The stream to load the XML configuration from.</param> + <remarks> + <para> + The configuration data must be valid XML. It must contain + at least one element called <c>log4net</c> that holds + the configuration data. + </para> + <para> + Note that this method will NOT close the stream parameter. + </para> + </remarks> + </member> + <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatch(System.IO.FileInfo)"> + <summary> + Configures log4net using the file specified, monitors the file for changes + and reloads the configuration if a change is detected. + </summary> + <param name="configFile">The XML file to load the configuration from.</param> + <remarks> + <para> + The configuration file must be valid XML. It must contain + at least one element called <c>log4net</c> that holds + the configuration data. + </para> + <para> + The configuration file will be monitored using a <see cref="T:System.IO.FileSystemWatcher"/> + and depends on the behavior of that class. + </para> + <para> + For more information on how to configure log4net using + a separate configuration file, see <see cref="M:Configure(FileInfo)"/>. + </para> + </remarks> + <seealso cref="M:Configure(FileInfo)"/> + </member> + <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatch(log4net.Repository.ILoggerRepository,System.IO.FileInfo)"> + <summary> + Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the file specified, + monitors the file for changes and reloads the configuration if a change + is detected. + </summary> + <param name="repository">The repository to configure.</param> + <param name="configFile">The XML file to load the configuration from.</param> + <remarks> + <para> + The configuration file must be valid XML. It must contain + at least one element called <c>log4net</c> that holds + the configuration data. + </para> + <para> + The configuration file will be monitored using a <see cref="T:System.IO.FileSystemWatcher"/> + and depends on the behavior of that class. + </para> + <para> + For more information on how to configure log4net using + a separate configuration file, see <see cref="M:Configure(FileInfo)"/>. + </para> + </remarks> + <seealso cref="M:Configure(FileInfo)"/> + </member> + <member name="M:log4net.Config.XmlConfigurator.InternalConfigureFromXml(log4net.Repository.ILoggerRepository,System.Xml.XmlElement)"> + <summary> + Configures the specified repository using a <c>log4net</c> element. + </summary> + <param name="repository">The hierarchy to configure.</param> + <param name="element">The element to parse.</param> + <remarks> + <para> + Loads the log4net configuration from the XML element + supplied as <paramref name="element"/>. + </para> + <para> + This method is ultimately called by one of the Configure methods + to load the configuration from an <see cref="T:System.Xml.XmlElement"/>. + </para> + </remarks> + </member> + <member name="F:log4net.Config.XmlConfigurator.m_repositoryName2ConfigAndWatchHandler"> + <summary> + Maps repository names to ConfigAndWatchHandler instances to allow a particular + ConfigAndWatchHandler to dispose of its FileSystemWatcher when a repository is + reconfigured. + </summary> + </member> + <member name="F:log4net.Config.XmlConfigurator.declaringType"> + <summary> + The fully qualified type of the XmlConfigurator class. + </summary> + <remarks> + Used by the internal logger to record the Type of the + log message. + </remarks> + </member> + <member name="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler"> + <summary> + Class used to watch config files. + </summary> + <remarks> + <para> + Uses the <see cref="T:System.IO.FileSystemWatcher"/> to monitor + changes to a specified file. Because multiple change notifications + may be raised when the file is modified, a timer is used to + compress the notifications into a single event. The timer + waits for <see cref="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.TimeoutMillis"/> time before delivering + the event notification. If any further <see cref="T:System.IO.FileSystemWatcher"/> + change notifications arrive while the timer is waiting it + is reset and waits again for <see cref="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.TimeoutMillis"/> to + elapse. + </para> + </remarks> + </member> + <member name="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.TimeoutMillis"> + <summary> + The default amount of time to wait after receiving notification + before reloading the config file. + </summary> + </member> + <member name="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.m_configFile"> + <summary> + Holds the FileInfo used to configure the XmlConfigurator + </summary> + </member> + <member name="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.m_repository"> + <summary> + Holds the repository being configured. + </summary> + </member> + <member name="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.m_timer"> + <summary> + The timer used to compress the notification events. + </summary> + </member> + <member name="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.m_watcher"> + <summary> + Watches file for changes. This object should be disposed when no longer + needed to free system handles on the watched resources. + </summary> + </member> + <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.#ctor(log4net.Repository.ILoggerRepository,System.IO.FileInfo)"> + <summary> + Initializes a new instance of the <see cref="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler"/> class to + watch a specified config file used to configure a repository. + </summary> + <param name="repository">The repository to configure.</param> + <param name="configFile">The configuration file to watch.</param> + <remarks> + <para> + Initializes a new instance of the <see cref="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler"/> class. + </para> + </remarks> + </member> + <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.ConfigureAndWatchHandler_OnChanged(System.Object,System.IO.FileSystemEventArgs)"> + <summary> + Event handler used by <see cref="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler"/>. + </summary> + <param name="source">The <see cref="T:System.IO.FileSystemWatcher"/> firing the event.</param> + <param name="e">The argument indicates the file that caused the event to be fired.</param> + <remarks> + <para> + This handler reloads the configuration from the file when the event is fired. + </para> + </remarks> + </member> + <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.ConfigureAndWatchHandler_OnRenamed(System.Object,System.IO.RenamedEventArgs)"> + <summary> + Event handler used by <see cref="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler"/>. + </summary> + <param name="source">The <see cref="T:System.IO.FileSystemWatcher"/> firing the event.</param> + <param name="e">The argument indicates the file that caused the event to be fired.</param> + <remarks> + <para> + This handler reloads the configuration from the file when the event is fired. + </para> + </remarks> + </member> + <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.OnWatchedFileChange(System.Object)"> + <summary> + Called by the timer when the configuration has been updated. + </summary> + <param name="state">null</param> + </member> + <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.Dispose"> + <summary> + Release the handles held by the watcher and timer. + </summary> + </member> + <member name="T:log4net.Core.CompactRepositorySelector"> + <summary> + The implementation of the <see cref="T:log4net.Core.IRepositorySelector"/> interface suitable + for use with the compact framework + </summary> + <remarks> + <para> + This <see cref="T:log4net.Core.IRepositorySelector"/> implementation is a simple + mapping between repository name and <see cref="T:log4net.Repository.ILoggerRepository"/> + object. + </para> + <para> + The .NET Compact Framework 1.0 does not support retrieving assembly + level attributes therefore unlike the <c>DefaultRepositorySelector</c> + this selector does not examine the calling assembly for attributes. + </para> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="T:log4net.Core.IRepositorySelector"> + <summary> + Interface used by the <see cref="T:log4net.LogManager"/> to select the <see cref="T:log4net.Repository.ILoggerRepository"/>. + </summary> + <remarks> + <para> + The <see cref="T:log4net.LogManager"/> uses a <see cref="T:log4net.Core.IRepositorySelector"/> + to specify the policy for selecting the correct <see cref="T:log4net.Repository.ILoggerRepository"/> + to return to the caller. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Core.IRepositorySelector.GetRepository(System.Reflection.Assembly)"> + <summary> + Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly. + </summary> + <param name="assembly">The assembly to use to lookup to the <see cref="T:log4net.Repository.ILoggerRepository"/></param> + <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> for the assembly.</returns> + <remarks> + <para> + Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly. + </para> + <para> + How the association between <see cref="T:System.Reflection.Assembly"/> and <see cref="T:log4net.Repository.ILoggerRepository"/> + is made is not defined. The implementation may choose any method for + this association. The results of this method must be repeatable, i.e. + when called again with the same arguments the result must be the + save value. + </para> + </remarks> + </member> + <member name="M:log4net.Core.IRepositorySelector.GetRepository(System.String)"> + <summary> + Gets the named <see cref="T:log4net.Repository.ILoggerRepository"/>. + </summary> + <param name="repositoryName">The name to use to lookup to the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param> + <returns>The named <see cref="T:log4net.Repository.ILoggerRepository"/></returns> + <remarks> + Lookup a named <see cref="T:log4net.Repository.ILoggerRepository"/>. This is the repository created by + calling <see cref="M:CreateRepository(string,Type)"/>. + </remarks> + </member> + <member name="M:log4net.Core.IRepositorySelector.CreateRepository(System.Reflection.Assembly,System.Type)"> + <summary> + Creates a new repository for the assembly specified. + </summary> + <param name="assembly">The assembly to use to create the domain to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param> + <param name="repositoryType">The type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.</param> + <returns>The repository created.</returns> + <remarks> + <para> + The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the domain + specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the + same assembly specified will return the same repository instance. + </para> + <para> + How the association between <see cref="T:System.Reflection.Assembly"/> and <see cref="T:log4net.Repository.ILoggerRepository"/> + is made is not defined. The implementation may choose any method for + this association. + </para> + </remarks> + </member> + <member name="M:log4net.Core.IRepositorySelector.CreateRepository(System.String,System.Type)"> + <summary> + Creates a new repository with the name specified. + </summary> + <param name="repositoryName">The name to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param> + <param name="repositoryType">The type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.</param> + <returns>The repository created.</returns> + <remarks> + <para> + The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the name + specified such that a call to <see cref="M:GetRepository(string)"/> with the + same name will return the same repository instance. + </para> + </remarks> + </member> + <member name="M:log4net.Core.IRepositorySelector.ExistsRepository(System.String)"> + <summary> + Test if a named repository exists + </summary> + <param name="repositoryName">the named repository to check</param> + <returns><c>true</c> if the repository exists</returns> + <remarks> + <para> + Test if a named repository exists. Use <see cref="M:CreateRepository(Assembly, Type)"/> + to create a new repository and <see cref="M:GetRepository(Assembly)"/> to retrieve + a repository. + </para> + </remarks> + </member> + <member name="M:log4net.Core.IRepositorySelector.GetAllRepositories"> + <summary> + Gets an array of all currently defined repositories. + </summary> + <returns> + An array of the <see cref="T:log4net.Repository.ILoggerRepository"/> instances created by + this <see cref="T:log4net.Core.IRepositorySelector"/>.</returns> + <remarks> + <para> + Gets an array of all of the repositories created by this selector. + </para> + </remarks> + </member> + <member name="E:log4net.Core.IRepositorySelector.LoggerRepositoryCreatedEvent"> + <summary> + Event to notify that a logger repository has been created. + </summary> + <value> + Event to notify that a logger repository has been created. + </value> + <remarks> + <para> + Event raised when a new repository is created. + The event source will be this selector. The event args will + be a <see cref="T:log4net.Core.LoggerRepositoryCreationEventArgs"/> which + holds the newly created <see cref="T:log4net.Repository.ILoggerRepository"/>. + </para> + </remarks> + </member> + <member name="M:log4net.Core.CompactRepositorySelector.#ctor(System.Type)"> + <summary> + Create a new repository selector + </summary> + <param name="defaultRepositoryType">the type of the repositories to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/></param> + <remarks> + <para> + Create an new compact repository selector. + The default type for repositories must be specified, + an appropriate value would be <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>. + </para> + </remarks> + <exception cref="T:System.ArgumentNullException">throw if <paramref name="defaultRepositoryType"/> is null</exception> + <exception cref="T:System.ArgumentOutOfRangeException">throw if <paramref name="defaultRepositoryType"/> does not implement <see cref="T:log4net.Repository.ILoggerRepository"/></exception> + </member> + <member name="M:log4net.Core.CompactRepositorySelector.GetRepository(System.Reflection.Assembly)"> + <summary> + Get the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly + </summary> + <param name="assembly">not used</param> + <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/></returns> + <remarks> + <para> + The <paramref name="assembly"/> argument is not used. This selector does not create a + separate repository for each assembly. + </para> + <para> + As a named repository is not specified the default repository is + returned. The default repository is named <c>log4net-default-repository</c>. + </para> + </remarks> + </member> + <member name="M:log4net.Core.CompactRepositorySelector.GetRepository(System.String)"> + <summary> + Get the named <see cref="T:log4net.Repository.ILoggerRepository"/> + </summary> + <param name="repositoryName">the name of the repository to lookup</param> + <returns>The named <see cref="T:log4net.Repository.ILoggerRepository"/></returns> + <remarks> + <para> + Get the named <see cref="T:log4net.Repository.ILoggerRepository"/>. The default + repository is <c>log4net-default-repository</c>. Other repositories + must be created using the <see cref="M:CreateRepository(string, Type)"/>. + If the named repository does not exist an exception is thrown. + </para> + </remarks> + <exception cref="T:System.ArgumentNullException">throw if <paramref name="repositoryName"/> is null</exception> + <exception cref="T:log4net.Core.LogException">throw if the <paramref name="repositoryName"/> does not exist</exception> + </member> + <member name="M:log4net.Core.CompactRepositorySelector.CreateRepository(System.Reflection.Assembly,System.Type)"> + <summary> + Create a new repository for the assembly specified + </summary> + <param name="assembly">not used</param> + <param name="repositoryType">the type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/></param> + <returns>the repository created</returns> + <remarks> + <para> + The <paramref name="assembly"/> argument is not used. This selector does not create a + separate repository for each assembly. + </para> + <para> + If the <paramref name="repositoryType"/> is <c>null</c> then the + default repository type specified to the constructor is used. + </para> + <para> + As a named repository is not specified the default repository is + returned. The default repository is named <c>log4net-default-repository</c>. + </para> + </remarks> + </member> + <member name="M:log4net.Core.CompactRepositorySelector.CreateRepository(System.String,System.Type)"> + <summary> + Create a new repository for the repository specified + </summary> + <param name="repositoryName">the repository to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/></param> + <param name="repositoryType">the type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>. + If this param is null then the default repository type is used.</param> + <returns>the repository created</returns> + <remarks> + <para> + The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository + specified such that a call to <see cref="M:GetRepository(string)"/> with the + same repository specified will return the same repository instance. + </para> + <para> + If the named repository already exists an exception will be thrown. + </para> + <para> + If <paramref name="repositoryType"/> is <c>null</c> then the default + repository type specified to the constructor is used. + </para> + </remarks> + <exception cref="T:System.ArgumentNullException">throw if <paramref name="repositoryName"/> is null</exception> + <exception cref="T:log4net.Core.LogException">throw if the <paramref name="repositoryName"/> already exists</exception> + </member> + <member name="M:log4net.Core.CompactRepositorySelector.ExistsRepository(System.String)"> + <summary> + Test if a named repository exists + </summary> + <param name="repositoryName">the named repository to check</param> + <returns><c>true</c> if the repository exists</returns> + <remarks> + <para> + Test if a named repository exists. Use <see cref="M:CreateRepository(string, Type)"/> + to create a new repository and <see cref="M:GetRepository(string)"/> to retrieve + a repository. + </para> + </remarks> + </member> + <member name="M:log4net.Core.CompactRepositorySelector.GetAllRepositories"> + <summary> + Gets a list of <see cref="T:log4net.Repository.ILoggerRepository"/> objects + </summary> + <returns>an array of all known <see cref="T:log4net.Repository.ILoggerRepository"/> objects</returns> + <remarks> + <para> + Gets an array of all of the repositories created by this selector. + </para> + </remarks> + </member> + <member name="F:log4net.Core.CompactRepositorySelector.declaringType"> + <summary> + The fully qualified type of the CompactRepositorySelector class. + </summary> + <remarks> + Used by the internal logger to record the Type of the + log message. + </remarks> + </member> + <member name="M:log4net.Core.CompactRepositorySelector.OnLoggerRepositoryCreatedEvent(log4net.Repository.ILoggerRepository)"> + <summary> + Notify the registered listeners that the repository has been created + </summary> + <param name="repository">The repository that has been created</param> + <remarks> + <para> + Raises the <event cref="E:log4net.Core.CompactRepositorySelector.LoggerRepositoryCreatedEvent">LoggerRepositoryCreatedEvent</event> + event. + </para> + </remarks> + </member> + <member name="E:log4net.Core.CompactRepositorySelector.LoggerRepositoryCreatedEvent"> + <summary> + Event to notify that a logger repository has been created. + </summary> + <value> + Event to notify that a logger repository has been created. + </value> + <remarks> + <para> + Event raised when a new repository is created. + The event source will be this selector. The event args will + be a <see cref="T:log4net.Core.LoggerRepositoryCreationEventArgs"/> which + holds the newly created <see cref="T:log4net.Repository.ILoggerRepository"/>. + </para> + </remarks> + </member> + <member name="T:log4net.Core.DefaultRepositorySelector"> + <summary> + The default implementation of the <see cref="T:log4net.Core.IRepositorySelector"/> interface. + </summary> + <remarks> + <para> + Uses attributes defined on the calling assembly to determine how to + configure the hierarchy for the repository. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Core.DefaultRepositorySelector.#ctor(System.Type)"> + <summary> + Creates a new repository selector. + </summary> + <param name="defaultRepositoryType">The type of the repositories to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/></param> + <remarks> + <para> + Create an new repository selector. + The default type for repositories must be specified, + an appropriate value would be <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>. + </para> + </remarks> + <exception cref="T:System.ArgumentNullException"><paramref name="defaultRepositoryType"/> is <see langword="null"/>.</exception> + <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="defaultRepositoryType"/> does not implement <see cref="T:log4net.Repository.ILoggerRepository"/>.</exception> + </member> + <member name="M:log4net.Core.DefaultRepositorySelector.GetRepository(System.Reflection.Assembly)"> + <summary> + Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly. + </summary> + <param name="repositoryAssembly">The assembly use to lookup the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param> + <remarks> + <para> + The type of the <see cref="T:log4net.Repository.ILoggerRepository"/> created and the repository + to create can be overridden by specifying the <see cref="T:log4net.Config.RepositoryAttribute"/> + attribute on the <paramref name="repositoryAssembly"/>. + </para> + <para> + The default values are to use the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> + implementation of the <see cref="T:log4net.Repository.ILoggerRepository"/> interface and to use the + <see cref="P:System.Reflection.AssemblyName.Name"/> as the name of the repository. + </para> + <para> + The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be automatically configured using + any <see cref="T:log4net.Config.ConfiguratorAttribute"/> attributes defined on + the <paramref name="repositoryAssembly"/>. + </para> + </remarks> + <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> for the assembly</returns> + <exception cref="T:System.ArgumentNullException"><paramref name="repositoryAssembly"/> is <see langword="null"/>.</exception> + </member> + <member name="M:log4net.Core.DefaultRepositorySelector.GetRepository(System.String)"> + <summary> + Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified repository. + </summary> + <param name="repositoryName">The repository to use to lookup the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param> + <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified repository.</returns> + <remarks> + <para> + Returns the named repository. If <paramref name="repositoryName"/> is <c>null</c> + a <see cref="T:System.ArgumentNullException"/> is thrown. If the repository + does not exist a <see cref="T:log4net.Core.LogException"/> is thrown. + </para> + <para> + Use <see cref="M:CreateRepository(string, Type)"/> to create a repository. + </para> + </remarks> + <exception cref="T:System.ArgumentNullException"><paramref name="repositoryName"/> is <see langword="null"/>.</exception> + <exception cref="T:log4net.Core.LogException"><paramref name="repositoryName"/> does not exist.</exception> + </member> + <member name="M:log4net.Core.DefaultRepositorySelector.CreateRepository(System.Reflection.Assembly,System.Type)"> + <summary> + Create a new repository for the assembly specified + </summary> + <param name="repositoryAssembly">the assembly to use to create the repository to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param> + <param name="repositoryType">The type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.</param> + <returns>The repository created.</returns> + <remarks> + <para> + The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository + specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the + same assembly specified will return the same repository instance. + </para> + <para> + The type of the <see cref="T:log4net.Repository.ILoggerRepository"/> created and + the repository to create can be overridden by specifying the + <see cref="T:log4net.Config.RepositoryAttribute"/> attribute on the + <paramref name="repositoryAssembly"/>. The default values are to use the + <paramref name="repositoryType"/> implementation of the + <see cref="T:log4net.Repository.ILoggerRepository"/> interface and to use the + <see cref="P:System.Reflection.AssemblyName.Name"/> as the name of the repository. + </para> + <para> + The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be automatically + configured using any <see cref="T:log4net.Config.ConfiguratorAttribute"/> + attributes defined on the <paramref name="repositoryAssembly"/>. + </para> + <para> + If a repository for the <paramref name="repositoryAssembly"/> already exists + that repository will be returned. An error will not be raised and that + repository may be of a different type to that specified in <paramref name="repositoryType"/>. + Also the <see cref="T:log4net.Config.RepositoryAttribute"/> attribute on the + assembly may be used to override the repository type specified in + <paramref name="repositoryType"/>. + </para> + </remarks> + <exception cref="T:System.ArgumentNullException"><paramref name="repositoryAssembly"/> is <see langword="null"/>.</exception> + </member> + <member name="M:log4net.Core.DefaultRepositorySelector.CreateRepository(System.Reflection.Assembly,System.Type,System.String,System.Boolean)"> + <summary> + Creates a new repository for the assembly specified. + </summary> + <param name="repositoryAssembly">the assembly to use to create the repository to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param> + <param name="repositoryType">The type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.</param> + <param name="repositoryName">The name to assign to the created repository</param> + <param name="readAssemblyAttributes">Set to <c>true</c> to read and apply the assembly attributes</param> + <returns>The repository created.</returns> + <remarks> + <para> + The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository + specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the + same assembly specified will return the same repository instance. + </para> + <para> + The type of the <see cref="T:log4net.Repository.ILoggerRepository"/> created and + the repository to create can be overridden by specifying the + <see cref="T:log4net.Config.RepositoryAttribute"/> attribute on the + <paramref name="repositoryAssembly"/>. The default values are to use the + <paramref name="repositoryType"/> implementation of the + <see cref="T:log4net.Repository.ILoggerRepository"/> interface and to use the + <see cref="P:System.Reflection.AssemblyName.Name"/> as the name of the repository. + </para> + <para> + The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be automatically + configured using any <see cref="T:log4net.Config.ConfiguratorAttribute"/> + attributes defined on the <paramref name="repositoryAssembly"/>. + </para> + <para> + If a repository for the <paramref name="repositoryAssembly"/> already exists + that repository will be returned. An error will not be raised and that + repository may be of a different type to that specified in <paramref name="repositoryType"/>. + Also the <see cref="T:log4net.Config.RepositoryAttribute"/> attribute on the + assembly may be used to override the repository type specified in + <paramref name="repositoryType"/>. + </para> + </remarks> + <exception cref="T:System.ArgumentNullException"><paramref name="repositoryAssembly"/> is <see langword="null"/>.</exception> + </member> + <member name="M:log4net.Core.DefaultRepositorySelector.CreateRepository(System.String,System.Type)"> + <summary> + Creates a new repository for the specified repository. + </summary> + <param name="repositoryName">The repository to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param> + <param name="repositoryType">The type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>. + If this param is <see langword="null"/> then the default repository type is used.</param> + <returns>The new repository.</returns> + <remarks> + <para> + The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository + specified such that a call to <see cref="M:GetRepository(string)"/> with the + same repository specified will return the same repository instance. + </para> + </remarks> + <exception cref="T:System.ArgumentNullException"><paramref name="repositoryName"/> is <see langword="null"/>.</exception> + <exception cref="T:log4net.Core.LogException"><paramref name="repositoryName"/> already exists.</exception> + </member> + <member name="M:log4net.Core.DefaultRepositorySelector.ExistsRepository(System.String)"> + <summary> + Test if a named repository exists + </summary> + <param name="repositoryName">the named repository to check</param> + <returns><c>true</c> if the repository exists</returns> + <remarks> + <para> + Test if a named repository exists. Use <see cref="M:CreateRepository(string, Type)"/> + to create a new repository and <see cref="M:GetRepository(string)"/> to retrieve + a repository. + </para> + </remarks> + </member> + <member name="M:log4net.Core.DefaultRepositorySelector.GetAllRepositories"> + <summary> + Gets a list of <see cref="T:log4net.Repository.ILoggerRepository"/> objects + </summary> + <returns>an array of all known <see cref="T:log4net.Repository.ILoggerRepository"/> objects</returns> + <remarks> + <para> + Gets an array of all of the repositories created by this selector. + </para> + </remarks> + </member> + <member name="M:log4net.Core.DefaultRepositorySelector.AliasRepository(System.String,log4net.Repository.ILoggerRepository)"> + <summary> + Aliases a repository to an existing repository. + </summary> + <param name="repositoryAlias">The repository to alias.</param> + <param name="repositoryTarget">The repository that the repository is aliased to.</param> + <remarks> + <para> + The repository specified will be aliased to the repository when created. + The repository must not already exist. + </para> + <para> + When the repository is created it must utilize the same repository type as + the repository it is aliased to, otherwise the aliasing will fail. + </para> + </remarks> + <exception cref="T:System.ArgumentNullException"> + <para><paramref name="repositoryAlias"/> is <see langword="null"/>.</para> + <para>-or-</para> + <para><paramref name="repositoryTarget"/> is <see langword="null"/>.</para> + </exception> + </member> + <member name="M:log4net.Core.DefaultRepositorySelector.OnLoggerRepositoryCreatedEvent(log4net.Repository.ILoggerRepository)"> + <summary> + Notifies the registered listeners that the repository has been created. + </summary> + <param name="repository">The repository that has been created.</param> + <remarks> + <para> + Raises the <see cref="E:log4net.Core.DefaultRepositorySelector.LoggerRepositoryCreatedEvent"/> event. + </para> + </remarks> + </member> + <member name="M:log4net.Core.DefaultRepositorySelector.GetInfoForAssembly(System.Reflection.Assembly,System.String@,System.Type@)"> + <summary> + Gets the repository name and repository type for the specified assembly. + </summary> + <param name="assembly">The assembly that has a <see cref="T:log4net.Config.RepositoryAttribute"/>.</param> + <param name="repositoryName">in/out param to hold the repository name to use for the assembly, caller should set this to the default value before calling.</param> + <param name="repositoryType">in/out param to hold the type of the repository to create for the assembly, caller should set this to the default value before calling.</param> + <exception cref="T:System.ArgumentNullException"><paramref name="assembly"/> is <see langword="null"/>.</exception> + </member> + <member name="M:log4net.Core.DefaultRepositorySelector.ConfigureRepository(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)"> + <summary> + Configures the repository using information from the assembly. + </summary> + <param name="assembly">The assembly containing <see cref="T:log4net.Config.ConfiguratorAttribute"/> + attributes which define the configuration for the repository.</param> + <param name="repository">The repository to configure.</param> + <exception cref="T:System.ArgumentNullException"> + <para><paramref name="assembly"/> is <see langword="null"/>.</para> + <para>-or-</para> + <para><paramref name="repository"/> is <see langword="null"/>.</para> + </exception> + </member> + <member name="M:log4net.Core.DefaultRepositorySelector.LoadPlugins(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)"> + <summary> + Loads the attribute defined plugins on the assembly. + </summary> + <param name="assembly">The assembly that contains the attributes.</param> + <param name="repository">The repository to add the plugins to.</param> + <exception cref="T:System.ArgumentNullException"> + <para><paramref name="assembly"/> is <see langword="null"/>.</para> + <para>-or-</para> + <para><paramref name="repository"/> is <see langword="null"/>.</para> + </exception> + </member> + <member name="M:log4net.Core.DefaultRepositorySelector.LoadAliases(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)"> + <summary> + Loads the attribute defined aliases on the assembly. + </summary> + <param name="assembly">The assembly that contains the attributes.</param> + <param name="repository">The repository to alias to.</param> + <exception cref="T:System.ArgumentNullException"> + <para><paramref name="assembly"/> is <see langword="null"/>.</para> + <para>-or-</para> + <para><paramref name="repository"/> is <see langword="null"/>.</para> + </exception> + </member> + <member name="F:log4net.Core.DefaultRepositorySelector.declaringType"> + <summary> + The fully qualified type of the DefaultRepositorySelector class. + </summary> + <remarks> + Used by the internal logger to record the Type of the + log message. + </remarks> + </member> + <member name="E:log4net.Core.DefaultRepositorySelector.LoggerRepositoryCreatedEvent"> + <summary> + Event to notify that a logger repository has been created. + </summary> + <value> + Event to notify that a logger repository has been created. + </value> + <remarks> + <para> + Event raised when a new repository is created. + The event source will be this selector. The event args will + be a <see cref="T:log4net.Core.LoggerRepositoryCreationEventArgs"/> which + holds the newly created <see cref="T:log4net.Repository.ILoggerRepository"/>. + </para> + </remarks> + </member> + <member name="T:log4net.Core.ErrorCode"> + <summary> + Defined error codes that can be passed to the <see cref="M:IErrorHandler.Error(string, Exception, ErrorCode)"/> method. + </summary> + <remarks> + <para> + Values passed to the <see cref="M:IErrorHandler.Error(string, Exception, ErrorCode)"/> method. + </para> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="F:log4net.Core.ErrorCode.GenericFailure"> + <summary> + A general error + </summary> + </member> + <member name="F:log4net.Core.ErrorCode.WriteFailure"> + <summary> + Error while writing output + </summary> + </member> + <member name="F:log4net.Core.ErrorCode.FlushFailure"> + <summary> + Failed to flush file + </summary> + </member> + <member name="F:log4net.Core.ErrorCode.CloseFailure"> + <summary> + Failed to close file + </summary> + </member> + <member name="F:log4net.Core.ErrorCode.FileOpenFailure"> + <summary> + Unable to open output file + </summary> + </member> + <member name="F:log4net.Core.ErrorCode.MissingLayout"> + <summary> + No layout specified + </summary> + </member> + <member name="F:log4net.Core.ErrorCode.AddressParseFailure"> + <summary> + Failed to parse address + </summary> + </member> + <member name="T:log4net.Core.ExceptionEvaluator"> + <summary> + An evaluator that triggers on an Exception type + </summary> + <remarks> + <para> + This evaluator will trigger if the type of the Exception + passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/> + is equal to a Type in <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/>. /// + </para> + </remarks> + <author>Drew Schaeffer</author> + </member> + <member name="T:log4net.Core.ITriggeringEventEvaluator"> + <summary> + Test if an <see cref="T:log4net.Core.LoggingEvent"/> triggers an action + </summary> + <remarks> + <para> + Implementations of this interface allow certain appenders to decide + when to perform an appender specific action. + </para> + <para> + The action or behavior triggered is defined by the implementation. + </para> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="M:log4net.Core.ITriggeringEventEvaluator.IsTriggeringEvent(log4net.Core.LoggingEvent)"> + <summary> + Test if this event triggers the action + </summary> + <param name="loggingEvent">The event to check</param> + <returns><c>true</c> if this event triggers the action, otherwise <c>false</c></returns> + <remarks> + <para> + Return <c>true</c> if this event triggers the action + </para> + </remarks> + </member> + <member name="F:log4net.Core.ExceptionEvaluator.m_type"> + <summary> + The type that causes the trigger to fire. + </summary> + </member> + <member name="F:log4net.Core.ExceptionEvaluator.m_triggerOnSubclass"> + <summary> + Causes subclasses of <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/> to cause the trigger to fire. + </summary> + </member> + <member name="M:log4net.Core.ExceptionEvaluator.#ctor"> + <summary> + Default ctor to allow dynamic creation through a configurator. + </summary> + </member> + <member name="M:log4net.Core.ExceptionEvaluator.#ctor(System.Type,System.Boolean)"> + <summary> + Constructs an evaluator and initializes to trigger on <paramref name="exType"/> + </summary> + <param name="exType">the type that triggers this evaluator.</param> + <param name="triggerOnSubClass">If true, this evaluator will trigger on subclasses of <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/>.</param> + </member> + <member name="M:log4net.Core.ExceptionEvaluator.IsTriggeringEvent(log4net.Core.LoggingEvent)"> + <summary> + Is this <paramref name="loggingEvent"/> the triggering event? + </summary> + <param name="loggingEvent">The event to check</param> + <returns>This method returns <c>true</c>, if the logging event Exception + Type is <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/>. + Otherwise it returns <c>false</c></returns> + <remarks> + <para> + This evaluator will trigger if the Exception Type of the event + passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/> + is <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/>. + </para> + </remarks> + </member> + <member name="P:log4net.Core.ExceptionEvaluator.ExceptionType"> + <summary> + The type that triggers this evaluator. + </summary> + </member> + <member name="P:log4net.Core.ExceptionEvaluator.TriggerOnSubclass"> + <summary> + If true, this evaluator will trigger on subclasses of <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/>. + </summary> + </member> + <member name="T:log4net.Core.IErrorHandler"> + <summary> + Appenders may delegate their error handling to an <see cref="T:log4net.Core.IErrorHandler"/>. + </summary> + <remarks> + <para> + Error handling is a particularly tedious to get right because by + definition errors are hard to predict and to reproduce. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Core.IErrorHandler.Error(System.String,System.Exception,log4net.Core.ErrorCode)"> + <summary> + Handles the error and information about the error condition is passed as + a parameter. + </summary> + <param name="message">The message associated with the error.</param> + <param name="e">The <see cref="T:System.Exception"/> that was thrown when the error occurred.</param> + <param name="errorCode">The error code associated with the error.</param> + <remarks> + <para> + Handles the error and information about the error condition is passed as + a parameter. + </para> + </remarks> + </member> + <member name="M:log4net.Core.IErrorHandler.Error(System.String,System.Exception)"> + <summary> + Prints the error message passed as a parameter. + </summary> + <param name="message">The message associated with the error.</param> + <param name="e">The <see cref="T:System.Exception"/> that was thrown when the error occurred.</param> + <remarks> + <para> + See <see cref="M:Error(string,Exception,ErrorCode)"/>. + </para> + </remarks> + </member> + <member name="M:log4net.Core.IErrorHandler.Error(System.String)"> + <summary> + Prints the error message passed as a parameter. + </summary> + <param name="message">The message associated with the error.</param> + <remarks> + <para> + See <see cref="M:Error(string,Exception,ErrorCode)"/>. + </para> + </remarks> + </member> + <member name="T:log4net.Core.IFixingRequired"> + <summary> + Interface for objects that require fixing. + </summary> + <remarks> + <para> + Interface that indicates that the object requires fixing before it + can be taken outside the context of the appender's + <see cref="M:log4net.Appender.IAppender.DoAppend(log4net.Core.LoggingEvent)"/> method. + </para> + <para> + When objects that implement this interface are stored + in the context properties maps <see cref="T:log4net.GlobalContext"/> + <see cref="P:log4net.GlobalContext.Properties"/> and <see cref="T:log4net.ThreadContext"/> + <see cref="P:log4net.ThreadContext.Properties"/> are fixed + (see <see cref="P:log4net.Core.LoggingEvent.Fix"/>) the <see cref="M:log4net.Core.IFixingRequired.GetFixedObject"/> + method will be called. + </para> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="M:log4net.Core.IFixingRequired.GetFixedObject"> + <summary> + Get a portable version of this object + </summary> + <returns>the portable instance of this object</returns> + <remarks> + <para> + Get a portable instance object that represents the current + state of this object. The portable object can be stored + and logged from any thread with identical results. + </para> + </remarks> + </member> + <member name="T:log4net.Core.ILogger"> + <summary> + Interface that all loggers implement + </summary> + <remarks> + <para> + This interface supports logging events and testing if a level + is enabled for logging. + </para> + <para> + These methods will not throw exceptions. Note to implementor, ensure + that the implementation of these methods cannot allow an exception + to be thrown to the caller. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Core.ILogger.Log(System.Type,log4net.Core.Level,System.Object,System.Exception)"> + <summary> + This generic form is intended to be used by wrappers. + </summary> + <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is + the stack boundary into the logging system for this call.</param> + <param name="level">The level of the message to be logged.</param> + <param name="message">The message object to log.</param> + <param name="exception">the exception to log, including its stack trace. Pass <c>null</c> to not log an exception.</param> + <remarks> + <para> + Generates a logging event for the specified <paramref name="level"/> using + the <paramref name="message"/> and <paramref name="exception"/>. + </para> + </remarks> + </member> + <member name="M:log4net.Core.ILogger.Log(log4net.Core.LoggingEvent)"> + <summary> + This is the most generic printing method that is intended to be used + by wrappers. + </summary> + <param name="logEvent">The event being logged.</param> + <remarks> + <para> + Logs the specified logging event through this logger. + </para> + </remarks> + </member> + <member name="M:log4net.Core.ILogger.IsEnabledFor(log4net.Core.Level)"> + <summary> + Checks if this logger is enabled for a given <see cref="T:log4net.Core.Level"/> passed as parameter. + </summary> + <param name="level">The level to check.</param> + <returns> + <c>true</c> if this logger is enabled for <c>level</c>, otherwise <c>false</c>. + </returns> + <remarks> + <para> + Test if this logger is going to log events of the specified <paramref name="level"/>. + </para> + </remarks> + </member> + <member name="P:log4net.Core.ILogger.Name"> + <summary> + Gets the name of the logger. + </summary> + <value> + The name of the logger. + </value> + <remarks> + <para> + The name of this logger + </para> + </remarks> + </member> + <member name="P:log4net.Core.ILogger.Repository"> + <summary> + Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> where this + <c>Logger</c> instance is attached to. + </summary> + <value> + The <see cref="T:log4net.Repository.ILoggerRepository"/> that this logger belongs to. + </value> + <remarks> + <para> + Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> where this + <c>Logger</c> instance is attached to. + </para> + </remarks> + </member> + <member name="T:log4net.Core.ILoggerWrapper"> + <summary> + Base interface for all wrappers + </summary> + <remarks> + <para> + Base interface for all wrappers. + </para> + <para> + All wrappers must implement this interface. + </para> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="P:log4net.Core.ILoggerWrapper.Logger"> + <summary> + Get the implementation behind this wrapper object. + </summary> + <value> + The <see cref="T:log4net.Core.ILogger"/> object that in implementing this object. + </value> + <remarks> + <para> + The <see cref="T:log4net.Core.ILogger"/> object that in implementing this + object. The <c>Logger</c> object may not + be the same object as this object because of logger decorators. + This gets the actual underlying objects that is used to process + the log events. + </para> + </remarks> + </member> + <member name="T:log4net.Core.LoggerRepositoryCreationEventHandler"> + <summary> + Delegate used to handle logger repository creation event notifications + </summary> + <param name="sender">The <see cref="T:log4net.Core.IRepositorySelector"/> which created the repository.</param> + <param name="e">The <see cref="T:log4net.Core.LoggerRepositoryCreationEventArgs"/> event args + that holds the <see cref="T:log4net.Repository.ILoggerRepository"/> instance that has been created.</param> + <remarks> + <para> + Delegate used to handle logger repository creation event notifications. + </para> + </remarks> + </member> + <member name="T:log4net.Core.LoggerRepositoryCreationEventArgs"> + <summary> + Provides data for the <see cref="E:log4net.Core.IRepositorySelector.LoggerRepositoryCreatedEvent"/> event. + </summary> + <remarks> + <para> + A <see cref="E:log4net.Core.IRepositorySelector.LoggerRepositoryCreatedEvent"/> + event is raised every time a <see cref="T:log4net.Repository.ILoggerRepository"/> is created. + </para> + </remarks> + </member> + <member name="F:log4net.Core.LoggerRepositoryCreationEventArgs.m_repository"> + <summary> + The <see cref="T:log4net.Repository.ILoggerRepository"/> created + </summary> + </member> + <member name="M:log4net.Core.LoggerRepositoryCreationEventArgs.#ctor(log4net.Repository.ILoggerRepository)"> + <summary> + Construct instance using <see cref="T:log4net.Repository.ILoggerRepository"/> specified + </summary> + <param name="repository">the <see cref="T:log4net.Repository.ILoggerRepository"/> that has been created</param> + <remarks> + <para> + Construct instance using <see cref="T:log4net.Repository.ILoggerRepository"/> specified + </para> + </remarks> + </member> + <member name="P:log4net.Core.LoggerRepositoryCreationEventArgs.LoggerRepository"> + <summary> + The <see cref="T:log4net.Repository.ILoggerRepository"/> that has been created + </summary> + <value> + The <see cref="T:log4net.Repository.ILoggerRepository"/> that has been created + </value> + <remarks> + <para> + The <see cref="T:log4net.Repository.ILoggerRepository"/> that has been created + </para> + </remarks> + </member> + <member name="T:log4net.Core.Level"> + <summary> + Defines the default set of levels recognized by the system. + </summary> + <remarks> + <para> + Each <see cref="T:log4net.Core.LoggingEvent"/> has an associated <see cref="T:log4net.Core.Level"/>. + </para> + <para> + Levels have a numeric <see cref="P:log4net.Core.Level.Value"/> that defines the relative + ordering between levels. Two Levels with the same <see cref="P:log4net.Core.Level.Value"/> + are deemed to be equivalent. + </para> + <para> + The levels that are recognized by log4net are set for each <see cref="T:log4net.Repository.ILoggerRepository"/> + and each repository can have different levels defined. The levels are stored + in the <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/> on the repository. Levels are + looked up by name from the <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>. + </para> + <para> + When logging at level INFO the actual level used is not <see cref="F:log4net.Core.Level.Info"/> but + the value of <c>LoggerRepository.LevelMap["INFO"]</c>. The default value for this is + <see cref="F:log4net.Core.Level.Info"/>, but this can be changed by reconfiguring the level map. + </para> + <para> + Each level has a <see cref="P:log4net.Core.Level.DisplayName"/> in addition to its <see cref="P:log4net.Core.Level.Name"/>. The + <see cref="P:log4net.Core.Level.DisplayName"/> is the string that is written into the output log. By default + the display name is the same as the level name, but this can be used to alias levels + or to localize the log output. + </para> + <para> + Some of the predefined levels recognized by the system are: + </para> + <list type="bullet"> + <item> + <description><see cref="F:log4net.Core.Level.Off"/>.</description> + </item> + <item> + <description><see cref="F:log4net.Core.Level.Fatal"/>.</description> + </item> + <item> + <description><see cref="F:log4net.Core.Level.Error"/>.</description> + </item> + <item> + <description><see cref="F:log4net.Core.Level.Warn"/>.</description> + </item> + <item> + <description><see cref="F:log4net.Core.Level.Info"/>.</description> + </item> + <item> + <description><see cref="F:log4net.Core.Level.Debug"/>.</description> + </item> + <item> + <description><see cref="F:log4net.Core.Level.All"/>.</description> + </item> + </list> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Core.Level.#ctor(System.Int32,System.String,System.String)"> + <summary> + Constructor + </summary> + <param name="level">Integer value for this level, higher values represent more severe levels.</param> + <param name="levelName">The string name of this level.</param> + <param name="displayName">The display name for this level. This may be localized or otherwise different from the name</param> + <remarks> + <para> + Initializes a new instance of the <see cref="T:log4net.Core.Level"/> class with + the specified level name and value. + </para> + </remarks> + </member> + <member name="M:log4net.Core.Level.#ctor(System.Int32,System.String)"> + <summary> + Constructor + </summary> + <param name="level">Integer value for this level, higher values represent more severe levels.</param> + <param name="levelName">The string name of this level.</param> + <remarks> + <para> + Initializes a new instance of the <see cref="T:log4net.Core.Level"/> class with + the specified level name and value. + </para> + </remarks> + </member> + <member name="M:log4net.Core.Level.ToString"> + <summary> + Returns the <see cref="T:System.String"/> representation of the current + <see cref="T:log4net.Core.Level"/>. + </summary> + <returns> + A <see cref="T:System.String"/> representation of the current <see cref="T:log4net.Core.Level"/>. + </returns> + <remarks> + <para> + Returns the level <see cref="P:log4net.Core.Level.Name"/>. + </para> + </remarks> + </member> + <member name="M:log4net.Core.Level.Equals(System.Object)"> + <summary> + Compares levels. + </summary> + <param name="o">The object to compare against.</param> + <returns><c>true</c> if the objects are equal.</returns> + <remarks> + <para> + Compares the levels of <see cref="T:log4net.Core.Level"/> instances, and + defers to base class if the target object is not a <see cref="T:log4net.Core.Level"/> + instance. + </para> + </remarks> + </member> + <member name="M:log4net.Core.Level.GetHashCode"> + <summary> + Returns a hash code + </summary> + <returns>A hash code for the current <see cref="T:log4net.Core.Level"/>.</returns> + <remarks> + <para> + Returns a hash code suitable for use in hashing algorithms and data + structures like a hash table. + </para> + <para> + Returns the hash code of the level <see cref="P:log4net.Core.Level.Value"/>. + </para> + </remarks> + </member> + <member name="M:log4net.Core.Level.CompareTo(System.Object)"> + <summary> + Compares this instance to a specified object and returns an + indication of their relative values. + </summary> + <param name="r">A <see cref="T:log4net.Core.Level"/> instance or <see langword="null"/> to compare with this instance.</param> + <returns> + A 32-bit signed integer that indicates the relative order of the + values compared. The return value has these meanings: + <list type="table"> + <listheader> + <term>Value</term> + <description>Meaning</description> + </listheader> + <item> + <term>Less than zero</term> + <description>This instance is less than <paramref name="r"/>.</description> + </item> + <item> + <term>Zero</term> + <description>This instance is equal to <paramref name="r"/>.</description> + </item> + <item> + <term>Greater than zero</term> + <description> + <para>This instance is greater than <paramref name="r"/>.</para> + <para>-or-</para> + <para><paramref name="r"/> is <see langword="null"/>.</para> + </description> + </item> + </list> + </returns> + <remarks> + <para> + <paramref name="r"/> must be an instance of <see cref="T:log4net.Core.Level"/> + or <see langword="null"/>; otherwise, an exception is thrown. + </para> + </remarks> + <exception cref="T:System.ArgumentException"><paramref name="r"/> is not a <see cref="T:log4net.Core.Level"/>.</exception> + </member> + <member name="M:log4net.Core.Level.op_GreaterThan(log4net.Core.Level,log4net.Core.Level)"> + <summary> + Returns a value indicating whether a specified <see cref="T:log4net.Core.Level"/> + is greater than another specified <see cref="T:log4net.Core.Level"/>. + </summary> + <param name="l">A <see cref="T:log4net.Core.Level"/></param> + <param name="r">A <see cref="T:log4net.Core.Level"/></param> + <returns> + <c>true</c> if <paramref name="l"/> is greater than + <paramref name="r"/>; otherwise, <c>false</c>. + </returns> + <remarks> + <para> + Compares two levels. + </para> + </remarks> + </member> + <member name="M:log4net.Core.Level.op_LessThan(log4net.Core.Level,log4net.Core.Level)"> + <summary> + Returns a value indicating whether a specified <see cref="T:log4net.Core.Level"/> + is less than another specified <see cref="T:log4net.Core.Level"/>. + </summary> + <param name="l">A <see cref="T:log4net.Core.Level"/></param> + <param name="r">A <see cref="T:log4net.Core.Level"/></param> + <returns> + <c>true</c> if <paramref name="l"/> is less than + <paramref name="r"/>; otherwise, <c>false</c>. + </returns> + <remarks> + <para> + Compares two levels. + </para> + </remarks> + </member> + <member name="M:log4net.Core.Level.op_GreaterThanOrEqual(log4net.Core.Level,log4net.Core.Level)"> + <summary> + Returns a value indicating whether a specified <see cref="T:log4net.Core.Level"/> + is greater than or equal to another specified <see cref="T:log4net.Core.Level"/>. + </summary> + <param name="l">A <see cref="T:log4net.Core.Level"/></param> + <param name="r">A <see cref="T:log4net.Core.Level"/></param> + <returns> + <c>true</c> if <paramref name="l"/> is greater than or equal to + <paramref name="r"/>; otherwise, <c>false</c>. + </returns> + <remarks> + <para> + Compares two levels. + </para> + </remarks> + </member> + <member name="M:log4net.Core.Level.op_LessThanOrEqual(log4net.Core.Level,log4net.Core.Level)"> + <summary> + Returns a value indicating whether a specified <see cref="T:log4net.Core.Level"/> + is less than or equal to another specified <see cref="T:log4net.Core.Level"/>. + </summary> + <param name="l">A <see cref="T:log4net.Core.Level"/></param> + <param name="r">A <see cref="T:log4net.Core.Level"/></param> + <returns> + <c>true</c> if <paramref name="l"/> is less than or equal to + <paramref name="r"/>; otherwise, <c>false</c>. + </returns> + <remarks> + <para> + Compares two levels. + </para> + </remarks> + </member> + <member name="M:log4net.Core.Level.op_Equality(log4net.Core.Level,log4net.Core.Level)"> + <summary> + Returns a value indicating whether two specified <see cref="T:log4net.Core.Level"/> + objects have the same value. + </summary> + <param name="l">A <see cref="T:log4net.Core.Level"/> or <see langword="null"/>.</param> + <param name="r">A <see cref="T:log4net.Core.Level"/> or <see langword="null"/>.</param> + <returns> + <c>true</c> if the value of <paramref name="l"/> is the same as the + value of <paramref name="r"/>; otherwise, <c>false</c>. + </returns> + <remarks> + <para> + Compares two levels. + </para> + </remarks> + </member> + <member name="M:log4net.Core.Level.op_Inequality(log4net.Core.Level,log4net.Core.Level)"> + <summary> + Returns a value indicating whether two specified <see cref="T:log4net.Core.Level"/> + objects have different values. + </summary> + <param name="l">A <see cref="T:log4net.Core.Level"/> or <see langword="null"/>.</param> + <param name="r">A <see cref="T:log4net.Core.Level"/> or <see langword="null"/>.</param> + <returns> + <c>true</c> if the value of <paramref name="l"/> is different from + the value of <paramref name="r"/>; otherwise, <c>false</c>. + </returns> + <remarks> + <para> + Compares two levels. + </para> + </remarks> + </member> + <member name="M:log4net.Core.Level.Compare(log4net.Core.Level,log4net.Core.Level)"> + <summary> + Compares two specified <see cref="T:log4net.Core.Level"/> instances. + </summary> + <param name="l">The first <see cref="T:log4net.Core.Level"/> to compare.</param> + <param name="r">The second <see cref="T:log4net.Core.Level"/> to compare.</param> + <returns> + A 32-bit signed integer that indicates the relative order of the + two values compared. The return value has these meanings: + <list type="table"> + <listheader> + <term>Value</term> + <description>Meaning</description> + </listheader> + <item> + <term>Less than zero</term> + <description><paramref name="l"/> is less than <paramref name="r"/>.</description> + </item> + <item> + <term>Zero</term> + <description><paramref name="l"/> is equal to <paramref name="r"/>.</description> + </item> + <item> + <term>Greater than zero</term> + <description><paramref name="l"/> is greater than <paramref name="r"/>.</description> + </item> + </list> + </returns> + <remarks> + <para> + Compares two levels. + </para> + </remarks> + </member> + <member name="F:log4net.Core.Level.Off"> + <summary> + The <see cref="F:log4net.Core.Level.Off"/> level designates a higher level than all the rest. + </summary> + </member> + <member name="F:log4net.Core.Level.Log4Net_Debug"> + <summary> + The <see cref="F:log4net.Core.Level.Emergency"/> level designates very severe error events. + System unusable, emergencies. + </summary> + </member> + <member name="F:log4net.Core.Level.Emergency"> + <summary> + The <see cref="F:log4net.Core.Level.Emergency"/> level designates very severe error events. + System unusable, emergencies. + </summary> + </member> + <member name="F:log4net.Core.Level.Fatal"> + <summary> + The <see cref="F:log4net.Core.Level.Fatal"/> level designates very severe error events + that will presumably lead the application to abort. + </summary> + </member> + <member name="F:log4net.Core.Level.Alert"> + <summary> + The <see cref="F:log4net.Core.Level.Alert"/> level designates very severe error events. + Take immediate action, alerts. + </summary> + </member> + <member name="F:log4net.Core.Level.Critical"> + <summary> + The <see cref="F:log4net.Core.Level.Critical"/> level designates very severe error events. + Critical condition, critical. + </summary> + </member> + <member name="F:log4net.Core.Level.Severe"> + <summary> + The <see cref="F:log4net.Core.Level.Severe"/> level designates very severe error events. + </summary> + </member> + <member name="F:log4net.Core.Level.Error"> + <summary> + The <see cref="F:log4net.Core.Level.Error"/> level designates error events that might + still allow the application to continue running. + </summary> + </member> + <member name="F:log4net.Core.Level.Warn"> + <summary> + The <see cref="F:log4net.Core.Level.Warn"/> level designates potentially harmful + situations. + </summary> + </member> + <member name="F:log4net.Core.Level.Notice"> + <summary> + The <see cref="F:log4net.Core.Level.Notice"/> level designates informational messages + that highlight the progress of the application at the highest level. + </summary> + </member> + <member name="F:log4net.Core.Level.Info"> + <summary> + The <see cref="F:log4net.Core.Level.Info"/> level designates informational messages that + highlight the progress of the application at coarse-grained level. + </summary> + </member> + <member name="F:log4net.Core.Level.Debug"> + <summary> + The <see cref="F:log4net.Core.Level.Debug"/> level designates fine-grained informational + events that are most useful to debug an application. + </summary> + </member> + <member name="F:log4net.Core.Level.Fine"> + <summary> + The <see cref="F:log4net.Core.Level.Fine"/> level designates fine-grained informational + events that are most useful to debug an application. + </summary> + </member> + <member name="F:log4net.Core.Level.Trace"> + <summary> + The <see cref="F:log4net.Core.Level.Trace"/> level designates fine-grained informational + events that are most useful to debug an application. + </summary> + </member> + <member name="F:log4net.Core.Level.Finer"> + <summary> + The <see cref="F:log4net.Core.Level.Finer"/> level designates fine-grained informational + events that are most useful to debug an application. + </summary> + </member> + <member name="F:log4net.Core.Level.Verbose"> + <summary> + The <see cref="F:log4net.Core.Level.Verbose"/> level designates fine-grained informational + events that are most useful to debug an application. + </summary> + </member> + <member name="F:log4net.Core.Level.Finest"> + <summary> + The <see cref="F:log4net.Core.Level.Finest"/> level designates fine-grained informational + events that are most useful to debug an application. + </summary> + </member> + <member name="F:log4net.Core.Level.All"> + <summary> + The <see cref="F:log4net.Core.Level.All"/> level designates the lowest level possible. + </summary> + </member> + <member name="P:log4net.Core.Level.Name"> + <summary> + Gets the name of this level. + </summary> + <value> + The name of this level. + </value> + <remarks> + <para> + Gets the name of this level. + </para> + </remarks> + </member> + <member name="P:log4net.Core.Level.Value"> + <summary> + Gets the value of this level. + </summary> + <value> + The value of this level. + </value> + <remarks> + <para> + Gets the value of this level. + </para> + </remarks> + </member> + <member name="P:log4net.Core.Level.DisplayName"> + <summary> + Gets the display name of this level. + </summary> + <value> + The display name of this level. + </value> + <remarks> + <para> + Gets the display name of this level. + </para> + </remarks> + </member> + <member name="T:log4net.Core.LevelCollection"> + <summary> + A strongly-typed collection of <see cref="T:log4net.Core.Level"/> objects. + </summary> + <author>Nicko Cadell</author> + </member> + <member name="M:log4net.Core.LevelCollection.ReadOnly(log4net.Core.LevelCollection)"> + <summary> + Creates a read-only wrapper for a <c>LevelCollection</c> instance. + </summary> + <param name="list">list to create a readonly wrapper arround</param> + <returns> + A <c>LevelCollection</c> wrapper that is read-only. + </returns> + </member> + <member name="M:log4net.Core.LevelCollection.#ctor"> + <summary> + Initializes a new instance of the <c>LevelCollection</c> class + that is empty and has the default initial capacity. + </summary> + </member> + <member name="M:log4net.Core.LevelCollection.#ctor(System.Int32)"> + <summary> + Initializes a new instance of the <c>LevelCollection</c> class + that has the specified initial capacity. + </summary> + <param name="capacity"> + The number of elements that the new <c>LevelCollection</c> is initially capable of storing. + </param> + </member> + <member name="M:log4net.Core.LevelCollection.#ctor(log4net.Core.LevelCollection)"> + <summary> + Initializes a new instance of the <c>LevelCollection</c> class + that contains elements copied from the specified <c>LevelCollection</c>. + </summary> + <param name="c">The <c>LevelCollection</c> whose elements are copied to the new collection.</param> + </member> + <member name="M:log4net.Core.LevelCollection.#ctor(log4net.Core.Level[])"> + <summary> + Initializes a new instance of the <c>LevelCollection</c> class + that contains elements copied from the specified <see cref="T:log4net.Core.Level"/> array. + </summary> + <param name="a">The <see cref="T:log4net.Core.Level"/> array whose elements are copied to the new list.</param> + </member> + <member name="M:log4net.Core.LevelCollection.#ctor(System.Collections.ICollection)"> + <summary> + Initializes a new instance of the <c>LevelCollection</c> class + that contains elements copied from the specified <see cref="T:log4net.Core.Level"/> collection. + </summary> + <param name="col">The <see cref="T:log4net.Core.Level"/> collection whose elements are copied to the new list.</param> + </member> + <member name="M:log4net.Core.LevelCollection.#ctor(log4net.Core.LevelCollection.Tag)"> + <summary> + Allow subclasses to avoid our default constructors + </summary> + <param name="tag"></param> + </member> + <member name="M:log4net.Core.LevelCollection.CopyTo(log4net.Core.Level[])"> + <summary> + Copies the entire <c>LevelCollection</c> to a one-dimensional + <see cref="T:log4net.Core.Level"/> array. + </summary> + <param name="array">The one-dimensional <see cref="T:log4net.Core.Level"/> array to copy to.</param> + </member> + <member name="M:log4net.Core.LevelCollection.CopyTo(log4net.Core.Level[],System.Int32)"> + <summary> + Copies the entire <c>LevelCollection</c> to a one-dimensional + <see cref="T:log4net.Core.Level"/> array, starting at the specified index of the target array. + </summary> + <param name="array">The one-dimensional <see cref="T:log4net.Core.Level"/> array to copy to.</param> + <param name="start">The zero-based index in <paramref name="array"/> at which copying begins.</param> + </member> + <member name="M:log4net.Core.LevelCollection.Add(log4net.Core.Level)"> + <summary> + Adds a <see cref="T:log4net.Core.Level"/> to the end of the <c>LevelCollection</c>. + </summary> + <param name="item">The <see cref="T:log4net.Core.Level"/> to be added to the end of the <c>LevelCollection</c>.</param> + <returns>The index at which the value has been added.</returns> + </member> + <member name="M:log4net.Core.LevelCollection.Clear"> + <summary> + Removes all elements from the <c>LevelCollection</c>. + </summary> + </member> + <member name="M:log4net.Core.LevelCollection.Clone"> + <summary> + Creates a shallow copy of the <see cref="T:log4net.Core.LevelCollection"/>. + </summary> + <returns>A new <see cref="T:log4net.Core.LevelCollection"/> with a shallow copy of the collection data.</returns> + </member> + <member name="M:log4net.Core.LevelCollection.Contains(log4net.Core.Level)"> + <summary> + Determines whether a given <see cref="T:log4net.Core.Level"/> is in the <c>LevelCollection</c>. + </summary> + <param name="item">The <see cref="T:log4net.Core.Level"/> to check for.</param> + <returns><c>true</c> if <paramref name="item"/> is found in the <c>LevelCollection</c>; otherwise, <c>false</c>.</returns> + </member> + <member name="M:log4net.Core.LevelCollection.IndexOf(log4net.Core.Level)"> + <summary> + Returns the zero-based index of the first occurrence of a <see cref="T:log4net.Core.Level"/> + in the <c>LevelCollection</c>. + </summary> + <param name="item">The <see cref="T:log4net.Core.Level"/> to locate in the <c>LevelCollection</c>.</param> + <returns> + The zero-based index of the first occurrence of <paramref name="item"/> + in the entire <c>LevelCollection</c>, if found; otherwise, -1. + </returns> + </member> + <member name="M:log4net.Core.LevelCollection.Insert(System.Int32,log4net.Core.Level)"> + <summary> + Inserts an element into the <c>LevelCollection</c> at the specified index. + </summary> + <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param> + <param name="item">The <see cref="T:log4net.Core.Level"/> to insert.</param> + <exception cref="T:System.ArgumentOutOfRangeException"> + <para><paramref name="index"/> is less than zero</para> + <para>-or-</para> + <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Core.LevelCollection.Count"/>.</para> + </exception> + </member> + <member name="M:log4net.Core.LevelCollection.Remove(log4net.Core.Level)"> + <summary> + Removes the first occurrence of a specific <see cref="T:log4net.Core.Level"/> from the <c>LevelCollection</c>. + </summary> + <param name="item">The <see cref="T:log4net.Core.Level"/> to remove from the <c>LevelCollection</c>.</param> + <exception cref="T:System.ArgumentException"> + The specified <see cref="T:log4net.Core.Level"/> was not found in the <c>LevelCollection</c>. + </exception> + </member> + <member name="M:log4net.Core.LevelCollection.RemoveAt(System.Int32)"> + <summary> + Removes the element at the specified index of the <c>LevelCollection</c>. + </summary> + <param name="index">The zero-based index of the element to remove.</param> + <exception cref="T:System.ArgumentOutOfRangeException"> + <para><paramref name="index"/> is less than zero</para> + <para>-or-</para> + <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Core.LevelCollection.Count"/>.</para> + </exception> + </member> + <member name="M:log4net.Core.LevelCollection.GetEnumerator"> + <summary> + Returns an enumerator that can iterate through the <c>LevelCollection</c>. + </summary> + <returns>An <see cref="T:log4net.Core.LevelCollection.Enumerator"/> for the entire <c>LevelCollection</c>.</returns> + </member> + <member name="M:log4net.Core.LevelCollection.AddRange(log4net.Core.LevelCollection)"> + <summary> + Adds the elements of another <c>LevelCollection</c> to the current <c>LevelCollection</c>. + </summary> + <param name="x">The <c>LevelCollection</c> whose elements should be added to the end of the current <c>LevelCollection</c>.</param> + <returns>The new <see cref="P:log4net.Core.LevelCollection.Count"/> of the <c>LevelCollection</c>.</returns> + </member> + <member name="M:log4net.Core.LevelCollection.AddRange(log4net.Core.Level[])"> + <summary> + Adds the elements of a <see cref="T:log4net.Core.Level"/> array to the current <c>LevelCollection</c>. + </summary> + <param name="x">The <see cref="T:log4net.Core.Level"/> array whose elements should be added to the end of the <c>LevelCollection</c>.</param> + <returns>The new <see cref="P:log4net.Core.LevelCollection.Count"/> of the <c>LevelCollection</c>.</returns> + </member> + <member name="M:log4net.Core.LevelCollection.AddRange(System.Collections.ICollection)"> + <summary> + Adds the elements of a <see cref="T:log4net.Core.Level"/> collection to the current <c>LevelCollection</c>. + </summary> + <param name="col">The <see cref="T:log4net.Core.Level"/> collection whose elements should be added to the end of the <c>LevelCollection</c>.</param> + <returns>The new <see cref="P:log4net.Core.LevelCollection.Count"/> of the <c>LevelCollection</c>.</returns> + </member> + <member name="M:log4net.Core.LevelCollection.TrimToSize"> + <summary> + Sets the capacity to the actual number of elements. + </summary> + </member> + <member name="M:log4net.Core.LevelCollection.ValidateIndex(System.Int32)"> + <exception cref="T:System.ArgumentOutOfRangeException"> + <para><paramref name="i"/> is less than zero</para> + <para>-or-</para> + <para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Core.LevelCollection.Count"/>.</para> + </exception> + </member> + <member name="M:log4net.Core.LevelCollection.ValidateIndex(System.Int32,System.Boolean)"> + <exception cref="T:System.ArgumentOutOfRangeException"> + <para><paramref name="i"/> is less than zero</para> + <para>-or-</para> + <para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Core.LevelCollection.Count"/>.</para> + </exception> + </member> + <member name="P:log4net.Core.LevelCollection.Count"> + <summary> + Gets the number of elements actually contained in the <c>LevelCollection</c>. + </summary> + </member> + <member name="P:log4net.Core.LevelCollection.IsSynchronized"> + <summary> + Gets a value indicating whether access to the collection is synchronized (thread-safe). + </summary> + <value>true if access to the ICollection is synchronized (thread-safe); otherwise, false.</value> + </member> + <member name="P:log4net.Core.LevelCollection.SyncRoot"> + <summary> + Gets an object that can be used to synchronize access to the collection. + </summary> + </member> + <member name="P:log4net.Core.LevelCollection.Item(System.Int32)"> + <summary> + Gets or sets the <see cref="T:log4net.Core.Level"/> at the specified index. + </summary> + <param name="index">The zero-based index of the element to get or set.</param> + <exception cref="T:System.ArgumentOutOfRangeException"> + <para><paramref name="index"/> is less than zero</para> + <para>-or-</para> + <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Core.LevelCollection.Count"/>.</para> + </exception> + </member> + <member name="P:log4net.Core.LevelCollection.IsFixedSize"> + <summary> + Gets a value indicating whether the collection has a fixed size. + </summary> + <value>true if the collection has a fixed size; otherwise, false. The default is false</value> + </member> + <member name="P:log4net.Core.LevelCollection.IsReadOnly"> + <summary> + Gets a value indicating whether the IList is read-only. + </summary> + <value>true if the collection is read-only; otherwise, false. The default is false</value> + </member> + <member name="P:log4net.Core.LevelCollection.Capacity"> + <summary> + Gets or sets the number of elements the <c>LevelCollection</c> can contain. + </summary> + </member> + <member name="T:log4net.Core.LevelCollection.ILevelCollectionEnumerator"> + <summary> + Supports type-safe iteration over a <see cref="T:log4net.Core.LevelCollection"/>. + </summary> + </member> + <member name="M:log4net.Core.LevelCollection.ILevelCollectionEnumerator.MoveNext"> + <summary> + Advances the enumerator to the next element in the collection. + </summary> + <returns> + <c>true</c> if the enumerator was successfully advanced to the next element; + <c>false</c> if the enumerator has passed the end of the collection. + </returns> + <exception cref="T:System.InvalidOperationException"> + The collection was modified after the enumerator was created. + </exception> + </member> + <member name="M:log4net.Core.LevelCollection.ILevelCollectionEnumerator.Reset"> + <summary> + Sets the enumerator to its initial position, before the first element in the collection. + </summary> + </member> + <member name="P:log4net.Core.LevelCollection.ILevelCollectionEnumerator.Current"> + <summary> + Gets the current element in the collection. + </summary> + </member> + <member name="T:log4net.Core.LevelCollection.Tag"> + <summary> + Type visible only to our subclasses + Used to access protected constructor + </summary> + </member> + <member name="F:log4net.Core.LevelCollection.Tag.Default"> + <summary> + A value + </summary> + </member> + <member name="T:log4net.Core.LevelCollection.Enumerator"> + <summary> + Supports simple iteration over a <see cref="T:log4net.Core.LevelCollection"/>. + </summary> + </member> + <member name="M:log4net.Core.LevelCollection.Enumerator.#ctor(log4net.Core.LevelCollection)"> + <summary> + Initializes a new instance of the <c>Enumerator</c> class. + </summary> + <param name="tc"></param> + </member> + <member name="M:log4net.Core.LevelCollection.Enumerator.MoveNext"> + <summary> + Advances the enumerator to the next element in the collection. + </summary> + <returns> + <c>true</c> if the enumerator was successfully advanced to the next element; + <c>false</c> if the enumerator has passed the end of the collection. + </returns> + <exception cref="T:System.InvalidOperationException"> + The collection was modified after the enumerator was created. + </exception> + </member> + <member name="M:log4net.Core.LevelCollection.Enumerator.Reset"> + <summary> + Sets the enumerator to its initial position, before the first element in the collection. + </summary> + </member> + <member name="P:log4net.Core.LevelCollection.Enumerator.Current"> + <summary> + Gets the current element in the collection. + </summary> + </member> + <member name="T:log4net.Core.LevelEvaluator"> + <summary> + An evaluator that triggers at a threshold level + </summary> + <remarks> + <para> + This evaluator will trigger if the level of the event + passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/> + is equal to or greater than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/> + level. + </para> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="F:log4net.Core.LevelEvaluator.m_threshold"> + <summary> + The threshold for triggering + </summary> + </member> + <member name="M:log4net.Core.LevelEvaluator.#ctor"> + <summary> + Create a new evaluator using the <see cref="F:log4net.Core.Level.Off"/> threshold. + </summary> + <remarks> + <para> + Create a new evaluator using the <see cref="F:log4net.Core.Level.Off"/> threshold. + </para> + <para> + This evaluator will trigger if the level of the event + passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/> + is equal to or greater than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/> + level. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LevelEvaluator.#ctor(log4net.Core.Level)"> + <summary> + Create a new evaluator using the specified <see cref="T:log4net.Core.Level"/> threshold. + </summary> + <param name="threshold">the threshold to trigger at</param> + <remarks> + <para> + Create a new evaluator using the specified <see cref="T:log4net.Core.Level"/> threshold. + </para> + <para> + This evaluator will trigger if the level of the event + passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/> + is equal to or greater than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/> + level. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LevelEvaluator.IsTriggeringEvent(log4net.Core.LoggingEvent)"> + <summary> + Is this <paramref name="loggingEvent"/> the triggering event? + </summary> + <param name="loggingEvent">The event to check</param> + <returns>This method returns <c>true</c>, if the event level + is equal or higher than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/>. + Otherwise it returns <c>false</c></returns> + <remarks> + <para> + This evaluator will trigger if the level of the event + passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/> + is equal to or greater than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/> + level. + </para> + </remarks> + </member> + <member name="P:log4net.Core.LevelEvaluator.Threshold"> + <summary> + the threshold to trigger at + </summary> + <value> + The <see cref="T:log4net.Core.Level"/> that will cause this evaluator to trigger + </value> + <remarks> + <para> + This evaluator will trigger if the level of the event + passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/> + is equal to or greater than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/> + level. + </para> + </remarks> + </member> + <member name="T:log4net.Core.LevelMap"> + <summary> + Mapping between string name and Level object + </summary> + <remarks> + <para> + Mapping between string name and <see cref="T:log4net.Core.Level"/> object. + This mapping is held separately for each <see cref="T:log4net.Repository.ILoggerRepository"/>. + The level name is case insensitive. + </para> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="F:log4net.Core.LevelMap.m_mapName2Level"> + <summary> + Mapping from level name to Level object. The + level name is case insensitive + </summary> + </member> + <member name="M:log4net.Core.LevelMap.#ctor"> + <summary> + Construct the level map + </summary> + <remarks> + <para> + Construct the level map. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LevelMap.Clear"> + <summary> + Clear the internal maps of all levels + </summary> + <remarks> + <para> + Clear the internal maps of all levels + </para> + </remarks> + </member> + <member name="M:log4net.Core.LevelMap.Add(System.String,System.Int32)"> + <summary> + Create a new Level and add it to the map + </summary> + <param name="name">the string to display for the Level</param> + <param name="value">the level value to give to the Level</param> + <remarks> + <para> + Create a new Level and add it to the map + </para> + </remarks> + <seealso cref="M:Add(string,int,string)"/> + </member> + <member name="M:log4net.Core.LevelMap.Add(System.String,System.Int32,System.String)"> + <summary> + Create a new Level and add it to the map + </summary> + <param name="name">the string to display for the Level</param> + <param name="value">the level value to give to the Level</param> + <param name="displayName">the display name to give to the Level</param> + <remarks> + <para> + Create a new Level and add it to the map + </para> + </remarks> + </member> + <member name="M:log4net.Core.LevelMap.Add(log4net.Core.Level)"> + <summary> + Add a Level to the map + </summary> + <param name="level">the Level to add</param> + <remarks> + <para> + Add a Level to the map + </para> + </remarks> + </member> + <member name="M:log4net.Core.LevelMap.LookupWithDefault(log4net.Core.Level)"> + <summary> + Lookup a named level from the map + </summary> + <param name="defaultLevel">the name of the level to lookup is taken from this level. + If the level is not set on the map then this level is added</param> + <returns>the level in the map with the name specified</returns> + <remarks> + <para> + Lookup a named level from the map. The name of the level to lookup is taken + from the <see cref="P:log4net.Core.Level.Name"/> property of the <paramref name="defaultLevel"/> + argument. + </para> + <para> + If no level with the specified name is found then the + <paramref name="defaultLevel"/> argument is added to the level map + and returned. + </para> + </remarks> + </member> + <member name="P:log4net.Core.LevelMap.Item(System.String)"> + <summary> + Lookup a <see cref="T:log4net.Core.Level"/> by name + </summary> + <param name="name">The name of the Level to lookup</param> + <returns>a Level from the map with the name specified</returns> + <remarks> + <para> + Returns the <see cref="T:log4net.Core.Level"/> from the + map with the name specified. If the no level is + found then <c>null</c> is returned. + </para> + </remarks> + </member> + <member name="P:log4net.Core.LevelMap.AllLevels"> + <summary> + Return all possible levels as a list of Level objects. + </summary> + <returns>all possible levels as a list of Level objects</returns> + <remarks> + <para> + Return all possible levels as a list of Level objects. + </para> + </remarks> + </member> + <member name="T:log4net.Core.LocationInfo"> + <summary> + The internal representation of caller location information. + </summary> + <remarks> + <para> + This class uses the <c>System.Diagnostics.StackTrace</c> class to generate + a call stack. The caller's information is then extracted from this stack. + </para> + <para> + The <c>System.Diagnostics.StackTrace</c> class is not supported on the + .NET Compact Framework 1.0 therefore caller location information is not + available on that framework. + </para> + <para> + The <c>System.Diagnostics.StackTrace</c> class has this to say about Release builds: + </para> + <para> + "StackTrace information will be most informative with Debug build configurations. + By default, Debug builds include debug symbols, while Release builds do not. The + debug symbols contain most of the file, method name, line number, and column + information used in constructing StackFrame and StackTrace objects. StackTrace + might not report as many method calls as expected, due to code transformations + that occur during optimization." + </para> + <para> + This means that in a Release build the caller information may be incomplete or may + not exist at all! Therefore caller location information cannot be relied upon in a Release build. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="F:log4net.Core.LocationInfo.NA"> + <summary> + When location information is not available the constant + <c>NA</c> is returned. Current value of this string + constant is <b>?</b>. + </summary> + </member> + <member name="M:log4net.Core.LocationInfo.#ctor(System.Type)"> + <summary> + Constructor + </summary> + <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is + the stack boundary into the logging system for this call.</param> + <remarks> + <para> + Initializes a new instance of the <see cref="T:log4net.Core.LocationInfo"/> + class based on the current thread. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LocationInfo.#ctor(System.String,System.String,System.String,System.String)"> + <summary> + Constructor + </summary> + <param name="className">The fully qualified class name.</param> + <param name="methodName">The method name.</param> + <param name="fileName">The file name.</param> + <param name="lineNumber">The line number of the method within the file.</param> + <remarks> + <para> + Initializes a new instance of the <see cref="T:log4net.Core.LocationInfo"/> + class with the specified data. + </para> + </remarks> + </member> + <member name="F:log4net.Core.LocationInfo.declaringType"> + <summary> + The fully qualified type of the LocationInfo class. + </summary> + <remarks> + Used by the internal logger to record the Type of the + log message. + </remarks> + </member> + <member name="P:log4net.Core.LocationInfo.ClassName"> + <summary> + Gets the fully qualified class name of the caller making the logging + request. + </summary> + <value> + The fully qualified class name of the caller making the logging + request. + </value> + <remarks> + <para> + Gets the fully qualified class name of the caller making the logging + request. + </para> + </remarks> + </member> + <member name="P:log4net.Core.LocationInfo.FileName"> + <summary> + Gets the file name of the caller. + </summary> + <value> + The file name of the caller. + </value> + <remarks> + <para> + Gets the file name of the caller. + </para> + </remarks> + </member> + <member name="P:log4net.Core.LocationInfo.LineNumber"> + <summary> + Gets the line number of the caller. + </summary> + <value> + The line number of the caller. + </value> + <remarks> + <para> + Gets the line number of the caller. + </para> + </remarks> + </member> + <member name="P:log4net.Core.LocationInfo.MethodName"> + <summary> + Gets the method name of the caller. + </summary> + <value> + The method name of the caller. + </value> + <remarks> + <para> + Gets the method name of the caller. + </para> + </remarks> + </member> + <member name="P:log4net.Core.LocationInfo.FullInfo"> + <summary> + Gets all available caller information + </summary> + <value> + All available caller information, in the format + <c>fully.qualified.classname.of.caller.methodName(Filename:line)</c> + </value> + <remarks> + <para> + Gets all available caller information, in the format + <c>fully.qualified.classname.of.caller.methodName(Filename:line)</c> + </para> + </remarks> + </member> + <member name="P:log4net.Core.LocationInfo.StackFrames"> + <summary> + Gets the stack frames from the stack trace of the caller making the log request + </summary> + </member> + <member name="T:log4net.Core.LoggerManager"> + <summary> + Static manager that controls the creation of repositories + </summary> + <remarks> + <para> + Static manager that controls the creation of repositories + </para> + <para> + This class is used by the wrapper managers (e.g. <see cref="T:log4net.LogManager"/>) + to provide access to the <see cref="T:log4net.Core.ILogger"/> objects. + </para> + <para> + This manager also holds the <see cref="T:log4net.Core.IRepositorySelector"/> that is used to + lookup and create repositories. The selector can be set either programmatically using + the <see cref="P:log4net.Core.LoggerManager.RepositorySelector"/> property, or by setting the <c>log4net.RepositorySelector</c> + AppSetting in the applications config file to the fully qualified type name of the + selector to use. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Core.LoggerManager.#ctor"> + <summary> + Private constructor to prevent instances. Only static methods should be used. + </summary> + <remarks> + <para> + Private constructor to prevent instances. Only static methods should be used. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LoggerManager.#cctor"> + <summary> + Hook the shutdown event + </summary> + <remarks> + <para> + On the full .NET runtime, the static constructor hooks up the + <c>AppDomain.ProcessExit</c> and <c>AppDomain.DomainUnload</c>> events. + These are used to shutdown the log4net system as the application exits. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LoggerManager.RegisterAppDomainEvents"> + <summary> + Register for ProcessExit and DomainUnload events on the AppDomain + </summary> + <remarks> + <para> + This needs to be in a separate method because the events make + a LinkDemand for the ControlAppDomain SecurityPermission. Because + this is a LinkDemand it is demanded at JIT time. Therefore we cannot + catch the exception in the method itself, we have to catch it in the + caller. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LoggerManager.GetLoggerRepository(System.String)"> + <summary> + Return the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance. + </summary> + <param name="repository">the repository to lookup in</param> + <returns>Return the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance</returns> + <remarks> + <para> + Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified + by the <paramref name="repository"/> argument. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LoggerManager.GetLoggerRepository(System.Reflection.Assembly)"> + <summary> + Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance. + </summary> + <param name="repositoryAssembly">The assembly to use to lookup the repository.</param> + <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns> + </member> + <member name="M:log4net.Core.LoggerManager.GetRepository(System.String)"> + <summary> + Return the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance. + </summary> + <param name="repository">the repository to lookup in</param> + <returns>Return the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance</returns> + <remarks> + <para> + Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified + by the <paramref name="repository"/> argument. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LoggerManager.GetRepository(System.Reflection.Assembly)"> + <summary> + Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance. + </summary> + <param name="repositoryAssembly">The assembly to use to lookup the repository.</param> + <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns> + <remarks> + <para> + Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LoggerManager.Exists(System.String,System.String)"> + <summary> + Returns the named logger if it exists. + </summary> + <param name="repository">The repository to lookup in.</param> + <param name="name">The fully qualified logger name to look for.</param> + <returns> + The logger found, or <c>null</c> if the named logger does not exist in the + specified repository. + </returns> + <remarks> + <para> + If the named logger exists (in the specified repository) then it + returns a reference to the logger, otherwise it returns + <c>null</c>. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LoggerManager.Exists(System.Reflection.Assembly,System.String)"> + <summary> + Returns the named logger if it exists. + </summary> + <param name="repositoryAssembly">The assembly to use to lookup the repository.</param> + <param name="name">The fully qualified logger name to look for.</param> + <returns> + The logger found, or <c>null</c> if the named logger does not exist in the + specified assembly's repository. + </returns> + <remarks> + <para> + If the named logger exists (in the specified assembly's repository) then it + returns a reference to the logger, otherwise it returns + <c>null</c>. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LoggerManager.GetCurrentLoggers(System.String)"> + <summary> + Returns all the currently defined loggers in the specified repository. + </summary> + <param name="repository">The repository to lookup in.</param> + <returns>All the defined loggers.</returns> + <remarks> + <para> + The root logger is <b>not</b> included in the returned array. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LoggerManager.GetCurrentLoggers(System.Reflection.Assembly)"> + <summary> + Returns all the currently defined loggers in the specified assembly's repository. + </summary> + <param name="repositoryAssembly">The assembly to use to lookup the repository.</param> + <returns>All the defined loggers.</returns> + <remarks> + <para> + The root logger is <b>not</b> included in the returned array. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LoggerManager.GetLogger(System.String,System.String)"> + <summary> + Retrieves or creates a named logger. + </summary> + <param name="repository">The repository to lookup in.</param> + <param name="name">The name of the logger to retrieve.</param> + <returns>The logger with the name specified.</returns> + <remarks> + <para> + Retrieves a logger named as the <paramref name="name"/> + parameter. If the named logger already exists, then the + existing instance will be returned. Otherwise, a new instance is + created. + </para> + <para> + By default, loggers do not have a set level but inherit + it from the hierarchy. This is one of the central features of + log4net. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LoggerManager.GetLogger(System.Reflection.Assembly,System.String)"> + <summary> + Retrieves or creates a named logger. + </summary> + <param name="repositoryAssembly">The assembly to use to lookup the repository.</param> + <param name="name">The name of the logger to retrieve.</param> + <returns>The logger with the name specified.</returns> + <remarks> + <para> + Retrieves a logger named as the <paramref name="name"/> + parameter. If the named logger already exists, then the + existing instance will be returned. Otherwise, a new instance is + created. + </para> + <para> + By default, loggers do not have a set level but inherit + it from the hierarchy. This is one of the central features of + log4net. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LoggerManager.GetLogger(System.String,System.Type)"> + <summary> + Shorthand for <see cref="M:LogManager.GetLogger(string)"/>. + </summary> + <param name="repository">The repository to lookup in.</param> + <param name="type">The <paramref name="type"/> of which the fullname will be used as the name of the logger to retrieve.</param> + <returns>The logger with the name specified.</returns> + <remarks> + <para> + Gets the logger for the fully qualified name of the type specified. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LoggerManager.GetLogger(System.Reflection.Assembly,System.Type)"> + <summary> + Shorthand for <see cref="M:LogManager.GetLogger(string)"/>. + </summary> + <param name="repositoryAssembly">the assembly to use to lookup the repository</param> + <param name="type">The <paramref name="type"/> of which the fullname will be used as the name of the logger to retrieve.</param> + <returns>The logger with the name specified.</returns> + <remarks> + <para> + Gets the logger for the fully qualified name of the type specified. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LoggerManager.Shutdown"> + <summary> + Shuts down the log4net system. + </summary> + <remarks> + <para> + Calling this method will <b>safely</b> close and remove all + appenders in all the loggers including root contained in all the + default repositories. + </para> + <para> + Some appenders need to be closed before the application exists. + Otherwise, pending logging events might be lost. + </para> + <para> + The <c>shutdown</c> method is careful to close nested + appenders before closing regular appenders. This is allows + configurations where a regular appender is attached to a logger + and again to a nested appender. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LoggerManager.ShutdownRepository(System.String)"> + <summary> + Shuts down the repository for the repository specified. + </summary> + <param name="repository">The repository to shutdown.</param> + <remarks> + <para> + Calling this method will <b>safely</b> close and remove all + appenders in all the loggers including root contained in the + repository for the <paramref name="repository"/> specified. + </para> + <para> + Some appenders need to be closed before the application exists. + Otherwise, pending logging events might be lost. + </para> + <para> + The <c>shutdown</c> method is careful to close nested + appenders before closing regular appenders. This is allows + configurations where a regular appender is attached to a logger + and again to a nested appender. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LoggerManager.ShutdownRepository(System.Reflection.Assembly)"> + <summary> + Shuts down the repository for the repository specified. + </summary> + <param name="repositoryAssembly">The assembly to use to lookup the repository.</param> + <remarks> + <para> + Calling this method will <b>safely</b> close and remove all + appenders in all the loggers including root contained in the + repository for the repository. The repository is looked up using + the <paramref name="repositoryAssembly"/> specified. + </para> + <para> + Some appenders need to be closed before the application exists. + Otherwise, pending logging events might be lost. + </para> + <para> + The <c>shutdown</c> method is careful to close nested + appenders before closing regular appenders. This is allows + configurations where a regular appender is attached to a logger + and again to a nested appender. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LoggerManager.ResetConfiguration(System.String)"> + <summary> + Resets all values contained in this repository instance to their defaults. + </summary> + <param name="repository">The repository to reset.</param> + <remarks> + <para> + Resets all values contained in the repository instance to their + defaults. This removes all appenders from all loggers, sets + the level of all non-root loggers to <c>null</c>, + sets their additivity flag to <c>true</c> and sets the level + of the root logger to <see cref="F:log4net.Core.Level.Debug"/>. Moreover, + message disabling is set its default "off" value. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LoggerManager.ResetConfiguration(System.Reflection.Assembly)"> + <summary> + Resets all values contained in this repository instance to their defaults. + </summary> + <param name="repositoryAssembly">The assembly to use to lookup the repository to reset.</param> + <remarks> + <para> + Resets all values contained in the repository instance to their + defaults. This removes all appenders from all loggers, sets + the level of all non-root loggers to <c>null</c>, + sets their additivity flag to <c>true</c> and sets the level + of the root logger to <see cref="F:log4net.Core.Level.Debug"/>. Moreover, + message disabling is set its default "off" value. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LoggerManager.CreateDomain(System.String)"> + <summary> + Creates a repository with the specified name. + </summary> + <param name="repository">The name of the repository, this must be unique amongst repositories.</param> + <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns> + <remarks> + <para> + <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b> + </para> + <para> + Creates the default type of <see cref="T:log4net.Repository.ILoggerRepository"/> which is a + <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> object. + </para> + <para> + The <paramref name="repository"/> name must be unique. Repositories cannot be redefined. + An <see cref="T:System.Exception"/> will be thrown if the repository already exists. + </para> + </remarks> + <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception> + </member> + <member name="M:log4net.Core.LoggerManager.CreateRepository(System.String)"> + <summary> + Creates a repository with the specified name. + </summary> + <param name="repository">The name of the repository, this must be unique amongst repositories.</param> + <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns> + <remarks> + <para> + Creates the default type of <see cref="T:log4net.Repository.ILoggerRepository"/> which is a + <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> object. + </para> + <para> + The <paramref name="repository"/> name must be unique. Repositories cannot be redefined. + An <see cref="T:System.Exception"/> will be thrown if the repository already exists. + </para> + </remarks> + <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception> + </member> + <member name="M:log4net.Core.LoggerManager.CreateDomain(System.String,System.Type)"> + <summary> + Creates a repository with the specified name and repository type. + </summary> + <param name="repository">The name of the repository, this must be unique to the repository.</param> + <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/> + and has a no arg constructor. An instance of this type will be created to act + as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param> + <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns> + <remarks> + <para> + <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b> + </para> + <para> + The <paramref name="repository"/> name must be unique. Repositories cannot be redefined. + An Exception will be thrown if the repository already exists. + </para> + </remarks> + <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception> + </member> + <member name="M:log4net.Core.LoggerManager.CreateRepository(System.String,System.Type)"> + <summary> + Creates a repository with the specified name and repository type. + </summary> + <param name="repository">The name of the repository, this must be unique to the repository.</param> + <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/> + and has a no arg constructor. An instance of this type will be created to act + as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param> + <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns> + <remarks> + <para> + The <paramref name="repository"/> name must be unique. Repositories cannot be redefined. + An Exception will be thrown if the repository already exists. + </para> + </remarks> + <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception> + </member> + <member name="M:log4net.Core.LoggerManager.CreateDomain(System.Reflection.Assembly,System.Type)"> + <summary> + Creates a repository for the specified assembly and repository type. + </summary> + <param name="repositoryAssembly">The assembly to use to get the name of the repository.</param> + <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/> + and has a no arg constructor. An instance of this type will be created to act + as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param> + <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns> + <remarks> + <para> + <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b> + </para> + <para> + The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository + specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the + same assembly specified will return the same repository instance. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LoggerManager.CreateRepository(System.Reflection.Assembly,System.Type)"> + <summary> + Creates a repository for the specified assembly and repository type. + </summary> + <param name="repositoryAssembly">The assembly to use to get the name of the repository.</param> + <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/> + and has a no arg constructor. An instance of this type will be created to act + as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param> + <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns> + <remarks> + <para> + The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository + specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the + same assembly specified will return the same repository instance. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LoggerManager.GetAllRepositories"> + <summary> + Gets an array of all currently defined repositories. + </summary> + <returns>An array of all the known <see cref="T:log4net.Repository.ILoggerRepository"/> objects.</returns> + <remarks> + <para> + Gets an array of all currently defined repositories. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LoggerManager.GetVersionInfo"> + <summary> + Internal method to get pertinent version info. + </summary> + <returns>A string of version info.</returns> + </member> + <member name="M:log4net.Core.LoggerManager.OnDomainUnload(System.Object,System.EventArgs)"> + <summary> + Called when the <see cref="E:System.AppDomain.DomainUnload"/> event fires + </summary> + <param name="sender">the <see cref="T:System.AppDomain"/> that is exiting</param> + <param name="e">null</param> + <remarks> + <para> + Called when the <see cref="E:System.AppDomain.DomainUnload"/> event fires. + </para> + <para> + When the event is triggered the log4net system is <see cref="M:Shutdown()"/>. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LoggerManager.OnProcessExit(System.Object,System.EventArgs)"> + <summary> + Called when the <see cref="E:System.AppDomain.ProcessExit"/> event fires + </summary> + <param name="sender">the <see cref="T:System.AppDomain"/> that is exiting</param> + <param name="e">null</param> + <remarks> + <para> + Called when the <see cref="E:System.AppDomain.ProcessExit"/> event fires. + </para> + <para> + When the event is triggered the log4net system is <see cref="M:Shutdown()"/>. + </para> + </remarks> + </member> + <member name="F:log4net.Core.LoggerManager.declaringType"> + <summary> + The fully qualified type of the LoggerManager class. + </summary> + <remarks> + Used by the internal logger to record the Type of the + log message. + </remarks> + </member> + <member name="F:log4net.Core.LoggerManager.s_repositorySelector"> + <summary> + Initialize the default repository selector + </summary> + </member> + <member name="P:log4net.Core.LoggerManager.RepositorySelector"> + <summary> + Gets or sets the repository selector used by the <see cref="T:log4net.LogManager"/>. + </summary> + <value> + The repository selector used by the <see cref="T:log4net.LogManager"/>. + </value> + <remarks> + <para> + The repository selector (<see cref="T:log4net.Core.IRepositorySelector"/>) is used by + the <see cref="T:log4net.LogManager"/> to create and select repositories + (<see cref="T:log4net.Repository.ILoggerRepository"/>). + </para> + <para> + The caller to <see cref="T:log4net.LogManager"/> supplies either a string name + or an assembly (if not supplied the assembly is inferred using + <see cref="M:Assembly.GetCallingAssembly()"/>). + </para> + <para> + This context is used by the selector to lookup a specific repository. + </para> + <para> + For the full .NET Framework, the default repository is <c>DefaultRepositorySelector</c>; + for the .NET Compact Framework <c>CompactRepositorySelector</c> is the default + repository. + </para> + </remarks> + </member> + <member name="T:log4net.Core.LoggerWrapperImpl"> + <summary> + Implementation of the <see cref="T:log4net.Core.ILoggerWrapper"/> interface. + </summary> + <remarks> + <para> + This class should be used as the base for all wrapper implementations. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Core.LoggerWrapperImpl.#ctor(log4net.Core.ILogger)"> + <summary> + Constructs a new wrapper for the specified logger. + </summary> + <param name="logger">The logger to wrap.</param> + <remarks> + <para> + Constructs a new wrapper for the specified logger. + </para> + </remarks> + </member> + <member name="F:log4net.Core.LoggerWrapperImpl.m_logger"> + <summary> + The logger that this object is wrapping + </summary> + </member> + <member name="P:log4net.Core.LoggerWrapperImpl.Logger"> + <summary> + Gets the implementation behind this wrapper object. + </summary> + <value> + The <see cref="T:log4net.Core.ILogger"/> object that this object is implementing. + </value> + <remarks> + <para> + The <c>Logger</c> object may not be the same object as this object + because of logger decorators. + </para> + <para> + This gets the actual underlying objects that is used to process + the log events. + </para> + </remarks> + </member> + <member name="T:log4net.Core.LoggingEventData"> + <summary> + Portable data structure used by <see cref="T:log4net.Core.LoggingEvent"/> + </summary> + <remarks> + <para> + Portable data structure used by <see cref="T:log4net.Core.LoggingEvent"/> + </para> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="F:log4net.Core.LoggingEventData.LoggerName"> + <summary> + The logger name. + </summary> + <remarks> + <para> + The logger name. + </para> + </remarks> + </member> + <member name="F:log4net.Core.LoggingEventData.Level"> + <summary> + Level of logging event. + </summary> + <remarks> + <para> + Level of logging event. Level cannot be Serializable + because it is a flyweight. Due to its special serialization it + cannot be declared final either. + </para> + </remarks> + </member> + <member name="F:log4net.Core.LoggingEventData.Message"> + <summary> + The application supplied message. + </summary> + <remarks> + <para> + The application supplied message of logging event. + </para> + </remarks> + </member> + <member name="F:log4net.Core.LoggingEventData.ThreadName"> + <summary> + The name of thread + </summary> + <remarks> + <para> + The name of thread in which this logging event was generated + </para> + </remarks> + </member> + <member name="F:log4net.Core.LoggingEventData.TimeStamp"> + <summary> + The time the event was logged + </summary> + <remarks> + <para> + The TimeStamp is stored in the local time zone for this computer. + </para> + </remarks> + </member> + <member name="F:log4net.Core.LoggingEventData.LocationInfo"> + <summary> + Location information for the caller. + </summary> + <remarks> + <para> + Location information for the caller. + </para> + </remarks> + </member> + <member name="F:log4net.Core.LoggingEventData.UserName"> + <summary> + String representation of the user + </summary> + <remarks> + <para> + String representation of the user's windows name, + like DOMAIN\username + </para> + </remarks> + </member> + <member name="F:log4net.Core.LoggingEventData.Identity"> + <summary> + String representation of the identity. + </summary> + <remarks> + <para> + String representation of the current thread's principal identity. + </para> + </remarks> + </member> + <member name="F:log4net.Core.LoggingEventData.ExceptionString"> + <summary> + The string representation of the exception + </summary> + <remarks> + <para> + The string representation of the exception + </para> + </remarks> + </member> + <member name="F:log4net.Core.LoggingEventData.Domain"> + <summary> + String representation of the AppDomain. + </summary> + <remarks> + <para> + String representation of the AppDomain. + </para> + </remarks> + </member> + <member name="F:log4net.Core.LoggingEventData.Properties"> + <summary> + Additional event specific properties + </summary> + <remarks> + <para> + A logger or an appender may attach additional + properties to specific events. These properties + have a string key and an object value. + </para> + </remarks> + </member> + <member name="T:log4net.Core.FixFlags"> + <summary> + Flags passed to the <see cref="P:log4net.Core.LoggingEvent.Fix"/> property + </summary> + <remarks> + <para> + Flags passed to the <see cref="P:log4net.Core.LoggingEvent.Fix"/> property + </para> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="F:log4net.Core.FixFlags.Mdc"> + <summary> + Fix the MDC + </summary> + </member> + <member name="F:log4net.Core.FixFlags.Ndc"> + <summary> + Fix the NDC + </summary> + </member> + <member name="F:log4net.Core.FixFlags.Message"> + <summary> + Fix the rendered message + </summary> + </member> + <member name="F:log4net.Core.FixFlags.ThreadName"> + <summary> + Fix the thread name + </summary> + </member> + <member name="F:log4net.Core.FixFlags.LocationInfo"> + <summary> + Fix the callers location information + </summary> + <remarks> + CAUTION: Very slow to generate + </remarks> + </member> + <member name="F:log4net.Core.FixFlags.UserName"> + <summary> + Fix the callers windows user name + </summary> + <remarks> + CAUTION: Slow to generate + </remarks> + </member> + <member name="F:log4net.Core.FixFlags.Domain"> + <summary> + Fix the domain friendly name + </summary> + </member> + <member name="F:log4net.Core.FixFlags.Identity"> + <summary> + Fix the callers principal name + </summary> + <remarks> + CAUTION: May be slow to generate + </remarks> + </member> + <member name="F:log4net.Core.FixFlags.Exception"> + <summary> + Fix the exception text + </summary> + </member> + <member name="F:log4net.Core.FixFlags.Properties"> + <summary> + Fix the event properties. Active properties must implement <see cref="T:log4net.Core.IFixingRequired"/> in order to be eligible for fixing. + </summary> + </member> + <member name="F:log4net.Core.FixFlags.None"> + <summary> + No fields fixed + </summary> + </member> + <member name="F:log4net.Core.FixFlags.All"> + <summary> + All fields fixed + </summary> + </member> + <member name="F:log4net.Core.FixFlags.Partial"> + <summary> + Partial fields fixed + </summary> + <remarks> + <para> + This set of partial fields gives good performance. The following fields are fixed: + </para> + <list type="bullet"> + <item><description><see cref="F:log4net.Core.FixFlags.Message"/></description></item> + <item><description><see cref="F:log4net.Core.FixFlags.ThreadName"/></description></item> + <item><description><see cref="F:log4net.Core.FixFlags.Exception"/></description></item> + <item><description><see cref="F:log4net.Core.FixFlags.Domain"/></description></item> + <item><description><see cref="F:log4net.Core.FixFlags.Properties"/></description></item> + </list> + </remarks> + </member> + <member name="T:log4net.Core.LoggingEvent"> + <summary> + The internal representation of logging events. + </summary> + <remarks> + <para> + When an affirmative decision is made to log then a + <see cref="T:log4net.Core.LoggingEvent"/> instance is created. This instance + is passed around to the different log4net components. + </para> + <para> + This class is of concern to those wishing to extend log4net. + </para> + <para> + Some of the values in instances of <see cref="T:log4net.Core.LoggingEvent"/> + are considered volatile, that is the values are correct at the + time the event is delivered to appenders, but will not be consistent + at any time afterwards. If an event is to be stored and then processed + at a later time these volatile values must be fixed by calling + <see cref="M:FixVolatileData()"/>. There is a performance penalty + for incurred by calling <see cref="M:FixVolatileData()"/> but it + is essential to maintaining data consistency. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + <author>Douglas de la Torre</author> + <author>Daniel Cazzulino</author> + </member> + <member name="F:log4net.Core.LoggingEvent.HostNameProperty"> + <summary> + The key into the Properties map for the host name value. + </summary> + </member> + <member name="F:log4net.Core.LoggingEvent.IdentityProperty"> + <summary> + The key into the Properties map for the thread identity value. + </summary> + </member> + <member name="F:log4net.Core.LoggingEvent.UserNameProperty"> + <summary> + The key into the Properties map for the user name value. + </summary> + </member> + <member name="M:log4net.Core.LoggingEvent.#ctor(System.Type,log4net.Repository.ILoggerRepository,System.String,log4net.Core.Level,System.Object,System.Exception)"> + <summary> + Initializes a new instance of the <see cref="T:log4net.Core.LoggingEvent"/> class + from the supplied parameters. + </summary> + <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is + the stack boundary into the logging system for this call.</param> + <param name="repository">The repository this event is logged in.</param> + <param name="loggerName">The name of the logger of this event.</param> + <param name="level">The level of this event.</param> + <param name="message">The message of this event.</param> + <param name="exception">The exception for this event.</param> + <remarks> + <para> + Except <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/>, <see cref="P:log4net.Core.LoggingEvent.Level"/> and <see cref="P:log4net.Core.LoggingEvent.LoggerName"/>, + all fields of <c>LoggingEvent</c> are filled when actually needed. Call + <see cref="M:FixVolatileData()"/> to cache all data locally + to prevent inconsistencies. + </para> + <para>This method is called by the log4net framework + to create a logging event. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LoggingEvent.#ctor(System.Type,log4net.Repository.ILoggerRepository,log4net.Core.LoggingEventData,log4net.Core.FixFlags)"> + <summary> + Initializes a new instance of the <see cref="T:log4net.Core.LoggingEvent"/> class + using specific data. + </summary> + <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is + the stack boundary into the logging system for this call.</param> + <param name="repository">The repository this event is logged in.</param> + <param name="data">Data used to initialize the logging event.</param> + <param name="fixedData">The fields in the <paranref name="data"/> struct that have already been fixed.</param> + <remarks> + <para> + This constructor is provided to allow a <see cref="T:log4net.Core.LoggingEvent"/> + to be created independently of the log4net framework. This can + be useful if you require a custom serialization scheme. + </para> + <para> + Use the <see cref="M:GetLoggingEventData(FixFlags)"/> method to obtain an + instance of the <see cref="T:log4net.Core.LoggingEventData"/> class. + </para> + <para> + The <paramref name="fixedData"/> parameter should be used to specify which fields in the + <paramref name="data"/> struct have been preset. Fields not specified in the <paramref name="fixedData"/> + will be captured from the environment if requested or fixed. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LoggingEvent.#ctor(System.Type,log4net.Repository.ILoggerRepository,log4net.Core.LoggingEventData)"> + <summary> + Initializes a new instance of the <see cref="T:log4net.Core.LoggingEvent"/> class + using specific data. + </summary> + <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is + the stack boundary into the logging system for this call.</param> + <param name="repository">The repository this event is logged in.</param> + <param name="data">Data used to initialize the logging event.</param> + <remarks> + <para> + This constructor is provided to allow a <see cref="T:log4net.Core.LoggingEvent"/> + to be created independently of the log4net framework. This can + be useful if you require a custom serialization scheme. + </para> + <para> + Use the <see cref="M:GetLoggingEventData(FixFlags)"/> method to obtain an + instance of the <see cref="T:log4net.Core.LoggingEventData"/> class. + </para> + <para> + This constructor sets this objects <see cref="P:log4net.Core.LoggingEvent.Fix"/> flags to <see cref="F:log4net.Core.FixFlags.All"/>, + this assumes that all the data relating to this event is passed in via the <paramref name="data"/> + parameter and no other data should be captured from the environment. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LoggingEvent.#ctor(log4net.Core.LoggingEventData)"> + <summary> + Initializes a new instance of the <see cref="T:log4net.Core.LoggingEvent"/> class + using specific data. + </summary> + <param name="data">Data used to initialize the logging event.</param> + <remarks> + <para> + This constructor is provided to allow a <see cref="T:log4net.Core.LoggingEvent"/> + to be created independently of the log4net framework. This can + be useful if you require a custom serialization scheme. + </para> + <para> + Use the <see cref="M:GetLoggingEventData(FixFlags)"/> method to obtain an + instance of the <see cref="T:log4net.Core.LoggingEventData"/> class. + </para> + <para> + This constructor sets this objects <see cref="P:log4net.Core.LoggingEvent.Fix"/> flags to <see cref="F:log4net.Core.FixFlags.All"/>, + this assumes that all the data relating to this event is passed in via the <paramref name="data"/> + parameter and no other data should be captured from the environment. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LoggingEvent.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> + <summary> + Serialization constructor + </summary> + <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.</param> + <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param> + <remarks> + <para> + Initializes a new instance of the <see cref="T:log4net.Core.LoggingEvent"/> class + with serialized data. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LoggingEvent.EnsureRepository(log4net.Repository.ILoggerRepository)"> + <summary> + Ensure that the repository is set. + </summary> + <param name="repository">the value for the repository</param> + </member> + <member name="M:log4net.Core.LoggingEvent.WriteRenderedMessage(System.IO.TextWriter)"> + <summary> + Write the rendered message to a TextWriter + </summary> + <param name="writer">the writer to write the message to</param> + <remarks> + <para> + Unlike the <see cref="P:log4net.Core.LoggingEvent.RenderedMessage"/> property this method + does store the message data in the internal cache. Therefore + if called only once this method should be faster than the + <see cref="P:log4net.Core.LoggingEvent.RenderedMessage"/> property, however if the message is + to be accessed multiple times then the property will be more efficient. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LoggingEvent.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> + <summary> + Serializes this object into the <see cref="T:System.Runtime.Serialization.SerializationInfo"/> provided. + </summary> + <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> to populate with data.</param> + <param name="context">The destination for this serialization.</param> + <remarks> + <para> + The data in this event must be fixed before it can be serialized. + </para> + <para> + The <see cref="M:FixVolatileData()"/> method must be called during the + <see cref="M:log4net.Appender.IAppender.DoAppend(log4net.Core.LoggingEvent)"/> method call if this event + is to be used outside that method. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LoggingEvent.GetLoggingEventData"> + <summary> + Gets the portable data for this <see cref="T:log4net.Core.LoggingEvent"/>. + </summary> + <returns>The <see cref="T:log4net.Core.LoggingEventData"/> for this event.</returns> + <remarks> + <para> + A new <see cref="T:log4net.Core.LoggingEvent"/> can be constructed using a + <see cref="T:log4net.Core.LoggingEventData"/> instance. + </para> + <para> + Does a <see cref="F:log4net.Core.FixFlags.Partial"/> fix of the data + in the logging event before returning the event data. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LoggingEvent.GetLoggingEventData(log4net.Core.FixFlags)"> + <summary> + Gets the portable data for this <see cref="T:log4net.Core.LoggingEvent"/>. + </summary> + <param name="fixFlags">The set of data to ensure is fixed in the LoggingEventData</param> + <returns>The <see cref="T:log4net.Core.LoggingEventData"/> for this event.</returns> + <remarks> + <para> + A new <see cref="T:log4net.Core.LoggingEvent"/> can be constructed using a + <see cref="T:log4net.Core.LoggingEventData"/> instance. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LoggingEvent.GetExceptionStrRep"> + <summary> + Returns this event's exception's rendered using the + <see cref="P:log4net.Repository.ILoggerRepository.RendererMap"/>. + </summary> + <returns> + This event's exception's rendered using the <see cref="P:log4net.Repository.ILoggerRepository.RendererMap"/>. + </returns> + <remarks> + <para> + <b>Obsolete. Use <see cref="M:log4net.Core.LoggingEvent.GetExceptionString"/> instead.</b> + </para> + </remarks> + </member> + <member name="M:log4net.Core.LoggingEvent.GetExceptionString"> + <summary> + Returns this event's exception's rendered using the + <see cref="P:log4net.Repository.ILoggerRepository.RendererMap"/>. + </summary> + <returns> + This event's exception's rendered using the <see cref="P:log4net.Repository.ILoggerRepository.RendererMap"/>. + </returns> + <remarks> + <para> + Returns this event's exception's rendered using the + <see cref="P:log4net.Repository.ILoggerRepository.RendererMap"/>. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LoggingEvent.FixVolatileData"> + <summary> + Fix instance fields that hold volatile data. + </summary> + <remarks> + <para> + Some of the values in instances of <see cref="T:log4net.Core.LoggingEvent"/> + are considered volatile, that is the values are correct at the + time the event is delivered to appenders, but will not be consistent + at any time afterwards. If an event is to be stored and then processed + at a later time these volatile values must be fixed by calling + <see cref="M:FixVolatileData()"/>. There is a performance penalty + incurred by calling <see cref="M:FixVolatileData()"/> but it + is essential to maintaining data consistency. + </para> + <para> + Calling <see cref="M:FixVolatileData()"/> is equivalent to + calling <see cref="M:FixVolatileData(bool)"/> passing the parameter + <c>false</c>. + </para> + <para> + See <see cref="M:FixVolatileData(bool)"/> for more + information. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LoggingEvent.FixVolatileData(System.Boolean)"> + <summary> + Fixes instance fields that hold volatile data. + </summary> + <param name="fastButLoose">Set to <c>true</c> to not fix data that takes a long time to fix.</param> + <remarks> + <para> + Some of the values in instances of <see cref="T:log4net.Core.LoggingEvent"/> + are considered volatile, that is the values are correct at the + time the event is delivered to appenders, but will not be consistent + at any time afterwards. If an event is to be stored and then processed + at a later time these volatile values must be fixed by calling + <see cref="M:FixVolatileData()"/>. There is a performance penalty + for incurred by calling <see cref="M:FixVolatileData()"/> but it + is essential to maintaining data consistency. + </para> + <para> + The <paramref name="fastButLoose"/> param controls the data that + is fixed. Some of the data that can be fixed takes a long time to + generate, therefore if you do not require those settings to be fixed + they can be ignored by setting the <paramref name="fastButLoose"/> param + to <c>true</c>. This setting will ignore the <see cref="P:log4net.Core.LoggingEvent.LocationInformation"/> + and <see cref="P:log4net.Core.LoggingEvent.UserName"/> settings. + </para> + <para> + Set <paramref name="fastButLoose"/> to <c>false</c> to ensure that all + settings are fixed. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LoggingEvent.FixVolatileData(log4net.Core.FixFlags)"> + <summary> + Fix the fields specified by the <see cref="T:log4net.Core.FixFlags"/> parameter + </summary> + <param name="flags">the fields to fix</param> + <remarks> + <para> + Only fields specified in the <paramref name="flags"/> will be fixed. + Fields will not be fixed if they have previously been fixed. + It is not possible to 'unfix' a field. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LoggingEvent.LookupProperty(System.String)"> + <summary> + Lookup a composite property in this event + </summary> + <param name="key">the key for the property to lookup</param> + <returns>the value for the property</returns> + <remarks> + <para> + This event has composite properties that combine together properties from + several different contexts in the following order: + <list type="definition"> + <item> + <term>this events properties</term> + <description> + This event has <see cref="P:log4net.Core.LoggingEvent.Properties"/> that can be set. These + properties are specific to this event only. + </description> + </item> + <item> + <term>the thread properties</term> + <description> + The <see cref="P:log4net.ThreadContext.Properties"/> that are set on the current + thread. These properties are shared by all events logged on this thread. + </description> + </item> + <item> + <term>the global properties</term> + <description> + The <see cref="P:log4net.GlobalContext.Properties"/> that are set globally. These + properties are shared by all the threads in the AppDomain. + </description> + </item> + </list> + </para> + </remarks> + </member> + <member name="M:log4net.Core.LoggingEvent.GetProperties"> + <summary> + Get all the composite properties in this event + </summary> + <returns>the <see cref="T:log4net.Util.PropertiesDictionary"/> containing all the properties</returns> + <remarks> + <para> + See <see cref="M:log4net.Core.LoggingEvent.LookupProperty(System.String)"/> for details of the composite properties + stored by the event. + </para> + <para> + This method returns a single <see cref="T:log4net.Util.PropertiesDictionary"/> containing all the + properties defined for this event. + </para> + </remarks> + </member> + <member name="F:log4net.Core.LoggingEvent.m_data"> + <summary> + The internal logging event data. + </summary> + </member> + <member name="F:log4net.Core.LoggingEvent.m_compositeProperties"> + <summary> + The internal logging event data. + </summary> + </member> + <member name="F:log4net.Core.LoggingEvent.m_eventProperties"> + <summary> + The internal logging event data. + </summary> + </member> + <member name="F:log4net.Core.LoggingEvent.m_callerStackBoundaryDeclaringType"> + <summary> + The fully qualified Type of the calling + logger class in the stack frame (i.e. the declaring type of the method). + </summary> + </member> + <member name="F:log4net.Core.LoggingEvent.m_message"> + <summary> + The application supplied message of logging event. + </summary> + </member> + <member name="F:log4net.Core.LoggingEvent.m_thrownException"> + <summary> + The exception that was thrown. + </summary> + <remarks> + This is not serialized. The string representation + is serialized instead. + </remarks> + </member> + <member name="F:log4net.Core.LoggingEvent.m_repository"> + <summary> + The repository that generated the logging event + </summary> + <remarks> + This is not serialized. + </remarks> + </member> + <member name="F:log4net.Core.LoggingEvent.m_fixFlags"> + <summary> + The fix state for this event + </summary> + <remarks> + These flags indicate which fields have been fixed. + Not serialized. + </remarks> + </member> + <member name="F:log4net.Core.LoggingEvent.m_cacheUpdatable"> + <summary> + Indicated that the internal cache is updateable (ie not fixed) + </summary> + <remarks> + This is a seperate flag to m_fixFlags as it allows incrementel fixing and simpler + changes in the caching strategy. + </remarks> + </member> + <member name="P:log4net.Core.LoggingEvent.StartTime"> + <summary> + Gets the time when the current process started. + </summary> + <value> + This is the time when this process started. + </value> + <remarks> + <para> + The TimeStamp is stored in the local time zone for this computer. + </para> + <para> + Tries to get the start time for the current process. + Failing that it returns the time of the first call to + this property. + </para> + <para> + Note that AppDomains may be loaded and unloaded within the + same process without the process terminating and therefore + without the process start time being reset. + </para> + </remarks> + </member> + <member name="P:log4net.Core.LoggingEvent.Level"> + <summary> + Gets the <see cref="P:log4net.Core.LoggingEvent.Level"/> of the logging event. + </summary> + <value> + The <see cref="P:log4net.Core.LoggingEvent.Level"/> of the logging event. + </value> + <remarks> + <para> + Gets the <see cref="P:log4net.Core.LoggingEvent.Level"/> of the logging event. + </para> + </remarks> + </member> + <member name="P:log4net.Core.LoggingEvent.TimeStamp"> + <summary> + Gets the time of the logging event. + </summary> + <value> + The time of the logging event. + </value> + <remarks> + <para> + The TimeStamp is stored in the local time zone for this computer. + </para> + </remarks> + </member> + <member name="P:log4net.Core.LoggingEvent.LoggerName"> + <summary> + Gets the name of the logger that logged the event. + </summary> + <value> + The name of the logger that logged the event. + </value> + <remarks> + <para> + Gets the name of the logger that logged the event. + </para> + </remarks> + </member> + <member name="P:log4net.Core.LoggingEvent.LocationInformation"> + <summary> + Gets the location information for this logging event. + </summary> + <value> + The location information for this logging event. + </value> + <remarks> + <para> + The collected information is cached for future use. + </para> + <para> + See the <see cref="T:log4net.Core.LocationInfo"/> class for more information on + supported frameworks and the different behavior in Debug and + Release builds. + </para> + </remarks> + </member> + <member name="P:log4net.Core.LoggingEvent.MessageObject"> + <summary> + Gets the message object used to initialize this event. + </summary> + <value> + The message object used to initialize this event. + </value> + <remarks> + <para> + Gets the message object used to initialize this event. + Note that this event may not have a valid message object. + If the event is serialized the message object will not + be transferred. To get the text of the message the + <see cref="P:log4net.Core.LoggingEvent.RenderedMessage"/> property must be used + not this property. + </para> + <para> + If there is no defined message object for this event then + null will be returned. + </para> + </remarks> + </member> + <member name="P:log4net.Core.LoggingEvent.ExceptionObject"> + <summary> + Gets the exception object used to initialize this event. + </summary> + <value> + The exception object used to initialize this event. + </value> + <remarks> + <para> + Gets the exception object used to initialize this event. + Note that this event may not have a valid exception object. + If the event is serialized the exception object will not + be transferred. To get the text of the exception the + <see cref="M:log4net.Core.LoggingEvent.GetExceptionString"/> method must be used + not this property. + </para> + <para> + If there is no defined exception object for this event then + null will be returned. + </para> + </remarks> + </member> + <member name="P:log4net.Core.LoggingEvent.Repository"> + <summary> + The <see cref="T:log4net.Repository.ILoggerRepository"/> that this event was created in. + </summary> + <remarks> + <para> + The <see cref="T:log4net.Repository.ILoggerRepository"/> that this event was created in. + </para> + </remarks> + </member> + <member name="P:log4net.Core.LoggingEvent.RenderedMessage"> + <summary> + Gets the message, rendered through the <see cref="P:log4net.Repository.ILoggerRepository.RendererMap"/>. + </summary> + <value> + The message rendered through the <see cref="P:log4net.Repository.ILoggerRepository.RendererMap"/>. + </value> + <remarks> + <para> + The collected information is cached for future use. + </para> + </remarks> + </member> + <member name="P:log4net.Core.LoggingEvent.ThreadName"> + <summary> + Gets the name of the current thread. + </summary> + <value> + The name of the current thread, or the thread ID when + the name is not available. + </value> + <remarks> + <para> + The collected information is cached for future use. + </para> + </remarks> + </member> + <member name="P:log4net.Core.LoggingEvent.UserName"> + <summary> + Gets the name of the current user. + </summary> + <value> + The name of the current user, or <c>NOT AVAILABLE</c> when the + underlying runtime has no support for retrieving the name of the + current user. + </value> + <remarks> + <para> + Calls <c>WindowsIdentity.GetCurrent().Name</c> to get the name of + the current windows user. + </para> + <para> + To improve performance, we could cache the string representation of + the name, and reuse that as long as the identity stayed constant. + Once the identity changed, we would need to re-assign and re-render + the string. + </para> + <para> + However, the <c>WindowsIdentity.GetCurrent()</c> call seems to + return different objects every time, so the current implementation + doesn't do this type of caching. + </para> + <para> + Timing for these operations: + </para> + <list type="table"> + <listheader> + <term>Method</term> + <description>Results</description> + </listheader> + <item> + <term><c>WindowsIdentity.GetCurrent()</c></term> + <description>10000 loops, 00:00:00.2031250 seconds</description> + </item> + <item> + <term><c>WindowsIdentity.GetCurrent().Name</c></term> + <description>10000 loops, 00:00:08.0468750 seconds</description> + </item> + </list> + <para> + This means we could speed things up almost 40 times by caching the + value of the <c>WindowsIdentity.GetCurrent().Name</c> property, since + this takes (8.04-0.20) = 7.84375 seconds. + </para> + </remarks> + </member> + <member name="P:log4net.Core.LoggingEvent.Identity"> + <summary> + Gets the identity of the current thread principal. + </summary> + <value> + The string name of the identity of the current thread principal. + </value> + <remarks> + <para> + Calls <c>System.Threading.Thread.CurrentPrincipal.Identity.Name</c> to get + the name of the current thread principal. + </para> + </remarks> + </member> + <member name="P:log4net.Core.LoggingEvent.Domain"> + <summary> + Gets the AppDomain friendly name. + </summary> + <value> + The AppDomain friendly name. + </value> + <remarks> + <para> + Gets the AppDomain friendly name. + </para> + </remarks> + </member> + <member name="P:log4net.Core.LoggingEvent.Properties"> + <summary> + Additional event specific properties. + </summary> + <value> + Additional event specific properties. + </value> + <remarks> + <para> + A logger or an appender may attach additional + properties to specific events. These properties + have a string key and an object value. + </para> + <para> + This property is for events that have been added directly to + this event. The aggregate properties (which include these + event properties) can be retrieved using <see cref="M:log4net.Core.LoggingEvent.LookupProperty(System.String)"/> + and <see cref="M:log4net.Core.LoggingEvent.GetProperties"/>. + </para> + <para> + Once the properties have been fixed <see cref="P:log4net.Core.LoggingEvent.Fix"/> this property + returns the combined cached properties. This ensures that updates to + this property are always reflected in the underlying storage. When + returning the combined properties there may be more keys in the + Dictionary than expected. + </para> + </remarks> + </member> + <member name="P:log4net.Core.LoggingEvent.Fix"> + <summary> + The fixed fields in this event + </summary> + <value> + The set of fields that are fixed in this event + </value> + <remarks> + <para> + Fields will not be fixed if they have previously been fixed. + It is not possible to 'unfix' a field. + </para> + </remarks> + </member> + <member name="T:log4net.Core.LogImpl"> + <summary> + Implementation of <see cref="T:log4net.ILog"/> wrapper interface. + </summary> + <remarks> + <para> + This implementation of the <see cref="T:log4net.ILog"/> interface + forwards to the <see cref="T:log4net.Core.ILogger"/> held by the base class. + </para> + <para> + This logger has methods to allow the caller to log at the following + levels: + </para> + <list type="definition"> + <item> + <term>DEBUG</term> + <description> + The <see cref="M:Debug(object)"/> and <see cref="M:DebugFormat(string, object[])"/> methods log messages + at the <c>DEBUG</c> level. That is the level with that name defined in the + repositories <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>. The default value + for this level is <see cref="F:log4net.Core.Level.Debug"/>. The <see cref="P:log4net.Core.LogImpl.IsDebugEnabled"/> + property tests if this level is enabled for logging. + </description> + </item> + <item> + <term>INFO</term> + <description> + The <see cref="M:Info(object)"/> and <see cref="M:InfoFormat(string, object[])"/> methods log messages + at the <c>INFO</c> level. That is the level with that name defined in the + repositories <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>. The default value + for this level is <see cref="F:log4net.Core.Level.Info"/>. The <see cref="P:log4net.Core.LogImpl.IsInfoEnabled"/> + property tests if this level is enabled for logging. + </description> + </item> + <item> + <term>WARN</term> + <description> + The <see cref="M:Warn(object)"/> and <see cref="M:WarnFormat(string, object[])"/> methods log messages + at the <c>WARN</c> level. That is the level with that name defined in the + repositories <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>. The default value + for this level is <see cref="F:log4net.Core.Level.Warn"/>. The <see cref="P:log4net.Core.LogImpl.IsWarnEnabled"/> + property tests if this level is enabled for logging. + </description> + </item> + <item> + <term>ERROR</term> + <description> + The <see cref="M:Error(object)"/> and <see cref="M:ErrorFormat(string, object[])"/> methods log messages + at the <c>ERROR</c> level. That is the level with that name defined in the + repositories <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>. The default value + for this level is <see cref="F:log4net.Core.Level.Error"/>. The <see cref="P:log4net.Core.LogImpl.IsErrorEnabled"/> + property tests if this level is enabled for logging. + </description> + </item> + <item> + <term>FATAL</term> + <description> + The <see cref="M:Fatal(object)"/> and <see cref="M:FatalFormat(string, object[])"/> methods log messages + at the <c>FATAL</c> level. That is the level with that name defined in the + repositories <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>. The default value + for this level is <see cref="F:log4net.Core.Level.Fatal"/>. The <see cref="P:log4net.Core.LogImpl.IsFatalEnabled"/> + property tests if this level is enabled for logging. + </description> + </item> + </list> + <para> + The values for these levels and their semantic meanings can be changed by + configuring the <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/> for the repository. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="T:log4net.ILog"> + <summary> + The ILog interface is use by application to log messages into + the log4net framework. + </summary> + <remarks> + <para> + Use the <see cref="T:log4net.LogManager"/> to obtain logger instances + that implement this interface. The <see cref="M:LogManager.GetLogger(Assembly,Type)"/> + static method is used to get logger instances. + </para> + <para> + This class contains methods for logging at different levels and also + has properties for determining if those logging levels are + enabled in the current configuration. + </para> + <para> + This interface can be implemented in different ways. This documentation + specifies reasonable behavior that a caller can expect from the actual + implementation, however different implementations reserve the right to + do things differently. + </para> + </remarks> + <example>Simple example of logging messages + <code lang="C#"> + ILog log = LogManager.GetLogger("application-log"); + + log.Info("Application Start"); + log.Debug("This is a debug message"); + + if (log.IsDebugEnabled) + { + log.Debug("This is another debug message"); + } + </code> + </example> + <seealso cref="T:log4net.LogManager"/> + <seealso cref="M:LogManager.GetLogger(Assembly, Type)"/> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.ILog.Debug(System.Object)"> + <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level.</overloads> + <summary> + Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level. + </summary> + <param name="message">The message object to log.</param> + <remarks> + <para> + This method first checks if this logger is <c>DEBUG</c> + enabled by comparing the level of this logger with the + <see cref="F:log4net.Core.Level.Debug"/> level. If this logger is + <c>DEBUG</c> enabled, then it converts the message object + (passed as parameter) to a string by invoking the appropriate + <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then + proceeds to call all the registered appenders in this logger + and also higher in the hierarchy depending on the value of + the additivity flag. + </para> + <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/> + to this method will print the name of the <see cref="T:System.Exception"/> + but no stack trace. To print a stack trace use the + <see cref="M:Debug(object,Exception)"/> form instead. + </para> + </remarks> + <seealso cref="M:Debug(object,Exception)"/> + <seealso cref="P:log4net.ILog.IsDebugEnabled"/> + </member> + <member name="M:log4net.ILog.Debug(System.Object,System.Exception)"> + <summary> + Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level including + the stack trace of the <see cref="T:System.Exception"/> passed + as a parameter. + </summary> + <param name="message">The message object to log.</param> + <param name="exception">The exception to log, including its stack trace.</param> + <remarks> + <para> + See the <see cref="M:Debug(object)"/> form for more detailed information. + </para> + </remarks> + <seealso cref="M:Debug(object)"/> + <seealso cref="P:log4net.ILog.IsDebugEnabled"/> + </member> + <member name="M:log4net.ILog.DebugFormat(System.String,System.Object[])"> + <overloads>Log a formatted string with the <see cref="F:log4net.Core.Level.Debug"/> level.</overloads> + <summary> + Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level. + </summary> + <param name="format">A String containing zero or more format items</param> + <param name="args">An Object array containing zero or more objects to format</param> + <remarks> + <para> + The message is formatted using the <c>String.Format</c> method. See + <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object,Exception)"/> + methods instead. + </para> + </remarks> + <seealso cref="M:Debug(object)"/> + <seealso cref="P:log4net.ILog.IsDebugEnabled"/> + </member> + <member name="M:log4net.ILog.DebugFormat(System.String,System.Object)"> + <summary> + Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level. + </summary> + <param name="format">A String containing zero or more format items</param> + <param name="arg0">An Object to format</param> + <remarks> + <para> + The message is formatted using the <c>String.Format</c> method. See + <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object,Exception)"/> + methods instead. + </para> + </remarks> + <seealso cref="M:Debug(object)"/> + <seealso cref="P:log4net.ILog.IsDebugEnabled"/> + </member> + <member name="M:log4net.ILog.DebugFormat(System.String,System.Object,System.Object)"> + <summary> + Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level. + </summary> + <param name="format">A String containing zero or more format items</param> + <param name="arg0">An Object to format</param> + <param name="arg1">An Object to format</param> + <remarks> + <para> + The message is formatted using the <c>String.Format</c> method. See + <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object,Exception)"/> + methods instead. + </para> + </remarks> + <seealso cref="M:Debug(object)"/> + <seealso cref="P:log4net.ILog.IsDebugEnabled"/> + </member> + <member name="M:log4net.ILog.DebugFormat(System.String,System.Object,System.Object,System.Object)"> + <summary> + Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level. + </summary> + <param name="format">A String containing zero or more format items</param> + <param name="arg0">An Object to format</param> + <param name="arg1">An Object to format</param> + <param name="arg2">An Object to format</param> + <remarks> + <para> + The message is formatted using the <c>String.Format</c> method. See + <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object,Exception)"/> + methods instead. + </para> + </remarks> + <seealso cref="M:Debug(object)"/> + <seealso cref="P:log4net.ILog.IsDebugEnabled"/> + </member> + <member name="M:log4net.ILog.DebugFormat(System.IFormatProvider,System.String,System.Object[])"> + <summary> + Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level. + </summary> + <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param> + <param name="format">A String containing zero or more format items</param> + <param name="args">An Object array containing zero or more objects to format</param> + <remarks> + <para> + The message is formatted using the <c>String.Format</c> method. See + <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object,Exception)"/> + methods instead. + </para> + </remarks> + <seealso cref="M:Debug(object)"/> + <seealso cref="P:log4net.ILog.IsDebugEnabled"/> + </member> + <member name="M:log4net.ILog.Info(System.Object)"> + <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Info"/> level.</overloads> + <summary> + Logs a message object with the <see cref="F:log4net.Core.Level.Info"/> level. + </summary> + <remarks> + <para> + This method first checks if this logger is <c>INFO</c> + enabled by comparing the level of this logger with the + <see cref="F:log4net.Core.Level.Info"/> level. If this logger is + <c>INFO</c> enabled, then it converts the message object + (passed as parameter) to a string by invoking the appropriate + <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then + proceeds to call all the registered appenders in this logger + and also higher in the hierarchy depending on the value of the + additivity flag. + </para> + <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/> + to this method will print the name of the <see cref="T:System.Exception"/> + but no stack trace. To print a stack trace use the + <see cref="M:Info(object,Exception)"/> form instead. + </para> + </remarks> + <param name="message">The message object to log.</param> + <seealso cref="M:Info(object,Exception)"/> + <seealso cref="P:log4net.ILog.IsInfoEnabled"/> + </member> + <member name="M:log4net.ILog.Info(System.Object,System.Exception)"> + <summary> + Logs a message object with the <c>INFO</c> level including + the stack trace of the <see cref="T:System.Exception"/> passed + as a parameter. + </summary> + <param name="message">The message object to log.</param> + <param name="exception">The exception to log, including its stack trace.</param> + <remarks> + <para> + See the <see cref="M:Info(object)"/> form for more detailed information. + </para> + </remarks> + <seealso cref="M:Info(object)"/> + <seealso cref="P:log4net.ILog.IsInfoEnabled"/> + </member> + <member name="M:log4net.ILog.InfoFormat(System.String,System.Object[])"> + <overloads>Log a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.</overloads> + <summary> + Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level. + </summary> + <param name="format">A String containing zero or more format items</param> + <param name="args">An Object array containing zero or more objects to format</param> + <remarks> + <para> + The message is formatted using the <c>String.Format</c> method. See + <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/> + methods instead. + </para> + </remarks> + <seealso cref="M:Info(object,Exception)"/> + <seealso cref="P:log4net.ILog.IsInfoEnabled"/> + </member> + <member name="M:log4net.ILog.InfoFormat(System.String,System.Object)"> + <summary> + Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level. + </summary> + <param name="format">A String containing zero or more format items</param> + <param name="arg0">An Object to format</param> + <remarks> + <para> + The message is formatted using the <c>String.Format</c> method. See + <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object,Exception)"/> + methods instead. + </para> + </remarks> + <seealso cref="M:Info(object)"/> + <seealso cref="P:log4net.ILog.IsInfoEnabled"/> + </member> + <member name="M:log4net.ILog.InfoFormat(System.String,System.Object,System.Object)"> + <summary> + Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level. + </summary> + <param name="format">A String containing zero or more format items</param> + <param name="arg0">An Object to format</param> + <param name="arg1">An Object to format</param> + <remarks> + <para> + The message is formatted using the <c>String.Format</c> method. See + <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object,Exception)"/> + methods instead. + </para> + </remarks> + <seealso cref="M:Info(object)"/> + <seealso cref="P:log4net.ILog.IsInfoEnabled"/> + </member> + <member name="M:log4net.ILog.InfoFormat(System.String,System.Object,System.Object,System.Object)"> + <summary> + Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level. + </summary> + <param name="format">A String containing zero or more format items</param> + <param name="arg0">An Object to format</param> + <param name="arg1">An Object to format</param> + <param name="arg2">An Object to format</param> + <remarks> + <para> + The message is formatted using the <c>String.Format</c> method. See + <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object,Exception)"/> + methods instead. + </para> + </remarks> + <seealso cref="M:Info(object)"/> + <seealso cref="P:log4net.ILog.IsInfoEnabled"/> + </member> + <member name="M:log4net.ILog.InfoFormat(System.IFormatProvider,System.String,System.Object[])"> + <summary> + Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level. + </summary> + <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param> + <param name="format">A String containing zero or more format items</param> + <param name="args">An Object array containing zero or more objects to format</param> + <remarks> + <para> + The message is formatted using the <c>String.Format</c> method. See + <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/> + methods instead. + </para> + </remarks> + <seealso cref="M:Info(object,Exception)"/> + <seealso cref="P:log4net.ILog.IsInfoEnabled"/> + </member> + <member name="M:log4net.ILog.Warn(System.Object)"> + <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level.</overloads> + <summary> + Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level. + </summary> + <remarks> + <para> + This method first checks if this logger is <c>WARN</c> + enabled by comparing the level of this logger with the + <see cref="F:log4net.Core.Level.Warn"/> level. If this logger is + <c>WARN</c> enabled, then it converts the message object + (passed as parameter) to a string by invoking the appropriate + <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then + proceeds to call all the registered appenders in this logger + and also higher in the hierarchy depending on the value of the + additivity flag. + </para> + <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/> + to this method will print the name of the <see cref="T:System.Exception"/> + but no stack trace. To print a stack trace use the + <see cref="M:Warn(object,Exception)"/> form instead. + </para> + </remarks> + <param name="message">The message object to log.</param> + <seealso cref="M:Warn(object,Exception)"/> + <seealso cref="P:log4net.ILog.IsWarnEnabled"/> + </member> + <member name="M:log4net.ILog.Warn(System.Object,System.Exception)"> + <summary> + Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level including + the stack trace of the <see cref="T:System.Exception"/> passed + as a parameter. + </summary> + <param name="message">The message object to log.</param> + <param name="exception">The exception to log, including its stack trace.</param> + <remarks> + <para> + See the <see cref="M:Warn(object)"/> form for more detailed information. + </para> + </remarks> + <seealso cref="M:Warn(object)"/> + <seealso cref="P:log4net.ILog.IsWarnEnabled"/> + </member> + <member name="M:log4net.ILog.WarnFormat(System.String,System.Object[])"> + <overloads>Log a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.</overloads> + <summary> + Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level. + </summary> + <param name="format">A String containing zero or more format items</param> + <param name="args">An Object array containing zero or more objects to format</param> + <remarks> + <para> + The message is formatted using the <c>String.Format</c> method. See + <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/> + methods instead. + </para> + </remarks> + <seealso cref="M:Warn(object,Exception)"/> + <seealso cref="P:log4net.ILog.IsWarnEnabled"/> + </member> + <member name="M:log4net.ILog.WarnFormat(System.String,System.Object)"> + <summary> + Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level. + </summary> + <param name="format">A String containing zero or more format items</param> + <param name="arg0">An Object to format</param> + <remarks> + <para> + The message is formatted using the <c>String.Format</c> method. See + <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object,Exception)"/> + methods instead. + </para> + </remarks> + <seealso cref="M:Warn(object)"/> + <seealso cref="P:log4net.ILog.IsWarnEnabled"/> + </member> + <member name="M:log4net.ILog.WarnFormat(System.String,System.Object,System.Object)"> + <summary> + Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level. + </summary> + <param name="format">A String containing zero or more format items</param> + <param name="arg0">An Object to format</param> + <param name="arg1">An Object to format</param> + <remarks> + <para> + The message is formatted using the <c>String.Format</c> method. See + <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object,Exception)"/> + methods instead. + </para> + </remarks> + <seealso cref="M:Warn(object)"/> + <seealso cref="P:log4net.ILog.IsWarnEnabled"/> + </member> + <member name="M:log4net.ILog.WarnFormat(System.String,System.Object,System.Object,System.Object)"> + <summary> + Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level. + </summary> + <param name="format">A String containing zero or more format items</param> + <param name="arg0">An Object to format</param> + <param name="arg1">An Object to format</param> + <param name="arg2">An Object to format</param> + <remarks> + <para> + The message is formatted using the <c>String.Format</c> method. See + <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object,Exception)"/> + methods instead. + </para> + </remarks> + <seealso cref="M:Warn(object)"/> + <seealso cref="P:log4net.ILog.IsWarnEnabled"/> + </member> + <member name="M:log4net.ILog.WarnFormat(System.IFormatProvider,System.String,System.Object[])"> + <summary> + Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level. + </summary> + <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param> + <param name="format">A String containing zero or more format items</param> + <param name="args">An Object array containing zero or more objects to format</param> + <remarks> + <para> + The message is formatted using the <c>String.Format</c> method. See + <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/> + methods instead. + </para> + </remarks> + <seealso cref="M:Warn(object,Exception)"/> + <seealso cref="P:log4net.ILog.IsWarnEnabled"/> + </member> + <member name="M:log4net.ILog.Error(System.Object)"> + <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level.</overloads> + <summary> + Logs a message object with the <see cref="F:log4net.Core.Level.Error"/> level. + </summary> + <param name="message">The message object to log.</param> + <remarks> + <para> + This method first checks if this logger is <c>ERROR</c> + enabled by comparing the level of this logger with the + <see cref="F:log4net.Core.Level.Error"/> level. If this logger is + <c>ERROR</c> enabled, then it converts the message object + (passed as parameter) to a string by invoking the appropriate + <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then + proceeds to call all the registered appenders in this logger + and also higher in the hierarchy depending on the value of the + additivity flag. + </para> + <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/> + to this method will print the name of the <see cref="T:System.Exception"/> + but no stack trace. To print a stack trace use the + <see cref="M:Error(object,Exception)"/> form instead. + </para> + </remarks> + <seealso cref="M:Error(object,Exception)"/> + <seealso cref="P:log4net.ILog.IsErrorEnabled"/> + </member> + <member name="M:log4net.ILog.Error(System.Object,System.Exception)"> + <summary> + Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level including + the stack trace of the <see cref="T:System.Exception"/> passed + as a parameter. + </summary> + <param name="message">The message object to log.</param> + <param name="exception">The exception to log, including its stack trace.</param> + <remarks> + <para> + See the <see cref="M:Error(object)"/> form for more detailed information. + </para> + </remarks> + <seealso cref="M:Error(object)"/> + <seealso cref="P:log4net.ILog.IsErrorEnabled"/> + </member> + <member name="M:log4net.ILog.ErrorFormat(System.String,System.Object[])"> + <overloads>Log a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.</overloads> + <summary> + Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level. + </summary> + <param name="format">A String containing zero or more format items</param> + <param name="args">An Object array containing zero or more objects to format</param> + <remarks> + <para> + The message is formatted using the <c>String.Format</c> method. See + <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/> + methods instead. + </para> + </remarks> + <seealso cref="M:Error(object,Exception)"/> + <seealso cref="P:log4net.ILog.IsErrorEnabled"/> + </member> + <member name="M:log4net.ILog.ErrorFormat(System.String,System.Object)"> + <summary> + Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level. + </summary> + <param name="format">A String containing zero or more format items</param> + <param name="arg0">An Object to format</param> + <remarks> + <para> + The message is formatted using the <c>String.Format</c> method. See + <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object,Exception)"/> + methods instead. + </para> + </remarks> + <seealso cref="M:Error(object)"/> + <seealso cref="P:log4net.ILog.IsErrorEnabled"/> + </member> + <member name="M:log4net.ILog.ErrorFormat(System.String,System.Object,System.Object)"> + <summary> + Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level. + </summary> + <param name="format">A String containing zero or more format items</param> + <param name="arg0">An Object to format</param> + <param name="arg1">An Object to format</param> + <remarks> + <para> + The message is formatted using the <c>String.Format</c> method. See + <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object,Exception)"/> + methods instead. + </para> + </remarks> + <seealso cref="M:Error(object)"/> + <seealso cref="P:log4net.ILog.IsErrorEnabled"/> + </member> + <member name="M:log4net.ILog.ErrorFormat(System.String,System.Object,System.Object,System.Object)"> + <summary> + Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level. + </summary> + <param name="format">A String containing zero or more format items</param> + <param name="arg0">An Object to format</param> + <param name="arg1">An Object to format</param> + <param name="arg2">An Object to format</param> + <remarks> + <para> + The message is formatted using the <c>String.Format</c> method. See + <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object,Exception)"/> + methods instead. + </para> + </remarks> + <seealso cref="M:Error(object)"/> + <seealso cref="P:log4net.ILog.IsErrorEnabled"/> + </member> + <member name="M:log4net.ILog.ErrorFormat(System.IFormatProvider,System.String,System.Object[])"> + <summary> + Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level. + </summary> + <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param> + <param name="format">A String containing zero or more format items</param> + <param name="args">An Object array containing zero or more objects to format</param> + <remarks> + <para> + The message is formatted using the <c>String.Format</c> method. See + <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/> + methods instead. + </para> + </remarks> + <seealso cref="M:Error(object,Exception)"/> + <seealso cref="P:log4net.ILog.IsErrorEnabled"/> + </member> + <member name="M:log4net.ILog.Fatal(System.Object)"> + <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level.</overloads> + <summary> + Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level. + </summary> + <remarks> + <para> + This method first checks if this logger is <c>FATAL</c> + enabled by comparing the level of this logger with the + <see cref="F:log4net.Core.Level.Fatal"/> level. If this logger is + <c>FATAL</c> enabled, then it converts the message object + (passed as parameter) to a string by invoking the appropriate + <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then + proceeds to call all the registered appenders in this logger + and also higher in the hierarchy depending on the value of the + additivity flag. + </para> + <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/> + to this method will print the name of the <see cref="T:System.Exception"/> + but no stack trace. To print a stack trace use the + <see cref="M:Fatal(object,Exception)"/> form instead. + </para> + </remarks> + <param name="message">The message object to log.</param> + <seealso cref="M:Fatal(object,Exception)"/> + <seealso cref="P:log4net.ILog.IsFatalEnabled"/> + </member> + <member name="M:log4net.ILog.Fatal(System.Object,System.Exception)"> + <summary> + Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level including + the stack trace of the <see cref="T:System.Exception"/> passed + as a parameter. + </summary> + <param name="message">The message object to log.</param> + <param name="exception">The exception to log, including its stack trace.</param> + <remarks> + <para> + See the <see cref="M:Fatal(object)"/> form for more detailed information. + </para> + </remarks> + <seealso cref="M:Fatal(object)"/> + <seealso cref="P:log4net.ILog.IsFatalEnabled"/> + </member> + <member name="M:log4net.ILog.FatalFormat(System.String,System.Object[])"> + <overloads>Log a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.</overloads> + <summary> + Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level. + </summary> + <param name="format">A String containing zero or more format items</param> + <param name="args">An Object array containing zero or more objects to format</param> + <remarks> + <para> + The message is formatted using the <c>String.Format</c> method. See + <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/> + methods instead. + </para> + </remarks> + <seealso cref="M:Fatal(object,Exception)"/> + <seealso cref="P:log4net.ILog.IsFatalEnabled"/> + </member> + <member name="M:log4net.ILog.FatalFormat(System.String,System.Object)"> + <summary> + Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level. + </summary> + <param name="format">A String containing zero or more format items</param> + <param name="arg0">An Object to format</param> + <remarks> + <para> + The message is formatted using the <c>String.Format</c> method. See + <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object,Exception)"/> + methods instead. + </para> + </remarks> + <seealso cref="M:Fatal(object)"/> + <seealso cref="P:log4net.ILog.IsFatalEnabled"/> + </member> + <member name="M:log4net.ILog.FatalFormat(System.String,System.Object,System.Object)"> + <summary> + Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level. + </summary> + <param name="format">A String containing zero or more format items</param> + <param name="arg0">An Object to format</param> + <param name="arg1">An Object to format</param> + <remarks> + <para> + The message is formatted using the <c>String.Format</c> method. See + <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object,Exception)"/> + methods instead. + </para> + </remarks> + <seealso cref="M:Fatal(object)"/> + <seealso cref="P:log4net.ILog.IsFatalEnabled"/> + </member> + <member name="M:log4net.ILog.FatalFormat(System.String,System.Object,System.Object,System.Object)"> + <summary> + Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level. + </summary> + <param name="format">A String containing zero or more format items</param> + <param name="arg0">An Object to format</param> + <param name="arg1">An Object to format</param> + <param name="arg2">An Object to format</param> + <remarks> + <para> + The message is formatted using the <c>String.Format</c> method. See + <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object,Exception)"/> + methods instead. + </para> + </remarks> + <seealso cref="M:Fatal(object)"/> + <seealso cref="P:log4net.ILog.IsFatalEnabled"/> + </member> + <member name="M:log4net.ILog.FatalFormat(System.IFormatProvider,System.String,System.Object[])"> + <summary> + Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level. + </summary> + <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param> + <param name="format">A String containing zero or more format items</param> + <param name="args">An Object array containing zero or more objects to format</param> + <remarks> + <para> + The message is formatted using the <c>String.Format</c> method. See + <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/> + methods instead. + </para> + </remarks> + <seealso cref="M:Fatal(object,Exception)"/> + <seealso cref="P:log4net.ILog.IsFatalEnabled"/> + </member> + <member name="P:log4net.ILog.IsDebugEnabled"> + <summary> + Checks if this logger is enabled for the <see cref="F:log4net.Core.Level.Debug"/> level. + </summary> + <value> + <c>true</c> if this logger is enabled for <see cref="F:log4net.Core.Level.Debug"/> events, <c>false</c> otherwise. + </value> + <remarks> + <para> + This function is intended to lessen the computational cost of + disabled log debug statements. + </para> + <para> For some ILog interface <c>log</c>, when you write:</para> + <code lang="C#"> + log.Debug("This is entry number: " + i ); + </code> + <para> + You incur the cost constructing the message, string construction and concatenation in + this case, regardless of whether the message is logged or not. + </para> + <para> + If you are worried about speed (who isn't), then you should write: + </para> + <code lang="C#"> + if (log.IsDebugEnabled) + { + log.Debug("This is entry number: " + i ); + } + </code> + <para> + This way you will not incur the cost of parameter + construction if debugging is disabled for <c>log</c>. On + the other hand, if the <c>log</c> is debug enabled, you + will incur the cost of evaluating whether the logger is debug + enabled twice. Once in <see cref="P:log4net.ILog.IsDebugEnabled"/> and once in + the <see cref="M:Debug(object)"/>. This is an insignificant overhead + since evaluating a logger takes about 1% of the time it + takes to actually log. This is the preferred style of logging. + </para> + <para>Alternatively if your logger is available statically then the is debug + enabled state can be stored in a static variable like this: + </para> + <code lang="C#"> + private static readonly bool isDebugEnabled = log.IsDebugEnabled; + </code> + <para> + Then when you come to log you can write: + </para> + <code lang="C#"> + if (isDebugEnabled) + { + log.Debug("This is entry number: " + i ); + } + </code> + <para> + This way the debug enabled state is only queried once + when the class is loaded. Using a <c>private static readonly</c> + variable is the most efficient because it is a run time constant + and can be heavily optimized by the JIT compiler. + </para> + <para> + Of course if you use a static readonly variable to + hold the enabled state of the logger then you cannot + change the enabled state at runtime to vary the logging + that is produced. You have to decide if you need absolute + speed or runtime flexibility. + </para> + </remarks> + <seealso cref="M:Debug(object)"/> + <seealso cref="M:DebugFormat(IFormatProvider, string, object[])"/> + </member> + <member name="P:log4net.ILog.IsInfoEnabled"> + <summary> + Checks if this logger is enabled for the <see cref="F:log4net.Core.Level.Info"/> level. + </summary> + <value> + <c>true</c> if this logger is enabled for <see cref="F:log4net.Core.Level.Info"/> events, <c>false</c> otherwise. + </value> + <remarks> + For more information see <see cref="P:log4net.ILog.IsDebugEnabled"/>. + </remarks> + <seealso cref="M:Info(object)"/> + <seealso cref="M:InfoFormat(IFormatProvider, string, object[])"/> + <seealso cref="P:log4net.ILog.IsDebugEnabled"/> + </member> + <member name="P:log4net.ILog.IsWarnEnabled"> + <summary> + Checks if this logger is enabled for the <see cref="F:log4net.Core.Level.Warn"/> level. + </summary> + <value> + <c>true</c> if this logger is enabled for <see cref="F:log4net.Core.Level.Warn"/> events, <c>false</c> otherwise. + </value> + <remarks> + For more information see <see cref="P:log4net.ILog.IsDebugEnabled"/>. + </remarks> + <seealso cref="M:Warn(object)"/> + <seealso cref="M:WarnFormat(IFormatProvider, string, object[])"/> + <seealso cref="P:log4net.ILog.IsDebugEnabled"/> + </member> + <member name="P:log4net.ILog.IsErrorEnabled"> + <summary> + Checks if this logger is enabled for the <see cref="F:log4net.Core.Level.Error"/> level. + </summary> + <value> + <c>true</c> if this logger is enabled for <see cref="F:log4net.Core.Level.Error"/> events, <c>false</c> otherwise. + </value> + <remarks> + For more information see <see cref="P:log4net.ILog.IsDebugEnabled"/>. + </remarks> + <seealso cref="M:Error(object)"/> + <seealso cref="M:ErrorFormat(IFormatProvider, string, object[])"/> + <seealso cref="P:log4net.ILog.IsDebugEnabled"/> + </member> + <member name="P:log4net.ILog.IsFatalEnabled"> + <summary> + Checks if this logger is enabled for the <see cref="F:log4net.Core.Level.Fatal"/> level. + </summary> + <value> + <c>true</c> if this logger is enabled for <see cref="F:log4net.Core.Level.Fatal"/> events, <c>false</c> otherwise. + </value> + <remarks> + For more information see <see cref="P:log4net.ILog.IsDebugEnabled"/>. + </remarks> + <seealso cref="M:Fatal(object)"/> + <seealso cref="M:FatalFormat(IFormatProvider, string, object[])"/> + <seealso cref="P:log4net.ILog.IsDebugEnabled"/> + </member> + <member name="M:log4net.Core.LogImpl.#ctor(log4net.Core.ILogger)"> + <summary> + Construct a new wrapper for the specified logger. + </summary> + <param name="logger">The logger to wrap.</param> + <remarks> + <para> + Construct a new wrapper for the specified logger. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LogImpl.ReloadLevels(log4net.Repository.ILoggerRepository)"> + <summary> + Virtual method called when the configuration of the repository changes + </summary> + <param name="repository">the repository holding the levels</param> + <remarks> + <para> + Virtual method called when the configuration of the repository changes + </para> + </remarks> + </member> + <member name="M:log4net.Core.LogImpl.Debug(System.Object)"> + <summary> + Logs a message object with the <c>DEBUG</c> level. + </summary> + <param name="message">The message object to log.</param> + <remarks> + <para> + This method first checks if this logger is <c>DEBUG</c> + enabled by comparing the level of this logger with the + <c>DEBUG</c> level. If this logger is + <c>DEBUG</c> enabled, then it converts the message object + (passed as parameter) to a string by invoking the appropriate + <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then + proceeds to call all the registered appenders in this logger + and also higher in the hierarchy depending on the value of the + additivity flag. + </para> + <para> + <b>WARNING</b> Note that passing an <see cref="T:System.Exception"/> + to this method will print the name of the <see cref="T:System.Exception"/> + but no stack trace. To print a stack trace use the + <see cref="M:Debug(object,Exception)"/> form instead. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LogImpl.Debug(System.Object,System.Exception)"> + <summary> + Logs a message object with the <c>DEBUG</c> level + </summary> + <param name="message">The message object to log.</param> + <param name="exception">The exception to log, including its stack trace.</param> + <remarks> + <para> + Logs a message object with the <c>DEBUG</c> level including + the stack trace of the <see cref="T:System.Exception"/> <paramref name="exception"/> passed + as a parameter. + </para> + <para> + See the <see cref="M:Debug(object)"/> form for more detailed information. + </para> + </remarks> + <seealso cref="M:Debug(object)"/> + </member> + <member name="M:log4net.Core.LogImpl.DebugFormat(System.String,System.Object[])"> + <summary> + Logs a formatted message string with the <c>DEBUG</c> level. + </summary> + <param name="format">A String containing zero or more format items</param> + <param name="args">An Object array containing zero or more objects to format</param> + <remarks> + <para> + The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See + <c>String.Format</c> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/> + format provider. To specify a localized provider use the + <see cref="M:DebugFormat(IFormatProvider,string,object[])"/> method. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object)"/> + methods instead. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LogImpl.DebugFormat(System.String,System.Object)"> + <summary> + Logs a formatted message string with the <c>DEBUG</c> level. + </summary> + <param name="format">A String containing zero or more format items</param> + <param name="arg0">An Object to format</param> + <remarks> + <para> + The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See + <c>String.Format</c> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/> + format provider. To specify a localized provider use the + <see cref="M:DebugFormat(IFormatProvider,string,object[])"/> method. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object)"/> + methods instead. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LogImpl.DebugFormat(System.String,System.Object,System.Object)"> + <summary> + Logs a formatted message string with the <c>DEBUG</c> level. + </summary> + <param name="format">A String containing zero or more format items</param> + <param name="arg0">An Object to format</param> + <param name="arg1">An Object to format</param> + <remarks> + <para> + The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See + <c>String.Format</c> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/> + format provider. To specify a localized provider use the + <see cref="M:DebugFormat(IFormatProvider,string,object[])"/> method. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object)"/> + methods instead. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LogImpl.DebugFormat(System.String,System.Object,System.Object,System.Object)"> + <summary> + Logs a formatted message string with the <c>DEBUG</c> level. + </summary> + <param name="format">A String containing zero or more format items</param> + <param name="arg0">An Object to format</param> + <param name="arg1">An Object to format</param> + <param name="arg2">An Object to format</param> + <remarks> + <para> + The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See + <c>String.Format</c> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/> + format provider. To specify a localized provider use the + <see cref="M:DebugFormat(IFormatProvider,string,object[])"/> method. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object)"/> + methods instead. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LogImpl.DebugFormat(System.IFormatProvider,System.String,System.Object[])"> + <summary> + Logs a formatted message string with the <c>DEBUG</c> level. + </summary> + <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param> + <param name="format">A String containing zero or more format items</param> + <param name="args">An Object array containing zero or more objects to format</param> + <remarks> + <para> + The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See + <c>String.Format</c> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object)"/> + methods instead. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LogImpl.Info(System.Object)"> + <summary> + Logs a message object with the <c>INFO</c> level. + </summary> + <param name="message">The message object to log.</param> + <remarks> + <para> + This method first checks if this logger is <c>INFO</c> + enabled by comparing the level of this logger with the + <c>INFO</c> level. If this logger is + <c>INFO</c> enabled, then it converts the message object + (passed as parameter) to a string by invoking the appropriate + <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then + proceeds to call all the registered appenders in this logger + and also higher in the hierarchy depending on the value of + the additivity flag. + </para> + <para> + <b>WARNING</b> Note that passing an <see cref="T:System.Exception"/> + to this method will print the name of the <see cref="T:System.Exception"/> + but no stack trace. To print a stack trace use the + <see cref="M:Info(object,Exception)"/> form instead. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LogImpl.Info(System.Object,System.Exception)"> + <summary> + Logs a message object with the <c>INFO</c> level. + </summary> + <param name="message">The message object to log.</param> + <param name="exception">The exception to log, including its stack trace.</param> + <remarks> + <para> + Logs a message object with the <c>INFO</c> level including + the stack trace of the <see cref="T:System.Exception"/> <paramref name="exception"/> + passed as a parameter. + </para> + <para> + See the <see cref="M:Info(object)"/> form for more detailed information. + </para> + </remarks> + <seealso cref="M:Info(object)"/> + </member> + <member name="M:log4net.Core.LogImpl.InfoFormat(System.String,System.Object[])"> + <summary> + Logs a formatted message string with the <c>INFO</c> level. + </summary> + <param name="format">A String containing zero or more format items</param> + <param name="args">An Object array containing zero or more objects to format</param> + <remarks> + <para> + The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See + <c>String.Format</c> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/> + format provider. To specify a localized provider use the + <see cref="M:InfoFormat(IFormatProvider,string,object[])"/> method. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/> + methods instead. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LogImpl.InfoFormat(System.String,System.Object)"> + <summary> + Logs a formatted message string with the <c>INFO</c> level. + </summary> + <param name="format">A String containing zero or more format items</param> + <param name="arg0">An Object to format</param> + <remarks> + <para> + The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See + <c>String.Format</c> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/> + format provider. To specify a localized provider use the + <see cref="M:InfoFormat(IFormatProvider,string,object[])"/> method. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/> + methods instead. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LogImpl.InfoFormat(System.String,System.Object,System.Object)"> + <summary> + Logs a formatted message string with the <c>INFO</c> level. + </summary> + <param name="format">A String containing zero or more format items</param> + <param name="arg0">An Object to format</param> + <param name="arg1">An Object to format</param> + <remarks> + <para> + The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See + <c>String.Format</c> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/> + format provider. To specify a localized provider use the + <see cref="M:InfoFormat(IFormatProvider,string,object[])"/> method. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/> + methods instead. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LogImpl.InfoFormat(System.String,System.Object,System.Object,System.Object)"> + <summary> + Logs a formatted message string with the <c>INFO</c> level. + </summary> + <param name="format">A String containing zero or more format items</param> + <param name="arg0">An Object to format</param> + <param name="arg1">An Object to format</param> + <param name="arg2">An Object to format</param> + <remarks> + <para> + The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See + <c>String.Format</c> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/> + format provider. To specify a localized provider use the + <see cref="M:InfoFormat(IFormatProvider,string,object[])"/> method. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/> + methods instead. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LogImpl.InfoFormat(System.IFormatProvider,System.String,System.Object[])"> + <summary> + Logs a formatted message string with the <c>INFO</c> level. + </summary> + <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param> + <param name="format">A String containing zero or more format items</param> + <param name="args">An Object array containing zero or more objects to format</param> + <remarks> + <para> + The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See + <c>String.Format</c> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/> + methods instead. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LogImpl.Warn(System.Object)"> + <summary> + Logs a message object with the <c>WARN</c> level. + </summary> + <param name="message">the message object to log</param> + <remarks> + <para> + This method first checks if this logger is <c>WARN</c> + enabled by comparing the level of this logger with the + <c>WARN</c> level. If this logger is + <c>WARN</c> enabled, then it converts the message object + (passed as parameter) to a string by invoking the appropriate + <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then + proceeds to call all the registered appenders in this logger and + also higher in the hierarchy depending on the value of the + additivity flag. + </para> + <para> + <b>WARNING</b> Note that passing an <see cref="T:System.Exception"/> to this + method will print the name of the <see cref="T:System.Exception"/> but no + stack trace. To print a stack trace use the + <see cref="M:Warn(object,Exception)"/> form instead. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LogImpl.Warn(System.Object,System.Exception)"> + <summary> + Logs a message object with the <c>WARN</c> level + </summary> + <param name="message">The message object to log.</param> + <param name="exception">The exception to log, including its stack trace.</param> + <remarks> + <para> + Logs a message object with the <c>WARN</c> level including + the stack trace of the <see cref="T:System.Exception"/> <paramref name="exception"/> + passed as a parameter. + </para> + <para> + See the <see cref="M:Warn(object)"/> form for more detailed information. + </para> + </remarks> + <seealso cref="M:Warn(object)"/> + </member> + <member name="M:log4net.Core.LogImpl.WarnFormat(System.String,System.Object[])"> + <summary> + Logs a formatted message string with the <c>WARN</c> level. + </summary> + <param name="format">A String containing zero or more format items</param> + <param name="args">An Object array containing zero or more objects to format</param> + <remarks> + <para> + The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See + <c>String.Format</c> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/> + format provider. To specify a localized provider use the + <see cref="M:WarnFormat(IFormatProvider,string,object[])"/> method. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/> + methods instead. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LogImpl.WarnFormat(System.String,System.Object)"> + <summary> + Logs a formatted message string with the <c>WARN</c> level. + </summary> + <param name="format">A String containing zero or more format items</param> + <param name="arg0">An Object to format</param> + <remarks> + <para> + The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See + <c>String.Format</c> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/> + format provider. To specify a localized provider use the + <see cref="M:WarnFormat(IFormatProvider,string,object[])"/> method. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/> + methods instead. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LogImpl.WarnFormat(System.String,System.Object,System.Object)"> + <summary> + Logs a formatted message string with the <c>WARN</c> level. + </summary> + <param name="format">A String containing zero or more format items</param> + <param name="arg0">An Object to format</param> + <param name="arg1">An Object to format</param> + <remarks> + <para> + The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See + <c>String.Format</c> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/> + format provider. To specify a localized provider use the + <see cref="M:WarnFormat(IFormatProvider,string,object[])"/> method. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/> + methods instead. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LogImpl.WarnFormat(System.String,System.Object,System.Object,System.Object)"> + <summary> + Logs a formatted message string with the <c>WARN</c> level. + </summary> + <param name="format">A String containing zero or more format items</param> + <param name="arg0">An Object to format</param> + <param name="arg1">An Object to format</param> + <param name="arg2">An Object to format</param> + <remarks> + <para> + The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See + <c>String.Format</c> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/> + format provider. To specify a localized provider use the + <see cref="M:WarnFormat(IFormatProvider,string,object[])"/> method. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/> + methods instead. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LogImpl.WarnFormat(System.IFormatProvider,System.String,System.Object[])"> + <summary> + Logs a formatted message string with the <c>WARN</c> level. + </summary> + <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param> + <param name="format">A String containing zero or more format items</param> + <param name="args">An Object array containing zero or more objects to format</param> + <remarks> + <para> + The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See + <c>String.Format</c> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/> + methods instead. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LogImpl.Error(System.Object)"> + <summary> + Logs a message object with the <c>ERROR</c> level. + </summary> + <param name="message">The message object to log.</param> + <remarks> + <para> + This method first checks if this logger is <c>ERROR</c> + enabled by comparing the level of this logger with the + <c>ERROR</c> level. If this logger is + <c>ERROR</c> enabled, then it converts the message object + (passed as parameter) to a string by invoking the appropriate + <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then + proceeds to call all the registered appenders in this logger and + also higher in the hierarchy depending on the value of the + additivity flag. + </para> + <para> + <b>WARNING</b> Note that passing an <see cref="T:System.Exception"/> to this + method will print the name of the <see cref="T:System.Exception"/> but no + stack trace. To print a stack trace use the + <see cref="M:Error(object,Exception)"/> form instead. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LogImpl.Error(System.Object,System.Exception)"> + <summary> + Logs a message object with the <c>ERROR</c> level + </summary> + <param name="message">The message object to log.</param> + <param name="exception">The exception to log, including its stack trace.</param> + <remarks> + <para> + Logs a message object with the <c>ERROR</c> level including + the stack trace of the <see cref="T:System.Exception"/> <paramref name="exception"/> + passed as a parameter. + </para> + <para> + See the <see cref="M:Error(object)"/> form for more detailed information. + </para> + </remarks> + <seealso cref="M:Error(object)"/> + </member> + <member name="M:log4net.Core.LogImpl.ErrorFormat(System.String,System.Object[])"> + <summary> + Logs a formatted message string with the <c>ERROR</c> level. + </summary> + <param name="format">A String containing zero or more format items</param> + <param name="args">An Object array containing zero or more objects to format</param> + <remarks> + <para> + The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See + <c>String.Format</c> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/> + format provider. To specify a localized provider use the + <see cref="M:ErrorFormat(IFormatProvider,string,object[])"/> method. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/> + methods instead. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LogImpl.ErrorFormat(System.String,System.Object)"> + <summary> + Logs a formatted message string with the <c>ERROR</c> level. + </summary> + <param name="format">A String containing zero or more format items</param> + <param name="arg0">An Object to format</param> + <remarks> + <para> + The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See + <c>String.Format</c> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/> + format provider. To specify a localized provider use the + <see cref="M:ErrorFormat(IFormatProvider,string,object[])"/> method. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/> + methods instead. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LogImpl.ErrorFormat(System.String,System.Object,System.Object)"> + <summary> + Logs a formatted message string with the <c>ERROR</c> level. + </summary> + <param name="format">A String containing zero or more format items</param> + <param name="arg0">An Object to format</param> + <param name="arg1">An Object to format</param> + <remarks> + <para> + The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See + <c>String.Format</c> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/> + format provider. To specify a localized provider use the + <see cref="M:ErrorFormat(IFormatProvider,string,object[])"/> method. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/> + methods instead. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LogImpl.ErrorFormat(System.String,System.Object,System.Object,System.Object)"> + <summary> + Logs a formatted message string with the <c>ERROR</c> level. + </summary> + <param name="format">A String containing zero or more format items</param> + <param name="arg0">An Object to format</param> + <param name="arg1">An Object to format</param> + <param name="arg2">An Object to format</param> + <remarks> + <para> + The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See + <c>String.Format</c> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/> + format provider. To specify a localized provider use the + <see cref="M:ErrorFormat(IFormatProvider,string,object[])"/> method. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/> + methods instead. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LogImpl.ErrorFormat(System.IFormatProvider,System.String,System.Object[])"> + <summary> + Logs a formatted message string with the <c>ERROR</c> level. + </summary> + <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param> + <param name="format">A String containing zero or more format items</param> + <param name="args">An Object array containing zero or more objects to format</param> + <remarks> + <para> + The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See + <c>String.Format</c> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/> + methods instead. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LogImpl.Fatal(System.Object)"> + <summary> + Logs a message object with the <c>FATAL</c> level. + </summary> + <param name="message">The message object to log.</param> + <remarks> + <para> + This method first checks if this logger is <c>FATAL</c> + enabled by comparing the level of this logger with the + <c>FATAL</c> level. If this logger is + <c>FATAL</c> enabled, then it converts the message object + (passed as parameter) to a string by invoking the appropriate + <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then + proceeds to call all the registered appenders in this logger and + also higher in the hierarchy depending on the value of the + additivity flag. + </para> + <para> + <b>WARNING</b> Note that passing an <see cref="T:System.Exception"/> to this + method will print the name of the <see cref="T:System.Exception"/> but no + stack trace. To print a stack trace use the + <see cref="M:Fatal(object,Exception)"/> form instead. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LogImpl.Fatal(System.Object,System.Exception)"> + <summary> + Logs a message object with the <c>FATAL</c> level + </summary> + <param name="message">The message object to log.</param> + <param name="exception">The exception to log, including its stack trace.</param> + <remarks> + <para> + Logs a message object with the <c>FATAL</c> level including + the stack trace of the <see cref="T:System.Exception"/> <paramref name="exception"/> + passed as a parameter. + </para> + <para> + See the <see cref="M:Fatal(object)"/> form for more detailed information. + </para> + </remarks> + <seealso cref="M:Fatal(object)"/> + </member> + <member name="M:log4net.Core.LogImpl.FatalFormat(System.String,System.Object[])"> + <summary> + Logs a formatted message string with the <c>FATAL</c> level. + </summary> + <param name="format">A String containing zero or more format items</param> + <param name="args">An Object array containing zero or more objects to format</param> + <remarks> + <para> + The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See + <c>String.Format</c> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/> + format provider. To specify a localized provider use the + <see cref="M:FatalFormat(IFormatProvider,string,object[])"/> method. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/> + methods instead. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LogImpl.FatalFormat(System.String,System.Object)"> + <summary> + Logs a formatted message string with the <c>FATAL</c> level. + </summary> + <param name="format">A String containing zero or more format items</param> + <param name="arg0">An Object to format</param> + <remarks> + <para> + The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See + <c>String.Format</c> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/> + format provider. To specify a localized provider use the + <see cref="M:FatalFormat(IFormatProvider,string,object[])"/> method. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/> + methods instead. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LogImpl.FatalFormat(System.String,System.Object,System.Object)"> + <summary> + Logs a formatted message string with the <c>FATAL</c> level. + </summary> + <param name="format">A String containing zero or more format items</param> + <param name="arg0">An Object to format</param> + <param name="arg1">An Object to format</param> + <remarks> + <para> + The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See + <c>String.Format</c> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/> + format provider. To specify a localized provider use the + <see cref="M:FatalFormat(IFormatProvider,string,object[])"/> method. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/> + methods instead. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LogImpl.FatalFormat(System.String,System.Object,System.Object,System.Object)"> + <summary> + Logs a formatted message string with the <c>FATAL</c> level. + </summary> + <param name="format">A String containing zero or more format items</param> + <param name="arg0">An Object to format</param> + <param name="arg1">An Object to format</param> + <param name="arg2">An Object to format</param> + <remarks> + <para> + The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See + <c>String.Format</c> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/> + format provider. To specify a localized provider use the + <see cref="M:FatalFormat(IFormatProvider,string,object[])"/> method. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/> + methods instead. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LogImpl.FatalFormat(System.IFormatProvider,System.String,System.Object[])"> + <summary> + Logs a formatted message string with the <c>FATAL</c> level. + </summary> + <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param> + <param name="format">A String containing zero or more format items</param> + <param name="args">An Object array containing zero or more objects to format</param> + <remarks> + <para> + The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See + <c>String.Format</c> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/> + methods instead. + </para> + </remarks> + </member> + <member name="M:log4net.Core.LogImpl.LoggerRepositoryConfigurationChanged(System.Object,System.EventArgs)"> + <summary> + Event handler for the <see cref="E:log4net.Repository.ILoggerRepository.ConfigurationChanged"/> event + </summary> + <param name="sender">the repository</param> + <param name="e">Empty</param> + </member> + <member name="F:log4net.Core.LogImpl.ThisDeclaringType"> + <summary> + The fully qualified name of this declaring type not the type of any subclass. + </summary> + </member> + <member name="P:log4net.Core.LogImpl.IsDebugEnabled"> + <summary> + Checks if this logger is enabled for the <c>DEBUG</c> + level. + </summary> + <value> + <c>true</c> if this logger is enabled for <c>DEBUG</c> events, + <c>false</c> otherwise. + </value> + <remarks> + <para> + This function is intended to lessen the computational cost of + disabled log debug statements. + </para> + <para> + For some <c>log</c> Logger object, when you write: + </para> + <code lang="C#"> + log.Debug("This is entry number: " + i ); + </code> + <para> + You incur the cost constructing the message, concatenation in + this case, regardless of whether the message is logged or not. + </para> + <para> + If you are worried about speed, then you should write: + </para> + <code lang="C#"> + if (log.IsDebugEnabled()) + { + log.Debug("This is entry number: " + i ); + } + </code> + <para> + This way you will not incur the cost of parameter + construction if debugging is disabled for <c>log</c>. On + the other hand, if the <c>log</c> is debug enabled, you + will incur the cost of evaluating whether the logger is debug + enabled twice. Once in <c>IsDebugEnabled</c> and once in + the <c>Debug</c>. This is an insignificant overhead + since evaluating a logger takes about 1% of the time it + takes to actually log. + </para> + </remarks> + </member> + <member name="P:log4net.Core.LogImpl.IsInfoEnabled"> + <summary> + Checks if this logger is enabled for the <c>INFO</c> level. + </summary> + <value> + <c>true</c> if this logger is enabled for <c>INFO</c> events, + <c>false</c> otherwise. + </value> + <remarks> + <para> + See <see cref="P:log4net.Core.LogImpl.IsDebugEnabled"/> for more information and examples + of using this method. + </para> + </remarks> + <seealso cref="P:log4net.Core.LogImpl.IsDebugEnabled"/> + </member> + <member name="P:log4net.Core.LogImpl.IsWarnEnabled"> + <summary> + Checks if this logger is enabled for the <c>WARN</c> level. + </summary> + <value> + <c>true</c> if this logger is enabled for <c>WARN</c> events, + <c>false</c> otherwise. + </value> + <remarks> + <para> + See <see cref="P:log4net.Core.LogImpl.IsDebugEnabled"/> for more information and examples + of using this method. + </para> + </remarks> + <seealso cref="P:log4net.ILog.IsDebugEnabled"/> + </member> + <member name="P:log4net.Core.LogImpl.IsErrorEnabled"> + <summary> + Checks if this logger is enabled for the <c>ERROR</c> level. + </summary> + <value> + <c>true</c> if this logger is enabled for <c>ERROR</c> events, + <c>false</c> otherwise. + </value> + <remarks> + <para> + See <see cref="P:log4net.Core.LogImpl.IsDebugEnabled"/> for more information and examples of using this method. + </para> + </remarks> + <seealso cref="P:log4net.ILog.IsDebugEnabled"/> + </member> + <member name="P:log4net.Core.LogImpl.IsFatalEnabled"> + <summary> + Checks if this logger is enabled for the <c>FATAL</c> level. + </summary> + <value> + <c>true</c> if this logger is enabled for <c>FATAL</c> events, + <c>false</c> otherwise. + </value> + <remarks> + <para> + See <see cref="P:log4net.Core.LogImpl.IsDebugEnabled"/> for more information and examples of using this method. + </para> + </remarks> + <seealso cref="P:log4net.ILog.IsDebugEnabled"/> + </member> + <member name="T:log4net.Core.MethodItem"> + <summary> + provides method information without actually referencing a System.Reflection.MethodBase + as that would require that the containing assembly is loaded. + </summary> + + </member> + <member name="F:log4net.Core.MethodItem.NA"> + <summary> + When location information is not available the constant + <c>NA</c> is returned. Current value of this string + constant is <b>?</b>. + </summary> + </member> + <member name="M:log4net.Core.MethodItem.#ctor"> + <summary> + constructs a method item for an unknown method. + </summary> + </member> + <member name="M:log4net.Core.MethodItem.#ctor(System.String)"> + <summary> + constructs a method item from the name of the method. + </summary> + <param name="name"></param> + </member> + <member name="M:log4net.Core.MethodItem.#ctor(System.String,System.String[])"> + <summary> + constructs a method item from the name of the method and its parameters. + </summary> + <param name="name"></param> + <param name="parameters"></param> + </member> + <member name="M:log4net.Core.MethodItem.#ctor(System.Reflection.MethodBase)"> + <summary> + constructs a method item from a method base by determining the method name and its parameters. + </summary> + <param name="methodBase"></param> + </member> + <member name="F:log4net.Core.MethodItem.declaringType"> + <summary> + The fully qualified type of the StackFrameItem class. + </summary> + <remarks> + Used by the internal logger to record the Type of the + log message. + </remarks> + </member> + <member name="P:log4net.Core.MethodItem.Name"> + <summary> + Gets the method name of the caller making the logging + request. + </summary> + <value> + The method name of the caller making the logging + request. + </value> + <remarks> + <para> + Gets the method name of the caller making the logging + request. + </para> + </remarks> + </member> + <member name="P:log4net.Core.MethodItem.Parameters"> + <summary> + Gets the method parameters of the caller making + the logging request. + </summary> + <value> + The method parameters of the caller making + the logging request + </value> + <remarks> + <para> + Gets the method parameters of the caller making + the logging request. + </para> + </remarks> + </member> + <member name="T:log4net.Core.SecurityContext"> + <summary> + A SecurityContext used by log4net when interacting with protected resources + </summary> + <remarks> + <para> + A SecurityContext used by log4net when interacting with protected resources + for example with operating system services. This can be used to impersonate + a principal that has been granted privileges on the system resources. + </para> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="M:log4net.Core.SecurityContext.Impersonate(System.Object)"> + <summary> + Impersonate this SecurityContext + </summary> + <param name="state">State supplied by the caller</param> + <returns>An <see cref="T:System.IDisposable"/> instance that will + revoke the impersonation of this SecurityContext, or <c>null</c></returns> + <remarks> + <para> + Impersonate this security context. Further calls on the current + thread should now be made in the security context provided + by this object. When the <see cref="T:System.IDisposable"/> result + <see cref="M:System.IDisposable.Dispose"/> method is called the security + context of the thread should be reverted to the state it was in + before <see cref="M:log4net.Core.SecurityContext.Impersonate(System.Object)"/> was called. + </para> + </remarks> + </member> + <member name="T:log4net.Core.SecurityContextProvider"> + <summary> + The <see cref="T:log4net.Core.SecurityContextProvider"/> providers default <see cref="T:log4net.Core.SecurityContext"/> instances. + </summary> + <remarks> + <para> + A configured component that interacts with potentially protected system + resources uses a <see cref="T:log4net.Core.SecurityContext"/> to provide the elevated + privileges required. If the <see cref="T:log4net.Core.SecurityContext"/> object has + been not been explicitly provided to the component then the component + will request one from this <see cref="T:log4net.Core.SecurityContextProvider"/>. + </para> + <para> + By default the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is + an instance of <see cref="T:log4net.Core.SecurityContextProvider"/> which returns only + <see cref="T:log4net.Util.NullSecurityContext"/> objects. This is a reasonable default + where the privileges required are not know by the system. + </para> + <para> + This default behavior can be overridden by subclassing the <see cref="T:log4net.Core.SecurityContextProvider"/> + and overriding the <see cref="M:log4net.Core.SecurityContextProvider.CreateSecurityContext(System.Object)"/> method to return + the desired <see cref="T:log4net.Core.SecurityContext"/> objects. The default provider + can be replaced by programmatically setting the value of the + <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> property. + </para> + <para> + An alternative is to use the <c>log4net.Config.SecurityContextProviderAttribute</c> + This attribute can be applied to an assembly in the same way as the + <c>log4net.Config.XmlConfiguratorAttribute"</c>. The attribute takes + the type to use as the <see cref="T:log4net.Core.SecurityContextProvider"/> as an argument. + </para> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="F:log4net.Core.SecurityContextProvider.s_defaultProvider"> + <summary> + The default provider + </summary> + </member> + <member name="M:log4net.Core.SecurityContextProvider.#ctor"> + <summary> + Protected default constructor to allow subclassing + </summary> + <remarks> + <para> + Protected default constructor to allow subclassing + </para> + </remarks> + </member> + <member name="M:log4net.Core.SecurityContextProvider.CreateSecurityContext(System.Object)"> + <summary> + Create a SecurityContext for a consumer + </summary> + <param name="consumer">The consumer requesting the SecurityContext</param> + <returns>An impersonation context</returns> + <remarks> + <para> + The default implementation is to return a <see cref="T:log4net.Util.NullSecurityContext"/>. + </para> + <para> + Subclasses should override this method to provide their own + behavior. + </para> + </remarks> + </member> + <member name="P:log4net.Core.SecurityContextProvider.DefaultProvider"> + <summary> + Gets or sets the default SecurityContextProvider + </summary> + <value> + The default SecurityContextProvider + </value> + <remarks> + <para> + The default provider is used by configured components that + require a <see cref="T:log4net.Core.SecurityContext"/> and have not had one + given to them. + </para> + <para> + By default this is an instance of <see cref="T:log4net.Core.SecurityContextProvider"/> + that returns <see cref="T:log4net.Util.NullSecurityContext"/> objects. + </para> + <para> + The default provider can be set programmatically by setting + the value of this property to a sub class of <see cref="T:log4net.Core.SecurityContextProvider"/> + that has the desired behavior. + </para> + </remarks> + </member> + <member name="T:log4net.Core.StackFrameItem"> + <summary> + provides stack frame information without actually referencing a System.Diagnostics.StackFrame + as that would require that the containing assembly is loaded. + </summary> + + </member> + <member name="F:log4net.Core.StackFrameItem.NA"> + <summary> + When location information is not available the constant + <c>NA</c> is returned. Current value of this string + constant is <b>?</b>. + </summary> + </member> + <member name="M:log4net.Core.StackFrameItem.#ctor(System.Diagnostics.StackFrame)"> + <summary> + returns a stack frame item from a stack frame. This + </summary> + <param name="frame"></param> + <returns></returns> + </member> + <member name="F:log4net.Core.StackFrameItem.declaringType"> + <summary> + The fully qualified type of the StackFrameItem class. + </summary> + <remarks> + Used by the internal logger to record the Type of the + log message. + </remarks> + </member> + <member name="P:log4net.Core.StackFrameItem.ClassName"> + <summary> + Gets the fully qualified class name of the caller making the logging + request. + </summary> + <value> + The fully qualified class name of the caller making the logging + request. + </value> + <remarks> + <para> + Gets the fully qualified class name of the caller making the logging + request. + </para> + </remarks> + </member> + <member name="P:log4net.Core.StackFrameItem.FileName"> + <summary> + Gets the file name of the caller. + </summary> + <value> + The file name of the caller. + </value> + <remarks> + <para> + Gets the file name of the caller. + </para> + </remarks> + </member> + <member name="P:log4net.Core.StackFrameItem.LineNumber"> + <summary> + Gets the line number of the caller. + </summary> + <value> + The line number of the caller. + </value> + <remarks> + <para> + Gets the line number of the caller. + </para> + </remarks> + </member> + <member name="P:log4net.Core.StackFrameItem.Method"> + <summary> + Gets the method name of the caller. + </summary> + <value> + The method name of the caller. + </value> + <remarks> + <para> + Gets the method name of the caller. + </para> + </remarks> + </member> + <member name="P:log4net.Core.StackFrameItem.FullInfo"> + <summary> + Gets all available caller information + </summary> + <value> + All available caller information, in the format + <c>fully.qualified.classname.of.caller.methodName(Filename:line)</c> + </value> + <remarks> + <para> + Gets all available caller information, in the format + <c>fully.qualified.classname.of.caller.methodName(Filename:line)</c> + </para> + </remarks> + </member> + <member name="T:log4net.Core.TimeEvaluator"> + <summary> + An evaluator that triggers after specified number of seconds. + </summary> + <remarks> + <para> + This evaluator will trigger if the specified time period + <see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check. + </para> + </remarks> + <author>Robert Sevcik</author> + </member> + <member name="F:log4net.Core.TimeEvaluator.DEFAULT_INTERVAL"> + <summary> + The default time threshold for triggering in seconds. Zero means it won't trigger at all. + </summary> + </member> + <member name="F:log4net.Core.TimeEvaluator.m_interval"> + <summary> + The time threshold for triggering in seconds. Zero means it won't trigger at all. + </summary> + </member> + <member name="F:log4net.Core.TimeEvaluator.m_lasttime"> + <summary> + The time of last check. This gets updated when the object is created and when the evaluator triggers. + </summary> + </member> + <member name="M:log4net.Core.TimeEvaluator.#ctor"> + <summary> + Create a new evaluator using the <see cref="F:log4net.Core.TimeEvaluator.DEFAULT_INTERVAL"/> time threshold in seconds. + </summary> + <remarks> + <para> + Create a new evaluator using the <see cref="F:log4net.Core.TimeEvaluator.DEFAULT_INTERVAL"/> time threshold in seconds. + </para> + <para> + This evaluator will trigger if the specified time period + <see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check. + </para> + </remarks> + </member> + <member name="M:log4net.Core.TimeEvaluator.#ctor(System.Int32)"> + <summary> + Create a new evaluator using the specified time threshold in seconds. + </summary> + <param name="interval"> + The time threshold in seconds to trigger after. + Zero means it won't trigger at all. + </param> + <remarks> + <para> + Create a new evaluator using the specified time threshold in seconds. + </para> + <para> + This evaluator will trigger if the specified time period + <see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check. + </para> + </remarks> + </member> + <member name="M:log4net.Core.TimeEvaluator.IsTriggeringEvent(log4net.Core.LoggingEvent)"> + <summary> + Is this <paramref name="loggingEvent"/> the triggering event? + </summary> + <param name="loggingEvent">The event to check</param> + <returns>This method returns <c>true</c>, if the specified time period + <see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check.. + Otherwise it returns <c>false</c></returns> + <remarks> + <para> + This evaluator will trigger if the specified time period + <see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check. + </para> + </remarks> + </member> + <member name="P:log4net.Core.TimeEvaluator.Interval"> + <summary> + The time threshold in seconds to trigger after + </summary> + <value> + The time threshold in seconds to trigger after. + Zero means it won't trigger at all. + </value> + <remarks> + <para> + This evaluator will trigger if the specified time period + <see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check. + </para> + </remarks> + </member> + <member name="T:log4net.Core.WrapperCreationHandler"> + <summary> + Delegate used to handle creation of new wrappers. + </summary> + <param name="logger">The logger to wrap in a wrapper.</param> + <remarks> + <para> + Delegate used to handle creation of new wrappers. This delegate + is called from the <see cref="M:log4net.Core.WrapperMap.CreateNewWrapperObject(log4net.Core.ILogger)"/> + method to construct the wrapper for the specified logger. + </para> + <para> + The delegate to use is supplied to the <see cref="T:log4net.Core.WrapperMap"/> + constructor. + </para> + </remarks> + </member> + <member name="T:log4net.Core.WrapperMap"> + <summary> + Maps between logger objects and wrapper objects. + </summary> + <remarks> + <para> + This class maintains a mapping between <see cref="T:log4net.Core.ILogger"/> objects and + <see cref="T:log4net.Core.ILoggerWrapper"/> objects. Use the <see cref="M:log4net.Core.WrapperMap.GetWrapper(log4net.Core.ILogger)"/> method to + lookup the <see cref="T:log4net.Core.ILoggerWrapper"/> for the specified <see cref="T:log4net.Core.ILogger"/>. + </para> + <para> + New wrapper instances are created by the <see cref="M:log4net.Core.WrapperMap.CreateNewWrapperObject(log4net.Core.ILogger)"/> + method. The default behavior is for this method to delegate construction + of the wrapper to the <see cref="T:log4net.Core.WrapperCreationHandler"/> delegate supplied + to the constructor. This allows specialization of the behavior without + requiring subclassing of this type. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Core.WrapperMap.#ctor(log4net.Core.WrapperCreationHandler)"> + <summary> + Initializes a new instance of the <see cref="T:log4net.Core.WrapperMap"/> + </summary> + <param name="createWrapperHandler">The handler to use to create the wrapper objects.</param> + <remarks> + <para> + Initializes a new instance of the <see cref="T:log4net.Core.WrapperMap"/> class with + the specified handler to create the wrapper objects. + </para> + </remarks> + </member> + <member name="M:log4net.Core.WrapperMap.GetWrapper(log4net.Core.ILogger)"> + <summary> + Gets the wrapper object for the specified logger. + </summary> + <returns>The wrapper object for the specified logger</returns> + <remarks> + <para> + If the logger is null then the corresponding wrapper is null. + </para> + <para> + Looks up the wrapper it it has previously been requested and + returns it. If the wrapper has never been requested before then + the <see cref="M:log4net.Core.WrapperMap.CreateNewWrapperObject(log4net.Core.ILogger)"/> virtual method is + called. + </para> + </remarks> + </member> + <member name="M:log4net.Core.WrapperMap.CreateNewWrapperObject(log4net.Core.ILogger)"> + <summary> + Creates the wrapper object for the specified logger. + </summary> + <param name="logger">The logger to wrap in a wrapper.</param> + <returns>The wrapper object for the logger.</returns> + <remarks> + <para> + This implementation uses the <see cref="T:log4net.Core.WrapperCreationHandler"/> + passed to the constructor to create the wrapper. This method + can be overridden in a subclass. + </para> + </remarks> + </member> + <member name="M:log4net.Core.WrapperMap.RepositoryShutdown(log4net.Repository.ILoggerRepository)"> + <summary> + Called when a monitored repository shutdown event is received. + </summary> + <param name="repository">The <see cref="T:log4net.Repository.ILoggerRepository"/> that is shutting down</param> + <remarks> + <para> + This method is called when a <see cref="T:log4net.Repository.ILoggerRepository"/> that this + <see cref="T:log4net.Core.WrapperMap"/> is holding loggers for has signaled its shutdown + event <see cref="E:log4net.Repository.ILoggerRepository.ShutdownEvent"/>. The default + behavior of this method is to release the references to the loggers + and their wrappers generated for this repository. + </para> + </remarks> + </member> + <member name="M:log4net.Core.WrapperMap.ILoggerRepository_Shutdown(System.Object,System.EventArgs)"> + <summary> + Event handler for repository shutdown event. + </summary> + <param name="sender">The sender of the event.</param> + <param name="e">The event args.</param> + </member> + <member name="F:log4net.Core.WrapperMap.m_repositories"> + <summary> + Map of logger repositories to hashtables of ILogger to ILoggerWrapper mappings + </summary> + </member> + <member name="F:log4net.Core.WrapperMap.m_createWrapperHandler"> + <summary> + The handler to use to create the extension wrapper objects. + </summary> + </member> + <member name="F:log4net.Core.WrapperMap.m_shutdownHandler"> + <summary> + Internal reference to the delegate used to register for repository shutdown events. + </summary> + </member> + <member name="P:log4net.Core.WrapperMap.Repositories"> + <summary> + Gets the map of logger repositories. + </summary> + <value> + Map of logger repositories. + </value> + <remarks> + <para> + Gets the hashtable that is keyed on <see cref="T:log4net.Repository.ILoggerRepository"/>. The + values are hashtables keyed on <see cref="T:log4net.Core.ILogger"/> with the + value being the corresponding <see cref="T:log4net.Core.ILoggerWrapper"/>. + </para> + </remarks> + </member> + <member name="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"> + <summary> + Formats a <see cref="T:System.DateTime"/> as <c>"HH:mm:ss,fff"</c>. + </summary> + <remarks> + <para> + Formats a <see cref="T:System.DateTime"/> in the format <c>"HH:mm:ss,fff"</c> for example, <c>"15:49:37,459"</c>. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="T:log4net.DateFormatter.IDateFormatter"> + <summary> + Render a <see cref="T:System.DateTime"/> as a string. + </summary> + <remarks> + <para> + Interface to abstract the rendering of a <see cref="T:System.DateTime"/> + instance into a string. + </para> + <para> + The <see cref="M:log4net.DateFormatter.IDateFormatter.FormatDate(System.DateTime,System.IO.TextWriter)"/> method is used to render the + date to a text writer. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.DateFormatter.IDateFormatter.FormatDate(System.DateTime,System.IO.TextWriter)"> + <summary> + Formats the specified date as a string. + </summary> + <param name="dateToFormat">The date to format.</param> + <param name="writer">The writer to write to.</param> + <remarks> + <para> + Format the <see cref="T:System.DateTime"/> as a string and write it + to the <see cref="T:System.IO.TextWriter"/> provided. + </para> + </remarks> + </member> + <member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.AbsoluteTimeDateFormat"> + <summary> + String constant used to specify AbsoluteTimeDateFormat in layouts. Current value is <b>ABSOLUTE</b>. + </summary> + </member> + <member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.DateAndTimeDateFormat"> + <summary> + String constant used to specify DateTimeDateFormat in layouts. Current value is <b>DATE</b>. + </summary> + </member> + <member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.Iso8601TimeDateFormat"> + <summary> + String constant used to specify ISO8601DateFormat in layouts. Current value is <b>ISO8601</b>. + </summary> + </member> + <member name="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)"> + <summary> + Renders the date into a string. Format is <c>"HH:mm:ss"</c>. + </summary> + <param name="dateToFormat">The date to render into a string.</param> + <param name="buffer">The string builder to write to.</param> + <remarks> + <para> + Subclasses should override this method to render the date + into a string using a precision up to the second. This method + will be called at most once per second and the result will be + reused if it is needed again during the same second. + </para> + </remarks> + </member> + <member name="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDate(System.DateTime,System.IO.TextWriter)"> + <summary> + Renders the date into a string. Format is "HH:mm:ss,fff". + </summary> + <param name="dateToFormat">The date to render into a string.</param> + <param name="writer">The writer to write to.</param> + <remarks> + <para> + Uses the <see cref="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)"/> method to generate the + time string up to the seconds and then appends the current + milliseconds. The results from <see cref="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)"/> are + cached and <see cref="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)"/> is called at most once + per second. + </para> + <para> + Sub classes should override <see cref="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)"/> + rather than <see cref="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDate(System.DateTime,System.IO.TextWriter)"/>. + </para> + </remarks> + </member> + <member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.s_lastTimeToTheSecond"> + <summary> + Last stored time with precision up to the second. + </summary> + </member> + <member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.s_lastTimeBuf"> + <summary> + Last stored time with precision up to the second, formatted + as a string. + </summary> + </member> + <member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.s_lastTimeStrings"> + <summary> + Last stored time with precision up to the second, formatted + as a string. + </summary> + </member> + <member name="T:log4net.DateFormatter.DateTimeDateFormatter"> + <summary> + Formats a <see cref="T:System.DateTime"/> as <c>"dd MMM yyyy HH:mm:ss,fff"</c> + </summary> + <remarks> + <para> + Formats a <see cref="T:System.DateTime"/> in the format + <c>"dd MMM yyyy HH:mm:ss,fff"</c> for example, + <c>"06 Nov 1994 15:49:37,459"</c>. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + <author>Angelika Schnagl</author> + </member> + <member name="M:log4net.DateFormatter.DateTimeDateFormatter.#ctor"> + <summary> + Default constructor. + </summary> + <remarks> + <para> + Initializes a new instance of the <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> class. + </para> + </remarks> + </member> + <member name="M:log4net.DateFormatter.DateTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)"> + <summary> + Formats the date without the milliseconds part + </summary> + <param name="dateToFormat">The date to format.</param> + <param name="buffer">The string builder to write to.</param> + <remarks> + <para> + Formats a DateTime in the format <c>"dd MMM yyyy HH:mm:ss"</c> + for example, <c>"06 Nov 1994 15:49:37"</c>. + </para> + <para> + The base class will append the <c>",fff"</c> milliseconds section. + This method will only be called at most once per second. + </para> + </remarks> + </member> + <member name="F:log4net.DateFormatter.DateTimeDateFormatter.m_dateTimeFormatInfo"> + <summary> + The format info for the invariant culture. + </summary> + </member> + <member name="T:log4net.DateFormatter.Iso8601DateFormatter"> + <summary> + Formats the <see cref="T:System.DateTime"/> as <c>"yyyy-MM-dd HH:mm:ss,fff"</c>. + </summary> + <remarks> + <para> + Formats the <see cref="T:System.DateTime"/> specified as a string: <c>"yyyy-MM-dd HH:mm:ss,fff"</c>. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.DateFormatter.Iso8601DateFormatter.#ctor"> + <summary> + Default constructor + </summary> + <remarks> + <para> + Initializes a new instance of the <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/> class. + </para> + </remarks> + </member> + <member name="M:log4net.DateFormatter.Iso8601DateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)"> + <summary> + Formats the date without the milliseconds part + </summary> + <param name="dateToFormat">The date to format.</param> + <param name="buffer">The string builder to write to.</param> + <remarks> + <para> + Formats the date specified as a string: <c>"yyyy-MM-dd HH:mm:ss"</c>. + </para> + <para> + The base class will append the <c>",fff"</c> milliseconds section. + This method will only be called at most once per second. + </para> + </remarks> + </member> + <member name="T:log4net.DateFormatter.SimpleDateFormatter"> + <summary> + Formats the <see cref="T:System.DateTime"/> using the <see cref="M:DateTime.ToString(string, IFormatProvider)"/> method. + </summary> + <remarks> + <para> + Formats the <see cref="T:System.DateTime"/> using the <see cref="T:System.DateTime"/> <see cref="M:DateTime.ToString(string, IFormatProvider)"/> method. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.DateFormatter.SimpleDateFormatter.#ctor(System.String)"> + <summary> + Constructor + </summary> + <param name="format">The format string.</param> + <remarks> + <para> + Initializes a new instance of the <see cref="T:log4net.DateFormatter.SimpleDateFormatter"/> class + with the specified format string. + </para> + <para> + The format string must be compatible with the options + that can be supplied to <see cref="M:DateTime.ToString(string, IFormatProvider)"/>. + </para> + </remarks> + </member> + <member name="M:log4net.DateFormatter.SimpleDateFormatter.FormatDate(System.DateTime,System.IO.TextWriter)"> + <summary> + Formats the date using <see cref="M:DateTime.ToString(string, IFormatProvider)"/>. + </summary> + <param name="dateToFormat">The date to convert to a string.</param> + <param name="writer">The writer to write to.</param> + <remarks> + <para> + Uses the date format string supplied to the constructor to call + the <see cref="M:DateTime.ToString(string, IFormatProvider)"/> method to format the date. + </para> + </remarks> + </member> + <member name="F:log4net.DateFormatter.SimpleDateFormatter.m_formatString"> + <summary> + The format string used to format the <see cref="T:System.DateTime"/>. + </summary> + <remarks> + <para> + The format string must be compatible with the options + that can be supplied to <see cref="M:DateTime.ToString(string, IFormatProvider)"/>. + </para> + </remarks> + </member> + <member name="T:log4net.Filter.DenyAllFilter"> + <summary> + This filter drops all <see cref="T:log4net.Core.LoggingEvent"/>. + </summary> + <remarks> + <para> + You can add this filter to the end of a filter chain to + switch from the default "accept all unless instructed otherwise" + filtering behavior to a "deny all unless instructed otherwise" + behavior. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="T:log4net.Filter.FilterSkeleton"> + <summary> + Subclass this type to implement customized logging event filtering + </summary> + <remarks> + <para> + Users should extend this class to implement customized logging + event filtering. Note that <see cref="T:log4net.Repository.Hierarchy.Logger"/> and + <see cref="T:log4net.Appender.AppenderSkeleton"/>, the parent class of all standard + appenders, have built-in filtering rules. It is suggested that you + first use and understand the built-in rules before rushing to write + your own custom filters. + </para> + <para> + This abstract class assumes and also imposes that filters be + organized in a linear chain. The <see cref="M:log4net.Filter.FilterSkeleton.Decide(log4net.Core.LoggingEvent)"/> + method of each filter is called sequentially, in the order of their + addition to the chain. + </para> + <para> + The <see cref="M:log4net.Filter.FilterSkeleton.Decide(log4net.Core.LoggingEvent)"/> method must return one + of the integer constants <see cref="F:log4net.Filter.FilterDecision.Deny"/>, + <see cref="F:log4net.Filter.FilterDecision.Neutral"/> or <see cref="F:log4net.Filter.FilterDecision.Accept"/>. + </para> + <para> + If the value <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned, then the log event is dropped + immediately without consulting with the remaining filters. + </para> + <para> + If the value <see cref="F:log4net.Filter.FilterDecision.Neutral"/> is returned, then the next filter + in the chain is consulted. If there are no more filters in the + chain, then the log event is logged. Thus, in the presence of no + filters, the default behavior is to log all logging events. + </para> + <para> + If the value <see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned, then the log + event is logged without consulting the remaining filters. + </para> + <para> + The philosophy of log4net filters is largely inspired from the + Linux ipchains. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="T:log4net.Filter.IFilter"> + <summary> + Implement this interface to provide customized logging event filtering + </summary> + <remarks> + <para> + Users should implement this interface to implement customized logging + event filtering. Note that <see cref="T:log4net.Repository.Hierarchy.Logger"/> and + <see cref="T:log4net.Appender.AppenderSkeleton"/>, the parent class of all standard + appenders, have built-in filtering rules. It is suggested that you + first use and understand the built-in rules before rushing to write + your own custom filters. + </para> + <para> + This abstract class assumes and also imposes that filters be + organized in a linear chain. The <see cref="M:log4net.Filter.IFilter.Decide(log4net.Core.LoggingEvent)"/> + method of each filter is called sequentially, in the order of their + addition to the chain. + </para> + <para> + The <see cref="M:log4net.Filter.IFilter.Decide(log4net.Core.LoggingEvent)"/> method must return one + of the integer constants <see cref="F:log4net.Filter.FilterDecision.Deny"/>, + <see cref="F:log4net.Filter.FilterDecision.Neutral"/> or <see cref="F:log4net.Filter.FilterDecision.Accept"/>. + </para> + <para> + If the value <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned, then the log event is dropped + immediately without consulting with the remaining filters. + </para> + <para> + If the value <see cref="F:log4net.Filter.FilterDecision.Neutral"/> is returned, then the next filter + in the chain is consulted. If there are no more filters in the + chain, then the log event is logged. Thus, in the presence of no + filters, the default behavior is to log all logging events. + </para> + <para> + If the value <see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned, then the log + event is logged without consulting the remaining filters. + </para> + <para> + The philosophy of log4net filters is largely inspired from the + Linux ipchains. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Filter.IFilter.Decide(log4net.Core.LoggingEvent)"> + <summary> + Decide if the logging event should be logged through an appender. + </summary> + <param name="loggingEvent">The LoggingEvent to decide upon</param> + <returns>The decision of the filter</returns> + <remarks> + <para> + If the decision is <see cref="F:log4net.Filter.FilterDecision.Deny"/>, then the event will be + dropped. If the decision is <see cref="F:log4net.Filter.FilterDecision.Neutral"/>, then the next + filter, if any, will be invoked. If the decision is <see cref="F:log4net.Filter.FilterDecision.Accept"/> then + the event will be logged without consulting with other filters in + the chain. + </para> + </remarks> + </member> + <member name="P:log4net.Filter.IFilter.Next"> + <summary> + Property to get and set the next filter + </summary> + <value> + The next filter in the chain + </value> + <remarks> + <para> + Filters are typically composed into chains. This property allows the next filter in + the chain to be accessed. + </para> + </remarks> + </member> + <member name="F:log4net.Filter.FilterSkeleton.m_next"> + <summary> + Points to the next filter in the filter chain. + </summary> + <remarks> + <para> + See <see cref="P:log4net.Filter.FilterSkeleton.Next"/> for more information. + </para> + </remarks> + </member> + <member name="M:log4net.Filter.FilterSkeleton.ActivateOptions"> + <summary> + Initialize the filter with the options set + </summary> + <remarks> + <para> + This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object + activation scheme. The <see cref="M:log4net.Filter.FilterSkeleton.ActivateOptions"/> method must + be called on this object after the configuration properties have + been set. Until <see cref="M:log4net.Filter.FilterSkeleton.ActivateOptions"/> is called this + object is in an undefined state and must not be used. + </para> + <para> + If any of the configuration properties are modified then + <see cref="M:log4net.Filter.FilterSkeleton.ActivateOptions"/> must be called again. + </para> + <para> + Typically filter's options become active immediately on set, + however this method must still be called. + </para> + </remarks> + </member> + <member name="M:log4net.Filter.FilterSkeleton.Decide(log4net.Core.LoggingEvent)"> + <summary> + Decide if the <see cref="T:log4net.Core.LoggingEvent"/> should be logged through an appender. + </summary> + <param name="loggingEvent">The <see cref="T:log4net.Core.LoggingEvent"/> to decide upon</param> + <returns>The decision of the filter</returns> + <remarks> + <para> + If the decision is <see cref="F:log4net.Filter.FilterDecision.Deny"/>, then the event will be + dropped. If the decision is <see cref="F:log4net.Filter.FilterDecision.Neutral"/>, then the next + filter, if any, will be invoked. If the decision is <see cref="F:log4net.Filter.FilterDecision.Accept"/> then + the event will be logged without consulting with other filters in + the chain. + </para> + <para> + This method is marked <c>abstract</c> and must be implemented + in a subclass. + </para> + </remarks> + </member> + <member name="P:log4net.Filter.FilterSkeleton.Next"> + <summary> + Property to get and set the next filter + </summary> + <value> + The next filter in the chain + </value> + <remarks> + <para> + Filters are typically composed into chains. This property allows the next filter in + the chain to be accessed. + </para> + </remarks> + </member> + <member name="M:log4net.Filter.DenyAllFilter.#ctor"> + <summary> + Default constructor + </summary> + </member> + <member name="M:log4net.Filter.DenyAllFilter.Decide(log4net.Core.LoggingEvent)"> + <summary> + Always returns the integer constant <see cref="F:log4net.Filter.FilterDecision.Deny"/> + </summary> + <param name="loggingEvent">the LoggingEvent to filter</param> + <returns>Always returns <see cref="F:log4net.Filter.FilterDecision.Deny"/></returns> + <remarks> + <para> + Ignores the event being logged and just returns + <see cref="F:log4net.Filter.FilterDecision.Deny"/>. This can be used to change the default filter + chain behavior from <see cref="F:log4net.Filter.FilterDecision.Accept"/> to <see cref="F:log4net.Filter.FilterDecision.Deny"/>. This filter + should only be used as the last filter in the chain + as any further filters will be ignored! + </para> + </remarks> + </member> + <member name="T:log4net.Filter.FilterDecision"> + <summary> + The return result from <see cref="M:log4net.Filter.IFilter.Decide(log4net.Core.LoggingEvent)"/> + </summary> + <remarks> + <para> + The return result from <see cref="M:log4net.Filter.IFilter.Decide(log4net.Core.LoggingEvent)"/> + </para> + </remarks> + </member> + <member name="F:log4net.Filter.FilterDecision.Deny"> + <summary> + The log event must be dropped immediately without + consulting with the remaining filters, if any, in the chain. + </summary> + </member> + <member name="F:log4net.Filter.FilterDecision.Neutral"> + <summary> + This filter is neutral with respect to the log event. + The remaining filters, if any, should be consulted for a final decision. + </summary> + </member> + <member name="F:log4net.Filter.FilterDecision.Accept"> + <summary> + The log event must be logged immediately without + consulting with the remaining filters, if any, in the chain. + </summary> + </member> + <member name="T:log4net.Filter.LevelMatchFilter"> + <summary> + This is a very simple filter based on <see cref="T:log4net.Core.Level"/> matching. + </summary> + <remarks> + <para> + The filter admits two options <see cref="P:log4net.Filter.LevelMatchFilter.LevelToMatch"/> and + <see cref="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch"/>. If there is an exact match between the value + of the <see cref="P:log4net.Filter.LevelMatchFilter.LevelToMatch"/> option and the <see cref="T:log4net.Core.Level"/> of the + <see cref="T:log4net.Core.LoggingEvent"/>, then the <see cref="M:log4net.Filter.LevelMatchFilter.Decide(log4net.Core.LoggingEvent)"/> method returns <see cref="F:log4net.Filter.FilterDecision.Accept"/> in + case the <see cref="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch"/> option value is set + to <c>true</c>, if it is <c>false</c> then + <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned. If the <see cref="T:log4net.Core.Level"/> does not match then + the result will be <see cref="F:log4net.Filter.FilterDecision.Neutral"/>. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="F:log4net.Filter.LevelMatchFilter.m_acceptOnMatch"> + <summary> + flag to indicate if the filter should <see cref="F:log4net.Filter.FilterDecision.Accept"/> on a match + </summary> + </member> + <member name="F:log4net.Filter.LevelMatchFilter.m_levelToMatch"> + <summary> + the <see cref="T:log4net.Core.Level"/> to match against + </summary> + </member> + <member name="M:log4net.Filter.LevelMatchFilter.#ctor"> + <summary> + Default constructor + </summary> + </member> + <member name="M:log4net.Filter.LevelMatchFilter.Decide(log4net.Core.LoggingEvent)"> + <summary> + Tests if the <see cref="T:log4net.Core.Level"/> of the logging event matches that of the filter + </summary> + <param name="loggingEvent">the event to filter</param> + <returns>see remarks</returns> + <remarks> + <para> + If the <see cref="T:log4net.Core.Level"/> of the event matches the level of the + filter then the result of the function depends on the + value of <see cref="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch"/>. If it is true then + the function will return <see cref="F:log4net.Filter.FilterDecision.Accept"/>, it it is false then it + will return <see cref="F:log4net.Filter.FilterDecision.Deny"/>. If the <see cref="T:log4net.Core.Level"/> does not match then + the result will be <see cref="F:log4net.Filter.FilterDecision.Neutral"/>. + </para> + </remarks> + </member> + <member name="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch"> + <summary> + <see cref="F:log4net.Filter.FilterDecision.Accept"/> when matching <see cref="P:log4net.Filter.LevelMatchFilter.LevelToMatch"/> + </summary> + <remarks> + <para> + The <see cref="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch"/> property is a flag that determines + the behavior when a matching <see cref="T:log4net.Core.Level"/> is found. If the + flag is set to true then the filter will <see cref="F:log4net.Filter.FilterDecision.Accept"/> the + logging event, otherwise it will <see cref="F:log4net.Filter.FilterDecision.Deny"/> the event. + </para> + <para> + The default is <c>true</c> i.e. to <see cref="F:log4net.Filter.FilterDecision.Accept"/> the event. + </para> + </remarks> + </member> + <member name="P:log4net.Filter.LevelMatchFilter.LevelToMatch"> + <summary> + The <see cref="T:log4net.Core.Level"/> that the filter will match + </summary> + <remarks> + <para> + The level that this filter will attempt to match against the + <see cref="T:log4net.Core.LoggingEvent"/> level. If a match is found then + the result depends on the value of <see cref="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch"/>. + </para> + </remarks> + </member> + <member name="T:log4net.Filter.LevelRangeFilter"> + <summary> + This is a simple filter based on <see cref="T:log4net.Core.Level"/> matching. + </summary> + <remarks> + <para> + The filter admits three options <see cref="P:log4net.Filter.LevelRangeFilter.LevelMin"/> and <see cref="P:log4net.Filter.LevelRangeFilter.LevelMax"/> + that determine the range of priorities that are matched, and + <see cref="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch"/>. If there is a match between the range + of priorities and the <see cref="T:log4net.Core.Level"/> of the <see cref="T:log4net.Core.LoggingEvent"/>, then the + <see cref="M:log4net.Filter.LevelRangeFilter.Decide(log4net.Core.LoggingEvent)"/> method returns <see cref="F:log4net.Filter.FilterDecision.Accept"/> in case the <see cref="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch"/> + option value is set to <c>true</c>, if it is <c>false</c> + then <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned. If there is no match, <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="F:log4net.Filter.LevelRangeFilter.m_acceptOnMatch"> + <summary> + Flag to indicate the behavior when matching a <see cref="T:log4net.Core.Level"/> + </summary> + </member> + <member name="F:log4net.Filter.LevelRangeFilter.m_levelMin"> + <summary> + the minimum <see cref="T:log4net.Core.Level"/> value to match + </summary> + </member> + <member name="F:log4net.Filter.LevelRangeFilter.m_levelMax"> + <summary> + the maximum <see cref="T:log4net.Core.Level"/> value to match + </summary> + </member> + <member name="M:log4net.Filter.LevelRangeFilter.#ctor"> + <summary> + Default constructor + </summary> + </member> + <member name="M:log4net.Filter.LevelRangeFilter.Decide(log4net.Core.LoggingEvent)"> + <summary> + Check if the event should be logged. + </summary> + <param name="loggingEvent">the logging event to check</param> + <returns>see remarks</returns> + <remarks> + <para> + If the <see cref="T:log4net.Core.Level"/> of the logging event is outside the range + matched by this filter then <see cref="F:log4net.Filter.FilterDecision.Deny"/> + is returned. If the <see cref="T:log4net.Core.Level"/> is matched then the value of + <see cref="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch"/> is checked. If it is true then + <see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned, otherwise + <see cref="F:log4net.Filter.FilterDecision.Neutral"/> is returned. + </para> + </remarks> + </member> + <member name="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch"> + <summary> + <see cref="F:log4net.Filter.FilterDecision.Accept"/> when matching <see cref="P:log4net.Filter.LevelRangeFilter.LevelMin"/> and <see cref="P:log4net.Filter.LevelRangeFilter.LevelMax"/> + </summary> + <remarks> + <para> + The <see cref="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch"/> property is a flag that determines + the behavior when a matching <see cref="T:log4net.Core.Level"/> is found. If the + flag is set to true then the filter will <see cref="F:log4net.Filter.FilterDecision.Accept"/> the + logging event, otherwise it will <see cref="F:log4net.Filter.FilterDecision.Neutral"/> the event. + </para> + <para> + The default is <c>true</c> i.e. to <see cref="F:log4net.Filter.FilterDecision.Accept"/> the event. + </para> + </remarks> + </member> + <member name="P:log4net.Filter.LevelRangeFilter.LevelMin"> + <summary> + Set the minimum matched <see cref="T:log4net.Core.Level"/> + </summary> + <remarks> + <para> + The minimum level that this filter will attempt to match against the + <see cref="T:log4net.Core.LoggingEvent"/> level. If a match is found then + the result depends on the value of <see cref="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch"/>. + </para> + </remarks> + </member> + <member name="P:log4net.Filter.LevelRangeFilter.LevelMax"> + <summary> + Sets the maximum matched <see cref="T:log4net.Core.Level"/> + </summary> + <remarks> + <para> + The maximum level that this filter will attempt to match against the + <see cref="T:log4net.Core.LoggingEvent"/> level. If a match is found then + the result depends on the value of <see cref="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch"/>. + </para> + </remarks> + </member> + <member name="T:log4net.Filter.LoggerMatchFilter"> + <summary> + Simple filter to match a string in the event's logger name. + </summary> + <remarks> + <para> + The works very similar to the <see cref="T:log4net.Filter.LevelMatchFilter"/>. It admits two + options <see cref="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch"/> and <see cref="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch"/>. If the + <see cref="P:log4net.Core.LoggingEvent.LoggerName"/> of the <see cref="T:log4net.Core.LoggingEvent"/> starts + with the value of the <see cref="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch"/> option, then the + <see cref="M:log4net.Filter.LoggerMatchFilter.Decide(log4net.Core.LoggingEvent)"/> method returns <see cref="F:log4net.Filter.FilterDecision.Accept"/> in + case the <see cref="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch"/> option value is set to <c>true</c>, + if it is <c>false</c> then <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned. + </para> + </remarks> + <author>Daniel Cazzulino</author> + </member> + <member name="F:log4net.Filter.LoggerMatchFilter.m_acceptOnMatch"> + <summary> + Flag to indicate the behavior when we have a match + </summary> + </member> + <member name="F:log4net.Filter.LoggerMatchFilter.m_loggerToMatch"> + <summary> + The logger name string to substring match against the event + </summary> + </member> + <member name="M:log4net.Filter.LoggerMatchFilter.#ctor"> + <summary> + Default constructor + </summary> + </member> + <member name="M:log4net.Filter.LoggerMatchFilter.Decide(log4net.Core.LoggingEvent)"> + <summary> + Check if this filter should allow the event to be logged + </summary> + <param name="loggingEvent">the event being logged</param> + <returns>see remarks</returns> + <remarks> + <para> + The rendered message is matched against the <see cref="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch"/>. + If the <see cref="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch"/> equals the beginning of + the incoming <see cref="P:log4net.Core.LoggingEvent.LoggerName"/> (<see cref="M:String.StartsWith(string)"/>) + then a match will have occurred. If no match occurs + this function will return <see cref="F:log4net.Filter.FilterDecision.Neutral"/> + allowing other filters to check the event. If a match occurs then + the value of <see cref="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch"/> is checked. If it is + true then <see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned otherwise + <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned. + </para> + </remarks> + </member> + <member name="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch"> + <summary> + <see cref="F:log4net.Filter.FilterDecision.Accept"/> when matching <see cref="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch"/> + </summary> + <remarks> + <para> + The <see cref="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch"/> property is a flag that determines + the behavior when a matching <see cref="T:log4net.Core.Level"/> is found. If the + flag is set to true then the filter will <see cref="F:log4net.Filter.FilterDecision.Accept"/> the + logging event, otherwise it will <see cref="F:log4net.Filter.FilterDecision.Deny"/> the event. + </para> + <para> + The default is <c>true</c> i.e. to <see cref="F:log4net.Filter.FilterDecision.Accept"/> the event. + </para> + </remarks> + </member> + <member name="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch"> + <summary> + The <see cref="P:log4net.Core.LoggingEvent.LoggerName"/> that the filter will match + </summary> + <remarks> + <para> + This filter will attempt to match this value against logger name in + the following way. The match will be done against the beginning of the + logger name (using <see cref="M:String.StartsWith(string)"/>). The match is + case sensitive. If a match is found then + the result depends on the value of <see cref="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch"/>. + </para> + </remarks> + </member> + <member name="T:log4net.Filter.MdcFilter"> + <summary> + Simple filter to match a keyed string in the <see cref="T:log4net.MDC"/> + </summary> + <remarks> + <para> + Simple filter to match a keyed string in the <see cref="T:log4net.MDC"/> + </para> + <para> + As the MDC has been replaced with layered properties the + <see cref="T:log4net.Filter.PropertyFilter"/> should be used instead. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="T:log4net.Filter.PropertyFilter"> + <summary> + Simple filter to match a string an event property + </summary> + <remarks> + <para> + Simple filter to match a string in the value for a + specific event property + </para> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="T:log4net.Filter.StringMatchFilter"> + <summary> + Simple filter to match a string in the rendered message + </summary> + <remarks> + <para> + Simple filter to match a string in the rendered message + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="F:log4net.Filter.StringMatchFilter.m_acceptOnMatch"> + <summary> + Flag to indicate the behavior when we have a match + </summary> + </member> + <member name="F:log4net.Filter.StringMatchFilter.m_stringToMatch"> + <summary> + The string to substring match against the message + </summary> + </member> + <member name="F:log4net.Filter.StringMatchFilter.m_stringRegexToMatch"> + <summary> + A string regex to match + </summary> + </member> + <member name="F:log4net.Filter.StringMatchFilter.m_regexToMatch"> + <summary> + A regex object to match (generated from m_stringRegexToMatch) + </summary> + </member> + <member name="M:log4net.Filter.StringMatchFilter.#ctor"> + <summary> + Default constructor + </summary> + </member> + <member name="M:log4net.Filter.StringMatchFilter.ActivateOptions"> + <summary> + Initialize and precompile the Regex if required + </summary> + <remarks> + <para> + This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object + activation scheme. The <see cref="M:log4net.Filter.StringMatchFilter.ActivateOptions"/> method must + be called on this object after the configuration properties have + been set. Until <see cref="M:log4net.Filter.StringMatchFilter.ActivateOptions"/> is called this + object is in an undefined state and must not be used. + </para> + <para> + If any of the configuration properties are modified then + <see cref="M:log4net.Filter.StringMatchFilter.ActivateOptions"/> must be called again. + </para> + </remarks> + </member> + <member name="M:log4net.Filter.StringMatchFilter.Decide(log4net.Core.LoggingEvent)"> + <summary> + Check if this filter should allow the event to be logged + </summary> + <param name="loggingEvent">the event being logged</param> + <returns>see remarks</returns> + <remarks> + <para> + The rendered message is matched against the <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/>. + If the <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/> occurs as a substring within + the message then a match will have occurred. If no match occurs + this function will return <see cref="F:log4net.Filter.FilterDecision.Neutral"/> + allowing other filters to check the event. If a match occurs then + the value of <see cref="P:log4net.Filter.StringMatchFilter.AcceptOnMatch"/> is checked. If it is + true then <see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned otherwise + <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned. + </para> + </remarks> + </member> + <member name="P:log4net.Filter.StringMatchFilter.AcceptOnMatch"> + <summary> + <see cref="F:log4net.Filter.FilterDecision.Accept"/> when matching <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/> or <see cref="P:log4net.Filter.StringMatchFilter.RegexToMatch"/> + </summary> + <remarks> + <para> + The <see cref="P:log4net.Filter.StringMatchFilter.AcceptOnMatch"/> property is a flag that determines + the behavior when a matching <see cref="T:log4net.Core.Level"/> is found. If the + flag is set to true then the filter will <see cref="F:log4net.Filter.FilterDecision.Accept"/> the + logging event, otherwise it will <see cref="F:log4net.Filter.FilterDecision.Neutral"/> the event. + </para> + <para> + The default is <c>true</c> i.e. to <see cref="F:log4net.Filter.FilterDecision.Accept"/> the event. + </para> + </remarks> + </member> + <member name="P:log4net.Filter.StringMatchFilter.StringToMatch"> + <summary> + Sets the static string to match + </summary> + <remarks> + <para> + The string that will be substring matched against + the rendered message. If the message contains this + string then the filter will match. If a match is found then + the result depends on the value of <see cref="P:log4net.Filter.StringMatchFilter.AcceptOnMatch"/>. + </para> + <para> + One of <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/> or <see cref="P:log4net.Filter.StringMatchFilter.RegexToMatch"/> + must be specified. + </para> + </remarks> + </member> + <member name="P:log4net.Filter.StringMatchFilter.RegexToMatch"> + <summary> + Sets the regular expression to match + </summary> + <remarks> + <para> + The regular expression pattern that will be matched against + the rendered message. If the message matches this + pattern then the filter will match. If a match is found then + the result depends on the value of <see cref="P:log4net.Filter.StringMatchFilter.AcceptOnMatch"/>. + </para> + <para> + One of <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/> or <see cref="P:log4net.Filter.StringMatchFilter.RegexToMatch"/> + must be specified. + </para> + </remarks> + </member> + <member name="F:log4net.Filter.PropertyFilter.m_key"> + <summary> + The key to use to lookup the string from the event properties + </summary> + </member> + <member name="M:log4net.Filter.PropertyFilter.#ctor"> + <summary> + Default constructor + </summary> + </member> + <member name="M:log4net.Filter.PropertyFilter.Decide(log4net.Core.LoggingEvent)"> + <summary> + Check if this filter should allow the event to be logged + </summary> + <param name="loggingEvent">the event being logged</param> + <returns>see remarks</returns> + <remarks> + <para> + The event property for the <see cref="P:log4net.Filter.PropertyFilter.Key"/> is matched against + the <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/>. + If the <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/> occurs as a substring within + the property value then a match will have occurred. If no match occurs + this function will return <see cref="F:log4net.Filter.FilterDecision.Neutral"/> + allowing other filters to check the event. If a match occurs then + the value of <see cref="P:log4net.Filter.StringMatchFilter.AcceptOnMatch"/> is checked. If it is + true then <see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned otherwise + <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned. + </para> + </remarks> + </member> + <member name="P:log4net.Filter.PropertyFilter.Key"> + <summary> + The key to lookup in the event properties and then match against. + </summary> + <remarks> + <para> + The key name to use to lookup in the properties map of the + <see cref="T:log4net.Core.LoggingEvent"/>. The match will be performed against + the value of this property if it exists. + </para> + </remarks> + </member> + <member name="T:log4net.Filter.NdcFilter"> + <summary> + Simple filter to match a string in the <see cref="T:log4net.NDC"/> + </summary> + <remarks> + <para> + Simple filter to match a string in the <see cref="T:log4net.NDC"/> + </para> + <para> + As the MDC has been replaced with named stacks stored in the + properties collections the <see cref="T:log4net.Filter.PropertyFilter"/> should + be used instead. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Filter.NdcFilter.#ctor"> + <summary> + Default constructor + </summary> + <remarks> + <para> + Sets the <see cref="P:log4net.Filter.PropertyFilter.Key"/> to <c>"NDC"</c>. + </para> + </remarks> + </member> + <member name="T:log4net.Layout.Pattern.AppDomainPatternConverter"> + <summary> + Write the event appdomain name to the output + </summary> + <remarks> + <para> + Writes the <see cref="P:log4net.Core.LoggingEvent.Domain"/> to the output writer. + </para> + </remarks> + <author>Daniel Cazzulino</author> + <author>Nicko Cadell</author> + </member> + <member name="T:log4net.Layout.Pattern.PatternLayoutConverter"> + <summary> + Abstract class that provides the formatting functionality that + derived classes need. + </summary> + <remarks> + Conversion specifiers in a conversion patterns are parsed to + individual PatternConverters. Each of which is responsible for + converting a logging event in a converter specific manner. + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="T:log4net.Util.PatternConverter"> + <summary> + Abstract class that provides the formatting functionality that + derived classes need. + </summary> + <remarks> + <para> + Conversion specifiers in a conversion patterns are parsed to + individual PatternConverters. Each of which is responsible for + converting a logging event in a converter specific manner. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="F:log4net.Util.PatternConverter.c_renderBufferSize"> + <summary> + Initial buffer size + </summary> + </member> + <member name="F:log4net.Util.PatternConverter.c_renderBufferMaxCapacity"> + <summary> + Maximum buffer size before it is recycled + </summary> + </member> + <member name="M:log4net.Util.PatternConverter.#ctor"> + <summary> + Protected constructor + </summary> + <remarks> + <para> + Initializes a new instance of the <see cref="T:log4net.Util.PatternConverter"/> class. + </para> + </remarks> + </member> + <member name="M:log4net.Util.PatternConverter.Convert(System.IO.TextWriter,System.Object)"> + <summary> + Evaluate this pattern converter and write the output to a writer. + </summary> + <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param> + <param name="state">The state object on which the pattern converter should be executed.</param> + <remarks> + <para> + Derived pattern converters must override this method in order to + convert conversion specifiers in the appropriate way. + </para> + </remarks> + </member> + <member name="M:log4net.Util.PatternConverter.SetNext(log4net.Util.PatternConverter)"> + <summary> + Set the next pattern converter in the chains + </summary> + <param name="patternConverter">the pattern converter that should follow this converter in the chain</param> + <returns>the next converter</returns> + <remarks> + <para> + The PatternConverter can merge with its neighbor during this method (or a sub class). + Therefore the return value may or may not be the value of the argument passed in. + </para> + </remarks> + </member> + <member name="M:log4net.Util.PatternConverter.Format(System.IO.TextWriter,System.Object)"> + <summary> + Write the pattern converter to the writer with appropriate formatting + </summary> + <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param> + <param name="state">The state object on which the pattern converter should be executed.</param> + <remarks> + <para> + This method calls <see cref="M:log4net.Util.PatternConverter.Convert(System.IO.TextWriter,System.Object)"/> to allow the subclass to perform + appropriate conversion of the pattern converter. If formatting options have + been specified via the <see cref="P:log4net.Util.PatternConverter.FormattingInfo"/> then this method will + apply those formattings before writing the output. + </para> + </remarks> + </member> + <member name="M:log4net.Util.PatternConverter.SpacePad(System.IO.TextWriter,System.Int32)"> + <summary> + Fast space padding method. + </summary> + <param name="writer"><see cref="T:System.IO.TextWriter"/> to which the spaces will be appended.</param> + <param name="length">The number of spaces to be padded.</param> + <remarks> + <para> + Fast space padding method. + </para> + </remarks> + </member> + <member name="F:log4net.Util.PatternConverter.m_option"> + <summary> + The option string to the converter + </summary> + </member> + <member name="M:log4net.Util.PatternConverter.WriteDictionary(System.IO.TextWriter,log4net.Repository.ILoggerRepository,System.Collections.IDictionary)"> + <summary> + Write an dictionary to a <see cref="T:System.IO.TextWriter"/> + </summary> + <param name="writer">the writer to write to</param> + <param name="repository">a <see cref="T:log4net.Repository.ILoggerRepository"/> to use for object conversion</param> + <param name="value">the value to write to the writer</param> + <remarks> + <para> + Writes the <see cref="T:System.Collections.IDictionary"/> to a writer in the form: + </para> + <code> + {key1=value1, key2=value2, key3=value3} + </code> + <para> + If the <see cref="T:log4net.Repository.ILoggerRepository"/> specified + is not null then it is used to render the key and value to text, otherwise + the object's ToString method is called. + </para> + </remarks> + </member> + <member name="M:log4net.Util.PatternConverter.WriteDictionary(System.IO.TextWriter,log4net.Repository.ILoggerRepository,System.Collections.IDictionaryEnumerator)"> + <summary> + Write an dictionary to a <see cref="T:System.IO.TextWriter"/> + </summary> + <param name="writer">the writer to write to</param> + <param name="repository">a <see cref="T:log4net.Repository.ILoggerRepository"/> to use for object conversion</param> + <param name="value">the value to write to the writer</param> + <remarks> + <para> + Writes the <see cref="T:System.Collections.IDictionaryEnumerator"/> to a writer in the form: + </para> + <code> + {key1=value1, key2=value2, key3=value3} + </code> + <para> + If the <see cref="T:log4net.Repository.ILoggerRepository"/> specified + is not null then it is used to render the key and value to text, otherwise + the object's ToString method is called. + </para> + </remarks> + </member> + <member name="M:log4net.Util.PatternConverter.WriteObject(System.IO.TextWriter,log4net.Repository.ILoggerRepository,System.Object)"> + <summary> + Write an object to a <see cref="T:System.IO.TextWriter"/> + </summary> + <param name="writer">the writer to write to</param> + <param name="repository">a <see cref="T:log4net.Repository.ILoggerRepository"/> to use for object conversion</param> + <param name="value">the value to write to the writer</param> + <remarks> + <para> + Writes the Object to a writer. If the <see cref="T:log4net.Repository.ILoggerRepository"/> specified + is not null then it is used to render the object to text, otherwise + the object's ToString method is called. + </para> + </remarks> + </member> + <member name="P:log4net.Util.PatternConverter.Next"> + <summary> + Get the next pattern converter in the chain + </summary> + <value> + the next pattern converter in the chain + </value> + <remarks> + <para> + Get the next pattern converter in the chain + </para> + </remarks> + </member> + <member name="P:log4net.Util.PatternConverter.FormattingInfo"> + <summary> + Gets or sets the formatting info for this converter + </summary> + <value> + The formatting info for this converter + </value> + <remarks> + <para> + Gets or sets the formatting info for this converter + </para> + </remarks> + </member> + <member name="P:log4net.Util.PatternConverter.Option"> + <summary> + Gets or sets the option value for this converter + </summary> + <summary> + The option for this converter + </summary> + <remarks> + <para> + Gets or sets the option value for this converter + </para> + </remarks> + </member> + <member name="P:log4net.Util.PatternConverter.Properties"> + <summary> + + </summary> + </member> + <member name="M:log4net.Layout.Pattern.PatternLayoutConverter.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:log4net.Layout.Pattern.PatternLayoutConverter"/> class. + </summary> + </member> + <member name="M:log4net.Layout.Pattern.PatternLayoutConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)"> + <summary> + Derived pattern converters must override this method in order to + convert conversion specifiers in the correct way. + </summary> + <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param> + <param name="loggingEvent">The <see cref="T:log4net.Core.LoggingEvent"/> on which the pattern converter should be executed.</param> + </member> + <member name="M:log4net.Layout.Pattern.PatternLayoutConverter.Convert(System.IO.TextWriter,System.Object)"> + <summary> + Derived pattern converters must override this method in order to + convert conversion specifiers in the correct way. + </summary> + <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param> + <param name="state">The state object on which the pattern converter should be executed.</param> + </member> + <member name="F:log4net.Layout.Pattern.PatternLayoutConverter.m_ignoresException"> + <summary> + Flag indicating if this converter handles exceptions + </summary> + <remarks> + <c>false</c> if this converter handles exceptions + </remarks> + </member> + <member name="P:log4net.Layout.Pattern.PatternLayoutConverter.IgnoresException"> + <summary> + Flag indicating if this converter handles the logging event exception + </summary> + <value><c>false</c> if this converter handles the logging event exception</value> + <remarks> + <para> + If this converter handles the exception object contained within + <see cref="T:log4net.Core.LoggingEvent"/>, then this property should be set to + <c>false</c>. Otherwise, if the layout ignores the exception + object, then the property should be set to <c>true</c>. + </para> + <para> + Set this value to override a this default setting. The default + value is <c>true</c>, this converter does not handle the exception. + </para> + </remarks> + </member> + <member name="M:log4net.Layout.Pattern.AppDomainPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)"> + <summary> + Write the event appdomain name to the output + </summary> + <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param> + <param name="loggingEvent">the event being logged</param> + <remarks> + <para> + Writes the <see cref="P:log4net.Core.LoggingEvent.Domain"/> to the output <paramref name="writer"/>. + </para> + </remarks> + </member> + <member name="T:log4net.Layout.Pattern.AspNetCachePatternConverter"> + <summary> + Converter for items in the ASP.Net Cache. + </summary> + <remarks> + <para> + Outputs an item from the <see cref="P:System.Web.HttpRuntime.Cache"/>. + </para> + </remarks> + <author>Ron Grabowski</author> + </member> + <member name="T:log4net.Layout.Pattern.AspNetPatternLayoutConverter"> + <summary> + Abstract class that provides access to the current HttpContext (<see cref="P:System.Web.HttpContext.Current"/>) that + derived classes need. + </summary> + <remarks> + This class handles the case when HttpContext.Current is null by writing + <see cref="P:log4net.Util.SystemInfo.NotAvailableText"/> to the writer. + </remarks> + <author>Ron Grabowski</author> + </member> + <member name="M:log4net.Layout.Pattern.AspNetPatternLayoutConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent,System.Web.HttpContext)"> + <summary> + Derived pattern converters must override this method in order to + convert conversion specifiers in the correct way. + </summary> + <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param> + <param name="loggingEvent">The <see cref="T:log4net.Core.LoggingEvent"/> on which the pattern converter should be executed.</param> + <param name="httpContext">The <see cref="T:System.Web.HttpContext"/> under which the ASP.Net request is running.</param> + </member> + <member name="M:log4net.Layout.Pattern.AspNetCachePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent,System.Web.HttpContext)"> + <summary> + Write the ASP.Net Cache item to the output + </summary> + <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param> + <param name="loggingEvent">The <see cref="T:log4net.Core.LoggingEvent"/> on which the pattern converter should be executed.</param> + <param name="httpContext">The <see cref="T:System.Web.HttpContext"/> under which the ASP.Net request is running.</param> + <remarks> + <para> + Writes out the value of a named property. The property name + should be set in the <see cref="P:log4net.Util.PatternConverter.Option"/> + property. If no property has been set, all key value pairs from the Cache will + be written to the output. + </para> + </remarks> + </member> + <member name="T:log4net.Layout.Pattern.AspNetContextPatternConverter"> + <summary> + Converter for items in the <see cref="T:System.Web.HttpContext"/>. + </summary> + <remarks> + <para> + Outputs an item from the <see cref="T:System.Web.HttpContext"/>. + </para> + </remarks> + <author>Ron Grabowski</author> + </member> + <member name="M:log4net.Layout.Pattern.AspNetContextPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent,System.Web.HttpContext)"> + <summary> + Write the ASP.Net HttpContext item to the output + </summary> + <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param> + <param name="loggingEvent">The <see cref="T:log4net.Core.LoggingEvent"/> on which the pattern converter should be executed.</param> + <param name="httpContext">The <see cref="T:System.Web.HttpContext"/> under which the ASP.Net request is running.</param> + <remarks> + <para> + Writes out the value of a named property. The property name + should be set in the <see cref="P:log4net.Util.PatternConverter.Option"/> + property. + </para> + </remarks> + </member> + <member name="T:log4net.Layout.Pattern.AspNetRequestPatternConverter"> + <summary> + Converter for items in the ASP.Net Cache. + </summary> + <remarks> + <para> + Outputs an item from the <see cref="P:System.Web.HttpRuntime.Cache"/>. + </para> + </remarks> + <author>Ron Grabowski</author> + </member> + <member name="M:log4net.Layout.Pattern.AspNetRequestPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent,System.Web.HttpContext)"> + <summary> + Write the ASP.Net Cache item to the output + </summary> + <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param> + <param name="loggingEvent">The <see cref="T:log4net.Core.LoggingEvent"/> on which the pattern converter should be executed.</param> + <param name="httpContext">The <see cref="T:System.Web.HttpContext"/> under which the ASP.Net request is running.</param> + <remarks> + <para> + Writes out the value of a named property. The property name + should be set in the <see cref="P:log4net.Util.PatternConverter.Option"/> + property. + </para> + </remarks> + </member> + <member name="T:log4net.Layout.Pattern.AspNetSessionPatternConverter"> + <summary> + Converter for items in the ASP.Net Cache. + </summary> + <remarks> + <para> + Outputs an item from the <see cref="P:System.Web.HttpRuntime.Cache"/>. + </para> + </remarks> + <author>Ron Grabowski</author> + </member> + <member name="M:log4net.Layout.Pattern.AspNetSessionPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent,System.Web.HttpContext)"> + <summary> + Write the ASP.Net Cache item to the output + </summary> + <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param> + <param name="loggingEvent">The <see cref="T:log4net.Core.LoggingEvent"/> on which the pattern converter should be executed.</param> + <param name="httpContext">The <see cref="T:System.Web.HttpContext"/> under which the ASP.Net request is running.</param> + <remarks> + <para> + Writes out the value of a named property. The property name + should be set in the <see cref="P:log4net.Util.PatternConverter.Option"/> + property. If no property has been set, all key value pairs from the Session will + be written to the output. + </para> + </remarks> + </member> + <member name="T:log4net.Layout.Pattern.DatePatternConverter"> + <summary> + Date pattern converter, uses a <see cref="T:log4net.DateFormatter.IDateFormatter"/> to format + the date of a <see cref="T:log4net.Core.LoggingEvent"/>. + </summary> + <remarks> + <para> + Render the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> to the writer as a string. + </para> + <para> + The value of the <see cref="P:log4net.Util.PatternConverter.Option"/> determines + the formatting of the date. The following values are allowed: + <list type="definition"> + <listheader> + <term>Option value</term> + <description>Output</description> + </listheader> + <item> + <term>ISO8601</term> + <description> + Uses the <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/> formatter. + Formats using the <c>"yyyy-MM-dd HH:mm:ss,fff"</c> pattern. + </description> + </item> + <item> + <term>DATE</term> + <description> + Uses the <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> formatter. + Formats using the <c>"dd MMM yyyy HH:mm:ss,fff"</c> for example, <c>"06 Nov 1994 15:49:37,459"</c>. + </description> + </item> + <item> + <term>ABSOLUTE</term> + <description> + Uses the <see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/> formatter. + Formats using the <c>"HH:mm:ss,yyyy"</c> for example, <c>"15:49:37,459"</c>. + </description> + </item> + <item> + <term>other</term> + <description> + Any other pattern string uses the <see cref="T:log4net.DateFormatter.SimpleDateFormatter"/> formatter. + This formatter passes the pattern string to the <see cref="T:System.DateTime"/> + <see cref="M:DateTime.ToString(string)"/> method. + For details on valid patterns see + <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfsystemglobalizationdatetimeformatinfoclasstopic.asp">DateTimeFormatInfo Class</a>. + </description> + </item> + </list> + </para> + <para> + The <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> is in the local time zone and is rendered in that zone. + To output the time in Universal time see <see cref="T:log4net.Layout.Pattern.UtcDatePatternConverter"/>. + </para> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="F:log4net.Layout.Pattern.DatePatternConverter.m_dateFormatter"> + <summary> + The <see cref="T:log4net.DateFormatter.IDateFormatter"/> used to render the date to a string + </summary> + <remarks> + <para> + The <see cref="T:log4net.DateFormatter.IDateFormatter"/> used to render the date to a string + </para> + </remarks> + </member> + <member name="M:log4net.Layout.Pattern.DatePatternConverter.ActivateOptions"> + <summary> + Initialize the converter pattern based on the <see cref="P:log4net.Util.PatternConverter.Option"/> property. + </summary> + <remarks> + <para> + This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object + activation scheme. The <see cref="M:log4net.Layout.Pattern.DatePatternConverter.ActivateOptions"/> method must + be called on this object after the configuration properties have + been set. Until <see cref="M:log4net.Layout.Pattern.DatePatternConverter.ActivateOptions"/> is called this + object is in an undefined state and must not be used. + </para> + <para> + If any of the configuration properties are modified then + <see cref="M:log4net.Layout.Pattern.DatePatternConverter.ActivateOptions"/> must be called again. + </para> + </remarks> + </member> + <member name="M:log4net.Layout.Pattern.DatePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)"> + <summary> + Convert the pattern into the rendered message + </summary> + <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param> + <param name="loggingEvent">the event being logged</param> + <remarks> + <para> + Pass the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> to the <see cref="T:log4net.DateFormatter.IDateFormatter"/> + for it to render it to the writer. + </para> + <para> + The <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> passed is in the local time zone. + </para> + </remarks> + </member> + <member name="F:log4net.Layout.Pattern.DatePatternConverter.declaringType"> + <summary> + The fully qualified type of the DatePatternConverter class. + </summary> + <remarks> + Used by the internal logger to record the Type of the + log message. + </remarks> + </member> + <member name="T:log4net.Layout.Pattern.ExceptionPatternConverter"> + <summary> + Write the exception text to the output + </summary> + <remarks> + <para> + If an exception object is stored in the logging event + it will be rendered into the pattern output with a + trailing newline. + </para> + <para> + If there is no exception then nothing will be output + and no trailing newline will be appended. + It is typical to put a newline before the exception + and to have the exception as the last data in the pattern. + </para> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="M:log4net.Layout.Pattern.ExceptionPatternConverter.#ctor"> + <summary> + Default constructor + </summary> + </member> + <member name="M:log4net.Layout.Pattern.ExceptionPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)"> + <summary> + Write the exception text to the output + </summary> + <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param> + <param name="loggingEvent">the event being logged</param> + <remarks> + <para> + If an exception object is stored in the logging event + it will be rendered into the pattern output with a + trailing newline. + </para> + <para> + If there is no exception or the exception property specified + by the Option value does not exist then nothing will be output + and no trailing newline will be appended. + It is typical to put a newline before the exception + and to have the exception as the last data in the pattern. + </para> + <para> + Recognized values for the Option parameter are: + </para> + <list type="bullet"> + <item> + <description>Message</description> + </item> + <item> + <description>Source</description> + </item> + <item> + <description>StackTrace</description> + </item> + <item> + <description>TargetSite</description> + </item> + <item> + <description>HelpLink</description> + </item> + </list> + </remarks> + </member> + <member name="T:log4net.Layout.Pattern.FileLocationPatternConverter"> + <summary> + Writes the caller location file name to the output + </summary> + <remarks> + <para> + Writes the value of the <see cref="P:log4net.Core.LocationInfo.FileName"/> for + the event to the output writer. + </para> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="M:log4net.Layout.Pattern.FileLocationPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)"> + <summary> + Write the caller location file name to the output + </summary> + <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param> + <param name="loggingEvent">the event being logged</param> + <remarks> + <para> + Writes the value of the <see cref="P:log4net.Core.LocationInfo.FileName"/> for + the <paramref name="loggingEvent"/> to the output <paramref name="writer"/>. + </para> + </remarks> + </member> + <member name="T:log4net.Layout.Pattern.FullLocationPatternConverter"> + <summary> + Write the caller location info to the output + </summary> + <remarks> + <para> + Writes the <see cref="P:log4net.Core.LocationInfo.FullInfo"/> to the output writer. + </para> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="M:log4net.Layout.Pattern.FullLocationPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)"> + <summary> + Write the caller location info to the output + </summary> + <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param> + <param name="loggingEvent">the event being logged</param> + <remarks> + <para> + Writes the <see cref="P:log4net.Core.LocationInfo.FullInfo"/> to the output writer. + </para> + </remarks> + </member> + <member name="T:log4net.Layout.Pattern.IdentityPatternConverter"> + <summary> + Writes the event identity to the output + </summary> + <remarks> + <para> + Writes the value of the <see cref="P:log4net.Core.LoggingEvent.Identity"/> to + the output writer. + </para> + </remarks> + <author>Daniel Cazzulino</author> + <author>Nicko Cadell</author> + </member> + <member name="M:log4net.Layout.Pattern.IdentityPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)"> + <summary> + Writes the event identity to the output + </summary> + <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param> + <param name="loggingEvent">the event being logged</param> + <remarks> + <para> + Writes the value of the <paramref name="loggingEvent"/> + <see cref="P:log4net.Core.LoggingEvent.Identity"/> to + the output <paramref name="writer"/>. + </para> + </remarks> + </member> + <member name="T:log4net.Layout.Pattern.LevelPatternConverter"> + <summary> + Write the event level to the output + </summary> + <remarks> + <para> + Writes the display name of the event <see cref="P:log4net.Core.LoggingEvent.Level"/> + to the writer. + </para> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="M:log4net.Layout.Pattern.LevelPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)"> + <summary> + Write the event level to the output + </summary> + <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param> + <param name="loggingEvent">the event being logged</param> + <remarks> + <para> + Writes the <see cref="P:log4net.Core.Level.DisplayName"/> of the <paramref name="loggingEvent"/> <see cref="P:log4net.Core.LoggingEvent.Level"/> + to the <paramref name="writer"/>. + </para> + </remarks> + </member> + <member name="T:log4net.Layout.Pattern.LineLocationPatternConverter"> + <summary> + Write the caller location line number to the output + </summary> + <remarks> + <para> + Writes the value of the <see cref="P:log4net.Core.LocationInfo.LineNumber"/> for + the event to the output writer. + </para> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="M:log4net.Layout.Pattern.LineLocationPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)"> + <summary> + Write the caller location line number to the output + </summary> + <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param> + <param name="loggingEvent">the event being logged</param> + <remarks> + <para> + Writes the value of the <see cref="P:log4net.Core.LocationInfo.LineNumber"/> for + the <paramref name="loggingEvent"/> to the output <paramref name="writer"/>. + </para> + </remarks> + </member> + <member name="T:log4net.Layout.Pattern.LoggerPatternConverter"> + <summary> + Converter for logger name + </summary> + <remarks> + <para> + Outputs the <see cref="P:log4net.Core.LoggingEvent.LoggerName"/> of the event. + </para> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="T:log4net.Layout.Pattern.NamedPatternConverter"> + <summary> + Converter to output and truncate <c>'.'</c> separated strings + </summary> + <remarks> + <para> + This abstract class supports truncating a <c>'.'</c> separated string + to show a specified number of elements from the right hand side. + This is used to truncate class names that are fully qualified. + </para> + <para> + Subclasses should override the <see cref="M:log4net.Layout.Pattern.NamedPatternConverter.GetFullyQualifiedName(log4net.Core.LoggingEvent)"/> method to + return the fully qualified string. + </para> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="M:log4net.Layout.Pattern.NamedPatternConverter.ActivateOptions"> + <summary> + Initialize the converter + </summary> + <remarks> + <para> + This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object + activation scheme. The <see cref="M:log4net.Layout.Pattern.NamedPatternConverter.ActivateOptions"/> method must + be called on this object after the configuration properties have + been set. Until <see cref="M:log4net.Layout.Pattern.NamedPatternConverter.ActivateOptions"/> is called this + object is in an undefined state and must not be used. + </para> + <para> + If any of the configuration properties are modified then + <see cref="M:log4net.Layout.Pattern.NamedPatternConverter.ActivateOptions"/> must be called again. + </para> + </remarks> + </member> + <member name="M:log4net.Layout.Pattern.NamedPatternConverter.GetFullyQualifiedName(log4net.Core.LoggingEvent)"> + <summary> + Get the fully qualified string data + </summary> + <param name="loggingEvent">the event being logged</param> + <returns>the fully qualified name</returns> + <remarks> + <para> + Overridden by subclasses to get the fully qualified name before the + precision is applied to it. + </para> + <para> + Return the fully qualified <c>'.'</c> (dot/period) separated string. + </para> + </remarks> + </member> + <member name="M:log4net.Layout.Pattern.NamedPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)"> + <summary> + Convert the pattern to the rendered message + </summary> + <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param> + <param name="loggingEvent">the event being logged</param> + <remarks> + Render the <see cref="M:log4net.Layout.Pattern.NamedPatternConverter.GetFullyQualifiedName(log4net.Core.LoggingEvent)"/> to the precision + specified by the <see cref="P:log4net.Util.PatternConverter.Option"/> property. + </remarks> + </member> + <member name="F:log4net.Layout.Pattern.NamedPatternConverter.declaringType"> + <summary> + The fully qualified type of the NamedPatternConverter class. + </summary> + <remarks> + Used by the internal logger to record the Type of the + log message. + </remarks> + </member> + <member name="M:log4net.Layout.Pattern.LoggerPatternConverter.GetFullyQualifiedName(log4net.Core.LoggingEvent)"> + <summary> + Gets the fully qualified name of the logger + </summary> + <param name="loggingEvent">the event being logged</param> + <returns>The fully qualified logger name</returns> + <remarks> + <para> + Returns the <see cref="P:log4net.Core.LoggingEvent.LoggerName"/> of the <paramref name="loggingEvent"/>. + </para> + </remarks> + </member> + <member name="T:log4net.Layout.Pattern.MessagePatternConverter"> + <summary> + Writes the event message to the output + </summary> + <remarks> + <para> + Uses the <see cref="M:log4net.Core.LoggingEvent.WriteRenderedMessage(System.IO.TextWriter)"/> method + to write out the event message. + </para> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="M:log4net.Layout.Pattern.MessagePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)"> + <summary> + Writes the event message to the output + </summary> + <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param> + <param name="loggingEvent">the event being logged</param> + <remarks> + <para> + Uses the <see cref="M:log4net.Core.LoggingEvent.WriteRenderedMessage(System.IO.TextWriter)"/> method + to write out the event message. + </para> + </remarks> + </member> + <member name="T:log4net.Layout.Pattern.MethodLocationPatternConverter"> + <summary> + Write the method name to the output + </summary> + <remarks> + <para> + Writes the caller location <see cref="P:log4net.Core.LocationInfo.MethodName"/> to + the output. + </para> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="M:log4net.Layout.Pattern.MethodLocationPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)"> + <summary> + Write the method name to the output + </summary> + <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param> + <param name="loggingEvent">the event being logged</param> + <remarks> + <para> + Writes the caller location <see cref="P:log4net.Core.LocationInfo.MethodName"/> to + the output. + </para> + </remarks> + </member> + <member name="T:log4net.Layout.Pattern.NdcPatternConverter"> + <summary> + Converter to include event NDC + </summary> + <remarks> + <para> + Outputs the value of the event property named <c>NDC</c>. + </para> + <para> + The <see cref="T:log4net.Layout.Pattern.PropertyPatternConverter"/> should be used instead. + </para> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="M:log4net.Layout.Pattern.NdcPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)"> + <summary> + Write the event NDC to the output + </summary> + <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param> + <param name="loggingEvent">the event being logged</param> + <remarks> + <para> + As the thread context stacks are now stored in named event properties + this converter simply looks up the value of the <c>NDC</c> property. + </para> + <para> + The <see cref="T:log4net.Layout.Pattern.PropertyPatternConverter"/> should be used instead. + </para> + </remarks> + </member> + <member name="T:log4net.Layout.Pattern.PropertyPatternConverter"> + <summary> + Property pattern converter + </summary> + <remarks> + <para> + Writes out the value of a named property. The property name + should be set in the <see cref="P:log4net.Util.PatternConverter.Option"/> + property. + </para> + <para> + If the <see cref="P:log4net.Util.PatternConverter.Option"/> is set to <c>null</c> + then all the properties are written as key value pairs. + </para> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="M:log4net.Layout.Pattern.PropertyPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)"> + <summary> + Write the property value to the output + </summary> + <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param> + <param name="loggingEvent">the event being logged</param> + <remarks> + <para> + Writes out the value of a named property. The property name + should be set in the <see cref="P:log4net.Util.PatternConverter.Option"/> + property. + </para> + <para> + If the <see cref="P:log4net.Util.PatternConverter.Option"/> is set to <c>null</c> + then all the properties are written as key value pairs. + </para> + </remarks> + </member> + <member name="T:log4net.Layout.Pattern.RelativeTimePatternConverter"> + <summary> + Converter to output the relative time of the event + </summary> + <remarks> + <para> + Converter to output the time of the event relative to the start of the program. + </para> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="M:log4net.Layout.Pattern.RelativeTimePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)"> + <summary> + Write the relative time to the output + </summary> + <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param> + <param name="loggingEvent">the event being logged</param> + <remarks> + <para> + Writes out the relative time of the event in milliseconds. + That is the number of milliseconds between the event <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> + and the <see cref="P:log4net.Core.LoggingEvent.StartTime"/>. + </para> + </remarks> + </member> + <member name="M:log4net.Layout.Pattern.RelativeTimePatternConverter.TimeDifferenceInMillis(System.DateTime,System.DateTime)"> + <summary> + Helper method to get the time difference between two DateTime objects + </summary> + <param name="start">start time (in the current local time zone)</param> + <param name="end">end time (in the current local time zone)</param> + <returns>the time difference in milliseconds</returns> + </member> + <member name="T:log4net.Layout.Pattern.StackTraceDetailPatternConverter"> + <summary> + Write the caller stack frames to the output + </summary> + <remarks> + <para> + Writes the <see cref="P:log4net.Core.LocationInfo.StackFrames"/> to the output writer, using format: + type3.MethodCall3(type param,...) > type2.MethodCall2(type param,...) > type1.MethodCall1(type param,...) + </para> + </remarks> + <author>Adam Davies</author> + </member> + <member name="T:log4net.Layout.Pattern.StackTracePatternConverter"> + <summary> + Write the caller stack frames to the output + </summary> + <remarks> + <para> + Writes the <see cref="P:log4net.Core.LocationInfo.StackFrames"/> to the output writer, using format: + type3.MethodCall3 > type2.MethodCall2 > type1.MethodCall1 + </para> + </remarks> + <author>Michael Cromwell</author> + </member> + <member name="M:log4net.Layout.Pattern.StackTracePatternConverter.ActivateOptions"> + <summary> + Initialize the converter + </summary> + <remarks> + <para> + This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object + activation scheme. The <see cref="M:log4net.Layout.Pattern.StackTracePatternConverter.ActivateOptions"/> method must + be called on this object after the configuration properties have + been set. Until <see cref="M:log4net.Layout.Pattern.StackTracePatternConverter.ActivateOptions"/> is called this + object is in an undefined state and must not be used. + </para> + <para> + If any of the configuration properties are modified then + <see cref="M:log4net.Layout.Pattern.StackTracePatternConverter.ActivateOptions"/> must be called again. + </para> + </remarks> + </member> + <member name="M:log4net.Layout.Pattern.StackTracePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)"> + <summary> + Write the strack frames to the output + </summary> + <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param> + <param name="loggingEvent">the event being logged</param> + <remarks> + <para> + Writes the <see cref="P:log4net.Core.LocationInfo.StackFrames"/> to the output writer. + </para> + </remarks> + </member> + <member name="M:log4net.Layout.Pattern.StackTracePatternConverter.GetMethodInformation(log4net.Core.MethodItem)"> + <summary> + Returns the Name of the method + </summary> + <param name="method"></param> + <remarks>This method was created, so this class could be used as a base class for StackTraceDetailPatternConverter</remarks> + <returns>string</returns> + </member> + <member name="F:log4net.Layout.Pattern.StackTracePatternConverter.declaringType"> + <summary> + The fully qualified type of the StackTracePatternConverter class. + </summary> + <remarks> + Used by the internal logger to record the Type of the + log message. + </remarks> + </member> + <member name="F:log4net.Layout.Pattern.StackTraceDetailPatternConverter.declaringType"> + <summary> + The fully qualified type of the StackTraceDetailPatternConverter class. + </summary> + <remarks> + Used by the internal logger to record the Type of the + log message. + </remarks> + </member> + <member name="T:log4net.Layout.Pattern.ThreadPatternConverter"> + <summary> + Converter to include event thread name + </summary> + <remarks> + <para> + Writes the <see cref="P:log4net.Core.LoggingEvent.ThreadName"/> to the output. + </para> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="M:log4net.Layout.Pattern.ThreadPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)"> + <summary> + Write the ThreadName to the output + </summary> + <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param> + <param name="loggingEvent">the event being logged</param> + <remarks> + <para> + Writes the <see cref="P:log4net.Core.LoggingEvent.ThreadName"/> to the <paramref name="writer"/>. + </para> + </remarks> + </member> + <member name="T:log4net.Layout.Pattern.TypeNamePatternConverter"> + <summary> + Pattern converter for the class name + </summary> + <remarks> + <para> + Outputs the <see cref="P:log4net.Core.LocationInfo.ClassName"/> of the event. + </para> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="M:log4net.Layout.Pattern.TypeNamePatternConverter.GetFullyQualifiedName(log4net.Core.LoggingEvent)"> + <summary> + Gets the fully qualified name of the class + </summary> + <param name="loggingEvent">the event being logged</param> + <returns>The fully qualified type name for the caller location</returns> + <remarks> + <para> + Returns the <see cref="P:log4net.Core.LocationInfo.ClassName"/> of the <paramref name="loggingEvent"/>. + </para> + </remarks> + </member> + <member name="T:log4net.Layout.Pattern.UserNamePatternConverter"> + <summary> + Converter to include event user name + </summary> + <author>Douglas de la Torre</author> + <author>Nicko Cadell</author> + </member> + <member name="M:log4net.Layout.Pattern.UserNamePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)"> + <summary> + Convert the pattern to the rendered message + </summary> + <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param> + <param name="loggingEvent">the event being logged</param> + </member> + <member name="T:log4net.Layout.Pattern.UtcDatePatternConverter"> + <summary> + Write the TimeStamp to the output + </summary> + <remarks> + <para> + Date pattern converter, uses a <see cref="T:log4net.DateFormatter.IDateFormatter"/> to format + the date of a <see cref="T:log4net.Core.LoggingEvent"/>. + </para> + <para> + Uses a <see cref="T:log4net.DateFormatter.IDateFormatter"/> to format the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> + in Universal time. + </para> + <para> + See the <see cref="T:log4net.Layout.Pattern.DatePatternConverter"/> for details on the date pattern syntax. + </para> + </remarks> + <seealso cref="T:log4net.Layout.Pattern.DatePatternConverter"/> + <author>Nicko Cadell</author> + </member> + <member name="M:log4net.Layout.Pattern.UtcDatePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)"> + <summary> + Write the TimeStamp to the output + </summary> + <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param> + <param name="loggingEvent">the event being logged</param> + <remarks> + <para> + Pass the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> to the <see cref="T:log4net.DateFormatter.IDateFormatter"/> + for it to render it to the writer. + </para> + <para> + The <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> passed is in the local time zone, this is converted + to Universal time before it is rendered. + </para> + </remarks> + <seealso cref="T:log4net.Layout.Pattern.DatePatternConverter"/> + </member> + <member name="F:log4net.Layout.Pattern.UtcDatePatternConverter.declaringType"> + <summary> + The fully qualified type of the UtcDatePatternConverter class. + </summary> + <remarks> + Used by the internal logger to record the Type of the + log message. + </remarks> + </member> + <member name="T:log4net.Layout.DynamicPatternLayout"> + <summary> + A flexible layout configurable with pattern string that re-evaluates on each call. + </summary> + <remarks> + <para>This class is built on <see cref="T:log4net.Layout.PatternLayout"></see> and provides all the + features and capabilities of PatternLayout. PatternLayout is a 'static' class + in that its layout is done once at configuration time. This class will recreate + the layout on each reference.</para> + <para>One important difference between PatternLayout and DynamicPatternLayout is the + treatment of the Header and Footer parameters in the configuration. The Header and Footer + parameters for DynamicPatternLayout must be syntactically in the form of a PatternString, + but should not be marked as type log4net.Util.PatternString. Doing so causes the + pattern to be statically converted at configuration time and causes DynamicPatternLayout + to perform the same as PatternLayout.</para> + <para>Please see <see cref="T:log4net.Layout.PatternLayout"/> for complete documentation.</para> + <example> + <layout type="log4net.Layout.DynamicPatternLayout"> + <param name="Header" value="%newline**** Trace Opened Local: %date{yyyy-MM-dd HH:mm:ss.fff} UTC: %utcdate{yyyy-MM-dd HH:mm:ss.fff} ****%newline" /> + <param name="Footer" value="**** Trace Closed %date{yyyy-MM-dd HH:mm:ss.fff} ****%newline" /> + </layout> + </example> + </remarks> + </member> + <member name="T:log4net.Layout.PatternLayout"> + <summary> + A flexible layout configurable with pattern string. + </summary> + <remarks> + <para> + The goal of this class is to <see cref="M:PatternLayout.Format(TextWriter,LoggingEvent)"/> a + <see cref="T:log4net.Core.LoggingEvent"/> as a string. The results + depend on the <i>conversion pattern</i>. + </para> + <para> + The conversion pattern is closely related to the conversion + pattern of the printf function in C. A conversion pattern is + composed of literal text and format control expressions called + <i>conversion specifiers</i>. + </para> + <para> + <i>You are free to insert any literal text within the conversion + pattern.</i> + </para> + <para> + Each conversion specifier starts with a percent sign (%) and is + followed by optional <i>format modifiers</i> and a <i>conversion + pattern name</i>. The conversion pattern name specifies the type of + data, e.g. logger, level, date, thread name. The format + modifiers control such things as field width, padding, left and + right justification. The following is a simple example. + </para> + <para> + Let the conversion pattern be <b>"%-5level [%thread]: %message%newline"</b> and assume + that the log4net environment was set to use a PatternLayout. Then the + statements + </para> + <code lang="C#"> + ILog log = LogManager.GetLogger(typeof(TestApp)); + log.Debug("Message 1"); + log.Warn("Message 2"); + </code> + <para>would yield the output</para> + <code> + DEBUG [main]: Message 1 + WARN [main]: Message 2 + </code> + <para> + Note that there is no explicit separator between text and + conversion specifiers. The pattern parser knows when it has reached + the end of a conversion specifier when it reads a conversion + character. In the example above the conversion specifier + <b>%-5level</b> means the level of the logging event should be left + justified to a width of five characters. + </para> + <para> + The recognized conversion pattern names are: + </para> + <list type="table"> + <listheader> + <term>Conversion Pattern Name</term> + <description>Effect</description> + </listheader> + <item> + <term>a</term> + <description>Equivalent to <b>appdomain</b></description> + </item> + <item> + <term>appdomain</term> + <description> + Used to output the friendly name of the AppDomain where the + logging event was generated. + </description> + </item> + <item> + <term>aspnet-cache</term> + <description> + <para> + Used to output all cache items in the case of <b>%aspnet-cache</b> or just one named item if used as <b>%aspnet-cache{key}</b> + </para> + <para> + This pattern is not available for Compact Framework or Client Profile assemblies. + </para> + </description> + </item> + <item> + <term>aspnet-context</term> + <description> + <para> + Used to output all context items in the case of <b>%aspnet-context</b> or just one named item if used as <b>%aspnet-context{key}</b> + </para> + <para> + This pattern is not available for Compact Framework or Client Profile assemblies. + </para> + </description> + </item> + <item> + <term>aspnet-request</term> + <description> + <para> + Used to output all request parameters in the case of <b>%aspnet-request</b> or just one named param if used as <b>%aspnet-request{key}</b> + </para> + <para> + This pattern is not available for Compact Framework or Client Profile assemblies. + </para> + </description> + </item> + <item> + <term>aspnet-session</term> + <description> + <para> + Used to output all session items in the case of <b>%aspnet-session</b> or just one named item if used as <b>%aspnet-session{key}</b> + </para> + <para> + This pattern is not available for Compact Framework or Client Profile assemblies. + </para> + </description> + </item> + <item> + <term>c</term> + <description>Equivalent to <b>logger</b></description> + </item> + <item> + <term>C</term> + <description>Equivalent to <b>type</b></description> + </item> + <item> + <term>class</term> + <description>Equivalent to <b>type</b></description> + </item> + <item> + <term>d</term> + <description>Equivalent to <b>date</b></description> + </item> + <item> + <term>date</term> + <description> + <para> + Used to output the date of the logging event in the local time zone. + To output the date in universal time use the <c>%utcdate</c> pattern. + The date conversion + specifier may be followed by a <i>date format specifier</i> enclosed + between braces. For example, <b>%date{HH:mm:ss,fff}</b> or + <b>%date{dd MMM yyyy HH:mm:ss,fff}</b>. If no date format specifier is + given then ISO8601 format is + assumed (<see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>). + </para> + <para> + The date format specifier admits the same syntax as the + time pattern string of the <see cref="M:DateTime.ToString(string)"/>. + </para> + <para> + For better results it is recommended to use the log4net date + formatters. These can be specified using one of the strings + "ABSOLUTE", "DATE" and "ISO8601" for specifying + <see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/>, + <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> and respectively + <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>. For example, + <b>%date{ISO8601}</b> or <b>%date{ABSOLUTE}</b>. + </para> + <para> + These dedicated date formatters perform significantly + better than <see cref="M:DateTime.ToString(string)"/>. + </para> + </description> + </item> + <item> + <term>exception</term> + <description> + <para> + Used to output the exception passed in with the log message. + </para> + <para> + If an exception object is stored in the logging event + it will be rendered into the pattern output with a + trailing newline. + If there is no exception then nothing will be output + and no trailing newline will be appended. + It is typical to put a newline before the exception + and to have the exception as the last data in the pattern. + </para> + </description> + </item> + <item> + <term>F</term> + <description>Equivalent to <b>file</b></description> + </item> + <item> + <term>file</term> + <description> + <para> + Used to output the file name where the logging request was + issued. + </para> + <para> + <b>WARNING</b> Generating caller location information is + extremely slow. Its use should be avoided unless execution speed + is not an issue. + </para> + <para> + See the note below on the availability of caller location information. + </para> + </description> + </item> + <item> + <term>identity</term> + <description> + <para> + Used to output the user name for the currently active user + (Principal.Identity.Name). + </para> + <para> + <b>WARNING</b> Generating caller information is + extremely slow. Its use should be avoided unless execution speed + is not an issue. + </para> + </description> + </item> + <item> + <term>l</term> + <description>Equivalent to <b>location</b></description> + </item> + <item> + <term>L</term> + <description>Equivalent to <b>line</b></description> + </item> + <item> + <term>location</term> + <description> + <para> + Used to output location information of the caller which generated + the logging event. + </para> + <para> + The location information depends on the CLI implementation but + usually consists of the fully qualified name of the calling + method followed by the callers source the file name and line + number between parentheses. + </para> + <para> + The location information can be very useful. However, its + generation is <b>extremely</b> slow. Its use should be avoided + unless execution speed is not an issue. + </para> + <para> + See the note below on the availability of caller location information. + </para> + </description> + </item> + <item> + <term>level</term> + <description> + <para> + Used to output the level of the logging event. + </para> + </description> + </item> + <item> + <term>line</term> + <description> + <para> + Used to output the line number from where the logging request + was issued. + </para> + <para> + <b>WARNING</b> Generating caller location information is + extremely slow. Its use should be avoided unless execution speed + is not an issue. + </para> + <para> + See the note below on the availability of caller location information. + </para> + </description> + </item> + <item> + <term>logger</term> + <description> + <para> + Used to output the logger of the logging event. The + logger conversion specifier can be optionally followed by + <i>precision specifier</i>, that is a decimal constant in + brackets. + </para> + <para> + If a precision specifier is given, then only the corresponding + number of right most components of the logger name will be + printed. By default the logger name is printed in full. + </para> + <para> + For example, for the logger name "a.b.c" the pattern + <b>%logger{2}</b> will output "b.c". + </para> + </description> + </item> + <item> + <term>m</term> + <description>Equivalent to <b>message</b></description> + </item> + <item> + <term>M</term> + <description>Equivalent to <b>method</b></description> + </item> + <item> + <term>message</term> + <description> + <para> + Used to output the application supplied message associated with + the logging event. + </para> + </description> + </item> + <item> + <term>mdc</term> + <description> + <para> + The MDC (old name for the ThreadContext.Properties) is now part of the + combined event properties. This pattern is supported for compatibility + but is equivalent to <b>property</b>. + </para> + </description> + </item> + <item> + <term>method</term> + <description> + <para> + Used to output the method name where the logging request was + issued. + </para> + <para> + <b>WARNING</b> Generating caller location information is + extremely slow. Its use should be avoided unless execution speed + is not an issue. + </para> + <para> + See the note below on the availability of caller location information. + </para> + </description> + </item> + <item> + <term>n</term> + <description>Equivalent to <b>newline</b></description> + </item> + <item> + <term>newline</term> + <description> + <para> + Outputs the platform dependent line separator character or + characters. + </para> + <para> + This conversion pattern offers the same performance as using + non-portable line separator strings such as "\n", or "\r\n". + Thus, it is the preferred way of specifying a line separator. + </para> + </description> + </item> + <item> + <term>ndc</term> + <description> + <para> + Used to output the NDC (nested diagnostic context) associated + with the thread that generated the logging event. + </para> + </description> + </item> + <item> + <term>p</term> + <description>Equivalent to <b>level</b></description> + </item> + <item> + <term>P</term> + <description>Equivalent to <b>property</b></description> + </item> + <item> + <term>properties</term> + <description>Equivalent to <b>property</b></description> + </item> + <item> + <term>property</term> + <description> + <para> + Used to output the an event specific property. The key to + lookup must be specified within braces and directly following the + pattern specifier, e.g. <b>%property{user}</b> would include the value + from the property that is keyed by the string 'user'. Each property value + that is to be included in the log must be specified separately. + Properties are added to events by loggers or appenders. By default + the <c>log4net:HostName</c> property is set to the name of machine on + which the event was originally logged. + </para> + <para> + If no key is specified, e.g. <b>%property</b> then all the keys and their + values are printed in a comma separated list. + </para> + <para> + The properties of an event are combined from a number of different + contexts. These are listed below in the order in which they are searched. + </para> + <list type="definition"> + <item> + <term>the event properties</term> + <description> + The event has <see cref="P:log4net.Core.LoggingEvent.Properties"/> that can be set. These + properties are specific to this event only. + </description> + </item> + <item> + <term>the thread properties</term> + <description> + The <see cref="P:log4net.ThreadContext.Properties"/> that are set on the current + thread. These properties are shared by all events logged on this thread. + </description> + </item> + <item> + <term>the global properties</term> + <description> + The <see cref="P:log4net.GlobalContext.Properties"/> that are set globally. These + properties are shared by all the threads in the AppDomain. + </description> + </item> + </list> + + </description> + </item> + <item> + <term>r</term> + <description>Equivalent to <b>timestamp</b></description> + </item> + <item> + <term>stacktrace</term> + <description> + <para> + Used to output the stack trace of the logging event + The stack trace level specifier may be enclosed + between braces. For example, <b>%stacktrace{level}</b>. + If no stack trace level specifier is given then 1 is assumed + </para> + <para> + Output uses the format: + type3.MethodCall3 > type2.MethodCall2 > type1.MethodCall1 + </para> + <para> + This pattern is not available for Compact Framework assemblies. + </para> + </description> + </item> + <item> + <term>stacktracedetail</term> + <description> + <para> + Used to output the stack trace of the logging event + The stack trace level specifier may be enclosed + between braces. For example, <b>%stacktracedetail{level}</b>. + If no stack trace level specifier is given then 1 is assumed + </para> + <para> + Output uses the format: + type3.MethodCall3(type param,...) > type2.MethodCall2(type param,...) > type1.MethodCall1(type param,...) + </para> + <para> + This pattern is not available for Compact Framework assemblies. + </para> + </description> + </item> + <item> + <term>t</term> + <description>Equivalent to <b>thread</b></description> + </item> + <item> + <term>timestamp</term> + <description> + <para> + Used to output the number of milliseconds elapsed since the start + of the application until the creation of the logging event. + </para> + </description> + </item> + <item> + <term>thread</term> + <description> + <para> + Used to output the name of the thread that generated the + logging event. Uses the thread number if no name is available. + </para> + </description> + </item> + <item> + <term>type</term> + <description> + <para> + Used to output the fully qualified type name of the caller + issuing the logging request. This conversion specifier + can be optionally followed by <i>precision specifier</i>, that + is a decimal constant in brackets. + </para> + <para> + If a precision specifier is given, then only the corresponding + number of right most components of the class name will be + printed. By default the class name is output in fully qualified form. + </para> + <para> + For example, for the class name "log4net.Layout.PatternLayout", the + pattern <b>%type{1}</b> will output "PatternLayout". + </para> + <para> + <b>WARNING</b> Generating the caller class information is + slow. Thus, its use should be avoided unless execution speed is + not an issue. + </para> + <para> + See the note below on the availability of caller location information. + </para> + </description> + </item> + <item> + <term>u</term> + <description>Equivalent to <b>identity</b></description> + </item> + <item> + <term>username</term> + <description> + <para> + Used to output the WindowsIdentity for the currently + active user. + </para> + <para> + <b>WARNING</b> Generating caller WindowsIdentity information is + extremely slow. Its use should be avoided unless execution speed + is not an issue. + </para> + </description> + </item> + <item> + <term>utcdate</term> + <description> + <para> + Used to output the date of the logging event in universal time. + The date conversion + specifier may be followed by a <i>date format specifier</i> enclosed + between braces. For example, <b>%utcdate{HH:mm:ss,fff}</b> or + <b>%utcdate{dd MMM yyyy HH:mm:ss,fff}</b>. If no date format specifier is + given then ISO8601 format is + assumed (<see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>). + </para> + <para> + The date format specifier admits the same syntax as the + time pattern string of the <see cref="M:DateTime.ToString(string)"/>. + </para> + <para> + For better results it is recommended to use the log4net date + formatters. These can be specified using one of the strings + "ABSOLUTE", "DATE" and "ISO8601" for specifying + <see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/>, + <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> and respectively + <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>. For example, + <b>%utcdate{ISO8601}</b> or <b>%utcdate{ABSOLUTE}</b>. + </para> + <para> + These dedicated date formatters perform significantly + better than <see cref="M:DateTime.ToString(string)"/>. + </para> + </description> + </item> + <item> + <term>w</term> + <description>Equivalent to <b>username</b></description> + </item> + <item> + <term>x</term> + <description>Equivalent to <b>ndc</b></description> + </item> + <item> + <term>X</term> + <description>Equivalent to <b>mdc</b></description> + </item> + <item> + <term>%</term> + <description> + <para> + The sequence %% outputs a single percent sign. + </para> + </description> + </item> + </list> + <para> + The single letter patterns are deprecated in favor of the + longer more descriptive pattern names. + </para> + <para> + By default the relevant information is output as is. However, + with the aid of format modifiers it is possible to change the + minimum field width, the maximum field width and justification. + </para> + <para> + The optional format modifier is placed between the percent sign + and the conversion pattern name. + </para> + <para> + The first optional format modifier is the <i>left justification + flag</i> which is just the minus (-) character. Then comes the + optional <i>minimum field width</i> modifier. This is a decimal + constant that represents the minimum number of characters to + output. If the data item requires fewer characters, it is padded on + either the left or the right until the minimum width is + reached. The default is to pad on the left (right justify) but you + can specify right padding with the left justification flag. The + padding character is space. If the data item is larger than the + minimum field width, the field is expanded to accommodate the + data. The value is never truncated. + </para> + <para> + This behavior can be changed using the <i>maximum field + width</i> modifier which is designated by a period followed by a + decimal constant. If the data item is longer than the maximum + field, then the extra characters are removed from the + <i>beginning</i> of the data item and not from the end. For + example, it the maximum field width is eight and the data item is + ten characters long, then the first two characters of the data item + are dropped. This behavior deviates from the printf function in C + where truncation is done from the end. + </para> + <para> + Below are various format modifier examples for the logger + conversion specifier. + </para> + <div class="tablediv"> + <table class="dtTABLE" cellspacing="0"> + <tr> + <th>Format modifier</th> + <th>left justify</th> + <th>minimum width</th> + <th>maximum width</th> + <th>comment</th> + </tr> + <tr> + <td align="center">%20logger</td> + <td align="center">false</td> + <td align="center">20</td> + <td align="center">none</td> + <td> + <para> + Left pad with spaces if the logger name is less than 20 + characters long. + </para> + </td> + </tr> + <tr> + <td align="center">%-20logger</td> + <td align="center">true</td> + <td align="center">20</td> + <td align="center">none</td> + <td> + <para> + Right pad with spaces if the logger + name is less than 20 characters long. + </para> + </td> + </tr> + <tr> + <td align="center">%.30logger</td> + <td align="center">NA</td> + <td align="center">none</td> + <td align="center">30</td> + <td> + <para> + Truncate from the beginning if the logger + name is longer than 30 characters. + </para> + </td> + </tr> + <tr> + <td align="center"><nobr>%20.30logger</nobr></td> + <td align="center">false</td> + <td align="center">20</td> + <td align="center">30</td> + <td> + <para> + Left pad with spaces if the logger name is shorter than 20 + characters. However, if logger name is longer than 30 characters, + then truncate from the beginning. + </para> + </td> + </tr> + <tr> + <td align="center">%-20.30logger</td> + <td align="center">true</td> + <td align="center">20</td> + <td align="center">30</td> + <td> + <para> + Right pad with spaces if the logger name is shorter than 20 + characters. However, if logger name is longer than 30 characters, + then truncate from the beginning. + </para> + </td> + </tr> + </table> + </div> + <para> + <b>Note about caller location information.</b><br/> + The following patterns <c>%type %file %line %method %location %class %C %F %L %l %M</c> + all generate caller location information. + Location information uses the <c>System.Diagnostics.StackTrace</c> class to generate + a call stack. The caller's information is then extracted from this stack. + </para> + <note type="caution"> + <para> + The <c>System.Diagnostics.StackTrace</c> class is not supported on the + .NET Compact Framework 1.0 therefore caller location information is not + available on that framework. + </para> + </note> + <note type="caution"> + <para> + The <c>System.Diagnostics.StackTrace</c> class has this to say about Release builds: + </para> + <para> + "StackTrace information will be most informative with Debug build configurations. + By default, Debug builds include debug symbols, while Release builds do not. The + debug symbols contain most of the file, method name, line number, and column + information used in constructing StackFrame and StackTrace objects. StackTrace + might not report as many method calls as expected, due to code transformations + that occur during optimization." + </para> + <para> + This means that in a Release build the caller information may be incomplete or may + not exist at all! Therefore caller location information cannot be relied upon in a Release build. + </para> + </note> + <para> + Additional pattern converters may be registered with a specific <see cref="T:log4net.Layout.PatternLayout"/> + instance using the <see cref="M:AddConverter(string, Type)"/> method. + </para> + </remarks> + <example> + This is a more detailed pattern. + <code><b>%timestamp [%thread] %level %logger %ndc - %message%newline</b></code> + </example> + <example> + A similar pattern except that the relative time is + right padded if less than 6 digits, thread name is right padded if + less than 15 characters and truncated if longer and the logger + name is left padded if shorter than 30 characters and truncated if + longer. + <code><b>%-6timestamp [%15.15thread] %-5level %30.30logger %ndc - %message%newline</b></code> + </example> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + <author>Douglas de la Torre</author> + <author>Daniel Cazzulino</author> + </member> + <member name="T:log4net.Layout.LayoutSkeleton"> + <summary> + Extend this abstract class to create your own log layout format. + </summary> + <remarks> + <para> + This is the base implementation of the <see cref="T:log4net.Layout.ILayout"/> + interface. Most layout objects should extend this class. + </para> + </remarks> + <remarks> + <note type="inheritinfo"> + <para> + Subclasses must implement the <see cref="M:Format(TextWriter,LoggingEvent)"/> + method. + </para> + <para> + Subclasses should set the <see cref="P:log4net.Layout.LayoutSkeleton.IgnoresException"/> in their default + constructor. + </para> + </note> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="T:log4net.Layout.ILayout"> + <summary> + Interface implemented by layout objects + </summary> + <remarks> + <para> + An <see cref="T:log4net.Layout.ILayout"/> object is used to format a <see cref="T:log4net.Core.LoggingEvent"/> + as text. The <see cref="M:Format(TextWriter,LoggingEvent)"/> method is called by an + appender to transform the <see cref="T:log4net.Core.LoggingEvent"/> into a string. + </para> + <para> + The layout can also supply <see cref="P:log4net.Layout.ILayout.Header"/> and <see cref="P:log4net.Layout.ILayout.Footer"/> + text that is appender before any events and after all the events respectively. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Layout.ILayout.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)"> + <summary> + Implement this method to create your own layout format. + </summary> + <param name="writer">The TextWriter to write the formatted event to</param> + <param name="loggingEvent">The event to format</param> + <remarks> + <para> + This method is called by an appender to format + the <paramref name="loggingEvent"/> as text and output to a writer. + </para> + <para> + If the caller does not have a <see cref="T:System.IO.TextWriter"/> and prefers the + event to be formatted as a <see cref="T:System.String"/> then the following + code can be used to format the event into a <see cref="T:System.IO.StringWriter"/>. + </para> + <code lang="C#"> + StringWriter writer = new StringWriter(); + Layout.Format(writer, loggingEvent); + string formattedEvent = writer.ToString(); + </code> + </remarks> + </member> + <member name="P:log4net.Layout.ILayout.ContentType"> + <summary> + The content type output by this layout. + </summary> + <value>The content type</value> + <remarks> + <para> + The content type output by this layout. + </para> + <para> + This is a MIME type e.g. <c>"text/plain"</c>. + </para> + </remarks> + </member> + <member name="P:log4net.Layout.ILayout.Header"> + <summary> + The header for the layout format. + </summary> + <value>the layout header</value> + <remarks> + <para> + The Header text will be appended before any logging events + are formatted and appended. + </para> + </remarks> + </member> + <member name="P:log4net.Layout.ILayout.Footer"> + <summary> + The footer for the layout format. + </summary> + <value>the layout footer</value> + <remarks> + <para> + The Footer text will be appended after all the logging events + have been formatted and appended. + </para> + </remarks> + </member> + <member name="P:log4net.Layout.ILayout.IgnoresException"> + <summary> + Flag indicating if this layout handle exceptions + </summary> + <value><c>false</c> if this layout handles exceptions</value> + <remarks> + <para> + If this layout handles the exception object contained within + <see cref="T:log4net.Core.LoggingEvent"/>, then the layout should return + <c>false</c>. Otherwise, if the layout ignores the exception + object, then the layout should return <c>true</c>. + </para> + </remarks> + </member> + <member name="F:log4net.Layout.LayoutSkeleton.m_header"> + <summary> + The header text + </summary> + <remarks> + <para> + See <see cref="P:log4net.Layout.LayoutSkeleton.Header"/> for more information. + </para> + </remarks> + </member> + <member name="F:log4net.Layout.LayoutSkeleton.m_footer"> + <summary> + The footer text + </summary> + <remarks> + <para> + See <see cref="P:log4net.Layout.LayoutSkeleton.Footer"/> for more information. + </para> + </remarks> + </member> + <member name="F:log4net.Layout.LayoutSkeleton.m_ignoresException"> + <summary> + Flag indicating if this layout handles exceptions + </summary> + <remarks> + <para> + <c>false</c> if this layout handles exceptions + </para> + </remarks> + </member> + <member name="M:log4net.Layout.LayoutSkeleton.#ctor"> + <summary> + Empty default constructor + </summary> + <remarks> + <para> + Empty default constructor + </para> + </remarks> + </member> + <member name="M:log4net.Layout.LayoutSkeleton.ActivateOptions"> + <summary> + Activate component options + </summary> + <remarks> + <para> + This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object + activation scheme. The <see cref="M:log4net.Layout.LayoutSkeleton.ActivateOptions"/> method must + be called on this object after the configuration properties have + been set. Until <see cref="M:log4net.Layout.LayoutSkeleton.ActivateOptions"/> is called this + object is in an undefined state and must not be used. + </para> + <para> + If any of the configuration properties are modified then + <see cref="M:log4net.Layout.LayoutSkeleton.ActivateOptions"/> must be called again. + </para> + <para> + This method must be implemented by the subclass. + </para> + </remarks> + </member> + <member name="M:log4net.Layout.LayoutSkeleton.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)"> + <summary> + Implement this method to create your own layout format. + </summary> + <param name="writer">The TextWriter to write the formatted event to</param> + <param name="loggingEvent">The event to format</param> + <remarks> + <para> + This method is called by an appender to format + the <paramref name="loggingEvent"/> as text. + </para> + </remarks> + </member> + <member name="M:log4net.Layout.LayoutSkeleton.Format(log4net.Core.LoggingEvent)"> + <summary> + Convenience method for easily formatting the logging event into a string variable. + </summary> + <param name="loggingEvent"></param> + <remarks> + Creates a new StringWriter instance to store the formatted logging event. + </remarks> + </member> + <member name="P:log4net.Layout.LayoutSkeleton.ContentType"> + <summary> + The content type output by this layout. + </summary> + <value>The content type is <c>"text/plain"</c></value> + <remarks> + <para> + The content type output by this layout. + </para> + <para> + This base class uses the value <c>"text/plain"</c>. + To change this value a subclass must override this + property. + </para> + </remarks> + </member> + <member name="P:log4net.Layout.LayoutSkeleton.Header"> + <summary> + The header for the layout format. + </summary> + <value>the layout header</value> + <remarks> + <para> + The Header text will be appended before any logging events + are formatted and appended. + </para> + </remarks> + </member> + <member name="P:log4net.Layout.LayoutSkeleton.Footer"> + <summary> + The footer for the layout format. + </summary> + <value>the layout footer</value> + <remarks> + <para> + The Footer text will be appended after all the logging events + have been formatted and appended. + </para> + </remarks> + </member> + <member name="P:log4net.Layout.LayoutSkeleton.IgnoresException"> + <summary> + Flag indicating if this layout handles exceptions + </summary> + <value><c>false</c> if this layout handles exceptions</value> + <remarks> + <para> + If this layout handles the exception object contained within + <see cref="T:log4net.Core.LoggingEvent"/>, then the layout should return + <c>false</c>. Otherwise, if the layout ignores the exception + object, then the layout should return <c>true</c>. + </para> + <para> + Set this value to override a this default setting. The default + value is <c>true</c>, this layout does not handle the exception. + </para> + </remarks> + </member> + <member name="F:log4net.Layout.PatternLayout.DefaultConversionPattern"> + <summary> + Default pattern string for log output. + </summary> + <remarks> + <para> + Default pattern string for log output. + Currently set to the string <b>"%message%newline"</b> + which just prints the application supplied message. + </para> + </remarks> + </member> + <member name="F:log4net.Layout.PatternLayout.DetailConversionPattern"> + <summary> + A detailed conversion pattern + </summary> + <remarks> + <para> + A conversion pattern which includes Time, Thread, Logger, and Nested Context. + Current value is <b>%timestamp [%thread] %level %logger %ndc - %message%newline</b>. + </para> + </remarks> + </member> + <member name="F:log4net.Layout.PatternLayout.s_globalRulesRegistry"> + <summary> + Internal map of converter identifiers to converter types. + </summary> + <remarks> + <para> + This static map is overridden by the m_converterRegistry instance map + </para> + </remarks> + </member> + <member name="F:log4net.Layout.PatternLayout.m_pattern"> + <summary> + the pattern + </summary> + </member> + <member name="F:log4net.Layout.PatternLayout.m_head"> + <summary> + the head of the pattern converter chain + </summary> + </member> + <member name="F:log4net.Layout.PatternLayout.m_instanceRulesRegistry"> + <summary> + patterns defined on this PatternLayout only + </summary> + </member> + <member name="M:log4net.Layout.PatternLayout.#cctor"> + <summary> + Initialize the global registry + </summary> + <remarks> + <para> + Defines the builtin global rules. + </para> + </remarks> + </member> + <member name="M:log4net.Layout.PatternLayout.#ctor"> + <summary> + Constructs a PatternLayout using the DefaultConversionPattern + </summary> + <remarks> + <para> + The default pattern just produces the application supplied message. + </para> + <para> + Note to Inheritors: This constructor calls the virtual method + <see cref="M:log4net.Layout.PatternLayout.CreatePatternParser(System.String)"/>. If you override this method be + aware that it will be called before your is called constructor. + </para> + <para> + As per the <see cref="T:log4net.Core.IOptionHandler"/> contract the <see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/> + method must be called after the properties on this object have been + configured. + </para> + </remarks> + </member> + <member name="M:log4net.Layout.PatternLayout.#ctor(System.String)"> + <summary> + Constructs a PatternLayout using the supplied conversion pattern + </summary> + <param name="pattern">the pattern to use</param> + <remarks> + <para> + Note to Inheritors: This constructor calls the virtual method + <see cref="M:log4net.Layout.PatternLayout.CreatePatternParser(System.String)"/>. If you override this method be + aware that it will be called before your is called constructor. + </para> + <para> + When using this constructor the <see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/> method + need not be called. This may not be the case when using a subclass. + </para> + </remarks> + </member> + <member name="M:log4net.Layout.PatternLayout.CreatePatternParser(System.String)"> + <summary> + Create the pattern parser instance + </summary> + <param name="pattern">the pattern to parse</param> + <returns>The <see cref="T:log4net.Util.PatternParser"/> that will format the event</returns> + <remarks> + <para> + Creates the <see cref="T:log4net.Util.PatternParser"/> used to parse the conversion string. Sets the + global and instance rules on the <see cref="T:log4net.Util.PatternParser"/>. + </para> + </remarks> + </member> + <member name="M:log4net.Layout.PatternLayout.ActivateOptions"> + <summary> + Initialize layout options + </summary> + <remarks> + <para> + This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object + activation scheme. The <see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/> method must + be called on this object after the configuration properties have + been set. Until <see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/> is called this + object is in an undefined state and must not be used. + </para> + <para> + If any of the configuration properties are modified then + <see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/> must be called again. + </para> + </remarks> + </member> + <member name="M:log4net.Layout.PatternLayout.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)"> + <summary> + Produces a formatted string as specified by the conversion pattern. + </summary> + <param name="loggingEvent">the event being logged</param> + <param name="writer">The TextWriter to write the formatted event to</param> + <remarks> + <para> + Parse the <see cref="T:log4net.Core.LoggingEvent"/> using the patter format + specified in the <see cref="P:log4net.Layout.PatternLayout.ConversionPattern"/> property. + </para> + </remarks> + </member> + <member name="M:log4net.Layout.PatternLayout.AddConverter(log4net.Util.ConverterInfo)"> + <summary> + Add a converter to this PatternLayout + </summary> + <param name="converterInfo">the converter info</param> + <remarks> + <para> + This version of the method is used by the configurator. + Programmatic users should use the alternative <see cref="M:AddConverter(string,Type)"/> method. + </para> + </remarks> + </member> + <member name="M:log4net.Layout.PatternLayout.AddConverter(System.String,System.Type)"> + <summary> + Add a converter to this PatternLayout + </summary> + <param name="name">the name of the conversion pattern for this converter</param> + <param name="type">the type of the converter</param> + <remarks> + <para> + Add a named pattern converter to this instance. This + converter will be used in the formatting of the event. + This method must be called before <see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/>. + </para> + <para> + The <paramref name="type"/> specified must extend the + <see cref="T:log4net.Util.PatternConverter"/> type. + </para> + </remarks> + </member> + <member name="P:log4net.Layout.PatternLayout.ConversionPattern"> + <summary> + The pattern formatting string + </summary> + <remarks> + <para> + The <b>ConversionPattern</b> option. This is the string which + controls formatting and consists of a mix of literal content and + conversion specifiers. + </para> + </remarks> + </member> + <member name="F:log4net.Layout.DynamicPatternLayout.m_headerPatternString"> + <summary> + The header PatternString + </summary> + </member> + <member name="F:log4net.Layout.DynamicPatternLayout.m_footerPatternString"> + <summary> + The footer PatternString + </summary> + </member> + <member name="M:log4net.Layout.DynamicPatternLayout.#ctor"> + <summary> + Constructs a DynamicPatternLayout using the DefaultConversionPattern + </summary> + <remarks> + <para> + The default pattern just produces the application supplied message. + </para> + </remarks> + </member> + <member name="M:log4net.Layout.DynamicPatternLayout.#ctor(System.String)"> + <summary> + Constructs a DynamicPatternLayout using the supplied conversion pattern + </summary> + <param name="pattern">the pattern to use</param> + <remarks> + </remarks> + </member> + <member name="P:log4net.Layout.DynamicPatternLayout.Header"> + <summary> + The header for the layout format. + </summary> + <value>the layout header</value> + <remarks> + <para> + The Header text will be appended before any logging events + are formatted and appended. + </para> + The pattern will be formatted on each get operation. + </remarks> + </member> + <member name="P:log4net.Layout.DynamicPatternLayout.Footer"> + <summary> + The footer for the layout format. + </summary> + <value>the layout footer</value> + <remarks> + <para> + The Footer text will be appended after all the logging events + have been formatted and appended. + </para> + The pattern will be formatted on each get operation. + </remarks> + </member> + <member name="T:log4net.Layout.ExceptionLayout"> + <summary> + A Layout that renders only the Exception text from the logging event + </summary> + <remarks> + <para> + A Layout that renders only the Exception text from the logging event. + </para> + <para> + This Layout should only be used with appenders that utilize multiple + layouts (e.g. <see cref="T:log4net.Appender.AdoNetAppender"/>). + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Layout.ExceptionLayout.#ctor"> + <summary> + Default constructor + </summary> + <remarks> + <para> + Constructs a ExceptionLayout + </para> + </remarks> + </member> + <member name="M:log4net.Layout.ExceptionLayout.ActivateOptions"> + <summary> + Activate component options + </summary> + <remarks> + <para> + Part of the <see cref="T:log4net.Core.IOptionHandler"/> component activation + framework. + </para> + <para> + This method does nothing as options become effective immediately. + </para> + </remarks> + </member> + <member name="M:log4net.Layout.ExceptionLayout.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)"> + <summary> + Gets the exception text from the logging event + </summary> + <param name="writer">The TextWriter to write the formatted event to</param> + <param name="loggingEvent">the event being logged</param> + <remarks> + <para> + Write the exception string to the <see cref="T:System.IO.TextWriter"/>. + The exception string is retrieved from <see cref="M:LoggingEvent.GetExceptionString()"/>. + </para> + </remarks> + </member> + <member name="T:log4net.Layout.IRawLayout"> + <summary> + Interface for raw layout objects + </summary> + <remarks> + <para> + Interface used to format a <see cref="T:log4net.Core.LoggingEvent"/> + to an object. + </para> + <para> + This interface should not be confused with the + <see cref="T:log4net.Layout.ILayout"/> interface. This interface is used in + only certain specialized situations where a raw object is + required rather than a formatted string. The <see cref="T:log4net.Layout.ILayout"/> + is not generally useful than this interface. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Layout.IRawLayout.Format(log4net.Core.LoggingEvent)"> + <summary> + Implement this method to create your own layout format. + </summary> + <param name="loggingEvent">The event to format</param> + <returns>returns the formatted event</returns> + <remarks> + <para> + Implement this method to create your own layout format. + </para> + </remarks> + </member> + <member name="T:log4net.Layout.Layout2RawLayoutAdapter"> + <summary> + Adapts any <see cref="T:log4net.Layout.ILayout"/> to a <see cref="T:log4net.Layout.IRawLayout"/> + </summary> + <remarks> + <para> + Where an <see cref="T:log4net.Layout.IRawLayout"/> is required this adapter + allows a <see cref="T:log4net.Layout.ILayout"/> to be specified. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="F:log4net.Layout.Layout2RawLayoutAdapter.m_layout"> + <summary> + The layout to adapt + </summary> + </member> + <member name="M:log4net.Layout.Layout2RawLayoutAdapter.#ctor(log4net.Layout.ILayout)"> + <summary> + Construct a new adapter + </summary> + <param name="layout">the layout to adapt</param> + <remarks> + <para> + Create the adapter for the specified <paramref name="layout"/>. + </para> + </remarks> + </member> + <member name="M:log4net.Layout.Layout2RawLayoutAdapter.Format(log4net.Core.LoggingEvent)"> + <summary> + Format the logging event as an object. + </summary> + <param name="loggingEvent">The event to format</param> + <returns>returns the formatted event</returns> + <remarks> + <para> + Format the logging event as an object. + </para> + <para> + Uses the <see cref="T:log4net.Layout.ILayout"/> object supplied to + the constructor to perform the formatting. + </para> + </remarks> + </member> + <member name="T:log4net.Layout.RawLayoutConverter"> + <summary> + Type converter for the <see cref="T:log4net.Layout.IRawLayout"/> interface + </summary> + <remarks> + <para> + Used to convert objects to the <see cref="T:log4net.Layout.IRawLayout"/> interface. + Supports converting from the <see cref="T:log4net.Layout.ILayout"/> interface to + the <see cref="T:log4net.Layout.IRawLayout"/> interface using the <see cref="T:log4net.Layout.Layout2RawLayoutAdapter"/>. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="T:log4net.Util.TypeConverters.IConvertFrom"> + <summary> + Interface supported by type converters + </summary> + <remarks> + <para> + This interface supports conversion from arbitrary types + to a single target type. See <see cref="T:log4net.Util.TypeConverters.TypeConverterAttribute"/>. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Util.TypeConverters.IConvertFrom.CanConvertFrom(System.Type)"> + <summary> + Can the source type be converted to the type supported by this object + </summary> + <param name="sourceType">the type to convert</param> + <returns>true if the conversion is possible</returns> + <remarks> + <para> + Test if the <paramref name="sourceType"/> can be converted to the + type supported by this converter. + </para> + </remarks> + </member> + <member name="M:log4net.Util.TypeConverters.IConvertFrom.ConvertFrom(System.Object)"> + <summary> + Convert the source object to the type supported by this object + </summary> + <param name="source">the object to convert</param> + <returns>the converted object</returns> + <remarks> + <para> + Converts the <paramref name="source"/> to the type supported + by this converter. + </para> + </remarks> + </member> + <member name="M:log4net.Layout.RawLayoutConverter.CanConvertFrom(System.Type)"> + <summary> + Can the sourceType be converted to an <see cref="T:log4net.Layout.IRawLayout"/> + </summary> + <param name="sourceType">the source to be to be converted</param> + <returns><c>true</c> if the source type can be converted to <see cref="T:log4net.Layout.IRawLayout"/></returns> + <remarks> + <para> + Test if the <paramref name="sourceType"/> can be converted to a + <see cref="T:log4net.Layout.IRawLayout"/>. Only <see cref="T:log4net.Layout.ILayout"/> is supported + as the <paramref name="sourceType"/>. + </para> + </remarks> + </member> + <member name="M:log4net.Layout.RawLayoutConverter.ConvertFrom(System.Object)"> + <summary> + Convert the value to a <see cref="T:log4net.Layout.IRawLayout"/> object + </summary> + <param name="source">the value to convert</param> + <returns>the <see cref="T:log4net.Layout.IRawLayout"/> object</returns> + <remarks> + <para> + Convert the <paramref name="source"/> object to a + <see cref="T:log4net.Layout.IRawLayout"/> object. If the <paramref name="source"/> object + is a <see cref="T:log4net.Layout.ILayout"/> then the <see cref="T:log4net.Layout.Layout2RawLayoutAdapter"/> + is used to adapt between the two interfaces, otherwise an + exception is thrown. + </para> + </remarks> + </member> + <member name="T:log4net.Layout.RawPropertyLayout"> + <summary> + Extract the value of a property from the <see cref="T:log4net.Core.LoggingEvent"/> + </summary> + <remarks> + <para> + Extract the value of a property from the <see cref="T:log4net.Core.LoggingEvent"/> + </para> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="M:log4net.Layout.RawPropertyLayout.#ctor"> + <summary> + Constructs a RawPropertyLayout + </summary> + </member> + <member name="M:log4net.Layout.RawPropertyLayout.Format(log4net.Core.LoggingEvent)"> + <summary> + Lookup the property for <see cref="P:log4net.Layout.RawPropertyLayout.Key"/> + </summary> + <param name="loggingEvent">The event to format</param> + <returns>returns property value</returns> + <remarks> + <para> + Looks up and returns the object value of the property + named <see cref="P:log4net.Layout.RawPropertyLayout.Key"/>. If there is no property defined + with than name then <c>null</c> will be returned. + </para> + </remarks> + </member> + <member name="P:log4net.Layout.RawPropertyLayout.Key"> + <summary> + The name of the value to lookup in the LoggingEvent Properties collection. + </summary> + <value> + Value to lookup in the LoggingEvent Properties collection + </value> + <remarks> + <para> + String name of the property to lookup in the <see cref="T:log4net.Core.LoggingEvent"/>. + </para> + </remarks> + </member> + <member name="T:log4net.Layout.RawTimeStampLayout"> + <summary> + Extract the date from the <see cref="T:log4net.Core.LoggingEvent"/> + </summary> + <remarks> + <para> + Extract the date from the <see cref="T:log4net.Core.LoggingEvent"/> + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Layout.RawTimeStampLayout.#ctor"> + <summary> + Constructs a RawTimeStampLayout + </summary> + </member> + <member name="M:log4net.Layout.RawTimeStampLayout.Format(log4net.Core.LoggingEvent)"> + <summary> + Gets the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> as a <see cref="T:System.DateTime"/>. + </summary> + <param name="loggingEvent">The event to format</param> + <returns>returns the time stamp</returns> + <remarks> + <para> + Gets the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> as a <see cref="T:System.DateTime"/>. + </para> + <para> + The time stamp is in local time. To format the time stamp + in universal time use <see cref="T:log4net.Layout.RawUtcTimeStampLayout"/>. + </para> + </remarks> + </member> + <member name="T:log4net.Layout.RawUtcTimeStampLayout"> + <summary> + Extract the date from the <see cref="T:log4net.Core.LoggingEvent"/> + </summary> + <remarks> + <para> + Extract the date from the <see cref="T:log4net.Core.LoggingEvent"/> + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Layout.RawUtcTimeStampLayout.#ctor"> + <summary> + Constructs a RawUtcTimeStampLayout + </summary> + </member> + <member name="M:log4net.Layout.RawUtcTimeStampLayout.Format(log4net.Core.LoggingEvent)"> + <summary> + Gets the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> as a <see cref="T:System.DateTime"/>. + </summary> + <param name="loggingEvent">The event to format</param> + <returns>returns the time stamp</returns> + <remarks> + <para> + Gets the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> as a <see cref="T:System.DateTime"/>. + </para> + <para> + The time stamp is in universal time. To format the time stamp + in local time use <see cref="T:log4net.Layout.RawTimeStampLayout"/>. + </para> + </remarks> + </member> + <member name="T:log4net.Layout.SimpleLayout"> + <summary> + A very simple layout + </summary> + <remarks> + <para> + SimpleLayout consists of the level of the log statement, + followed by " - " and then the log message itself. For example, + <code> + DEBUG - Hello world + </code> + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Layout.SimpleLayout.#ctor"> + <summary> + Constructs a SimpleLayout + </summary> + </member> + <member name="M:log4net.Layout.SimpleLayout.ActivateOptions"> + <summary> + Initialize layout options + </summary> + <remarks> + <para> + This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object + activation scheme. The <see cref="M:log4net.Layout.SimpleLayout.ActivateOptions"/> method must + be called on this object after the configuration properties have + been set. Until <see cref="M:log4net.Layout.SimpleLayout.ActivateOptions"/> is called this + object is in an undefined state and must not be used. + </para> + <para> + If any of the configuration properties are modified then + <see cref="M:log4net.Layout.SimpleLayout.ActivateOptions"/> must be called again. + </para> + </remarks> + </member> + <member name="M:log4net.Layout.SimpleLayout.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)"> + <summary> + Produces a simple formatted output. + </summary> + <param name="loggingEvent">the event being logged</param> + <param name="writer">The TextWriter to write the formatted event to</param> + <remarks> + <para> + Formats the event as the level of the even, + followed by " - " and then the log message itself. The + output is terminated by a newline. + </para> + </remarks> + </member> + <member name="T:log4net.Layout.XmlLayout"> + <summary> + Layout that formats the log events as XML elements. + </summary> + <remarks> + <para> + The output of the <see cref="T:log4net.Layout.XmlLayout"/> consists of a series of + log4net:event elements. It does not output a complete well-formed XML + file. The output is designed to be included as an <em>external entity</em> + in a separate file to form a correct XML file. + </para> + <para> + For example, if <c>abc</c> is the name of the file where + the <see cref="T:log4net.Layout.XmlLayout"/> output goes, then a well-formed XML file would + be: + </para> + <code lang="XML"> + <?xml version="1.0" ?> + + <!DOCTYPE log4net:events SYSTEM "log4net-events.dtd" [<!ENTITY data SYSTEM "abc">]> + + <log4net:events version="1.2" xmlns:log4net="http://logging.apache.org/log4net/schemas/log4net-events-1.2> + &data; + </log4net:events> + </code> + <para> + This approach enforces the independence of the <see cref="T:log4net.Layout.XmlLayout"/> + and the appender where it is embedded. + </para> + <para> + The <c>version</c> attribute helps components to correctly + interpret output generated by <see cref="T:log4net.Layout.XmlLayout"/>. The value of + this attribute should be "1.2" for release 1.2 and later. + </para> + <para> + Alternatively the <c>Header</c> and <c>Footer</c> properties can be + configured to output the correct XML header, open tag and close tag. + When setting the <c>Header</c> and <c>Footer</c> properties it is essential + that the underlying data store not be appendable otherwise the data + will become invalid XML. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="T:log4net.Layout.XmlLayoutBase"> + <summary> + Layout that formats the log events as XML elements. + </summary> + <remarks> + <para> + This is an abstract class that must be subclassed by an implementation + to conform to a specific schema. + </para> + <para> + Deriving classes must implement the <see cref="M:log4net.Layout.XmlLayoutBase.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)"/> method. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Layout.XmlLayoutBase.#ctor"> + <summary> + Protected constructor to support subclasses + </summary> + <remarks> + <para> + Initializes a new instance of the <see cref="T:log4net.Layout.XmlLayoutBase"/> class + with no location info. + </para> + </remarks> + </member> + <member name="M:log4net.Layout.XmlLayoutBase.#ctor(System.Boolean)"> + <summary> + Protected constructor to support subclasses + </summary> + <remarks> + <para> + The <paramref name="locationInfo" /> parameter determines whether + location information will be output by the layout. If + <paramref name="locationInfo" /> is set to <c>true</c>, then the + file name and line number of the statement at the origin of the log + statement will be output. + </para> + <para> + If you are embedding this layout within an SMTPAppender + then make sure to set the <b>LocationInfo</b> option of that + appender as well. + </para> + </remarks> + </member> + <member name="M:log4net.Layout.XmlLayoutBase.ActivateOptions"> + <summary> + Initialize layout options + </summary> + <remarks> + <para> + This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object + activation scheme. The <see cref="M:log4net.Layout.XmlLayoutBase.ActivateOptions"/> method must + be called on this object after the configuration properties have + been set. Until <see cref="M:log4net.Layout.XmlLayoutBase.ActivateOptions"/> is called this + object is in an undefined state and must not be used. + </para> + <para> + If any of the configuration properties are modified then + <see cref="M:log4net.Layout.XmlLayoutBase.ActivateOptions"/> must be called again. + </para> + </remarks> + </member> + <member name="M:log4net.Layout.XmlLayoutBase.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)"> + <summary> + Produces a formatted string. + </summary> + <param name="loggingEvent">The event being logged.</param> + <param name="writer">The TextWriter to write the formatted event to</param> + <remarks> + <para> + Format the <see cref="T:log4net.Core.LoggingEvent"/> and write it to the <see cref="T:System.IO.TextWriter"/>. + </para> + <para> + This method creates an <see cref="T:System.Xml.XmlTextWriter"/> that writes to the + <paramref name="writer"/>. The <see cref="T:System.Xml.XmlTextWriter"/> is passed + to the <see cref="M:log4net.Layout.XmlLayoutBase.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)"/> method. Subclasses should override the + <see cref="M:log4net.Layout.XmlLayoutBase.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)"/> method rather than this method. + </para> + </remarks> + </member> + <member name="M:log4net.Layout.XmlLayoutBase.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)"> + <summary> + Does the actual writing of the XML. + </summary> + <param name="writer">The writer to use to output the event to.</param> + <param name="loggingEvent">The event to write.</param> + <remarks> + <para> + Subclasses should override this method to format + the <see cref="T:log4net.Core.LoggingEvent"/> as XML. + </para> + </remarks> + </member> + <member name="F:log4net.Layout.XmlLayoutBase.m_locationInfo"> + <summary> + Flag to indicate if location information should be included in + the XML events. + </summary> + </member> + <member name="F:log4net.Layout.XmlLayoutBase.m_invalidCharReplacement"> + <summary> + The string to replace invalid chars with + </summary> + </member> + <member name="P:log4net.Layout.XmlLayoutBase.LocationInfo"> + <summary> + Gets a value indicating whether to include location information in + the XML events. + </summary> + <value> + <c>true</c> if location information should be included in the XML + events; otherwise, <c>false</c>. + </value> + <remarks> + <para> + If <see cref="P:log4net.Layout.XmlLayoutBase.LocationInfo"/> is set to <c>true</c>, then the file + name and line number of the statement at the origin of the log + statement will be output. + </para> + <para> + If you are embedding this layout within an <c>SMTPAppender</c> + then make sure to set the <b>LocationInfo</b> option of that + appender as well. + </para> + </remarks> + </member> + <member name="P:log4net.Layout.XmlLayoutBase.InvalidCharReplacement"> + <summary> + The string to replace characters that can not be expressed in XML with. + <remarks> + <para> + Not all characters may be expressed in XML. This property contains the + string to replace those that can not with. This defaults to a ?. Set it + to the empty string to simply remove offending characters. For more + details on the allowed character ranges see http://www.w3.org/TR/REC-xml/#charsets + Character replacement will occur in the log message, the property names + and the property values. + </para> + </remarks> + </summary> + </member> + <member name="P:log4net.Layout.XmlLayoutBase.ContentType"> + <summary> + Gets the content type output by this layout. + </summary> + <value> + As this is the XML layout, the value is always <c>"text/xml"</c>. + </value> + <remarks> + <para> + As this is the XML layout, the value is always <c>"text/xml"</c>. + </para> + </remarks> + </member> + <member name="M:log4net.Layout.XmlLayout.#ctor"> + <summary> + Constructs an XmlLayout + </summary> + </member> + <member name="M:log4net.Layout.XmlLayout.#ctor(System.Boolean)"> + <summary> + Constructs an XmlLayout. + </summary> + <remarks> + <para> + The <b>LocationInfo</b> option takes a boolean value. By + default, it is set to false which means there will be no location + information output by this layout. If the the option is set to + true, then the file name and line number of the statement + at the origin of the log statement will be output. + </para> + <para> + If you are embedding this layout within an SmtpAppender + then make sure to set the <b>LocationInfo</b> option of that + appender as well. + </para> + </remarks> + </member> + <member name="M:log4net.Layout.XmlLayout.ActivateOptions"> + <summary> + Initialize layout options + </summary> + <remarks> + <para> + This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object + activation scheme. The <see cref="M:log4net.Layout.XmlLayout.ActivateOptions"/> method must + be called on this object after the configuration properties have + been set. Until <see cref="M:log4net.Layout.XmlLayout.ActivateOptions"/> is called this + object is in an undefined state and must not be used. + </para> + <para> + If any of the configuration properties are modified then + <see cref="M:log4net.Layout.XmlLayout.ActivateOptions"/> must be called again. + </para> + <para> + Builds a cache of the element names + </para> + </remarks> + </member> + <member name="M:log4net.Layout.XmlLayout.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)"> + <summary> + Does the actual writing of the XML. + </summary> + <param name="writer">The writer to use to output the event to.</param> + <param name="loggingEvent">The event to write.</param> + <remarks> + <para> + Override the base class <see cref="M:log4net.Layout.XmlLayoutBase.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)"/> method + to write the <see cref="T:log4net.Core.LoggingEvent"/> to the <see cref="T:System.Xml.XmlWriter"/>. + </para> + </remarks> + </member> + <member name="F:log4net.Layout.XmlLayout.m_prefix"> + <summary> + The prefix to use for all generated element names + </summary> + </member> + <member name="P:log4net.Layout.XmlLayout.Prefix"> + <summary> + The prefix to use for all element names + </summary> + <remarks> + <para> + The default prefix is <b>log4net</b>. Set this property + to change the prefix. If the prefix is set to an empty string + then no prefix will be written. + </para> + </remarks> + </member> + <member name="P:log4net.Layout.XmlLayout.Base64EncodeMessage"> + <summary> + Set whether or not to base64 encode the message. + </summary> + <remarks> + <para> + By default the log message will be written as text to the xml + output. This can cause problems when the message contains binary + data. By setting this to true the contents of the message will be + base64 encoded. If this is set then invalid character replacement + (see <see cref="P:log4net.Layout.XmlLayoutBase.InvalidCharReplacement"/>) will not be performed + on the log message. + </para> + </remarks> + </member> + <member name="P:log4net.Layout.XmlLayout.Base64EncodeProperties"> + <summary> + Set whether or not to base64 encode the property values. + </summary> + <remarks> + <para> + By default the properties will be written as text to the xml + output. This can cause problems when one or more properties contain + binary data. By setting this to true the values of the properties + will be base64 encoded. If this is set then invalid character replacement + (see <see cref="P:log4net.Layout.XmlLayoutBase.InvalidCharReplacement"/>) will not be performed + on the property values. + </para> + </remarks> + </member> + <member name="T:log4net.Layout.XmlLayoutSchemaLog4j"> + <summary> + Layout that formats the log events as XML elements compatible with the log4j schema + </summary> + <remarks> + <para> + Formats the log events according to the http://logging.apache.org/log4j schema. + </para> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="F:log4net.Layout.XmlLayoutSchemaLog4j.s_date1970"> + <summary> + The 1st of January 1970 in UTC + </summary> + </member> + <member name="M:log4net.Layout.XmlLayoutSchemaLog4j.#ctor"> + <summary> + Constructs an XMLLayoutSchemaLog4j + </summary> + </member> + <member name="M:log4net.Layout.XmlLayoutSchemaLog4j.#ctor(System.Boolean)"> + <summary> + Constructs an XMLLayoutSchemaLog4j. + </summary> + <remarks> + <para> + The <b>LocationInfo</b> option takes a boolean value. By + default, it is set to false which means there will be no location + information output by this layout. If the the option is set to + true, then the file name and line number of the statement + at the origin of the log statement will be output. + </para> + <para> + If you are embedding this layout within an SMTPAppender + then make sure to set the <b>LocationInfo</b> option of that + appender as well. + </para> + </remarks> + </member> + <member name="M:log4net.Layout.XmlLayoutSchemaLog4j.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)"> + <summary> + Actually do the writing of the xml + </summary> + <param name="writer">the writer to use</param> + <param name="loggingEvent">the event to write</param> + <remarks> + <para> + Generate XML that is compatible with the log4j schema. + </para> + </remarks> + </member> + <member name="P:log4net.Layout.XmlLayoutSchemaLog4j.Version"> + <summary> + The version of the log4j schema to use. + </summary> + <remarks> + <para> + Only version 1.2 of the log4j schema is supported. + </para> + </remarks> + </member> + <member name="T:log4net.ObjectRenderer.DefaultRenderer"> + <summary> + The default object Renderer. + </summary> + <remarks> + <para> + The default renderer supports rendering objects and collections to strings. + </para> + <para> + See the <see cref="M:log4net.ObjectRenderer.DefaultRenderer.RenderObject(log4net.ObjectRenderer.RendererMap,System.Object,System.IO.TextWriter)"/> method for details of the output. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="T:log4net.ObjectRenderer.IObjectRenderer"> + <summary> + Implement this interface in order to render objects as strings + </summary> + <remarks> + <para> + Certain types require special case conversion to + string form. This conversion is done by an object renderer. + Object renderers implement the <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/> + interface. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.ObjectRenderer.IObjectRenderer.RenderObject(log4net.ObjectRenderer.RendererMap,System.Object,System.IO.TextWriter)"> + <summary> + Render the object <paramref name="obj"/> to a string + </summary> + <param name="rendererMap">The map used to lookup renderers</param> + <param name="obj">The object to render</param> + <param name="writer">The writer to render to</param> + <remarks> + <para> + Render the object <paramref name="obj"/> to a + string. + </para> + <para> + The <paramref name="rendererMap"/> parameter is + provided to lookup and render other objects. This is + very useful where <paramref name="obj"/> contains + nested objects of unknown type. The <see cref="M:RendererMap.FindAndRender(object, TextWriter)"/> + method can be used to render these objects. + </para> + </remarks> + </member> + <member name="M:log4net.ObjectRenderer.DefaultRenderer.#ctor"> + <summary> + Default constructor + </summary> + <remarks> + <para> + Default constructor + </para> + </remarks> + </member> + <member name="M:log4net.ObjectRenderer.DefaultRenderer.RenderObject(log4net.ObjectRenderer.RendererMap,System.Object,System.IO.TextWriter)"> + <summary> + Render the object <paramref name="obj"/> to a string + </summary> + <param name="rendererMap">The map used to lookup renderers</param> + <param name="obj">The object to render</param> + <param name="writer">The writer to render to</param> + <remarks> + <para> + Render the object <paramref name="obj"/> to a string. + </para> + <para> + The <paramref name="rendererMap"/> parameter is + provided to lookup and render other objects. This is + very useful where <paramref name="obj"/> contains + nested objects of unknown type. The <see cref="M:RendererMap.FindAndRender(object)"/> + method can be used to render these objects. + </para> + <para> + The default renderer supports rendering objects to strings as follows: + </para> + <list type="table"> + <listheader> + <term>Value</term> + <description>Rendered String</description> + </listheader> + <item> + <term><c>null</c></term> + <description> + <para>"(null)"</para> + </description> + </item> + <item> + <term><see cref="T:System.Array"/></term> + <description> + <para> + For a one dimensional array this is the + array type name, an open brace, followed by a comma + separated list of the elements (using the appropriate + renderer), followed by a close brace. + </para> + <para> + For example: <c>int[] {1, 2, 3}</c>. + </para> + <para> + If the array is not one dimensional the + <c>Array.ToString()</c> is returned. + </para> + </description> + </item> + <item> + <term><see cref="T:System.Collections.IEnumerable"/>, <see cref="T:System.Collections.ICollection"/> & <see cref="T:System.Collections.IEnumerator"/></term> + <description> + <para> + Rendered as an open brace, followed by a comma + separated list of the elements (using the appropriate + renderer), followed by a close brace. + </para> + <para> + For example: <c>{a, b, c}</c>. + </para> + <para> + All collection classes that implement <see cref="T:System.Collections.ICollection"/> its subclasses, + or generic equivalents all implement the <see cref="T:System.Collections.IEnumerable"/> interface. + </para> + </description> + </item> + <item> + <term><see cref="T:System.Collections.DictionaryEntry"/></term> + <description> + <para> + Rendered as the key, an equals sign ('='), and the value (using the appropriate + renderer). + </para> + <para> + For example: <c>key=value</c>. + </para> + </description> + </item> + <item> + <term>other</term> + <description> + <para><c>Object.ToString()</c></para> + </description> + </item> + </list> + </remarks> + </member> + <member name="M:log4net.ObjectRenderer.DefaultRenderer.RenderArray(log4net.ObjectRenderer.RendererMap,System.Array,System.IO.TextWriter)"> + <summary> + Render the array argument into a string + </summary> + <param name="rendererMap">The map used to lookup renderers</param> + <param name="array">the array to render</param> + <param name="writer">The writer to render to</param> + <remarks> + <para> + For a one dimensional array this is the + array type name, an open brace, followed by a comma + separated list of the elements (using the appropriate + renderer), followed by a close brace. For example: + <c>int[] {1, 2, 3}</c>. + </para> + <para> + If the array is not one dimensional the + <c>Array.ToString()</c> is returned. + </para> + </remarks> + </member> + <member name="M:log4net.ObjectRenderer.DefaultRenderer.RenderEnumerator(log4net.ObjectRenderer.RendererMap,System.Collections.IEnumerator,System.IO.TextWriter)"> + <summary> + Render the enumerator argument into a string + </summary> + <param name="rendererMap">The map used to lookup renderers</param> + <param name="enumerator">the enumerator to render</param> + <param name="writer">The writer to render to</param> + <remarks> + <para> + Rendered as an open brace, followed by a comma + separated list of the elements (using the appropriate + renderer), followed by a close brace. For example: + <c>{a, b, c}</c>. + </para> + </remarks> + </member> + <member name="M:log4net.ObjectRenderer.DefaultRenderer.RenderDictionaryEntry(log4net.ObjectRenderer.RendererMap,System.Collections.DictionaryEntry,System.IO.TextWriter)"> + <summary> + Render the DictionaryEntry argument into a string + </summary> + <param name="rendererMap">The map used to lookup renderers</param> + <param name="entry">the DictionaryEntry to render</param> + <param name="writer">The writer to render to</param> + <remarks> + <para> + Render the key, an equals sign ('='), and the value (using the appropriate + renderer). For example: <c>key=value</c>. + </para> + </remarks> + </member> + <member name="T:log4net.ObjectRenderer.RendererMap"> + <summary> + Map class objects to an <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. + </summary> + <remarks> + <para> + Maintains a mapping between types that require special + rendering and the <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/> that + is used to render them. + </para> + <para> + The <see cref="M:FindAndRender(object)"/> method is used to render an + <c>object</c> using the appropriate renderers defined in this map. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.ObjectRenderer.RendererMap.#ctor"> + <summary> + Default Constructor + </summary> + <remarks> + <para> + Default constructor. + </para> + </remarks> + </member> + <member name="M:log4net.ObjectRenderer.RendererMap.FindAndRender(System.Object)"> + <summary> + Render <paramref name="obj"/> using the appropriate renderer. + </summary> + <param name="obj">the object to render to a string</param> + <returns>the object rendered as a string</returns> + <remarks> + <para> + This is a convenience method used to render an object to a string. + The alternative method <see cref="M:FindAndRender(object,TextWriter)"/> + should be used when streaming output to a <see cref="T:System.IO.TextWriter"/>. + </para> + </remarks> + </member> + <member name="M:log4net.ObjectRenderer.RendererMap.FindAndRender(System.Object,System.IO.TextWriter)"> + <summary> + Render <paramref name="obj"/> using the appropriate renderer. + </summary> + <param name="obj">the object to render to a string</param> + <param name="writer">The writer to render to</param> + <remarks> + <para> + Find the appropriate renderer for the type of the + <paramref name="obj"/> parameter. This is accomplished by calling the + <see cref="M:Get(Type)"/> method. Once a renderer is found, it is + applied on the object <paramref name="obj"/> and the result is returned + as a <see cref="T:System.String"/>. + </para> + </remarks> + </member> + <member name="M:log4net.ObjectRenderer.RendererMap.Get(System.Object)"> + <summary> + Gets the renderer for the specified object type + </summary> + <param name="obj">the object to lookup the renderer for</param> + <returns>the renderer for <paramref name="obj"/></returns> + <remarks> + <param> + Gets the renderer for the specified object type. + </param> + <param> + Syntactic sugar method that calls <see cref="M:Get(Type)"/> + with the type of the object parameter. + </param> + </remarks> + </member> + <member name="M:log4net.ObjectRenderer.RendererMap.Get(System.Type)"> + <summary> + Gets the renderer for the specified type + </summary> + <param name="type">the type to lookup the renderer for</param> + <returns>the renderer for the specified type</returns> + <remarks> + <para> + Returns the renderer for the specified type. + If no specific renderer has been defined the + <see cref="P:log4net.ObjectRenderer.RendererMap.DefaultRenderer"/> will be returned. + </para> + </remarks> + </member> + <member name="M:log4net.ObjectRenderer.RendererMap.SearchTypeAndInterfaces(System.Type)"> + <summary> + Internal function to recursively search interfaces + </summary> + <param name="type">the type to lookup the renderer for</param> + <returns>the renderer for the specified type</returns> + </member> + <member name="M:log4net.ObjectRenderer.RendererMap.Clear"> + <summary> + Clear the map of renderers + </summary> + <remarks> + <para> + Clear the custom renderers defined by using + <see cref="M:log4net.ObjectRenderer.RendererMap.Put(System.Type,log4net.ObjectRenderer.IObjectRenderer)"/>. The <see cref="P:log4net.ObjectRenderer.RendererMap.DefaultRenderer"/> + cannot be removed. + </para> + </remarks> + </member> + <member name="M:log4net.ObjectRenderer.RendererMap.Put(System.Type,log4net.ObjectRenderer.IObjectRenderer)"> + <summary> + Register an <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/> for <paramref name="typeToRender"/>. + </summary> + <param name="typeToRender">the type that will be rendered by <paramref name="renderer"/></param> + <param name="renderer">the renderer for <paramref name="typeToRender"/></param> + <remarks> + <para> + Register an object renderer for a specific source type. + This renderer will be returned from a call to <see cref="M:Get(Type)"/> + specifying the same <paramref name="typeToRender"/> as an argument. + </para> + </remarks> + </member> + <member name="P:log4net.ObjectRenderer.RendererMap.DefaultRenderer"> + <summary> + Get the default renderer instance + </summary> + <value>the default renderer</value> + <remarks> + <para> + Get the default renderer + </para> + </remarks> + </member> + <member name="T:log4net.Plugin.IPlugin"> + <summary> + Interface implemented by logger repository plugins. + </summary> + <remarks> + <para> + Plugins define additional behavior that can be associated + with a <see cref="T:log4net.Repository.ILoggerRepository"/>. + The <see cref="T:log4net.Plugin.PluginMap"/> held by the <see cref="P:log4net.Repository.ILoggerRepository.PluginMap"/> + property is used to store the plugins for a repository. + </para> + <para> + The <c>log4net.Config.PluginAttribute</c> can be used to + attach plugins to repositories created using configuration + attributes. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Plugin.IPlugin.Attach(log4net.Repository.ILoggerRepository)"> + <summary> + Attaches the plugin to the specified <see cref="T:log4net.Repository.ILoggerRepository"/>. + </summary> + <param name="repository">The <see cref="T:log4net.Repository.ILoggerRepository"/> that this plugin should be attached to.</param> + <remarks> + <para> + A plugin may only be attached to a single repository. + </para> + <para> + This method is called when the plugin is attached to the repository. + </para> + </remarks> + </member> + <member name="M:log4net.Plugin.IPlugin.Shutdown"> + <summary> + Is called when the plugin is to shutdown. + </summary> + <remarks> + <para> + This method is called to notify the plugin that + it should stop operating and should detach from + the repository. + </para> + </remarks> + </member> + <member name="P:log4net.Plugin.IPlugin.Name"> + <summary> + Gets the name of the plugin. + </summary> + <value> + The name of the plugin. + </value> + <remarks> + <para> + Plugins are stored in the <see cref="T:log4net.Plugin.PluginMap"/> + keyed by name. Each plugin instance attached to a + repository must be a unique name. + </para> + </remarks> + </member> + <member name="T:log4net.Plugin.PluginCollection"> + <summary> + A strongly-typed collection of <see cref="T:log4net.Plugin.IPlugin"/> objects. + </summary> + <author>Nicko Cadell</author> + </member> + <member name="M:log4net.Plugin.PluginCollection.ReadOnly(log4net.Plugin.PluginCollection)"> + <summary> + Creates a read-only wrapper for a <c>PluginCollection</c> instance. + </summary> + <param name="list">list to create a readonly wrapper arround</param> + <returns> + A <c>PluginCollection</c> wrapper that is read-only. + </returns> + </member> + <member name="M:log4net.Plugin.PluginCollection.#ctor"> + <summary> + Initializes a new instance of the <c>PluginCollection</c> class + that is empty and has the default initial capacity. + </summary> + </member> + <member name="M:log4net.Plugin.PluginCollection.#ctor(System.Int32)"> + <summary> + Initializes a new instance of the <c>PluginCollection</c> class + that has the specified initial capacity. + </summary> + <param name="capacity"> + The number of elements that the new <c>PluginCollection</c> is initially capable of storing. + </param> + </member> + <member name="M:log4net.Plugin.PluginCollection.#ctor(log4net.Plugin.PluginCollection)"> + <summary> + Initializes a new instance of the <c>PluginCollection</c> class + that contains elements copied from the specified <c>PluginCollection</c>. + </summary> + <param name="c">The <c>PluginCollection</c> whose elements are copied to the new collection.</param> + </member> + <member name="M:log4net.Plugin.PluginCollection.#ctor(log4net.Plugin.IPlugin[])"> + <summary> + Initializes a new instance of the <c>PluginCollection</c> class + that contains elements copied from the specified <see cref="T:log4net.Plugin.IPlugin"/> array. + </summary> + <param name="a">The <see cref="T:log4net.Plugin.IPlugin"/> array whose elements are copied to the new list.</param> + </member> + <member name="M:log4net.Plugin.PluginCollection.#ctor(System.Collections.ICollection)"> + <summary> + Initializes a new instance of the <c>PluginCollection</c> class + that contains elements copied from the specified <see cref="T:log4net.Plugin.IPlugin"/> collection. + </summary> + <param name="col">The <see cref="T:log4net.Plugin.IPlugin"/> collection whose elements are copied to the new list.</param> + </member> + <member name="M:log4net.Plugin.PluginCollection.#ctor(log4net.Plugin.PluginCollection.Tag)"> + <summary> + Allow subclasses to avoid our default constructors + </summary> + <param name="tag"></param> + <exclude/> + </member> + <member name="M:log4net.Plugin.PluginCollection.CopyTo(log4net.Plugin.IPlugin[])"> + <summary> + Copies the entire <c>PluginCollection</c> to a one-dimensional + <see cref="T:log4net.Plugin.IPlugin"/> array. + </summary> + <param name="array">The one-dimensional <see cref="T:log4net.Plugin.IPlugin"/> array to copy to.</param> + </member> + <member name="M:log4net.Plugin.PluginCollection.CopyTo(log4net.Plugin.IPlugin[],System.Int32)"> + <summary> + Copies the entire <c>PluginCollection</c> to a one-dimensional + <see cref="T:log4net.Plugin.IPlugin"/> array, starting at the specified index of the target array. + </summary> + <param name="array">The one-dimensional <see cref="T:log4net.Plugin.IPlugin"/> array to copy to.</param> + <param name="start">The zero-based index in <paramref name="array"/> at which copying begins.</param> + </member> + <member name="M:log4net.Plugin.PluginCollection.Add(log4net.Plugin.IPlugin)"> + <summary> + Adds a <see cref="T:log4net.Plugin.IPlugin"/> to the end of the <c>PluginCollection</c>. + </summary> + <param name="item">The <see cref="T:log4net.Plugin.IPlugin"/> to be added to the end of the <c>PluginCollection</c>.</param> + <returns>The index at which the value has been added.</returns> + </member> + <member name="M:log4net.Plugin.PluginCollection.Clear"> + <summary> + Removes all elements from the <c>PluginCollection</c>. + </summary> + </member> + <member name="M:log4net.Plugin.PluginCollection.Clone"> + <summary> + Creates a shallow copy of the <see cref="T:log4net.Plugin.PluginCollection"/>. + </summary> + <returns>A new <see cref="T:log4net.Plugin.PluginCollection"/> with a shallow copy of the collection data.</returns> + </member> + <member name="M:log4net.Plugin.PluginCollection.Contains(log4net.Plugin.IPlugin)"> + <summary> + Determines whether a given <see cref="T:log4net.Plugin.IPlugin"/> is in the <c>PluginCollection</c>. + </summary> + <param name="item">The <see cref="T:log4net.Plugin.IPlugin"/> to check for.</param> + <returns><c>true</c> if <paramref name="item"/> is found in the <c>PluginCollection</c>; otherwise, <c>false</c>.</returns> + </member> + <member name="M:log4net.Plugin.PluginCollection.IndexOf(log4net.Plugin.IPlugin)"> + <summary> + Returns the zero-based index of the first occurrence of a <see cref="T:log4net.Plugin.IPlugin"/> + in the <c>PluginCollection</c>. + </summary> + <param name="item">The <see cref="T:log4net.Plugin.IPlugin"/> to locate in the <c>PluginCollection</c>.</param> + <returns> + The zero-based index of the first occurrence of <paramref name="item"/> + in the entire <c>PluginCollection</c>, if found; otherwise, -1. + </returns> + </member> + <member name="M:log4net.Plugin.PluginCollection.Insert(System.Int32,log4net.Plugin.IPlugin)"> + <summary> + Inserts an element into the <c>PluginCollection</c> at the specified index. + </summary> + <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param> + <param name="item">The <see cref="T:log4net.Plugin.IPlugin"/> to insert.</param> + <exception cref="T:System.ArgumentOutOfRangeException"> + <para><paramref name="index"/> is less than zero</para> + <para>-or-</para> + <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Plugin.PluginCollection.Count"/>.</para> + </exception> + </member> + <member name="M:log4net.Plugin.PluginCollection.Remove(log4net.Plugin.IPlugin)"> + <summary> + Removes the first occurrence of a specific <see cref="T:log4net.Plugin.IPlugin"/> from the <c>PluginCollection</c>. + </summary> + <param name="item">The <see cref="T:log4net.Plugin.IPlugin"/> to remove from the <c>PluginCollection</c>.</param> + <exception cref="T:System.ArgumentException"> + The specified <see cref="T:log4net.Plugin.IPlugin"/> was not found in the <c>PluginCollection</c>. + </exception> + </member> + <member name="M:log4net.Plugin.PluginCollection.RemoveAt(System.Int32)"> + <summary> + Removes the element at the specified index of the <c>PluginCollection</c>. + </summary> + <param name="index">The zero-based index of the element to remove.</param> + <exception cref="T:System.ArgumentOutOfRangeException"> + <para><paramref name="index"/> is less than zero.</para> + <para>-or-</para> + <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Plugin.PluginCollection.Count"/>.</para> + </exception> + </member> + <member name="M:log4net.Plugin.PluginCollection.GetEnumerator"> + <summary> + Returns an enumerator that can iterate through the <c>PluginCollection</c>. + </summary> + <returns>An <see cref="T:log4net.Plugin.PluginCollection.Enumerator"/> for the entire <c>PluginCollection</c>.</returns> + </member> + <member name="M:log4net.Plugin.PluginCollection.AddRange(log4net.Plugin.PluginCollection)"> + <summary> + Adds the elements of another <c>PluginCollection</c> to the current <c>PluginCollection</c>. + </summary> + <param name="x">The <c>PluginCollection</c> whose elements should be added to the end of the current <c>PluginCollection</c>.</param> + <returns>The new <see cref="P:log4net.Plugin.PluginCollection.Count"/> of the <c>PluginCollection</c>.</returns> + </member> + <member name="M:log4net.Plugin.PluginCollection.AddRange(log4net.Plugin.IPlugin[])"> + <summary> + Adds the elements of a <see cref="T:log4net.Plugin.IPlugin"/> array to the current <c>PluginCollection</c>. + </summary> + <param name="x">The <see cref="T:log4net.Plugin.IPlugin"/> array whose elements should be added to the end of the <c>PluginCollection</c>.</param> + <returns>The new <see cref="P:log4net.Plugin.PluginCollection.Count"/> of the <c>PluginCollection</c>.</returns> + </member> + <member name="M:log4net.Plugin.PluginCollection.AddRange(System.Collections.ICollection)"> + <summary> + Adds the elements of a <see cref="T:log4net.Plugin.IPlugin"/> collection to the current <c>PluginCollection</c>. + </summary> + <param name="col">The <see cref="T:log4net.Plugin.IPlugin"/> collection whose elements should be added to the end of the <c>PluginCollection</c>.</param> + <returns>The new <see cref="P:log4net.Plugin.PluginCollection.Count"/> of the <c>PluginCollection</c>.</returns> + </member> + <member name="M:log4net.Plugin.PluginCollection.TrimToSize"> + <summary> + Sets the capacity to the actual number of elements. + </summary> + </member> + <member name="M:log4net.Plugin.PluginCollection.ValidateIndex(System.Int32)"> + <exception cref="T:System.ArgumentOutOfRangeException"> + <para><paramref name="i"/> is less than zero.</para> + <para>-or-</para> + <para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Plugin.PluginCollection.Count"/>.</para> + </exception> + </member> + <member name="M:log4net.Plugin.PluginCollection.ValidateIndex(System.Int32,System.Boolean)"> + <exception cref="T:System.ArgumentOutOfRangeException"> + <para><paramref name="i"/> is less than zero.</para> + <para>-or-</para> + <para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Plugin.PluginCollection.Count"/>.</para> + </exception> + </member> + <member name="P:log4net.Plugin.PluginCollection.Count"> + <summary> + Gets the number of elements actually contained in the <c>PluginCollection</c>. + </summary> + </member> + <member name="P:log4net.Plugin.PluginCollection.IsSynchronized"> + <summary> + Gets a value indicating whether access to the collection is synchronized (thread-safe). + </summary> + <returns>true if access to the ICollection is synchronized (thread-safe); otherwise, false.</returns> + </member> + <member name="P:log4net.Plugin.PluginCollection.SyncRoot"> + <summary> + Gets an object that can be used to synchronize access to the collection. + </summary> + <value> + An object that can be used to synchronize access to the collection. + </value> + </member> + <member name="P:log4net.Plugin.PluginCollection.Item(System.Int32)"> + <summary> + Gets or sets the <see cref="T:log4net.Plugin.IPlugin"/> at the specified index. + </summary> + <value> + The <see cref="T:log4net.Plugin.IPlugin"/> at the specified index. + </value> + <param name="index">The zero-based index of the element to get or set.</param> + <exception cref="T:System.ArgumentOutOfRangeException"> + <para><paramref name="index"/> is less than zero.</para> + <para>-or-</para> + <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Plugin.PluginCollection.Count"/>.</para> + </exception> + </member> + <member name="P:log4net.Plugin.PluginCollection.IsFixedSize"> + <summary> + Gets a value indicating whether the collection has a fixed size. + </summary> + <value><c>true</c> if the collection has a fixed size; otherwise, <c>false</c>. The default is <c>false</c>.</value> + </member> + <member name="P:log4net.Plugin.PluginCollection.IsReadOnly"> + <summary> + Gets a value indicating whether the IList is read-only. + </summary> + <value><c>true</c> if the collection is read-only; otherwise, <c>false</c>. The default is <c>false</c>.</value> + </member> + <member name="P:log4net.Plugin.PluginCollection.Capacity"> + <summary> + Gets or sets the number of elements the <c>PluginCollection</c> can contain. + </summary> + <value> + The number of elements the <c>PluginCollection</c> can contain. + </value> + </member> + <member name="T:log4net.Plugin.PluginCollection.IPluginCollectionEnumerator"> + <summary> + Supports type-safe iteration over a <see cref="T:log4net.Plugin.PluginCollection"/>. + </summary> + <exclude/> + </member> + <member name="M:log4net.Plugin.PluginCollection.IPluginCollectionEnumerator.MoveNext"> + <summary> + Advances the enumerator to the next element in the collection. + </summary> + <returns> + <c>true</c> if the enumerator was successfully advanced to the next element; + <c>false</c> if the enumerator has passed the end of the collection. + </returns> + <exception cref="T:System.InvalidOperationException"> + The collection was modified after the enumerator was created. + </exception> + </member> + <member name="M:log4net.Plugin.PluginCollection.IPluginCollectionEnumerator.Reset"> + <summary> + Sets the enumerator to its initial position, before the first element in the collection. + </summary> + </member> + <member name="P:log4net.Plugin.PluginCollection.IPluginCollectionEnumerator.Current"> + <summary> + Gets the current element in the collection. + </summary> + </member> + <member name="T:log4net.Plugin.PluginCollection.Tag"> + <summary> + Type visible only to our subclasses + Used to access protected constructor + </summary> + <exclude/> + </member> + <member name="F:log4net.Plugin.PluginCollection.Tag.Default"> + <summary> + A value + </summary> + </member> + <member name="T:log4net.Plugin.PluginCollection.Enumerator"> + <summary> + Supports simple iteration over a <see cref="T:log4net.Plugin.PluginCollection"/>. + </summary> + <exclude/> + </member> + <member name="M:log4net.Plugin.PluginCollection.Enumerator.#ctor(log4net.Plugin.PluginCollection)"> + <summary> + Initializes a new instance of the <c>Enumerator</c> class. + </summary> + <param name="tc"></param> + </member> + <member name="M:log4net.Plugin.PluginCollection.Enumerator.MoveNext"> + <summary> + Advances the enumerator to the next element in the collection. + </summary> + <returns> + <c>true</c> if the enumerator was successfully advanced to the next element; + <c>false</c> if the enumerator has passed the end of the collection. + </returns> + <exception cref="T:System.InvalidOperationException"> + The collection was modified after the enumerator was created. + </exception> + </member> + <member name="M:log4net.Plugin.PluginCollection.Enumerator.Reset"> + <summary> + Sets the enumerator to its initial position, before the first element in the collection. + </summary> + </member> + <member name="P:log4net.Plugin.PluginCollection.Enumerator.Current"> + <summary> + Gets the current element in the collection. + </summary> + <value> + The current element in the collection. + </value> + </member> + <member name="T:log4net.Plugin.PluginCollection.ReadOnlyPluginCollection"> + <exclude/> + </member> + <member name="T:log4net.Plugin.PluginMap"> + <summary> + Map of repository plugins. + </summary> + <remarks> + <para> + This class is a name keyed map of the plugins that are + attached to a repository. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Plugin.PluginMap.#ctor(log4net.Repository.ILoggerRepository)"> + <summary> + Constructor + </summary> + <param name="repository">The repository that the plugins should be attached to.</param> + <remarks> + <para> + Initialize a new instance of the <see cref="T:log4net.Plugin.PluginMap"/> class with a + repository that the plugins should be attached to. + </para> + </remarks> + </member> + <member name="M:log4net.Plugin.PluginMap.Add(log4net.Plugin.IPlugin)"> + <summary> + Adds a <see cref="T:log4net.Plugin.IPlugin"/> to the map. + </summary> + <param name="plugin">The <see cref="T:log4net.Plugin.IPlugin"/> to add to the map.</param> + <remarks> + <para> + The <see cref="T:log4net.Plugin.IPlugin"/> will be attached to the repository when added. + </para> + <para> + If there already exists a plugin with the same name + attached to the repository then the old plugin will + be <see cref="M:log4net.Plugin.IPlugin.Shutdown"/> and replaced with + the new plugin. + </para> + </remarks> + </member> + <member name="M:log4net.Plugin.PluginMap.Remove(log4net.Plugin.IPlugin)"> + <summary> + Removes a <see cref="T:log4net.Plugin.IPlugin"/> from the map. + </summary> + <param name="plugin">The <see cref="T:log4net.Plugin.IPlugin"/> to remove from the map.</param> + <remarks> + <para> + Remove a specific plugin from this map. + </para> + </remarks> + </member> + <member name="P:log4net.Plugin.PluginMap.Item(System.String)"> + <summary> + Gets a <see cref="T:log4net.Plugin.IPlugin"/> by name. + </summary> + <param name="name">The name of the <see cref="T:log4net.Plugin.IPlugin"/> to lookup.</param> + <returns> + The <see cref="T:log4net.Plugin.IPlugin"/> from the map with the name specified, or + <c>null</c> if no plugin is found. + </returns> + <remarks> + <para> + Lookup a plugin by name. If the plugin is not found <c>null</c> + will be returned. + </para> + </remarks> + </member> + <member name="P:log4net.Plugin.PluginMap.AllPlugins"> + <summary> + Gets all possible plugins as a list of <see cref="T:log4net.Plugin.IPlugin"/> objects. + </summary> + <value>All possible plugins as a list of <see cref="T:log4net.Plugin.IPlugin"/> objects.</value> + <remarks> + <para> + Get a collection of all the plugins defined in this map. + </para> + </remarks> + </member> + <member name="T:log4net.Plugin.PluginSkeleton"> + <summary> + Base implementation of <see cref="T:log4net.Plugin.IPlugin"/> + </summary> + <remarks> + <para> + Default abstract implementation of the <see cref="T:log4net.Plugin.IPlugin"/> + interface. This base class can be used by implementors + of the <see cref="T:log4net.Plugin.IPlugin"/> interface. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Plugin.PluginSkeleton.#ctor(System.String)"> + <summary> + Constructor + </summary> + <param name="name">the name of the plugin</param> + <remarks> + Initializes a new Plugin with the specified name. + </remarks> + </member> + <member name="M:log4net.Plugin.PluginSkeleton.Attach(log4net.Repository.ILoggerRepository)"> + <summary> + Attaches this plugin to a <see cref="T:log4net.Repository.ILoggerRepository"/>. + </summary> + <param name="repository">The <see cref="T:log4net.Repository.ILoggerRepository"/> that this plugin should be attached to.</param> + <remarks> + <para> + A plugin may only be attached to a single repository. + </para> + <para> + This method is called when the plugin is attached to the repository. + </para> + </remarks> + </member> + <member name="M:log4net.Plugin.PluginSkeleton.Shutdown"> + <summary> + Is called when the plugin is to shutdown. + </summary> + <remarks> + <para> + This method is called to notify the plugin that + it should stop operating and should detach from + the repository. + </para> + </remarks> + </member> + <member name="F:log4net.Plugin.PluginSkeleton.m_name"> + <summary> + The name of this plugin. + </summary> + </member> + <member name="F:log4net.Plugin.PluginSkeleton.m_repository"> + <summary> + The repository this plugin is attached to. + </summary> + </member> + <member name="P:log4net.Plugin.PluginSkeleton.Name"> + <summary> + Gets or sets the name of the plugin. + </summary> + <value> + The name of the plugin. + </value> + <remarks> + <para> + Plugins are stored in the <see cref="T:log4net.Plugin.PluginMap"/> + keyed by name. Each plugin instance attached to a + repository must be a unique name. + </para> + <para> + The name of the plugin must not change one the + plugin has been attached to a repository. + </para> + </remarks> + </member> + <member name="P:log4net.Plugin.PluginSkeleton.LoggerRepository"> + <summary> + The repository for this plugin + </summary> + <value> + The <see cref="T:log4net.Repository.ILoggerRepository"/> that this plugin is attached to. + </value> + <remarks> + <para> + Gets or sets the <see cref="T:log4net.Repository.ILoggerRepository"/> that this plugin is + attached to. + </para> + </remarks> + </member> + <member name="T:log4net.Plugin.RemoteLoggingServerPlugin"> + <summary> + Plugin that listens for events from the <see cref="T:log4net.Appender.RemotingAppender"/> + </summary> + <remarks> + <para> + This plugin publishes an instance of <see cref="T:log4net.Appender.RemotingAppender.IRemoteLoggingSink"/> + on a specified <see cref="P:log4net.Plugin.RemoteLoggingServerPlugin.SinkUri"/>. This listens for logging events delivered from + a remote <see cref="T:log4net.Appender.RemotingAppender"/>. + </para> + <para> + When an event is received it is relogged within the attached repository + as if it had been raised locally. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Plugin.RemoteLoggingServerPlugin.#ctor"> + <summary> + Default constructor + </summary> + <remarks> + <para> + Initializes a new instance of the <see cref="T:log4net.Plugin.RemoteLoggingServerPlugin"/> class. + </para> + <para> + The <see cref="P:log4net.Plugin.RemoteLoggingServerPlugin.SinkUri"/> property must be set. + </para> + </remarks> + </member> + <member name="M:log4net.Plugin.RemoteLoggingServerPlugin.#ctor(System.String)"> + <summary> + Construct with sink Uri. + </summary> + <param name="sinkUri">The name to publish the sink under in the remoting infrastructure. + See <see cref="P:log4net.Plugin.RemoteLoggingServerPlugin.SinkUri"/> for more details.</param> + <remarks> + <para> + Initializes a new instance of the <see cref="T:log4net.Plugin.RemoteLoggingServerPlugin"/> class + with specified name. + </para> + </remarks> + </member> + <member name="M:log4net.Plugin.RemoteLoggingServerPlugin.Attach(log4net.Repository.ILoggerRepository)"> + <summary> + Attaches this plugin to a <see cref="T:log4net.Repository.ILoggerRepository"/>. + </summary> + <param name="repository">The <see cref="T:log4net.Repository.ILoggerRepository"/> that this plugin should be attached to.</param> + <remarks> + <para> + A plugin may only be attached to a single repository. + </para> + <para> + This method is called when the plugin is attached to the repository. + </para> + </remarks> + </member> + <member name="M:log4net.Plugin.RemoteLoggingServerPlugin.Shutdown"> + <summary> + Is called when the plugin is to shutdown. + </summary> + <remarks> + <para> + When the plugin is shutdown the remote logging + sink is disconnected. + </para> + </remarks> + </member> + <member name="F:log4net.Plugin.RemoteLoggingServerPlugin.declaringType"> + <summary> + The fully qualified type of the RemoteLoggingServerPlugin class. + </summary> + <remarks> + Used by the internal logger to record the Type of the + log message. + </remarks> + </member> + <member name="P:log4net.Plugin.RemoteLoggingServerPlugin.SinkUri"> + <summary> + Gets or sets the URI of this sink. + </summary> + <value> + The URI of this sink. + </value> + <remarks> + <para> + This is the name under which the object is marshaled. + <see cref="M:RemotingServices.Marshal(MarshalByRefObject,String,Type)"/> + </para> + </remarks> + </member> + <member name="T:log4net.Plugin.RemoteLoggingServerPlugin.RemoteLoggingSinkImpl"> + <summary> + Delivers <see cref="T:log4net.Core.LoggingEvent"/> objects to a remote sink. + </summary> + <remarks> + <para> + Internal class used to listen for logging events + and deliver them to the local repository. + </para> + </remarks> + </member> + <member name="M:log4net.Plugin.RemoteLoggingServerPlugin.RemoteLoggingSinkImpl.#ctor(log4net.Repository.ILoggerRepository)"> + <summary> + Constructor + </summary> + <param name="repository">The repository to log to.</param> + <remarks> + <para> + Initializes a new instance of the <see cref="T:log4net.Plugin.RemoteLoggingServerPlugin.RemoteLoggingSinkImpl"/> for the + specified <see cref="T:log4net.Repository.ILoggerRepository"/>. + </para> + </remarks> + </member> + <member name="M:log4net.Plugin.RemoteLoggingServerPlugin.RemoteLoggingSinkImpl.LogEvents(log4net.Core.LoggingEvent[])"> + <summary> + Logs the events to the repository. + </summary> + <param name="events">The events to log.</param> + <remarks> + <para> + The events passed are logged to the <see cref="T:log4net.Repository.ILoggerRepository"/> + </para> + </remarks> + </member> + <member name="M:log4net.Plugin.RemoteLoggingServerPlugin.RemoteLoggingSinkImpl.InitializeLifetimeService"> + <summary> + Obtains a lifetime service object to control the lifetime + policy for this instance. + </summary> + <returns><c>null</c> to indicate that this instance should live forever.</returns> + <remarks> + <para> + Obtains a lifetime service object to control the lifetime + policy for this instance. This object should live forever + therefore this implementation returns <c>null</c>. + </para> + </remarks> + </member> + <member name="F:log4net.Plugin.RemoteLoggingServerPlugin.RemoteLoggingSinkImpl.m_repository"> + <summary> + The underlying <see cref="T:log4net.Repository.ILoggerRepository"/> that events should + be logged to. + </summary> + </member> + <member name="T:log4net.Repository.Hierarchy.DefaultLoggerFactory"> + <summary> + Default implementation of <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/> + </summary> + <remarks> + <para> + This default implementation of the <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/> + interface is used to create the default subclass + of the <see cref="T:log4net.Repository.Hierarchy.Logger"/> object. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="T:log4net.Repository.Hierarchy.ILoggerFactory"> + <summary> + Interface abstracts creation of <see cref="T:log4net.Repository.Hierarchy.Logger"/> instances + </summary> + <remarks> + <para> + This interface is used by the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> to + create new <see cref="T:log4net.Repository.Hierarchy.Logger"/> objects. + </para> + <para> + The <see cref="M:log4net.Repository.Hierarchy.ILoggerFactory.CreateLogger(log4net.Repository.ILoggerRepository,System.String)"/> method is called + to create a named <see cref="T:log4net.Repository.Hierarchy.Logger"/>. + </para> + <para> + Implement this interface to create new subclasses of <see cref="T:log4net.Repository.Hierarchy.Logger"/>. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Repository.Hierarchy.ILoggerFactory.CreateLogger(log4net.Repository.ILoggerRepository,System.String)"> + <summary> + Create a new <see cref="T:log4net.Repository.Hierarchy.Logger"/> instance + </summary> + <param name="repository">The <see cref="T:log4net.Repository.ILoggerRepository"/> that will own the <see cref="T:log4net.Repository.Hierarchy.Logger"/>.</param> + <param name="name">The name of the <see cref="T:log4net.Repository.Hierarchy.Logger"/>.</param> + <returns>The <see cref="T:log4net.Repository.Hierarchy.Logger"/> instance for the specified name.</returns> + <remarks> + <para> + Create a new <see cref="T:log4net.Repository.Hierarchy.Logger"/> instance with the + specified name. + </para> + <para> + Called by the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> to create + new named <see cref="T:log4net.Repository.Hierarchy.Logger"/> instances. + </para> + <para> + If the <paramref name="name"/> is <c>null</c> then the root logger + must be returned. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.Hierarchy.DefaultLoggerFactory.#ctor"> + <summary> + Default constructor + </summary> + <remarks> + <para> + Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.DefaultLoggerFactory"/> class. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.Hierarchy.DefaultLoggerFactory.CreateLogger(log4net.Repository.ILoggerRepository,System.String)"> + <summary> + Create a new <see cref="T:log4net.Repository.Hierarchy.Logger"/> instance + </summary> + <param name="repository">The <see cref="T:log4net.Repository.ILoggerRepository"/> that will own the <see cref="T:log4net.Repository.Hierarchy.Logger"/>.</param> + <param name="name">The name of the <see cref="T:log4net.Repository.Hierarchy.Logger"/>.</param> + <returns>The <see cref="T:log4net.Repository.Hierarchy.Logger"/> instance for the specified name.</returns> + <remarks> + <para> + Create a new <see cref="T:log4net.Repository.Hierarchy.Logger"/> instance with the + specified name. + </para> + <para> + Called by the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> to create + new named <see cref="T:log4net.Repository.Hierarchy.Logger"/> instances. + </para> + <para> + If the <paramref name="name"/> is <c>null</c> then the root logger + must be returned. + </para> + </remarks> + </member> + <member name="T:log4net.Repository.Hierarchy.DefaultLoggerFactory.LoggerImpl"> + <summary> + Default internal subclass of <see cref="T:log4net.Repository.Hierarchy.Logger"/> + </summary> + <remarks> + <para> + This subclass has no additional behavior over the + <see cref="T:log4net.Repository.Hierarchy.Logger"/> class but does allow instances + to be created. + </para> + </remarks> + </member> + <member name="T:log4net.Repository.Hierarchy.Logger"> + <summary> + Implementation of <see cref="T:log4net.Core.ILogger"/> used by <see cref="P:log4net.Repository.Hierarchy.Logger.Hierarchy"/> + </summary> + <remarks> + <para> + Internal class used to provide implementation of <see cref="T:log4net.Core.ILogger"/> + interface. Applications should use <see cref="T:log4net.LogManager"/> to get + logger instances. + </para> + <para> + This is one of the central classes in the log4net implementation. One of the + distinctive features of log4net are hierarchical loggers and their + evaluation. The <see cref="P:log4net.Repository.Hierarchy.Logger.Hierarchy"/> organizes the <see cref="T:log4net.Repository.Hierarchy.Logger"/> + instances into a rooted tree hierarchy. + </para> + <para> + The <see cref="T:log4net.Repository.Hierarchy.Logger"/> class is abstract. Only concrete subclasses of + <see cref="T:log4net.Repository.Hierarchy.Logger"/> can be created. The <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/> + is used to create instances of this type for the <see cref="P:log4net.Repository.Hierarchy.Logger.Hierarchy"/>. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + <author>Aspi Havewala</author> + <author>Douglas de la Torre</author> + </member> + <member name="M:log4net.Repository.Hierarchy.Logger.#ctor(System.String)"> + <summary> + This constructor created a new <see cref="T:log4net.Repository.Hierarchy.Logger"/> instance and + sets its name. + </summary> + <param name="name">The name of the <see cref="T:log4net.Repository.Hierarchy.Logger"/>.</param> + <remarks> + <para> + This constructor is protected and designed to be used by + a subclass that is not abstract. + </para> + <para> + Loggers are constructed by <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/> + objects. See <see cref="T:log4net.Repository.Hierarchy.DefaultLoggerFactory"/> for the default + logger creator. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.Hierarchy.Logger.AddAppender(log4net.Appender.IAppender)"> + <summary> + Add <paramref name="newAppender"/> to the list of appenders of this + Logger instance. + </summary> + <param name="newAppender">An appender to add to this logger</param> + <remarks> + <para> + Add <paramref name="newAppender"/> to the list of appenders of this + Logger instance. + </para> + <para> + If <paramref name="newAppender"/> is already in the list of + appenders, then it won't be added again. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.Hierarchy.Logger.GetAppender(System.String)"> + <summary> + Look for the appender named as <c>name</c> + </summary> + <param name="name">The name of the appender to lookup</param> + <returns>The appender with the name specified, or <c>null</c>.</returns> + <remarks> + <para> + Returns the named appender, or null if the appender is not found. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.Hierarchy.Logger.RemoveAllAppenders"> + <summary> + Remove all previously added appenders from this Logger instance. + </summary> + <remarks> + <para> + Remove all previously added appenders from this Logger instance. + </para> + <para> + This is useful when re-reading configuration information. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.Hierarchy.Logger.RemoveAppender(log4net.Appender.IAppender)"> + <summary> + Remove the appender passed as parameter form the list of appenders. + </summary> + <param name="appender">The appender to remove</param> + <returns>The appender removed from the list</returns> + <remarks> + <para> + Remove the appender passed as parameter form the list of appenders. + The appender removed is not closed. + If you are discarding the appender you must call + <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.Hierarchy.Logger.RemoveAppender(System.String)"> + <summary> + Remove the appender passed as parameter form the list of appenders. + </summary> + <param name="name">The name of the appender to remove</param> + <returns>The appender removed from the list</returns> + <remarks> + <para> + Remove the named appender passed as parameter form the list of appenders. + The appender removed is not closed. + If you are discarding the appender you must call + <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.Hierarchy.Logger.Log(System.Type,log4net.Core.Level,System.Object,System.Exception)"> + <summary> + This generic form is intended to be used by wrappers. + </summary> + <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is + the stack boundary into the logging system for this call.</param> + <param name="level">The level of the message to be logged.</param> + <param name="message">The message object to log.</param> + <param name="exception">The exception to log, including its stack trace.</param> + <remarks> + <para> + Generate a logging event for the specified <paramref name="level"/> using + the <paramref name="message"/> and <paramref name="exception"/>. + </para> + <para> + This method must not throw any exception to the caller. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.Hierarchy.Logger.Log(log4net.Core.LoggingEvent)"> + <summary> + This is the most generic printing method that is intended to be used + by wrappers. + </summary> + <param name="logEvent">The event being logged.</param> + <remarks> + <para> + Logs the specified logging event through this logger. + </para> + <para> + This method must not throw any exception to the caller. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.Hierarchy.Logger.IsEnabledFor(log4net.Core.Level)"> + <summary> + Checks if this logger is enabled for a given <see cref="P:log4net.Repository.Hierarchy.Logger.Level"/> passed as parameter. + </summary> + <param name="level">The level to check.</param> + <returns> + <c>true</c> if this logger is enabled for <c>level</c>, otherwise <c>false</c>. + </returns> + <remarks> + <para> + Test if this logger is going to log events of the specified <paramref name="level"/>. + </para> + <para> + This method must not throw any exception to the caller. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.Hierarchy.Logger.CallAppenders(log4net.Core.LoggingEvent)"> + <summary> + Deliver the <see cref="T:log4net.Core.LoggingEvent"/> to the attached appenders. + </summary> + <param name="loggingEvent">The event to log.</param> + <remarks> + <para> + Call the appenders in the hierarchy starting at + <c>this</c>. If no appenders could be found, emit a + warning. + </para> + <para> + This method calls all the appenders inherited from the + hierarchy circumventing any evaluation of whether to log or not + to log the particular log request. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.Hierarchy.Logger.CloseNestedAppenders"> + <summary> + Closes all attached appenders implementing the <see cref="T:log4net.Core.IAppenderAttachable"/> interface. + </summary> + <remarks> + <para> + Used to ensure that the appenders are correctly shutdown. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.Hierarchy.Logger.Log(log4net.Core.Level,System.Object,System.Exception)"> + <summary> + This is the most generic printing method. This generic form is intended to be used by wrappers + </summary> + <param name="level">The level of the message to be logged.</param> + <param name="message">The message object to log.</param> + <param name="exception">The exception to log, including its stack trace.</param> + <remarks> + <para> + Generate a logging event for the specified <paramref name="level"/> using + the <paramref name="message"/>. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.Hierarchy.Logger.ForcedLog(System.Type,log4net.Core.Level,System.Object,System.Exception)"> + <summary> + Creates a new logging event and logs the event without further checks. + </summary> + <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is + the stack boundary into the logging system for this call.</param> + <param name="level">The level of the message to be logged.</param> + <param name="message">The message object to log.</param> + <param name="exception">The exception to log, including its stack trace.</param> + <remarks> + <para> + Generates a logging event and delivers it to the attached + appenders. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.Hierarchy.Logger.ForcedLog(log4net.Core.LoggingEvent)"> + <summary> + Creates a new logging event and logs the event without further checks. + </summary> + <param name="logEvent">The event being logged.</param> + <remarks> + <para> + Delivers the logging event to the attached appenders. + </para> + </remarks> + </member> + <member name="F:log4net.Repository.Hierarchy.Logger.declaringType"> + <summary> + The fully qualified type of the Logger class. + </summary> + </member> + <member name="F:log4net.Repository.Hierarchy.Logger.m_name"> + <summary> + The name of this logger. + </summary> + </member> + <member name="F:log4net.Repository.Hierarchy.Logger.m_level"> + <summary> + The assigned level of this logger. + </summary> + <remarks> + <para> + The <c>level</c> variable need not be + assigned a value in which case it is inherited + form the hierarchy. + </para> + </remarks> + </member> + <member name="F:log4net.Repository.Hierarchy.Logger.m_parent"> + <summary> + The parent of this logger. + </summary> + <remarks> + <para> + The parent of this logger. + All loggers have at least one ancestor which is the root logger. + </para> + </remarks> + </member> + <member name="F:log4net.Repository.Hierarchy.Logger.m_hierarchy"> + <summary> + Loggers need to know what Hierarchy they are in. + </summary> + <remarks> + <para> + Loggers need to know what Hierarchy they are in. + The hierarchy that this logger is a member of is stored + here. + </para> + </remarks> + </member> + <member name="F:log4net.Repository.Hierarchy.Logger.m_appenderAttachedImpl"> + <summary> + Helper implementation of the <see cref="T:log4net.Core.IAppenderAttachable"/> interface + </summary> + </member> + <member name="F:log4net.Repository.Hierarchy.Logger.m_additive"> + <summary> + Flag indicating if child loggers inherit their parents appenders + </summary> + <remarks> + <para> + Additivity is set to true by default, that is children inherit + the appenders of their ancestors by default. If this variable is + set to <c>false</c> then the appenders found in the + ancestors of this logger are not used. However, the children + of this logger will inherit its appenders, unless the children + have their additivity flag set to <c>false</c> too. See + the user manual for more details. + </para> + </remarks> + </member> + <member name="F:log4net.Repository.Hierarchy.Logger.m_appenderLock"> + <summary> + Lock to protect AppenderAttachedImpl variable m_appenderAttachedImpl + </summary> + </member> + <member name="P:log4net.Repository.Hierarchy.Logger.Parent"> + <summary> + Gets or sets the parent logger in the hierarchy. + </summary> + <value> + The parent logger in the hierarchy. + </value> + <remarks> + <para> + Part of the Composite pattern that makes the hierarchy. + The hierarchy is parent linked rather than child linked. + </para> + </remarks> + </member> + <member name="P:log4net.Repository.Hierarchy.Logger.Additivity"> + <summary> + Gets or sets a value indicating if child loggers inherit their parent's appenders. + </summary> + <value> + <c>true</c> if child loggers inherit their parent's appenders. + </value> + <remarks> + <para> + Additivity is set to <c>true</c> by default, that is children inherit + the appenders of their ancestors by default. If this variable is + set to <c>false</c> then the appenders found in the + ancestors of this logger are not used. However, the children + of this logger will inherit its appenders, unless the children + have their additivity flag set to <c>false</c> too. See + the user manual for more details. + </para> + </remarks> + </member> + <member name="P:log4net.Repository.Hierarchy.Logger.EffectiveLevel"> + <summary> + Gets the effective level for this logger. + </summary> + <returns>The nearest level in the logger hierarchy.</returns> + <remarks> + <para> + Starting from this logger, searches the logger hierarchy for a + non-null level and returns it. Otherwise, returns the level of the + root logger. + </para> + <para>The Logger class is designed so that this method executes as + quickly as possible.</para> + </remarks> + </member> + <member name="P:log4net.Repository.Hierarchy.Logger.Hierarchy"> + <summary> + Gets or sets the <see cref="P:log4net.Repository.Hierarchy.Logger.Hierarchy"/> where this + <c>Logger</c> instance is attached to. + </summary> + <value>The hierarchy that this logger belongs to.</value> + <remarks> + <para> + This logger must be attached to a single <see cref="P:log4net.Repository.Hierarchy.Logger.Hierarchy"/>. + </para> + </remarks> + </member> + <member name="P:log4net.Repository.Hierarchy.Logger.Level"> + <summary> + Gets or sets the assigned <see cref="P:log4net.Repository.Hierarchy.Logger.Level"/>, if any, for this Logger. + </summary> + <value> + The <see cref="P:log4net.Repository.Hierarchy.Logger.Level"/> of this logger. + </value> + <remarks> + <para> + The assigned <see cref="P:log4net.Repository.Hierarchy.Logger.Level"/> can be <c>null</c>. + </para> + </remarks> + </member> + <member name="P:log4net.Repository.Hierarchy.Logger.Appenders"> + <summary> + Get the appenders contained in this logger as an + <see cref="T:System.Collections.ICollection"/>. + </summary> + <returns>A collection of the appenders in this logger</returns> + <remarks> + <para> + Get the appenders contained in this logger as an + <see cref="T:System.Collections.ICollection"/>. If no appenders + can be found, then a <see cref="T:log4net.Util.EmptyCollection"/> is returned. + </para> + </remarks> + </member> + <member name="P:log4net.Repository.Hierarchy.Logger.Name"> + <summary> + Gets the logger name. + </summary> + <value> + The name of the logger. + </value> + <remarks> + <para> + The name of this logger + </para> + </remarks> + </member> + <member name="P:log4net.Repository.Hierarchy.Logger.Repository"> + <summary> + Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> where this + <c>Logger</c> instance is attached to. + </summary> + <value> + The <see cref="T:log4net.Repository.ILoggerRepository"/> that this logger belongs to. + </value> + <remarks> + <para> + Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> where this + <c>Logger</c> instance is attached to. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.Hierarchy.DefaultLoggerFactory.LoggerImpl.#ctor(System.String)"> + <summary> + Construct a new Logger + </summary> + <param name="name">the name of the logger</param> + <remarks> + <para> + Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.DefaultLoggerFactory.LoggerImpl"/> class + with the specified name. + </para> + </remarks> + </member> + <member name="T:log4net.Repository.Hierarchy.LoggerCreationEventHandler"> + <summary> + Delegate used to handle logger creation event notifications. + </summary> + <param name="sender">The <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> in which the <see cref="T:log4net.Repository.Hierarchy.Logger"/> has been created.</param> + <param name="e">The <see cref="T:log4net.Repository.Hierarchy.LoggerCreationEventArgs"/> event args that hold the <see cref="T:log4net.Repository.Hierarchy.Logger"/> instance that has been created.</param> + <remarks> + <para> + Delegate used to handle logger creation event notifications. + </para> + </remarks> + </member> + <member name="T:log4net.Repository.Hierarchy.LoggerCreationEventArgs"> + <summary> + Provides data for the <see cref="E:log4net.Repository.Hierarchy.Hierarchy.LoggerCreatedEvent"/> event. + </summary> + <remarks> + <para> + A <see cref="E:log4net.Repository.Hierarchy.Hierarchy.LoggerCreatedEvent"/> event is raised every time a + <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> is created. + </para> + </remarks> + </member> + <member name="F:log4net.Repository.Hierarchy.LoggerCreationEventArgs.m_log"> + <summary> + The <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> created + </summary> + </member> + <member name="M:log4net.Repository.Hierarchy.LoggerCreationEventArgs.#ctor(log4net.Repository.Hierarchy.Logger)"> + <summary> + Constructor + </summary> + <param name="log">The <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> that has been created.</param> + <remarks> + <para> + Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.LoggerCreationEventArgs"/> event argument + class,with the specified <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/>. + </para> + </remarks> + </member> + <member name="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"> + <summary> + Gets the <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> that has been created. + </summary> + <value> + The <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> that has been created. + </value> + <remarks> + <para> + The <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> that has been created. + </para> + </remarks> + </member> + <member name="T:log4net.Repository.Hierarchy.Hierarchy"> + <summary> + Hierarchical organization of loggers + </summary> + <remarks> + <para> + <i>The casual user should not have to deal with this class + directly.</i> + </para> + <para> + This class is specialized in retrieving loggers by name and + also maintaining the logger hierarchy. Implements the + <see cref="T:log4net.Repository.ILoggerRepository"/> interface. + </para> + <para> + The structure of the logger hierarchy is maintained by the + <see cref="M:GetLogger(string)"/> method. The hierarchy is such that children + link to their parent but parents do not have any references to their + children. Moreover, loggers can be instantiated in any order, in + particular descendant before ancestor. + </para> + <para> + In case a descendant is created before a particular ancestor, + then it creates a provision node for the ancestor and adds itself + to the provision node. Other descendants of the same ancestor add + themselves to the previously created provision node. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="T:log4net.Repository.LoggerRepositorySkeleton"> + <summary> + Base implementation of <see cref="T:log4net.Repository.ILoggerRepository"/> + </summary> + <remarks> + <para> + Default abstract implementation of the <see cref="T:log4net.Repository.ILoggerRepository"/> interface. + </para> + <para> + Skeleton implementation of the <see cref="T:log4net.Repository.ILoggerRepository"/> interface. + All <see cref="T:log4net.Repository.ILoggerRepository"/> types can extend this type. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="T:log4net.Repository.ILoggerRepository"> + <summary> + Interface implemented by logger repositories. + </summary> + <remarks> + <para> + This interface is implemented by logger repositories. e.g. + <see cref="N:log4net.Repository.Hierarchy"/>. + </para> + <para> + This interface is used by the <see cref="T:log4net.LogManager"/> + to obtain <see cref="T:log4net.ILog"/> interfaces. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Repository.ILoggerRepository.Exists(System.String)"> + <summary> + Check if the named logger exists in the repository. If so return + its reference, otherwise returns <c>null</c>. + </summary> + <param name="name">The name of the logger to lookup</param> + <returns>The Logger object with the name specified</returns> + <remarks> + <para> + If the names logger exists it is returned, otherwise + <c>null</c> is returned. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.ILoggerRepository.GetCurrentLoggers"> + <summary> + Returns all the currently defined loggers as an Array. + </summary> + <returns>All the defined loggers</returns> + <remarks> + <para> + Returns all the currently defined loggers as an Array. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.ILoggerRepository.GetLogger(System.String)"> + <summary> + Returns a named logger instance + </summary> + <param name="name">The name of the logger to retrieve</param> + <returns>The logger object with the name specified</returns> + <remarks> + <para> + Returns a named logger instance. + </para> + <para> + If a logger of that name already exists, then it will be + returned. Otherwise, a new logger will be instantiated and + then linked with its existing ancestors as well as children. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.ILoggerRepository.Shutdown"> + <summary>Shutdown the repository</summary> + <remarks> + <para> + Shutting down a repository will <i>safely</i> close and remove + all appenders in all loggers including the root logger. + </para> + <para> + Some appenders need to be closed before the + application exists. Otherwise, pending logging events might be + lost. + </para> + <para> + The <see cref="M:Shutdown()"/> method is careful to close nested + appenders before closing regular appenders. This is allows + configurations where a regular appender is attached to a logger + and again to a nested appender. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.ILoggerRepository.ResetConfiguration"> + <summary> + Reset the repositories configuration to a default state + </summary> + <remarks> + <para> + Reset all values contained in this instance to their + default state. + </para> + <para> + Existing loggers are not removed. They are just reset. + </para> + <para> + This method should be used sparingly and with care as it will + block all logging until it is completed. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.ILoggerRepository.Log(log4net.Core.LoggingEvent)"> + <summary> + Log the <see cref="T:log4net.Core.LoggingEvent"/> through this repository. + </summary> + <param name="logEvent">the event to log</param> + <remarks> + <para> + This method should not normally be used to log. + The <see cref="T:log4net.ILog"/> interface should be used + for routine logging. This interface can be obtained + using the <see cref="M:log4net.LogManager.GetLogger(string)"/> method. + </para> + <para> + The <c>logEvent</c> is delivered to the appropriate logger and + that logger is then responsible for logging the event. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.ILoggerRepository.GetAppenders"> + <summary> + Returns all the Appenders that are configured as an Array. + </summary> + <returns>All the Appenders</returns> + <remarks> + <para> + Returns all the Appenders that are configured as an Array. + </para> + </remarks> + </member> + <member name="P:log4net.Repository.ILoggerRepository.Name"> + <summary> + The name of the repository + </summary> + <value> + The name of the repository + </value> + <remarks> + <para> + The name of the repository. + </para> + </remarks> + </member> + <member name="P:log4net.Repository.ILoggerRepository.RendererMap"> + <summary> + RendererMap accesses the object renderer map for this repository. + </summary> + <value> + RendererMap accesses the object renderer map for this repository. + </value> + <remarks> + <para> + RendererMap accesses the object renderer map for this repository. + </para> + <para> + The RendererMap holds a mapping between types and + <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/> objects. + </para> + </remarks> + </member> + <member name="P:log4net.Repository.ILoggerRepository.PluginMap"> + <summary> + The plugin map for this repository. + </summary> + <value> + The plugin map for this repository. + </value> + <remarks> + <para> + The plugin map holds the <see cref="T:log4net.Plugin.IPlugin"/> instances + that have been attached to this repository. + </para> + </remarks> + </member> + <member name="P:log4net.Repository.ILoggerRepository.LevelMap"> + <summary> + Get the level map for the Repository. + </summary> + <remarks> + <para> + Get the level map for the Repository. + </para> + <para> + The level map defines the mappings between + level names and <see cref="T:log4net.Core.Level"/> objects in + this repository. + </para> + </remarks> + </member> + <member name="P:log4net.Repository.ILoggerRepository.Threshold"> + <summary> + The threshold for all events in this repository + </summary> + <value> + The threshold for all events in this repository + </value> + <remarks> + <para> + The threshold for all events in this repository. + </para> + </remarks> + </member> + <member name="P:log4net.Repository.ILoggerRepository.Configured"> + <summary> + Flag indicates if this repository has been configured. + </summary> + <value> + Flag indicates if this repository has been configured. + </value> + <remarks> + <para> + Flag indicates if this repository has been configured. + </para> + </remarks> + </member> + <member name="P:log4net.Repository.ILoggerRepository.ConfigurationMessages"> + <summary> + Collection of internal messages captured during the most + recent configuration process. + </summary> + </member> + <member name="E:log4net.Repository.ILoggerRepository.ShutdownEvent"> + <summary> + Event to notify that the repository has been shutdown. + </summary> + <value> + Event to notify that the repository has been shutdown. + </value> + <remarks> + <para> + Event raised when the repository has been shutdown. + </para> + </remarks> + </member> + <member name="E:log4net.Repository.ILoggerRepository.ConfigurationReset"> + <summary> + Event to notify that the repository has had its configuration reset. + </summary> + <value> + Event to notify that the repository has had its configuration reset. + </value> + <remarks> + <para> + Event raised when the repository's configuration has been + reset to default. + </para> + </remarks> + </member> + <member name="E:log4net.Repository.ILoggerRepository.ConfigurationChanged"> + <summary> + Event to notify that the repository has had its configuration changed. + </summary> + <value> + Event to notify that the repository has had its configuration changed. + </value> + <remarks> + <para> + Event raised when the repository's configuration has been changed. + </para> + </remarks> + </member> + <member name="P:log4net.Repository.ILoggerRepository.Properties"> + <summary> + Repository specific properties + </summary> + <value> + Repository specific properties + </value> + <remarks> + <para> + These properties can be specified on a repository specific basis. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.LoggerRepositorySkeleton.#ctor"> + <summary> + Default Constructor + </summary> + <remarks> + <para> + Initializes the repository with default (empty) properties. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.LoggerRepositorySkeleton.#ctor(log4net.Util.PropertiesDictionary)"> + <summary> + Construct the repository using specific properties + </summary> + <param name="properties">the properties to set for this repository</param> + <remarks> + <para> + Initializes the repository with specified properties. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.LoggerRepositorySkeleton.Exists(System.String)"> + <summary> + Test if logger exists + </summary> + <param name="name">The name of the logger to lookup</param> + <returns>The Logger object with the name specified</returns> + <remarks> + <para> + Check if the named logger exists in the repository. If so return + its reference, otherwise returns <c>null</c>. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.LoggerRepositorySkeleton.GetCurrentLoggers"> + <summary> + Returns all the currently defined loggers in the repository + </summary> + <returns>All the defined loggers</returns> + <remarks> + <para> + Returns all the currently defined loggers in the repository as an Array. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.LoggerRepositorySkeleton.GetLogger(System.String)"> + <summary> + Return a new logger instance + </summary> + <param name="name">The name of the logger to retrieve</param> + <returns>The logger object with the name specified</returns> + <remarks> + <para> + Return a new logger instance. + </para> + <para> + If a logger of that name already exists, then it will be + returned. Otherwise, a new logger will be instantiated and + then linked with its existing ancestors as well as children. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.LoggerRepositorySkeleton.Shutdown"> + <summary> + Shutdown the repository + </summary> + <remarks> + <para> + Shutdown the repository. Can be overridden in a subclass. + This base class implementation notifies the <see cref="E:log4net.Repository.LoggerRepositorySkeleton.ShutdownEvent"/> + listeners and all attached plugins of the shutdown event. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.LoggerRepositorySkeleton.ResetConfiguration"> + <summary> + Reset the repositories configuration to a default state + </summary> + <remarks> + <para> + Reset all values contained in this instance to their + default state. + </para> + <para> + Existing loggers are not removed. They are just reset. + </para> + <para> + This method should be used sparingly and with care as it will + block all logging until it is completed. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.LoggerRepositorySkeleton.Log(log4net.Core.LoggingEvent)"> + <summary> + Log the logEvent through this repository. + </summary> + <param name="logEvent">the event to log</param> + <remarks> + <para> + This method should not normally be used to log. + The <see cref="T:log4net.ILog"/> interface should be used + for routine logging. This interface can be obtained + using the <see cref="M:log4net.LogManager.GetLogger(string)"/> method. + </para> + <para> + The <c>logEvent</c> is delivered to the appropriate logger and + that logger is then responsible for logging the event. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.LoggerRepositorySkeleton.GetAppenders"> + <summary> + Returns all the Appenders that are configured as an Array. + </summary> + <returns>All the Appenders</returns> + <remarks> + <para> + Returns all the Appenders that are configured as an Array. + </para> + </remarks> + </member> + <member name="F:log4net.Repository.LoggerRepositorySkeleton.declaringType"> + <summary> + The fully qualified type of the LoggerRepositorySkeleton class. + </summary> + <remarks> + Used by the internal logger to record the Type of the + log message. + </remarks> + </member> + <member name="M:log4net.Repository.LoggerRepositorySkeleton.AddRenderer(System.Type,log4net.ObjectRenderer.IObjectRenderer)"> + <summary> + Adds an object renderer for a specific class. + </summary> + <param name="typeToRender">The type that will be rendered by the renderer supplied.</param> + <param name="rendererInstance">The object renderer used to render the object.</param> + <remarks> + <para> + Adds an object renderer for a specific class. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.LoggerRepositorySkeleton.OnShutdown(System.EventArgs)"> + <summary> + Notify the registered listeners that the repository is shutting down + </summary> + <param name="e">Empty EventArgs</param> + <remarks> + <para> + Notify any listeners that this repository is shutting down. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.LoggerRepositorySkeleton.OnConfigurationReset(System.EventArgs)"> + <summary> + Notify the registered listeners that the repository has had its configuration reset + </summary> + <param name="e">Empty EventArgs</param> + <remarks> + <para> + Notify any listeners that this repository's configuration has been reset. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.LoggerRepositorySkeleton.OnConfigurationChanged(System.EventArgs)"> + <summary> + Notify the registered listeners that the repository has had its configuration changed + </summary> + <param name="e">Empty EventArgs</param> + <remarks> + <para> + Notify any listeners that this repository's configuration has changed. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.LoggerRepositorySkeleton.RaiseConfigurationChanged(System.EventArgs)"> + <summary> + Raise a configuration changed event on this repository + </summary> + <param name="e">EventArgs.Empty</param> + <remarks> + <para> + Applications that programmatically change the configuration of the repository should + raise this event notification to notify listeners. + </para> + </remarks> + </member> + <member name="P:log4net.Repository.LoggerRepositorySkeleton.Name"> + <summary> + The name of the repository + </summary> + <value> + The string name of the repository + </value> + <remarks> + <para> + The name of this repository. The name is + used to store and lookup the repositories + stored by the <see cref="T:log4net.Core.IRepositorySelector"/>. + </para> + </remarks> + </member> + <member name="P:log4net.Repository.LoggerRepositorySkeleton.Threshold"> + <summary> + The threshold for all events in this repository + </summary> + <value> + The threshold for all events in this repository + </value> + <remarks> + <para> + The threshold for all events in this repository + </para> + </remarks> + </member> + <member name="P:log4net.Repository.LoggerRepositorySkeleton.RendererMap"> + <summary> + RendererMap accesses the object renderer map for this repository. + </summary> + <value> + RendererMap accesses the object renderer map for this repository. + </value> + <remarks> + <para> + RendererMap accesses the object renderer map for this repository. + </para> + <para> + The RendererMap holds a mapping between types and + <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/> objects. + </para> + </remarks> + </member> + <member name="P:log4net.Repository.LoggerRepositorySkeleton.PluginMap"> + <summary> + The plugin map for this repository. + </summary> + <value> + The plugin map for this repository. + </value> + <remarks> + <para> + The plugin map holds the <see cref="T:log4net.Plugin.IPlugin"/> instances + that have been attached to this repository. + </para> + </remarks> + </member> + <member name="P:log4net.Repository.LoggerRepositorySkeleton.LevelMap"> + <summary> + Get the level map for the Repository. + </summary> + <remarks> + <para> + Get the level map for the Repository. + </para> + <para> + The level map defines the mappings between + level names and <see cref="T:log4net.Core.Level"/> objects in + this repository. + </para> + </remarks> + </member> + <member name="P:log4net.Repository.LoggerRepositorySkeleton.Configured"> + <summary> + Flag indicates if this repository has been configured. + </summary> + <value> + Flag indicates if this repository has been configured. + </value> + <remarks> + <para> + Flag indicates if this repository has been configured. + </para> + </remarks> + </member> + <member name="P:log4net.Repository.LoggerRepositorySkeleton.ConfigurationMessages"> + <summary> + Contains a list of internal messages captures during the + last configuration. + </summary> + </member> + <member name="E:log4net.Repository.LoggerRepositorySkeleton.ShutdownEvent"> + <summary> + Event to notify that the repository has been shutdown. + </summary> + <value> + Event to notify that the repository has been shutdown. + </value> + <remarks> + <para> + Event raised when the repository has been shutdown. + </para> + </remarks> + </member> + <member name="E:log4net.Repository.LoggerRepositorySkeleton.ConfigurationReset"> + <summary> + Event to notify that the repository has had its configuration reset. + </summary> + <value> + Event to notify that the repository has had its configuration reset. + </value> + <remarks> + <para> + Event raised when the repository's configuration has been + reset to default. + </para> + </remarks> + </member> + <member name="E:log4net.Repository.LoggerRepositorySkeleton.ConfigurationChanged"> + <summary> + Event to notify that the repository has had its configuration changed. + </summary> + <value> + Event to notify that the repository has had its configuration changed. + </value> + <remarks> + <para> + Event raised when the repository's configuration has been changed. + </para> + </remarks> + </member> + <member name="P:log4net.Repository.LoggerRepositorySkeleton.Properties"> + <summary> + Repository specific properties + </summary> + <value> + Repository specific properties + </value> + <remarks> + These properties can be specified on a repository specific basis + </remarks> + </member> + <member name="T:log4net.Repository.IBasicRepositoryConfigurator"> + <summary> + Basic Configurator interface for repositories + </summary> + <remarks> + <para> + Interface used by basic configurator to configure a <see cref="T:log4net.Repository.ILoggerRepository"/> + with a default <see cref="T:log4net.Appender.IAppender"/>. + </para> + <para> + A <see cref="T:log4net.Repository.ILoggerRepository"/> should implement this interface to support + configuration by the <see cref="T:log4net.Config.BasicConfigurator"/>. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Repository.IBasicRepositoryConfigurator.Configure(log4net.Appender.IAppender)"> + <summary> + Initialize the repository using the specified appender + </summary> + <param name="appender">the appender to use to log all logging events</param> + <remarks> + <para> + Configure the repository to route all logging events to the + specified appender. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.IBasicRepositoryConfigurator.Configure(log4net.Appender.IAppender[])"> + <summary> + Initialize the repository using the specified appenders + </summary> + <param name="appenders">the appenders to use to log all logging events</param> + <remarks> + <para> + Configure the repository to route all logging events to the + specified appenders. + </para> + </remarks> + </member> + <member name="T:log4net.Repository.IXmlRepositoryConfigurator"> + <summary> + Configure repository using XML + </summary> + <remarks> + <para> + Interface used by Xml configurator to configure a <see cref="T:log4net.Repository.ILoggerRepository"/>. + </para> + <para> + A <see cref="T:log4net.Repository.ILoggerRepository"/> should implement this interface to support + configuration by the <see cref="T:log4net.Config.XmlConfigurator"/>. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Repository.IXmlRepositoryConfigurator.Configure(System.Xml.XmlElement)"> + <summary> + Initialize the repository using the specified config + </summary> + <param name="element">the element containing the root of the config</param> + <remarks> + <para> + The schema for the XML configuration data is defined by + the implementation. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.Hierarchy.Hierarchy.#ctor"> + <summary> + Default constructor + </summary> + <remarks> + <para> + Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> class. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.Hierarchy.Hierarchy.#ctor(log4net.Util.PropertiesDictionary)"> + <summary> + Construct with properties + </summary> + <param name="properties">The properties to pass to this repository.</param> + <remarks> + <para> + Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> class. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.Hierarchy.Hierarchy.#ctor(log4net.Repository.Hierarchy.ILoggerFactory)"> + <summary> + Construct with a logger factory + </summary> + <param name="loggerFactory">The factory to use to create new logger instances.</param> + <remarks> + <para> + Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> class with + the specified <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/>. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.Hierarchy.Hierarchy.#ctor(log4net.Util.PropertiesDictionary,log4net.Repository.Hierarchy.ILoggerFactory)"> + <summary> + Construct with properties and a logger factory + </summary> + <param name="properties">The properties to pass to this repository.</param> + <param name="loggerFactory">The factory to use to create new logger instances.</param> + <remarks> + <para> + Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> class with + the specified <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/>. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.Hierarchy.Hierarchy.Exists(System.String)"> + <summary> + Test if a logger exists + </summary> + <param name="name">The name of the logger to lookup</param> + <returns>The Logger object with the name specified</returns> + <remarks> + <para> + Check if the named logger exists in the hierarchy. If so return + its reference, otherwise returns <c>null</c>. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.Hierarchy.Hierarchy.GetCurrentLoggers"> + <summary> + Returns all the currently defined loggers in the hierarchy as an Array + </summary> + <returns>All the defined loggers</returns> + <remarks> + <para> + Returns all the currently defined loggers in the hierarchy as an Array. + The root logger is <b>not</b> included in the returned + enumeration. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.Hierarchy.Hierarchy.GetLogger(System.String)"> + <summary> + Return a new logger instance named as the first parameter using + the default factory. + </summary> + <remarks> + <para> + Return a new logger instance named as the first parameter using + the default factory. + </para> + <para> + If a logger of that name already exists, then it will be + returned. Otherwise, a new logger will be instantiated and + then linked with its existing ancestors as well as children. + </para> + </remarks> + <param name="name">The name of the logger to retrieve</param> + <returns>The logger object with the name specified</returns> + </member> + <member name="M:log4net.Repository.Hierarchy.Hierarchy.Shutdown"> + <summary> + Shutting down a hierarchy will <i>safely</i> close and remove + all appenders in all loggers including the root logger. + </summary> + <remarks> + <para> + Shutting down a hierarchy will <i>safely</i> close and remove + all appenders in all loggers including the root logger. + </para> + <para> + Some appenders need to be closed before the + application exists. Otherwise, pending logging events might be + lost. + </para> + <para> + The <c>Shutdown</c> method is careful to close nested + appenders before closing regular appenders. This is allows + configurations where a regular appender is attached to a logger + and again to a nested appender. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.Hierarchy.Hierarchy.ResetConfiguration"> + <summary> + Reset all values contained in this hierarchy instance to their default. + </summary> + <remarks> + <para> + Reset all values contained in this hierarchy instance to their + default. This removes all appenders from all loggers, sets + the level of all non-root loggers to <c>null</c>, + sets their additivity flag to <c>true</c> and sets the level + of the root logger to <see cref="F:log4net.Core.Level.Debug"/>. Moreover, + message disabling is set its default "off" value. + </para> + <para> + Existing loggers are not removed. They are just reset. + </para> + <para> + This method should be used sparingly and with care as it will + block all logging until it is completed. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.Hierarchy.Hierarchy.Log(log4net.Core.LoggingEvent)"> + <summary> + Log the logEvent through this hierarchy. + </summary> + <param name="logEvent">the event to log</param> + <remarks> + <para> + This method should not normally be used to log. + The <see cref="T:log4net.ILog"/> interface should be used + for routine logging. This interface can be obtained + using the <see cref="M:log4net.LogManager.GetLogger(string)"/> method. + </para> + <para> + The <c>logEvent</c> is delivered to the appropriate logger and + that logger is then responsible for logging the event. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.Hierarchy.Hierarchy.GetAppenders"> + <summary> + Returns all the Appenders that are currently configured + </summary> + <returns>An array containing all the currently configured appenders</returns> + <remarks> + <para> + Returns all the <see cref="T:log4net.Appender.IAppender"/> instances that are currently configured. + All the loggers are searched for appenders. The appenders may also be containers + for appenders and these are also searched for additional loggers. + </para> + <para> + The list returned is unordered but does not contain duplicates. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.Hierarchy.Hierarchy.CollectAppender(System.Collections.ArrayList,log4net.Appender.IAppender)"> + <summary> + Collect the appenders from an <see cref="T:log4net.Core.IAppenderAttachable"/>. + The appender may also be a container. + </summary> + <param name="appenderList"></param> + <param name="appender"></param> + </member> + <member name="M:log4net.Repository.Hierarchy.Hierarchy.CollectAppenders(System.Collections.ArrayList,log4net.Core.IAppenderAttachable)"> + <summary> + Collect the appenders from an <see cref="T:log4net.Core.IAppenderAttachable"/> container + </summary> + <param name="appenderList"></param> + <param name="container"></param> + </member> + <member name="M:log4net.Repository.Hierarchy.Hierarchy.log4net#Repository#IBasicRepositoryConfigurator#Configure(log4net.Appender.IAppender)"> + <summary> + Initialize the log4net system using the specified appender + </summary> + <param name="appender">the appender to use to log all logging events</param> + </member> + <member name="M:log4net.Repository.Hierarchy.Hierarchy.log4net#Repository#IBasicRepositoryConfigurator#Configure(log4net.Appender.IAppender[])"> + <summary> + Initialize the log4net system using the specified appenders + </summary> + <param name="appenders">the appenders to use to log all logging events</param> + </member> + <member name="M:log4net.Repository.Hierarchy.Hierarchy.BasicRepositoryConfigure(log4net.Appender.IAppender[])"> + <summary> + Initialize the log4net system using the specified appenders + </summary> + <param name="appenders">the appenders to use to log all logging events</param> + <remarks> + <para> + This method provides the same functionality as the + <see cref="M:IBasicRepositoryConfigurator.Configure(IAppender)"/> method implemented + on this object, but it is protected and therefore can be called by subclasses. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.Hierarchy.Hierarchy.log4net#Repository#IXmlRepositoryConfigurator#Configure(System.Xml.XmlElement)"> + <summary> + Initialize the log4net system using the specified config + </summary> + <param name="element">the element containing the root of the config</param> + </member> + <member name="M:log4net.Repository.Hierarchy.Hierarchy.XmlRepositoryConfigure(System.Xml.XmlElement)"> + <summary> + Initialize the log4net system using the specified config + </summary> + <param name="element">the element containing the root of the config</param> + <remarks> + <para> + This method provides the same functionality as the + <see cref="M:IBasicRepositoryConfigurator.Configure(IAppender)"/> method implemented + on this object, but it is protected and therefore can be called by subclasses. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.Hierarchy.Hierarchy.IsDisabled(log4net.Core.Level)"> + <summary> + Test if this hierarchy is disabled for the specified <see cref="T:log4net.Core.Level"/>. + </summary> + <param name="level">The level to check against.</param> + <returns> + <c>true</c> if the repository is disabled for the level argument, <c>false</c> otherwise. + </returns> + <remarks> + <para> + If this hierarchy has not been configured then this method will + always return <c>true</c>. + </para> + <para> + This method will return <c>true</c> if this repository is + disabled for <c>level</c> object passed as parameter and + <c>false</c> otherwise. + </para> + <para> + See also the <see cref="P:log4net.Repository.ILoggerRepository.Threshold"/> property. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.Hierarchy.Hierarchy.Clear"> + <summary> + Clear all logger definitions from the internal hashtable + </summary> + <remarks> + <para> + This call will clear all logger definitions from the internal + hashtable. Invoking this method will irrevocably mess up the + logger hierarchy. + </para> + <para> + You should <b>really</b> know what you are doing before + invoking this method. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.Hierarchy.Hierarchy.GetLogger(System.String,log4net.Repository.Hierarchy.ILoggerFactory)"> + <summary> + Return a new logger instance named as the first parameter using + <paramref name="factory"/>. + </summary> + <param name="name">The name of the logger to retrieve</param> + <param name="factory">The factory that will make the new logger instance</param> + <returns>The logger object with the name specified</returns> + <remarks> + <para> + If a logger of that name already exists, then it will be + returned. Otherwise, a new logger will be instantiated by the + <paramref name="factory"/> parameter and linked with its existing + ancestors as well as children. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.Hierarchy.Hierarchy.OnLoggerCreationEvent(log4net.Repository.Hierarchy.Logger)"> + <summary> + Sends a logger creation event to all registered listeners + </summary> + <param name="logger">The newly created logger</param> + <remarks> + Raises the logger creation event. + </remarks> + </member> + <member name="M:log4net.Repository.Hierarchy.Hierarchy.UpdateParents(log4net.Repository.Hierarchy.Logger)"> + <summary> + Updates all the parents of the specified logger + </summary> + <param name="log">The logger to update the parents for</param> + <remarks> + <para> + This method loops through all the <i>potential</i> parents of + <paramref name="log"/>. There 3 possible cases: + </para> + <list type="number"> + <item> + <term>No entry for the potential parent of <paramref name="log"/> exists</term> + <description> + We create a ProvisionNode for this potential + parent and insert <paramref name="log"/> in that provision node. + </description> + </item> + <item> + <term>The entry is of type Logger for the potential parent.</term> + <description> + The entry is <paramref name="log"/>'s nearest existing parent. We + update <paramref name="log"/>'s parent field with this entry. We also break from + he loop because updating our parent's parent is our parent's + responsibility. + </description> + </item> + <item> + <term>The entry is of type ProvisionNode for this potential parent.</term> + <description> + We add <paramref name="log"/> to the list of children for this + potential parent. + </description> + </item> + </list> + </remarks> + </member> + <member name="M:log4net.Repository.Hierarchy.Hierarchy.UpdateChildren(log4net.Repository.Hierarchy.ProvisionNode,log4net.Repository.Hierarchy.Logger)"> + <summary> + Replace a <see cref="T:log4net.Repository.Hierarchy.ProvisionNode"/> with a <see cref="T:log4net.Repository.Hierarchy.Logger"/> in the hierarchy. + </summary> + <param name="pn"></param> + <param name="log"></param> + <remarks> + <para> + We update the links for all the children that placed themselves + in the provision node 'pn'. The second argument 'log' is a + reference for the newly created Logger, parent of all the + children in 'pn'. + </para> + <para> + We loop on all the children 'c' in 'pn'. + </para> + <para> + If the child 'c' has been already linked to a child of + 'log' then there is no need to update 'c'. + </para> + <para> + Otherwise, we set log's parent field to c's parent and set + c's parent field to log. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.Hierarchy.Hierarchy.AddLevel(log4net.Repository.Hierarchy.Hierarchy.LevelEntry)"> + <summary> + Define or redefine a Level using the values in the <see cref="T:log4net.Repository.Hierarchy.Hierarchy.LevelEntry"/> argument + </summary> + <param name="levelEntry">the level values</param> + <remarks> + <para> + Define or redefine a Level using the values in the <see cref="T:log4net.Repository.Hierarchy.Hierarchy.LevelEntry"/> argument + </para> + <para> + Supports setting levels via the configuration file. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.Hierarchy.Hierarchy.AddProperty(log4net.Util.PropertyEntry)"> + <summary> + Set a Property using the values in the <see cref="T:log4net.Repository.Hierarchy.Hierarchy.LevelEntry"/> argument + </summary> + <param name="propertyEntry">the property value</param> + <remarks> + <para> + Set a Property using the values in the <see cref="T:log4net.Repository.Hierarchy.Hierarchy.LevelEntry"/> argument. + </para> + <para> + Supports setting property values via the configuration file. + </para> + </remarks> + </member> + <member name="F:log4net.Repository.Hierarchy.Hierarchy.declaringType"> + <summary> + The fully qualified type of the Hierarchy class. + </summary> + <remarks> + Used by the internal logger to record the Type of the + log message. + </remarks> + </member> + <member name="E:log4net.Repository.Hierarchy.Hierarchy.LoggerCreatedEvent"> + <summary> + Event used to notify that a logger has been created. + </summary> + <remarks> + <para> + Event raised when a logger is created. + </para> + </remarks> + </member> + <member name="P:log4net.Repository.Hierarchy.Hierarchy.EmittedNoAppenderWarning"> + <summary> + Has no appender warning been emitted + </summary> + <remarks> + <para> + Flag to indicate if we have already issued a warning + about not having an appender warning. + </para> + </remarks> + </member> + <member name="P:log4net.Repository.Hierarchy.Hierarchy.Root"> + <summary> + Get the root of this hierarchy + </summary> + <remarks> + <para> + Get the root of this hierarchy. + </para> + </remarks> + </member> + <member name="P:log4net.Repository.Hierarchy.Hierarchy.LoggerFactory"> + <summary> + Gets or sets the default <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/> instance. + </summary> + <value>The default <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/></value> + <remarks> + <para> + The logger factory is used to create logger instances. + </para> + </remarks> + </member> + <member name="T:log4net.Repository.Hierarchy.Hierarchy.LevelEntry"> + <summary> + A class to hold the value, name and display name for a level + </summary> + <remarks> + <para> + A class to hold the value, name and display name for a level + </para> + </remarks> + </member> + <member name="M:log4net.Repository.Hierarchy.Hierarchy.LevelEntry.ToString"> + <summary> + Override <c>Object.ToString</c> to return sensible debug info + </summary> + <returns>string info about this object</returns> + </member> + <member name="P:log4net.Repository.Hierarchy.Hierarchy.LevelEntry.Value"> + <summary> + Value of the level + </summary> + <remarks> + <para> + If the value is not set (defaults to -1) the value will be looked + up for the current level with the same name. + </para> + </remarks> + </member> + <member name="P:log4net.Repository.Hierarchy.Hierarchy.LevelEntry.Name"> + <summary> + Name of the level + </summary> + <value> + The name of the level + </value> + <remarks> + <para> + The name of the level. + </para> + </remarks> + </member> + <member name="P:log4net.Repository.Hierarchy.Hierarchy.LevelEntry.DisplayName"> + <summary> + Display name for the level + </summary> + <value> + The display name of the level + </value> + <remarks> + <para> + The display name of the level. + </para> + </remarks> + </member> + <member name="T:log4net.Repository.Hierarchy.LoggerKey"> + <summary> + Used internally to accelerate hash table searches. + </summary> + <remarks> + <para> + Internal class used to improve performance of + string keyed hashtables. + </para> + <para> + The hashcode of the string is cached for reuse. + The string is stored as an interned value. + When comparing two <see cref="T:log4net.Repository.Hierarchy.LoggerKey"/> objects for equality + the reference equality of the interned strings is compared. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Repository.Hierarchy.LoggerKey.#ctor(System.String)"> + <summary> + Construct key with string name + </summary> + <remarks> + <para> + Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.LoggerKey"/> class + with the specified name. + </para> + <para> + Stores the hashcode of the string and interns + the string key to optimize comparisons. + </para> + <note> + The Compact Framework 1.0 the <see cref="M:System.String.Intern(System.String)"/> + method does not work. On the Compact Framework + the string keys are not interned nor are they + compared by reference. + </note> + </remarks> + <param name="name">The name of the logger.</param> + </member> + <member name="M:log4net.Repository.Hierarchy.LoggerKey.GetHashCode"> + <summary> + Returns a hash code for the current instance. + </summary> + <returns>A hash code for the current instance.</returns> + <remarks> + <para> + Returns the cached hashcode. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.Hierarchy.LoggerKey.Equals(System.Object)"> + <summary> + Determines whether two <see cref="T:log4net.Repository.Hierarchy.LoggerKey"/> instances + are equal. + </summary> + <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:log4net.Repository.Hierarchy.LoggerKey"/>.</param> + <returns> + <c>true</c> if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:log4net.Repository.Hierarchy.LoggerKey"/>; otherwise, <c>false</c>. + </returns> + <remarks> + <para> + Compares the references of the interned strings. + </para> + </remarks> + </member> + <member name="T:log4net.Repository.Hierarchy.ProvisionNode"> + <summary> + Provision nodes are used where no logger instance has been specified + </summary> + <remarks> + <para> + <see cref="T:log4net.Repository.Hierarchy.ProvisionNode"/> instances are used in the + <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> when there is no specified + <see cref="T:log4net.Repository.Hierarchy.Logger"/> for that node. + </para> + <para> + A provision node holds a list of child loggers on behalf of + a logger that does not exist. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Repository.Hierarchy.ProvisionNode.#ctor(log4net.Repository.Hierarchy.Logger)"> + <summary> + Create a new provision node with child node + </summary> + <param name="log">A child logger to add to this node.</param> + <remarks> + <para> + Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.ProvisionNode"/> class + with the specified child logger. + </para> + </remarks> + </member> + <member name="T:log4net.Repository.Hierarchy.RootLogger"> + <summary> + The <see cref="T:log4net.Repository.Hierarchy.RootLogger"/> sits at the root of the logger hierarchy tree. + </summary> + <remarks> + <para> + The <see cref="T:log4net.Repository.Hierarchy.RootLogger"/> is a regular <see cref="T:log4net.Repository.Hierarchy.Logger"/> except + that it provides several guarantees. + </para> + <para> + First, it cannot be assigned a <c>null</c> + level. Second, since the root logger cannot have a parent, the + <see cref="P:log4net.Repository.Hierarchy.RootLogger.EffectiveLevel"/> property always returns the value of the + level field without walking the hierarchy. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Repository.Hierarchy.RootLogger.#ctor(log4net.Core.Level)"> + <summary> + Construct a <see cref="T:log4net.Repository.Hierarchy.RootLogger"/> + </summary> + <param name="level">The level to assign to the root logger.</param> + <remarks> + <para> + Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.RootLogger"/> class with + the specified logging level. + </para> + <para> + The root logger names itself as "root". However, the root + logger cannot be retrieved by name. + </para> + </remarks> + </member> + <member name="F:log4net.Repository.Hierarchy.RootLogger.declaringType"> + <summary> + The fully qualified type of the RootLogger class. + </summary> + <remarks> + Used by the internal logger to record the Type of the + log message. + </remarks> + </member> + <member name="P:log4net.Repository.Hierarchy.RootLogger.EffectiveLevel"> + <summary> + Gets the assigned level value without walking the logger hierarchy. + </summary> + <value>The assigned level value without walking the logger hierarchy.</value> + <remarks> + <para> + Because the root logger cannot have a parent and its level + must not be <c>null</c> this property just returns the + value of <see cref="P:log4net.Repository.Hierarchy.Logger.Level"/>. + </para> + </remarks> + </member> + <member name="P:log4net.Repository.Hierarchy.RootLogger.Level"> + <summary> + Gets or sets the assigned <see cref="P:log4net.Repository.Hierarchy.RootLogger.Level"/> for the root logger. + </summary> + <value> + The <see cref="P:log4net.Repository.Hierarchy.RootLogger.Level"/> of the root logger. + </value> + <remarks> + <para> + Setting the level of the root logger to a <c>null</c> reference + may have catastrophic results. We prevent this here. + </para> + </remarks> + </member> + <member name="T:log4net.Repository.Hierarchy.XmlHierarchyConfigurator"> + <summary> + Initializes the log4net environment using an XML DOM. + </summary> + <remarks> + <para> + Configures a <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> using an XML DOM. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.#ctor(log4net.Repository.Hierarchy.Hierarchy)"> + <summary> + Construct the configurator for a hierarchy + </summary> + <param name="hierarchy">The hierarchy to build.</param> + <remarks> + <para> + Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.XmlHierarchyConfigurator"/> class + with the specified <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.Configure(System.Xml.XmlElement)"> + <summary> + Configure the hierarchy by parsing a DOM tree of XML elements. + </summary> + <param name="element">The root element to parse.</param> + <remarks> + <para> + Configure the hierarchy by parsing a DOM tree of XML elements. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.FindAppenderByReference(System.Xml.XmlElement)"> + <summary> + Parse appenders by IDREF. + </summary> + <param name="appenderRef">The appender ref element.</param> + <returns>The instance of the appender that the ref refers to.</returns> + <remarks> + <para> + Parse an XML element that represents an appender and return + the appender. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseAppender(System.Xml.XmlElement)"> + <summary> + Parses an appender element. + </summary> + <param name="appenderElement">The appender element.</param> + <returns>The appender instance or <c>null</c> when parsing failed.</returns> + <remarks> + <para> + Parse an XML element that represents an appender and return + the appender instance. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseLogger(System.Xml.XmlElement)"> + <summary> + Parses a logger element. + </summary> + <param name="loggerElement">The logger element.</param> + <remarks> + <para> + Parse an XML element that represents a logger. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseRoot(System.Xml.XmlElement)"> + <summary> + Parses the root logger element. + </summary> + <param name="rootElement">The root element.</param> + <remarks> + <para> + Parse an XML element that represents the root logger. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseChildrenOfLoggerElement(System.Xml.XmlElement,log4net.Repository.Hierarchy.Logger,System.Boolean)"> + <summary> + Parses the children of a logger element. + </summary> + <param name="catElement">The category element.</param> + <param name="log">The logger instance.</param> + <param name="isRoot">Flag to indicate if the logger is the root logger.</param> + <remarks> + <para> + Parse the child elements of a <logger> element. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseRenderer(System.Xml.XmlElement)"> + <summary> + Parses an object renderer. + </summary> + <param name="element">The renderer element.</param> + <remarks> + <para> + Parse an XML element that represents a renderer. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseLevel(System.Xml.XmlElement,log4net.Repository.Hierarchy.Logger,System.Boolean)"> + <summary> + Parses a level element. + </summary> + <param name="element">The level element.</param> + <param name="log">The logger object to set the level on.</param> + <param name="isRoot">Flag to indicate if the logger is the root logger.</param> + <remarks> + <para> + Parse an XML element that represents a level. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.SetParameter(System.Xml.XmlElement,System.Object)"> + <summary> + Sets a parameter on an object. + </summary> + <param name="element">The parameter element.</param> + <param name="target">The object to set the parameter on.</param> + <remarks> + The parameter name must correspond to a writable property + on the object. The value of the parameter is a string, + therefore this function will attempt to set a string + property first. If unable to set a string property it + will inspect the property and its argument type. It will + attempt to call a static method called <c>Parse</c> on the + type of the property. This method will take a single + string argument and return a value that can be used to + set the property. + </remarks> + </member> + <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.HasAttributesOrElements(System.Xml.XmlElement)"> + <summary> + Test if an element has no attributes or child elements + </summary> + <param name="element">the element to inspect</param> + <returns><c>true</c> if the element has any attributes or child elements, <c>false</c> otherwise</returns> + </member> + <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.IsTypeConstructible(System.Type)"> + <summary> + Test if a <see cref="T:System.Type"/> is constructible with <c>Activator.CreateInstance</c>. + </summary> + <param name="type">the type to inspect</param> + <returns><c>true</c> if the type is creatable using a default constructor, <c>false</c> otherwise</returns> + </member> + <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.FindMethodInfo(System.Type,System.String)"> + <summary> + Look for a method on the <paramref name="targetType"/> that matches the <paramref name="name"/> supplied + </summary> + <param name="targetType">the type that has the method</param> + <param name="name">the name of the method</param> + <returns>the method info found</returns> + <remarks> + <para> + The method must be a public instance method on the <paramref name="targetType"/>. + The method must be named <paramref name="name"/> or "Add" followed by <paramref name="name"/>. + The method must take a single parameter. + </para> + </remarks> + </member> + <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ConvertStringTo(System.Type,System.String)"> + <summary> + Converts a string value to a target type. + </summary> + <param name="type">The type of object to convert the string to.</param> + <param name="value">The string value to use as the value of the object.</param> + <returns> + <para> + An object of type <paramref name="type"/> with value <paramref name="value"/> or + <c>null</c> when the conversion could not be performed. + </para> + </returns> + </member> + <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.CreateObjectFromXml(System.Xml.XmlElement,System.Type,System.Type)"> + <summary> + Creates an object as specified in XML. + </summary> + <param name="element">The XML element that contains the definition of the object.</param> + <param name="defaultTargetType">The object type to use if not explicitly specified.</param> + <param name="typeConstraint">The type that the returned object must be or must inherit from.</param> + <returns>The object or <c>null</c></returns> + <remarks> + <para> + Parse an XML element and create an object instance based on the configuration + data. + </para> + <para> + The type of the instance may be specified in the XML. If not + specified then the <paramref name="defaultTargetType"/> is used + as the type. However the type is specified it must support the + <paramref name="typeConstraint"/> type. + </para> + </remarks> + </member> + <member name="F:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.m_appenderBag"> + <summary> + key: appenderName, value: appender. + </summary> + </member> + <member name="F:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.m_hierarchy"> + <summary> + The Hierarchy being configured. + </summary> + </member> + <member name="F:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.declaringType"> + <summary> + The fully qualified type of the XmlHierarchyConfigurator class. + </summary> + <remarks> + Used by the internal logger to record the Type of the + log message. + </remarks> + </member> + <member name="T:log4net.Repository.ConfigurationChangedEventArgs"> + <summary> + + </summary> + </member> + <member name="M:log4net.Repository.ConfigurationChangedEventArgs.#ctor(System.Collections.ICollection)"> + <summary> + + </summary> + <param name="configurationMessages"></param> + </member> + <member name="P:log4net.Repository.ConfigurationChangedEventArgs.ConfigurationMessages"> + <summary> + + </summary> + </member> + <member name="T:log4net.Repository.LoggerRepositoryShutdownEventHandler"> + <summary> + Delegate used to handle logger repository shutdown event notifications + </summary> + <param name="sender">The <see cref="T:log4net.Repository.ILoggerRepository"/> that is shutting down.</param> + <param name="e">Empty event args</param> + <remarks> + <para> + Delegate used to handle logger repository shutdown event notifications. + </para> + </remarks> + </member> + <member name="T:log4net.Repository.LoggerRepositoryConfigurationResetEventHandler"> + <summary> + Delegate used to handle logger repository configuration reset event notifications + </summary> + <param name="sender">The <see cref="T:log4net.Repository.ILoggerRepository"/> that has had its configuration reset.</param> + <param name="e">Empty event args</param> + <remarks> + <para> + Delegate used to handle logger repository configuration reset event notifications. + </para> + </remarks> + </member> + <member name="T:log4net.Repository.LoggerRepositoryConfigurationChangedEventHandler"> + <summary> + Delegate used to handle event notifications for logger repository configuration changes. + </summary> + <param name="sender">The <see cref="T:log4net.Repository.ILoggerRepository"/> that has had its configuration changed.</param> + <param name="e">Empty event arguments.</param> + <remarks> + <para> + Delegate used to handle event notifications for logger repository configuration changes. + </para> + </remarks> + </member> + <member name="T:log4net.Util.PatternStringConverters.AppDomainPatternConverter"> + <summary> + Write the name of the current AppDomain to the output + </summary> + <remarks> + <para> + Write the name of the current AppDomain to the output writer + </para> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="M:log4net.Util.PatternStringConverters.AppDomainPatternConverter.Convert(System.IO.TextWriter,System.Object)"> + <summary> + Write the name of the current AppDomain to the output + </summary> + <param name="writer">the writer to write to</param> + <param name="state">null, state is not set</param> + <remarks> + <para> + Writes name of the current AppDomain to the output <paramref name="writer"/>. + </para> + </remarks> + </member> + <member name="T:log4net.Util.PatternStringConverters.DatePatternConverter"> + <summary> + Write the current date to the output + </summary> + <remarks> + <para> + Date pattern converter, uses a <see cref="T:log4net.DateFormatter.IDateFormatter"/> to format + the current date and time to the writer as a string. + </para> + <para> + The value of the <see cref="P:log4net.Util.PatternConverter.Option"/> determines + the formatting of the date. The following values are allowed: + <list type="definition"> + <listheader> + <term>Option value</term> + <description>Output</description> + </listheader> + <item> + <term>ISO8601</term> + <description> + Uses the <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/> formatter. + Formats using the <c>"yyyy-MM-dd HH:mm:ss,fff"</c> pattern. + </description> + </item> + <item> + <term>DATE</term> + <description> + Uses the <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> formatter. + Formats using the <c>"dd MMM yyyy HH:mm:ss,fff"</c> for example, <c>"06 Nov 1994 15:49:37,459"</c>. + </description> + </item> + <item> + <term>ABSOLUTE</term> + <description> + Uses the <see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/> formatter. + Formats using the <c>"HH:mm:ss,fff"</c> for example, <c>"15:49:37,459"</c>. + </description> + </item> + <item> + <term>other</term> + <description> + Any other pattern string uses the <see cref="T:log4net.DateFormatter.SimpleDateFormatter"/> formatter. + This formatter passes the pattern string to the <see cref="T:System.DateTime"/> + <see cref="M:DateTime.ToString(string)"/> method. + For details on valid patterns see + <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfsystemglobalizationdatetimeformatinfoclasstopic.asp">DateTimeFormatInfo Class</a>. + </description> + </item> + </list> + </para> + <para> + The date and time is in the local time zone and is rendered in that zone. + To output the time in Universal time see <see cref="T:log4net.Util.PatternStringConverters.UtcDatePatternConverter"/>. + </para> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="F:log4net.Util.PatternStringConverters.DatePatternConverter.m_dateFormatter"> + <summary> + The <see cref="T:log4net.DateFormatter.IDateFormatter"/> used to render the date to a string + </summary> + <remarks> + <para> + The <see cref="T:log4net.DateFormatter.IDateFormatter"/> used to render the date to a string + </para> + </remarks> + </member> + <member name="M:log4net.Util.PatternStringConverters.DatePatternConverter.ActivateOptions"> + <summary> + Initialize the converter options + </summary> + <remarks> + <para> + This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object + activation scheme. The <see cref="M:log4net.Util.PatternStringConverters.DatePatternConverter.ActivateOptions"/> method must + be called on this object after the configuration properties have + been set. Until <see cref="M:log4net.Util.PatternStringConverters.DatePatternConverter.ActivateOptions"/> is called this + object is in an undefined state and must not be used. + </para> + <para> + If any of the configuration properties are modified then + <see cref="M:log4net.Util.PatternStringConverters.DatePatternConverter.ActivateOptions"/> must be called again. + </para> + </remarks> + </member> + <member name="M:log4net.Util.PatternStringConverters.DatePatternConverter.Convert(System.IO.TextWriter,System.Object)"> + <summary> + Write the current date to the output + </summary> + <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param> + <param name="state">null, state is not set</param> + <remarks> + <para> + Pass the current date and time to the <see cref="T:log4net.DateFormatter.IDateFormatter"/> + for it to render it to the writer. + </para> + <para> + The date and time passed is in the local time zone. + </para> + </remarks> + </member> + <member name="F:log4net.Util.PatternStringConverters.DatePatternConverter.declaringType"> + <summary> + The fully qualified type of the DatePatternConverter class. + </summary> + <remarks> + Used by the internal logger to record the Type of the + log message. + </remarks> + </member> + <member name="T:log4net.Util.PatternStringConverters.EnvironmentFolderPathPatternConverter"> + <summary> + Write an <see cref="T:System.Environment.SpecialFolder"/> folder path to the output + </summary> + <remarks> + <para> + Write an special path environment folder path to the output writer. + The value of the <see cref="P:log4net.Util.PatternConverter.Option"/> determines + the name of the variable to output. <see cref="P:log4net.Util.PatternConverter.Option"/> + should be a value in the <see cref="T:System.Environment.SpecialFolder"/> enumeration. + </para> + </remarks> + <author>Ron Grabowski</author> + </member> + <member name="M:log4net.Util.PatternStringConverters.EnvironmentFolderPathPatternConverter.Convert(System.IO.TextWriter,System.Object)"> + <summary> + Write an special path environment folder path to the output + </summary> + <param name="writer">the writer to write to</param> + <param name="state">null, state is not set</param> + <remarks> + <para> + Writes the special path environment folder path to the output <paramref name="writer"/>. + The name of the special path environment folder path to output must be set + using the <see cref="P:log4net.Util.PatternConverter.Option"/> + property. + </para> + </remarks> + </member> + <member name="F:log4net.Util.PatternStringConverters.EnvironmentFolderPathPatternConverter.declaringType"> + <summary> + The fully qualified type of the EnvironmentFolderPathPatternConverter class. + </summary> + <remarks> + Used by the internal logger to record the Type of the + log message. + </remarks> + </member> + <member name="T:log4net.Util.PatternStringConverters.EnvironmentPatternConverter"> + <summary> + Write an environment variable to the output + </summary> + <remarks> + <para> + Write an environment variable to the output writer. + The value of the <see cref="P:log4net.Util.PatternConverter.Option"/> determines + the name of the variable to output. + </para> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="M:log4net.Util.PatternStringConverters.EnvironmentPatternConverter.Convert(System.IO.TextWriter,System.Object)"> + <summary> + Write an environment variable to the output + </summary> + <param name="writer">the writer to write to</param> + <param name="state">null, state is not set</param> + <remarks> + <para> + Writes the environment variable to the output <paramref name="writer"/>. + The name of the environment variable to output must be set + using the <see cref="P:log4net.Util.PatternConverter.Option"/> + property. + </para> + </remarks> + </member> + <member name="F:log4net.Util.PatternStringConverters.EnvironmentPatternConverter.declaringType"> + <summary> + The fully qualified type of the EnvironmentPatternConverter class. + </summary> + <remarks> + Used by the internal logger to record the Type of the + log message. + </remarks> + </member> + <member name="T:log4net.Util.PatternStringConverters.IdentityPatternConverter"> + <summary> + Write the current thread identity to the output + </summary> + <remarks> + <para> + Write the current thread identity to the output writer + </para> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="M:log4net.Util.PatternStringConverters.IdentityPatternConverter.Convert(System.IO.TextWriter,System.Object)"> + <summary> + Write the current thread identity to the output + </summary> + <param name="writer">the writer to write to</param> + <param name="state">null, state is not set</param> + <remarks> + <para> + Writes the current thread identity to the output <paramref name="writer"/>. + </para> + </remarks> + </member> + <member name="F:log4net.Util.PatternStringConverters.IdentityPatternConverter.declaringType"> + <summary> + The fully qualified type of the IdentityPatternConverter class. + </summary> + <remarks> + Used by the internal logger to record the Type of the + log message. + </remarks> + </member> + <member name="T:log4net.Util.PatternStringConverters.LiteralPatternConverter"> + <summary> + Pattern converter for literal string instances in the pattern + </summary> + <remarks> + <para> + Writes the literal string value specified in the + <see cref="P:log4net.Util.PatternConverter.Option"/> property to + the output. + </para> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="M:log4net.Util.PatternStringConverters.LiteralPatternConverter.SetNext(log4net.Util.PatternConverter)"> + <summary> + Set the next converter in the chain + </summary> + <param name="pc">The next pattern converter in the chain</param> + <returns>The next pattern converter</returns> + <remarks> + <para> + Special case the building of the pattern converter chain + for <see cref="T:log4net.Util.PatternStringConverters.LiteralPatternConverter"/> instances. Two adjacent + literals in the pattern can be represented by a single combined + pattern converter. This implementation detects when a + <see cref="T:log4net.Util.PatternStringConverters.LiteralPatternConverter"/> is added to the chain + after this converter and combines its value with this converter's + literal value. + </para> + </remarks> + </member> + <member name="M:log4net.Util.PatternStringConverters.LiteralPatternConverter.Format(System.IO.TextWriter,System.Object)"> + <summary> + Write the literal to the output + </summary> + <param name="writer">the writer to write to</param> + <param name="state">null, not set</param> + <remarks> + <para> + Override the formatting behavior to ignore the FormattingInfo + because we have a literal instead. + </para> + <para> + Writes the value of <see cref="P:log4net.Util.PatternConverter.Option"/> + to the output <paramref name="writer"/>. + </para> + </remarks> + </member> + <member name="M:log4net.Util.PatternStringConverters.LiteralPatternConverter.Convert(System.IO.TextWriter,System.Object)"> + <summary> + Convert this pattern into the rendered message + </summary> + <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param> + <param name="state">null, not set</param> + <remarks> + <para> + This method is not used. + </para> + </remarks> + </member> + <member name="T:log4net.Util.PatternStringConverters.NewLinePatternConverter"> + <summary> + Writes a newline to the output + </summary> + <remarks> + <para> + Writes the system dependent line terminator to the output. + This behavior can be overridden by setting the <see cref="P:log4net.Util.PatternConverter.Option"/>: + </para> + <list type="definition"> + <listheader> + <term>Option Value</term> + <description>Output</description> + </listheader> + <item> + <term>DOS</term> + <description>DOS or Windows line terminator <c>"\r\n"</c></description> + </item> + <item> + <term>UNIX</term> + <description>UNIX line terminator <c>"\n"</c></description> + </item> + </list> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="M:log4net.Util.PatternStringConverters.NewLinePatternConverter.ActivateOptions"> + <summary> + Initialize the converter + </summary> + <remarks> + <para> + This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object + activation scheme. The <see cref="M:log4net.Util.PatternStringConverters.NewLinePatternConverter.ActivateOptions"/> method must + be called on this object after the configuration properties have + been set. Until <see cref="M:log4net.Util.PatternStringConverters.NewLinePatternConverter.ActivateOptions"/> is called this + object is in an undefined state and must not be used. + </para> + <para> + If any of the configuration properties are modified then + <see cref="M:log4net.Util.PatternStringConverters.NewLinePatternConverter.ActivateOptions"/> must be called again. + </para> + </remarks> + </member> + <member name="T:log4net.Util.PatternStringConverters.ProcessIdPatternConverter"> + <summary> + Write the current process ID to the output + </summary> + <remarks> + <para> + Write the current process ID to the output writer + </para> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="M:log4net.Util.PatternStringConverters.ProcessIdPatternConverter.Convert(System.IO.TextWriter,System.Object)"> + <summary> + Write the current process ID to the output + </summary> + <param name="writer">the writer to write to</param> + <param name="state">null, state is not set</param> + <remarks> + <para> + Write the current process ID to the output <paramref name="writer"/>. + </para> + </remarks> + </member> + <member name="F:log4net.Util.PatternStringConverters.ProcessIdPatternConverter.declaringType"> + <summary> + The fully qualified type of the ProcessIdPatternConverter class. + </summary> + <remarks> + Used by the internal logger to record the Type of the + log message. + </remarks> + </member> + <member name="T:log4net.Util.PatternStringConverters.PropertyPatternConverter"> + <summary> + Property pattern converter + </summary> + <remarks> + <para> + This pattern converter reads the thread and global properties. + The thread properties take priority over global properties. + See <see cref="P:log4net.ThreadContext.Properties"/> for details of the + thread properties. See <see cref="P:log4net.GlobalContext.Properties"/> for + details of the global properties. + </para> + <para> + If the <see cref="P:log4net.Util.PatternConverter.Option"/> is specified then that will be used to + lookup a single property. If no <see cref="P:log4net.Util.PatternConverter.Option"/> is specified + then all properties will be dumped as a list of key value pairs. + </para> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="M:log4net.Util.PatternStringConverters.PropertyPatternConverter.Convert(System.IO.TextWriter,System.Object)"> + <summary> + Write the property value to the output + </summary> + <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param> + <param name="state">null, state is not set</param> + <remarks> + <para> + Writes out the value of a named property. The property name + should be set in the <see cref="P:log4net.Util.PatternConverter.Option"/> + property. + </para> + <para> + If the <see cref="P:log4net.Util.PatternConverter.Option"/> is set to <c>null</c> + then all the properties are written as key value pairs. + </para> + </remarks> + </member> + <member name="T:log4net.Util.PatternStringConverters.RandomStringPatternConverter"> + <summary> + A Pattern converter that generates a string of random characters + </summary> + <remarks> + <para> + The converter generates a string of random characters. By default + the string is length 4. This can be changed by setting the <see cref="P:log4net.Util.PatternConverter.Option"/> + to the string value of the length required. + </para> + <para> + The random characters in the string are limited to uppercase letters + and numbers only. + </para> + <para> + The random number generator used by this class is not cryptographically secure. + </para> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="F:log4net.Util.PatternStringConverters.RandomStringPatternConverter.s_random"> + <summary> + Shared random number generator + </summary> + </member> + <member name="F:log4net.Util.PatternStringConverters.RandomStringPatternConverter.m_length"> + <summary> + Length of random string to generate. Default length 4. + </summary> + </member> + <member name="M:log4net.Util.PatternStringConverters.RandomStringPatternConverter.ActivateOptions"> + <summary> + Initialize the converter options + </summary> + <remarks> + <para> + This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object + activation scheme. The <see cref="M:log4net.Util.PatternStringConverters.RandomStringPatternConverter.ActivateOptions"/> method must + be called on this object after the configuration properties have + been set. Until <see cref="M:log4net.Util.PatternStringConverters.RandomStringPatternConverter.ActivateOptions"/> is called this + object is in an undefined state and must not be used. + </para> + <para> + If any of the configuration properties are modified then + <see cref="M:log4net.Util.PatternStringConverters.RandomStringPatternConverter.ActivateOptions"/> must be called again. + </para> + </remarks> + </member> + <member name="M:log4net.Util.PatternStringConverters.RandomStringPatternConverter.Convert(System.IO.TextWriter,System.Object)"> + <summary> + Write a randoim string to the output + </summary> + <param name="writer">the writer to write to</param> + <param name="state">null, state is not set</param> + <remarks> + <para> + Write a randoim string to the output <paramref name="writer"/>. + </para> + </remarks> + </member> + <member name="F:log4net.Util.PatternStringConverters.RandomStringPatternConverter.declaringType"> + <summary> + The fully qualified type of the RandomStringPatternConverter class. + </summary> + <remarks> + Used by the internal logger to record the Type of the + log message. + </remarks> + </member> + <member name="T:log4net.Util.PatternStringConverters.UserNamePatternConverter"> + <summary> + Write the current threads username to the output + </summary> + <remarks> + <para> + Write the current threads username to the output writer + </para> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="M:log4net.Util.PatternStringConverters.UserNamePatternConverter.Convert(System.IO.TextWriter,System.Object)"> + <summary> + Write the current threads username to the output + </summary> + <param name="writer">the writer to write to</param> + <param name="state">null, state is not set</param> + <remarks> + <para> + Write the current threads username to the output <paramref name="writer"/>. + </para> + </remarks> + </member> + <member name="F:log4net.Util.PatternStringConverters.UserNamePatternConverter.declaringType"> + <summary> + The fully qualified type of the UserNamePatternConverter class. + </summary> + <remarks> + Used by the internal logger to record the Type of the + log message. + </remarks> + </member> + <member name="T:log4net.Util.PatternStringConverters.UtcDatePatternConverter"> + <summary> + Write the UTC date time to the output + </summary> + <remarks> + <para> + Date pattern converter, uses a <see cref="T:log4net.DateFormatter.IDateFormatter"/> to format + the current date and time in Universal time. + </para> + <para> + See the <see cref="T:log4net.Util.PatternStringConverters.DatePatternConverter"/> for details on the date pattern syntax. + </para> + </remarks> + <seealso cref="T:log4net.Util.PatternStringConverters.DatePatternConverter"/> + <author>Nicko Cadell</author> + </member> + <member name="M:log4net.Util.PatternStringConverters.UtcDatePatternConverter.Convert(System.IO.TextWriter,System.Object)"> + <summary> + Write the current date and time to the output + </summary> + <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param> + <param name="state">null, state is not set</param> + <remarks> + <para> + Pass the current date and time to the <see cref="T:log4net.DateFormatter.IDateFormatter"/> + for it to render it to the writer. + </para> + <para> + The date is in Universal time when it is rendered. + </para> + </remarks> + <seealso cref="T:log4net.Util.PatternStringConverters.DatePatternConverter"/> + </member> + <member name="F:log4net.Util.PatternStringConverters.UtcDatePatternConverter.declaringType"> + <summary> + The fully qualified type of the UtcDatePatternConverter class. + </summary> + <remarks> + Used by the internal logger to record the Type of the + log message. + </remarks> + </member> + <member name="T:log4net.Util.TypeConverters.BooleanConverter"> + <summary> + Type converter for Boolean. + </summary> + <remarks> + <para> + Supports conversion from string to <c>bool</c> type. + </para> + </remarks> + <seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/> + <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/> + <seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Util.TypeConverters.BooleanConverter.CanConvertFrom(System.Type)"> + <summary> + Can the source type be converted to the type supported by this object + </summary> + <param name="sourceType">the type to convert</param> + <returns>true if the conversion is possible</returns> + <remarks> + <para> + Returns <c>true</c> if the <paramref name="sourceType"/> is + the <see cref="T:System.String"/> type. + </para> + </remarks> + </member> + <member name="M:log4net.Util.TypeConverters.BooleanConverter.ConvertFrom(System.Object)"> + <summary> + Convert the source object to the type supported by this object + </summary> + <param name="source">the object to convert</param> + <returns>the converted object</returns> + <remarks> + <para> + Uses the <see cref="M:System.Boolean.Parse(System.String)"/> method to convert the + <see cref="T:System.String"/> argument to a <see cref="T:System.Boolean"/>. + </para> + </remarks> + <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"> + The <paramref name="source"/> object cannot be converted to the + target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.BooleanConverter.CanConvertFrom(System.Type)"/> + method. + </exception> + </member> + <member name="T:log4net.Util.TypeConverters.ConversionNotSupportedException"> + <summary> + Exception base type for conversion errors. + </summary> + <remarks> + <para> + This type extends <see cref="T:System.ApplicationException"/>. It + does not add any new functionality but does differentiate the + type of exception being thrown. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Util.TypeConverters.ConversionNotSupportedException.#ctor"> + <summary> + Constructor + </summary> + <remarks> + <para> + Initializes a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/> class. + </para> + </remarks> + </member> + <member name="M:log4net.Util.TypeConverters.ConversionNotSupportedException.#ctor(System.String)"> + <summary> + Constructor + </summary> + <param name="message">A message to include with the exception.</param> + <remarks> + <para> + Initializes a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/> class + with the specified message. + </para> + </remarks> + </member> + <member name="M:log4net.Util.TypeConverters.ConversionNotSupportedException.#ctor(System.String,System.Exception)"> + <summary> + Constructor + </summary> + <param name="message">A message to include with the exception.</param> + <param name="innerException">A nested exception to include.</param> + <remarks> + <para> + Initializes a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/> class + with the specified message and inner exception. + </para> + </remarks> + </member> + <member name="M:log4net.Util.TypeConverters.ConversionNotSupportedException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> + <summary> + Serialization constructor + </summary> + <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param> + <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param> + <remarks> + <para> + Initializes a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/> class + with serialized data. + </para> + </remarks> + </member> + <member name="M:log4net.Util.TypeConverters.ConversionNotSupportedException.Create(System.Type,System.Object)"> + <summary> + Creates a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/> class. + </summary> + <param name="destinationType">The conversion destination type.</param> + <param name="sourceValue">The value to convert.</param> + <returns>An instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/>.</returns> + <remarks> + <para> + Creates a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/> class. + </para> + </remarks> + </member> + <member name="M:log4net.Util.TypeConverters.ConversionNotSupportedException.Create(System.Type,System.Object,System.Exception)"> + <summary> + Creates a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/> class. + </summary> + <param name="destinationType">The conversion destination type.</param> + <param name="sourceValue">The value to convert.</param> + <param name="innerException">A nested exception to include.</param> + <returns>An instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/>.</returns> + <remarks> + <para> + Creates a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/> class. + </para> + </remarks> + </member> + <member name="T:log4net.Util.TypeConverters.ConverterRegistry"> + <summary> + Register of type converters for specific types. + </summary> + <remarks> + <para> + Maintains a registry of type converters used to convert between + types. + </para> + <para> + Use the <see cref="M:AddConverter(Type, object)"/> and + <see cref="M:AddConverter(Type, Type)"/> methods to register new converters. + The <see cref="M:log4net.Util.TypeConverters.ConverterRegistry.GetConvertTo(System.Type,System.Type)"/> and <see cref="M:log4net.Util.TypeConverters.ConverterRegistry.GetConvertFrom(System.Type)"/> methods + lookup appropriate converters to use. + </para> + </remarks> + <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/> + <seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Util.TypeConverters.ConverterRegistry.#ctor"> + <summary> + Private constructor + </summary> + <remarks> + Initializes a new instance of the <see cref="T:log4net.Util.TypeConverters.ConverterRegistry"/> class. + </remarks> + </member> + <member name="M:log4net.Util.TypeConverters.ConverterRegistry.#cctor"> + <summary> + Static constructor. + </summary> + <remarks> + <para> + This constructor defines the intrinsic type converters. + </para> + </remarks> + </member> + <member name="M:log4net.Util.TypeConverters.ConverterRegistry.AddConverter(System.Type,System.Object)"> + <summary> + Adds a converter for a specific type. + </summary> + <param name="destinationType">The type being converted to.</param> + <param name="converter">The type converter to use to convert to the destination type.</param> + <remarks> + <para> + Adds a converter instance for a specific type. + </para> + </remarks> + </member> + <member name="M:log4net.Util.TypeConverters.ConverterRegistry.AddConverter(System.Type,System.Type)"> + <summary> + Adds a converter for a specific type. + </summary> + <param name="destinationType">The type being converted to.</param> + <param name="converterType">The type of the type converter to use to convert to the destination type.</param> + <remarks> + <para> + Adds a converter <see cref="T:System.Type"/> for a specific type. + </para> + </remarks> + </member> + <member name="M:log4net.Util.TypeConverters.ConverterRegistry.GetConvertTo(System.Type,System.Type)"> + <summary> + Gets the type converter to use to convert values to the destination type. + </summary> + <param name="sourceType">The type being converted from.</param> + <param name="destinationType">The type being converted to.</param> + <returns> + The type converter instance to use for type conversions or <c>null</c> + if no type converter is found. + </returns> + <remarks> + <para> + Gets the type converter to use to convert values to the destination type. + </para> + </remarks> + </member> + <member name="M:log4net.Util.TypeConverters.ConverterRegistry.GetConvertFrom(System.Type)"> + <summary> + Gets the type converter to use to convert values to the destination type. + </summary> + <param name="destinationType">The type being converted to.</param> + <returns> + The type converter instance to use for type conversions or <c>null</c> + if no type converter is found. + </returns> + <remarks> + <para> + Gets the type converter to use to convert values to the destination type. + </para> + </remarks> + </member> + <member name="M:log4net.Util.TypeConverters.ConverterRegistry.GetConverterFromAttribute(System.Type)"> + <summary> + Lookups the type converter to use as specified by the attributes on the + destination type. + </summary> + <param name="destinationType">The type being converted to.</param> + <returns> + The type converter instance to use for type conversions or <c>null</c> + if no type converter is found. + </returns> + </member> + <member name="M:log4net.Util.TypeConverters.ConverterRegistry.CreateConverterInstance(System.Type)"> + <summary> + Creates the instance of the type converter. + </summary> + <param name="converterType">The type of the type converter.</param> + <returns> + The type converter instance to use for type conversions or <c>null</c> + if no type converter is found. + </returns> + <remarks> + <para> + The type specified for the type converter must implement + the <see cref="T:log4net.Util.TypeConverters.IConvertFrom"/> or <see cref="T:log4net.Util.TypeConverters.IConvertTo"/> interfaces + and must have a public default (no argument) constructor. + </para> + </remarks> + </member> + <member name="F:log4net.Util.TypeConverters.ConverterRegistry.declaringType"> + <summary> + The fully qualified type of the ConverterRegistry class. + </summary> + <remarks> + Used by the internal logger to record the Type of the + log message. + </remarks> + </member> + <member name="F:log4net.Util.TypeConverters.ConverterRegistry.s_type2converter"> + <summary> + Mapping from <see cref="T:System.Type"/> to type converter. + </summary> + </member> + <member name="T:log4net.Util.TypeConverters.EncodingConverter"> + <summary> + Supports conversion from string to <see cref="T:System.Text.Encoding"/> type. + </summary> + <remarks> + <para> + Supports conversion from string to <see cref="T:System.Text.Encoding"/> type. + </para> + </remarks> + <seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/> + <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/> + <seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Util.TypeConverters.EncodingConverter.CanConvertFrom(System.Type)"> + <summary> + Can the source type be converted to the type supported by this object + </summary> + <param name="sourceType">the type to convert</param> + <returns>true if the conversion is possible</returns> + <remarks> + <para> + Returns <c>true</c> if the <paramref name="sourceType"/> is + the <see cref="T:System.String"/> type. + </para> + </remarks> + </member> + <member name="M:log4net.Util.TypeConverters.EncodingConverter.ConvertFrom(System.Object)"> + <summary> + Overrides the ConvertFrom method of IConvertFrom. + </summary> + <param name="source">the object to convert to an encoding</param> + <returns>the encoding</returns> + <remarks> + <para> + Uses the <see cref="M:Encoding.GetEncoding(string)"/> method to + convert the <see cref="T:System.String"/> argument to an <see cref="T:System.Text.Encoding"/>. + </para> + </remarks> + <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"> + The <paramref name="source"/> object cannot be converted to the + target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.EncodingConverter.CanConvertFrom(System.Type)"/> + method. + </exception> + </member> + <member name="T:log4net.Util.TypeConverters.IConvertTo"> + <summary> + Interface supported by type converters + </summary> + <remarks> + <para> + This interface supports conversion from a single type to arbitrary types. + See <see cref="T:log4net.Util.TypeConverters.TypeConverterAttribute"/>. + </para> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="M:log4net.Util.TypeConverters.IConvertTo.CanConvertTo(System.Type)"> + <summary> + Returns whether this converter can convert the object to the specified type + </summary> + <param name="targetType">A Type that represents the type you want to convert to</param> + <returns>true if the conversion is possible</returns> + <remarks> + <para> + Test if the type supported by this converter can be converted to the + <paramref name="targetType"/>. + </para> + </remarks> + </member> + <member name="M:log4net.Util.TypeConverters.IConvertTo.ConvertTo(System.Object,System.Type)"> + <summary> + Converts the given value object to the specified type, using the arguments + </summary> + <param name="source">the object to convert</param> + <param name="targetType">The Type to convert the value parameter to</param> + <returns>the converted object</returns> + <remarks> + <para> + Converts the <paramref name="source"/> (which must be of the type supported + by this converter) to the <paramref name="targetType"/> specified.. + </para> + </remarks> + </member> + <member name="T:log4net.Util.TypeConverters.IPAddressConverter"> + <summary> + Supports conversion from string to <see cref="T:System.Net.IPAddress"/> type. + </summary> + <remarks> + <para> + Supports conversion from string to <see cref="T:System.Net.IPAddress"/> type. + </para> + </remarks> + <seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/> + <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/> + <author>Nicko Cadell</author> + </member> + <member name="M:log4net.Util.TypeConverters.IPAddressConverter.CanConvertFrom(System.Type)"> + <summary> + Can the source type be converted to the type supported by this object + </summary> + <param name="sourceType">the type to convert</param> + <returns>true if the conversion is possible</returns> + <remarks> + <para> + Returns <c>true</c> if the <paramref name="sourceType"/> is + the <see cref="T:System.String"/> type. + </para> + </remarks> + </member> + <member name="M:log4net.Util.TypeConverters.IPAddressConverter.ConvertFrom(System.Object)"> + <summary> + Overrides the ConvertFrom method of IConvertFrom. + </summary> + <param name="source">the object to convert to an IPAddress</param> + <returns>the IPAddress</returns> + <remarks> + <para> + Uses the <see cref="M:System.Net.IPAddress.Parse(System.String)"/> method to convert the + <see cref="T:System.String"/> argument to an <see cref="T:System.Net.IPAddress"/>. + If that fails then the string is resolved as a DNS hostname. + </para> + </remarks> + <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"> + The <paramref name="source"/> object cannot be converted to the + target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.IPAddressConverter.CanConvertFrom(System.Type)"/> + method. + </exception> + </member> + <member name="F:log4net.Util.TypeConverters.IPAddressConverter.validIpAddressChars"> + <summary> + Valid characters in an IPv4 or IPv6 address string. (Does not support subnets) + </summary> + </member> + <member name="T:log4net.Util.TypeConverters.PatternLayoutConverter"> + <summary> + Supports conversion from string to <see cref="T:log4net.Layout.PatternLayout"/> type. + </summary> + <remarks> + <para> + Supports conversion from string to <see cref="T:log4net.Layout.PatternLayout"/> type. + </para> + <para> + The string is used as the <see cref="P:log4net.Layout.PatternLayout.ConversionPattern"/> + of the <see cref="T:log4net.Layout.PatternLayout"/>. + </para> + </remarks> + <seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/> + <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/> + <seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/> + <author>Nicko Cadell</author> + </member> + <member name="M:log4net.Util.TypeConverters.PatternLayoutConverter.CanConvertFrom(System.Type)"> + <summary> + Can the source type be converted to the type supported by this object + </summary> + <param name="sourceType">the type to convert</param> + <returns>true if the conversion is possible</returns> + <remarks> + <para> + Returns <c>true</c> if the <paramref name="sourceType"/> is + the <see cref="T:System.String"/> type. + </para> + </remarks> + </member> + <member name="M:log4net.Util.TypeConverters.PatternLayoutConverter.ConvertFrom(System.Object)"> + <summary> + Overrides the ConvertFrom method of IConvertFrom. + </summary> + <param name="source">the object to convert to a PatternLayout</param> + <returns>the PatternLayout</returns> + <remarks> + <para> + Creates and returns a new <see cref="T:log4net.Layout.PatternLayout"/> using + the <paramref name="source"/> <see cref="T:System.String"/> as the + <see cref="P:log4net.Layout.PatternLayout.ConversionPattern"/>. + </para> + </remarks> + <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"> + The <paramref name="source"/> object cannot be converted to the + target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.PatternLayoutConverter.CanConvertFrom(System.Type)"/> + method. + </exception> + </member> + <member name="T:log4net.Util.TypeConverters.PatternStringConverter"> + <summary> + Convert between string and <see cref="T:log4net.Util.PatternString"/> + </summary> + <remarks> + <para> + Supports conversion from string to <see cref="T:log4net.Util.PatternString"/> type, + and from a <see cref="T:log4net.Util.PatternString"/> type to a string. + </para> + <para> + The string is used as the <see cref="P:log4net.Util.PatternString.ConversionPattern"/> + of the <see cref="T:log4net.Util.PatternString"/>. + </para> + </remarks> + <seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/> + <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/> + <seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/> + <author>Nicko Cadell</author> + </member> + <member name="M:log4net.Util.TypeConverters.PatternStringConverter.CanConvertTo(System.Type)"> + <summary> + Can the target type be converted to the type supported by this object + </summary> + <param name="targetType">A <see cref="T:System.Type"/> that represents the type you want to convert to</param> + <returns>true if the conversion is possible</returns> + <remarks> + <para> + Returns <c>true</c> if the <paramref name="targetType"/> is + assignable from a <see cref="T:System.String"/> type. + </para> + </remarks> + </member> + <member name="M:log4net.Util.TypeConverters.PatternStringConverter.ConvertTo(System.Object,System.Type)"> + <summary> + Converts the given value object to the specified type, using the arguments + </summary> + <param name="source">the object to convert</param> + <param name="targetType">The Type to convert the value parameter to</param> + <returns>the converted object</returns> + <remarks> + <para> + Uses the <see cref="M:PatternString.Format()"/> method to convert the + <see cref="T:log4net.Util.PatternString"/> argument to a <see cref="T:System.String"/>. + </para> + </remarks> + <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"> + The <paramref name="source"/> object cannot be converted to the + <paramref name="targetType"/>. To check for this condition use the + <see cref="M:log4net.Util.TypeConverters.PatternStringConverter.CanConvertTo(System.Type)"/> method. + </exception> + </member> + <member name="M:log4net.Util.TypeConverters.PatternStringConverter.CanConvertFrom(System.Type)"> + <summary> + Can the source type be converted to the type supported by this object + </summary> + <param name="sourceType">the type to convert</param> + <returns>true if the conversion is possible</returns> + <remarks> + <para> + Returns <c>true</c> if the <paramref name="sourceType"/> is + the <see cref="T:System.String"/> type. + </para> + </remarks> + </member> + <member name="M:log4net.Util.TypeConverters.PatternStringConverter.ConvertFrom(System.Object)"> + <summary> + Overrides the ConvertFrom method of IConvertFrom. + </summary> + <param name="source">the object to convert to a PatternString</param> + <returns>the PatternString</returns> + <remarks> + <para> + Creates and returns a new <see cref="T:log4net.Util.PatternString"/> using + the <paramref name="source"/> <see cref="T:System.String"/> as the + <see cref="P:log4net.Util.PatternString.ConversionPattern"/>. + </para> + </remarks> + <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"> + The <paramref name="source"/> object cannot be converted to the + target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.PatternStringConverter.CanConvertFrom(System.Type)"/> + method. + </exception> + </member> + <member name="T:log4net.Util.TypeConverters.TypeConverter"> + <summary> + Supports conversion from string to <see cref="T:System.Type"/> type. + </summary> + <remarks> + <para> + Supports conversion from string to <see cref="T:System.Type"/> type. + </para> + </remarks> + <seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/> + <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/> + <seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/> + <author>Nicko Cadell</author> + </member> + <member name="M:log4net.Util.TypeConverters.TypeConverter.CanConvertFrom(System.Type)"> + <summary> + Can the source type be converted to the type supported by this object + </summary> + <param name="sourceType">the type to convert</param> + <returns>true if the conversion is possible</returns> + <remarks> + <para> + Returns <c>true</c> if the <paramref name="sourceType"/> is + the <see cref="T:System.String"/> type. + </para> + </remarks> + </member> + <member name="M:log4net.Util.TypeConverters.TypeConverter.ConvertFrom(System.Object)"> + <summary> + Overrides the ConvertFrom method of IConvertFrom. + </summary> + <param name="source">the object to convert to a Type</param> + <returns>the Type</returns> + <remarks> + <para> + Uses the <see cref="M:Type.GetType(string,bool)"/> method to convert the + <see cref="T:System.String"/> argument to a <see cref="T:System.Type"/>. + Additional effort is made to locate partially specified types + by searching the loaded assemblies. + </para> + </remarks> + <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"> + The <paramref name="source"/> object cannot be converted to the + target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.TypeConverter.CanConvertFrom(System.Type)"/> + method. + </exception> + </member> + <member name="T:log4net.Util.TypeConverters.TypeConverterAttribute"> + <summary> + Attribute used to associate a type converter + </summary> + <remarks> + <para> + Class and Interface level attribute that specifies a type converter + to use with the associated type. + </para> + <para> + To associate a type converter with a target type apply a + <c>TypeConverterAttribute</c> to the target type. Specify the + type of the type converter on the attribute. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="F:log4net.Util.TypeConverters.TypeConverterAttribute.m_typeName"> + <summary> + The string type name of the type converter + </summary> + </member> + <member name="M:log4net.Util.TypeConverters.TypeConverterAttribute.#ctor"> + <summary> + Default constructor + </summary> + <remarks> + <para> + Default constructor + </para> + </remarks> + </member> + <member name="M:log4net.Util.TypeConverters.TypeConverterAttribute.#ctor(System.String)"> + <summary> + Create a new type converter attribute for the specified type name + </summary> + <param name="typeName">The string type name of the type converter</param> + <remarks> + <para> + The type specified must implement the <see cref="T:log4net.Util.TypeConverters.IConvertFrom"/> + or the <see cref="T:log4net.Util.TypeConverters.IConvertTo"/> interfaces. + </para> + </remarks> + </member> + <member name="M:log4net.Util.TypeConverters.TypeConverterAttribute.#ctor(System.Type)"> + <summary> + Create a new type converter attribute for the specified type + </summary> + <param name="converterType">The type of the type converter</param> + <remarks> + <para> + The type specified must implement the <see cref="T:log4net.Util.TypeConverters.IConvertFrom"/> + or the <see cref="T:log4net.Util.TypeConverters.IConvertTo"/> interfaces. + </para> + </remarks> + </member> + <member name="P:log4net.Util.TypeConverters.TypeConverterAttribute.ConverterTypeName"> + <summary> + The string type name of the type converter + </summary> + <value> + The string type name of the type converter + </value> + <remarks> + <para> + The type specified must implement the <see cref="T:log4net.Util.TypeConverters.IConvertFrom"/> + or the <see cref="T:log4net.Util.TypeConverters.IConvertTo"/> interfaces. + </para> + </remarks> + </member> + <member name="T:log4net.Util.AppenderAttachedImpl"> + <summary> + A straightforward implementation of the <see cref="T:log4net.Core.IAppenderAttachable"/> interface. + </summary> + <remarks> + <para> + This is the default implementation of the <see cref="T:log4net.Core.IAppenderAttachable"/> + interface. Implementors of the <see cref="T:log4net.Core.IAppenderAttachable"/> interface + should aggregate an instance of this type. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Util.AppenderAttachedImpl.#ctor"> + <summary> + Constructor + </summary> + <remarks> + <para> + Initializes a new instance of the <see cref="T:log4net.Util.AppenderAttachedImpl"/> class. + </para> + </remarks> + </member> + <member name="M:log4net.Util.AppenderAttachedImpl.AppendLoopOnAppenders(log4net.Core.LoggingEvent)"> + <summary> + Append on on all attached appenders. + </summary> + <param name="loggingEvent">The event being logged.</param> + <returns>The number of appenders called.</returns> + <remarks> + <para> + Calls the <see cref="M:log4net.Appender.IAppender.DoAppend(log4net.Core.LoggingEvent)"/> method on all + attached appenders. + </para> + </remarks> + </member> + <member name="M:log4net.Util.AppenderAttachedImpl.AppendLoopOnAppenders(log4net.Core.LoggingEvent[])"> + <summary> + Append on on all attached appenders. + </summary> + <param name="loggingEvents">The array of events being logged.</param> + <returns>The number of appenders called.</returns> + <remarks> + <para> + Calls the <see cref="M:log4net.Appender.IAppender.DoAppend(log4net.Core.LoggingEvent)"/> method on all + attached appenders. + </para> + </remarks> + </member> + <member name="M:log4net.Util.AppenderAttachedImpl.CallAppend(log4net.Appender.IAppender,log4net.Core.LoggingEvent[])"> + <summary> + Calls the DoAppende method on the <see cref="T:log4net.Appender.IAppender"/> with + the <see cref="T:log4net.Core.LoggingEvent"/> objects supplied. + </summary> + <param name="appender">The appender</param> + <param name="loggingEvents">The events</param> + <remarks> + <para> + If the <paramref name="appender"/> supports the <see cref="T:log4net.Appender.IBulkAppender"/> + interface then the <paramref name="loggingEvents"/> will be passed + through using that interface. Otherwise the <see cref="T:log4net.Core.LoggingEvent"/> + objects in the array will be passed one at a time. + </para> + </remarks> + </member> + <member name="M:log4net.Util.AppenderAttachedImpl.AddAppender(log4net.Appender.IAppender)"> + <summary> + Attaches an appender. + </summary> + <param name="newAppender">The appender to add.</param> + <remarks> + <para> + If the appender is already in the list it won't be added again. + </para> + </remarks> + </member> + <member name="M:log4net.Util.AppenderAttachedImpl.GetAppender(System.String)"> + <summary> + Gets an attached appender with the specified name. + </summary> + <param name="name">The name of the appender to get.</param> + <returns> + The appender with the name specified, or <c>null</c> if no appender with the + specified name is found. + </returns> + <remarks> + <para> + Lookup an attached appender by name. + </para> + </remarks> + </member> + <member name="M:log4net.Util.AppenderAttachedImpl.RemoveAllAppenders"> + <summary> + Removes all attached appenders. + </summary> + <remarks> + <para> + Removes and closes all attached appenders + </para> + </remarks> + </member> + <member name="M:log4net.Util.AppenderAttachedImpl.RemoveAppender(log4net.Appender.IAppender)"> + <summary> + Removes the specified appender from the list of attached appenders. + </summary> + <param name="appender">The appender to remove.</param> + <returns>The appender removed from the list</returns> + <remarks> + <para> + The appender removed is not closed. + If you are discarding the appender you must call + <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed. + </para> + </remarks> + </member> + <member name="M:log4net.Util.AppenderAttachedImpl.RemoveAppender(System.String)"> + <summary> + Removes the appender with the specified name from the list of appenders. + </summary> + <param name="name">The name of the appender to remove.</param> + <returns>The appender removed from the list</returns> + <remarks> + <para> + The appender removed is not closed. + If you are discarding the appender you must call + <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed. + </para> + </remarks> + </member> + <member name="F:log4net.Util.AppenderAttachedImpl.m_appenderList"> + <summary> + List of appenders + </summary> + </member> + <member name="F:log4net.Util.AppenderAttachedImpl.m_appenderArray"> + <summary> + Array of appenders, used to cache the m_appenderList + </summary> + </member> + <member name="F:log4net.Util.AppenderAttachedImpl.declaringType"> + <summary> + The fully qualified type of the AppenderAttachedImpl class. + </summary> + <remarks> + Used by the internal logger to record the Type of the + log message. + </remarks> + </member> + <member name="P:log4net.Util.AppenderAttachedImpl.Appenders"> + <summary> + Gets all attached appenders. + </summary> + <returns> + A collection of attached appenders, or <c>null</c> if there + are no attached appenders. + </returns> + <remarks> + <para> + The read only collection of all currently attached appenders. + </para> + </remarks> + </member> + <member name="T:log4net.Util.CompositeProperties"> + <summary> + This class aggregates several PropertiesDictionary collections together. + </summary> + <remarks> + <para> + Provides a dictionary style lookup over an ordered list of + <see cref="T:log4net.Util.PropertiesDictionary"/> collections. + </para> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="M:log4net.Util.CompositeProperties.#ctor"> + <summary> + Constructor + </summary> + <remarks> + <para> + Initializes a new instance of the <see cref="T:log4net.Util.CompositeProperties"/> class. + </para> + </remarks> + </member> + <member name="M:log4net.Util.CompositeProperties.Add(log4net.Util.ReadOnlyPropertiesDictionary)"> + <summary> + Add a Properties Dictionary to this composite collection + </summary> + <param name="properties">the properties to add</param> + <remarks> + <para> + Properties dictionaries added first take precedence over dictionaries added + later. + </para> + </remarks> + </member> + <member name="M:log4net.Util.CompositeProperties.Flatten"> + <summary> + Flatten this composite collection into a single properties dictionary + </summary> + <returns>the flattened dictionary</returns> + <remarks> + <para> + Reduces the collection of ordered dictionaries to a single dictionary + containing the resultant values for the keys. + </para> + </remarks> + </member> + <member name="P:log4net.Util.CompositeProperties.Item(System.String)"> + <summary> + Gets the value of a property + </summary> + <value> + The value for the property with the specified key + </value> + <remarks> + <para> + Looks up the value for the <paramref name="key"/> specified. + The <see cref="T:log4net.Util.PropertiesDictionary"/> collections are searched + in the order in which they were added to this collection. The value + returned is the value held by the first collection that contains + the specified key. + </para> + <para> + If none of the collections contain the specified key then + <c>null</c> is returned. + </para> + </remarks> + </member> + <member name="T:log4net.Util.ContextPropertiesBase"> + <summary> + Base class for Context Properties implementations + </summary> + <remarks> + <para> + This class defines a basic property get set accessor + </para> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="P:log4net.Util.ContextPropertiesBase.Item(System.String)"> + <summary> + Gets or sets the value of a property + </summary> + <value> + The value for the property with the specified key + </value> + <remarks> + <para> + Gets or sets the value of a property + </para> + </remarks> + </member> + <member name="T:log4net.Util.ConverterInfo"> + <summary> + Wrapper class used to map converter names to converter types + </summary> + <remarks> + <para> + Pattern converter info class used during configuration by custom + PatternString and PatternLayer converters. + </para> + </remarks> + </member> + <member name="M:log4net.Util.ConverterInfo.#ctor"> + <summary> + default constructor + </summary> + </member> + <member name="M:log4net.Util.ConverterInfo.AddProperty(log4net.Util.PropertyEntry)"> + <summary> + + </summary> + <param name="entry"></param> + </member> + <member name="P:log4net.Util.ConverterInfo.Name"> + <summary> + Gets or sets the name of the conversion pattern + </summary> + <remarks> + <para> + The name of the pattern in the format string + </para> + </remarks> + </member> + <member name="P:log4net.Util.ConverterInfo.Type"> + <summary> + Gets or sets the type of the converter + </summary> + <remarks> + <para> + The value specified must extend the + <see cref="T:log4net.Util.PatternConverter"/> type. + </para> + </remarks> + </member> + <member name="P:log4net.Util.ConverterInfo.Properties"> + <summary> + + </summary> + </member> + <member name="T:log4net.Util.CountingQuietTextWriter"> + <summary> + Subclass of <see cref="T:log4net.Util.QuietTextWriter"/> that maintains a count of + the number of bytes written. + </summary> + <remarks> + <para> + This writer counts the number of bytes written. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="T:log4net.Util.QuietTextWriter"> + <summary> + <see cref="T:System.IO.TextWriter"/> that does not leak exceptions + </summary> + <remarks> + <para> + <see cref="T:log4net.Util.QuietTextWriter"/> does not throw exceptions when things go wrong. + Instead, it delegates error handling to its <see cref="T:log4net.Core.IErrorHandler"/>. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="T:log4net.Util.TextWriterAdapter"> + <summary> + Adapter that extends <see cref="T:System.IO.TextWriter"/> and forwards all + messages to an instance of <see cref="T:System.IO.TextWriter"/>. + </summary> + <remarks> + <para> + Adapter that extends <see cref="T:System.IO.TextWriter"/> and forwards all + messages to an instance of <see cref="T:System.IO.TextWriter"/>. + </para> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="F:log4net.Util.TextWriterAdapter.m_writer"> + <summary> + The writer to forward messages to + </summary> + </member> + <member name="M:log4net.Util.TextWriterAdapter.#ctor(System.IO.TextWriter)"> + <summary> + Create an instance of <see cref="T:log4net.Util.TextWriterAdapter"/> that forwards all + messages to a <see cref="T:System.IO.TextWriter"/>. + </summary> + <param name="writer">The <see cref="T:System.IO.TextWriter"/> to forward to</param> + <remarks> + <para> + Create an instance of <see cref="T:log4net.Util.TextWriterAdapter"/> that forwards all + messages to a <see cref="T:System.IO.TextWriter"/>. + </para> + </remarks> + </member> + <member name="M:log4net.Util.TextWriterAdapter.Close"> + <summary> + Closes the writer and releases any system resources associated with the writer + </summary> + <remarks> + <para> + </para> + </remarks> + </member> + <member name="M:log4net.Util.TextWriterAdapter.Dispose(System.Boolean)"> + <summary> + Dispose this writer + </summary> + <param name="disposing">flag indicating if we are being disposed</param> + <remarks> + <para> + Dispose this writer + </para> + </remarks> + </member> + <member name="M:log4net.Util.TextWriterAdapter.Flush"> + <summary> + Flushes any buffered output + </summary> + <remarks> + <para> + Clears all buffers for the writer and causes any buffered data to be written + to the underlying device + </para> + </remarks> + </member> + <member name="M:log4net.Util.TextWriterAdapter.Write(System.Char)"> + <summary> + Writes a character to the wrapped TextWriter + </summary> + <param name="value">the value to write to the TextWriter</param> + <remarks> + <para> + Writes a character to the wrapped TextWriter + </para> + </remarks> + </member> + <member name="M:log4net.Util.TextWriterAdapter.Write(System.Char[],System.Int32,System.Int32)"> + <summary> + Writes a character buffer to the wrapped TextWriter + </summary> + <param name="buffer">the data buffer</param> + <param name="index">the start index</param> + <param name="count">the number of characters to write</param> + <remarks> + <para> + Writes a character buffer to the wrapped TextWriter + </para> + </remarks> + </member> + <member name="M:log4net.Util.TextWriterAdapter.Write(System.String)"> + <summary> + Writes a string to the wrapped TextWriter + </summary> + <param name="value">the value to write to the TextWriter</param> + <remarks> + <para> + Writes a string to the wrapped TextWriter + </para> + </remarks> + </member> + <member name="P:log4net.Util.TextWriterAdapter.Writer"> + <summary> + Gets or sets the underlying <see cref="T:System.IO.TextWriter"/>. + </summary> + <value> + The underlying <see cref="T:System.IO.TextWriter"/>. + </value> + <remarks> + <para> + Gets or sets the underlying <see cref="T:System.IO.TextWriter"/>. + </para> + </remarks> + </member> + <member name="P:log4net.Util.TextWriterAdapter.Encoding"> + <summary> + The Encoding in which the output is written + </summary> + <value> + The <see cref="P:log4net.Util.TextWriterAdapter.Encoding"/> + </value> + <remarks> + <para> + The Encoding in which the output is written + </para> + </remarks> + </member> + <member name="P:log4net.Util.TextWriterAdapter.FormatProvider"> + <summary> + Gets an object that controls formatting + </summary> + <value> + The format provider + </value> + <remarks> + <para> + Gets an object that controls formatting + </para> + </remarks> + </member> + <member name="P:log4net.Util.TextWriterAdapter.NewLine"> + <summary> + Gets or sets the line terminator string used by the TextWriter + </summary> + <value> + The line terminator to use + </value> + <remarks> + <para> + Gets or sets the line terminator string used by the TextWriter + </para> + </remarks> + </member> + <member name="M:log4net.Util.QuietTextWriter.#ctor(System.IO.TextWriter,log4net.Core.IErrorHandler)"> + <summary> + Constructor + </summary> + <param name="writer">the writer to actually write to</param> + <param name="errorHandler">the error handler to report error to</param> + <remarks> + <para> + Create a new QuietTextWriter using a writer and error handler + </para> + </remarks> + </member> + <member name="M:log4net.Util.QuietTextWriter.Write(System.Char)"> + <summary> + Writes a character to the underlying writer + </summary> + <param name="value">the char to write</param> + <remarks> + <para> + Writes a character to the underlying writer + </para> + </remarks> + </member> + <member name="M:log4net.Util.QuietTextWriter.Write(System.Char[],System.Int32,System.Int32)"> + <summary> + Writes a buffer to the underlying writer + </summary> + <param name="buffer">the buffer to write</param> + <param name="index">the start index to write from</param> + <param name="count">the number of characters to write</param> + <remarks> + <para> + Writes a buffer to the underlying writer + </para> + </remarks> + </member> + <member name="M:log4net.Util.QuietTextWriter.Write(System.String)"> + <summary> + Writes a string to the output. + </summary> + <param name="value">The string data to write to the output.</param> + <remarks> + <para> + Writes a string to the output. + </para> + </remarks> + </member> + <member name="M:log4net.Util.QuietTextWriter.Close"> + <summary> + Closes the underlying output writer. + </summary> + <remarks> + <para> + Closes the underlying output writer. + </para> + </remarks> + </member> + <member name="F:log4net.Util.QuietTextWriter.m_errorHandler"> + <summary> + The error handler instance to pass all errors to + </summary> + </member> + <member name="F:log4net.Util.QuietTextWriter.m_closed"> + <summary> + Flag to indicate if this writer is closed + </summary> + </member> + <member name="P:log4net.Util.QuietTextWriter.ErrorHandler"> + <summary> + Gets or sets the error handler that all errors are passed to. + </summary> + <value> + The error handler that all errors are passed to. + </value> + <remarks> + <para> + Gets or sets the error handler that all errors are passed to. + </para> + </remarks> + </member> + <member name="P:log4net.Util.QuietTextWriter.Closed"> + <summary> + Gets a value indicating whether this writer is closed. + </summary> + <value> + <c>true</c> if this writer is closed, otherwise <c>false</c>. + </value> + <remarks> + <para> + Gets a value indicating whether this writer is closed. + </para> + </remarks> + </member> + <member name="M:log4net.Util.CountingQuietTextWriter.#ctor(System.IO.TextWriter,log4net.Core.IErrorHandler)"> + <summary> + Constructor + </summary> + <param name="writer">The <see cref="T:System.IO.TextWriter"/> to actually write to.</param> + <param name="errorHandler">The <see cref="T:log4net.Core.IErrorHandler"/> to report errors to.</param> + <remarks> + <para> + Creates a new instance of the <see cref="T:log4net.Util.CountingQuietTextWriter"/> class + with the specified <see cref="T:System.IO.TextWriter"/> and <see cref="T:log4net.Core.IErrorHandler"/>. + </para> + </remarks> + </member> + <member name="M:log4net.Util.CountingQuietTextWriter.Write(System.Char)"> + <summary> + Writes a character to the underlying writer and counts the number of bytes written. + </summary> + <param name="value">the char to write</param> + <remarks> + <para> + Overrides implementation of <see cref="T:log4net.Util.QuietTextWriter"/>. Counts + the number of bytes written. + </para> + </remarks> + </member> + <member name="M:log4net.Util.CountingQuietTextWriter.Write(System.Char[],System.Int32,System.Int32)"> + <summary> + Writes a buffer to the underlying writer and counts the number of bytes written. + </summary> + <param name="buffer">the buffer to write</param> + <param name="index">the start index to write from</param> + <param name="count">the number of characters to write</param> + <remarks> + <para> + Overrides implementation of <see cref="T:log4net.Util.QuietTextWriter"/>. Counts + the number of bytes written. + </para> + </remarks> + </member> + <member name="M:log4net.Util.CountingQuietTextWriter.Write(System.String)"> + <summary> + Writes a string to the output and counts the number of bytes written. + </summary> + <param name="str">The string data to write to the output.</param> + <remarks> + <para> + Overrides implementation of <see cref="T:log4net.Util.QuietTextWriter"/>. Counts + the number of bytes written. + </para> + </remarks> + </member> + <member name="F:log4net.Util.CountingQuietTextWriter.m_countBytes"> + <summary> + Total number of bytes written. + </summary> + </member> + <member name="P:log4net.Util.CountingQuietTextWriter.Count"> + <summary> + Gets or sets the total number of bytes written. + </summary> + <value> + The total number of bytes written. + </value> + <remarks> + <para> + Gets or sets the total number of bytes written. + </para> + </remarks> + </member> + <member name="T:log4net.Util.CyclicBuffer"> + <summary> + A fixed size rolling buffer of logging events. + </summary> + <remarks> + <para> + An array backed fixed size leaky bucket. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Util.CyclicBuffer.#ctor(System.Int32)"> + <summary> + Constructor + </summary> + <param name="maxSize">The maximum number of logging events in the buffer.</param> + <remarks> + <para> + Initializes a new instance of the <see cref="T:log4net.Util.CyclicBuffer"/> class with + the specified maximum number of buffered logging events. + </para> + </remarks> + <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="maxSize"/> argument is not a positive integer.</exception> + </member> + <member name="M:log4net.Util.CyclicBuffer.Append(log4net.Core.LoggingEvent)"> + <summary> + Appends a <paramref name="loggingEvent"/> to the buffer. + </summary> + <param name="loggingEvent">The event to append to the buffer.</param> + <returns>The event discarded from the buffer, if the buffer is full, otherwise <c>null</c>.</returns> + <remarks> + <para> + Append an event to the buffer. If the buffer still contains free space then + <c>null</c> is returned. If the buffer is full then an event will be dropped + to make space for the new event, the event dropped is returned. + </para> + </remarks> + </member> + <member name="M:log4net.Util.CyclicBuffer.PopOldest"> + <summary> + Get and remove the oldest event in the buffer. + </summary> + <returns>The oldest logging event in the buffer</returns> + <remarks> + <para> + Gets the oldest (first) logging event in the buffer and removes it + from the buffer. + </para> + </remarks> + </member> + <member name="M:log4net.Util.CyclicBuffer.PopAll"> + <summary> + Pops all the logging events from the buffer into an array. + </summary> + <returns>An array of all the logging events in the buffer.</returns> + <remarks> + <para> + Get all the events in the buffer and clear the buffer. + </para> + </remarks> + </member> + <member name="M:log4net.Util.CyclicBuffer.Clear"> + <summary> + Clear the buffer + </summary> + <remarks> + <para> + Clear the buffer of all events. The events in the buffer are lost. + </para> + </remarks> + </member> + <member name="P:log4net.Util.CyclicBuffer.Item(System.Int32)"> + <summary> + Gets the <paramref name="i"/>th oldest event currently in the buffer. + </summary> + <value>The <paramref name="i"/>th oldest event currently in the buffer.</value> + <remarks> + <para> + If <paramref name="i"/> is outside the range 0 to the number of events + currently in the buffer, then <c>null</c> is returned. + </para> + </remarks> + </member> + <member name="P:log4net.Util.CyclicBuffer.MaxSize"> + <summary> + Gets the maximum size of the buffer. + </summary> + <value>The maximum size of the buffer.</value> + <remarks> + <para> + Gets the maximum size of the buffer + </para> + </remarks> + </member> + <member name="P:log4net.Util.CyclicBuffer.Length"> + <summary> + Gets the number of logging events in the buffer. + </summary> + <value>The number of logging events in the buffer.</value> + <remarks> + <para> + This number is guaranteed to be in the range 0 to <see cref="P:log4net.Util.CyclicBuffer.MaxSize"/> + (inclusive). + </para> + </remarks> + </member> + <member name="T:log4net.Util.EmptyCollection"> + <summary> + An always empty <see cref="T:System.Collections.ICollection"/>. + </summary> + <remarks> + <para> + A singleton implementation of the <see cref="T:System.Collections.ICollection"/> + interface that always represents an empty collection. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Util.EmptyCollection.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:log4net.Util.EmptyCollection"/> class. + </summary> + <remarks> + <para> + Uses a private access modifier to enforce the singleton pattern. + </para> + </remarks> + </member> + <member name="M:log4net.Util.EmptyCollection.CopyTo(System.Array,System.Int32)"> + <summary> + Copies the elements of the <see cref="T:System.Collections.ICollection"/> to an + <see cref="T:System.Array"/>, starting at a particular Array index. + </summary> + <param name="array">The one-dimensional <see cref="T:System.Array"/> + that is the destination of the elements copied from + <see cref="T:System.Collections.ICollection"/>. The Array must have zero-based + indexing.</param> + <param name="index">The zero-based index in array at which + copying begins.</param> + <remarks> + <para> + As the collection is empty no values are copied into the array. + </para> + </remarks> + </member> + <member name="M:log4net.Util.EmptyCollection.GetEnumerator"> + <summary> + Returns an enumerator that can iterate through a collection. + </summary> + <returns> + An <see cref="T:System.Collections.IEnumerator"/> that can be used to + iterate through the collection. + </returns> + <remarks> + <para> + As the collection is empty a <see cref="T:log4net.Util.NullEnumerator"/> is returned. + </para> + </remarks> + </member> + <member name="F:log4net.Util.EmptyCollection.s_instance"> + <summary> + The singleton instance of the empty collection. + </summary> + </member> + <member name="P:log4net.Util.EmptyCollection.Instance"> + <summary> + Gets the singleton instance of the empty collection. + </summary> + <returns>The singleton instance of the empty collection.</returns> + <remarks> + <para> + Gets the singleton instance of the empty collection. + </para> + </remarks> + </member> + <member name="P:log4net.Util.EmptyCollection.IsSynchronized"> + <summary> + Gets a value indicating if access to the <see cref="T:System.Collections.ICollection"/> is synchronized (thread-safe). + </summary> + <value> + <b>true</b> if access to the <see cref="T:System.Collections.ICollection"/> is synchronized (thread-safe); otherwise, <b>false</b>. + </value> + <remarks> + <para> + For the <see cref="T:log4net.Util.EmptyCollection"/> this property is always <c>true</c>. + </para> + </remarks> + </member> + <member name="P:log4net.Util.EmptyCollection.Count"> + <summary> + Gets the number of elements contained in the <see cref="T:System.Collections.ICollection"/>. + </summary> + <value> + The number of elements contained in the <see cref="T:System.Collections.ICollection"/>. + </value> + <remarks> + <para> + As the collection is empty the <see cref="P:log4net.Util.EmptyCollection.Count"/> is always <c>0</c>. + </para> + </remarks> + </member> + <member name="P:log4net.Util.EmptyCollection.SyncRoot"> + <summary> + Gets an object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection"/>. + </summary> + <value> + An object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection"/>. + </value> + <remarks> + <para> + As the collection is empty and thread safe and synchronized this instance is also + the <see cref="P:log4net.Util.EmptyCollection.SyncRoot"/> object. + </para> + </remarks> + </member> + <member name="T:log4net.Util.EmptyDictionary"> + <summary> + An always empty <see cref="T:System.Collections.IDictionary"/>. + </summary> + <remarks> + <para> + A singleton implementation of the <see cref="T:System.Collections.IDictionary"/> + interface that always represents an empty collection. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Util.EmptyDictionary.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:log4net.Util.EmptyDictionary"/> class. + </summary> + <remarks> + <para> + Uses a private access modifier to enforce the singleton pattern. + </para> + </remarks> + </member> + <member name="M:log4net.Util.EmptyDictionary.CopyTo(System.Array,System.Int32)"> + <summary> + Copies the elements of the <see cref="T:System.Collections.ICollection"/> to an + <see cref="T:System.Array"/>, starting at a particular Array index. + </summary> + <param name="array">The one-dimensional <see cref="T:System.Array"/> + that is the destination of the elements copied from + <see cref="T:System.Collections.ICollection"/>. The Array must have zero-based + indexing.</param> + <param name="index">The zero-based index in array at which + copying begins.</param> + <remarks> + <para> + As the collection is empty no values are copied into the array. + </para> + </remarks> + </member> + <member name="M:log4net.Util.EmptyDictionary.System#Collections#IEnumerable#GetEnumerator"> + <summary> + Returns an enumerator that can iterate through a collection. + </summary> + <returns> + An <see cref="T:System.Collections.IEnumerator"/> that can be used to + iterate through the collection. + </returns> + <remarks> + <para> + As the collection is empty a <see cref="T:log4net.Util.NullEnumerator"/> is returned. + </para> + </remarks> + </member> + <member name="M:log4net.Util.EmptyDictionary.Add(System.Object,System.Object)"> + <summary> + Adds an element with the provided key and value to the + <see cref="T:log4net.Util.EmptyDictionary"/>. + </summary> + <param name="key">The <see cref="T:System.Object"/> to use as the key of the element to add.</param> + <param name="value">The <see cref="T:System.Object"/> to use as the value of the element to add.</param> + <remarks> + <para> + As the collection is empty no new values can be added. A <see cref="T:System.InvalidOperationException"/> + is thrown if this method is called. + </para> + </remarks> + <exception cref="T:System.InvalidOperationException">This dictionary is always empty and cannot be modified.</exception> + </member> + <member name="M:log4net.Util.EmptyDictionary.Clear"> + <summary> + Removes all elements from the <see cref="T:log4net.Util.EmptyDictionary"/>. + </summary> + <remarks> + <para> + As the collection is empty no values can be removed. A <see cref="T:System.InvalidOperationException"/> + is thrown if this method is called. + </para> + </remarks> + <exception cref="T:System.InvalidOperationException">This dictionary is always empty and cannot be modified.</exception> + </member> + <member name="M:log4net.Util.EmptyDictionary.Contains(System.Object)"> + <summary> + Determines whether the <see cref="T:log4net.Util.EmptyDictionary"/> contains an element + with the specified key. + </summary> + <param name="key">The key to locate in the <see cref="T:log4net.Util.EmptyDictionary"/>.</param> + <returns><c>false</c></returns> + <remarks> + <para> + As the collection is empty the <see cref="M:log4net.Util.EmptyDictionary.Contains(System.Object)"/> method always returns <c>false</c>. + </para> + </remarks> + </member> + <member name="M:log4net.Util.EmptyDictionary.GetEnumerator"> + <summary> + Returns an enumerator that can iterate through a collection. + </summary> + <returns> + An <see cref="T:System.Collections.IEnumerator"/> that can be used to + iterate through the collection. + </returns> + <remarks> + <para> + As the collection is empty a <see cref="T:log4net.Util.NullEnumerator"/> is returned. + </para> + </remarks> + </member> + <member name="M:log4net.Util.EmptyDictionary.Remove(System.Object)"> + <summary> + Removes the element with the specified key from the <see cref="T:log4net.Util.EmptyDictionary"/>. + </summary> + <param name="key">The key of the element to remove.</param> + <remarks> + <para> + As the collection is empty no values can be removed. A <see cref="T:System.InvalidOperationException"/> + is thrown if this method is called. + </para> + </remarks> + <exception cref="T:System.InvalidOperationException">This dictionary is always empty and cannot be modified.</exception> + </member> + <member name="F:log4net.Util.EmptyDictionary.s_instance"> + <summary> + The singleton instance of the empty dictionary. + </summary> + </member> + <member name="P:log4net.Util.EmptyDictionary.Instance"> + <summary> + Gets the singleton instance of the <see cref="T:log4net.Util.EmptyDictionary"/>. + </summary> + <returns>The singleton instance of the <see cref="T:log4net.Util.EmptyDictionary"/>.</returns> + <remarks> + <para> + Gets the singleton instance of the <see cref="T:log4net.Util.EmptyDictionary"/>. + </para> + </remarks> + </member> + <member name="P:log4net.Util.EmptyDictionary.IsSynchronized"> + <summary> + Gets a value indicating if access to the <see cref="T:System.Collections.ICollection"/> is synchronized (thread-safe). + </summary> + <value> + <b>true</b> if access to the <see cref="T:System.Collections.ICollection"/> is synchronized (thread-safe); otherwise, <b>false</b>. + </value> + <remarks> + <para> + For the <see cref="T:log4net.Util.EmptyCollection"/> this property is always <b>true</b>. + </para> + </remarks> + </member> + <member name="P:log4net.Util.EmptyDictionary.Count"> + <summary> + Gets the number of elements contained in the <see cref="T:System.Collections.ICollection"/> + </summary> + <value> + The number of elements contained in the <see cref="T:System.Collections.ICollection"/>. + </value> + <remarks> + <para> + As the collection is empty the <see cref="P:log4net.Util.EmptyDictionary.Count"/> is always <c>0</c>. + </para> + </remarks> + </member> + <member name="P:log4net.Util.EmptyDictionary.SyncRoot"> + <summary> + Gets an object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection"/>. + </summary> + <value> + An object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection"/>. + </value> + <remarks> + <para> + As the collection is empty and thread safe and synchronized this instance is also + the <see cref="P:log4net.Util.EmptyDictionary.SyncRoot"/> object. + </para> + </remarks> + </member> + <member name="P:log4net.Util.EmptyDictionary.IsFixedSize"> + <summary> + Gets a value indicating whether the <see cref="T:log4net.Util.EmptyDictionary"/> has a fixed size. + </summary> + <value><c>true</c></value> + <remarks> + <para> + As the collection is empty <see cref="P:log4net.Util.EmptyDictionary.IsFixedSize"/> always returns <c>true</c>. + </para> + </remarks> + </member> + <member name="P:log4net.Util.EmptyDictionary.IsReadOnly"> + <summary> + Gets a value indicating whether the <see cref="T:log4net.Util.EmptyDictionary"/> is read-only. + </summary> + <value><c>true</c></value> + <remarks> + <para> + As the collection is empty <see cref="P:log4net.Util.EmptyDictionary.IsReadOnly"/> always returns <c>true</c>. + </para> + </remarks> + </member> + <member name="P:log4net.Util.EmptyDictionary.Keys"> + <summary> + Gets an <see cref="T:System.Collections.ICollection"/> containing the keys of the <see cref="T:log4net.Util.EmptyDictionary"/>. + </summary> + <value>An <see cref="T:System.Collections.ICollection"/> containing the keys of the <see cref="T:log4net.Util.EmptyDictionary"/>.</value> + <remarks> + <para> + As the collection is empty a <see cref="T:log4net.Util.EmptyCollection"/> is returned. + </para> + </remarks> + </member> + <member name="P:log4net.Util.EmptyDictionary.Values"> + <summary> + Gets an <see cref="T:System.Collections.ICollection"/> containing the values of the <see cref="T:log4net.Util.EmptyDictionary"/>. + </summary> + <value>An <see cref="T:System.Collections.ICollection"/> containing the values of the <see cref="T:log4net.Util.EmptyDictionary"/>.</value> + <remarks> + <para> + As the collection is empty a <see cref="T:log4net.Util.EmptyCollection"/> is returned. + </para> + </remarks> + </member> + <member name="P:log4net.Util.EmptyDictionary.Item(System.Object)"> + <summary> + Gets or sets the element with the specified key. + </summary> + <param name="key">The key of the element to get or set.</param> + <value><c>null</c></value> + <remarks> + <para> + As the collection is empty no values can be looked up or stored. + If the index getter is called then <c>null</c> is returned. + A <see cref="T:System.InvalidOperationException"/> is thrown if the setter is called. + </para> + </remarks> + <exception cref="T:System.InvalidOperationException">This dictionary is always empty and cannot be modified.</exception> + </member> + <member name="T:log4net.Util.FormattingInfo"> + <summary> + Contain the information obtained when parsing formatting modifiers + in conversion modifiers. + </summary> + <remarks> + <para> + Holds the formatting information extracted from the format string by + the <see cref="T:log4net.Util.PatternParser"/>. This is used by the <see cref="T:log4net.Util.PatternConverter"/> + objects when rendering the output. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Util.FormattingInfo.#ctor"> + <summary> + Defaut Constructor + </summary> + <remarks> + <para> + Initializes a new instance of the <see cref="T:log4net.Util.FormattingInfo"/> class. + </para> + </remarks> + </member> + <member name="M:log4net.Util.FormattingInfo.#ctor(System.Int32,System.Int32,System.Boolean)"> + <summary> + Constructor + </summary> + <remarks> + <para> + Initializes a new instance of the <see cref="T:log4net.Util.FormattingInfo"/> class + with the specified parameters. + </para> + </remarks> + </member> + <member name="P:log4net.Util.FormattingInfo.Min"> + <summary> + Gets or sets the minimum value. + </summary> + <value> + The minimum value. + </value> + <remarks> + <para> + Gets or sets the minimum value. + </para> + </remarks> + </member> + <member name="P:log4net.Util.FormattingInfo.Max"> + <summary> + Gets or sets the maximum value. + </summary> + <value> + The maximum value. + </value> + <remarks> + <para> + Gets or sets the maximum value. + </para> + </remarks> + </member> + <member name="P:log4net.Util.FormattingInfo.LeftAlign"> + <summary> + Gets or sets a flag indicating whether left align is enabled + or not. + </summary> + <value> + A flag indicating whether left align is enabled or not. + </value> + <remarks> + <para> + Gets or sets a flag indicating whether left align is enabled or not. + </para> + </remarks> + </member> + <member name="T:log4net.Util.GlobalContextProperties"> + <summary> + Implementation of Properties collection for the <see cref="T:log4net.GlobalContext"/> + </summary> + <remarks> + <para> + This class implements a properties collection that is thread safe and supports both + storing properties and capturing a read only copy of the current propertied. + </para> + <para> + This class is optimized to the scenario where the properties are read frequently + and are modified infrequently. + </para> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="F:log4net.Util.GlobalContextProperties.m_readOnlyProperties"> + <summary> + The read only copy of the properties. + </summary> + <remarks> + <para> + This variable is declared <c>volatile</c> to prevent the compiler and JIT from + reordering reads and writes of this thread performed on different threads. + </para> + </remarks> + </member> + <member name="F:log4net.Util.GlobalContextProperties.m_syncRoot"> + <summary> + Lock object used to synchronize updates within this instance + </summary> + </member> + <member name="M:log4net.Util.GlobalContextProperties.#ctor"> + <summary> + Constructor + </summary> + <remarks> + <para> + Initializes a new instance of the <see cref="T:log4net.Util.GlobalContextProperties"/> class. + </para> + </remarks> + </member> + <member name="M:log4net.Util.GlobalContextProperties.Remove(System.String)"> + <summary> + Remove a property from the global context + </summary> + <param name="key">the key for the entry to remove</param> + <remarks> + <para> + Removing an entry from the global context properties is relatively expensive compared + with reading a value. + </para> + </remarks> + </member> + <member name="M:log4net.Util.GlobalContextProperties.Clear"> + <summary> + Clear the global context properties + </summary> + </member> + <member name="M:log4net.Util.GlobalContextProperties.GetReadOnlyProperties"> + <summary> + Get a readonly immutable copy of the properties + </summary> + <returns>the current global context properties</returns> + <remarks> + <para> + This implementation is fast because the GlobalContextProperties class + stores a readonly copy of the properties. + </para> + </remarks> + </member> + <member name="P:log4net.Util.GlobalContextProperties.Item(System.String)"> + <summary> + Gets or sets the value of a property + </summary> + <value> + The value for the property with the specified key + </value> + <remarks> + <para> + Reading the value for a key is faster than setting the value. + When the value is written a new read only copy of + the properties is created. + </para> + </remarks> + </member> + <member name="T:log4net.Util.ILogExtensions"> + <summary> + The static class ILogExtensions contains a set of widely used + methods that ease the interaction with the ILog interface implementations. + </summary> + <remarks> + <para> + This class contains methods for logging at different levels and checks the + properties for determining if those logging levels are enabled in the current + configuration. + </para> + </remarks> + <example>Simple example of logging messages + <code lang="C#"> + using log4net.Util; + + ILog log = LogManager.GetLogger("application-log"); + + log.InfoExt("Application Start"); + log.DebugExt("This is a debug message"); + </code> + </example> + </member> + <member name="F:log4net.Util.ILogExtensions.declaringType"> + <summary> + The fully qualified type of the Logger class. + </summary> + </member> + <member name="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Func{System.Object})"> + <summary> + Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level. + </summary> + <param name="logger">The logger on which the message is logged.</param> + <param name="callback">The lambda expression that gets the object to log.</param> + <remarks> + <para> + This method first checks if this logger is <c>INFO</c> + enabled by reading the value <seealso cref="P:log4net.ILog.IsDebugEnabled"/> property. + This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/> + implementation. If this logger is <c>INFO</c> enabled, then it converts + the message object (retrieved by invocation of the provided callback) to a + string by invoking the appropriate <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. + It then proceeds to call all the registered appenders in this logger + and also higher in the hierarchy depending on the value of + the additivity flag. + </para> + <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/> + to this method will print the name of the <see cref="T:System.Exception"/> + but no stack trace. To print a stack trace use the + <see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Func{System.Object},System.Exception)"/> form instead. + </para> + </remarks> + <seealso cref="M:log4net.ILog.Debug(System.Object)"/> + <seealso cref="P:log4net.ILog.IsDebugEnabled"/> + </member> + <member name="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Func{System.Object},System.Exception)"> + <summary> + Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level including + the stack trace of the <see cref="T:System.Exception"/> passed + as a parameter. + </summary> + <param name="logger">The logger on which the message is logged.</param> + <param name="callback">The lambda expression that gets the object to log.</param> + <param name="exception">The exception to log, including its stack trace.</param> + <remarks> + <para> + See the <see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object)"/> form for more detailed information. + </para> + </remarks> + <seealso cref="M:log4net.ILog.Debug(System.Object)"/> + <seealso cref="P:log4net.ILog.IsDebugEnabled"/> + </member> + <member name="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object)"> + <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level.</overloads> //TODO + <summary> + Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level. + </summary> + <param name="logger">The logger on which the message is logged.</param> + <param name="message">The message object to log.</param> + <remarks> + <para> + This method first checks if this logger is <c>INFO</c> + enabled by reading the value <seealso cref="P:log4net.ILog.IsDebugEnabled"/> property. + This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/> + implementation. If this logger is <c>INFO</c> enabled, then it converts + the message object (passed as parameter) to a string by invoking the appropriate + <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then + proceeds to call all the registered appenders in this logger + and also higher in the hierarchy depending on the value of + the additivity flag. + </para> + <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/> + to this method will print the name of the <see cref="T:System.Exception"/> + but no stack trace. To print a stack trace use the + <see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object,System.Exception)"/> form instead. + </para> + </remarks> + <seealso cref="M:log4net.ILog.Debug(System.Object)"/> + <seealso cref="P:log4net.ILog.IsDebugEnabled"/> + </member> + <member name="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object,System.Exception)"> + <summary> + Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level including + the stack trace of the <see cref="T:System.Exception"/> passed + as a parameter. + </summary> + <param name="logger">The logger on which the message is logged.</param> + <param name="message">The message object to log.</param> + <param name="exception">The exception to log, including its stack trace.</param> + <remarks> + <para> + See the <see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object)"/> form for more detailed information. + </para> + </remarks> + <seealso cref="M:log4net.ILog.Debug(System.Object)"/> + <seealso cref="P:log4net.ILog.IsDebugEnabled"/> + </member> + <member name="M:log4net.Util.ILogExtensions.DebugFormatExt(log4net.ILog,System.String,System.Object)"> + <summary> + Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level. + </summary> + <param name="logger">The logger on which the message is logged.</param> + <param name="format">A String containing zero or more format items</param> + <param name="arg0">An Object to format</param> + <remarks> + <para> + The message is formatted using the <c>String.Format</c> method. See + <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object,System.Exception)"/> + methods instead. + </para> + </remarks> + <seealso cref="M:log4net.ILog.Debug(System.Object)"/> + <seealso cref="P:log4net.ILog.IsDebugEnabled"/> + </member> + <member name="M:log4net.Util.ILogExtensions.DebugFormatExt(log4net.ILog,System.String,System.Object[])"> + <summary> + Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level. + </summary> + <param name="logger">The logger on which the message is logged.</param> + <param name="format">A String containing zero or more format items</param> + <param name="args">An Object array containing zero or more objects to format</param> + <remarks> + <para> + The message is formatted using the <c>String.Format</c> method. See + <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object,System.Exception)"/> + methods instead. + </para> + </remarks> + <seealso cref="M:log4net.ILog.Debug(System.Object)"/> + <seealso cref="P:log4net.ILog.IsDebugEnabled"/> + </member> + <member name="M:log4net.Util.ILogExtensions.DebugFormatExt(log4net.ILog,System.IFormatProvider,System.String,System.Object[])"> + <summary> + Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level. + </summary> + <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param> + <param name="logger">The logger on which the message is logged.</param> + <param name="format">A String containing zero or more format items</param> + <param name="args">An Object array containing zero or more objects to format</param> + <remarks> + <para> + The message is formatted using the <c>String.Format</c> method. See + <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object,System.Exception)"/> + methods instead. + </para> + </remarks> + <seealso cref="M:log4net.ILog.Debug(System.Object)"/> + <seealso cref="P:log4net.ILog.IsDebugEnabled"/> + </member> + <member name="M:log4net.Util.ILogExtensions.DebugFormatExt(log4net.ILog,System.String,System.Object,System.Object)"> + <summary> + Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level. + </summary> + <param name="logger">The logger on which the message is logged.</param> + <param name="format">A String containing zero or more format items</param> + <param name="arg0">An Object to format</param> + <param name="arg1">An Object to format</param> + <remarks> + <para> + The message is formatted using the <c>String.Format</c> method. See + <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object,System.Exception)"/> + methods instead. + </para> + </remarks> + <seealso cref="M:log4net.ILog.Debug(System.Object)"/> + <seealso cref="P:log4net.ILog.IsDebugEnabled"/> + </member> + <member name="M:log4net.Util.ILogExtensions.DebugFormatExt(log4net.ILog,System.String,System.Object,System.Object,System.Object)"> + <summary> + Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level. + </summary> + <param name="logger">The logger on which the message is logged.</param> + <param name="format">A String containing zero or more format items</param> + <param name="arg0">An Object to format</param> + <param name="arg1">An Object to format</param> + <param name="arg2">An Object to format</param> + <remarks> + <para> + The message is formatted using the <c>String.Format</c> method. See + <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object,System.Exception)"/> + methods instead. + </para> + </remarks> + <seealso cref="M:log4net.ILog.Debug(System.Object)"/> + <seealso cref="P:log4net.ILog.IsDebugEnabled"/> + </member> + <member name="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Func{System.Object})"> + <summary> + Log a message object with the <see cref="F:log4net.Core.Level.Info"/> level. + </summary> + <param name="logger">The logger on which the message is logged.</param> + <param name="callback">The lambda expression that gets the object to log.</param> + <remarks> + <para> + This method first checks if this logger is <c>INFO</c> + enabled by reading the value <seealso cref="P:log4net.ILog.IsInfoEnabled"/> property. + This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/> + implementation. If this logger is <c>INFO</c> enabled, then it converts + the message object (retrieved by invocation of the provided callback) to a + string by invoking the appropriate <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. + It then proceeds to call all the registered appenders in this logger + and also higher in the hierarchy depending on the value of + the additivity flag. + </para> + <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/> + to this method will print the name of the <see cref="T:System.Exception"/> + but no stack trace. To print a stack trace use the + <see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Func{System.Object},System.Exception)"/> form instead. + </para> + </remarks> + <seealso cref="M:log4net.ILog.Info(System.Object)"/> + <seealso cref="P:log4net.ILog.IsInfoEnabled"/> + </member> + <member name="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Func{System.Object},System.Exception)"> + <summary> + Log a message object with the <see cref="F:log4net.Core.Level.Info"/> level including + the stack trace of the <see cref="T:System.Exception"/> passed + as a parameter. + </summary> + <param name="logger">The logger on which the message is logged.</param> + <param name="callback">The lambda expression that gets the object to log.</param> + <param name="exception">The exception to log, including its stack trace.</param> + <remarks> + <para> + See the <see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object)"/> form for more detailed information. + </para> + </remarks> + <seealso cref="M:log4net.ILog.Info(System.Object)"/> + <seealso cref="P:log4net.ILog.IsInfoEnabled"/> + </member> + <member name="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object)"> + <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Info"/> level.</overloads> //TODO + <summary> + Log a message object with the <see cref="F:log4net.Core.Level.Info"/> level. + </summary> + <param name="logger">The logger on which the message is logged.</param> + <param name="message">The message object to log.</param> + <remarks> + <para> + This method first checks if this logger is <c>INFO</c> + enabled by reading the value <seealso cref="P:log4net.ILog.IsInfoEnabled"/> property. + This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/> + implementation. If this logger is <c>INFO</c> enabled, then it converts + the message object (passed as parameter) to a string by invoking the appropriate + <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then + proceeds to call all the registered appenders in this logger + and also higher in the hierarchy depending on the value of + the additivity flag. + </para> + <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/> + to this method will print the name of the <see cref="T:System.Exception"/> + but no stack trace. To print a stack trace use the + <see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object,System.Exception)"/> form instead. + </para> + </remarks> + <seealso cref="M:log4net.ILog.Info(System.Object)"/> + <seealso cref="P:log4net.ILog.IsInfoEnabled"/> + </member> + <member name="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object,System.Exception)"> + <summary> + Log a message object with the <see cref="F:log4net.Core.Level.Info"/> level including + the stack trace of the <see cref="T:System.Exception"/> passed + as a parameter. + </summary> + <param name="logger">The logger on which the message is logged.</param> + <param name="message">The message object to log.</param> + <param name="exception">The exception to log, including its stack trace.</param> + <remarks> + <para> + See the <see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object)"/> form for more detailed information. + </para> + </remarks> + <seealso cref="M:log4net.ILog.Info(System.Object)"/> + <seealso cref="P:log4net.ILog.IsInfoEnabled"/> + </member> + <member name="M:log4net.Util.ILogExtensions.InfoFormatExt(log4net.ILog,System.String,System.Object)"> + <summary> + Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level. + </summary> + <param name="logger">The logger on which the message is logged.</param> + <param name="format">A String containing zero or more format items</param> + <param name="arg0">An Object to format</param> + <remarks> + <para> + The message is formatted using the <c>String.Format</c> method. See + <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object,System.Exception)"/> + methods instead. + </para> + </remarks> + <seealso cref="M:log4net.ILog.Info(System.Object)"/> + <seealso cref="P:log4net.ILog.IsInfoEnabled"/> + </member> + <member name="M:log4net.Util.ILogExtensions.InfoFormatExt(log4net.ILog,System.String,System.Object[])"> + <summary> + Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level. + </summary> + <param name="logger">The logger on which the message is logged.</param> + <param name="format">A String containing zero or more format items</param> + <param name="args">An Object array containing zero or more objects to format</param> + <remarks> + <para> + The message is formatted using the <c>String.Format</c> method. See + <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object,System.Exception)"/> + methods instead. + </para> + </remarks> + <seealso cref="M:log4net.ILog.Info(System.Object)"/> + <seealso cref="P:log4net.ILog.IsInfoEnabled"/> + </member> + <member name="M:log4net.Util.ILogExtensions.InfoFormatExt(log4net.ILog,System.IFormatProvider,System.String,System.Object[])"> + <summary> + Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level. + </summary> + <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param> + <param name="logger">The logger on which the message is logged.</param> + <param name="format">A String containing zero or more format items</param> + <param name="args">An Object array containing zero or more objects to format</param> + <remarks> + <para> + The message is formatted using the <c>String.Format</c> method. See + <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object,System.Exception)"/> + methods instead. + </para> + </remarks> + <seealso cref="M:log4net.ILog.Info(System.Object)"/> + <seealso cref="P:log4net.ILog.IsInfoEnabled"/> + </member> + <member name="M:log4net.Util.ILogExtensions.InfoFormatExt(log4net.ILog,System.String,System.Object,System.Object)"> + <summary> + Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level. + </summary> + <param name="logger">The logger on which the message is logged.</param> + <param name="format">A String containing zero or more format items</param> + <param name="arg0">An Object to format</param> + <param name="arg1">An Object to format</param> + <remarks> + <para> + The message is formatted using the <c>String.Format</c> method. See + <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object,System.Exception)"/> + methods instead. + </para> + </remarks> + <seealso cref="M:log4net.ILog.Info(System.Object)"/> + <seealso cref="P:log4net.ILog.IsInfoEnabled"/> + </member> + <member name="M:log4net.Util.ILogExtensions.InfoFormatExt(log4net.ILog,System.String,System.Object,System.Object,System.Object)"> + <summary> + Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level. + </summary> + <param name="logger">The logger on which the message is logged.</param> + <param name="format">A String containing zero or more format items</param> + <param name="arg0">An Object to format</param> + <param name="arg1">An Object to format</param> + <param name="arg2">An Object to format</param> + <remarks> + <para> + The message is formatted using the <c>String.Format</c> method. See + <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object,System.Exception)"/> + methods instead. + </para> + </remarks> + <seealso cref="M:log4net.ILog.Info(System.Object)"/> + <seealso cref="P:log4net.ILog.IsInfoEnabled"/> + </member> + <member name="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Func{System.Object})"> + <summary> + Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level. + </summary> + <param name="logger">The logger on which the message is logged.</param> + <param name="callback">The lambda expression that gets the object to log.</param> + <remarks> + <para> + This method first checks if this logger is <c>WARN</c> + enabled by reading the value <seealso cref="P:log4net.ILog.IsWarnEnabled"/> property. + This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/> + implementation. If this logger is <c>WARN</c> enabled, then it converts + the message object (retrieved by invocation of the provided callback) to a + string by invoking the appropriate <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. + It then proceeds to call all the registered appenders in this logger + and also higher in the hierarchy depending on the value of + the additivity flag. + </para> + <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/> + to this method will print the name of the <see cref="T:System.Exception"/> + but no stack trace. To print a stack trace use the + <see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Func{System.Object},System.Exception)"/> form instead. + </para> + </remarks> + <seealso cref="M:log4net.ILog.Warn(System.Object)"/> + <seealso cref="P:log4net.ILog.IsWarnEnabled"/> + </member> + <member name="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Func{System.Object},System.Exception)"> + <summary> + Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level including + the stack trace of the <see cref="T:System.Exception"/> passed + as a parameter. + </summary> + <param name="logger">The logger on which the message is logged.</param> + <param name="callback">The lambda expression that gets the object to log.</param> + <param name="exception">The exception to log, including its stack trace.</param> + <remarks> + <para> + See the <see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object)"/> form for more detailed information. + </para> + </remarks> + <seealso cref="M:log4net.ILog.Warn(System.Object)"/> + <seealso cref="P:log4net.ILog.IsWarnEnabled"/> + </member> + <member name="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object)"> + <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level.</overloads> //TODO + <summary> + Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level. + </summary> + <param name="logger">The logger on which the message is logged.</param> + <param name="message">The message object to log.</param> + <remarks> + <para> + This method first checks if this logger is <c>WARN</c> + enabled by reading the value <seealso cref="P:log4net.ILog.IsWarnEnabled"/> property. + This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/> + implementation. If this logger is <c>WARN</c> enabled, then it converts + the message object (passed as parameter) to a string by invoking the appropriate + <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then + proceeds to call all the registered appenders in this logger + and also higher in the hierarchy depending on the value of + the additivity flag. + </para> + <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/> + to this method will print the name of the <see cref="T:System.Exception"/> + but no stack trace. To print a stack trace use the + <see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object,System.Exception)"/> form instead. + </para> + </remarks> + <seealso cref="M:log4net.ILog.Warn(System.Object)"/> + <seealso cref="P:log4net.ILog.IsWarnEnabled"/> + </member> + <member name="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object,System.Exception)"> + <summary> + Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level including + the stack trace of the <see cref="T:System.Exception"/> passed + as a parameter. + </summary> + <param name="logger">The logger on which the message is logged.</param> + <param name="message">The message object to log.</param> + <param name="exception">The exception to log, including its stack trace.</param> + <remarks> + <para> + See the <see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object)"/> form for more detailed information. + </para> + </remarks> + <seealso cref="M:log4net.ILog.Warn(System.Object)"/> + <seealso cref="P:log4net.ILog.IsWarnEnabled"/> + </member> + <member name="M:log4net.Util.ILogExtensions.WarnFormatExt(log4net.ILog,System.String,System.Object)"> + <summary> + Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level. + </summary> + <param name="logger">The logger on which the message is logged.</param> + <param name="format">A String containing zero or more format items</param> + <param name="arg0">An Object to format</param> + <remarks> + <para> + The message is formatted using the <c>String.Format</c> method. See + <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object,System.Exception)"/> + methods instead. + </para> + </remarks> + <seealso cref="M:log4net.ILog.Warn(System.Object)"/> + <seealso cref="P:log4net.ILog.IsWarnEnabled"/> + </member> + <member name="M:log4net.Util.ILogExtensions.WarnFormatExt(log4net.ILog,System.String,System.Object[])"> + <summary> + Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level. + </summary> + <param name="logger">The logger on which the message is logged.</param> + <param name="format">A String containing zero or more format items</param> + <param name="args">An Object array containing zero or more objects to format</param> + <remarks> + <para> + The message is formatted using the <c>String.Format</c> method. See + <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object,System.Exception)"/> + methods instead. + </para> + </remarks> + <seealso cref="M:log4net.ILog.Warn(System.Object)"/> + <seealso cref="P:log4net.ILog.IsWarnEnabled"/> + </member> + <member name="M:log4net.Util.ILogExtensions.WarnFormatExt(log4net.ILog,System.IFormatProvider,System.String,System.Object[])"> + <summary> + Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level. + </summary> + <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param> + <param name="logger">The logger on which the message is logged.</param> + <param name="format">A String containing zero or more format items</param> + <param name="args">An Object array containing zero or more objects to format</param> + <remarks> + <para> + The message is formatted using the <c>String.Format</c> method. See + <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object,System.Exception)"/> + methods instead. + </para> + </remarks> + <seealso cref="M:log4net.ILog.Warn(System.Object)"/> + <seealso cref="P:log4net.ILog.IsWarnEnabled"/> + </member> + <member name="M:log4net.Util.ILogExtensions.WarnFormatExt(log4net.ILog,System.String,System.Object,System.Object)"> + <summary> + Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level. + </summary> + <param name="logger">The logger on which the message is logged.</param> + <param name="format">A String containing zero or more format items</param> + <param name="arg0">An Object to format</param> + <param name="arg1">An Object to format</param> + <remarks> + <para> + The message is formatted using the <c>String.Format</c> method. See + <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object,System.Exception)"/> + methods instead. + </para> + </remarks> + <seealso cref="M:log4net.ILog.Warn(System.Object)"/> + <seealso cref="P:log4net.ILog.IsWarnEnabled"/> + </member> + <member name="M:log4net.Util.ILogExtensions.WarnFormatExt(log4net.ILog,System.String,System.Object,System.Object,System.Object)"> + <summary> + Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level. + </summary> + <param name="logger">The logger on which the message is logged.</param> + <param name="format">A String containing zero or more format items</param> + <param name="arg0">An Object to format</param> + <param name="arg1">An Object to format</param> + <param name="arg2">An Object to format</param> + <remarks> + <para> + The message is formatted using the <c>String.Format</c> method. See + <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object,System.Exception)"/> + methods instead. + </para> + </remarks> + <seealso cref="M:log4net.ILog.Warn(System.Object)"/> + <seealso cref="P:log4net.ILog.IsWarnEnabled"/> + </member> + <member name="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Func{System.Object})"> + <summary> + Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level. + </summary> + <param name="logger">The logger on which the message is logged.</param> + <param name="callback">The lambda expression that gets the object to log.</param> + <remarks> + <para> + This method first checks if this logger is <c>ERROR</c> + enabled by reading the value <seealso cref="P:log4net.ILog.IsErrorEnabled"/> property. + This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/> + implementation. If this logger is <c>ERROR</c> enabled, then it converts + the message object (retrieved by invocation of the provided callback) to a + string by invoking the appropriate <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. + It then proceeds to call all the registered appenders in this logger + and also higher in the hierarchy depending on the value of + the additivity flag. + </para> + <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/> + to this method will print the name of the <see cref="T:System.Exception"/> + but no stack trace. To print a stack trace use the + <see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Func{System.Object},System.Exception)"/> form instead. + </para> + </remarks> + <seealso cref="M:log4net.ILog.Error(System.Object)"/> + <seealso cref="P:log4net.ILog.IsErrorEnabled"/> + </member> + <member name="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Func{System.Object},System.Exception)"> + <summary> + Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level including + the stack trace of the <see cref="T:System.Exception"/> passed + as a parameter. + </summary> + <param name="logger">The logger on which the message is logged.</param> + <param name="callback">The lambda expression that gets the object to log.</param> + <param name="exception">The exception to log, including its stack trace.</param> + <remarks> + <para> + See the <see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object)"/> form for more detailed information. + </para> + </remarks> + <seealso cref="M:log4net.ILog.Error(System.Object)"/> + <seealso cref="P:log4net.ILog.IsErrorEnabled"/> + </member> + <member name="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object)"> + <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level.</overloads> //TODO + <summary> + Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level. + </summary> + <param name="logger">The logger on which the message is logged.</param> + <param name="message">The message object to log.</param> + <remarks> + <para> + This method first checks if this logger is <c>ERROR</c> + enabled by reading the value <seealso cref="P:log4net.ILog.IsErrorEnabled"/> property. + This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/> + implementation. If this logger is <c>ERROR</c> enabled, then it converts + the message object (passed as parameter) to a string by invoking the appropriate + <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then + proceeds to call all the registered appenders in this logger + and also higher in the hierarchy depending on the value of + the additivity flag. + </para> + <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/> + to this method will print the name of the <see cref="T:System.Exception"/> + but no stack trace. To print a stack trace use the + <see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object,System.Exception)"/> form instead. + </para> + </remarks> + <seealso cref="M:log4net.ILog.Error(System.Object)"/> + <seealso cref="P:log4net.ILog.IsErrorEnabled"/> + </member> + <member name="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object,System.Exception)"> + <summary> + Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level including + the stack trace of the <see cref="T:System.Exception"/> passed + as a parameter. + </summary> + <param name="logger">The logger on which the message is logged.</param> + <param name="message">The message object to log.</param> + <param name="exception">The exception to log, including its stack trace.</param> + <remarks> + <para> + See the <see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object)"/> form for more detailed information. + </para> + </remarks> + <seealso cref="M:log4net.ILog.Error(System.Object)"/> + <seealso cref="P:log4net.ILog.IsErrorEnabled"/> + </member> + <member name="M:log4net.Util.ILogExtensions.ErrorFormatExt(log4net.ILog,System.String,System.Object)"> + <summary> + Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level. + </summary> + <param name="logger">The logger on which the message is logged.</param> + <param name="format">A String containing zero or more format items</param> + <param name="arg0">An Object to format</param> + <remarks> + <para> + The message is formatted using the <c>String.Format</c> method. See + <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object,System.Exception)"/> + methods instead. + </para> + </remarks> + <seealso cref="M:log4net.ILog.Error(System.Object)"/> + <seealso cref="P:log4net.ILog.IsErrorEnabled"/> + </member> + <member name="M:log4net.Util.ILogExtensions.ErrorFormatExt(log4net.ILog,System.String,System.Object[])"> + <summary> + Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level. + </summary> + <param name="logger">The logger on which the message is logged.</param> + <param name="format">A String containing zero or more format items</param> + <param name="args">An Object array containing zero or more objects to format</param> + <remarks> + <para> + The message is formatted using the <c>String.Format</c> method. See + <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object,System.Exception)"/> + methods instead. + </para> + </remarks> + <seealso cref="M:log4net.ILog.Error(System.Object)"/> + <seealso cref="P:log4net.ILog.IsErrorEnabled"/> + </member> + <member name="M:log4net.Util.ILogExtensions.ErrorFormatExt(log4net.ILog,System.IFormatProvider,System.String,System.Object[])"> + <summary> + Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level. + </summary> + <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param> + <param name="logger">The logger on which the message is logged.</param> + <param name="format">A String containing zero or more format items</param> + <param name="args">An Object array containing zero or more objects to format</param> + <remarks> + <para> + The message is formatted using the <c>String.Format</c> method. See + <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object,System.Exception)"/> + methods instead. + </para> + </remarks> + <seealso cref="M:log4net.ILog.Error(System.Object)"/> + <seealso cref="P:log4net.ILog.IsErrorEnabled"/> + </member> + <member name="M:log4net.Util.ILogExtensions.ErrorFormatExt(log4net.ILog,System.String,System.Object,System.Object)"> + <summary> + Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level. + </summary> + <param name="logger">The logger on which the message is logged.</param> + <param name="format">A String containing zero or more format items</param> + <param name="arg0">An Object to format</param> + <param name="arg1">An Object to format</param> + <remarks> + <para> + The message is formatted using the <c>String.Format</c> method. See + <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object,System.Exception)"/> + methods instead. + </para> + </remarks> + <seealso cref="M:log4net.ILog.Error(System.Object)"/> + <seealso cref="P:log4net.ILog.IsErrorEnabled"/> + </member> + <member name="M:log4net.Util.ILogExtensions.ErrorFormatExt(log4net.ILog,System.String,System.Object,System.Object,System.Object)"> + <summary> + Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level. + </summary> + <param name="logger">The logger on which the message is logged.</param> + <param name="format">A String containing zero or more format items</param> + <param name="arg0">An Object to format</param> + <param name="arg1">An Object to format</param> + <param name="arg2">An Object to format</param> + <remarks> + <para> + The message is formatted using the <c>String.Format</c> method. See + <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object,System.Exception)"/> + methods instead. + </para> + </remarks> + <seealso cref="M:log4net.ILog.Error(System.Object)"/> + <seealso cref="P:log4net.ILog.IsErrorEnabled"/> + </member> + <member name="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Func{System.Object})"> + <summary> + Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level. + </summary> + <param name="logger">The logger on which the message is logged.</param> + <param name="callback">The lambda expression that gets the object to log.</param> + <remarks> + <para> + This method first checks if this logger is <c>FATAL</c> + enabled by reading the value <seealso cref="P:log4net.ILog.IsFatalEnabled"/> property. + This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/> + implementation. If this logger is <c>FATAL</c> enabled, then it converts + the message object (retrieved by invocation of the provided callback) to a + string by invoking the appropriate <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. + It then proceeds to call all the registered appenders in this logger + and also higher in the hierarchy depending on the value of + the additivity flag. + </para> + <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/> + to this method will print the name of the <see cref="T:System.Exception"/> + but no stack trace. To print a stack trace use the + <see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Func{System.Object},System.Exception)"/> form instead. + </para> + </remarks> + <seealso cref="M:log4net.ILog.Fatal(System.Object)"/> + <seealso cref="P:log4net.ILog.IsFatalEnabled"/> + </member> + <member name="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Func{System.Object},System.Exception)"> + <summary> + Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level including + the stack trace of the <see cref="T:System.Exception"/> passed + as a parameter. + </summary> + <param name="logger">The logger on which the message is logged.</param> + <param name="callback">The lambda expression that gets the object to log.</param> + <param name="exception">The exception to log, including its stack trace.</param> + <remarks> + <para> + See the <see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object)"/> form for more detailed information. + </para> + </remarks> + <seealso cref="M:log4net.ILog.Fatal(System.Object)"/> + <seealso cref="P:log4net.ILog.IsFatalEnabled"/> + </member> + <member name="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object)"> + <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level.</overloads> //TODO + <summary> + Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level. + </summary> + <param name="logger">The logger on which the message is logged.</param> + <param name="message">The message object to log.</param> + <remarks> + <para> + This method first checks if this logger is <c>FATAL</c> + enabled by reading the value <seealso cref="P:log4net.ILog.IsFatalEnabled"/> property. + This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/> + implementation. If this logger is <c>FATAL</c> enabled, then it converts + the message object (passed as parameter) to a string by invoking the appropriate + <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then + proceeds to call all the registered appenders in this logger + and also higher in the hierarchy depending on the value of + the additivity flag. + </para> + <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/> + to this method will print the name of the <see cref="T:System.Exception"/> + but no stack trace. To print a stack trace use the + <see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object,System.Exception)"/> form instead. + </para> + </remarks> + <seealso cref="M:log4net.ILog.Fatal(System.Object)"/> + <seealso cref="P:log4net.ILog.IsFatalEnabled"/> + </member> + <member name="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object,System.Exception)"> + <summary> + Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level including + the stack trace of the <see cref="T:System.Exception"/> passed + as a parameter. + </summary> + <param name="logger">The logger on which the message is logged.</param> + <param name="message">The message object to log.</param> + <param name="exception">The exception to log, including its stack trace.</param> + <remarks> + <para> + See the <see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object)"/> form for more detailed information. + </para> + </remarks> + <seealso cref="M:log4net.ILog.Fatal(System.Object)"/> + <seealso cref="P:log4net.ILog.IsFatalEnabled"/> + </member> + <member name="M:log4net.Util.ILogExtensions.FatalFormatExt(log4net.ILog,System.String,System.Object)"> + <summary> + Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level. + </summary> + <param name="logger">The logger on which the message is logged.</param> + <param name="format">A String containing zero or more format items</param> + <param name="arg0">An Object to format</param> + <remarks> + <para> + The message is formatted using the <c>String.Format</c> method. See + <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object,System.Exception)"/> + methods instead. + </para> + </remarks> + <seealso cref="M:log4net.ILog.Fatal(System.Object)"/> + <seealso cref="P:log4net.ILog.IsFatalEnabled"/> + </member> + <member name="M:log4net.Util.ILogExtensions.FatalFormatExt(log4net.ILog,System.String,System.Object[])"> + <summary> + Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level. + </summary> + <param name="logger">The logger on which the message is logged.</param> + <param name="format">A String containing zero or more format items</param> + <param name="args">An Object array containing zero or more objects to format</param> + <remarks> + <para> + The message is formatted using the <c>String.Format</c> method. See + <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object,System.Exception)"/> + methods instead. + </para> + </remarks> + <seealso cref="M:log4net.ILog.Fatal(System.Object)"/> + <seealso cref="P:log4net.ILog.IsFatalEnabled"/> + </member> + <member name="M:log4net.Util.ILogExtensions.FatalFormatExt(log4net.ILog,System.IFormatProvider,System.String,System.Object[])"> + <summary> + Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level. + </summary> + <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param> + <param name="logger">The logger on which the message is logged.</param> + <param name="format">A String containing zero or more format items</param> + <param name="args">An Object array containing zero or more objects to format</param> + <remarks> + <para> + The message is formatted using the <c>String.Format</c> method. See + <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object,System.Exception)"/> + methods instead. + </para> + </remarks> + <seealso cref="M:log4net.ILog.Fatal(System.Object)"/> + <seealso cref="P:log4net.ILog.IsFatalEnabled"/> + </member> + <member name="M:log4net.Util.ILogExtensions.FatalFormatExt(log4net.ILog,System.String,System.Object,System.Object)"> + <summary> + Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level. + </summary> + <param name="logger">The logger on which the message is logged.</param> + <param name="format">A String containing zero or more format items</param> + <param name="arg0">An Object to format</param> + <param name="arg1">An Object to format</param> + <remarks> + <para> + The message is formatted using the <c>String.Format</c> method. See + <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object,System.Exception)"/> + methods instead. + </para> + </remarks> + <seealso cref="M:log4net.ILog.Fatal(System.Object)"/> + <seealso cref="P:log4net.ILog.IsFatalEnabled"/> + </member> + <member name="M:log4net.Util.ILogExtensions.FatalFormatExt(log4net.ILog,System.String,System.Object,System.Object,System.Object)"> + <summary> + Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level. + </summary> + <param name="logger">The logger on which the message is logged.</param> + <param name="format">A String containing zero or more format items</param> + <param name="arg0">An Object to format</param> + <param name="arg1">An Object to format</param> + <param name="arg2">An Object to format</param> + <remarks> + <para> + The message is formatted using the <c>String.Format</c> method. See + <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior + of the formatting. + </para> + <para> + This method does not take an <see cref="T:System.Exception"/> object to include in the + log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object,System.Exception)"/> + methods instead. + </para> + </remarks> + <seealso cref="M:log4net.ILog.Fatal(System.Object)"/> + <seealso cref="P:log4net.ILog.IsFatalEnabled"/> + </member> + <member name="T:log4net.Util.LevelMapping"> + <summary> + Manages a mapping from levels to <see cref="T:log4net.Util.LevelMappingEntry"/> + </summary> + <remarks> + <para> + Manages an ordered mapping from <see cref="T:log4net.Core.Level"/> instances + to <see cref="T:log4net.Util.LevelMappingEntry"/> subclasses. + </para> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="M:log4net.Util.LevelMapping.#ctor"> + <summary> + Default constructor + </summary> + <remarks> + <para> + Initialise a new instance of <see cref="T:log4net.Util.LevelMapping"/>. + </para> + </remarks> + </member> + <member name="M:log4net.Util.LevelMapping.Add(log4net.Util.LevelMappingEntry)"> + <summary> + Add a <see cref="T:log4net.Util.LevelMappingEntry"/> to this mapping + </summary> + <param name="entry">the entry to add</param> + <remarks> + <para> + If a <see cref="T:log4net.Util.LevelMappingEntry"/> has previously been added + for the same <see cref="T:log4net.Core.Level"/> then that entry will be + overwritten. + </para> + </remarks> + </member> + <member name="M:log4net.Util.LevelMapping.Lookup(log4net.Core.Level)"> + <summary> + Lookup the mapping for the specified level + </summary> + <param name="level">the level to lookup</param> + <returns>the <see cref="T:log4net.Util.LevelMappingEntry"/> for the level or <c>null</c> if no mapping found</returns> + <remarks> + <para> + Lookup the value for the specified level. Finds the nearest + mapping value for the level that is equal to or less than the + <paramref name="level"/> specified. + </para> + <para> + If no mapping could be found then <c>null</c> is returned. + </para> + </remarks> + </member> + <member name="M:log4net.Util.LevelMapping.ActivateOptions"> + <summary> + Initialize options + </summary> + <remarks> + <para> + Caches the sorted list of <see cref="T:log4net.Util.LevelMappingEntry"/> in an array + </para> + </remarks> + </member> + <member name="T:log4net.Util.LogicalThreadContextProperties"> + <summary> + Implementation of Properties collection for the <see cref="T:log4net.LogicalThreadContext"/> + </summary> + <remarks> + <para> + Class implements a collection of properties that is specific to each thread. + The class is not synchronized as each thread has its own <see cref="T:log4net.Util.PropertiesDictionary"/>. + </para> + <para> + This class stores its properties in a slot on the <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/> named + <c>log4net.Util.LogicalThreadContextProperties</c>. + </para> + <para> + The <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/> requires a link time + <see cref="T:System.Security.Permissions.SecurityPermission"/> for the + <see cref="F:System.Security.Permissions.SecurityPermissionFlag.Infrastructure"/>. + If the calling code does not have this permission then this context will be disabled. + It will not store any property values set on it. + </para> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="F:log4net.Util.LogicalThreadContextProperties.m_disabled"> + <summary> + Flag used to disable this context if we don't have permission to access the CallContext. + </summary> + </member> + <member name="M:log4net.Util.LogicalThreadContextProperties.#ctor"> + <summary> + Constructor + </summary> + <remarks> + <para> + Initializes a new instance of the <see cref="T:log4net.Util.LogicalThreadContextProperties"/> class. + </para> + </remarks> + </member> + <member name="M:log4net.Util.LogicalThreadContextProperties.Remove(System.String)"> + <summary> + Remove a property + </summary> + <param name="key">the key for the entry to remove</param> + <remarks> + <para> + Remove the value for the specified <paramref name="key"/> from the context. + </para> + </remarks> + </member> + <member name="M:log4net.Util.LogicalThreadContextProperties.Clear"> + <summary> + Clear all the context properties + </summary> + <remarks> + <para> + Clear all the context properties + </para> + </remarks> + </member> + <member name="M:log4net.Util.LogicalThreadContextProperties.GetProperties(System.Boolean)"> + <summary> + Get the PropertiesDictionary stored in the LocalDataStoreSlot for this thread. + </summary> + <param name="create">create the dictionary if it does not exist, otherwise return null if is does not exist</param> + <returns>the properties for this thread</returns> + <remarks> + <para> + The collection returned is only to be used on the calling thread. If the + caller needs to share the collection between different threads then the + caller must clone the collection before doings so. + </para> + </remarks> + </member> + <member name="M:log4net.Util.LogicalThreadContextProperties.GetCallContextData"> + <summary> + Gets the call context get data. + </summary> + <returns>The peroperties dictionary stored in the call context</returns> + <remarks> + The <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/> method <see cref="M:System.Runtime.Remoting.Messaging.CallContext.GetData(System.String)"/> has a + security link demand, therfore we must put the method call in a seperate method + that we can wrap in an exception handler. + </remarks> + </member> + <member name="M:log4net.Util.LogicalThreadContextProperties.SetCallContextData(log4net.Util.PropertiesDictionary)"> + <summary> + Sets the call context data. + </summary> + <param name="properties">The properties.</param> + <remarks> + The <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/> method <see cref="M:System.Runtime.Remoting.Messaging.CallContext.SetData(System.String,System.Object)"/> has a + security link demand, therfore we must put the method call in a seperate method + that we can wrap in an exception handler. + </remarks> + </member> + <member name="F:log4net.Util.LogicalThreadContextProperties.declaringType"> + <summary> + The fully qualified type of the LogicalThreadContextProperties class. + </summary> + <remarks> + Used by the internal logger to record the Type of the + log message. + </remarks> + </member> + <member name="P:log4net.Util.LogicalThreadContextProperties.Item(System.String)"> + <summary> + Gets or sets the value of a property + </summary> + <value> + The value for the property with the specified key + </value> + <remarks> + <para> + Get or set the property value for the <paramref name="key"/> specified. + </para> + </remarks> + </member> + <member name="T:log4net.Util.LogReceivedEventHandler"> + <summary> + + </summary> + <param name="source"></param> + <param name="e"></param> + </member> + <member name="T:log4net.Util.LogLog"> + <summary> + Outputs log statements from within the log4net assembly. + </summary> + <remarks> + <para> + Log4net components cannot make log4net logging calls. However, it is + sometimes useful for the user to learn about what log4net is + doing. + </para> + <para> + All log4net internal debug calls go to the standard output stream + whereas internal error messages are sent to the standard error output + stream. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Util.LogLog.ToString"> + <summary> + Formats Prefix, Source, and Message in the same format as the value + sent to Console.Out and Trace.Write. + </summary> + <returns></returns> + </member> + <member name="M:log4net.Util.LogLog.#ctor(System.Type,System.String,System.String,System.Exception)"> + <summary> + Initializes a new instance of the <see cref="T:log4net.Util.LogLog"/> class. + </summary> + <param name="source"></param> + <param name="prefix"></param> + <param name="message"></param> + <param name="exception"></param> + </member> + <member name="M:log4net.Util.LogLog.#cctor"> + <summary> + Static constructor that initializes logging by reading + settings from the application configuration file. + </summary> + <remarks> + <para> + The <c>log4net.Internal.Debug</c> application setting + controls internal debugging. This setting should be set + to <c>true</c> to enable debugging. + </para> + <para> + The <c>log4net.Internal.Quiet</c> application setting + suppresses all internal logging including error messages. + This setting should be set to <c>true</c> to enable message + suppression. + </para> + </remarks> + </member> + <member name="M:log4net.Util.LogLog.OnLogReceived(System.Type,System.String,System.String,System.Exception)"> + <summary> + Raises the LogReceived event when an internal messages is received. + </summary> + <param name="source"></param> + <param name="prefix"></param> + <param name="message"></param> + <param name="exception"></param> + </member> + <member name="M:log4net.Util.LogLog.Debug(System.Type,System.String)"> + <summary> + Writes log4net internal debug messages to the + standard output stream. + </summary> + <param name="source"></param> + <param name="message">The message to log.</param> + <remarks> + <para> + All internal debug messages are prepended with + the string "log4net: ". + </para> + </remarks> + </member> + <member name="M:log4net.Util.LogLog.Debug(System.Type,System.String,System.Exception)"> + <summary> + Writes log4net internal debug messages to the + standard output stream. + </summary> + <param name="source">The Type that generated this message.</param> + <param name="message">The message to log.</param> + <param name="exception">An exception to log.</param> + <remarks> + <para> + All internal debug messages are prepended with + the string "log4net: ". + </para> + </remarks> + </member> + <member name="M:log4net.Util.LogLog.Warn(System.Type,System.String)"> + <summary> + Writes log4net internal warning messages to the + standard error stream. + </summary> + <param name="source">The Type that generated this message.</param> + <param name="message">The message to log.</param> + <remarks> + <para> + All internal warning messages are prepended with + the string "log4net:WARN ". + </para> + </remarks> + </member> + <member name="M:log4net.Util.LogLog.Warn(System.Type,System.String,System.Exception)"> + <summary> + Writes log4net internal warning messages to the + standard error stream. + </summary> + <param name="source">The Type that generated this message.</param> + <param name="message">The message to log.</param> + <param name="exception">An exception to log.</param> + <remarks> + <para> + All internal warning messages are prepended with + the string "log4net:WARN ". + </para> + </remarks> + </member> + <member name="M:log4net.Util.LogLog.Error(System.Type,System.String)"> + <summary> + Writes log4net internal error messages to the + standard error stream. + </summary> + <param name="source">The Type that generated this message.</param> + <param name="message">The message to log.</param> + <remarks> + <para> + All internal error messages are prepended with + the string "log4net:ERROR ". + </para> + </remarks> + </member> + <member name="M:log4net.Util.LogLog.Error(System.Type,System.String,System.Exception)"> + <summary> + Writes log4net internal error messages to the + standard error stream. + </summary> + <param name="source">The Type that generated this message.</param> + <param name="message">The message to log.</param> + <param name="exception">An exception to log.</param> + <remarks> + <para> + All internal debug messages are prepended with + the string "log4net:ERROR ". + </para> + </remarks> + </member> + <member name="M:log4net.Util.LogLog.EmitOutLine(System.String)"> + <summary> + Writes output to the standard output stream. + </summary> + <param name="message">The message to log.</param> + <remarks> + <para> + Writes to both Console.Out and System.Diagnostics.Trace. + Note that the System.Diagnostics.Trace is not supported + on the Compact Framework. + </para> + <para> + If the AppDomain is not configured with a config file then + the call to System.Diagnostics.Trace may fail. This is only + an issue if you are programmatically creating your own AppDomains. + </para> + </remarks> + </member> + <member name="M:log4net.Util.LogLog.EmitErrorLine(System.String)"> + <summary> + Writes output to the standard error stream. + </summary> + <param name="message">The message to log.</param> + <remarks> + <para> + Writes to both Console.Error and System.Diagnostics.Trace. + Note that the System.Diagnostics.Trace is not supported + on the Compact Framework. + </para> + <para> + If the AppDomain is not configured with a config file then + the call to System.Diagnostics.Trace may fail. This is only + an issue if you are programmatically creating your own AppDomains. + </para> + </remarks> + </member> + <member name="F:log4net.Util.LogLog.s_debugEnabled"> + <summary> + Default debug level + </summary> + </member> + <member name="F:log4net.Util.LogLog.s_quietMode"> + <summary> + In quietMode not even errors generate any output. + </summary> + </member> + <member name="E:log4net.Util.LogLog.LogReceived"> + <summary> + The event raised when an internal message has been received. + </summary> + </member> + <member name="P:log4net.Util.LogLog.Source"> + <summary> + The Type that generated the internal message. + </summary> + </member> + <member name="P:log4net.Util.LogLog.TimeStamp"> + <summary> + The DateTime stamp of when the internal message was received. + </summary> + </member> + <member name="P:log4net.Util.LogLog.Prefix"> + <summary> + A string indicating the severity of the internal message. + </summary> + <remarks> + "log4net: ", + "log4net:ERROR ", + "log4net:WARN " + </remarks> + </member> + <member name="P:log4net.Util.LogLog.Message"> + <summary> + The internal log message. + </summary> + </member> + <member name="P:log4net.Util.LogLog.Exception"> + <summary> + The Exception related to the message. + </summary> + <remarks> + Optional. Will be null if no Exception was passed. + </remarks> + </member> + <member name="P:log4net.Util.LogLog.InternalDebugging"> + <summary> + Gets or sets a value indicating whether log4net internal logging + is enabled or disabled. + </summary> + <value> + <c>true</c> if log4net internal logging is enabled, otherwise + <c>false</c>. + </value> + <remarks> + <para> + When set to <c>true</c>, internal debug level logging will be + displayed. + </para> + <para> + This value can be set by setting the application setting + <c>log4net.Internal.Debug</c> in the application configuration + file. + </para> + <para> + The default value is <c>false</c>, i.e. debugging is + disabled. + </para> + </remarks> + <example> + <para> + The following example enables internal debugging using the + application configuration file : + </para> + <code lang="XML" escaped="true"> + <configuration> + <appSettings> + <add key="log4net.Internal.Debug" value="true" /> + </appSettings> + </configuration> + </code> + </example> + </member> + <member name="P:log4net.Util.LogLog.QuietMode"> + <summary> + Gets or sets a value indicating whether log4net should generate no output + from internal logging, not even for errors. + </summary> + <value> + <c>true</c> if log4net should generate no output at all from internal + logging, otherwise <c>false</c>. + </value> + <remarks> + <para> + When set to <c>true</c> will cause internal logging at all levels to be + suppressed. This means that no warning or error reports will be logged. + This option overrides the <see cref="P:log4net.Util.LogLog.InternalDebugging"/> setting and + disables all debug also. + </para> + <para>This value can be set by setting the application setting + <c>log4net.Internal.Quiet</c> in the application configuration file. + </para> + <para> + The default value is <c>false</c>, i.e. internal logging is not + disabled. + </para> + </remarks> + <example> + The following example disables internal logging using the + application configuration file : + <code lang="XML" escaped="true"> + <configuration> + <appSettings> + <add key="log4net.Internal.Quiet" value="true"/> + </appSettings> + </configuration> + </code> + </example> + </member> + <member name="P:log4net.Util.LogLog.EmitInternalMessages"> + <summary> + + </summary> + </member> + <member name="P:log4net.Util.LogLog.IsDebugEnabled"> + <summary> + Test if LogLog.Debug is enabled for output. + </summary> + <value> + <c>true</c> if Debug is enabled + </value> + <remarks> + <para> + Test if LogLog.Debug is enabled for output. + </para> + </remarks> + </member> + <member name="P:log4net.Util.LogLog.IsWarnEnabled"> + <summary> + Test if LogLog.Warn is enabled for output. + </summary> + <value> + <c>true</c> if Warn is enabled + </value> + <remarks> + <para> + Test if LogLog.Warn is enabled for output. + </para> + </remarks> + </member> + <member name="P:log4net.Util.LogLog.IsErrorEnabled"> + <summary> + Test if LogLog.Error is enabled for output. + </summary> + <value> + <c>true</c> if Error is enabled + </value> + <remarks> + <para> + Test if LogLog.Error is enabled for output. + </para> + </remarks> + </member> + <member name="T:log4net.Util.LogLog.LogReceivedAdapter"> + <summary> + Subscribes to the LogLog.LogReceived event and stores messages + to the supplied IList instance. + </summary> + </member> + <member name="M:log4net.Util.LogLog.LogReceivedAdapter.#ctor(System.Collections.IList)"> + <summary> + + </summary> + <param name="items"></param> + </member> + <member name="M:log4net.Util.LogLog.LogReceivedAdapter.Dispose"> + <summary> + + </summary> + </member> + <member name="P:log4net.Util.LogLog.LogReceivedAdapter.Items"> + <summary> + + </summary> + </member> + <member name="T:log4net.Util.LogReceivedEventArgs"> + <summary> + + </summary> + </member> + <member name="M:log4net.Util.LogReceivedEventArgs.#ctor(log4net.Util.LogLog)"> + <summary> + + </summary> + <param name="loglog"></param> + </member> + <member name="P:log4net.Util.LogReceivedEventArgs.LogLog"> + <summary> + + </summary> + </member> + <member name="T:log4net.Util.NativeError"> + <summary> + Represents a native error code and message. + </summary> + <remarks> + <para> + Represents a Win32 platform native error. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Util.NativeError.#ctor(System.Int32,System.String)"> + <summary> + Create an instance of the <see cref="T:log4net.Util.NativeError"/> class with the specified + error number and message. + </summary> + <param name="number">The number of the native error.</param> + <param name="message">The message of the native error.</param> + <remarks> + <para> + Create an instance of the <see cref="T:log4net.Util.NativeError"/> class with the specified + error number and message. + </para> + </remarks> + </member> + <member name="M:log4net.Util.NativeError.GetLastError"> + <summary> + Create a new instance of the <see cref="T:log4net.Util.NativeError"/> class for the last Windows error. + </summary> + <returns> + An instance of the <see cref="T:log4net.Util.NativeError"/> class for the last windows error. + </returns> + <remarks> + <para> + The message for the <see cref="M:System.Runtime.InteropServices.Marshal.GetLastWin32Error"/> error number is lookup up using the + native Win32 <c>FormatMessage</c> function. + </para> + </remarks> + </member> + <member name="M:log4net.Util.NativeError.GetError(System.Int32)"> + <summary> + Create a new instance of the <see cref="T:log4net.Util.NativeError"/> class. + </summary> + <param name="number">the error number for the native error</param> + <returns> + An instance of the <see cref="T:log4net.Util.NativeError"/> class for the specified + error number. + </returns> + <remarks> + <para> + The message for the specified error number is lookup up using the + native Win32 <c>FormatMessage</c> function. + </para> + </remarks> + </member> + <member name="M:log4net.Util.NativeError.GetErrorMessage(System.Int32)"> + <summary> + Retrieves the message corresponding with a Win32 message identifier. + </summary> + <param name="messageId">Message identifier for the requested message.</param> + <returns> + The message corresponding with the specified message identifier. + </returns> + <remarks> + <para> + The message will be searched for in system message-table resource(s) + using the native <c>FormatMessage</c> function. + </para> + </remarks> + </member> + <member name="M:log4net.Util.NativeError.ToString"> + <summary> + Return error information string + </summary> + <returns>error information string</returns> + <remarks> + <para> + Return error information string + </para> + </remarks> + </member> + <member name="M:log4net.Util.NativeError.FormatMessage(System.Int32,System.IntPtr@,System.Int32,System.Int32,System.String@,System.Int32,System.IntPtr)"> + <summary> + Formats a message string. + </summary> + <param name="dwFlags">Formatting options, and how to interpret the <paramref name="lpSource" /> parameter.</param> + <param name="lpSource">Location of the message definition.</param> + <param name="dwMessageId">Message identifier for the requested message.</param> + <param name="dwLanguageId">Language identifier for the requested message.</param> + <param name="lpBuffer">If <paramref name="dwFlags" /> includes FORMAT_MESSAGE_ALLOCATE_BUFFER, the function allocates a buffer using the <c>LocalAlloc</c> function, and places the pointer to the buffer at the address specified in <paramref name="lpBuffer" />.</param> + <param name="nSize">If the FORMAT_MESSAGE_ALLOCATE_BUFFER flag is not set, this parameter specifies the maximum number of TCHARs that can be stored in the output buffer. If FORMAT_MESSAGE_ALLOCATE_BUFFER is set, this parameter specifies the minimum number of TCHARs to allocate for an output buffer.</param> + <param name="Arguments">Pointer to an array of values that are used as insert values in the formatted message.</param> + <remarks> + <para> + The function requires a message definition as input. The message definition can come from a + buffer passed into the function. It can come from a message table resource in an + already-loaded module. Or the caller can ask the function to search the system's message + table resource(s) for the message definition. The function finds the message definition + in a message table resource based on a message identifier and a language identifier. + The function copies the formatted message text to an output buffer, processing any embedded + insert sequences if requested. + </para> + <para> + To prevent the usage of unsafe code, this stub does not support inserting values in the formatted message. + </para> + </remarks> + <returns> + <para> + If the function succeeds, the return value is the number of TCHARs stored in the output + buffer, excluding the terminating null character. + </para> + <para> + If the function fails, the return value is zero. To get extended error information, + call <see cref="M:Marshal.GetLastWin32Error()" />. + </para> + </returns> + </member> + <member name="P:log4net.Util.NativeError.Number"> + <summary> + Gets the number of the native error. + </summary> + <value> + The number of the native error. + </value> + <remarks> + <para> + Gets the number of the native error. + </para> + </remarks> + </member> + <member name="P:log4net.Util.NativeError.Message"> + <summary> + Gets the message of the native error. + </summary> + <value> + The message of the native error. + </value> + <remarks> + <para> + </para> + Gets the message of the native error. + </remarks> + </member> + <member name="T:log4net.Util.NullDictionaryEnumerator"> + <summary> + An always empty <see cref="T:System.Collections.IDictionaryEnumerator"/>. + </summary> + <remarks> + <para> + A singleton implementation of the <see cref="T:System.Collections.IDictionaryEnumerator"/> over a collection + that is empty and not modifiable. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Util.NullDictionaryEnumerator.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:log4net.Util.NullDictionaryEnumerator"/> class. + </summary> + <remarks> + <para> + Uses a private access modifier to enforce the singleton pattern. + </para> + </remarks> + </member> + <member name="M:log4net.Util.NullDictionaryEnumerator.MoveNext"> + <summary> + Test if the enumerator can advance, if so advance. + </summary> + <returns><c>false</c> as the <see cref="T:log4net.Util.NullDictionaryEnumerator"/> cannot advance.</returns> + <remarks> + <para> + As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/> + value cannot be moved over a valid position, therefore <see cref="M:log4net.Util.NullDictionaryEnumerator.MoveNext"/> + will always return <c>false</c>. + </para> + </remarks> + </member> + <member name="M:log4net.Util.NullDictionaryEnumerator.Reset"> + <summary> + Resets the enumerator back to the start. + </summary> + <remarks> + <para> + As the enumerator is over an empty collection <see cref="M:log4net.Util.NullDictionaryEnumerator.Reset"/> does nothing. + </para> + </remarks> + </member> + <member name="F:log4net.Util.NullDictionaryEnumerator.s_instance"> + <summary> + The singleton instance of the <see cref="T:log4net.Util.NullDictionaryEnumerator"/>. + </summary> + </member> + <member name="P:log4net.Util.NullDictionaryEnumerator.Instance"> + <summary> + Gets the singleton instance of the <see cref="T:log4net.Util.NullDictionaryEnumerator"/>. + </summary> + <returns>The singleton instance of the <see cref="T:log4net.Util.NullDictionaryEnumerator"/>.</returns> + <remarks> + <para> + Gets the singleton instance of the <see cref="T:log4net.Util.NullDictionaryEnumerator"/>. + </para> + </remarks> + </member> + <member name="P:log4net.Util.NullDictionaryEnumerator.Current"> + <summary> + Gets the current object from the enumerator. + </summary> + <remarks> + Throws an <see cref="T:System.InvalidOperationException"/> because the + <see cref="T:log4net.Util.NullDictionaryEnumerator"/> never has a current value. + </remarks> + <remarks> + <para> + As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/> + value cannot be moved over a valid position, therefore <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/> + will throw an <see cref="T:System.InvalidOperationException"/>. + </para> + </remarks> + <exception cref="T:System.InvalidOperationException">The collection is empty and <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/> + cannot be positioned over a valid location.</exception> + </member> + <member name="P:log4net.Util.NullDictionaryEnumerator.Key"> + <summary> + Gets the current key from the enumerator. + </summary> + <remarks> + Throws an exception because the <see cref="T:log4net.Util.NullDictionaryEnumerator"/> + never has a current value. + </remarks> + <remarks> + <para> + As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/> + value cannot be moved over a valid position, therefore <see cref="P:log4net.Util.NullDictionaryEnumerator.Key"/> + will throw an <see cref="T:System.InvalidOperationException"/>. + </para> + </remarks> + <exception cref="T:System.InvalidOperationException">The collection is empty and <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/> + cannot be positioned over a valid location.</exception> + </member> + <member name="P:log4net.Util.NullDictionaryEnumerator.Value"> + <summary> + Gets the current value from the enumerator. + </summary> + <value>The current value from the enumerator.</value> + <remarks> + Throws an <see cref="T:System.InvalidOperationException"/> because the + <see cref="T:log4net.Util.NullDictionaryEnumerator"/> never has a current value. + </remarks> + <remarks> + <para> + As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/> + value cannot be moved over a valid position, therefore <see cref="P:log4net.Util.NullDictionaryEnumerator.Value"/> + will throw an <see cref="T:System.InvalidOperationException"/>. + </para> + </remarks> + <exception cref="T:System.InvalidOperationException">The collection is empty and <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/> + cannot be positioned over a valid location.</exception> + </member> + <member name="P:log4net.Util.NullDictionaryEnumerator.Entry"> + <summary> + Gets the current entry from the enumerator. + </summary> + <remarks> + Throws an <see cref="T:System.InvalidOperationException"/> because the + <see cref="T:log4net.Util.NullDictionaryEnumerator"/> never has a current entry. + </remarks> + <remarks> + <para> + As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/> + value cannot be moved over a valid position, therefore <see cref="P:log4net.Util.NullDictionaryEnumerator.Entry"/> + will throw an <see cref="T:System.InvalidOperationException"/>. + </para> + </remarks> + <exception cref="T:System.InvalidOperationException">The collection is empty and <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/> + cannot be positioned over a valid location.</exception> + </member> + <member name="T:log4net.Util.NullEnumerator"> + <summary> + An always empty <see cref="T:System.Collections.IEnumerator"/>. + </summary> + <remarks> + <para> + A singleton implementation of the <see cref="T:System.Collections.IEnumerator"/> over a collection + that is empty and not modifiable. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Util.NullEnumerator.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:log4net.Util.NullEnumerator"/> class. + </summary> + <remarks> + <para> + Uses a private access modifier to enforce the singleton pattern. + </para> + </remarks> + </member> + <member name="M:log4net.Util.NullEnumerator.MoveNext"> + <summary> + Test if the enumerator can advance, if so advance + </summary> + <returns><c>false</c> as the <see cref="T:log4net.Util.NullEnumerator"/> cannot advance.</returns> + <remarks> + <para> + As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullEnumerator.Current"/> + value cannot be moved over a valid position, therefore <see cref="M:log4net.Util.NullEnumerator.MoveNext"/> + will always return <c>false</c>. + </para> + </remarks> + </member> + <member name="M:log4net.Util.NullEnumerator.Reset"> + <summary> + Resets the enumerator back to the start. + </summary> + <remarks> + <para> + As the enumerator is over an empty collection <see cref="M:log4net.Util.NullEnumerator.Reset"/> does nothing. + </para> + </remarks> + </member> + <member name="F:log4net.Util.NullEnumerator.s_instance"> + <summary> + The singleton instance of the <see cref="T:log4net.Util.NullEnumerator"/>. + </summary> + </member> + <member name="P:log4net.Util.NullEnumerator.Instance"> + <summary> + Get the singleton instance of the <see cref="T:log4net.Util.NullEnumerator"/>. + </summary> + <returns>The singleton instance of the <see cref="T:log4net.Util.NullEnumerator"/>.</returns> + <remarks> + <para> + Gets the singleton instance of the <see cref="T:log4net.Util.NullEnumerator"/>. + </para> + </remarks> + </member> + <member name="P:log4net.Util.NullEnumerator.Current"> + <summary> + Gets the current object from the enumerator. + </summary> + <remarks> + Throws an <see cref="T:System.InvalidOperationException"/> because the + <see cref="T:log4net.Util.NullDictionaryEnumerator"/> never has a current value. + </remarks> + <remarks> + <para> + As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullEnumerator.Current"/> + value cannot be moved over a valid position, therefore <see cref="P:log4net.Util.NullEnumerator.Current"/> + will throw an <see cref="T:System.InvalidOperationException"/>. + </para> + </remarks> + <exception cref="T:System.InvalidOperationException">The collection is empty and <see cref="P:log4net.Util.NullEnumerator.Current"/> + cannot be positioned over a valid location.</exception> + </member> + <member name="T:log4net.Util.NullSecurityContext"> + <summary> + A SecurityContext used when a SecurityContext is not required + </summary> + <remarks> + <para> + The <see cref="T:log4net.Util.NullSecurityContext"/> is a no-op implementation of the + <see cref="T:log4net.Core.SecurityContext"/> base class. It is used where a <see cref="T:log4net.Core.SecurityContext"/> + is required but one has not been provided. + </para> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="F:log4net.Util.NullSecurityContext.Instance"> + <summary> + Singleton instance of <see cref="T:log4net.Util.NullSecurityContext"/> + </summary> + <remarks> + <para> + Singleton instance of <see cref="T:log4net.Util.NullSecurityContext"/> + </para> + </remarks> + </member> + <member name="M:log4net.Util.NullSecurityContext.#ctor"> + <summary> + Private constructor + </summary> + <remarks> + <para> + Private constructor for singleton pattern. + </para> + </remarks> + </member> + <member name="M:log4net.Util.NullSecurityContext.Impersonate(System.Object)"> + <summary> + Impersonate this SecurityContext + </summary> + <param name="state">State supplied by the caller</param> + <returns><c>null</c></returns> + <remarks> + <para> + No impersonation is done and <c>null</c> is always returned. + </para> + </remarks> + </member> + <member name="T:log4net.Util.OnlyOnceErrorHandler"> + <summary> + Implements log4net's default error handling policy which consists + of emitting a message for the first error in an appender and + ignoring all subsequent errors. + </summary> + <remarks> + <para> + The error message is processed using the LogLog sub-system by default. + </para> + <para> + This policy aims at protecting an otherwise working application + from being flooded with error messages when logging fails. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + <author>Ron Grabowski</author> + </member> + <member name="M:log4net.Util.OnlyOnceErrorHandler.#ctor"> + <summary> + Default Constructor + </summary> + <remarks> + <para> + Initializes a new instance of the <see cref="T:log4net.Util.OnlyOnceErrorHandler"/> class. + </para> + </remarks> + </member> + <member name="M:log4net.Util.OnlyOnceErrorHandler.#ctor(System.String)"> + <summary> + Constructor + </summary> + <param name="prefix">The prefix to use for each message.</param> + <remarks> + <para> + Initializes a new instance of the <see cref="T:log4net.Util.OnlyOnceErrorHandler"/> class + with the specified prefix. + </para> + </remarks> + </member> + <member name="M:log4net.Util.OnlyOnceErrorHandler.Reset"> + <summary> + Reset the error handler back to its initial disabled state. + </summary> + </member> + <member name="M:log4net.Util.OnlyOnceErrorHandler.Error(System.String,System.Exception,log4net.Core.ErrorCode)"> + <summary> + Log an Error + </summary> + <param name="message">The error message.</param> + <param name="e">The exception.</param> + <param name="errorCode">The internal error code.</param> + <remarks> + <para> + Invokes <see cref="M:log4net.Util.OnlyOnceErrorHandler.FirstError(System.String,System.Exception,log4net.Core.ErrorCode)"/> if and only if this is the first error or the first error after <see cref="M:log4net.Util.OnlyOnceErrorHandler.Reset"/> has been called. + </para> + </remarks> + </member> + <member name="M:log4net.Util.OnlyOnceErrorHandler.FirstError(System.String,System.Exception,log4net.Core.ErrorCode)"> + <summary> + Log the very first error + </summary> + <param name="message">The error message.</param> + <param name="e">The exception.</param> + <param name="errorCode">The internal error code.</param> + <remarks> + <para> + Sends the error information to <see cref="T:log4net.Util.LogLog"/>'s Error method. + </para> + </remarks> + </member> + <member name="M:log4net.Util.OnlyOnceErrorHandler.Error(System.String,System.Exception)"> + <summary> + Log an Error + </summary> + <param name="message">The error message.</param> + <param name="e">The exception.</param> + <remarks> + <para> + Invokes <see cref="M:log4net.Util.OnlyOnceErrorHandler.FirstError(System.String,System.Exception,log4net.Core.ErrorCode)"/> if and only if this is the first error or the first error after <see cref="M:log4net.Util.OnlyOnceErrorHandler.Reset"/> has been called. + </para> + </remarks> + </member> + <member name="M:log4net.Util.OnlyOnceErrorHandler.Error(System.String)"> + <summary> + Log an error + </summary> + <param name="message">The error message.</param> + <remarks> + <para> + Invokes <see cref="M:log4net.Util.OnlyOnceErrorHandler.FirstError(System.String,System.Exception,log4net.Core.ErrorCode)"/> if and only if this is the first error or the first error after <see cref="M:log4net.Util.OnlyOnceErrorHandler.Reset"/> has been called. + </para> + </remarks> + </member> + <member name="F:log4net.Util.OnlyOnceErrorHandler.m_enabledDate"> + <summary> + The date the error was recorded. + </summary> + </member> + <member name="F:log4net.Util.OnlyOnceErrorHandler.m_firstTime"> + <summary> + Flag to indicate if it is the first error + </summary> + </member> + <member name="F:log4net.Util.OnlyOnceErrorHandler.m_message"> + <summary> + The message recorded during the first error. + </summary> + </member> + <member name="F:log4net.Util.OnlyOnceErrorHandler.m_exception"> + <summary> + The exception recorded during the first error. + </summary> + </member> + <member name="F:log4net.Util.OnlyOnceErrorHandler.m_errorCode"> + <summary> + The error code recorded during the first error. + </summary> + </member> + <member name="F:log4net.Util.OnlyOnceErrorHandler.m_prefix"> + <summary> + String to prefix each message with + </summary> + </member> + <member name="F:log4net.Util.OnlyOnceErrorHandler.declaringType"> + <summary> + The fully qualified type of the OnlyOnceErrorHandler class. + </summary> + <remarks> + Used by the internal logger to record the Type of the + log message. + </remarks> + </member> + <member name="P:log4net.Util.OnlyOnceErrorHandler.IsEnabled"> + <summary> + Is error logging enabled + </summary> + <remarks> + <para> + Is error logging enabled. Logging is only enabled for the + first error delivered to the <see cref="T:log4net.Util.OnlyOnceErrorHandler"/>. + </para> + </remarks> + </member> + <member name="P:log4net.Util.OnlyOnceErrorHandler.EnabledDate"> + <summary> + The date the first error that trigged this error handler occured. + </summary> + </member> + <member name="P:log4net.Util.OnlyOnceErrorHandler.ErrorMessage"> + <summary> + The message from the first error that trigged this error handler. + </summary> + </member> + <member name="P:log4net.Util.OnlyOnceErrorHandler.Exception"> + <summary> + The exception from the first error that trigged this error handler. + </summary> + <remarks> + May be <see langword="null" />. + </remarks> + </member> + <member name="P:log4net.Util.OnlyOnceErrorHandler.ErrorCode"> + <summary> + The error code from the first error that trigged this error handler. + </summary> + <remarks> + Defaults to <see cref="F:log4net.Core.ErrorCode.GenericFailure"/> + </remarks> + </member> + <member name="T:log4net.Util.OptionConverter"> + <summary> + A convenience class to convert property values to specific types. + </summary> + <remarks> + <para> + Utility functions for converting types and parsing values. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Util.OptionConverter.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:log4net.Util.OptionConverter"/> class. + </summary> + <remarks> + <para> + Uses a private access modifier to prevent instantiation of this class. + </para> + </remarks> + </member> + <member name="M:log4net.Util.OptionConverter.ToBoolean(System.String,System.Boolean)"> + <summary> + Converts a string to a <see cref="T:System.Boolean"/> value. + </summary> + <param name="argValue">String to convert.</param> + <param name="defaultValue">The default value.</param> + <returns>The <see cref="T:System.Boolean"/> value of <paramref name="argValue"/>.</returns> + <remarks> + <para> + If <paramref name="argValue"/> is "true", then <c>true</c> is returned. + If <paramref name="argValue"/> is "false", then <c>false</c> is returned. + Otherwise, <paramref name="defaultValue"/> is returned. + </para> + </remarks> + </member> + <member name="M:log4net.Util.OptionConverter.ToFileSize(System.String,System.Int64)"> + <summary> + Parses a file size into a number. + </summary> + <param name="argValue">String to parse.</param> + <param name="defaultValue">The default value.</param> + <returns>The <see cref="T:System.Int64"/> value of <paramref name="argValue"/>.</returns> + <remarks> + <para> + Parses a file size of the form: number[KB|MB|GB] into a + long value. It is scaled with the appropriate multiplier. + </para> + <para> + <paramref name="defaultValue"/> is returned when <paramref name="argValue"/> + cannot be converted to a <see cref="T:System.Int64"/> value. + </para> + </remarks> + </member> + <member name="M:log4net.Util.OptionConverter.ConvertStringTo(System.Type,System.String)"> + <summary> + Converts a string to an object. + </summary> + <param name="target">The target type to convert to.</param> + <param name="txt">The string to convert to an object.</param> + <returns> + The object converted from a string or <c>null</c> when the + conversion failed. + </returns> + <remarks> + <para> + Converts a string to an object. Uses the converter registry to try + to convert the string value into the specified target type. + </para> + </remarks> + </member> + <member name="M:log4net.Util.OptionConverter.CanConvertTypeTo(System.Type,System.Type)"> + <summary> + Checks if there is an appropriate type conversion from the source type to the target type. + </summary> + <param name="sourceType">The type to convert from.</param> + <param name="targetType">The type to convert to.</param> + <returns><c>true</c> if there is a conversion from the source type to the target type.</returns> + <remarks> + Checks if there is an appropriate type conversion from the source type to the target type. + <para> + </para> + </remarks> + </member> + <member name="M:log4net.Util.OptionConverter.ConvertTypeTo(System.Object,System.Type)"> + <summary> + Converts an object to the target type. + </summary> + <param name="sourceInstance">The object to convert to the target type.</param> + <param name="targetType">The type to convert to.</param> + <returns>The converted object.</returns> + <remarks> + <para> + Converts an object to the target type. + </para> + </remarks> + </member> + <member name="M:log4net.Util.OptionConverter.InstantiateByClassName(System.String,System.Type,System.Object)"> + <summary> + Instantiates an object given a class name. + </summary> + <param name="className">The fully qualified class name of the object to instantiate.</param> + <param name="superClass">The class to which the new object should belong.</param> + <param name="defaultValue">The object to return in case of non-fulfillment.</param> + <returns> + An instance of the <paramref name="className"/> or <paramref name="defaultValue"/> + if the object could not be instantiated. + </returns> + <remarks> + <para> + Checks that the <paramref name="className"/> is a subclass of + <paramref name="superClass"/>. If that test fails or the object could + not be instantiated, then <paramref name="defaultValue"/> is returned. + </para> + </remarks> + </member> + <member name="M:log4net.Util.OptionConverter.SubstituteVariables(System.String,System.Collections.IDictionary)"> + <summary> + Performs variable substitution in string <paramref name="value"/> from the + values of keys found in <paramref name="props"/>. + </summary> + <param name="value">The string on which variable substitution is performed.</param> + <param name="props">The dictionary to use to lookup variables.</param> + <returns>The result of the substitutions.</returns> + <remarks> + <para> + The variable substitution delimiters are <b>${</b> and <b>}</b>. + </para> + <para> + For example, if props contains <c>key=value</c>, then the call + </para> + <para> + <code lang="C#"> + string s = OptionConverter.SubstituteVariables("Value of key is ${key}."); + </code> + </para> + <para> + will set the variable <c>s</c> to "Value of key is value.". + </para> + <para> + If no value could be found for the specified key, then substitution + defaults to an empty string. + </para> + <para> + For example, if system properties contains no value for the key + "nonExistentKey", then the call + </para> + <para> + <code lang="C#"> + string s = OptionConverter.SubstituteVariables("Value of nonExistentKey is [${nonExistentKey}]"); + </code> + </para> + <para> + will set <s>s</s> to "Value of nonExistentKey is []". + </para> + <para> + An Exception is thrown if <paramref name="value"/> contains a start + delimiter "${" which is not balanced by a stop delimiter "}". + </para> + </remarks> + </member> + <member name="M:log4net.Util.OptionConverter.ParseEnum(System.Type,System.String,System.Boolean)"> + <summary> + Converts the string representation of the name or numeric value of one or + more enumerated constants to an equivalent enumerated object. + </summary> + <param name="enumType">The type to convert to.</param> + <param name="value">The enum string value.</param> + <param name="ignoreCase">If <c>true</c>, ignore case; otherwise, regard case.</param> + <returns>An object of type <paramref name="enumType" /> whose value is represented by <paramref name="value" />.</returns> + </member> + <member name="F:log4net.Util.OptionConverter.declaringType"> + <summary> + The fully qualified type of the OptionConverter class. + </summary> + <remarks> + Used by the internal logger to record the Type of the + log message. + </remarks> + </member> + <member name="T:log4net.Util.PatternParser"> + <summary> + Most of the work of the <see cref="T:log4net.Layout.PatternLayout"/> class + is delegated to the PatternParser class. + </summary> + <remarks> + <para> + The <c>PatternParser</c> processes a pattern string and + returns a chain of <see cref="T:log4net.Util.PatternConverter"/> objects. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Util.PatternParser.#ctor(System.String)"> + <summary> + Constructor + </summary> + <param name="pattern">The pattern to parse.</param> + <remarks> + <para> + Initializes a new instance of the <see cref="T:log4net.Util.PatternParser"/> class + with the specified pattern string. + </para> + </remarks> + </member> + <member name="M:log4net.Util.PatternParser.Parse"> + <summary> + Parses the pattern into a chain of pattern converters. + </summary> + <returns>The head of a chain of pattern converters.</returns> + <remarks> + <para> + Parses the pattern into a chain of pattern converters. + </para> + </remarks> + </member> + <member name="M:log4net.Util.PatternParser.BuildCache"> + <summary> + Build the unified cache of converters from the static and instance maps + </summary> + <returns>the list of all the converter names</returns> + <remarks> + <para> + Build the unified cache of converters from the static and instance maps + </para> + </remarks> + </member> + <member name="M:log4net.Util.PatternParser.ParseInternal(System.String,System.String[])"> + <summary> + Internal method to parse the specified pattern to find specified matches + </summary> + <param name="pattern">the pattern to parse</param> + <param name="matches">the converter names to match in the pattern</param> + <remarks> + <para> + The matches param must be sorted such that longer strings come before shorter ones. + </para> + </remarks> + </member> + <member name="M:log4net.Util.PatternParser.ProcessLiteral(System.String)"> + <summary> + Process a parsed literal + </summary> + <param name="text">the literal text</param> + </member> + <member name="M:log4net.Util.PatternParser.ProcessConverter(System.String,System.String,log4net.Util.FormattingInfo)"> + <summary> + Process a parsed converter pattern + </summary> + <param name="converterName">the name of the converter</param> + <param name="option">the optional option for the converter</param> + <param name="formattingInfo">the formatting info for the converter</param> + </member> + <member name="M:log4net.Util.PatternParser.AddConverter(log4net.Util.PatternConverter)"> + <summary> + Resets the internal state of the parser and adds the specified pattern converter + to the chain. + </summary> + <param name="pc">The pattern converter to add.</param> + </member> + <member name="F:log4net.Util.PatternParser.m_head"> + <summary> + The first pattern converter in the chain + </summary> + </member> + <member name="F:log4net.Util.PatternParser.m_tail"> + <summary> + the last pattern converter in the chain + </summary> + </member> + <member name="F:log4net.Util.PatternParser.m_pattern"> + <summary> + The pattern + </summary> + </member> + <member name="F:log4net.Util.PatternParser.m_patternConverters"> + <summary> + Internal map of converter identifiers to converter types + </summary> + <remarks> + <para> + This map overrides the static s_globalRulesRegistry map. + </para> + </remarks> + </member> + <member name="F:log4net.Util.PatternParser.declaringType"> + <summary> + The fully qualified type of the PatternParser class. + </summary> + <remarks> + Used by the internal logger to record the Type of the + log message. + </remarks> + </member> + <member name="P:log4net.Util.PatternParser.PatternConverters"> + <summary> + Get the converter registry used by this parser + </summary> + <value> + The converter registry used by this parser + </value> + <remarks> + <para> + Get the converter registry used by this parser + </para> + </remarks> + </member> + <member name="T:log4net.Util.PatternParser.StringLengthComparer"> + <summary> + Sort strings by length + </summary> + <remarks> + <para> + <see cref="T:System.Collections.IComparer"/> that orders strings by string length. + The longest strings are placed first + </para> + </remarks> + </member> + <member name="T:log4net.Util.PatternString"> + <summary> + This class implements a patterned string. + </summary> + <remarks> + <para> + This string has embedded patterns that are resolved and expanded + when the string is formatted. + </para> + <para> + This class functions similarly to the <see cref="T:log4net.Layout.PatternLayout"/> + in that it accepts a pattern and renders it to a string. Unlike the + <see cref="T:log4net.Layout.PatternLayout"/> however the <c>PatternString</c> + does not render the properties of a specific <see cref="T:log4net.Core.LoggingEvent"/> but + of the process in general. + </para> + <para> + The recognized conversion pattern names are: + </para> + <list type="table"> + <listheader> + <term>Conversion Pattern Name</term> + <description>Effect</description> + </listheader> + <item> + <term>appdomain</term> + <description> + <para> + Used to output the friendly name of the current AppDomain. + </para> + </description> + </item> + <item> + <term>date</term> + <description> + <para> + Used to output the current date and time in the local time zone. + To output the date in universal time use the <c>%utcdate</c> pattern. + The date conversion + specifier may be followed by a <i>date format specifier</i> enclosed + between braces. For example, <b>%date{HH:mm:ss,fff}</b> or + <b>%date{dd MMM yyyy HH:mm:ss,fff}</b>. If no date format specifier is + given then ISO8601 format is + assumed (<see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>). + </para> + <para> + The date format specifier admits the same syntax as the + time pattern string of the <see cref="M:DateTime.ToString(string)"/>. + </para> + <para> + For better results it is recommended to use the log4net date + formatters. These can be specified using one of the strings + "ABSOLUTE", "DATE" and "ISO8601" for specifying + <see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/>, + <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> and respectively + <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>. For example, + <b>%date{ISO8601}</b> or <b>%date{ABSOLUTE}</b>. + </para> + <para> + These dedicated date formatters perform significantly + better than <see cref="M:DateTime.ToString(string)"/>. + </para> + </description> + </item> + <item> + <term>env</term> + <description> + <para> + Used to output the a specific environment variable. The key to + lookup must be specified within braces and directly following the + pattern specifier, e.g. <b>%env{COMPUTERNAME}</b> would include the value + of the <c>COMPUTERNAME</c> environment variable. + </para> + <para> + The <c>env</c> pattern is not supported on the .NET Compact Framework. + </para> + </description> + </item> + <item> + <term>identity</term> + <description> + <para> + Used to output the user name for the currently active user + (Principal.Identity.Name). + </para> + </description> + </item> + <item> + <term>newline</term> + <description> + <para> + Outputs the platform dependent line separator character or + characters. + </para> + <para> + This conversion pattern name offers the same performance as using + non-portable line separator strings such as "\n", or "\r\n". + Thus, it is the preferred way of specifying a line separator. + </para> + </description> + </item> + <item> + <term>processid</term> + <description> + <para> + Used to output the system process ID for the current process. + </para> + </description> + </item> + <item> + <term>property</term> + <description> + <para> + Used to output a specific context property. The key to + lookup must be specified within braces and directly following the + pattern specifier, e.g. <b>%property{user}</b> would include the value + from the property that is keyed by the string 'user'. Each property value + that is to be included in the log must be specified separately. + Properties are stored in logging contexts. By default + the <c>log4net:HostName</c> property is set to the name of machine on + which the event was originally logged. + </para> + <para> + If no key is specified, e.g. <b>%property</b> then all the keys and their + values are printed in a comma separated list. + </para> + <para> + The properties of an event are combined from a number of different + contexts. These are listed below in the order in which they are searched. + </para> + <list type="definition"> + <item> + <term>the thread properties</term> + <description> + The <see cref="P:log4net.ThreadContext.Properties"/> that are set on the current + thread. These properties are shared by all events logged on this thread. + </description> + </item> + <item> + <term>the global properties</term> + <description> + The <see cref="P:log4net.GlobalContext.Properties"/> that are set globally. These + properties are shared by all the threads in the AppDomain. + </description> + </item> + </list> + </description> + </item> + <item> + <term>random</term> + <description> + <para> + Used to output a random string of characters. The string is made up of + uppercase letters and numbers. By default the string is 4 characters long. + The length of the string can be specified within braces directly following the + pattern specifier, e.g. <b>%random{8}</b> would output an 8 character string. + </para> + </description> + </item> + <item> + <term>username</term> + <description> + <para> + Used to output the WindowsIdentity for the currently + active user. + </para> + </description> + </item> + <item> + <term>utcdate</term> + <description> + <para> + Used to output the date of the logging event in universal time. + The date conversion + specifier may be followed by a <i>date format specifier</i> enclosed + between braces. For example, <b>%utcdate{HH:mm:ss,fff}</b> or + <b>%utcdate{dd MMM yyyy HH:mm:ss,fff}</b>. If no date format specifier is + given then ISO8601 format is + assumed (<see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>). + </para> + <para> + The date format specifier admits the same syntax as the + time pattern string of the <see cref="M:DateTime.ToString(string)"/>. + </para> + <para> + For better results it is recommended to use the log4net date + formatters. These can be specified using one of the strings + "ABSOLUTE", "DATE" and "ISO8601" for specifying + <see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/>, + <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> and respectively + <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>. For example, + <b>%utcdate{ISO8601}</b> or <b>%utcdate{ABSOLUTE}</b>. + </para> + <para> + These dedicated date formatters perform significantly + better than <see cref="M:DateTime.ToString(string)"/>. + </para> + </description> + </item> + <item> + <term>%</term> + <description> + <para> + The sequence %% outputs a single percent sign. + </para> + </description> + </item> + </list> + <para> + Additional pattern converters may be registered with a specific <see cref="T:log4net.Util.PatternString"/> + instance using <see cref="M:AddConverter(ConverterInfo)"/> or + <see cref="M:AddConverter(string, Type)"/>. + </para> + <para> + See the <see cref="T:log4net.Layout.PatternLayout"/> for details on the + <i>format modifiers</i> supported by the patterns. + </para> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="F:log4net.Util.PatternString.s_globalRulesRegistry"> + <summary> + Internal map of converter identifiers to converter types. + </summary> + </member> + <member name="F:log4net.Util.PatternString.m_pattern"> + <summary> + the pattern + </summary> + </member> + <member name="F:log4net.Util.PatternString.m_head"> + <summary> + the head of the pattern converter chain + </summary> + </member> + <member name="F:log4net.Util.PatternString.m_instanceRulesRegistry"> + <summary> + patterns defined on this PatternString only + </summary> + </member> + <member name="M:log4net.Util.PatternString.#cctor"> + <summary> + Initialize the global registry + </summary> + </member> + <member name="M:log4net.Util.PatternString.#ctor"> + <summary> + Default constructor + </summary> + <remarks> + <para> + Initialize a new instance of <see cref="T:log4net.Util.PatternString"/> + </para> + </remarks> + </member> + <member name="M:log4net.Util.PatternString.#ctor(System.String)"> + <summary> + Constructs a PatternString + </summary> + <param name="pattern">The pattern to use with this PatternString</param> + <remarks> + <para> + Initialize a new instance of <see cref="T:log4net.Util.PatternString"/> with the pattern specified. + </para> + </remarks> + </member> + <member name="M:log4net.Util.PatternString.ActivateOptions"> + <summary> + Initialize object options + </summary> + <remarks> + <para> + This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object + activation scheme. The <see cref="M:log4net.Util.PatternString.ActivateOptions"/> method must + be called on this object after the configuration properties have + been set. Until <see cref="M:log4net.Util.PatternString.ActivateOptions"/> is called this + object is in an undefined state and must not be used. + </para> + <para> + If any of the configuration properties are modified then + <see cref="M:log4net.Util.PatternString.ActivateOptions"/> must be called again. + </para> + </remarks> + </member> + <member name="M:log4net.Util.PatternString.CreatePatternParser(System.String)"> + <summary> + Create the <see cref="T:log4net.Util.PatternParser"/> used to parse the pattern + </summary> + <param name="pattern">the pattern to parse</param> + <returns>The <see cref="T:log4net.Util.PatternParser"/></returns> + <remarks> + <para> + Returns PatternParser used to parse the conversion string. Subclasses + may override this to return a subclass of PatternParser which recognize + custom conversion pattern name. + </para> + </remarks> + </member> + <member name="M:log4net.Util.PatternString.Format(System.IO.TextWriter)"> + <summary> + Produces a formatted string as specified by the conversion pattern. + </summary> + <param name="writer">The TextWriter to write the formatted event to</param> + <remarks> + <para> + Format the pattern to the <paramref name="writer"/>. + </para> + </remarks> + </member> + <member name="M:log4net.Util.PatternString.Format"> + <summary> + Format the pattern as a string + </summary> + <returns>the pattern formatted as a string</returns> + <remarks> + <para> + Format the pattern to a string. + </para> + </remarks> + </member> + <member name="M:log4net.Util.PatternString.AddConverter(log4net.Util.ConverterInfo)"> + <summary> + Add a converter to this PatternString + </summary> + <param name="converterInfo">the converter info</param> + <remarks> + <para> + This version of the method is used by the configurator. + Programmatic users should use the alternative <see cref="M:AddConverter(string,Type)"/> method. + </para> + </remarks> + </member> + <member name="M:log4net.Util.PatternString.AddConverter(System.String,System.Type)"> + <summary> + Add a converter to this PatternString + </summary> + <param name="name">the name of the conversion pattern for this converter</param> + <param name="type">the type of the converter</param> + <remarks> + <para> + Add a converter to this PatternString + </para> + </remarks> + </member> + <member name="P:log4net.Util.PatternString.ConversionPattern"> + <summary> + Gets or sets the pattern formatting string + </summary> + <value> + The pattern formatting string + </value> + <remarks> + <para> + The <b>ConversionPattern</b> option. This is the string which + controls formatting and consists of a mix of literal content and + conversion specifiers. + </para> + </remarks> + </member> + <member name="T:log4net.Util.PropertiesDictionary"> + <summary> + String keyed object map. + </summary> + <remarks> + <para> + While this collection is serializable only member + objects that are serializable will + be serialized along with this collection. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="T:log4net.Util.ReadOnlyPropertiesDictionary"> + <summary> + String keyed object map that is read only. + </summary> + <remarks> + <para> + This collection is readonly and cannot be modified. + </para> + <para> + While this collection is serializable only member + objects that are serializable will + be serialized along with this collection. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="F:log4net.Util.ReadOnlyPropertiesDictionary.m_hashtable"> + <summary> + The Hashtable used to store the properties data + </summary> + </member> + <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.#ctor"> + <summary> + Constructor + </summary> + <remarks> + <para> + Initializes a new instance of the <see cref="T:log4net.Util.ReadOnlyPropertiesDictionary"/> class. + </para> + </remarks> + </member> + <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.#ctor(log4net.Util.ReadOnlyPropertiesDictionary)"> + <summary> + Copy Constructor + </summary> + <param name="propertiesDictionary">properties to copy</param> + <remarks> + <para> + Initializes a new instance of the <see cref="T:log4net.Util.ReadOnlyPropertiesDictionary"/> class. + </para> + </remarks> + </member> + <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> + <summary> + Deserialization constructor + </summary> + <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.</param> + <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param> + <remarks> + <para> + Initializes a new instance of the <see cref="T:log4net.Util.ReadOnlyPropertiesDictionary"/> class + with serialized data. + </para> + </remarks> + </member> + <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.GetKeys"> + <summary> + Gets the key names. + </summary> + <returns>An array of all the keys.</returns> + <remarks> + <para> + Gets the key names. + </para> + </remarks> + </member> + <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.Contains(System.String)"> + <summary> + Test if the dictionary contains a specified key + </summary> + <param name="key">the key to look for</param> + <returns>true if the dictionary contains the specified key</returns> + <remarks> + <para> + Test if the dictionary contains a specified key + </para> + </remarks> + </member> + <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> + <summary> + Serializes this object into the <see cref="T:System.Runtime.Serialization.SerializationInfo"/> provided. + </summary> + <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> to populate with data.</param> + <param name="context">The destination for this serialization.</param> + <remarks> + <para> + Serializes this object into the <see cref="T:System.Runtime.Serialization.SerializationInfo"/> provided. + </para> + </remarks> + </member> + <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#GetEnumerator"> + <summary> + See <see cref="M:System.Collections.IDictionary.GetEnumerator"/> + </summary> + </member> + <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Remove(System.Object)"> + <summary> + See <see cref="M:System.Collections.IDictionary.Remove(System.Object)"/> + </summary> + <param name="key"></param> + </member> + <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Contains(System.Object)"> + <summary> + See <see cref="M:System.Collections.IDictionary.Contains(System.Object)"/> + </summary> + <param name="key"></param> + <returns></returns> + </member> + <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.Clear"> + <summary> + Remove all properties from the properties collection + </summary> + </member> + <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Add(System.Object,System.Object)"> + <summary> + See <see cref="M:System.Collections.IDictionary.Add(System.Object,System.Object)"/> + </summary> + <param name="key"></param> + <param name="value"></param> + </member> + <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#ICollection#CopyTo(System.Array,System.Int32)"> + <summary> + See <see cref="M:System.Collections.ICollection.CopyTo(System.Array,System.Int32)"/> + </summary> + <param name="array"></param> + <param name="index"></param> + </member> + <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IEnumerable#GetEnumerator"> + <summary> + See <see cref="M:System.Collections.IEnumerable.GetEnumerator"/> + </summary> + </member> + <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.Item(System.String)"> + <summary> + Gets or sets the value of the property with the specified key. + </summary> + <value> + The value of the property with the specified key. + </value> + <param name="key">The key of the property to get or set.</param> + <remarks> + <para> + The property value will only be serialized if it is serializable. + If it cannot be serialized it will be silently ignored if + a serialization operation is performed. + </para> + </remarks> + </member> + <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.InnerHashtable"> + <summary> + The hashtable used to store the properties + </summary> + <value> + The internal collection used to store the properties + </value> + <remarks> + <para> + The hashtable used to store the properties + </para> + </remarks> + </member> + <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#IsReadOnly"> + <summary> + See <see cref="P:System.Collections.IDictionary.IsReadOnly"/> + </summary> + </member> + <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Item(System.Object)"> + <summary> + See <see cref="P:System.Collections.IDictionary.Item(System.Object)"/> + </summary> + </member> + <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Values"> + <summary> + See <see cref="P:System.Collections.IDictionary.Values"/> + </summary> + </member> + <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Keys"> + <summary> + See <see cref="P:System.Collections.IDictionary.Keys"/> + </summary> + </member> + <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#IsFixedSize"> + <summary> + See <see cref="P:System.Collections.IDictionary.IsFixedSize"/> + </summary> + </member> + <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#ICollection#IsSynchronized"> + <summary> + See <see cref="P:System.Collections.ICollection.IsSynchronized"/> + </summary> + </member> + <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.Count"> + <summary> + The number of properties in this collection + </summary> + </member> + <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#ICollection#SyncRoot"> + <summary> + See <see cref="P:System.Collections.ICollection.SyncRoot"/> + </summary> + </member> + <member name="M:log4net.Util.PropertiesDictionary.#ctor"> + <summary> + Constructor + </summary> + <remarks> + <para> + Initializes a new instance of the <see cref="T:log4net.Util.PropertiesDictionary"/> class. + </para> + </remarks> + </member> + <member name="M:log4net.Util.PropertiesDictionary.#ctor(log4net.Util.ReadOnlyPropertiesDictionary)"> + <summary> + Constructor + </summary> + <param name="propertiesDictionary">properties to copy</param> + <remarks> + <para> + Initializes a new instance of the <see cref="T:log4net.Util.PropertiesDictionary"/> class. + </para> + </remarks> + </member> + <member name="M:log4net.Util.PropertiesDictionary.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> + <summary> + Initializes a new instance of the <see cref="T:log4net.Util.PropertiesDictionary"/> class + with serialized data. + </summary> + <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.</param> + <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param> + <remarks> + <para> + Because this class is sealed the serialization constructor is private. + </para> + </remarks> + </member> + <member name="M:log4net.Util.PropertiesDictionary.Remove(System.String)"> + <summary> + Remove the entry with the specified key from this dictionary + </summary> + <param name="key">the key for the entry to remove</param> + <remarks> + <para> + Remove the entry with the specified key from this dictionary + </para> + </remarks> + </member> + <member name="M:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#GetEnumerator"> + <summary> + See <see cref="M:System.Collections.IDictionary.GetEnumerator"/> + </summary> + <returns>an enumerator</returns> + <remarks> + <para> + Returns a <see cref="T:System.Collections.IDictionaryEnumerator"/> over the contest of this collection. + </para> + </remarks> + </member> + <member name="M:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Remove(System.Object)"> + <summary> + See <see cref="M:System.Collections.IDictionary.Remove(System.Object)"/> + </summary> + <param name="key">the key to remove</param> + <remarks> + <para> + Remove the entry with the specified key from this dictionary + </para> + </remarks> + </member> + <member name="M:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Contains(System.Object)"> + <summary> + See <see cref="M:System.Collections.IDictionary.Contains(System.Object)"/> + </summary> + <param name="key">the key to lookup in the collection</param> + <returns><c>true</c> if the collection contains the specified key</returns> + <remarks> + <para> + Test if this collection contains a specified key. + </para> + </remarks> + </member> + <member name="M:log4net.Util.PropertiesDictionary.Clear"> + <summary> + Remove all properties from the properties collection + </summary> + <remarks> + <para> + Remove all properties from the properties collection + </para> + </remarks> + </member> + <member name="M:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Add(System.Object,System.Object)"> + <summary> + See <see cref="M:System.Collections.IDictionary.Add(System.Object,System.Object)"/> + </summary> + <param name="key">the key</param> + <param name="value">the value to store for the key</param> + <remarks> + <para> + Store a value for the specified <see cref="T:System.String"/> <paramref name="key"/>. + </para> + </remarks> + <exception cref="T:System.ArgumentException">Thrown if the <paramref name="key"/> is not a string</exception> + </member> + <member name="M:log4net.Util.PropertiesDictionary.System#Collections#ICollection#CopyTo(System.Array,System.Int32)"> + <summary> + See <see cref="M:System.Collections.ICollection.CopyTo(System.Array,System.Int32)"/> + </summary> + <param name="array"></param> + <param name="index"></param> + </member> + <member name="M:log4net.Util.PropertiesDictionary.System#Collections#IEnumerable#GetEnumerator"> + <summary> + See <see cref="M:System.Collections.IEnumerable.GetEnumerator"/> + </summary> + </member> + <member name="P:log4net.Util.PropertiesDictionary.Item(System.String)"> + <summary> + Gets or sets the value of the property with the specified key. + </summary> + <value> + The value of the property with the specified key. + </value> + <param name="key">The key of the property to get or set.</param> + <remarks> + <para> + The property value will only be serialized if it is serializable. + If it cannot be serialized it will be silently ignored if + a serialization operation is performed. + </para> + </remarks> + </member> + <member name="P:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#IsReadOnly"> + <summary> + See <see cref="P:System.Collections.IDictionary.IsReadOnly"/> + </summary> + <value> + <c>false</c> + </value> + <remarks> + <para> + This collection is modifiable. This property always + returns <c>false</c>. + </para> + </remarks> + </member> + <member name="P:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Item(System.Object)"> + <summary> + See <see cref="P:System.Collections.IDictionary.Item(System.Object)"/> + </summary> + <value> + The value for the key specified. + </value> + <remarks> + <para> + Get or set a value for the specified <see cref="T:System.String"/> <paramref name="key"/>. + </para> + </remarks> + <exception cref="T:System.ArgumentException">Thrown if the <paramref name="key"/> is not a string</exception> + </member> + <member name="P:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Values"> + <summary> + See <see cref="P:System.Collections.IDictionary.Values"/> + </summary> + </member> + <member name="P:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Keys"> + <summary> + See <see cref="P:System.Collections.IDictionary.Keys"/> + </summary> + </member> + <member name="P:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#IsFixedSize"> + <summary> + See <see cref="P:System.Collections.IDictionary.IsFixedSize"/> + </summary> + </member> + <member name="P:log4net.Util.PropertiesDictionary.System#Collections#ICollection#IsSynchronized"> + <summary> + See <see cref="P:System.Collections.ICollection.IsSynchronized"/> + </summary> + </member> + <member name="P:log4net.Util.PropertiesDictionary.System#Collections#ICollection#SyncRoot"> + <summary> + See <see cref="P:System.Collections.ICollection.SyncRoot"/> + </summary> + </member> + <member name="T:log4net.Util.PropertyEntry"> + <summary> + A class to hold the key and data for a property set in the config file + </summary> + <remarks> + <para> + A class to hold the key and data for a property set in the config file + </para> + </remarks> + </member> + <member name="M:log4net.Util.PropertyEntry.ToString"> + <summary> + Override <c>Object.ToString</c> to return sensible debug info + </summary> + <returns>string info about this object</returns> + </member> + <member name="P:log4net.Util.PropertyEntry.Key"> + <summary> + Property Key + </summary> + <value> + Property Key + </value> + <remarks> + <para> + Property Key. + </para> + </remarks> + </member> + <member name="P:log4net.Util.PropertyEntry.Value"> + <summary> + Property Value + </summary> + <value> + Property Value + </value> + <remarks> + <para> + Property Value. + </para> + </remarks> + </member> + <member name="T:log4net.Util.ProtectCloseTextWriter"> + <summary> + A <see cref="T:System.IO.TextWriter"/> that ignores the <see cref="M:log4net.Util.ProtectCloseTextWriter.Close"/> message + </summary> + <remarks> + <para> + This writer is used in special cases where it is necessary + to protect a writer from being closed by a client. + </para> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="M:log4net.Util.ProtectCloseTextWriter.#ctor(System.IO.TextWriter)"> + <summary> + Constructor + </summary> + <param name="writer">the writer to actually write to</param> + <remarks> + <para> + Create a new ProtectCloseTextWriter using a writer + </para> + </remarks> + </member> + <member name="M:log4net.Util.ProtectCloseTextWriter.Attach(System.IO.TextWriter)"> + <summary> + Attach this instance to a different underlying <see cref="T:System.IO.TextWriter"/> + </summary> + <param name="writer">the writer to attach to</param> + <remarks> + <para> + Attach this instance to a different underlying <see cref="T:System.IO.TextWriter"/> + </para> + </remarks> + </member> + <member name="M:log4net.Util.ProtectCloseTextWriter.Close"> + <summary> + Does not close the underlying output writer. + </summary> + <remarks> + <para> + Does not close the underlying output writer. + This method does nothing. + </para> + </remarks> + </member> + <member name="T:log4net.Util.ReaderWriterLock"> + <summary> + Defines a lock that supports single writers and multiple readers + </summary> + <remarks> + <para> + <c>ReaderWriterLock</c> is used to synchronize access to a resource. + At any given time, it allows either concurrent read access for + multiple threads, or write access for a single thread. In a + situation where a resource is changed infrequently, a + <c>ReaderWriterLock</c> provides better throughput than a simple + one-at-a-time lock, such as <see cref="T:System.Threading.Monitor"/>. + </para> + <para> + If a platform does not support a <c>System.Threading.ReaderWriterLock</c> + implementation then all readers and writers are serialized. Therefore + the caller must not rely on multiple simultaneous readers. + </para> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="M:log4net.Util.ReaderWriterLock.#ctor"> + <summary> + Constructor + </summary> + <remarks> + <para> + Initializes a new instance of the <see cref="T:log4net.Util.ReaderWriterLock"/> class. + </para> + </remarks> + </member> + <member name="M:log4net.Util.ReaderWriterLock.AcquireReaderLock"> + <summary> + Acquires a reader lock + </summary> + <remarks> + <para> + <see cref="M:log4net.Util.ReaderWriterLock.AcquireReaderLock"/> blocks if a different thread has the writer + lock, or if at least one thread is waiting for the writer lock. + </para> + </remarks> + </member> + <member name="M:log4net.Util.ReaderWriterLock.ReleaseReaderLock"> + <summary> + Decrements the lock count + </summary> + <remarks> + <para> + <see cref="M:log4net.Util.ReaderWriterLock.ReleaseReaderLock"/> decrements the lock count. When the count + reaches zero, the lock is released. + </para> + </remarks> + </member> + <member name="M:log4net.Util.ReaderWriterLock.AcquireWriterLock"> + <summary> + Acquires the writer lock + </summary> + <remarks> + <para> + This method blocks if another thread has a reader lock or writer lock. + </para> + </remarks> + </member> + <member name="M:log4net.Util.ReaderWriterLock.ReleaseWriterLock"> + <summary> + Decrements the lock count on the writer lock + </summary> + <remarks> + <para> + ReleaseWriterLock decrements the writer lock count. + When the count reaches zero, the writer lock is released. + </para> + </remarks> + </member> + <member name="T:log4net.Util.ReusableStringWriter"> + <summary> + A <see cref="T:System.IO.StringWriter"/> that can be <see cref="M:log4net.Util.ReusableStringWriter.Reset(System.Int32,System.Int32)"/> and reused + </summary> + <remarks> + <para> + A <see cref="T:System.IO.StringWriter"/> that can be <see cref="M:log4net.Util.ReusableStringWriter.Reset(System.Int32,System.Int32)"/> and reused. + This uses a single buffer for string operations. + </para> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="M:log4net.Util.ReusableStringWriter.#ctor(System.IFormatProvider)"> + <summary> + Create an instance of <see cref="T:log4net.Util.ReusableStringWriter"/> + </summary> + <param name="formatProvider">the format provider to use</param> + <remarks> + <para> + Create an instance of <see cref="T:log4net.Util.ReusableStringWriter"/> + </para> + </remarks> + </member> + <member name="M:log4net.Util.ReusableStringWriter.Dispose(System.Boolean)"> + <summary> + Override Dispose to prevent closing of writer + </summary> + <param name="disposing">flag</param> + <remarks> + <para> + Override Dispose to prevent closing of writer + </para> + </remarks> + </member> + <member name="M:log4net.Util.ReusableStringWriter.Reset(System.Int32,System.Int32)"> + <summary> + Reset this string writer so that it can be reused. + </summary> + <param name="maxCapacity">the maximum buffer capacity before it is trimmed</param> + <param name="defaultSize">the default size to make the buffer</param> + <remarks> + <para> + Reset this string writer so that it can be reused. + The internal buffers are cleared and reset. + </para> + </remarks> + </member> + <member name="T:log4net.Util.SystemInfo"> + <summary> + Utility class for system specific information. + </summary> + <remarks> + <para> + Utility class of static methods for system specific information. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + <author>Alexey Solofnenko</author> + </member> + <member name="M:log4net.Util.SystemInfo.#ctor"> + <summary> + Private constructor to prevent instances. + </summary> + <remarks> + <para> + Only static methods are exposed from this type. + </para> + </remarks> + </member> + <member name="M:log4net.Util.SystemInfo.#cctor"> + <summary> + Initialize default values for private static fields. + </summary> + <remarks> + <para> + Only static methods are exposed from this type. + </para> + </remarks> + </member> + <member name="M:log4net.Util.SystemInfo.AssemblyLocationInfo(System.Reflection.Assembly)"> + <summary> + Gets the assembly location path for the specified assembly. + </summary> + <param name="myAssembly">The assembly to get the location for.</param> + <returns>The location of the assembly.</returns> + <remarks> + <para> + This method does not guarantee to return the correct path + to the assembly. If only tries to give an indication as to + where the assembly was loaded from. + </para> + </remarks> + </member> + <member name="M:log4net.Util.SystemInfo.AssemblyQualifiedName(System.Type)"> + <summary> + Gets the fully qualified name of the <see cref="T:System.Type"/>, including + the name of the assembly from which the <see cref="T:System.Type"/> was + loaded. + </summary> + <param name="type">The <see cref="T:System.Type"/> to get the fully qualified name for.</param> + <returns>The fully qualified name for the <see cref="T:System.Type"/>.</returns> + <remarks> + <para> + This is equivalent to the <c>Type.AssemblyQualifiedName</c> property, + but this method works on the .NET Compact Framework 1.0 as well as + the full .NET runtime. + </para> + </remarks> + </member> + <member name="M:log4net.Util.SystemInfo.AssemblyShortName(System.Reflection.Assembly)"> + <summary> + Gets the short name of the <see cref="T:System.Reflection.Assembly"/>. + </summary> + <param name="myAssembly">The <see cref="T:System.Reflection.Assembly"/> to get the name for.</param> + <returns>The short name of the <see cref="T:System.Reflection.Assembly"/>.</returns> + <remarks> + <para> + The short name of the assembly is the <see cref="P:System.Reflection.Assembly.FullName"/> + without the version, culture, or public key. i.e. it is just the + assembly's file name without the extension. + </para> + <para> + Use this rather than <c>Assembly.GetName().Name</c> because that + is not available on the Compact Framework. + </para> + <para> + Because of a FileIOPermission security demand we cannot do + the obvious Assembly.GetName().Name. We are allowed to get + the <see cref="P:System.Reflection.Assembly.FullName"/> of the assembly so we + start from there and strip out just the assembly name. + </para> + </remarks> + </member> + <member name="M:log4net.Util.SystemInfo.AssemblyFileName(System.Reflection.Assembly)"> + <summary> + Gets the file name portion of the <see cref="T:System.Reflection.Assembly"/>, including the extension. + </summary> + <param name="myAssembly">The <see cref="T:System.Reflection.Assembly"/> to get the file name for.</param> + <returns>The file name of the assembly.</returns> + <remarks> + <para> + Gets the file name portion of the <see cref="T:System.Reflection.Assembly"/>, including the extension. + </para> + </remarks> + </member> + <member name="M:log4net.Util.SystemInfo.GetTypeFromString(System.Type,System.String,System.Boolean,System.Boolean)"> + <summary> + Loads the type specified in the type string. + </summary> + <param name="relativeType">A sibling type to use to load the type.</param> + <param name="typeName">The name of the type to load.</param> + <param name="throwOnError">Flag set to <c>true</c> to throw an exception if the type cannot be loaded.</param> + <param name="ignoreCase"><c>true</c> to ignore the case of the type name; otherwise, <c>false</c></param> + <returns>The type loaded or <c>null</c> if it could not be loaded.</returns> + <remarks> + <para> + If the type name is fully qualified, i.e. if contains an assembly name in + the type name, the type will be loaded from the system using + <see cref="M:Type.GetType(string,bool)"/>. + </para> + <para> + If the type name is not fully qualified, it will be loaded from the assembly + containing the specified relative type. If the type is not found in the assembly + then all the loaded assemblies will be searched for the type. + </para> + </remarks> + </member> + <member name="M:log4net.Util.SystemInfo.GetTypeFromString(System.String,System.Boolean,System.Boolean)"> + <summary> + Loads the type specified in the type string. + </summary> + <param name="typeName">The name of the type to load.</param> + <param name="throwOnError">Flag set to <c>true</c> to throw an exception if the type cannot be loaded.</param> + <param name="ignoreCase"><c>true</c> to ignore the case of the type name; otherwise, <c>false</c></param> + <returns>The type loaded or <c>null</c> if it could not be loaded.</returns> + <remarks> + <para> + If the type name is fully qualified, i.e. if contains an assembly name in + the type name, the type will be loaded from the system using + <see cref="M:Type.GetType(string,bool)"/>. + </para> + <para> + If the type name is not fully qualified it will be loaded from the + assembly that is directly calling this method. If the type is not found + in the assembly then all the loaded assemblies will be searched for the type. + </para> + </remarks> + </member> + <member name="M:log4net.Util.SystemInfo.GetTypeFromString(System.Reflection.Assembly,System.String,System.Boolean,System.Boolean)"> + <summary> + Loads the type specified in the type string. + </summary> + <param name="relativeAssembly">An assembly to load the type from.</param> + <param name="typeName">The name of the type to load.</param> + <param name="throwOnError">Flag set to <c>true</c> to throw an exception if the type cannot be loaded.</param> + <param name="ignoreCase"><c>true</c> to ignore the case of the type name; otherwise, <c>false</c></param> + <returns>The type loaded or <c>null</c> if it could not be loaded.</returns> + <remarks> + <para> + If the type name is fully qualified, i.e. if contains an assembly name in + the type name, the type will be loaded from the system using + <see cref="M:Type.GetType(string,bool)"/>. + </para> + <para> + If the type name is not fully qualified it will be loaded from the specified + assembly. If the type is not found in the assembly then all the loaded assemblies + will be searched for the type. + </para> + </remarks> + </member> + <member name="M:log4net.Util.SystemInfo.NewGuid"> + <summary> + Generate a new guid + </summary> + <returns>A new Guid</returns> + <remarks> + <para> + Generate a new guid + </para> + </remarks> + </member> + <member name="M:log4net.Util.SystemInfo.CreateArgumentOutOfRangeException(System.String,System.Object,System.String)"> + <summary> + Create an <see cref="T:System.ArgumentOutOfRangeException"/> + </summary> + <param name="parameterName">The name of the parameter that caused the exception</param> + <param name="actualValue">The value of the argument that causes this exception</param> + <param name="message">The message that describes the error</param> + <returns>the ArgumentOutOfRangeException object</returns> + <remarks> + <para> + Create a new instance of the <see cref="T:System.ArgumentOutOfRangeException"/> class + with a specified error message, the parameter name, and the value + of the argument. + </para> + <para> + The Compact Framework does not support the 3 parameter constructor for the + <see cref="T:System.ArgumentOutOfRangeException"/> type. This method provides an + implementation that works for all platforms. + </para> + </remarks> + </member> + <member name="M:log4net.Util.SystemInfo.TryParse(System.String,System.Int32@)"> + <summary> + Parse a string into an <see cref="T:System.Int32"/> value + </summary> + <param name="s">the string to parse</param> + <param name="val">out param where the parsed value is placed</param> + <returns><c>true</c> if the string was able to be parsed into an integer</returns> + <remarks> + <para> + Attempts to parse the string into an integer. If the string cannot + be parsed then this method returns <c>false</c>. The method does not throw an exception. + </para> + </remarks> + </member> + <member name="M:log4net.Util.SystemInfo.TryParse(System.String,System.Int64@)"> + <summary> + Parse a string into an <see cref="T:System.Int64"/> value + </summary> + <param name="s">the string to parse</param> + <param name="val">out param where the parsed value is placed</param> + <returns><c>true</c> if the string was able to be parsed into an integer</returns> + <remarks> + <para> + Attempts to parse the string into an integer. If the string cannot + be parsed then this method returns <c>false</c>. The method does not throw an exception. + </para> + </remarks> + </member> + <member name="M:log4net.Util.SystemInfo.TryParse(System.String,System.Int16@)"> + <summary> + Parse a string into an <see cref="T:System.Int16"/> value + </summary> + <param name="s">the string to parse</param> + <param name="val">out param where the parsed value is placed</param> + <returns><c>true</c> if the string was able to be parsed into an integer</returns> + <remarks> + <para> + Attempts to parse the string into an integer. If the string cannot + be parsed then this method returns <c>false</c>. The method does not throw an exception. + </para> + </remarks> + </member> + <member name="M:log4net.Util.SystemInfo.GetAppSetting(System.String)"> + <summary> + Lookup an application setting + </summary> + <param name="key">the application settings key to lookup</param> + <returns>the value for the key, or <c>null</c></returns> + <remarks> + <para> + Configuration APIs are not supported under the Compact Framework + </para> + </remarks> + </member> + <member name="M:log4net.Util.SystemInfo.ConvertToFullPath(System.String)"> + <summary> + Convert a path into a fully qualified local file path. + </summary> + <param name="path">The path to convert.</param> + <returns>The fully qualified path.</returns> + <remarks> + <para> + Converts the path specified to a fully + qualified path. If the path is relative it is + taken as relative from the application base + directory. + </para> + <para> + The path specified must be a local file path, a URI is not supported. + </para> + </remarks> + </member> + <member name="M:log4net.Util.SystemInfo.CreateCaseInsensitiveHashtable"> + <summary> + Creates a new case-insensitive instance of the <see cref="T:System.Collections.Hashtable"/> class with the default initial capacity. + </summary> + <returns>A new case-insensitive instance of the <see cref="T:System.Collections.Hashtable"/> class with the default initial capacity</returns> + <remarks> + <para> + The new Hashtable instance uses the default load factor, the CaseInsensitiveHashCodeProvider, and the CaseInsensitiveComparer. + </para> + </remarks> + </member> + <member name="F:log4net.Util.SystemInfo.EmptyTypes"> + <summary> + Gets an empty array of types. + </summary> + <remarks> + <para> + The <c>Type.EmptyTypes</c> field is not available on + the .NET Compact Framework 1.0. + </para> + </remarks> + </member> + <member name="F:log4net.Util.SystemInfo.declaringType"> + <summary> + The fully qualified type of the SystemInfo class. + </summary> + <remarks> + Used by the internal logger to record the Type of the + log message. + </remarks> + </member> + <member name="F:log4net.Util.SystemInfo.s_hostName"> + <summary> + Cache the host name for the current machine + </summary> + </member> + <member name="F:log4net.Util.SystemInfo.s_appFriendlyName"> + <summary> + Cache the application friendly name + </summary> + </member> + <member name="F:log4net.Util.SystemInfo.s_nullText"> + <summary> + Text to output when a <c>null</c> is encountered. + </summary> + </member> + <member name="F:log4net.Util.SystemInfo.s_notAvailableText"> + <summary> + Text to output when an unsupported feature is requested. + </summary> + </member> + <member name="F:log4net.Util.SystemInfo.s_processStartTime"> + <summary> + Start time for the current process. + </summary> + </member> + <member name="P:log4net.Util.SystemInfo.NewLine"> + <summary> + Gets the system dependent line terminator. + </summary> + <value> + The system dependent line terminator. + </value> + <remarks> + <para> + Gets the system dependent line terminator. + </para> + </remarks> + </member> + <member name="P:log4net.Util.SystemInfo.ApplicationBaseDirectory"> + <summary> + Gets the base directory for this <see cref="T:System.AppDomain"/>. + </summary> + <value>The base directory path for the current <see cref="T:System.AppDomain"/>.</value> + <remarks> + <para> + Gets the base directory for this <see cref="T:System.AppDomain"/>. + </para> + <para> + The value returned may be either a local file path or a URI. + </para> + </remarks> + </member> + <member name="P:log4net.Util.SystemInfo.ConfigurationFileLocation"> + <summary> + Gets the path to the configuration file for the current <see cref="T:System.AppDomain"/>. + </summary> + <value>The path to the configuration file for the current <see cref="T:System.AppDomain"/>.</value> + <remarks> + <para> + The .NET Compact Framework 1.0 does not have a concept of a configuration + file. For this runtime, we use the entry assembly location as the root for + the configuration file name. + </para> + <para> + The value returned may be either a local file path or a URI. + </para> + </remarks> + </member> + <member name="P:log4net.Util.SystemInfo.EntryAssemblyLocation"> + <summary> + Gets the path to the file that first executed in the current <see cref="T:System.AppDomain"/>. + </summary> + <value>The path to the entry assembly.</value> + <remarks> + <para> + Gets the path to the file that first executed in the current <see cref="T:System.AppDomain"/>. + </para> + </remarks> + </member> + <member name="P:log4net.Util.SystemInfo.CurrentThreadId"> + <summary> + Gets the ID of the current thread. + </summary> + <value>The ID of the current thread.</value> + <remarks> + <para> + On the .NET framework, the <c>AppDomain.GetCurrentThreadId</c> method + is used to obtain the thread ID for the current thread. This is the + operating system ID for the thread. + </para> + <para> + On the .NET Compact Framework 1.0 it is not possible to get the + operating system thread ID for the current thread. The native method + <c>GetCurrentThreadId</c> is implemented inline in a header file + and cannot be called. + </para> + <para> + On the .NET Framework 2.0 the <c>Thread.ManagedThreadId</c> is used as this + gives a stable id unrelated to the operating system thread ID which may + change if the runtime is using fibers. + </para> + </remarks> + </member> + <member name="P:log4net.Util.SystemInfo.HostName"> + <summary> + Get the host name or machine name for the current machine + </summary> + <value> + The hostname or machine name + </value> + <remarks> + <para> + Get the host name or machine name for the current machine + </para> + <para> + The host name (<see cref="M:System.Net.Dns.GetHostName"/>) or + the machine name (<c>Environment.MachineName</c>) for + the current machine, or if neither of these are available + then <c>NOT AVAILABLE</c> is returned. + </para> + </remarks> + </member> + <member name="P:log4net.Util.SystemInfo.ApplicationFriendlyName"> + <summary> + Get this application's friendly name + </summary> + <value> + The friendly name of this application as a string + </value> + <remarks> + <para> + If available the name of the application is retrieved from + the <c>AppDomain</c> using <c>AppDomain.CurrentDomain.FriendlyName</c>. + </para> + <para> + Otherwise the file name of the entry assembly is used. + </para> + </remarks> + </member> + <member name="P:log4net.Util.SystemInfo.ProcessStartTime"> + <summary> + Get the start time for the current process. + </summary> + <remarks> + <para> + This is the time at which the log4net library was loaded into the + AppDomain. Due to reports of a hang in the call to <c>System.Diagnostics.Process.StartTime</c> + this is not the start time for the current process. + </para> + <para> + The log4net library should be loaded by an application early during its + startup, therefore this start time should be a good approximation for + the actual start time. + </para> + <para> + Note that AppDomains may be loaded and unloaded within the + same process without the process terminating, however this start time + will be set per AppDomain. + </para> + </remarks> + </member> + <member name="P:log4net.Util.SystemInfo.NullText"> + <summary> + Text to output when a <c>null</c> is encountered. + </summary> + <remarks> + <para> + Use this value to indicate a <c>null</c> has been encountered while + outputting a string representation of an item. + </para> + <para> + The default value is <c>(null)</c>. This value can be overridden by specifying + a value for the <c>log4net.NullText</c> appSetting in the application's + .config file. + </para> + </remarks> + </member> + <member name="P:log4net.Util.SystemInfo.NotAvailableText"> + <summary> + Text to output when an unsupported feature is requested. + </summary> + <remarks> + <para> + Use this value when an unsupported feature is requested. + </para> + <para> + The default value is <c>NOT AVAILABLE</c>. This value can be overridden by specifying + a value for the <c>log4net.NotAvailableText</c> appSetting in the application's + .config file. + </para> + </remarks> + </member> + <member name="T:log4net.Util.SystemStringFormat"> + <summary> + Utility class that represents a format string. + </summary> + <remarks> + <para> + Utility class that represents a format string. + </para> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="M:log4net.Util.SystemStringFormat.#ctor(System.IFormatProvider,System.String,System.Object[])"> + <summary> + Initialise the <see cref="T:log4net.Util.SystemStringFormat"/> + </summary> + <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information.</param> + <param name="format">A <see cref="T:System.String"/> containing zero or more format items.</param> + <param name="args">An <see cref="T:System.Object"/> array containing zero or more objects to format.</param> + </member> + <member name="M:log4net.Util.SystemStringFormat.ToString"> + <summary> + Format the string and arguments + </summary> + <returns>the formatted string</returns> + </member> + <member name="M:log4net.Util.SystemStringFormat.StringFormat(System.IFormatProvider,System.String,System.Object[])"> + <summary> + Replaces the format item in a specified <see cref="T:System.String"/> with the text equivalent + of the value of a corresponding <see cref="T:System.Object"/> instance in a specified array. + A specified parameter supplies culture-specific formatting information. + </summary> + <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information.</param> + <param name="format">A <see cref="T:System.String"/> containing zero or more format items.</param> + <param name="args">An <see cref="T:System.Object"/> array containing zero or more objects to format.</param> + <returns> + A copy of format in which the format items have been replaced by the <see cref="T:System.String"/> + equivalent of the corresponding instances of <see cref="T:System.Object"/> in args. + </returns> + <remarks> + <para> + This method does not throw exceptions. If an exception thrown while formatting the result the + exception and arguments are returned in the result string. + </para> + </remarks> + </member> + <member name="M:log4net.Util.SystemStringFormat.StringFormatError(System.Exception,System.String,System.Object[])"> + <summary> + Process an error during StringFormat + </summary> + </member> + <member name="M:log4net.Util.SystemStringFormat.RenderArray(System.Array,System.Text.StringBuilder)"> + <summary> + Dump the contents of an array into a string builder + </summary> + </member> + <member name="M:log4net.Util.SystemStringFormat.RenderObject(System.Object,System.Text.StringBuilder)"> + <summary> + Dump an object to a string + </summary> + </member> + <member name="F:log4net.Util.SystemStringFormat.declaringType"> + <summary> + The fully qualified type of the SystemStringFormat class. + </summary> + <remarks> + Used by the internal logger to record the Type of the + log message. + </remarks> + </member> + <member name="T:log4net.Util.ThreadContextProperties"> + <summary> + Implementation of Properties collection for the <see cref="T:log4net.ThreadContext"/> + </summary> + <remarks> + <para> + Class implements a collection of properties that is specific to each thread. + The class is not synchronized as each thread has its own <see cref="T:log4net.Util.PropertiesDictionary"/>. + </para> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="F:log4net.Util.ThreadContextProperties._dictionary"> + <summary> + Each thread will automatically have its instance. + </summary> + </member> + <member name="M:log4net.Util.ThreadContextProperties.#ctor"> + <summary> + Internal constructor + </summary> + <remarks> + <para> + Initializes a new instance of the <see cref="T:log4net.Util.ThreadContextProperties"/> class. + </para> + </remarks> + </member> + <member name="M:log4net.Util.ThreadContextProperties.Remove(System.String)"> + <summary> + Remove a property + </summary> + <param name="key">the key for the entry to remove</param> + <remarks> + <para> + Remove a property + </para> + </remarks> + </member> + <member name="M:log4net.Util.ThreadContextProperties.GetKeys"> + <summary> + Get the keys stored in the properties. + </summary> + <para> + Gets the keys stored in the properties. + </para> + <returns>a set of the defined keys</returns> + </member> + <member name="M:log4net.Util.ThreadContextProperties.Clear"> + <summary> + Clear all properties + </summary> + <remarks> + <para> + Clear all properties + </para> + </remarks> + </member> + <member name="M:log4net.Util.ThreadContextProperties.GetProperties(System.Boolean)"> + <summary> + Get the <c>PropertiesDictionary</c> for this thread. + </summary> + <param name="create">create the dictionary if it does not exist, otherwise return null if does not exist</param> + <returns>the properties for this thread</returns> + <remarks> + <para> + The collection returned is only to be used on the calling thread. If the + caller needs to share the collection between different threads then the + caller must clone the collection before doing so. + </para> + </remarks> + </member> + <member name="P:log4net.Util.ThreadContextProperties.Item(System.String)"> + <summary> + Gets or sets the value of a property + </summary> + <value> + The value for the property with the specified key + </value> + <remarks> + <para> + Gets or sets the value of a property + </para> + </remarks> + </member> + <member name="T:log4net.Util.ThreadContextStack"> + <summary> + Implementation of Stack for the <see cref="T:log4net.ThreadContext"/> + </summary> + <remarks> + <para> + Implementation of Stack for the <see cref="T:log4net.ThreadContext"/> + </para> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="F:log4net.Util.ThreadContextStack.m_stack"> + <summary> + The stack store. + </summary> + </member> + <member name="M:log4net.Util.ThreadContextStack.#ctor"> + <summary> + Internal constructor + </summary> + <remarks> + <para> + Initializes a new instance of the <see cref="T:log4net.Util.ThreadContextStack"/> class. + </para> + </remarks> + </member> + <member name="M:log4net.Util.ThreadContextStack.Clear"> + <summary> + Clears all the contextual information held in this stack. + </summary> + <remarks> + <para> + Clears all the contextual information held in this stack. + Only call this if you think that this tread is being reused after + a previous call execution which may not have completed correctly. + You do not need to use this method if you always guarantee to call + the <see cref="M:System.IDisposable.Dispose"/> method of the <see cref="T:System.IDisposable"/> + returned from <see cref="M:log4net.Util.ThreadContextStack.Push(System.String)"/> even in exceptional circumstances, + for example by using the <c>using(log4net.ThreadContext.Stacks["NDC"].Push("Stack_Message"))</c> + syntax. + </para> + </remarks> + </member> + <member name="M:log4net.Util.ThreadContextStack.Pop"> + <summary> + Removes the top context from this stack. + </summary> + <returns>The message in the context that was removed from the top of this stack.</returns> + <remarks> + <para> + Remove the top context from this stack, and return + it to the caller. If this stack is empty then an + empty string (not <see langword="null"/>) is returned. + </para> + </remarks> + </member> + <member name="M:log4net.Util.ThreadContextStack.Push(System.String)"> + <summary> + Pushes a new context message into this stack. + </summary> + <param name="message">The new context message.</param> + <returns> + An <see cref="T:System.IDisposable"/> that can be used to clean up the context stack. + </returns> + <remarks> + <para> + Pushes a new context onto this stack. An <see cref="T:System.IDisposable"/> + is returned that can be used to clean up this stack. This + can be easily combined with the <c>using</c> keyword to scope the + context. + </para> + </remarks> + <example>Simple example of using the <c>Push</c> method with the <c>using</c> keyword. + <code lang="C#"> + using(log4net.ThreadContext.Stacks["NDC"].Push("Stack_Message")) + { + log.Warn("This should have an ThreadContext Stack message"); + } + </code> + </example> + </member> + <member name="M:log4net.Util.ThreadContextStack.GetFullMessage"> + <summary> + Gets the current context information for this stack. + </summary> + <returns>The current context information.</returns> + </member> + <member name="M:log4net.Util.ThreadContextStack.ToString"> + <summary> + Gets the current context information for this stack. + </summary> + <returns>Gets the current context information</returns> + <remarks> + <para> + Gets the current context information for this stack. + </para> + </remarks> + </member> + <member name="M:log4net.Util.ThreadContextStack.log4net#Core#IFixingRequired#GetFixedObject"> + <summary> + Get a portable version of this object + </summary> + <returns>the portable instance of this object</returns> + <remarks> + <para> + Get a cross thread portable version of this object + </para> + </remarks> + </member> + <member name="P:log4net.Util.ThreadContextStack.Count"> + <summary> + The number of messages in the stack + </summary> + <value> + The current number of messages in the stack + </value> + <remarks> + <para> + The current number of messages in the stack. That is + the number of times <see cref="M:log4net.Util.ThreadContextStack.Push(System.String)"/> has been called + minus the number of times <see cref="M:log4net.Util.ThreadContextStack.Pop"/> has been called. + </para> + </remarks> + </member> + <member name="P:log4net.Util.ThreadContextStack.InternalStack"> + <summary> + Gets and sets the internal stack used by this <see cref="T:log4net.Util.ThreadContextStack"/> + </summary> + <value>The internal storage stack</value> + <remarks> + <para> + This property is provided only to support backward compatability + of the <see cref="T:log4net.NDC"/>. Tytpically the internal stack should not + be modified. + </para> + </remarks> + </member> + <member name="T:log4net.Util.ThreadContextStack.StackFrame"> + <summary> + Inner class used to represent a single context frame in the stack. + </summary> + <remarks> + <para> + Inner class used to represent a single context frame in the stack. + </para> + </remarks> + </member> + <member name="M:log4net.Util.ThreadContextStack.StackFrame.#ctor(System.String,log4net.Util.ThreadContextStack.StackFrame)"> + <summary> + Constructor + </summary> + <param name="message">The message for this context.</param> + <param name="parent">The parent context in the chain.</param> + <remarks> + <para> + Initializes a new instance of the <see cref="T:log4net.Util.ThreadContextStack.StackFrame"/> class + with the specified message and parent context. + </para> + </remarks> + </member> + <member name="P:log4net.Util.ThreadContextStack.StackFrame.Message"> + <summary> + Get the message. + </summary> + <value>The message.</value> + <remarks> + <para> + Get the message. + </para> + </remarks> + </member> + <member name="P:log4net.Util.ThreadContextStack.StackFrame.FullMessage"> + <summary> + Gets the full text of the context down to the root level. + </summary> + <value> + The full text of the context down to the root level. + </value> + <remarks> + <para> + Gets the full text of the context down to the root level. + </para> + </remarks> + </member> + <member name="T:log4net.Util.ThreadContextStack.AutoPopStackFrame"> + <summary> + Struct returned from the <see cref="M:log4net.Util.ThreadContextStack.Push(System.String)"/> method. + </summary> + <remarks> + <para> + This struct implements the <see cref="T:System.IDisposable"/> and is designed to be used + with the <see langword="using"/> pattern to remove the stack frame at the end of the scope. + </para> + </remarks> + </member> + <member name="F:log4net.Util.ThreadContextStack.AutoPopStackFrame.m_frameStack"> + <summary> + The ThreadContextStack internal stack + </summary> + </member> + <member name="F:log4net.Util.ThreadContextStack.AutoPopStackFrame.m_frameDepth"> + <summary> + The depth to trim the stack to when this instance is disposed + </summary> + </member> + <member name="M:log4net.Util.ThreadContextStack.AutoPopStackFrame.#ctor(System.Collections.Stack,System.Int32)"> + <summary> + Constructor + </summary> + <param name="frameStack">The internal stack used by the ThreadContextStack.</param> + <param name="frameDepth">The depth to return the stack to when this object is disposed.</param> + <remarks> + <para> + Initializes a new instance of the <see cref="T:log4net.Util.ThreadContextStack.AutoPopStackFrame"/> class with + the specified stack and return depth. + </para> + </remarks> + </member> + <member name="M:log4net.Util.ThreadContextStack.AutoPopStackFrame.Dispose"> + <summary> + Returns the stack to the correct depth. + </summary> + <remarks> + <para> + Returns the stack to the correct depth. + </para> + </remarks> + </member> + <member name="T:log4net.Util.ThreadContextStacks"> + <summary> + Implementation of Stacks collection for the <see cref="T:log4net.ThreadContext"/> + </summary> + <remarks> + <para> + Implementation of Stacks collection for the <see cref="T:log4net.ThreadContext"/> + </para> + </remarks> + <author>Nicko Cadell</author> + </member> + <member name="M:log4net.Util.ThreadContextStacks.#ctor(log4net.Util.ContextPropertiesBase)"> + <summary> + Internal constructor + </summary> + <remarks> + <para> + Initializes a new instance of the <see cref="T:log4net.Util.ThreadContextStacks"/> class. + </para> + </remarks> + </member> + <member name="F:log4net.Util.ThreadContextStacks.declaringType"> + <summary> + The fully qualified type of the ThreadContextStacks class. + </summary> + <remarks> + Used by the internal logger to record the Type of the + log message. + </remarks> + </member> + <member name="P:log4net.Util.ThreadContextStacks.Item(System.String)"> + <summary> + Gets the named thread context stack + </summary> + <value> + The named stack + </value> + <remarks> + <para> + Gets the named thread context stack + </para> + </remarks> + </member> + <member name="T:log4net.Util.Transform"> + <summary> + Utility class for transforming strings. + </summary> + <remarks> + <para> + Utility class for transforming strings. + </para> + </remarks> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.Util.Transform.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:log4net.Util.Transform"/> class. + </summary> + <remarks> + <para> + Uses a private access modifier to prevent instantiation of this class. + </para> + </remarks> + </member> + <member name="M:log4net.Util.Transform.WriteEscapedXmlString(System.Xml.XmlWriter,System.String,System.String)"> + <summary> + Write a string to an <see cref="T:System.Xml.XmlWriter"/> + </summary> + <param name="writer">the writer to write to</param> + <param name="textData">the string to write</param> + <param name="invalidCharReplacement">The string to replace non XML compliant chars with</param> + <remarks> + <para> + The test is escaped either using XML escape entities + or using CDATA sections. + </para> + </remarks> + </member> + <member name="M:log4net.Util.Transform.MaskXmlInvalidCharacters(System.String,System.String)"> + <summary> + Replace invalid XML characters in text string + </summary> + <param name="textData">the XML text input string</param> + <param name="mask">the string to use in place of invalid characters</param> + <returns>A string that does not contain invalid XML characters.</returns> + <remarks> + <para> + Certain Unicode code points are not allowed in the XML InfoSet, for + details see: <a href="http://www.w3.org/TR/REC-xml/#charsets">http://www.w3.org/TR/REC-xml/#charsets</a>. + </para> + <para> + This method replaces any illegal characters in the input string + with the mask string specified. + </para> + </remarks> + </member> + <member name="M:log4net.Util.Transform.CountSubstrings(System.String,System.String)"> + <summary> + Count the number of times that the substring occurs in the text + </summary> + <param name="text">the text to search</param> + <param name="substring">the substring to find</param> + <returns>the number of times the substring occurs in the text</returns> + <remarks> + <para> + The substring is assumed to be non repeating within itself. + </para> + </remarks> + </member> + <member name="F:log4net.Util.Transform.INVALIDCHARS"> + <summary> + Characters illegal in XML 1.0 + </summary> + </member> + <member name="T:log4net.Util.WindowsSecurityContext"> + <summary> + Impersonate a Windows Account + </summary> + <remarks> + <para> + This <see cref="T:log4net.Core.SecurityContext"/> impersonates a Windows account. + </para> + <para> + How the impersonation is done depends on the value of <see cref="M:log4net.Util.WindowsSecurityContext.Impersonate(System.Object)"/>. + This allows the context to either impersonate a set of user credentials specified + using username, domain name and password or to revert to the process credentials. + </para> + </remarks> + </member> + <member name="M:log4net.Util.WindowsSecurityContext.#ctor"> + <summary> + Default constructor + </summary> + <remarks> + <para> + Default constructor + </para> + </remarks> + </member> + <member name="M:log4net.Util.WindowsSecurityContext.ActivateOptions"> + <summary> + Initialize the SecurityContext based on the options set. + </summary> + <remarks> + <para> + This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object + activation scheme. The <see cref="M:log4net.Util.WindowsSecurityContext.ActivateOptions"/> method must + be called on this object after the configuration properties have + been set. Until <see cref="M:log4net.Util.WindowsSecurityContext.ActivateOptions"/> is called this + object is in an undefined state and must not be used. + </para> + <para> + If any of the configuration properties are modified then + <see cref="M:log4net.Util.WindowsSecurityContext.ActivateOptions"/> must be called again. + </para> + <para> + The security context will try to Logon the specified user account and + capture a primary token for impersonation. + </para> + </remarks> + <exception cref="T:System.ArgumentNullException">The required <see cref="P:log4net.Util.WindowsSecurityContext.UserName"/>, + <see cref="P:log4net.Util.WindowsSecurityContext.DomainName"/> or <see cref="P:log4net.Util.WindowsSecurityContext.Password"/> properties were not specified.</exception> + </member> + <member name="M:log4net.Util.WindowsSecurityContext.Impersonate(System.Object)"> + <summary> + Impersonate the Windows account specified by the <see cref="P:log4net.Util.WindowsSecurityContext.UserName"/> and <see cref="P:log4net.Util.WindowsSecurityContext.DomainName"/> properties. + </summary> + <param name="state">caller provided state</param> + <returns> + An <see cref="T:System.IDisposable"/> instance that will revoke the impersonation of this SecurityContext + </returns> + <remarks> + <para> + Depending on the <see cref="P:log4net.Util.WindowsSecurityContext.Credentials"/> property either + impersonate a user using credentials supplied or revert + to the process credentials. + </para> + </remarks> + </member> + <member name="M:log4net.Util.WindowsSecurityContext.LogonUser(System.String,System.String,System.String)"> + <summary> + Create a <see cref="T:System.Security.Principal.WindowsIdentity"/> given the userName, domainName and password. + </summary> + <param name="userName">the user name</param> + <param name="domainName">the domain name</param> + <param name="password">the password</param> + <returns>the <see cref="T:System.Security.Principal.WindowsIdentity"/> for the account specified</returns> + <remarks> + <para> + Uses the Windows API call LogonUser to get a principal token for the account. This + token is used to initialize the WindowsIdentity. + </para> + </remarks> + </member> + <member name="P:log4net.Util.WindowsSecurityContext.Credentials"> + <summary> + Gets or sets the impersonation mode for this security context + </summary> + <value> + The impersonation mode for this security context + </value> + <remarks> + <para> + Impersonate either a user with user credentials or + revert this thread to the credentials of the process. + The value is one of the <see cref="T:log4net.Util.WindowsSecurityContext.ImpersonationMode"/> + enum. + </para> + <para> + The default value is <see cref="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.User"/> + </para> + <para> + When the mode is set to <see cref="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.User"/> + the user's credentials are established using the + <see cref="P:log4net.Util.WindowsSecurityContext.UserName"/>, <see cref="P:log4net.Util.WindowsSecurityContext.DomainName"/> and <see cref="P:log4net.Util.WindowsSecurityContext.Password"/> + values. + </para> + <para> + When the mode is set to <see cref="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.Process"/> + no other properties need to be set. If the calling thread is + impersonating then it will be reverted back to the process credentials. + </para> + </remarks> + </member> + <member name="P:log4net.Util.WindowsSecurityContext.UserName"> + <summary> + Gets or sets the Windows username for this security context + </summary> + <value> + The Windows username for this security context + </value> + <remarks> + <para> + This property must be set if <see cref="P:log4net.Util.WindowsSecurityContext.Credentials"/> + is set to <see cref="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.User"/> (the default setting). + </para> + </remarks> + </member> + <member name="P:log4net.Util.WindowsSecurityContext.DomainName"> + <summary> + Gets or sets the Windows domain name for this security context + </summary> + <value> + The Windows domain name for this security context + </value> + <remarks> + <para> + The default value for <see cref="P:log4net.Util.WindowsSecurityContext.DomainName"/> is the local machine name + taken from the <see cref="P:System.Environment.MachineName"/> property. + </para> + <para> + This property must be set if <see cref="P:log4net.Util.WindowsSecurityContext.Credentials"/> + is set to <see cref="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.User"/> (the default setting). + </para> + </remarks> + </member> + <member name="P:log4net.Util.WindowsSecurityContext.Password"> + <summary> + Sets the password for the Windows account specified by the <see cref="P:log4net.Util.WindowsSecurityContext.UserName"/> and <see cref="P:log4net.Util.WindowsSecurityContext.DomainName"/> properties. + </summary> + <value> + The password for the Windows account specified by the <see cref="P:log4net.Util.WindowsSecurityContext.UserName"/> and <see cref="P:log4net.Util.WindowsSecurityContext.DomainName"/> properties. + </value> + <remarks> + <para> + This property must be set if <see cref="P:log4net.Util.WindowsSecurityContext.Credentials"/> + is set to <see cref="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.User"/> (the default setting). + </para> + </remarks> + </member> + <member name="T:log4net.Util.WindowsSecurityContext.ImpersonationMode"> + <summary> + The impersonation modes for the <see cref="T:log4net.Util.WindowsSecurityContext"/> + </summary> + <remarks> + <para> + See the <see cref="P:log4net.Util.WindowsSecurityContext.Credentials"/> property for + details. + </para> + </remarks> + </member> + <member name="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.User"> + <summary> + Impersonate a user using the credentials supplied + </summary> + </member> + <member name="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.Process"> + <summary> + Revert this the thread to the credentials of the process + </summary> + </member> + <member name="T:log4net.Util.WindowsSecurityContext.DisposableImpersonationContext"> + <summary> + Adds <see cref="T:System.IDisposable"/> to <see cref="T:System.Security.Principal.WindowsImpersonationContext"/> + </summary> + <remarks> + <para> + Helper class to expose the <see cref="T:System.Security.Principal.WindowsImpersonationContext"/> + through the <see cref="T:System.IDisposable"/> interface. + </para> + </remarks> + </member> + <member name="M:log4net.Util.WindowsSecurityContext.DisposableImpersonationContext.#ctor(System.Security.Principal.WindowsImpersonationContext)"> + <summary> + Constructor + </summary> + <param name="impersonationContext">the impersonation context being wrapped</param> + <remarks> + <para> + Constructor + </para> + </remarks> + </member> + <member name="M:log4net.Util.WindowsSecurityContext.DisposableImpersonationContext.Dispose"> + <summary> + Revert the impersonation + </summary> + <remarks> + <para> + Revert the impersonation + </para> + </remarks> + </member> + <member name="T:log4net.GlobalContext"> + <summary> + The log4net Global Context. + </summary> + <remarks> + <para> + The <c>GlobalContext</c> provides a location for global debugging + information to be stored. + </para> + <para> + The global context has a properties map and these properties can + be included in the output of log messages. The <see cref="T:log4net.Layout.PatternLayout"/> + supports selecting and outputing these properties. + </para> + <para> + By default the <c>log4net:HostName</c> property is set to the name of + the current machine. + </para> + </remarks> + <example> + <code lang="C#"> + GlobalContext.Properties["hostname"] = Environment.MachineName; + </code> + </example> + <threadsafety static="true" instance="true"/> + <author>Nicko Cadell</author> + </member> + <member name="M:log4net.GlobalContext.#ctor"> + <summary> + Private Constructor. + </summary> + <remarks> + Uses a private access modifier to prevent instantiation of this class. + </remarks> + </member> + <member name="F:log4net.GlobalContext.s_properties"> + <summary> + The global context properties instance + </summary> + </member> + <member name="P:log4net.GlobalContext.Properties"> + <summary> + The global properties map. + </summary> + <value> + The global properties map. + </value> + <remarks> + <para> + The global properties map. + </para> + </remarks> + </member> + <member name="T:log4net.AssemblyInfo"> + <summary> + Provides information about the environment the assembly has + been built for. + </summary> + </member> + <member name="F:log4net.AssemblyInfo.Version"> + <summary>Version of the assembly</summary> + </member> + <member name="F:log4net.AssemblyInfo.TargetFrameworkVersion"> + <summary>Version of the framework targeted</summary> + </member> + <member name="F:log4net.AssemblyInfo.TargetFramework"> + <summary>Type of framework targeted</summary> + </member> + <member name="F:log4net.AssemblyInfo.ClientProfile"> + <summary>Does it target a client profile?</summary> + </member> + <member name="P:log4net.AssemblyInfo.Info"> + <summary> + Identifies the version and target for this assembly. + </summary> + </member> + <member name="T:log4net.LogicalThreadContext"> + <summary> + The log4net Logical Thread Context. + </summary> + <remarks> + <para> + The <c>LogicalThreadContext</c> provides a location for <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/> specific debugging + information to be stored. + The <c>LogicalThreadContext</c> properties override any <see cref="T:log4net.ThreadContext"/> or <see cref="T:log4net.GlobalContext"/> + properties with the same name. + </para> + <para> + The Logical Thread Context has a properties map and a stack. + The properties and stack can + be included in the output of log messages. The <see cref="T:log4net.Layout.PatternLayout"/> + supports selecting and outputting these properties. + </para> + <para> + The Logical Thread Context provides a diagnostic context for the current call context. + This is an instrument for distinguishing interleaved log + output from different sources. Log output is typically interleaved + when a server handles multiple clients near-simultaneously. + </para> + <para> + The Logical Thread Context is managed on a per <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/> basis. + </para> + <para> + The <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/> requires a link time + <see cref="T:System.Security.Permissions.SecurityPermission"/> for the + <see cref="F:System.Security.Permissions.SecurityPermissionFlag.Infrastructure"/>. + If the calling code does not have this permission then this context will be disabled. + It will not store any property values set on it. + </para> + </remarks> + <example>Example of using the thread context properties to store a username. + <code lang="C#"> + LogicalThreadContext.Properties["user"] = userName; + log.Info("This log message has a LogicalThreadContext Property called 'user'"); + </code> + </example> + <example>Example of how to push a message into the context stack + <code lang="C#"> + using(LogicalThreadContext.Stacks["LDC"].Push("my context message")) + { + log.Info("This log message has a LogicalThreadContext Stack message that includes 'my context message'"); + + } // at the end of the using block the message is automatically popped + </code> + </example> + <threadsafety static="true" instance="true"/> + <author>Nicko Cadell</author> + </member> + <member name="M:log4net.LogicalThreadContext.#ctor"> + <summary> + Private Constructor. + </summary> + <remarks> + <para> + Uses a private access modifier to prevent instantiation of this class. + </para> + </remarks> + </member> + <member name="F:log4net.LogicalThreadContext.s_properties"> + <summary> + The thread context properties instance + </summary> + </member> + <member name="F:log4net.LogicalThreadContext.s_stacks"> + <summary> + The thread context stacks instance + </summary> + </member> + <member name="P:log4net.LogicalThreadContext.Properties"> + <summary> + The thread properties map + </summary> + <value> + The thread properties map + </value> + <remarks> + <para> + The <c>LogicalThreadContext</c> properties override any <see cref="T:log4net.ThreadContext"/> + or <see cref="T:log4net.GlobalContext"/> properties with the same name. + </para> + </remarks> + </member> + <member name="P:log4net.LogicalThreadContext.Stacks"> + <summary> + The thread stacks + </summary> + <value> + stack map + </value> + <remarks> + <para> + The logical thread stacks. + </para> + </remarks> + </member> + <member name="T:log4net.LogManager"> + <summary> + This class is used by client applications to request logger instances. + </summary> + <remarks> + <para> + This class has static methods that are used by a client to request + a logger instance. The <see cref="M:GetLogger(string)"/> method is + used to retrieve a logger. + </para> + <para> + See the <see cref="T:log4net.ILog"/> interface for more details. + </para> + </remarks> + <example>Simple example of logging messages + <code lang="C#"> + ILog log = LogManager.GetLogger("application-log"); + + log.Info("Application Start"); + log.Debug("This is a debug message"); + + if (log.IsDebugEnabled) + { + log.Debug("This is another debug message"); + } + </code> + </example> + <threadsafety static="true" instance="true"/> + <seealso cref="T:log4net.ILog"/> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.LogManager.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:log4net.LogManager"/> class. + </summary> + <remarks> + Uses a private access modifier to prevent instantiation of this class. + </remarks> + </member> + <member name="M:log4net.LogManager.Exists(System.String)"> + <overloads>Returns the named logger if it exists.</overloads> + <summary> + Returns the named logger if it exists. + </summary> + <remarks> + <para> + If the named logger exists (in the default repository) then it + returns a reference to the logger, otherwise it returns <c>null</c>. + </para> + </remarks> + <param name="name">The fully qualified logger name to look for.</param> + <returns>The logger found, or <c>null</c> if no logger could be found.</returns> + </member> + <member name="M:log4net.LogManager.Exists(System.String,System.String)"> + <summary> + Returns the named logger if it exists. + </summary> + <remarks> + <para> + If the named logger exists (in the specified repository) then it + returns a reference to the logger, otherwise it returns + <c>null</c>. + </para> + </remarks> + <param name="repository">The repository to lookup in.</param> + <param name="name">The fully qualified logger name to look for.</param> + <returns> + The logger found, or <c>null</c> if the logger doesn't exist in the specified + repository. + </returns> + </member> + <member name="M:log4net.LogManager.Exists(System.Reflection.Assembly,System.String)"> + <summary> + Returns the named logger if it exists. + </summary> + <remarks> + <para> + If the named logger exists (in the repository for the specified assembly) then it + returns a reference to the logger, otherwise it returns + <c>null</c>. + </para> + </remarks> + <param name="repositoryAssembly">The assembly to use to lookup the repository.</param> + <param name="name">The fully qualified logger name to look for.</param> + <returns> + The logger, or <c>null</c> if the logger doesn't exist in the specified + assembly's repository. + </returns> + </member> + <member name="M:log4net.LogManager.GetCurrentLoggers"> + <overloads>Get the currently defined loggers.</overloads> + <summary> + Returns all the currently defined loggers in the default repository. + </summary> + <remarks> + <para>The root logger is <b>not</b> included in the returned array.</para> + </remarks> + <returns>All the defined loggers.</returns> + </member> + <member name="M:log4net.LogManager.GetCurrentLoggers(System.String)"> + <summary> + Returns all the currently defined loggers in the specified repository. + </summary> + <param name="repository">The repository to lookup in.</param> + <remarks> + The root logger is <b>not</b> included in the returned array. + </remarks> + <returns>All the defined loggers.</returns> + </member> + <member name="M:log4net.LogManager.GetCurrentLoggers(System.Reflection.Assembly)"> + <summary> + Returns all the currently defined loggers in the specified assembly's repository. + </summary> + <param name="repositoryAssembly">The assembly to use to lookup the repository.</param> + <remarks> + The root logger is <b>not</b> included in the returned array. + </remarks> + <returns>All the defined loggers.</returns> + </member> + <member name="M:log4net.LogManager.GetLogger(System.String)"> + <overloads>Get or create a logger.</overloads> + <summary> + Retrieves or creates a named logger. + </summary> + <remarks> + <para> + Retrieves a logger named as the <paramref name="name"/> + parameter. If the named logger already exists, then the + existing instance will be returned. Otherwise, a new instance is + created. + </para> + <para>By default, loggers do not have a set level but inherit + it from the hierarchy. This is one of the central features of + log4net. + </para> + </remarks> + <param name="name">The name of the logger to retrieve.</param> + <returns>The logger with the name specified.</returns> + </member> + <member name="M:log4net.LogManager.GetLogger(System.String,System.String)"> + <summary> + Retrieves or creates a named logger. + </summary> + <remarks> + <para> + Retrieve a logger named as the <paramref name="name"/> + parameter. If the named logger already exists, then the + existing instance will be returned. Otherwise, a new instance is + created. + </para> + <para> + By default, loggers do not have a set level but inherit + it from the hierarchy. This is one of the central features of + log4net. + </para> + </remarks> + <param name="repository">The repository to lookup in.</param> + <param name="name">The name of the logger to retrieve.</param> + <returns>The logger with the name specified.</returns> + </member> + <member name="M:log4net.LogManager.GetLogger(System.Reflection.Assembly,System.String)"> + <summary> + Retrieves or creates a named logger. + </summary> + <remarks> + <para> + Retrieve a logger named as the <paramref name="name"/> + parameter. If the named logger already exists, then the + existing instance will be returned. Otherwise, a new instance is + created. + </para> + <para> + By default, loggers do not have a set level but inherit + it from the hierarchy. This is one of the central features of + log4net. + </para> + </remarks> + <param name="repositoryAssembly">The assembly to use to lookup the repository.</param> + <param name="name">The name of the logger to retrieve.</param> + <returns>The logger with the name specified.</returns> + </member> + <member name="M:log4net.LogManager.GetLogger(System.Type)"> + <summary> + Shorthand for <see cref="M:LogManager.GetLogger(string)"/>. + </summary> + <remarks> + Get the logger for the fully qualified name of the type specified. + </remarks> + <param name="type">The full name of <paramref name="type"/> will be used as the name of the logger to retrieve.</param> + <returns>The logger with the name specified.</returns> + </member> + <member name="M:log4net.LogManager.GetLogger(System.String,System.Type)"> + <summary> + Shorthand for <see cref="M:LogManager.GetLogger(string)"/>. + </summary> + <remarks> + Gets the logger for the fully qualified name of the type specified. + </remarks> + <param name="repository">The repository to lookup in.</param> + <param name="type">The full name of <paramref name="type"/> will be used as the name of the logger to retrieve.</param> + <returns>The logger with the name specified.</returns> + </member> + <member name="M:log4net.LogManager.GetLogger(System.Reflection.Assembly,System.Type)"> + <summary> + Shorthand for <see cref="M:LogManager.GetLogger(string)"/>. + </summary> + <remarks> + Gets the logger for the fully qualified name of the type specified. + </remarks> + <param name="repositoryAssembly">The assembly to use to lookup the repository.</param> + <param name="type">The full name of <paramref name="type"/> will be used as the name of the logger to retrieve.</param> + <returns>The logger with the name specified.</returns> + </member> + <member name="M:log4net.LogManager.Shutdown"> + <summary> + Shuts down the log4net system. + </summary> + <remarks> + <para> + Calling this method will <b>safely</b> close and remove all + appenders in all the loggers including root contained in all the + default repositories. + </para> + <para> + Some appenders need to be closed before the application exists. + Otherwise, pending logging events might be lost. + </para> + <para>The <c>shutdown</c> method is careful to close nested + appenders before closing regular appenders. This is allows + configurations where a regular appender is attached to a logger + and again to a nested appender. + </para> + </remarks> + </member> + <member name="M:log4net.LogManager.ShutdownRepository"> + <overloads>Shutdown a logger repository.</overloads> + <summary> + Shuts down the default repository. + </summary> + <remarks> + <para> + Calling this method will <b>safely</b> close and remove all + appenders in all the loggers including root contained in the + default repository. + </para> + <para>Some appenders need to be closed before the application exists. + Otherwise, pending logging events might be lost. + </para> + <para>The <c>shutdown</c> method is careful to close nested + appenders before closing regular appenders. This is allows + configurations where a regular appender is attached to a logger + and again to a nested appender. + </para> + </remarks> + </member> + <member name="M:log4net.LogManager.ShutdownRepository(System.String)"> + <summary> + Shuts down the repository for the repository specified. + </summary> + <remarks> + <para> + Calling this method will <b>safely</b> close and remove all + appenders in all the loggers including root contained in the + <paramref name="repository"/> specified. + </para> + <para> + Some appenders need to be closed before the application exists. + Otherwise, pending logging events might be lost. + </para> + <para>The <c>shutdown</c> method is careful to close nested + appenders before closing regular appenders. This is allows + configurations where a regular appender is attached to a logger + and again to a nested appender. + </para> + </remarks> + <param name="repository">The repository to shutdown.</param> + </member> + <member name="M:log4net.LogManager.ShutdownRepository(System.Reflection.Assembly)"> + <summary> + Shuts down the repository specified. + </summary> + <remarks> + <para> + Calling this method will <b>safely</b> close and remove all + appenders in all the loggers including root contained in the + repository. The repository is looked up using + the <paramref name="repositoryAssembly"/> specified. + </para> + <para> + Some appenders need to be closed before the application exists. + Otherwise, pending logging events might be lost. + </para> + <para> + The <c>shutdown</c> method is careful to close nested + appenders before closing regular appenders. This is allows + configurations where a regular appender is attached to a logger + and again to a nested appender. + </para> + </remarks> + <param name="repositoryAssembly">The assembly to use to lookup the repository.</param> + </member> + <member name="M:log4net.LogManager.ResetConfiguration"> + <overloads>Reset the configuration of a repository</overloads> + <summary> + Resets all values contained in this repository instance to their defaults. + </summary> + <remarks> + <para> + Resets all values contained in the repository instance to their + defaults. This removes all appenders from all loggers, sets + the level of all non-root loggers to <c>null</c>, + sets their additivity flag to <c>true</c> and sets the level + of the root logger to <see cref="F:log4net.Core.Level.Debug"/>. Moreover, + message disabling is set to its default "off" value. + </para> + </remarks> + </member> + <member name="M:log4net.LogManager.ResetConfiguration(System.String)"> + <summary> + Resets all values contained in this repository instance to their defaults. + </summary> + <remarks> + <para> + Reset all values contained in the repository instance to their + defaults. This removes all appenders from all loggers, sets + the level of all non-root loggers to <c>null</c>, + sets their additivity flag to <c>true</c> and sets the level + of the root logger to <see cref="F:log4net.Core.Level.Debug"/>. Moreover, + message disabling is set to its default "off" value. + </para> + </remarks> + <param name="repository">The repository to reset.</param> + </member> + <member name="M:log4net.LogManager.ResetConfiguration(System.Reflection.Assembly)"> + <summary> + Resets all values contained in this repository instance to their defaults. + </summary> + <remarks> + <para> + Reset all values contained in the repository instance to their + defaults. This removes all appenders from all loggers, sets + the level of all non-root loggers to <c>null</c>, + sets their additivity flag to <c>true</c> and sets the level + of the root logger to <see cref="F:log4net.Core.Level.Debug"/>. Moreover, + message disabling is set to its default "off" value. + </para> + </remarks> + <param name="repositoryAssembly">The assembly to use to lookup the repository to reset.</param> + </member> + <member name="M:log4net.LogManager.GetLoggerRepository"> + <overloads>Get the logger repository.</overloads> + <summary> + Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance. + </summary> + <remarks> + <para> + Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified + by the callers assembly (<see cref="M:Assembly.GetCallingAssembly()"/>). + </para> + </remarks> + <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> instance for the default repository.</returns> + </member> + <member name="M:log4net.LogManager.GetLoggerRepository(System.String)"> + <summary> + Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance. + </summary> + <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns> + <remarks> + <para> + Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified + by the <paramref name="repository"/> argument. + </para> + </remarks> + <param name="repository">The repository to lookup in.</param> + </member> + <member name="M:log4net.LogManager.GetLoggerRepository(System.Reflection.Assembly)"> + <summary> + Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance. + </summary> + <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns> + <remarks> + <para> + Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified + by the <paramref name="repositoryAssembly"/> argument. + </para> + </remarks> + <param name="repositoryAssembly">The assembly to use to lookup the repository.</param> + </member> + <member name="M:log4net.LogManager.GetRepository"> + <overloads>Get a logger repository.</overloads> + <summary> + Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance. + </summary> + <remarks> + <para> + Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified + by the callers assembly (<see cref="M:Assembly.GetCallingAssembly()"/>). + </para> + </remarks> + <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> instance for the default repository.</returns> + </member> + <member name="M:log4net.LogManager.GetRepository(System.String)"> + <summary> + Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance. + </summary> + <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns> + <remarks> + <para> + Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified + by the <paramref name="repository"/> argument. + </para> + </remarks> + <param name="repository">The repository to lookup in.</param> + </member> + <member name="M:log4net.LogManager.GetRepository(System.Reflection.Assembly)"> + <summary> + Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance. + </summary> + <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns> + <remarks> + <para> + Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified + by the <paramref name="repositoryAssembly"/> argument. + </para> + </remarks> + <param name="repositoryAssembly">The assembly to use to lookup the repository.</param> + </member> + <member name="M:log4net.LogManager.CreateDomain(System.Type)"> + <overloads>Create a domain</overloads> + <summary> + Creates a repository with the specified repository type. + </summary> + <remarks> + <para> + <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b> + </para> + <para> + The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository + specified such that a call to <see cref="M:GetRepository()"/> will return + the same repository instance. + </para> + </remarks> + <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/> + and has a no arg constructor. An instance of this type will be created to act + as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param> + <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns> + </member> + <member name="M:log4net.LogManager.CreateRepository(System.Type)"> + <overloads>Create a logger repository.</overloads> + <summary> + Creates a repository with the specified repository type. + </summary> + <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/> + and has a no arg constructor. An instance of this type will be created to act + as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param> + <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns> + <remarks> + <para> + The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository + specified such that a call to <see cref="M:GetRepository()"/> will return + the same repository instance. + </para> + </remarks> + </member> + <member name="M:log4net.LogManager.CreateDomain(System.String)"> + <summary> + Creates a repository with the specified name. + </summary> + <remarks> + <para> + <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b> + </para> + <para> + Creates the default type of <see cref="T:log4net.Repository.ILoggerRepository"/> which is a + <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> object. + </para> + <para> + The <paramref name="repository"/> name must be unique. Repositories cannot be redefined. + An <see cref="T:System.Exception"/> will be thrown if the repository already exists. + </para> + </remarks> + <param name="repository">The name of the repository, this must be unique amongst repositories.</param> + <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns> + <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception> + </member> + <member name="M:log4net.LogManager.CreateRepository(System.String)"> + <summary> + Creates a repository with the specified name. + </summary> + <remarks> + <para> + Creates the default type of <see cref="T:log4net.Repository.ILoggerRepository"/> which is a + <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> object. + </para> + <para> + The <paramref name="repository"/> name must be unique. Repositories cannot be redefined. + An <see cref="T:System.Exception"/> will be thrown if the repository already exists. + </para> + </remarks> + <param name="repository">The name of the repository, this must be unique amongst repositories.</param> + <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns> + <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception> + </member> + <member name="M:log4net.LogManager.CreateDomain(System.String,System.Type)"> + <summary> + Creates a repository with the specified name and repository type. + </summary> + <remarks> + <para> + <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b> + </para> + <para> + The <paramref name="repository"/> name must be unique. Repositories cannot be redefined. + An <see cref="T:System.Exception"/> will be thrown if the repository already exists. + </para> + </remarks> + <param name="repository">The name of the repository, this must be unique to the repository.</param> + <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/> + and has a no arg constructor. An instance of this type will be created to act + as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param> + <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns> + <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception> + </member> + <member name="M:log4net.LogManager.CreateRepository(System.String,System.Type)"> + <summary> + Creates a repository with the specified name and repository type. + </summary> + <remarks> + <para> + The <paramref name="repository"/> name must be unique. Repositories cannot be redefined. + An <see cref="T:System.Exception"/> will be thrown if the repository already exists. + </para> + </remarks> + <param name="repository">The name of the repository, this must be unique to the repository.</param> + <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/> + and has a no arg constructor. An instance of this type will be created to act + as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param> + <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns> + <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception> + </member> + <member name="M:log4net.LogManager.CreateDomain(System.Reflection.Assembly,System.Type)"> + <summary> + Creates a repository for the specified assembly and repository type. + </summary> + <remarks> + <para> + <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b> + </para> + <para> + The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository + specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the + same assembly specified will return the same repository instance. + </para> + </remarks> + <param name="repositoryAssembly">The assembly to use to get the name of the repository.</param> + <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/> + and has a no arg constructor. An instance of this type will be created to act + as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param> + <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns> + </member> + <member name="M:log4net.LogManager.CreateRepository(System.Reflection.Assembly,System.Type)"> + <summary> + Creates a repository for the specified assembly and repository type. + </summary> + <remarks> + <para> + The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository + specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the + same assembly specified will return the same repository instance. + </para> + </remarks> + <param name="repositoryAssembly">The assembly to use to get the name of the repository.</param> + <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/> + and has a no arg constructor. An instance of this type will be created to act + as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param> + <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns> + </member> + <member name="M:log4net.LogManager.GetAllRepositories"> + <summary> + Gets the list of currently defined repositories. + </summary> + <remarks> + <para> + Get an array of all the <see cref="T:log4net.Repository.ILoggerRepository"/> objects that have been created. + </para> + </remarks> + <returns>An array of all the known <see cref="T:log4net.Repository.ILoggerRepository"/> objects.</returns> + </member> + <member name="M:log4net.LogManager.WrapLogger(log4net.Core.ILogger)"> + <summary> + Looks up the wrapper object for the logger specified. + </summary> + <param name="logger">The logger to get the wrapper for.</param> + <returns>The wrapper for the logger specified.</returns> + </member> + <member name="M:log4net.LogManager.WrapLoggers(log4net.Core.ILogger[])"> + <summary> + Looks up the wrapper objects for the loggers specified. + </summary> + <param name="loggers">The loggers to get the wrappers for.</param> + <returns>The wrapper objects for the loggers specified.</returns> + </member> + <member name="M:log4net.LogManager.WrapperCreationHandler(log4net.Core.ILogger)"> + <summary> + Create the <see cref="T:log4net.Core.ILoggerWrapper"/> objects used by + this manager. + </summary> + <param name="logger">The logger to wrap.</param> + <returns>The wrapper for the logger specified.</returns> + </member> + <member name="F:log4net.LogManager.s_wrapperMap"> + <summary> + The wrapper map to use to hold the <see cref="T:log4net.Core.LogImpl"/> objects. + </summary> + </member> + <member name="T:log4net.MDC"> + <summary> + Implementation of Mapped Diagnostic Contexts. + </summary> + <remarks> + <note> + <para> + The MDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Properties"/>. + The current MDC implementation forwards to the <c>ThreadContext.Properties</c>. + </para> + </note> + <para> + The MDC class is similar to the <see cref="T:log4net.NDC"/> class except that it is + based on a map instead of a stack. It provides <i>mapped + diagnostic contexts</i>. A <i>Mapped Diagnostic Context</i>, or + MDC in short, is an instrument for distinguishing interleaved log + output from different sources. Log output is typically interleaved + when a server handles multiple clients near-simultaneously. + </para> + <para> + The MDC is managed on a per thread basis. + </para> + </remarks> + <threadsafety static="true" instance="true"/> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.MDC.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:log4net.MDC"/> class. + </summary> + <remarks> + Uses a private access modifier to prevent instantiation of this class. + </remarks> + </member> + <member name="M:log4net.MDC.Get(System.String)"> + <summary> + Gets the context value identified by the <paramref name="key"/> parameter. + </summary> + <param name="key">The key to lookup in the MDC.</param> + <returns>The string value held for the key, or a <c>null</c> reference if no corresponding value is found.</returns> + <remarks> + <note> + <para> + The MDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Properties"/>. + The current MDC implementation forwards to the <c>ThreadContext.Properties</c>. + </para> + </note> + <para> + If the <paramref name="key"/> parameter does not look up to a + previously defined context then <c>null</c> will be returned. + </para> + </remarks> + </member> + <member name="M:log4net.MDC.Set(System.String,System.String)"> + <summary> + Add an entry to the MDC + </summary> + <param name="key">The key to store the value under.</param> + <param name="value">The value to store.</param> + <remarks> + <note> + <para> + The MDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Properties"/>. + The current MDC implementation forwards to the <c>ThreadContext.Properties</c>. + </para> + </note> + <para> + Puts a context value (the <paramref name="value"/> parameter) as identified + with the <paramref name="key"/> parameter into the current thread's + context map. + </para> + <para> + If a value is already defined for the <paramref name="key"/> + specified then the value will be replaced. If the <paramref name="value"/> + is specified as <c>null</c> then the key value mapping will be removed. + </para> + </remarks> + </member> + <member name="M:log4net.MDC.Remove(System.String)"> + <summary> + Removes the key value mapping for the key specified. + </summary> + <param name="key">The key to remove.</param> + <remarks> + <note> + <para> + The MDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Properties"/>. + The current MDC implementation forwards to the <c>ThreadContext.Properties</c>. + </para> + </note> + <para> + Remove the specified entry from this thread's MDC + </para> + </remarks> + </member> + <member name="M:log4net.MDC.Clear"> + <summary> + Clear all entries in the MDC + </summary> + <remarks> + <note> + <para> + The MDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Properties"/>. + The current MDC implementation forwards to the <c>ThreadContext.Properties</c>. + </para> + </note> + <para> + Remove all the entries from this thread's MDC + </para> + </remarks> + </member> + <member name="T:log4net.NDC"> + <summary> + Implementation of Nested Diagnostic Contexts. + </summary> + <remarks> + <note> + <para> + The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>. + The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>. + </para> + </note> + <para> + A Nested Diagnostic Context, or NDC in short, is an instrument + to distinguish interleaved log output from different sources. Log + output is typically interleaved when a server handles multiple + clients near-simultaneously. + </para> + <para> + Interleaved log output can still be meaningful if each log entry + from different contexts had a distinctive stamp. This is where NDCs + come into play. + </para> + <para> + Note that NDCs are managed on a per thread basis. The NDC class + is made up of static methods that operate on the context of the + calling thread. + </para> + </remarks> + <example>How to push a message into the context + <code lang="C#"> + using(NDC.Push("my context message")) + { + ... all log calls will have 'my context message' included ... + + } // at the end of the using block the message is automatically removed + </code> + </example> + <threadsafety static="true" instance="true"/> + <author>Nicko Cadell</author> + <author>Gert Driesen</author> + </member> + <member name="M:log4net.NDC.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:log4net.NDC"/> class. + </summary> + <remarks> + Uses a private access modifier to prevent instantiation of this class. + </remarks> + </member> + <member name="M:log4net.NDC.Clear"> + <summary> + Clears all the contextual information held on the current thread. + </summary> + <remarks> + <note> + <para> + The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>. + The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>. + </para> + </note> + <para> + Clears the stack of NDC data held on the current thread. + </para> + </remarks> + </member> + <member name="M:log4net.NDC.CloneStack"> + <summary> + Creates a clone of the stack of context information. + </summary> + <returns>A clone of the context info for this thread.</returns> + <remarks> + <note> + <para> + The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>. + The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>. + </para> + </note> + <para> + The results of this method can be passed to the <see cref="M:log4net.NDC.Inherit(System.Collections.Stack)"/> + method to allow child threads to inherit the context of their + parent thread. + </para> + </remarks> + </member> + <member name="M:log4net.NDC.Inherit(System.Collections.Stack)"> + <summary> + Inherits the contextual information from another thread. + </summary> + <param name="stack">The context stack to inherit.</param> + <remarks> + <note> + <para> + The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>. + The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>. + </para> + </note> + <para> + This thread will use the context information from the stack + supplied. This can be used to initialize child threads with + the same contextual information as their parent threads. These + contexts will <b>NOT</b> be shared. Any further contexts that + are pushed onto the stack will not be visible to the other. + Call <see cref="M:log4net.NDC.CloneStack"/> to obtain a stack to pass to + this method. + </para> + </remarks> + </member> + <member name="M:log4net.NDC.Pop"> + <summary> + Removes the top context from the stack. + </summary> + <returns> + The message in the context that was removed from the top + of the stack. + </returns> + <remarks> + <note> + <para> + The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>. + The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>. + </para> + </note> + <para> + Remove the top context from the stack, and return + it to the caller. If the stack is empty then an + empty string (not <c>null</c>) is returned. + </para> + </remarks> + </member> + <member name="M:log4net.NDC.Push(System.String)"> + <summary> + Pushes a new context message. + </summary> + <param name="message">The new context message.</param> + <returns> + An <see cref="T:System.IDisposable"/> that can be used to clean up + the context stack. + </returns> + <remarks> + <note> + <para> + The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>. + The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>. + </para> + </note> + <para> + Pushes a new context onto the context stack. An <see cref="T:System.IDisposable"/> + is returned that can be used to clean up the context stack. This + can be easily combined with the <c>using</c> keyword to scope the + context. + </para> + </remarks> + <example>Simple example of using the <c>Push</c> method with the <c>using</c> keyword. + <code lang="C#"> + using(log4net.NDC.Push("NDC_Message")) + { + log.Warn("This should have an NDC message"); + } + </code> + </example> + </member> + <member name="M:log4net.NDC.Remove"> + <summary> + Removes the context information for this thread. It is + not required to call this method. + </summary> + <remarks> + <note> + <para> + The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>. + The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>. + </para> + </note> + <para> + This method is not implemented. + </para> + </remarks> + </member> + <member name="M:log4net.NDC.SetMaxDepth(System.Int32)"> + <summary> + Forces the stack depth to be at most <paramref name="maxDepth"/>. + </summary> + <param name="maxDepth">The maximum depth of the stack</param> + <remarks> + <note> + <para> + The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>. + The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>. + </para> + </note> + <para> + Forces the stack depth to be at most <paramref name="maxDepth"/>. + This may truncate the head of the stack. This only affects the + stack in the current thread. Also it does not prevent it from + growing, it only sets the maximum depth at the time of the + call. This can be used to return to a known context depth. + </para> + </remarks> + </member> + <member name="P:log4net.NDC.Depth"> + <summary> + Gets the current context depth. + </summary> + <value>The current context depth.</value> + <remarks> + <note> + <para> + The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>. + The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>. + </para> + </note> + <para> + The number of context values pushed onto the context stack. + </para> + <para> + Used to record the current depth of the context. This can then + be restored using the <see cref="M:log4net.NDC.SetMaxDepth(System.Int32)"/> method. + </para> + </remarks> + <seealso cref="M:log4net.NDC.SetMaxDepth(System.Int32)"/> + </member> + <member name="T:log4net.ThreadContext"> + <summary> + The log4net Thread Context. + </summary> + <remarks> + <para> + The <c>ThreadContext</c> provides a location for thread specific debugging + information to be stored. + The <c>ThreadContext</c> properties override any <see cref="T:log4net.GlobalContext"/> + properties with the same name. + </para> + <para> + The thread context has a properties map and a stack. + The properties and stack can + be included in the output of log messages. The <see cref="T:log4net.Layout.PatternLayout"/> + supports selecting and outputting these properties. + </para> + <para> + The Thread Context provides a diagnostic context for the current thread. + This is an instrument for distinguishing interleaved log + output from different sources. Log output is typically interleaved + when a server handles multiple clients near-simultaneously. + </para> + <para> + The Thread Context is managed on a per thread basis. + </para> + </remarks> + <example>Example of using the thread context properties to store a username. + <code lang="C#"> + ThreadContext.Properties["user"] = userName; + log.Info("This log message has a ThreadContext Property called 'user'"); + </code> + </example> + <example>Example of how to push a message into the context stack + <code lang="C#"> + using(ThreadContext.Stacks["NDC"].Push("my context message")) + { + log.Info("This log message has a ThreadContext Stack message that includes 'my context message'"); + + } // at the end of the using block the message is automatically popped + </code> + </example> + <threadsafety static="true" instance="true"/> + <author>Nicko Cadell</author> + </member> + <member name="M:log4net.ThreadContext.#ctor"> + <summary> + Private Constructor. + </summary> + <remarks> + <para> + Uses a private access modifier to prevent instantiation of this class. + </para> + </remarks> + </member> + <member name="F:log4net.ThreadContext.s_properties"> + <summary> + The thread context properties instance + </summary> + </member> + <member name="F:log4net.ThreadContext.s_stacks"> + <summary> + The thread context stacks instance + </summary> + </member> + <member name="P:log4net.ThreadContext.Properties"> + <summary> + The thread properties map + </summary> + <value> + The thread properties map + </value> + <remarks> + <para> + The <c>ThreadContext</c> properties override any <see cref="T:log4net.GlobalContext"/> + properties with the same name. + </para> + </remarks> + </member> + <member name="P:log4net.ThreadContext.Stacks"> + <summary> + The thread stacks + </summary> + <value> + stack map + </value> + <remarks> + <para> + The thread local stacks. + </para> + </remarks> + </member> + </members> +</doc> Index: DamClients/DamUI/trunk/release/Install_Version/DevExpress.XtraVerticalGrid.v12.2.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/DotSpatial.Mono.xml =================================================================== diff -u --- DamClients/DamUI/trunk/release/Install_Version/DotSpatial.Mono.xml (revision 0) +++ DamClients/DamUI/trunk/release/Install_Version/DotSpatial.Mono.xml (revision 2315) @@ -0,0 +1,8 @@ +<?xml version="1.0"?> +<doc> + <assembly> + <name>DotSpatial.Mono</name> + </assembly> + <members> + </members> +</doc> Index: DamClients/DamUI/trunk/release/Install_Version/vi-VN/DotSpatial.Projections.Forms.resources.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/DotSpatial.Data.xml =================================================================== diff -u --- DamClients/DamUI/trunk/release/Install_Version/DotSpatial.Data.xml (revision 0) +++ DamClients/DamUI/trunk/release/Install_Version/DotSpatial.Data.xml (revision 2315) @@ -0,0 +1,19164 @@ +<?xml version="1.0"?> +<doc> + <assembly> + <name>DotSpatial.Data</name> + </assembly> + <members> + <member name="T:DotSpatial.Data.Argb"> + <summary> + Tiny structure for storing A,R,G,B components of Color + </summary> + </member> + <member name="M:DotSpatial.Data.Argb.ByteRange(System.Int32)"> + <summary> + Returns an integer that ranges from 0 to 255. If value is larger than 255, the value will be equal to 255. + If the value is smaller than 255, it will be equal to 255. + </summary> + <param name="value">A Double value to convert.</param> + <returns>An integer ranging from 0 to 255</returns> + </member> + <member name="T:DotSpatial.Data.BinaryReaderWriterExtensions"> + <summary> + + </summary> + </member> + <member name="M:DotSpatial.Data.BinaryReaderWriterExtensions.Write``1(System.IO.BinaryWriter,``0)"> + <summary> + Writes the specified type. + </summary> + <typeparam name="T"></typeparam> + <param name="writer">The writer.</param> + <param name="num">The value.</param> + </member> + <member name="M:DotSpatial.Data.BinaryReaderWriterExtensions.Read``1(System.IO.BinaryReader)"> + <summary> + Reads the specified type. + </summary> + <typeparam name="T"></typeparam> + <param name="reader">The reader.</param> + <returns></returns> + </member> + <member name="T:DotSpatial.Data.DbaseLocaleRegistry"> + <summary> + A registry used to map CLR cultures and encodings to + dBase language driver id (LDID) encoding specifiers. + </summary> + <remarks> + Lookup values are taken from Esri's + <a href="http://downloads.esri.com/support/documentation/pad_/ArcPad_RefGuide_1105.pdf"> + ArcPad Reference Guide</a> + </remarks> + </member> + <member name="M:DotSpatial.Data.DbaseLocaleRegistry.GetCulture(System.Byte)"> + <summary> + Gets the <see cref="T:System.Globalization.CultureInfo"/> associated with the + given dBase LDID. + </summary> + <param name="dBaseEncoding"> + The language driver id (LDID) to get a CultureInfo for. + </param> + <returns> + A <see cref="T:System.Globalization.CultureInfo"/> which uses the encoding represented by + <paramref name="dBaseEncoding"/> by default. + </returns> + </member> + <member name="M:DotSpatial.Data.DbaseLocaleRegistry.GetEncoding(System.Byte)"> + <summary> + Gets the <see cref="T:System.Text.Encoding"/> which matches the + given dBase LDID. + </summary> + <param name="dBaseEncoding"> + The language driver id (LDID) to get the <see cref="T:System.Text.Encoding"/> for. + </param> + <returns> + An <see cref="T:System.Text.Encoding"/> which corresponds to the the + <paramref name="dBaseEncoding"/> code established by Esri. + </returns> + </member> + <member name="M:DotSpatial.Data.DbaseLocaleRegistry.GetLanguageDriverId(System.Text.Encoding)"> + <summary> + Gets a language driver id (LDID) for the given encoding. + </summary> + <param name="encoding">The Encoding used to lookup the LDID.</param> + <returns>A language driver code used to specify the encoding used to write text in the dBase file.</returns> + <remarks>0x57 (Windows ANSI) is returned as a default if there is no associated LDID for the given encoding.</remarks> + </member> + <member name="T:DotSpatial.Data.DbaseLocaleRegistry.CodePageChoice"> + <summary> + Specifies which code page to use in a <see cref="T:System.Globalization.TextInfo"/> + instance. + </summary> + </member> + <member name="T:DotSpatial.Data.DbaseLocaleRegistry.CultureWithEncoding"> + <summary> + Represents a culture and encoding pair. + </summary> + </member> + <member name="T:DotSpatial.Data.DisposeBase"> + <summary> + This base class tries to correctly implement disposable, and should help make the behaviors + more consistent across classes that inherit from this class. + </summary> + </member> + <member name="T:DotSpatial.Data.IDisposeLock"> + <summary> + Unlike forms that have a disposable life cycle with a clear chain of ownership, or purely managed + libraries that have in a built in reference counting system, disposable members in DotSpatial + require the ability to behave in some cases like a layer that should be removed from memory + as soon as it is removed from the map, and other times like a persistent object. The DisposeLock + concept works like an industrial lock-out system. Each additional lock increases the lock count. + When all users have released the lock, the IsDisposedLocked property will be false, and the next + action like a removal from the parent layers will properly dispose the item. Users may feel free + to add the lock in order to handle disposal on the layers themselves. These methods will not + actually prevent Dispose from functioning, but understand that calling dispose when there is an + IsDisposeLocked is true means that there will likely be a problem. + </summary> + </member> + <member name="M:DotSpatial.Data.IDisposeLock.LockDispose"> + <summary> + Locks dispose. This typically adds one instance of an internal reference counter. + </summary> + </member> + <member name="M:DotSpatial.Data.IDisposeLock.UnlockDispose"> + <summary> + Unlocks dispose. This typically removes one instance of an internal reference counter. + </summary> + </member> + <member name="P:DotSpatial.Data.IDisposeLock.IsDisposeLocked"> + <summary> + Gets a value indicating whether an existing reference is requesting that the object is not disposed of. + </summary> + </member> + <member name="M:DotSpatial.Data.DisposeBase.Dispose"> + <summary> + Disposes + </summary> + </member> + <member name="M:DotSpatial.Data.DisposeBase.LockDispose"> + <summary> + Adds one request or "reference count" for this item not to be disposed. When an owner is finished, + if this is 0, then dispose should be called. For now this does not prevent Dispose from being + called, it is simply for tracking purposes. + </summary> + </member> + <member name="M:DotSpatial.Data.DisposeBase.UnlockDispose"> + <summary> + Removes one reference or request to prevent an object from being automatically disposed. + </summary> + </member> + <member name="M:DotSpatial.Data.DisposeBase.Finalize"> + <summary> + Finalizes an instance of the <see cref="T:DotSpatial.Data.DisposeBase"/> class. + </summary> + </member> + <member name="M:DotSpatial.Data.DisposeBase.Dispose(System.Boolean)"> + <summary> + This is where the meat of the dispose work is done. Subclasses should call dispose on any disposable + members or internal members (presuming they are not dispose locked). + </summary> + <param name="isDisposing">True if the "Dispose" method was called instead of the destructor.</param> + </member> + <member name="P:DotSpatial.Data.DisposeBase.IsDisposed"> + <summary> + Gets a value indicating whether this instance has already had the Dispose method called on it. + </summary> + </member> + <member name="P:DotSpatial.Data.DisposeBase.IsDisposeLocked"> + <summary> + Gets a value indicating whether there are outstanding references that may be using the item + that would prefer it if you did not dispose of the item while they are still using it. + </summary> + </member> + <member name="T:DotSpatial.Data.ExtentArgs"> + <summary> + An EventArgs class for passing around an extent. + </summary> + </member> + <member name="M:DotSpatial.Data.ExtentArgs.#ctor(DotSpatial.Data.Extent)"> + <summary> + Initializes a new instance of the ExtentArgs class. + </summary> + <param name="value">The value for this event.</param> + </member> + <member name="P:DotSpatial.Data.ExtentArgs.Extent"> + <summary> + Gets or sets the Extents for this event. + </summary> + </member> + <member name="T:DotSpatial.Data.ExtentM"> + <summary> + The ExtentsM class extends the regular X and Y extent to the X, Y and M case. + </summary> + </member> + <member name="T:DotSpatial.Data.Extent"> + <summary> + Extent works like an envelope but is faster acting, has a minimum memory profile, + only works in 2D and has no events. + </summary> + </member> + <member name="T:DotSpatial.Data.IExtent"> + <summary> + A very simple, 2D extent specification. + </summary> + </member> + <member name="P:DotSpatial.Data.IExtent.MinX"> + <summary> + Minimum in the X dimension, usually left or minimum longitude. + </summary> + </member> + <member name="P:DotSpatial.Data.IExtent.MaxX"> + <summary> + Maximum in the x dimension, usually right or maximum longitude. + </summary> + </member> + <member name="P:DotSpatial.Data.IExtent.MinY"> + <summary> + Minimum in the y dimension, usually bottom or minimum latitude. + </summary> + </member> + <member name="P:DotSpatial.Data.IExtent.MaxY"> + <summary> + Maximum in the y dimension, usually the top or maximum latitude. + </summary> + </member> + <member name="P:DotSpatial.Data.IExtent.HasM"> + <summary> + Gets a Boolean that is true if the Min and Max M range should be used. + </summary> + </member> + <member name="P:DotSpatial.Data.IExtent.HasZ"> + <summary> + Gets a Boolean indicating whether the Z value should be used. + </summary> + </member> + <member name="M:DotSpatial.Data.Extent.#ctor"> + <summary> + Creates a new instance of Extent. This introduces no error checking and assumes + that the user knows what they are doing when working with this. + </summary> + </member> + <member name="M:DotSpatial.Data.Extent.#ctor(System.Double,System.Double,System.Double,System.Double)"> + <summary> + Creates a new extent from the specified ordinates + </summary> + <param name="xMin"></param> + <param name="yMin"></param> + <param name="xMax"></param> + <param name="yMax"></param> + </member> + <member name="M:DotSpatial.Data.Extent.#ctor(System.Double[],System.Int32)"> + <summary> + Given a long array of doubles, this builds an extent from a small part of that + xmin, ymin, xmax, ymax + </summary> + <param name="values"></param> + <param name="offset"></param> + </member> + <member name="M:DotSpatial.Data.Extent.#ctor(System.Double[])"> + <summary> + XMin, YMin, XMax, YMax order + </summary> + <param name="values"></param> + </member> + <member name="M:DotSpatial.Data.Extent.#ctor(DotSpatial.Topology.IEnvelope)"> + <summary> + Creates a new extent from the specified envelope + </summary> + <param name="env"></param> + </member> + <member name="M:DotSpatial.Data.Extent.Clone"> + <summary> + Produces a clone, rather than using this same object. + </summary> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.Extent.op_Equality(DotSpatial.Data.Extent,DotSpatial.Data.IExtent)"> + <summary> + Equality test + </summary> + <param name="left"></param> + <param name="right"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.Extent.op_Inequality(DotSpatial.Data.Extent,DotSpatial.Data.IExtent)"> + <summary> + Inequality test + </summary> + <param name="left"></param> + <param name="right"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.Extent.Contains(DotSpatial.Data.IExtent)"> + <summary> + Tests if this envelope is contained by the specified envelope + </summary> + <param name="ext"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.Extent.Contains(DotSpatial.Topology.Coordinate)"> + <summary> + Tests if this envelope is contained by the specified envelope + </summary> + <param name="c">The coordinate to test.</param> + <returns>Boolean</returns> + </member> + <member name="M:DotSpatial.Data.Extent.Contains(DotSpatial.Topology.IEnvelope)"> + <summary> + Tests if this envelope is contained by the specified envelope + </summary> + <param name="env"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.Extent.CopyFrom(DotSpatial.Data.IExtent)"> + <summary> + Copies the MinX, MaxX, MinY, MaxY values from extent. + </summary> + <param name="extent">Any IExtent implementation.</param> + </member> + <member name="M:DotSpatial.Data.Extent.Equals(System.Object)"> + <summary> + Allows equality testing for extents that is derived on the extent itself. + </summary> + <param name="obj"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.Extent.ExpandBy(System.Double,System.Double)"> + <summary> + Expand will adjust both the minimum and maximum by the specified sizeX and sizeY + </summary> + <param name="padX">The amount to expand left and right.</param> + <param name="padY">The amount to expand up and down.</param> + </member> + <member name="M:DotSpatial.Data.Extent.ExpandBy(System.Double)"> + <summary> + This expand the extent by the specified padding on all bounds. So the width will + change by twice the padding for instance. To Expand only x and y, use + the overload with those values explicitly specified. + </summary> + <param name="padding">The double padding to expand the extent.</param> + </member> + <member name="M:DotSpatial.Data.Extent.ExpandToInclude(DotSpatial.Data.IExtent)"> + <summary> + Expands this extent to include the domain of the specified extent + </summary> + <param name="ext">The extent to expand to include</param> + </member> + <member name="M:DotSpatial.Data.Extent.ExpandToInclude(System.Double,System.Double)"> + <summary> + Expands this extent to include the domain of the specified point + </summary> + <param name="x"></param> + <param name="y"></param> + </member> + <member name="M:DotSpatial.Data.Extent.GetHashCode"> + <summary> + Spreads the values for the basic X, Y extents across the whole range of int. + Repetition will occur, but it should be rare. + </summary> + <returns>Integer</returns> + </member> + <member name="M:DotSpatial.Data.Extent.Intersection(DotSpatial.Data.Extent)"> + <summary> + Calculates the intersection of this extent and the other extent. A result + with a min greater than the max in either direction is considered invalid + and represents no intersection. + </summary> + <param name="other">The other extent to intersect with.</param> + </member> + <member name="M:DotSpatial.Data.Extent.Intersects(DotSpatial.Topology.Coordinate)"> + <summary> + Returns true if the coordinate exists anywhere within this envelope + </summary> + <param name="c"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.Extent.Intersects(System.Double,System.Double)"> + <summary> + Tests for intersection with the specified coordinate + </summary> + <param name="x">The double ordinate to test intersection with in the X direction</param> + <param name="y">The double ordinate to test intersection with in the Y direction</param> + <returns>True if a point with the specified x and y coordinates is within or on the border + of this extent object. NAN values will always return false.</returns> + </member> + <member name="M:DotSpatial.Data.Extent.Intersects(DotSpatial.Data.Vertex)"> + <summary> + Tests to see if the point is inside or on the boundary of this extent. + </summary> + <param name="vert"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.Extent.Intersects(DotSpatial.Data.IExtent)"> + <summary> + Tests for an intersection with the specified extent + </summary> + <param name="ext">The other extent</param> + <returns>Boolean, true if they overlap anywhere, or even touch</returns> + </member> + <member name="M:DotSpatial.Data.Extent.Intersects(DotSpatial.Topology.IEnvelope)"> + <summary> + Tests with the specified envelope for a collision + </summary> + <param name="env"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.Extent.IsEmpty"> + <summary> + If this is undefined, it will have a min that is larger than the max, or else + any value is NaN. This only applies to the X and Z terms. Check HasM or HasZ higher dimensions. + </summary> + <returns>Boolean, true if the envelope has not had values set for it yet.</returns> + </member> + <member name="M:DotSpatial.Data.Extent.Parse(System.String)"> + <summary> + This allows parsing the X and Y values from a string version of the extent as: + 'X[-180|180], Y[-90|90]' Where minimum always precedes maximum. The correct + M or MZ version of extent will be returned if the string has those values. + </summary> + <param name="text">The string text to parse.</param> + </member> + <member name="M:DotSpatial.Data.Extent.TryParse(System.String,DotSpatial.Data.Extent@,System.String@)"> + <summary> + This reads the string and attempts to derive values from the text. + </summary> + <param name="text"></param> + <param name="result"></param> + <param name="nameFailed"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.Extent.SetCenter(System.Double,System.Double,System.Double,System.Double)"> + <summary> + This centers the X and Y aspect of the extent on the specified center location. + </summary> + <param name="centerX"></param> + <param name="centerY"></param> + <param name="width"></param> + <param name="height"></param> + </member> + <member name="M:DotSpatial.Data.Extent.SetCenter(DotSpatial.Topology.Coordinate,System.Double,System.Double)"> + <summary> + This centers the X and Y aspect of the extent on the specified center location. + </summary> + <param name="center">The center coordinate to to set.</param> + <param name="width"></param> + <param name="height"></param> + </member> + <member name="M:DotSpatial.Data.Extent.SetCenter(DotSpatial.Topology.Coordinate)"> + <summary> + This centers the extent on the specified coordinate, keeping the width and height the same. + </summary> + </member> + <member name="M:DotSpatial.Data.Extent.SetValues(System.Double,System.Double,System.Double,System.Double)"> + <summary> + Sets the values for xMin, xMax, yMin and yMax. + </summary> + <param name="minX">The double Minimum in the X direction.</param> + <param name="minY">The double Minimum in the Y direction.</param> + <param name="maxX">The double Maximum in the X direction.</param> + <param name="maxY">The double Maximum in the Y direction.</param> + </member> + <member name="M:DotSpatial.Data.Extent.ToEnvelope"> + <summary> + Creates a geometric envelope interface from this + </summary> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.Extent.ToString"> + <summary> + Creates a string that shows the extent. + </summary> + <returns>The string form of the extent.</returns> + </member> + <member name="M:DotSpatial.Data.Extent.Within(DotSpatial.Data.IExtent)"> + <summary> + Tests if this envelope is contained by the specified envelope + </summary> + <param name="ext"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.Extent.Within(DotSpatial.Topology.IEnvelope)"> + <summary> + Tests if this envelope is contained by the specified envelope + </summary> + <param name="env"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.Extent.TryExtract(System.String,System.String,System.Double@,System.Double@)"> + <summary> + Attempts to extract the min and max from one element of text. The element should be + formatted like X[1.5, 2.7] using an invariant culture. + </summary> + <param name="entireText"></param> + <param name="name">The name of the dimension, like X.</param> + <param name="min">The minimum that gets assigned</param> + <param name="max">The maximum that gets assigned</param> + <returns>Boolean, true if the parse was successful.</returns> + </member> + <member name="M:DotSpatial.Data.Extent.TryParseExtremes(System.String,System.Double@,System.Double@)"> + <summary> + This method converts the X and Y text into two doubles. + </summary> + <returns></returns> + </member> + <member name="P:DotSpatial.Data.Extent.Center"> + <summary> + Gets the Center of this extent. + </summary> + </member> + <member name="P:DotSpatial.Data.Extent.HasM"> + <summary> + Gets or sets whether the M values are used. M values are considered optional, + and not mandatory. Unused could mean either bound is NaN for some reason, or + else that the bounds are invalid by the Min being less than the Max. + </summary> + </member> + <member name="P:DotSpatial.Data.Extent.HasZ"> + <summary> + Gets or sets whether the M values are used. M values are considered optional, + and not mandatory. Unused could mean either bound is NaN for some reason, or + else that the bounds are invalid by the Min being less than the Max. + </summary> + </member> + <member name="P:DotSpatial.Data.Extent.MaxX"> + <summary> + Max X + </summary> + </member> + <member name="P:DotSpatial.Data.Extent.MaxY"> + <summary> + Max Y + </summary> + </member> + <member name="P:DotSpatial.Data.Extent.MinX"> + <summary> + Min X + </summary> + </member> + <member name="P:DotSpatial.Data.Extent.MinY"> + <summary> + Min Y + </summary> + </member> + <member name="P:DotSpatial.Data.Extent.Height"> + <summary> + Gets MaxY - MinY. Setting this will update MinY, keeping MaxY the same. (Pinned at top left corner). + </summary> + </member> + <member name="P:DotSpatial.Data.Extent.Width"> + <summary> + Gets MaxX - MinX. Setting this will update MaxX, keeping MinX the same. (Pinned at top left corner). + </summary> + </member> + <member name="P:DotSpatial.Data.Extent.X"> + <summary> + Gets MinX. Setting this will shift both MinX and MaxX, keeping the width the same. + </summary> + </member> + <member name="P:DotSpatial.Data.Extent.Y"> + <summary> + Gets MaxY. Setting this will shift both MinY and MaxY, keeping the height the same. + </summary> + </member> + <member name="T:DotSpatial.Data.IExtentM"> + <summary> + Supports bounding in the M Dimension + </summary> + </member> + <member name="P:DotSpatial.Data.IExtentM.MinM"> + <summary> + Gets or sets the minimum M value + </summary> + </member> + <member name="P:DotSpatial.Data.IExtentM.MaxM"> + <summary> + Gets or sets the maximum M value + </summary> + </member> + <member name="M:DotSpatial.Data.ExtentM.#ctor"> + <summary> + Initializes a new instance of the ExtentM class. + </summary> + </member> + <member name="M:DotSpatial.Data.ExtentM.#ctor(System.Double,System.Double,System.Double,System.Double,System.Double,System.Double)"> + <summary> + Initializes a new instance of the ExtentM class. + </summary> + <param name="minX">The double Minimum in the X direction.</param> + <param name="minY">The double Minimum in the Y direction.</param> + <param name="minM">The double Minimum in the Measure category.</param> + <param name="maxX">The double Maximum in the X direction.</param> + <param name="maxY">The double Maximum in the Y direction.</param> + <param name="maxM">The double Maximum in the Measure category.</param> + </member> + <member name="M:DotSpatial.Data.ExtentM.#ctor(DotSpatial.Data.IExtent,System.Double,System.Double)"> + <summary> + Initializes a new instance of the ExtentM class that is specially designed to work + with shapefile formats that have a Measure value. Obviously other formats can use + this as well. + </summary> + <param name="xyExtent">An extent that contains only the x and y boundaries.</param> + <param name="minM">The minimum M.</param> + <param name="maxM">The maximum M.</param> + </member> + <member name="M:DotSpatial.Data.ExtentM.#ctor(DotSpatial.Topology.IEnvelope)"> + <summary> + Initializes a new instance of the ExtentM class. This overload works from an envelope. + </summary> + <param name="env">The envelope with extent values to read.</param> + </member> + <member name="M:DotSpatial.Data.ExtentM.Clone"> + <summary> + Produces a clone, rather than using this same object. + </summary> + <returns>Returns a copy of this object.</returns> + </member> + <member name="M:DotSpatial.Data.ExtentM.Contains(DotSpatial.Topology.Coordinate)"> + <summary> + Tests if this envelope is contained by the specified envelope + </summary> + <param name="c">The coordinate to test.</param> + <returns>Boolean.</returns> + </member> + <member name="M:DotSpatial.Data.ExtentM.Contains(DotSpatial.Data.IExtent)"> + <summary> + Tests if this envelope is contained by the specified envelope + </summary> + <param name="ext"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.ExtentM.Contains(DotSpatial.Topology.IEnvelope)"> + <summary> + Tests if this envelope is contained by the specified envelope. If either element + does not support M values, then only the default X and Y contains test is used. + </summary> + <param name="env">The envelope to test.</param> + <returns>Boolean.</returns> + </member> + <member name="M:DotSpatial.Data.ExtentM.CopyFrom(DotSpatial.Data.IExtent)"> + <summary> + Copies from the implementation of IExtent. This checks to see if IExtentM is implemented + and if not, this only sets the X and Y bounds. + </summary> + <param name="extent"></param> + </member> + <member name="M:DotSpatial.Data.ExtentM.ExpandBy(System.Double)"> + <summary> + This expand the extent by the specified padding on all bounds. So the width will + change by twice the padding for instance. To Expand only x and y, use + the overload with those values explicitly specified. + </summary> + <param name="padding">The double padding to expand the extent.</param> + </member> + <member name="M:DotSpatial.Data.ExtentM.ExpandToInclude(DotSpatial.Data.IExtent)"> + <summary> + Expands this extent to include the domain of the specified extent. If the specified case + doesn't support IExtentM or HasM is false for that extent, then this test will default + to the XY case. + </summary> + <param name="ext">The extent to expand to include.</param> + </member> + <member name="M:DotSpatial.Data.ExtentM.ExpandToInclude(System.Double,System.Double,System.Double)"> + <summary> + Expands this extent to include the domain of the specified point + </summary> + <param name="x">The x ordinate to expand to.</param> + <param name="y">The y ordinate to expand to.</param> + <param name="m">The m ordinate to expand to.</param> + </member> + <member name="M:DotSpatial.Data.ExtentM.Intersection(DotSpatial.Data.Extent)"> + <summary> + Calculates the intersection of this extent and the other extent. A result + with a min greater than the max in either direction is considered invalid + and represents no intersection. + </summary> + <param name="other">The other extent to intersect with.</param> + </member> + <member name="M:DotSpatial.Data.ExtentM.Intersects(DotSpatial.Topology.Coordinate)"> + <summary> + Returns true if the coordinate exists anywhere within this envelope. If this + envelope represents a valid M extent by having a max greater than min and + neither value being NaN, then this will also test the coordinate for the + M range. + </summary> + <param name="c">The Coordinate to test.</param> + <returns>Boolean</returns> + </member> + <member name="M:DotSpatial.Data.ExtentM.Intersects(System.Double,System.Double,System.Double)"> + <summary> + Tests for intersection with the specified coordinate. If the m is double.NaN + then it degenerates to only testing X and Y, even if this envelope has an M range. + </summary> + <param name="x">The double ordinate to test intersection with in the X direction</param> + <param name="y">The double ordinate to test intersection with in the Y direction</param> + <param name="m">The optional double measure parameter to test.</param> + <returns>Boolean</returns> + </member> + <member name="M:DotSpatial.Data.ExtentM.Intersects(DotSpatial.Data.IExtent)"> + <summary> + Tests for an intersection with the specified extent. Both this extent and the + other must implement IExtentM and HasM must be true for both, or else just + the X and Y are compared. + </summary> + <param name="ext">The other extent. If the extent doesn't implement IExtentM, then + this comparison simply defaults to the X Y intersect case.</param> + <returns>Boolean, true if they overlap anywhere, or even touch.</returns> + </member> + <member name="M:DotSpatial.Data.ExtentM.Intersects(DotSpatial.Topology.IEnvelope)"> + <summary> + Tests with the specified envelope for a collision. If any part of the M bounds + are invalid, this will default to the XY Intersect comparison. + </summary> + <param name="env">The envelope to test.</param> + <returns>Boolean.</returns> + </member> + <member name="M:DotSpatial.Data.ExtentM.RemoveM"> + <summary> + Since M values are optional, they can be set to an invalid state, which will behave the + same as if the M bounds did not exist. + </summary> + </member> + <member name="M:DotSpatial.Data.ExtentM.SetValues(System.Double,System.Double,System.Double,System.Double,System.Double,System.Double)"> + <summary> + Sets the values for xMin, xMax, yMin and yMax. + </summary> + <param name="minX">The double Minimum in the X direction.</param> + <param name="minY">The double Minimum in the Y direction.</param> + <param name="minM">The double Minimum in the Measure category.</param> + <param name="maxX">The double Maximum in the X direction.</param> + <param name="maxY">The double Maximum in the Y direction.</param> + <param name="maxM">The double Maximum in the Measure category.</param> + </member> + <member name="M:DotSpatial.Data.ExtentM.Within(DotSpatial.Data.IExtent)"> + <summary> + Tests if this envelope is contained by the specified envelope. If either party doesn't have + M constraints, they will not be used for this test. + </summary> + <param name="ext">implementation of IExtent to compare to.</param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.ExtentM.Within(DotSpatial.Topology.IEnvelope)"> + <summary> + Tests if this envelope is contained by the specified envelope. If either envelope doesn't + support M then only the X and Y case will be tested. + </summary> + <param name="env">The envelope to compare.</param> + <returns>Boolean.</returns> + </member> + <member name="M:DotSpatial.Data.ExtentM.Equals(System.Object)"> + <summary> + Allows equality testing for extents that is derived on the extent itself. + </summary> + <param name="obj"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.ExtentM.ToString"> + <summary> + Creates a string that shows the extent. + </summary> + <returns>The string form of the extent.</returns> + </member> + <member name="M:DotSpatial.Data.ExtentM.GetHashCode"> + <summary> + Spreads the values for the basic X, Y extents across the whole range of int. + Repetition will occur, but it should be rare. + </summary> + <returns>Integer</returns> + </member> + <member name="P:DotSpatial.Data.ExtentM.HasM"> + <summary> + Gets or sets whether the M values are used. M values are considered optional, + and not mandatory. Unused could mean either bound is NaN for some reason, or + else that the bounds are invalid by the Min being less than the Max. + </summary> + </member> + <member name="P:DotSpatial.Data.ExtentM.MaxM"> + <inheritdoc/> + </member> + <member name="P:DotSpatial.Data.ExtentM.MinM"> + <inheritdoc/> + </member> + <member name="T:DotSpatial.Data.ExtentMZ"> + <summary> + For shapefiles, the extents may or may not have M and Z values depending on the file type. + These are valid IExtent implementations, but add both the M and Z extent options. + For the file format, the Z values are mandatory, and so whatever the values are will be + stored. This may cause issues when viewing in ArcGIS if you have entered some bad Z + envelope extents. + </summary> + </member> + <member name="T:DotSpatial.Data.IExtentZ"> + <summary> + The Extent interface for Z dimension extent bounds. + </summary> + </member> + <member name="P:DotSpatial.Data.IExtentZ.MinZ"> + <summary> + The minimum in the Z dimension (usually the bottom) + </summary> + </member> + <member name="P:DotSpatial.Data.IExtentZ.MaxZ"> + <summary> + The maximum in the Z dimension (usually the top) + </summary> + </member> + <member name="M:DotSpatial.Data.ExtentMZ.#ctor"> + <summary> + Initializes a new instance of the ExtentMZ class. + </summary> + </member> + <member name="M:DotSpatial.Data.ExtentMZ.#ctor(System.Double,System.Double,System.Double,System.Double,System.Double,System.Double,System.Double,System.Double)"> + <summary> + Initializes a new instance of the ExtentMZ class. + </summary> + <param name="minX">The double Minimum in the X direction.</param> + <param name="minY">The double Minimum in the Y direction.</param> + <param name="minM">The double Minimum in the Measure category.</param> + <param name="minZ">The double Minimum in the Z direction.</param> + <param name="maxX">The double Maximum in the X direction.</param> + <param name="maxY">The double Maximum in the Y direction.</param> + <param name="maxM">The double Maximum in the Measure category.</param> + <param name="maxZ">The double Maximum in the Z direction.</param> + </member> + <member name="M:DotSpatial.Data.ExtentMZ.#ctor(DotSpatial.Topology.IEnvelope)"> + <summary> + Initialize a new instance of the ExtentMZ class. + </summary> + <param name="env">The Envelope to read the minimum and maximum values from.</param> + </member> + <member name="M:DotSpatial.Data.ExtentMZ.RemoveZ"> + <summary> + Since M values are optional, they can be set to an invalid state, which will behave the + same as if the M bounds did not exist. + </summary> + </member> + <member name="M:DotSpatial.Data.ExtentMZ.CopyFrom(DotSpatial.Data.IExtent)"> + <summary> + Copies from the implementation of IExtent. This checks to see if IExtentM is implemented + and if not, this only sets the X and Y bounds. + </summary> + <param name="extent"></param> + </member> + <member name="M:DotSpatial.Data.ExtentMZ.SetValues(System.Double,System.Double,System.Double,System.Double,System.Double,System.Double,System.Double,System.Double)"> + <summary> + Sets the values for xZin, xMax, yMin and yMax. + </summary> + <param name="minX">The double Minimum in the X direction.</param> + <param name="minY">The double Minimum in the Y direction.</param> + <param name="minM">The double Minimum in the Measure category.</param> + <param name="minZ">The double Minimum in the Z direction.</param> + <param name="maxX">The double Maximum in the X direction.</param> + <param name="maxY">The double Maximum in the Y direction.</param> + <param name="maxM">The double Maximum in the Measure category.</param> + <param name="maxZ">The double Maximum in the Z direction.</param> + </member> + <member name="M:DotSpatial.Data.ExtentMZ.Contains(DotSpatial.Topology.Coordinate)"> + <summary> + Tests if this envelope is contained by the specified envelope + </summary> + <param name="c">The coordinate to test.</param> + <returns>Boolean.</returns> + </member> + <member name="M:DotSpatial.Data.ExtentMZ.Intersects(DotSpatial.Topology.Coordinate)"> + <summary> + Returns true if the coordinate exists anywhere within this envelope. If this + envelope represents a valid Z extent by having a max greater than min and + neither value being NaN, then this will also test the coordinate for the + Z range. + </summary> + <param name="c">The Coordinate to test.</param> + <returns>Boolean</returns> + </member> + <member name="M:DotSpatial.Data.ExtentMZ.Intersects(System.Double,System.Double,System.Double,System.Double)"> + <summary> + Tests for intersection with the specified coordinate. If the m is double.NaN + then it degenerates to only testing M, X and Y, even if this envelope has an M range. + </summary> + <param name="x">The double ordinate to test intersection with in the X direction.</param> + <param name="y">The double ordinate to test intersection with in the Y direction.</param> + <param name="m">The optional double measure parameter to test.</param> + <param name="z">The double ordinate to test intersection with in the Z direction.</param> + <returns>Boolean</returns> + </member> + <member name="M:DotSpatial.Data.ExtentMZ.Intersects(DotSpatial.Data.IExtent)"> + <summary> + Tests for an intersection with the specified extent. Both this extent and the + other must implement IExtentM and HasM must be true for both, or else just + the X and Y are compared. + </summary> + <param name="ext">The other extent. If the extent doesn't implement IExtentM, then + this comparison simply defaults to the M, X and Y intersect case.</param> + <returns>Boolean, true if they overlap anywhere, or even touch.</returns> + </member> + <member name="M:DotSpatial.Data.ExtentMZ.Intersects(DotSpatial.Topology.IEnvelope)"> + <summary> + Tests with the specified envelope for a collision. If any part of the Z bounds + are invalid, this will default to the M, X and Y Intersect comparison. + </summary> + <param name="env">The envelope to test.</param> + <returns>Boolean.</returns> + </member> + <member name="M:DotSpatial.Data.ExtentMZ.Intersection(DotSpatial.Data.Extent)"> + <summary> + Calculates the intersection of this extent and the other extent. A result + with a min greater than the max in either direction is considered invalid + and represents no intersection. + </summary> + <param name="other">The other extent to intersect with.</param> + </member> + <member name="M:DotSpatial.Data.ExtentMZ.ExpandToInclude(DotSpatial.Data.IExtent)"> + <summary> + Expands this extent to include the domain of the specified extent. If the specified case + doesn't support IExtentM or HasM is false for that extent, then this test will default + to the M, X and Y case. + </summary> + <param name="ext">The extent to expand to include</param> + </member> + <member name="M:DotSpatial.Data.ExtentMZ.ExpandBy(System.Double)"> + <summary> + This expand the extent by the specified padding on all bounds. So the width will + change by twice the padding for instance. To Expand only x and y, use + the overload with those values explicitly specified. + </summary> + <param name="padding">The double padding to expand the extent.</param> + </member> + <member name="M:DotSpatial.Data.ExtentMZ.ExpandToInclude(System.Double,System.Double,System.Double,System.Double)"> + <summary> + Expands this extent to include the domain of the specified point + </summary> + <param name="x">The x ordinate to expand to.</param> + <param name="y">The y ordinate to expand to.</param> + <param name="m">The m ordinate to expand to.</param> + <param name="z">The z ordinate to expand to.</param> + </member> + <member name="M:DotSpatial.Data.ExtentMZ.Within(DotSpatial.Data.IExtent)"> + <summary> + Tests if this envelope is contained by the specified envelope. If either party doesn't have + M constraints, they will not be used for this test. + </summary> + <param name="ext">implementation of IExtent to compare to.</param> + <returns>Boolean.</returns> + </member> + <member name="M:DotSpatial.Data.ExtentMZ.Contains(DotSpatial.Data.IExtent)"> + <summary> + Tests if this envelope is contained by the specified envelope + </summary> + <param name="ext">The extent to test.</param> + <returns>Boolean.</returns> + </member> + <member name="M:DotSpatial.Data.ExtentMZ.Within(DotSpatial.Topology.IEnvelope)"> + <summary> + Tests if this envelope is contained by the specified envelope. If either envelope doesn't + support M then only the XY case will be tested. + </summary> + <param name="env">The envelope to compare.</param> + <returns>Boolean.</returns> + </member> + <member name="M:DotSpatial.Data.ExtentMZ.Contains(DotSpatial.Topology.IEnvelope)"> + <summary> + Tests if this envelope is contained by the specified envelope. If either element + does not support M values, then only the default XY contains test is used. + </summary> + <param name="env">The envelope to test.</param> + <returns>Boolean.</returns> + </member> + <member name="M:DotSpatial.Data.ExtentMZ.ToString"> + <summary> + Creates a string that shows the extent. + </summary> + <returns>The string form of the extent.</returns> + </member> + <member name="M:DotSpatial.Data.ExtentMZ.Clone"> + <summary> + Produces a clone, rather than using this same object. + </summary> + <returns>Returns a copy of this object.</returns> + </member> + <member name="M:DotSpatial.Data.ExtentMZ.Equals(System.Object)"> + <summary> + Allows equality testing for extents that is derived on the extent itself. + </summary> + <param name="obj"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.ExtentMZ.GetHashCode"> + <summary> + Spreads the values for the basic X, Y extents across the whole range of int. + Repetition will occur for extents that are close, but should be rare. + </summary> + <returns>Integer</returns> + </member> + <member name="P:DotSpatial.Data.ExtentMZ.HasZ"> + <summary> + Gets or sets whether the M values are used. M values are considered optional, + and not mandatory. Unused could mean either bound is NaN for some reason, or + else that the bounds are invalid by the Min being less than the Max. + </summary> + </member> + <member name="P:DotSpatial.Data.ExtentMZ.MinZ"> + <inheritdoc/> + </member> + <member name="P:DotSpatial.Data.ExtentMZ.MaxZ"> + <inheritdoc/> + </member> + <member name="T:DotSpatial.Data.ExtentParseException"> + <summary> + + </summary> + </member> + <member name="F:DotSpatial.Data.ExtentParseException.EXTENT_TEXT_TEMPLATE"> + <summary> + The string template that should be used. M and Z are optional. Do use a comma to + delimit terms, but the space doesn't matter. Do use square brackets to enclose + numbers, and do use the | separator to separate min from max. Do place min + before max in each term. The order of the terms doesn't matter. Use periods + for decimals and an invariant culture. + </summary> + </member> + <member name="M:DotSpatial.Data.ExtentParseException.#ctor(System.String)"> + <summary> + Initializes a new instance of the ExtentParseException + </summary> + <param name="message">The string message to parse.</param> + </member> + <member name="M:DotSpatial.Data.ExtentParseException.#ctor(System.String,System.Exception)"> + <summary> + Initializes a new instance of the ExtentParseException + </summary> + <param name="message">The string message to parse.</param> + <param name="innerException">The inner exception that caused this exception.</param> + </member> + <member name="M:DotSpatial.Data.ExtentParseException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> + <summary> + Initializes a new instance of the ExtentParseException + </summary> + <param name="info">The Serialization info class that holds the serialized object about which + the exception is being thrown.</param> + <param name="context">The streaming context that contains contextual information about the + source or destination.</param> + </member> + <member name="P:DotSpatial.Data.ExtentParseException.Expression"> + <summary> + Gets the string expression that provoked the exception. + </summary> + </member> + <member name="T:DotSpatial.Data.FeatureRow"> + <summary> + Represents strongly named DataRow class. + </summary> + </member> + <member name="T:DotSpatial.Data.IFeatureRow"> + <summary> + This interface allows access to geometries and attributes in a more cohesive package. + </summary> + </member> + <member name="M:DotSpatial.Data.IFeatureRow.StoreShape"> + <summary> + Stores the shape to the GEOMETRY WKB. + </summary> + </member> + <member name="M:DotSpatial.Data.IFeatureRow.StoreGeometry"> + <summary> + Stores the geometry to the geometry wkb. + </summary> + </member> + <member name="P:DotSpatial.Data.IFeatureRow.Extent"> + <summary> + This is a cached extent. This will not reflect changes in Geometry or Shape unless + they have been stored, but will reflect the most recently stored or retrieved + extent from accessing either the shape or geometry. In cases where reading from + WKB, this will be lazily created, but it will be cached when reading from + shapefiles. + </summary> + </member> + <member name="P:DotSpatial.Data.IFeatureRow.Geometry"> + <summary> + A Geometry created lazily from a WKB byte structure in the GEOMETRY field preferentially + or if the field is DBNull and the shape is not null, then from the Shape object. + </summary> + </member> + <member name="P:DotSpatial.Data.IFeatureRow.Shape"> + <summary> + A Shape that is either created lazily from the WKB Geometry or directly from a shapefile. + </summary> + </member> + <member name="P:DotSpatial.Data.IFeatureRow.Item(System.String)"> + <summary> + The rest of the attributes are stored by an indexed property. + </summary> + <param name="fieldName"></param> + <returns></returns> + </member> + <member name="P:DotSpatial.Data.IFeatureRow.IsGeometryCreated"> + <summary> + Boolean, true if the geometry has already been created, false otherwise. + </summary> + </member> + <member name="P:DotSpatial.Data.IFeatureRow.IsShapeCreated"> + <summary> + Boolean, true if the shape has already been created, false otherwise. + </summary> + </member> + <member name="P:DotSpatial.Data.IFeatureRow.IsExtentCreated"> + <summary> + Boolean, true if the extent has been created, false otherwise. + </summary> + </member> + <member name="M:DotSpatial.Data.FeatureRow.#ctor(System.Data.DataRowBuilder)"> + <summary> + Creates a new instance of the FeatureRow class. + </summary> + <param name="rb"></param> + </member> + <member name="M:DotSpatial.Data.FeatureRow.StoreShape"> + <summary> + Stores the shape into the WKB for storage in a database, overwriting any existing value. + </summary> + </member> + <member name="M:DotSpatial.Data.FeatureRow.StoreGeometry"> + <summary> + Stores the goemetry as WKB, overwriting any existing value. + </summary> + </member> + <member name="M:DotSpatial.Data.FeatureRow.SetWellKnwonBinaryNull"> + <summary> + Sets the geometry field to DBNull. + </summary> + </member> + <member name="M:DotSpatial.Data.FeatureRow.IsWellKnownBinaryNull"> + <summary> + Gets whether the geometry is null. + </summary> + <returns>Boolean, true if the column is null.</returns> + </member> + <member name="P:DotSpatial.Data.FeatureRow.FID"> + <summary> + A long integer representing the FID. + </summary> + </member> + <member name="P:DotSpatial.Data.FeatureRow.WellKnownBinary"> + <summary> + The Byte form of the Geometry + </summary> + </member> + <member name="P:DotSpatial.Data.FeatureRow.Extent"> + <summary> + From shapefiles, this should be cached. Any other source must likely + create the extent from a geometry, and possibly all the way from WKB. + </summary> + </member> + <member name="P:DotSpatial.Data.FeatureRow.Geometry"> + <summary> + A lazily created and cached geometry. + </summary> + </member> + <member name="P:DotSpatial.Data.FeatureRow.IsExtentCreated"> + <summary> + Boolean, true if the extent has been created, false otherwise. + </summary> + </member> + <member name="P:DotSpatial.Data.FeatureRow.IsGeometryCreated"> + <summary> + Boolean, true if the geometry has already been created, false otherwise. + </summary> + </member> + <member name="P:DotSpatial.Data.FeatureRow.IsShapeCreated"> + <summary> + Boolean, true if the shape has already been created, false otherwise. + </summary> + </member> + <member name="P:DotSpatial.Data.FeatureRow.Shape"> + <summary> + When reading from WKB, the Shape is lazily created. When reading from sources like + a shapefile, the Shape is actually pre-fetched because the value exists as a shape + rather than a geometry. + </summary> + </member> + <member name="T:DotSpatial.Data.FeatureRowChangeEvent"> + <summary> + Row event argument class + </summary> + </member> + <member name="M:DotSpatial.Data.FeatureRowChangeEvent.#ctor(DotSpatial.Data.FeatureRow,System.Data.DataRowAction)"> + <summary> + A new event argument for events in a FeatureTable. + </summary> + <param name="row">The FeatureRow of the event.</param> + <param name="action">The action occuring for this event.</param> + </member> + <member name="P:DotSpatial.Data.FeatureRowChangeEvent.Row"> + <summary> + The FeatureRow for this event. + </summary> + </member> + <member name="P:DotSpatial.Data.FeatureRowChangeEvent.Action"> + <summary> + The action for this event. + </summary> + </member> + <member name="T:DotSpatial.Data.FeatureSetEventArgs"> + <summary> + An EventArgs specifically tailored to FeatureSet. + </summary> + </member> + <member name="M:DotSpatial.Data.FeatureSetEventArgs.#ctor(DotSpatial.Data.IFeatureSet)"> + <summary> + Initializes a new instance of the FeatureSetEventArgs class. + </summary> + <param name="featureSet">The IFeatureSet that is involved in this event.</param> + </member> + <member name="P:DotSpatial.Data.FeatureSetEventArgs.FeatureSet"> + <summary> + Gets the Raster associated with this event. + </summary> + </member> + <member name="T:DotSpatial.Data.FeatureSourceRowEditEvent"> + <summary> + Callback specified when calling IFeatureSource.SearchAndModifyAttributes + </summary> + <param name="e"></param> + </member> + <member name="T:DotSpatial.Data.FeatureSourceRowEditEventArgs"> + <summary> + FeatureSourceRowEditEvent arguments + </summary> + </member> + <member name="F:DotSpatial.Data.FeatureSourceRowEditEventArgs.RowEditEventArgs"> + <summary> + RowEditEvent arguments + </summary> + </member> + <member name="F:DotSpatial.Data.FeatureSourceRowEditEventArgs.Shape"> + <summary> + Shape geometry associated with the row + </summary> + </member> + <member name="M:DotSpatial.Data.FeatureSourceRowEditEventArgs.#ctor(DotSpatial.Data.RowEditEventArgs,DotSpatial.Data.Shape)"> + <summary> + Construct FeatureSourceRowEditEventArgs + </summary> + <param name="rowEditEventArgs"></param> + <param name="shape"></param> + </member> + <member name="T:DotSpatial.Data.FeatureTable"> + <summary> + Represents the strongly named DataTable class. + </summary> + </member> + <member name="M:DotSpatial.Data.FeatureTable.#ctor"> + <summary> + Initializes a new instance of a FeatureTable class. + </summary> + </member> + <member name="M:DotSpatial.Data.FeatureTable.#ctor(System.String)"> + <summary> + Initializes a new instance of a FeatureTable class. + </summary> + </member> + <member name="M:DotSpatial.Data.FeatureTable.AddFeatureRow(DotSpatial.Data.FeatureRow)"> + <summary> + Adds the specified FeatureRow to this FeatureTable. + </summary> + <param name="row">the row to add.</param> + </member> + <member name="M:DotSpatial.Data.FeatureTable.AddFeatureRow(System.Byte[])"> + <summary> + Generates a new feature row using only the goemetry. + </summary> + <param name="wellKnownBinary">The byte form of the well known text to use in creating a new, otherwise empty row.</param> + <returns>The newly created FeatureRow with the specified well known text.</returns> + </member> + <member name="M:DotSpatial.Data.FeatureTable.NewFeatureRow"> + <summary> + Retrieves a newly generated row from this table cast as a FeatureRow. + </summary> + <returns>The FeatureRow class.</returns> + </member> + <member name="M:DotSpatial.Data.FeatureTable.Clone"> + <inheritdocs/> + </member> + <member name="M:DotSpatial.Data.FeatureTable.FindByFID(System.Int64)"> + <summary> + Finds a FeatureRow by the FID field. + </summary> + <param name="fid">The long fid to find</param> + <returns>A FeatureRow</returns> + </member> + <member name="M:DotSpatial.Data.FeatureTable.RemoveFeatureRow(DotSpatial.Data.FeatureRow)"> + <summary> + Removes the specified row from the table. + </summary> + <param name="row">The FeatureRow to remove.</param> + </member> + <member name="M:DotSpatial.Data.FeatureTable.AddFeatureRow(DotSpatial.Topology.IGeometry)"> + <summary> + Generates a new feature row using only the goemetry. + </summary> + <param name="geometry">The byte form of the well known text to use in creating a new, otherwise empty row.</param> + <returns>The newly created FeatureRow with the specified well known text.</returns> + </member> + <member name="M:DotSpatial.Data.FeatureTable.CreateInstance"> + <inheritdocs/> + </member> + <member name="M:DotSpatial.Data.FeatureTable.GetRowType"> + <inheritdocs/> + </member> + <member name="M:DotSpatial.Data.FeatureTable.NewRowFromBuilder(System.Data.DataRowBuilder)"> + <inheritdocs/> + </member> + <member name="M:DotSpatial.Data.FeatureTable.OnRowChanged(System.Data.DataRowChangeEventArgs)"> + <inheritdocs/> + </member> + <member name="M:DotSpatial.Data.FeatureTable.OnRowChanging(System.Data.DataRowChangeEventArgs)"> + <inheritdocs/> + </member> + <member name="M:DotSpatial.Data.FeatureTable.OnRowDeleted(System.Data.DataRowChangeEventArgs)"> + <inheritdocs/> + </member> + <member name="M:DotSpatial.Data.FeatureTable.OnRowDeleting(System.Data.DataRowChangeEventArgs)"> + <inheritdocs/> + </member> + <member name="M:DotSpatial.Data.FeatureTable.#ctor(System.Data.DataTable)"> + <summary> + This may or may not be required for proper functioning, but is not part of the public API. + </summary> + <param name="table">A DataTable</param> + </member> + <member name="M:DotSpatial.Data.FeatureTable.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> + <summary> + This may not work since I stripped off the xml related auto text that seems to rely on an existing dataset + </summary> + <param name="info"></param> + <param name="context"></param> + </member> + <member name="E:DotSpatial.Data.FeatureTable.FeatureRowChanging"> + <summary> + Occurs while the row is changing + </summary> + </member> + <member name="E:DotSpatial.Data.FeatureTable.FeatureRowChanged"> + <summary> + Occurs after the row has been changed. + </summary> + </member> + <member name="E:DotSpatial.Data.FeatureTable.FeatureRowDeleting"> + <summary> + Occurs while the row is being deleted. + </summary> + </member> + <member name="E:DotSpatial.Data.FeatureTable.FeatureRowDeleted"> + <summary> + Occurs after the row has been deleted. + </summary> + </member> + <member name="P:DotSpatial.Data.FeatureTable.Count"> + <summary> + The integer number of rows in this table. + </summary> + </member> + <member name="P:DotSpatial.Data.FeatureTable.FidColumn"> + <summary> + The Column containing the FID value. + </summary> + </member> + <member name="P:DotSpatial.Data.FeatureTable.GeometryColumn"> + <summary> + The Column containing the Geometry column. + </summary> + </member> + <member name="P:DotSpatial.Data.FeatureTable.GeometryFactory"> + <summary> + Optionally gets or sets a geometry factory to use when instantiating geometries + from WKB for the rows of this table. + </summary> + </member> + <member name="P:DotSpatial.Data.FeatureTable.Item(System.Int32)"> + <summary> + Accesses the FeatureRow of this table based on the specified index. + </summary> + <param name="index">The integer index of the feature row to access.</param> + <returns>This FeatureRow</returns> + </member> + <member name="T:DotSpatial.Data.Fields"> + <summary> + Manage the Fields associated with a dbase + </summary> + </member> + <member name="M:DotSpatial.Data.Fields.#ctor(System.Collections.Generic.IEnumerable{DotSpatial.Data.Field})"> + <summary> + Construct Fields and update the individual field data addresses + </summary> + <param name="fields"></param> + </member> + <member name="M:DotSpatial.Data.Fields.Add(DotSpatial.Data.Field)"> + <summary> + Add a field + </summary> + <param name="field"></param> + </member> + <member name="M:DotSpatial.Data.Fields.UpdateDataAddresses"> + <summary> + Update the DataAddress of each field + </summary> + </member> + <member name="P:DotSpatial.Data.Fields.Item(System.Int32)"> + <summary> + Retrieve field by ordinal + </summary> + <param name="pos"></param> + <returns></returns> + </member> + <member name="P:DotSpatial.Data.Fields.Item(System.String)"> + <summary> + Retrieve field by name + </summary> + <param name="name"></param> + <returns></returns> + </member> + <member name="P:DotSpatial.Data.Fields.Count"> + <summary> + Get number of fields + </summary> + </member> + <member name="T:DotSpatial.Data.IContainRasterBounds"> + <summary> + An interface for specifying something has a Bounds property on it that is a raster bounds. + </summary> + </member> + <member name="P:DotSpatial.Data.IContainRasterBounds.Bounds"> + <summary> + Gets or sets the image bounds being used to define the georeferencing of the image + </summary> + </member> + <member name="T:DotSpatial.Data.IGetBitmap"> + <summary> + Returns the bitmap + </summary> + </member> + <member name="M:DotSpatial.Data.IGetBitmap.GetBitmap"> + <summary> + Attempts to create a bitmap for the entire image. This may cause memory exceptions. + </summary> + <returns> + A Bitmap of the image. + </returns> + </member> + <member name="M:DotSpatial.Data.IGetBitmap.GetBitmap(DotSpatial.Data.Extent,System.Drawing.Size)"> + <summary> + The geographic envelope gives the region that the image should be created for. + The window gives the corresponding pixel dimensions for the image, so that + images matching the resolution of the screen can be used. + </summary> + <param name="envelope"> + The geographic extents to retrieve data for + </param> + <param name="size"> + The rectangle that defines the size of the drawing area in pixels + </param> + <returns> + A bitmap captured from the main image + </returns> + </member> + <member name="M:DotSpatial.Data.IGetBitmap.GetBitmap(DotSpatial.Data.Extent,System.Drawing.Rectangle)"> + <summary> + The geographic envelope gives the region that the image should be created for. + The window gives the corresponding pixel dimensions for the image, so that + images matching the resolution of the screen can be used. + </summary> + <param name="envelope"> + The geographic extents to retrieve data for + </param> + <param name="window"> + The rectangle that defines the size of the drawing area in pixels + </param> + <returns> + A bitmap captured from the main image + </returns> + </member> + <member name="T:DotSpatial.Data.ImageDataEventArgs"> + <summary> + An EventArgs specifically tailored to ImageData. + </summary> + </member> + <member name="M:DotSpatial.Data.ImageDataEventArgs.#ctor(DotSpatial.Data.IImageData)"> + <summary> + Initializes a new instance of the ImageDataEventArgs class. + </summary> + <param name="imageData">The IImageData that is involved in this event.</param> + </member> + <member name="P:DotSpatial.Data.ImageDataEventArgs.ImageData"> + <summary> + Gets the ImageData associated with this event. + </summary> + </member> + <member name="T:DotSpatial.Data.Endian"> + <summary> + An enumeration for specifying the endian byte order to use. + </summary> + </member> + <member name="F:DotSpatial.Data.Endian.BigEndian"> + <summary> + Specifies big endian like mainframe or unix system. + </summary> + </member> + <member name="F:DotSpatial.Data.Endian.LittleEndian"> + <summary> + Specifies little endian like most pc systems. + </summary> + </member> + <member name="T:DotSpatial.Data.IFeatureSource"> + <summary> + A new interface for accessing database or file features to large for memory. This allows editing only for attribute content, + but allows Add, Remove, AddRange, and Query functionality that covers both vector and raster content. + </summary> + </member> + <member name="M:DotSpatial.Data.IFeatureSource.Add(DotSpatial.Data.IFeature)"> + <summary> + Updates the file with an additional feature. + </summary> + <param name="feature"></param> + </member> + <member name="M:DotSpatial.Data.IFeatureSource.RemoveAt(System.Int32)"> + <summary> + Removes the feature with the specified index + </summary> + <param name="index">Removes the feature from the specified index location</param> + </member> + <member name="M:DotSpatial.Data.IFeatureSource.AddRange(System.Collections.Generic.IEnumerable{DotSpatial.Data.IFeature})"> + <summary> + The default implementation calls the add method repeatedly. + </summary> + <param name="features">The set of features to add</param> + </member> + <member name="M:DotSpatial.Data.IFeatureSource.Select(System.String,DotSpatial.Topology.IEnvelope,System.Int32@,System.Int32)"> + <summary> + Select function passed with a filter expression. + </summary> + <param name="filterExpression">The string filter expression based on attributes</param> + <param name="envelope">The envelope for vector filtering.</param> + <param name="startIndex">The integer start index where values should be checked. This will be updated to the </param> + last index that was checked before the return, so that paging the query can begin with that index in the next cycle. + Be sure to add one before the next call. + <param name="maxCount">The integer maximum number of IFeature values that should be returned.</param> + <returns>A dictionary with FID keys and IFeature values.</returns> + </member> + <member name="M:DotSpatial.Data.IFeatureSource.SearchAndModifyAttributes(DotSpatial.Topology.IEnvelope,System.Int32,DotSpatial.Data.FeatureSourceRowEditEvent)"> + <summary> + Conditionally modify attributes as searched in a single pass via client supplied callback. + </summary> + <param name="envelope">The envelope for vector filtering.</param> + <param name="chunkSize">Number of shapes to request from the ShapeSource in each chunk</param> + <param name="rowCallback">Callback on each feature</param> + </member> + <member name="M:DotSpatial.Data.IFeatureSource.EditAttributes(System.Int32,System.Data.DataRow)"> + <summary> + Edits the values of the specified row in the attribute table. Since not all data formats + can handle the dynamic change of attributes, updating vectors can be done with Remove and Add. + </summary> + <param name="fid">The feature offest</param> + <param name="attributeValues">The row of new attribute values.</param> + </member> + <member name="M:DotSpatial.Data.IFeatureSource.EditAttributes(System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.Int32,System.Data.DataRow}})"> + <summary> + Edits the values of the specified rows in the attribute table. + </summary> + <param name="indexDataRowPairs"></param> + </member> + <member name="M:DotSpatial.Data.IFeatureSource.UpdateExtents"> + <summary> + Adding and removing shapes may make the bounds for the entire shapefile invalid. + This triggers a check that ensures that the collective extents contain all the shapes. + </summary> + </member> + <member name="P:DotSpatial.Data.IFeatureSource.Extent"> + <summary> + The geographic extent of the feature source + </summary> + </member> + <member name="P:DotSpatial.Data.IFeatureSource.AttributeTable"> + <summary> + Get the attribute table associated with the feature source + </summary> + </member> + <member name="T:DotSpatial.Data.ImageBandType"> + <summary> + An enumeration listing the types of image band interpretations supported. + </summary> + </member> + <member name="F:DotSpatial.Data.ImageBandType.ARGB"> + <summary> + Alpha, Red, Green, Blue 4 bytes per pixel, 4 bands + </summary> + </member> + <member name="F:DotSpatial.Data.ImageBandType.RGB"> + <summary> + Red, Green, Blue 3 bytes per pixel, 3 bands + </summary> + </member> + <member name="F:DotSpatial.Data.ImageBandType.Gray"> + <summary> + Gray as one byte per pixel, 1 band + </summary> + </member> + <member name="F:DotSpatial.Data.ImageBandType.PalletCoded"> + <summary> + Colors encoded 1 byte per pixel, 1 band + </summary> + </member> + <member name="T:DotSpatial.Data.InRamImage"> + <summary> + Sets the InRamImage for this class. This is just a georeferenced .Net bitmap that also implements + IGetBitmap for cross purpose use with IImageData implementations. + </summary> + </member> + <member name="M:DotSpatial.Data.InRamImage.#ctor(System.Drawing.Bitmap)"> + <summary> + Initializes a new instance of an InRamImage class. This class supports a basic .Net Image + plus a geographic extent as a RasterBounds. This class does not feature any byte level + data access or built in file access. The expectation is that this will only be used in memory. + </summary> + <param name="image">THe Bitmap image to use to create this image.</param> + </member> + <member name="M:DotSpatial.Data.InRamImage.GetBitmap"> + <summary> + Returns the internal bitmap in this case. In other cases, this may have to be constructed + from the unmanaged memory content. + </summary> + <returns> + A Bitmap that represents the entire image. + </returns> + </member> + <member name="M:DotSpatial.Data.InRamImage.GetBitmap(DotSpatial.Data.Extent,System.Drawing.Rectangle)"> + <summary> + The geographic envelope gives the region that the image should be created for. + The window gives the corresponding pixel dimensions for the image, so that + images matching the resolution of the screen can be used. + </summary> + <param name="envelope"> + The geographic extents to retrieve data for + </param> + <param name="window"> + The rectangle that defines the size of the drawing area in pixels + </param> + <returns> + A bitmap captured from the main image + </returns> + </member> + <member name="M:DotSpatial.Data.InRamImage.GetBitmap(DotSpatial.Data.Extent,System.Drawing.Size)"> + <summary> + The geographic envelope gives the region that the image should be created for. + The window gives the corresponding pixel dimensions for the image, so that + images matching the resolution of the screen can be used. + </summary> + <param name="envelope">The geographic extents to retrieve data for</param> + <param name="size">The rectangle that defines the size of the drawing area in pixels</param> + <returns>A bitmap captured from the main image </returns> + </member> + <member name="M:DotSpatial.Data.InRamImage.SetBitmap(System.Drawing.Bitmap)"> + <summary> + Sets the bitmap for this InRamImage to use. + </summary> + <param name="value">the value to set.</param> + </member> + <member name="M:DotSpatial.Data.InRamImage.ToImageData"> + <summary> + If byte access is required, a new class can be created that is a copy of this class for + modifying values byte by byte. + </summary> + <returns></returns> + </member> + <member name="P:DotSpatial.Data.InRamImage.Bounds"> + <summary> + Gets or sets the raster bounds + </summary> + </member> + <member name="T:DotSpatial.Data.IProj"> + <summary> + The Projection interface that acts as a useful tool for calculating pixel coordinates + to geographic coordinates and vise-versa. + </summary> + </member> + <member name="P:DotSpatial.Data.IProj.ImageRectangle"> + <summary> + The Rectangle representation of the geographic extents in image coordinates + </summary> + </member> + <member name="P:DotSpatial.Data.IProj.GeographicExtents"> + <summary> + The geographic extents used for projection. + </summary> + </member> + <member name="T:DotSpatial.Data.IRasterBoundDataSet"> + <summary> + This interface specifically insists on an IRasterBounds as the Bounds property. + </summary> + </member> + <member name="T:DotSpatial.Data.IDataSet"> + <summary> + A very generic interface that is implemented by any dataset, regardless of what kinds of data that it has. + </summary> + </member> + <member name="T:DotSpatial.Data.IReproject"> + <summary> + This interface supports the basic Reprojection content. CanReproject tests to see if the + DotSpatial.Projections library exists and will return false if it does not exist. In + such a case the + </summary> + </member> + <member name="M:DotSpatial.Data.IReproject.Reproject(DotSpatial.Projections.ProjectionInfo)"> + <summary> + Reprojects all of the in-ram vertices of vectors, or else this + simply updates the "Bounds" of image and raster objects + This will also update the projection to be the specified projection. + </summary> + <param name="targetProjection"> + The projection information to reproject the coordinates to. + </param> + </member> + <member name="P:DotSpatial.Data.IReproject.CanReproject"> + <summary> + Gets a value indicating whether the DotSpatial.Projections assembly is loaded. If + not, this returns false, and neither ProjectionInfo nor the Reproject() method should + be used. + </summary> + <returns>Boolean, true if the value can reproject.</returns> + </member> + <member name="P:DotSpatial.Data.IReproject.Projection"> + <summary> + Gets or sets the projection information for this dataset + </summary> + </member> + <member name="P:DotSpatial.Data.IReproject.ProjectionString"> + <summary> + Gets or sets the proj4 string for this dataset. This exists in + case the Projections library is not loaded. If the projection + library is loaded, this also updates the Projection property. + Setting this behaves like defining the projection and will not + reproject the values. + </summary> + </member> + <member name="M:DotSpatial.Data.IDataSet.Close"> + <summary> + This closes the data set. Many times this will simply do nothing, but + in some cases this may close an open connection to a data source. + </summary> + </member> + <member name="P:DotSpatial.Data.IDataSet.Extent"> + <summary> + Gets or sets the extent for the dataset. Usages to Envelope were replaced + as they required an explicit using to DotSpatial.Topology which is not + as intuitive. Extent.ToEnvelope() and new Extent(myEnvelope) convert them. + </summary> + </member> + <member name="P:DotSpatial.Data.IDataSet.IsDisposed"> + <summary> + True if the dispose method has been called on this dataset. + </summary> + </member> + <member name="P:DotSpatial.Data.IDataSet.Name"> + <summary> + Gets or sets a string name identifying this dataset + </summary> + </member> + <member name="P:DotSpatial.Data.IDataSet.ProgressHandler"> + <summary> + Gets or sets the progress handler to use for internal actions taken by this dataset. + </summary> + </member> + <member name="P:DotSpatial.Data.IDataSet.SpaceTimeSupport"> + <summary> + Gets or sets the space time support for this dataset. + </summary> + </member> + <member name="P:DotSpatial.Data.IDataSet.TypeName"> + <summary> + Gets or sets a string that describes as clearly as possible what type of + elements are contained in this dataset. + </summary> + </member> + <member name="T:DotSpatial.Data.IShapeSource"> + <summary> + Rendering is considered a different pathway from editing. For rendering, we can distance + ourselves from the attributes all together in order to speedily grab just the indices + that are within the view extent. + </summary> + </member> + <member name="M:DotSpatial.Data.IShapeSource.GetShapes(System.Int32@,System.Int32,DotSpatial.Topology.IEnvelope)"> + <summary> + Returns a dictionary with the FID and Shape, but only returns shapes within the envelope. + </summary> + <param name="startIndex">The integer offset of the first shape to test. When this returns, the offset is set to the integer index of the last shape tested, regardless of whether or not it was returned.</param> + <param name="count">The integer count of the maximum number of shapes to return here. </param> + <param name="envelope">The geographic extents that can be used to limit the shapes. If this is null, then no envelope is used.</param> + <returns>The Dictionary with FID indices and Shape values</returns> + </member> + <member name="M:DotSpatial.Data.IShapeSource.GetShapes(System.Int32[])"> + <summary> + Returns array of shapes at the specified indices + </summary> + <param name="indices"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.IShapeSource.GetShapeCount"> + <summary> + Gets the integer count of the total number of shapes in the set. This may run a query, + so it is better to cache the result than call this repeatedly. + </summary> + <returns>The integer number of shapes in the entire source.</returns> + </member> + <member name="M:DotSpatial.Data.IShapeSource.EndGetShapesSession"> + <summary> + Should be called when done making repeated calls to GetShapes to free internal resources. + </summary> + </member> + <member name="P:DotSpatial.Data.IShapeSource.FeatureType"> + <summary> + This is most likely set once per source. + </summary> + </member> + <member name="T:DotSpatial.Data.LineShape"> + <summary> + LineShape + </summary> + </member> + <member name="M:DotSpatial.Data.LineShape.Intersects(DotSpatial.Data.ShapeRange,DotSpatial.Data.ShapeRange)"> + <summary> + Calculates the intersection of a polygon shape without relying on the NTS geometry + </summary> + <param name="lineShape"></param> + <param name="otherShape"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.LineShape.IntersectsVertex(DotSpatial.Data.ShapeRange,DotSpatial.Data.ShapeRange)"> + <summary> + Tests to see if any vertices from the other shape are coincident with a segment from this line shape. + </summary> + <param name="lineShape"></param> + <param name="otherShape"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.LineShape.SegmentsIntersect(DotSpatial.Data.ShapeRange,DotSpatial.Data.ShapeRange)"> + <summary> + Returns true if any segment from a line or polygon shape interesect any segments from the line or polygon shape. + </summary> + <param name="lineShape">A Line or Polygon shape</param> + <param name="otherShape">Another line or polygon shape</param> + <returns></returns> + </member> + <member name="P:DotSpatial.Data.LineShape.Epsilon"> + <summary> + Gets or sets the precision for calculating equality, but this is just a re-direction to Vertex.Epsilon + </summary> + </member> + <member name="T:DotSpatial.Data.LineShapefileFeatureSource"> + <summary> + This class is strictly the vector access code. This does not handle + the attributes, which must be handled independantly. + </summary> + </member> + <member name="T:DotSpatial.Data.ShapefileFeatureSource"> + <summary> + Provides common functionality for all ShapefileFeatureSource classes (Point, Line, Polygon) + </summary> + </member> + <member name="M:DotSpatial.Data.ShapefileFeatureSource.#ctor(System.String)"> + <summary> + Sets the fileName and creates a new ShapefileFeatureSource for the specified file. + </summary> + <param name="fileName">The fileName to work with.</param> + </member> + <member name="M:DotSpatial.Data.ShapefileFeatureSource.#ctor(System.String,System.Boolean,System.Boolean)"> + <summary> + Sets the fileName and creates a new PolygonshapefileFeatureSource for the specified file (and builds spatial index if requested) + </summary> + <param name="fileName"></param> + <param name="useSpatialIndexing"></param> + <param name="trackDeletedRows"></param> + </member> + <member name="M:DotSpatial.Data.ShapefileFeatureSource.Delete"> + <summary> + This deletes the files with any extension and the same base fileName. + </summary> + </member> + <member name="F:DotSpatial.Data.ShapefileFeatureSource.Quadtree"> + <summary> + Spatial index for faster searches + </summary> + </member> + <member name="M:DotSpatial.Data.ShapefileFeatureSource.Add(DotSpatial.Data.IFeature)"> + <inheritdocs/> + </member> + <member name="M:DotSpatial.Data.ShapefileFeatureSource.RemoveAt(System.Int32)"> + <inheritdocs/> + </member> + <member name="M:DotSpatial.Data.ShapefileFeatureSource.AddRange(System.Collections.Generic.IEnumerable{DotSpatial.Data.IFeature})"> + <inheritdocs/> + </member> + <member name="M:DotSpatial.Data.ShapefileFeatureSource.Select(System.String,DotSpatial.Topology.IEnvelope,System.Int32@,System.Int32)"> + <inheritdocs/> + </member> + <member name="M:DotSpatial.Data.ShapefileFeatureSource.SearchAndModifyAttributes(DotSpatial.Topology.IEnvelope,System.Int32,DotSpatial.Data.FeatureSourceRowEditEvent)"> + <inheritdocs/> + </member> + <member name="M:DotSpatial.Data.ShapefileFeatureSource.EditAttributes(System.Int32,System.Data.DataRow)"> + <inheritdocs/> + </member> + <member name="M:DotSpatial.Data.ShapefileFeatureSource.EditAttributes(System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.Int32,System.Data.DataRow}})"> + <inheritdocs/> + </member> + <member name="M:DotSpatial.Data.ShapefileFeatureSource.UpdateExtents"> + <inheritdocs/> + </member> + <member name="M:DotSpatial.Data.ShapefileFeatureSource.Open(System.String)"> + <summary> + Create a ShapefileFeatureSource of the appropriate type + </summary> + <param name="filename"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.ShapefileFeatureSource.Open(System.String,System.Boolean,System.Boolean)"> + <summary> + Create a ShapefileFeatureSource of the appropriate type spatial indexing + </summary> + <param name="filename"></param> + <param name="useSpatialIndexing"></param> + <param name="trackDeletedRows"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.ShapefileFeatureSource.UpdateHeader(DotSpatial.Data.ShapefileHeader,DotSpatial.Topology.IBasicGeometry)"> + <summary> + Update the header to include the feature extent + </summary> + <param name="header"></param> + <param name="feature"></param> + </member> + <member name="M:DotSpatial.Data.ShapefileFeatureSource.UpdateHeader(DotSpatial.Data.ShapefileHeader,DotSpatial.Topology.IBasicGeometry,System.Boolean)"> + <summary> + Update the header to include the feature extent + </summary> + <param name="header"></param> + <param name="feature"></param> + <param name="writeHeaderFiles"> </param> + </member> + <member name="M:DotSpatial.Data.ShapefileFeatureSource.UpdateExtents(DotSpatial.Data.IShapeSource)"> + <summary> + Update header extents from the geometries in a IShapeSource + </summary> + <param name="src"></param> + </member> + <member name="M:DotSpatial.Data.ShapefileFeatureSource.Select(DotSpatial.Data.IShapeSource,System.String,DotSpatial.Topology.IEnvelope,System.Int32@,System.Int32)"> + <summary> + Select the features in an IShapeSource + </summary> + <param name="sr"></param> + <param name="filterExpression"></param> + <param name="envelope"></param> + <param name="startIndex"></param> + <param name="maxCount"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.ShapefileFeatureSource.SearchAndModifyAttributes(DotSpatial.Data.IShapeSource,DotSpatial.Topology.IEnvelope,System.Int32,DotSpatial.Data.FeatureSourceRowEditEvent)"> + <summary> + Conditionally modify attributes as searched in a single pass via client supplied callback. + </summary> + <param name="sr">ShapeSource for this feature source</param> + <param name="envelope">The envelope for vector filtering.</param> + <param name="chunkSize">Number of shapes to request from the ShapeSource in each chunk</param> + <param name="featureEditCallback">Callback on each feature</param> + </member> + <member name="M:DotSpatial.Data.ShapefileFeatureSource.WriteHeader(DotSpatial.Data.ShapefileHeader,System.String)"> + <inheritdocs/> + </member> + <member name="M:DotSpatial.Data.ShapefileFeatureSource.AppendBasicGeometry(DotSpatial.Data.ShapefileHeader,DotSpatial.Topology.IBasicGeometry,System.Int32)"> + <summary> + Append the geometry to the shapefile + </summary> + <param name="header"></param> + <param name="feature"></param> + <param name="numFeatures"></param> + </member> + <member name="M:DotSpatial.Data.ShapefileFeatureSource.CreateShapeSource"> + <summary> + Create an appropriate ShapeSource for this FeatureSource + </summary> + <returns></returns> + </member> + <member name="P:DotSpatial.Data.ShapefileFeatureSource.Filename"> + <summary> + Gets or sets the Filename of this polygon shapefile. + </summary> + </member> + <member name="P:DotSpatial.Data.ShapefileFeatureSource.PageSize"> + <summary> + The integer maximum number of records to return in a single page of results. + </summary> + </member> + <member name="P:DotSpatial.Data.ShapefileFeatureSource.SpatialIndex"> + <summary> + Gets the spatial index if any + </summary> + </member> + <member name="P:DotSpatial.Data.ShapefileFeatureSource.FeatureType"> + <summary> + Get the feature type supported by this feature source + </summary> + </member> + <member name="P:DotSpatial.Data.ShapefileFeatureSource.ShapeType"> + <summary> + Get the shape type (without M or Z) supported by this feature source + </summary> + </member> + <member name="P:DotSpatial.Data.ShapefileFeatureSource.ShapeTypeM"> + <summary> + Get the shape type (with M, and no Z) supported by this feature source + </summary> + </member> + <member name="P:DotSpatial.Data.ShapefileFeatureSource.ShapeTypeZ"> + <summary> + Get the shape type (with M and Z) supported by this feature source + </summary> + </member> + <member name="P:DotSpatial.Data.ShapefileFeatureSource.Extent"> + <inheritdocs/> + </member> + <member name="P:DotSpatial.Data.ShapefileFeatureSource.AttributeTable"> + <summary> + Gets the AttributeTable for this feature source including DeletedRows + </summary> + </member> + <member name="M:DotSpatial.Data.LineShapefileFeatureSource.#ctor(System.String)"> + <summary> + Sets the fileName and creates a new LineShapefileFeatureSource for the specified file. + </summary> + <param name="fileName">The fileName to work with.</param> + </member> + <member name="M:DotSpatial.Data.LineShapefileFeatureSource.#ctor(System.String,System.Boolean,System.Boolean)"> + <summary> + Sets the fileName and creates a new LineShapefileFeatureSource for the specified file (and builds spatial index if requested) + </summary> + <param name="fileName"></param> + <param name="useSpatialIndexing"></param> + <param name="trackDeletedRows"></param> + </member> + <member name="M:DotSpatial.Data.LineShapefileFeatureSource.AppendBasicGeometry(DotSpatial.Data.ShapefileHeader,DotSpatial.Topology.IBasicGeometry,System.Int32)"> + <inheritdocs/> + </member> + <member name="M:DotSpatial.Data.LineShapefileFeatureSource.CreateShapeSource"> + <inheritdocs/> + </member> + <member name="M:DotSpatial.Data.LineShapefileFeatureSource.UpdateExtents"> + <inheritdocs/> + </member> + <member name="M:DotSpatial.Data.LineShapefileFeatureSource.Select(System.String,DotSpatial.Topology.IEnvelope,System.Int32@,System.Int32)"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.LineShapefileFeatureSource.SearchAndModifyAttributes(DotSpatial.Topology.IEnvelope,System.Int32,DotSpatial.Data.FeatureSourceRowEditEvent)"> + <inheritdoc/> + </member> + <member name="P:DotSpatial.Data.LineShapefileFeatureSource.FeatureType"> + <inheritdocs/> + </member> + <member name="P:DotSpatial.Data.LineShapefileFeatureSource.ShapeType"> + <inheritdocs/> + </member> + <member name="P:DotSpatial.Data.LineShapefileFeatureSource.ShapeTypeM"> + <inheritdocs/> + </member> + <member name="P:DotSpatial.Data.LineShapefileFeatureSource.ShapeTypeZ"> + <inheritdocs/> + </member> + <member name="T:DotSpatial.Data.LineShapefileShapeSource"> + <summary> + Retrieves specific shapes. + </summary> + </member> + <member name="T:DotSpatial.Data.ShapefileShapeSource"> + <summary> + Common functionality for retrieving specific shapes. + </summary> + </member> + <member name="F:DotSpatial.Data.ShapefileShapeSource._shx"> + <summary> + Cached contents of shape index file + </summary> + </member> + <member name="M:DotSpatial.Data.ShapefileShapeSource.#ctor(System.String)"> + <summary> + Creates a new instance of the ShapefileShapeSource with the specified + shapefile as the source. + </summary> + <param name="fileName"></param> + </member> + <member name="M:DotSpatial.Data.ShapefileShapeSource.#ctor(System.String,DotSpatial.Topology.Index.ISpatialIndex,DotSpatial.Data.ShapefileIndexFile)"> + <summary> + Creates a new instance of the ShapefileShapeSource with the specified + shapefile as the source and supplied spatial and shape indices. + </summary> + <param name="fileName"></param> + <param name="spatialIndex"></param> + <param name="shx"></param> + </member> + <member name="M:DotSpatial.Data.ShapefileShapeSource.GetShapeCount"> + <inheritdocs/> + </member> + <member name="M:DotSpatial.Data.ShapefileShapeSource.GetShapes(System.Int32@,System.Int32,DotSpatial.Topology.IEnvelope)"> + <inheritdocs/> + </member> + <member name="M:DotSpatial.Data.ShapefileShapeSource.GetShapes(System.Int32[])"> + <inheritdocs/> + </member> + <member name="M:DotSpatial.Data.ShapefileShapeSource.EndGetShapesSession"> + <inheritdocs/> + </member> + <member name="M:DotSpatial.Data.ShapefileShapeSource.CacheShapeIndexFile"> + <summary> + Cache Index File in memory so we don't have to read it in every call to GetShapes + </summary> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.ShapefileShapeSource.GetShapeAtIndex(System.IO.FileStream,DotSpatial.Data.ShapefileIndexFile,DotSpatial.Data.ShapefileHeader,System.Int32,DotSpatial.Topology.IEnvelope)"> + <summary> + Get the shape at the specified index. Must be implemented by all shape sources derived from ShapefileShapeSource + </summary> + <param name="fs"></param> + <param name="shx"></param> + <param name="header"></param> + <param name="shp"></param> + <param name="envelope"></param> + <returns></returns> + </member> + <member name="P:DotSpatial.Data.ShapefileShapeSource.Filename"> + <inheritdocs/> + </member> + <member name="P:DotSpatial.Data.ShapefileShapeSource.ShapeType"> + <summary> + Get the shape type (without M or Z) supported by this shape source + </summary> + </member> + <member name="P:DotSpatial.Data.ShapefileShapeSource.ShapeTypeM"> + <summary> + Get the shape type (with M, and no Z) supported by this shape source + </summary> + </member> + <member name="P:DotSpatial.Data.ShapefileShapeSource.ShapeTypeZ"> + <summary> + Get the shape type (with M and Z) supported by this shape source + </summary> + </member> + <member name="P:DotSpatial.Data.ShapefileShapeSource.FeatureType"> + <inheritdocs/> + </member> + <member name="M:DotSpatial.Data.LineShapefileShapeSource.#ctor(System.String)"> + <summary> + Creates a new instance of the LineShapefileShapeSource with the specified line + shapefile as the source. + </summary> + <param name="fileName">The string fileName</param> + </member> + <member name="M:DotSpatial.Data.LineShapefileShapeSource.#ctor(System.String,DotSpatial.Topology.Index.ISpatialIndex,DotSpatial.Data.ShapefileIndexFile)"> + <summary> + Creates a new instance of the LineShapefileShapeSource with the specified polygon shapefile as the source and provided indices + </summary> + <param name="fileName"></param> + <param name="spatialIndex"></param> + <param name="shx"></param> + </member> + <member name="M:DotSpatial.Data.LineShapefileShapeSource.GetShapeAtIndex(System.IO.FileStream,DotSpatial.Data.ShapefileIndexFile,DotSpatial.Data.ShapefileHeader,System.Int32,DotSpatial.Topology.IEnvelope)"> + <inheritdocs/> + </member> + <member name="P:DotSpatial.Data.LineShapefileShapeSource.ShapeType"> + <inheritdocs/> + </member> + <member name="P:DotSpatial.Data.LineShapefileShapeSource.ShapeTypeM"> + <inheritdocs/> + </member> + <member name="P:DotSpatial.Data.LineShapefileShapeSource.ShapeTypeZ"> + <inheritdocs/> + </member> + <member name="P:DotSpatial.Data.LineShapefileShapeSource.FeatureType"> + <inheritdocs/> + </member> + <member name="T:MiscUtil.Linq.ExpressionUtil"> + <summary> + General purpose Expression utilities + </summary> + </member> + <member name="M:MiscUtil.Linq.ExpressionUtil.CreateExpression``2(System.Func{System.Linq.Expressions.Expression,System.Linq.Expressions.UnaryExpression})"> + <summary> + Create a function delegate representing a unary operation + </summary> + <typeparam name="TArg1">The parameter type</typeparam> + <typeparam name="TResult">The return type</typeparam> + <param name="body">Body factory</param> + <returns>Compiled function delegate</returns> + </member> + <member name="M:MiscUtil.Linq.ExpressionUtil.CreateExpression``3(System.Func{System.Linq.Expressions.Expression,System.Linq.Expressions.Expression,System.Linq.Expressions.BinaryExpression})"> + <summary> + Create a function delegate representing a binary operation + </summary> + <typeparam name="TArg1">The first parameter type</typeparam> + <typeparam name="TArg2">The second parameter type</typeparam> + <typeparam name="TResult">The return type</typeparam> + <param name="body">Body factory</param> + <returns>Compiled function delegate</returns> + </member> + <member name="M:MiscUtil.Linq.ExpressionUtil.CreateExpression``3(System.Func{System.Linq.Expressions.Expression,System.Linq.Expressions.Expression,System.Linq.Expressions.BinaryExpression},System.Boolean)"> + <summary> + Create a function delegate representing a binary operation + </summary> + <typeparam name="TArg1">The first parameter type</typeparam> + <typeparam name="TArg2">The second parameter type</typeparam> + <typeparam name="TResult">The return type</typeparam> + <param name="body">Body factory</param> + <param name="castArgsToResultOnFailure">If no matching operation is possible, attempt to convert + TArg1 and TArg2 to TResult for a match? For example, there is no + "decimal operator /(decimal, int)", but by converting TArg2 (int) to + TResult (decimal) a match is found.</param> + <returns> + Compiled function delegate + </returns> + </member> + <member name="T:MiscUtil.Operator"> + <summary> + The Operator class provides easy access to the standard operators + (addition, etc) for generic types, using type inference to simplify + usage. + </summary> + </member> + <member name="M:MiscUtil.Operator.HasValue``1(``0)"> + <summary> + Indicates if the supplied value is non-null, + for reference-types or Nullable<T> + </summary> + <returns>True for non-null values, else false</returns> + </member> + <member name="M:MiscUtil.Operator.AddIfNotNull``1(``0@,``0)"> + <summary> + Increments the accumulator only + if the value is non-null. If the accumulator + is null, then the accumulator is given the new + value; otherwise the accumulator and value + are added. + </summary> + <param name="accumulator">The current total to be incremented (can be null)</param> + <param name="value">The value to be tested and added to the accumulator</param> + <returns>True if the value is non-null, else false - i.e. + "has the accumulator been updated?"</returns> + </member> + <member name="M:MiscUtil.Operator.Negate``1(``0)"> + <summary> + Evaluates unary negation (-) for the given type; this will throw + an InvalidOperationException if the type T does not provide this operator, or for + Nullable<TInner> if TInner does not provide this operator. + </summary> + </member> + <member name="M:MiscUtil.Operator.Not``1(``0)"> + <summary> + Evaluates bitwise not (~) for the given type; this will throw + an InvalidOperationException if the type T does not provide this operator, or for + Nullable<TInner> if TInner does not provide this operator. + </summary> + </member> + <member name="M:MiscUtil.Operator.Or``1(``0,``0)"> + <summary> + Evaluates bitwise or (|) for the given type; this will throw + an InvalidOperationException if the type T does not provide this operator, or for + Nullable<TInner> if TInner does not provide this operator. + </summary> + </member> + <member name="M:MiscUtil.Operator.And``1(``0,``0)"> + <summary> + Evaluates bitwise and (&) for the given type; this will throw + an InvalidOperationException if the type T does not provide this operator, or for + Nullable<TInner> if TInner does not provide this operator. + </summary> + </member> + <member name="M:MiscUtil.Operator.Xor``1(``0,``0)"> + <summary> + Evaluates bitwise xor (^) for the given type; this will throw + an InvalidOperationException if the type T does not provide this operator, or for + Nullable<TInner> if TInner does not provide this operator. + </summary> + </member> + <member name="M:MiscUtil.Operator.Convert``2(``0)"> + <summary> + Performs a conversion between the given types; this will throw + an InvalidOperationException if the type T does not provide a suitable cast, or for + Nullable<TInner> if TInner does not provide this cast. + </summary> + </member> + <member name="M:MiscUtil.Operator.Add``1(``0,``0)"> + <summary> + Evaluates binary addition (+) for the given type; this will throw + an InvalidOperationException if the type T does not provide this operator, or for + Nullable<TInner> if TInner does not provide this operator. + </summary> + </member> + <member name="M:MiscUtil.Operator.AddAlternative``2(``0,``1)"> + <summary> + Evaluates binary addition (+) for the given type(s); this will throw + an InvalidOperationException if the type T does not provide this operator, or for + Nullable<TInner> if TInner does not provide this operator. + </summary> + </member> + <member name="M:MiscUtil.Operator.Subtract``1(``0,``0)"> + <summary> + Evaluates binary subtraction (-) for the given type; this will throw + an InvalidOperationException if the type T does not provide this operator, or for + Nullable<TInner> if TInner does not provide this operator. + </summary> + </member> + <member name="M:MiscUtil.Operator.SubtractAlternative``2(``0,``1)"> + <summary> + Evaluates binary subtraction(-) for the given type(s); this will throw + an InvalidOperationException if the type T does not provide this operator, or for + Nullable<TInner> if TInner does not provide this operator. + </summary> + </member> + <member name="M:MiscUtil.Operator.Multiply``1(``0,``0)"> + <summary> + Evaluates binary multiplication (*) for the given type; this will throw + an InvalidOperationException if the type T does not provide this operator, or for + Nullable<TInner> if TInner does not provide this operator. + </summary> + </member> + <member name="M:MiscUtil.Operator.MultiplyAlternative``2(``0,``1)"> + <summary> + Evaluates binary multiplication (*) for the given type(s); this will throw + an InvalidOperationException if the type T does not provide this operator, or for + Nullable<TInner> if TInner does not provide this operator. + </summary> + </member> + <member name="M:MiscUtil.Operator.Divide``1(``0,``0)"> + <summary> + Evaluates binary division (/) for the given type; this will throw + an InvalidOperationException if the type T does not provide this operator, or for + Nullable<TInner> if TInner does not provide this operator. + </summary> + </member> + <member name="M:MiscUtil.Operator.DivideAlternative``2(``0,``1)"> + <summary> + Evaluates binary division (/) for the given type(s); this will throw + an InvalidOperationException if the type T does not provide this operator, or for + Nullable<TInner> if TInner does not provide this operator. + </summary> + </member> + <member name="M:MiscUtil.Operator.Equal``1(``0,``0)"> + <summary> + Evaluates binary equality (==) for the given type; this will throw + an InvalidOperationException if the type T does not provide this operator, or for + Nullable<TInner> if TInner does not provide this operator. + </summary> + </member> + <member name="M:MiscUtil.Operator.NotEqual``1(``0,``0)"> + <summary> + Evaluates binary inequality (!=) for the given type; this will throw + an InvalidOperationException if the type T does not provide this operator, or for + Nullable<TInner> if TInner does not provide this operator. + </summary> + </member> + <member name="M:MiscUtil.Operator.GreaterThan``1(``0,``0)"> + <summary> + Evaluates binary greater-than (>) for the given type; this will throw + an InvalidOperationException if the type T does not provide this operator, or for + Nullable<TInner> if TInner does not provide this operator. + </summary> + </member> + <member name="M:MiscUtil.Operator.LessThan``1(``0,``0)"> + <summary> + Evaluates binary less-than (<) for the given type; this will throw + an InvalidOperationException if the type T does not provide this operator, or for + Nullable<TInner> if TInner does not provide this operator. + </summary> + </member> + <member name="M:MiscUtil.Operator.GreaterThanOrEqual``1(``0,``0)"> + <summary> + Evaluates binary greater-than-on-eqauls (>=) for the given type; this will throw + an InvalidOperationException if the type T does not provide this operator, or for + Nullable<TInner> if TInner does not provide this operator. + </summary> + </member> + <member name="M:MiscUtil.Operator.LessThanOrEqual``1(``0,``0)"> + <summary> + Evaluates binary less-than-or-equal (<=) for the given type; this will throw + an InvalidOperationException if the type T does not provide this operator, or for + Nullable<TInner> if TInner does not provide this operator. + </summary> + </member> + <member name="M:MiscUtil.Operator.DivideInt32``1(``0,System.Int32)"> + <summary> + Evaluates integer division (/) for the given type; this will throw + an InvalidOperationException if the type T does not provide this operator, or for + Nullable<TInner> if TInner does not provide this operator. + </summary><remarks> + This operation is particularly useful for computing averages and + similar aggregates. + </remarks> + </member> + <member name="T:MiscUtil.Operator`2"> + <summary> + Provides standard operators (such as addition) that operate over operands of + different types. For operators, the return type is assumed to match the first + operand. + </summary> + <seealso cref="T:MiscUtil.Operator`1"/> + <seealso cref="T:MiscUtil.Operator"/> + </member> + <member name="P:MiscUtil.Operator`2.Convert"> + <summary> + Returns a delegate to convert a value between two types; this delegate will throw + an InvalidOperationException if the type T does not provide a suitable cast, or for + Nullable<TInner> if TInner does not provide this cast. + </summary> + </member> + <member name="P:MiscUtil.Operator`2.Add"> + <summary> + Returns a delegate to evaluate binary addition (+) for the given types; this delegate will throw + an InvalidOperationException if the type T does not provide this operator, or for + Nullable<TInner> if TInner does not provide this operator. + </summary> + </member> + <member name="P:MiscUtil.Operator`2.Subtract"> + <summary> + Returns a delegate to evaluate binary subtraction (-) for the given types; this delegate will throw + an InvalidOperationException if the type T does not provide this operator, or for + Nullable<TInner> if TInner does not provide this operator. + </summary> + </member> + <member name="P:MiscUtil.Operator`2.Multiply"> + <summary> + Returns a delegate to evaluate binary multiplication (*) for the given types; this delegate will throw + an InvalidOperationException if the type T does not provide this operator, or for + Nullable<TInner> if TInner does not provide this operator. + </summary> + </member> + <member name="P:MiscUtil.Operator`2.Divide"> + <summary> + Returns a delegate to evaluate binary division (/) for the given types; this delegate will throw + an InvalidOperationException if the type T does not provide this operator, or for + Nullable<TInner> if TInner does not provide this operator. + </summary> + </member> + <member name="T:MiscUtil.Operator`1"> + <summary> + Provides standard operators (such as addition) over a single type + </summary> + <seealso cref="T:MiscUtil.Operator"/> + <seealso cref="T:MiscUtil.Operator`2"/> + </member> + <member name="P:MiscUtil.Operator`1.Zero"> + <summary> + Returns the zero value for value-types (even full Nullable<TInner>) - or null for reference types + </summary> + </member> + <member name="P:MiscUtil.Operator`1.Negate"> + <summary> + Returns a delegate to evaluate unary negation (-) for the given type; this delegate will throw + an InvalidOperationException if the type T does not provide this operator, or for + Nullable<TInner> if TInner does not provide this operator. + </summary> + </member> + <member name="P:MiscUtil.Operator`1.Not"> + <summary> + Returns a delegate to evaluate bitwise not (~) for the given type; this delegate will throw + an InvalidOperationException if the type T does not provide this operator, or for + Nullable<TInner> if TInner does not provide this operator. + </summary> + </member> + <member name="P:MiscUtil.Operator`1.Or"> + <summary> + Returns a delegate to evaluate bitwise or (|) for the given type; this delegate will throw + an InvalidOperationException if the type T does not provide this operator, or for + Nullable<TInner> if TInner does not provide this operator. + </summary> + </member> + <member name="P:MiscUtil.Operator`1.And"> + <summary> + Returns a delegate to evaluate bitwise and (&) for the given type; this delegate will throw + an InvalidOperationException if the type T does not provide this operator, or for + Nullable<TInner> if TInner does not provide this operator. + </summary> + </member> + <member name="P:MiscUtil.Operator`1.Xor"> + <summary> + Returns a delegate to evaluate bitwise xor (^) for the given type; this delegate will throw + an InvalidOperationException if the type T does not provide this operator, or for + Nullable<TInner> if TInner does not provide this operator. + </summary> + </member> + <member name="P:MiscUtil.Operator`1.Add"> + <summary> + Returns a delegate to evaluate binary addition (+) for the given type; this delegate will throw + an InvalidOperationException if the type T does not provide this operator, or for + Nullable<TInner> if TInner does not provide this operator. + </summary> + </member> + <member name="P:MiscUtil.Operator`1.Subtract"> + <summary> + Returns a delegate to evaluate binary subtraction (-) for the given type; this delegate will throw + an InvalidOperationException if the type T does not provide this operator, or for + Nullable<TInner> if TInner does not provide this operator. + </summary> + </member> + <member name="P:MiscUtil.Operator`1.Multiply"> + <summary> + Returns a delegate to evaluate binary multiplication (*) for the given type; this delegate will throw + an InvalidOperationException if the type T does not provide this operator, or for + Nullable<TInner> if TInner does not provide this operator. + </summary> + </member> + <member name="P:MiscUtil.Operator`1.Divide"> + <summary> + Returns a delegate to evaluate binary division (/) for the given type; this delegate will throw + an InvalidOperationException if the type T does not provide this operator, or for + Nullable<TInner> if TInner does not provide this operator. + </summary> + </member> + <member name="P:MiscUtil.Operator`1.Equal"> + <summary> + Returns a delegate to evaluate binary equality (==) for the given type; this delegate will throw + an InvalidOperationException if the type T does not provide this operator, or for + Nullable<TInner> if TInner does not provide this operator. + </summary> + </member> + <member name="P:MiscUtil.Operator`1.NotEqual"> + <summary> + Returns a delegate to evaluate binary inequality (!=) for the given type; this delegate will throw + an InvalidOperationException if the type T does not provide this operator, or for + Nullable<TInner> if TInner does not provide this operator. + </summary> + </member> + <member name="P:MiscUtil.Operator`1.GreaterThan"> + <summary> + Returns a delegate to evaluate binary greater-then (>) for the given type; this delegate will throw + an InvalidOperationException if the type T does not provide this operator, or for + Nullable<TInner> if TInner does not provide this operator. + </summary> + </member> + <member name="P:MiscUtil.Operator`1.LessThan"> + <summary> + Returns a delegate to evaluate binary less-than (<) for the given type; this delegate will throw + an InvalidOperationException if the type T does not provide this operator, or for + Nullable<TInner> if TInner does not provide this operator. + </summary> + </member> + <member name="P:MiscUtil.Operator`1.GreaterThanOrEqual"> + <summary> + Returns a delegate to evaluate binary greater-than-or-equal (>=) for the given type; this delegate will throw + an InvalidOperationException if the type T does not provide this operator, or for + Nullable<TInner> if TInner does not provide this operator. + </summary> + </member> + <member name="P:MiscUtil.Operator`1.LessThanOrEqual"> + <summary> + Returns a delegate to evaluate binary less-than-or-equal (<=) for the given type; this delegate will throw + an InvalidOperationException if the type T does not provide this operator, or for + Nullable<TInner> if TInner does not provide this operator. + </summary> + </member> + <member name="T:DotSpatial.Data.PointShape"> + <summary> + PointShape + </summary> + </member> + <member name="M:DotSpatial.Data.PointShape.Intersects(DotSpatial.Data.ShapeRange,DotSpatial.Data.ShapeRange)"> + <summary> + Calculates the intersection of a polygon shape without relying on the NTS geometry + </summary> + <param name="pointShape"></param> + <param name="otherShape"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.PointShape.VerticesIntersect(DotSpatial.Data.ShapeRange,DotSpatial.Data.ShapeRange)"> + <summary> + Returns true if any vertices overlap + </summary> + <returns></returns> + </member> + <member name="P:DotSpatial.Data.PointShape.Epsilon"> + <summary> + Gets or sets the precision for calculating equality, but this is just a re-direction to Vertex.Epsilon + </summary> + </member> + <member name="T:DotSpatial.Data.PointShapefileFeatureSource"> + <summary> + This class is strictly the vector access code. This does not handle + the attributes, which must be handled independantly. + </summary> + </member> + <member name="M:DotSpatial.Data.PointShapefileFeatureSource.#ctor(System.String)"> + <summary> + Sets the fileName and creates a new PointShapefileFeatureSource for the specified file. + </summary> + <param name="fileName">The fileName to work with.</param> + </member> + <member name="M:DotSpatial.Data.PointShapefileFeatureSource.#ctor(System.String,System.Boolean,System.Boolean)"> + <summary> + Sets the fileName and creates a new PointshapefileFeatureSource for the specified file (and builds spatial index if requested) + </summary> + <param name="fileName"></param> + <param name="useSpatialIndexing"></param> + <param name="trackDeletedRows"></param> + </member> + <member name="M:DotSpatial.Data.PointShapefileFeatureSource.AppendBasicGeometry(DotSpatial.Data.ShapefileHeader,DotSpatial.Topology.IBasicGeometry,System.Int32)"> + <inheritdocs/> + </member> + <member name="M:DotSpatial.Data.PointShapefileFeatureSource.CreateShapeSource"> + <inheritdocs/> + </member> + <member name="M:DotSpatial.Data.PointShapefileFeatureSource.UpdateExtents"> + <inheritdocs/> + </member> + <member name="M:DotSpatial.Data.PointShapefileFeatureSource.Select(System.String,DotSpatial.Topology.IEnvelope,System.Int32@,System.Int32)"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.PointShapefileFeatureSource.SearchAndModifyAttributes(DotSpatial.Topology.IEnvelope,System.Int32,DotSpatial.Data.FeatureSourceRowEditEvent)"> + <inheritdoc/> + </member> + <member name="P:DotSpatial.Data.PointShapefileFeatureSource.FeatureType"> + <inheritdocs/> + </member> + <member name="P:DotSpatial.Data.PointShapefileFeatureSource.ShapeType"> + <inheritdocs/> + </member> + <member name="P:DotSpatial.Data.PointShapefileFeatureSource.ShapeTypeM"> + <inheritdocs/> + </member> + <member name="P:DotSpatial.Data.PointShapefileFeatureSource.ShapeTypeZ"> + <inheritdocs/> + </member> + <member name="T:DotSpatial.Data.PointShapefileShapeSource"> + <summary> + Retrieves specific shapes. + </summary> + </member> + <member name="M:DotSpatial.Data.PointShapefileShapeSource.#ctor(System.String)"> + <summary> + Creates a new instance of the PointShapefileShapeSource with the specified point + shapefile as the source. + </summary> + <param name="fileName">The string fileName</param> + </member> + <member name="M:DotSpatial.Data.PointShapefileShapeSource.#ctor(System.String,DotSpatial.Topology.Index.ISpatialIndex,DotSpatial.Data.ShapefileIndexFile)"> + <summary> + Creates a new instance of the PointShapefileShapeSource with the specified polygon shapefile as the source and provided indices + </summary> + <param name="fileName"></param> + <param name="spatialIndex"></param> + <param name="shx"></param> + </member> + <member name="M:DotSpatial.Data.PointShapefileShapeSource.GetShapeAtIndex(System.IO.FileStream,DotSpatial.Data.ShapefileIndexFile,DotSpatial.Data.ShapefileHeader,System.Int32,DotSpatial.Topology.IEnvelope)"> + <inheritdocs/> + </member> + <member name="P:DotSpatial.Data.PointShapefileShapeSource.ShapeType"> + <inheritdocs/> + </member> + <member name="P:DotSpatial.Data.PointShapefileShapeSource.ShapeTypeM"> + <inheritdocs/> + </member> + <member name="P:DotSpatial.Data.PointShapefileShapeSource.ShapeTypeZ"> + <inheritdocs/> + </member> + <member name="P:DotSpatial.Data.PointShapefileShapeSource.FeatureType"> + <inheritdocs/> + </member> + <member name="T:DotSpatial.Data.PolygonShape"> + <summary> + Polygon contains algorithms for the case where the current feature type is a polygon. The shape may be single or multi-part. + </summary> + </member> + <member name="M:DotSpatial.Data.PolygonShape.Intersects(DotSpatial.Data.ShapeRange,DotSpatial.Data.ShapeRange)"> + <summary> + Calculates the intersection of a polygon shape without relying on the NTS geometry + </summary> + <param name="polygonShape"></param> + <param name="otherShape"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.PolygonShape.ContainsVertex(DotSpatial.Data.ShapeRange,DotSpatial.Data.ShapeRange)"> + <summary> + This cycles through all the vertices, which are stored as {X1, Y1, X2, Y2...Xn, Yn} and tests + if any of those vertices falls within the polygon shape. + </summary> + <param name="polygonShape"></param> + <param name="otherShape"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.PolygonShape.ContainsVertex(DotSpatial.Data.ShapeRange,DotSpatial.Data.PartRange)"> + <summary> + For each coordinate in the other part, if it falls in the extent of this polygon, a + ray crossing test is used for point in polygon testing. If it is not in the extent, + it is skipped. + </summary> + <param name="polygonShape">The part of the polygon to analyze polygon</param> + <param name="otherPart">The other part</param> + <returns>Boolean, true if any coordinate falls inside the polygon</returns> + </member> + <member name="P:DotSpatial.Data.PolygonShape.Epsilon"> + <summary> + Gets or sets the precision for calculating equality, but this is just a re-direction to Vertex.Epsilon + </summary> + </member> + <member name="T:DotSpatial.Data.DataFormat"> + <summary> + DataFormats + </summary> + </member> + <member name="F:DotSpatial.Data.DataFormat.Vector"> + <summary> + Lines, Points and Polygons make up standard static vector formats. + These are drawn dynamically based on the symbolizer. + </summary> + </member> + <member name="F:DotSpatial.Data.DataFormat.Raster"> + <summary> + Rasters are grids of integers, doubles, floats, or other numeric value types. + These can be symbolized and represented as images, but not drawn directly. + </summary> + </member> + <member name="F:DotSpatial.Data.DataFormat.Image"> + <summary> + Images specifically have pixels coordinates that store a color. + These are drawn directly. + </summary> + </member> + <member name="F:DotSpatial.Data.DataFormat.Custom"> + <summary> + This represents an extended format that does not have a formal definition in DotSpatial. + </summary> + </member> + <member name="T:DotSpatial.Data.DataManager"> + <summary> + This can be used as a component to work as a DataManager. This also provides the + very important DefaultDataManager property, which is where the developer controls + what DataManager should be used for their project. + </summary> + </member> + <member name="T:DotSpatial.Data.IDataManager"> + <summary> + IDataManager + </summary> + </member> + <member name="M:DotSpatial.Data.IDataManager.GetFileFormat(System.String)"> + <summary> + This can help determine what kind of file format a file is, without actually opening the file. + </summary> + <param name="fileName">The string fileName to test</param> + <returns>A DataFormats enum</returns> + </member> + <member name="M:DotSpatial.Data.IDataManager.GetFeatureType(System.String)"> + <summary> + Instead of opening the specified file, this simply determines the correct + provider, and requests that the provider check the feature type for vector + formats. + </summary> + <param name="fileName">The string fileName to test</param> + <returns>A FeatureTypes enum</returns> + </member> + <member name="M:DotSpatial.Data.IDataManager.GetSupportedExtensions(System.String)"> + <summary> + Checks a dialog filter and returns a list of just the extensions. + </summary> + <param name="dialogFilter">The Dialog Filter to read extensions from</param> + <returns>A list of extensions</returns> + </member> + <member name="M:DotSpatial.Data.IDataManager.OpenFile(System.String)"> + <summary> + Attempts to call the open fileName method for any IDataProvider plugin + that matches the extension on the string. + </summary> + <param name="fileName">A String fileName to attempt to open.</param> + </member> + <member name="M:DotSpatial.Data.IDataManager.OpenFile(System.String,System.Boolean)"> + <summary> + Attempts to call the open fileName method for any IDataProvider plugin + that matches the extension on the string. + </summary> + <param name="fileName">A String fileName to attempt to open.</param> + <param name="inRam">A boolean value that if true will attempt to force a load of the data into memory. This value overrides the property on this DataManager.</param> + </member> + <member name="M:DotSpatial.Data.IDataManager.OpenFile(System.String,System.Boolean,DotSpatial.Data.IProgressHandler)"> + <summary> + Attempts to call the open fileName method for any IDataProvider plugin + that matches the extension on the string. + </summary> + <param name="fileName">A String fileName to attempt to open.</param> + <param name="inRam">A boolean value that if true will attempt to force a load of the data into memory. This value overrides the property on this DataManager.</param> + <param name="progressHandler">Specifies the progressHandler to receive progress messages. This value overrides the property on this DataManager.</param> + </member> + <member name="M:DotSpatial.Data.IDataManager.OpenImage(System.String)"> + <summary> + Opens the file as an Image and returns an IImageData object for interacting with the file. + </summary> + <param name="fileName">The string fileName</param> + <returns>An IImageData object</returns> + </member> + <member name="M:DotSpatial.Data.IDataManager.OpenImage(System.String,DotSpatial.Data.IProgressHandler)"> + <summary> + Opens the file as an Image and returns an IImageData object + </summary> + <param name="fileName">The string fileName to open</param> + <param name="progressHandler">The progressHandler to receive progress updates</param> + <returns>An IImageData</returns> + </member> + <member name="M:DotSpatial.Data.IDataManager.OpenRaster(System.String)"> + <summary> + Opens the specified fileName, returning an IRaster. This will return null if a manager + either returns the wrong data format. + </summary> + <param name="fileName">The string fileName to open</param> + <returns>An IRaster loaded from the specified file.</returns> + </member> + <member name="M:DotSpatial.Data.IDataManager.OpenRaster(System.String,System.Boolean,DotSpatial.Data.IProgressHandler)"> + <summary> + Opens the specified fileName, returning an IRaster. This will return null if a manager + either returns the wrong data format. + </summary> + <param name="fileName">The string fileName to open</param> + <param name="inRam">boolean, true if this should be loaded into ram</param> + <param name="prog">a progress interface</param> + <returns>An IRaster loaded from the specified file</returns> + </member> + <member name="M:DotSpatial.Data.IDataManager.OpenVector(System.String,System.Boolean,DotSpatial.Data.IProgressHandler)"> + <summary> + Opens a specified file as an IFeatureSet + </summary> + <param name="fileName">The string fileName to open</param> + <param name="inRam">boolean, true if this should be loaded into ram</param> + <param name="prog">a progress interface</param> + <returns>An IFeatureSet loaded from the specified file</returns> + </member> + <member name="M:DotSpatial.Data.IDataManager.CreateImage(System.String,System.Int32,System.Int32,DotSpatial.Data.ImageBandType)"> + <summary> + Creates a new image using an appropriate data provider + </summary> + <param name="fileName">The string fileName to open an image for</param> + <param name="numRows">The integer number of rows</param> + <param name="numColumns">The integer number of columns</param> + <param name="bandType">The color band type.</param> + <returns>An IImageData interface allowing access to image data</returns> + </member> + <member name="M:DotSpatial.Data.IDataManager.CreateImage(System.String,System.Int32,System.Int32,System.Boolean,DotSpatial.Data.ImageBandType)"> + <summary> + Creates a new image using an appropriate data provider + </summary> + <param name="fileName">The string fileName to open an image for</param> + <param name="numRows">The integer number of rows</param> + <param name="numColumns">The integer number of columns</param> + <param name="inRam">Boolean, true if the entire file should be created in memory</param> + <param name="bandType">The color band type.</param> + <returns>An IImageData interface allowing access to image data</returns> + </member> + <member name="M:DotSpatial.Data.IDataManager.CreateImage(System.String,System.Int32,System.Int32,System.Boolean,DotSpatial.Data.IProgressHandler,DotSpatial.Data.ImageBandType)"> + <summary> + Creates a new image using an appropriate data provider + </summary> + <param name="fileName">The string fileName to open an image for</param> + <param name="numRows">The integer number of rows</param> + <param name="numColumns">The integer number of columns</param> + <param name="inRam">Boolean, true if the entire file should be created in memory</param> + <param name="progHandler">A Progress handler</param> + <param name="bandType">The color band type.</param> + <returns>An IImageData interface allowing access to image data</returns> + + </member> + <member name="M:DotSpatial.Data.IDataManager.CreateVector(System.String,DotSpatial.Topology.FeatureType)"> + <summary> + Creates a new class of vector that matches the given fileName. + </summary> + <param name="fileName">The string fileName from which to create a vector.</param> + <param name="featureType">Specifies the type of feature for this vector file</param> + <returns>An IFeatureSet that allows working with the dataset.</returns> + </member> + <member name="M:DotSpatial.Data.IDataManager.CreateVector(System.String,DotSpatial.Topology.FeatureType,DotSpatial.Data.IProgressHandler)"> + <summary> + Creates a new class of vector that matches the given fileName. + </summary> + <param name="fileName">The string fileName from which to create a vector.</param> + <param name="featureType">Specifies the type of feature for this vector file</param> + <param name="progHandler">Overrides the default progress handler with the specified progress handler</param> + <returns>An IFeatureSet that allows working with the dataset.</returns> + </member> + <member name="M:DotSpatial.Data.IDataManager.CreateRaster(System.String,System.String,System.Int32,System.Int32,System.Int32,System.Type,System.String[])"> + <summary> + Creates a new raster using the specified raster provider and the Data Manager's Progress Handler, + as well as its LoadInRam property. + </summary> + <param name="name">The fileName of the new file to create.</param> + <param name="driverCode">The string code identifying the driver to use to create the raster</param> + <param name="xSize">The number of columns in the raster</param> + <param name="ySize">The number of rows in the raster</param> + <param name="numBands">The number of bands in the raster</param> + <param name="dataType">The data type for the raster</param> + <param name="options">Any additional, driver specific options for creation</param> + <returns>An IRaster representing the created raster.</returns> + </member> + <member name="P:DotSpatial.Data.IDataManager.DataProviders"> + <summary> + Gets or sets the list of IDataProviders that should be used in the project. + </summary> + </member> + <member name="P:DotSpatial.Data.IDataManager.DialogReadFilter"> + <summary> + Gets or sets the dialog read filter to use for opening data files. + </summary> + </member> + <member name="P:DotSpatial.Data.IDataManager.DialogWriteFilter"> + <summary> + Gets or sets the dialog write filter to use for saving data files. + </summary> + </member> + <member name="P:DotSpatial.Data.IDataManager.LoadInRam"> + <summary> + Sets the default condition for how this data manager should try to load layers. + This will be overridden if the inRam property is specified as a parameter. + </summary> + </member> + <member name="P:DotSpatial.Data.IDataManager.RasterReadFilter"> + <summary> + Gets or sets the dialog read filter to use for opening data files that are specifically raster formats. + </summary> + </member> + <member name="P:DotSpatial.Data.IDataManager.RasterWriteFilter"> + <summary> + Gets or sets the dialog write filter to use for saving raster files. + </summary> + </member> + <member name="P:DotSpatial.Data.IDataManager.VectorReadFilter"> + <summary> + Gets or sets the dialog read filter to use for opening vector files. + </summary> + </member> + <member name="P:DotSpatial.Data.IDataManager.VectorWriteFilter"> + <summary> + Gets or sets the dialog write filter to use for saving vector files. + </summary> + </member> + <member name="P:DotSpatial.Data.IDataManager.ImageReadFilter"> + <summary> + Gets or sets the dialog read filter to use for opening image files. + </summary> + </member> + <member name="P:DotSpatial.Data.IDataManager.ImageWriteFilter"> + <summary> + Gets or sets the dialog write filter to use for saving image files. + </summary> + </member> + <member name="P:DotSpatial.Data.IDataManager.PreferredProviders"> + <summary> + Gets or sets a dictionary of IDataProviders keyed by the extension. The + standard order is to try to load the data using a PreferredProvider. If that + fails, then it will check the list of dataProviders, and finally, if that fails, + it will check the plugin Data Providers in directories. + </summary> + </member> + <member name="P:DotSpatial.Data.IDataManager.ProgressHandler"> + <summary> + Gets or sets a progress handler for any open operations that are intiated by this + DataManager. + </summary> + </member> + <member name="E:DotSpatial.Data.IDataManager.DirectoryProvidersLoaded"> + <summary> + Occurs after the directory providers have been loaded into the project. + </summary> + </member> + <member name="M:DotSpatial.Data.DataManager.#ctor"> + <summary> + Creates a new instance of the DataManager class. A data manager is more or less + just a list of data providers to use. The very important + DataManager.DefaultDataManager property controls which DataManager will be used + to load data. By default, each DataManager sets itself as the default in its + constructor. + </summary> + </member> + <member name="M:DotSpatial.Data.DataManager.CreateVector(System.String,DotSpatial.Topology.FeatureType)"> + <summary> + Creates a new class of vector that matches the given fileName. + </summary> + <param name="fileName">The string fileName from which to create a vector.</param> + <param name="featureType">Specifies the type of feature for this vector file</param> + <returns>An IFeatureSet that allows working with the dataset.</returns> + </member> + <member name="M:DotSpatial.Data.DataManager.CreateVector(System.String,DotSpatial.Topology.FeatureType,DotSpatial.Data.IProgressHandler)"> + <summary> + Creates a new class of vector that matches the given fileName. + </summary> + <param name="fileName">The string fileName from which to create a vector.</param> + <param name="featureType">Specifies the type of feature for this vector file</param> + <param name="progHandler">Overrides the default progress handler with the specified progress handler</param> + <returns>An IFeatureSet that allows working with the dataset.</returns> + <exception cref="T:System.ArgumentNullException">Raised when fileName is null.</exception> + <exception cref="T:System.IO.IOException">Raised when suitable DataProvider not found.</exception> + </member> + <member name="M:DotSpatial.Data.DataManager.GetSupportedExtensions(System.String)"> + <summary> + Checks a dialog filter and returns a list of just the extensions. + </summary> + <param name="dialogFilter">The Dialog Filter to read extensions from</param> + <returns>A list of extensions</returns> + </member> + <member name="M:DotSpatial.Data.DataManager.GetFileFormat(System.String)"> + <summary> + This can help determine what kind of file format a file is, without actually opening the file. + </summary> + <param name="fileName"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.DataManager.GetFeatureType(System.String)"> + <summary> + Instead of opening the specified file, this simply determines the correct + provider, and requests that the provider check the feature type for vector + formats. + </summary> + <param name="fileName"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.DataManager.OpenRaster(System.String)"> + <summary> + Opens the specified fileName, returning an IRaster. This will return null if a manager + either returns the wrong data format. + </summary> + <param name="fileName">The string fileName to open</param> + <returns>An IRaster loaded from the specified file.</returns> + </member> + <member name="M:DotSpatial.Data.DataManager.OpenRaster(System.String,System.Boolean,DotSpatial.Data.IProgressHandler)"> + <summary> + Opens the specified fileName, returning an IRaster. This will return null if a manager + either returns the wrong data format. + </summary> + <param name="fileName">The string fileName to open</param> + <param name="inRam">boolean, true if this should be loaded into ram</param> + <param name="prog">a progress interface</param> + <returns>An IRaster loaded from the specified file</returns> + </member> + <member name="M:DotSpatial.Data.DataManager.OpenVector(System.String,System.Boolean,DotSpatial.Data.IProgressHandler)"> + <summary> + Opens a specified file as an IFeatureSet + </summary> + <param name="fileName">The string fileName to open</param> + <param name="inRam">boolean, true if this should be loaded into ram</param> + <param name="prog">a progress interface</param> + <returns>An IFeatureSet loaded from the specified file</returns> + </member> + <member name="M:DotSpatial.Data.DataManager.OpenImage(System.String)"> + <summary> + Opens the file as an Image and returns an IImageData object for interacting with the file. + </summary> + <param name="fileName">The string fileName</param> + <returns>An IImageData object</returns> + </member> + <member name="M:DotSpatial.Data.DataManager.OpenImage(System.String,DotSpatial.Data.IProgressHandler)"> + <summary> + Opens the file as an Image and returns an IImageData object + </summary> + <param name="fileName">The string fileName to open</param> + <param name="progressHandler">The progressHandler to receive progress updates</param> + <returns>An IImageData</returns> + </member> + <member name="M:DotSpatial.Data.DataManager.OpenFile(System.String)"> + <summary> + Attempts to call the open fileName method for any IDataProvider plugin + that matches the extension on the string. + </summary> + <param name="fileName">A String fileName to attempt to open.</param> + </member> + <member name="M:DotSpatial.Data.DataManager.OpenFile(System.String,System.Boolean)"> + <summary> + Attempts to call the open fileName method for any IDataProvider plugin + that matches the extension on the string. + </summary> + <param name="fileName">A String fileName to attempt to open.</param> + <param name="inRam">A boolean value that if true will attempt to force a load of the data into memory. This value overrides the property on this DataManager.</param> + </member> + <member name="M:DotSpatial.Data.DataManager.OpenFile(System.String,System.Boolean,DotSpatial.Data.IProgressHandler)"> + <summary> + Attempts to call the open fileName method for any IDataProvider plugin + that matches the extension on the string. + </summary> + <param name="fileName">A String fileName to attempt to open.</param> + <param name="inRam">A boolean value that if true will attempt to force a load of the data into memory. This value overrides the property on this DataManager.</param> + <param name="progressHandler">Specifies the progressHandler to receive progress messages. This value overrides the property on this DataManager.</param> + </member> + <member name="M:DotSpatial.Data.DataManager.CreateImage(System.String,System.Int32,System.Int32,DotSpatial.Data.ImageBandType)"> + <summary> + Creates a new image using an appropriate data provider + </summary> + <param name="fileName">The string fileName to open an image for</param> + <param name="width">The integer width in pixels</param> + <param name="height">The integer height in pixels</param> + <param name="bandType">The band color type</param> + <returns>An IImageData interface allowing access to image data</returns> + </member> + <member name="M:DotSpatial.Data.DataManager.CreateImage(System.String,System.Int32,System.Int32,System.Boolean,DotSpatial.Data.ImageBandType)"> + <summary> + Creates a new image using an appropriate data provider + </summary> + <param name="fileName">The string fileName to open an image for</param> + <param name="width">The integer width in pixels</param> + <param name="height">The integer height in pixels</param> + <param name="inRam">Boolean, true if the entire file should be created in memory</param> + <param name="bandType">The band color type</param> + <returns>An IImageData interface allowing access to image data</returns> + </member> + <member name="M:DotSpatial.Data.DataManager.CreateImage(System.String,System.Int32,System.Int32,System.Boolean,DotSpatial.Data.IProgressHandler,DotSpatial.Data.ImageBandType)"> + <summary> + Creates a new image using an appropriate data provider + </summary> + <param name="fileName">The string fileName to open an image for</param> + <param name="width">The integer width in pixels</param> + <param name="height">The integer height in pixels</param> + <param name="inRam">Boolean, true if the entire file should be created in memory</param> + <param name="progHandler">A Progress handler</param> + <param name="bandType">The band color type</param> + <returns>An IImageData interface allowing access to image data</returns> + </member> + <member name="M:DotSpatial.Data.DataManager.CreateRaster(System.String,System.String,System.Int32,System.Int32,System.Int32,System.Type,System.String[])"> + <summary> + Creates a new raster using the specified raster provider and the Data Manager's Progress Handler, + as well as its LoadInRam property. + </summary> + <param name="name">The fileName of the new file to create.</param> + <param name="driverCode">The string code identifying the driver to use to create the raster. If no code is specified + the manager will attempt to match the extension with a code specified in the Dialog write filter. </param> + <param name="xSize">The number of columns in the raster</param> + <param name="ySize">The number of rows in the raster</param> + <param name="numBands">The number of bands in the raster</param> + <param name="dataType">The data type for the raster</param> + <param name="options">Any additional, driver specific options for creation</param> + <returns>An IRaster representing the created raster.</returns> + </member> + <member name="M:DotSpatial.Data.DataManager.OpenFileAsIRaster(System.String,System.Boolean,DotSpatial.Data.IProgressHandler)"> + <summary> + Opens the file making sure it can be returned as an IRaster. + </summary> + <param name="fileName">Name of the file.</param> + <param name="inRam">if set to <c>true</c> [in ram].</param> + <param name="progressHandler">The progress handler.</param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.DataManager.OnProvidersLoaded(System.Collections.Generic.IEnumerable{DotSpatial.Data.IDataProvider})"> + <summary> + Triggers the DirectoryProvidersLoaded event + </summary> + </member> + <member name="P:DotSpatial.Data.DataManager.DefaultDataManager"> + <summary> + Gets or sets the implementation of IDataManager for the project to use when + accessing data. This is THE place where the DataManager can be replaced + by a different data manager. If you add this data manager to your + project, this will automatically set itself as the DefaultDataManager. + However, since each DM will do this, you may have to control this manually + if you add more than one DataManager to the project in order to set the + one that will be chosen. + </summary> + </member> + <member name="P:DotSpatial.Data.DataManager.DataProviders"> + <summary> + Gets or sets the list of IDataProviders that should be used in the project. + </summary> + </member> + <member name="P:DotSpatial.Data.DataManager.DialogReadFilter"> + <summary> + Gets or sets the dialog read filter to use for opening data files. + </summary> + </member> + <member name="P:DotSpatial.Data.DataManager.DialogWriteFilter"> + <summary> + Gets or sets the dialog write filter to use for saving data files. + </summary> + </member> + <member name="P:DotSpatial.Data.DataManager.RasterReadFilter"> + <summary> + Gets or sets the dialog read filter to use for opening data files that are specifically raster formats. + </summary> + </member> + <member name="P:DotSpatial.Data.DataManager.RasterWriteFilter"> + <summary> + Gets or sets the dialog write filter to use for saving data files. + </summary> + </member> + <member name="P:DotSpatial.Data.DataManager.VectorReadFilter"> + <summary> + Gets or sets the dialog read filter to use for opening data files. + </summary> + </member> + <member name="P:DotSpatial.Data.DataManager.VectorWriteFilter"> + <summary> + Gets or sets the dialog write filter to use for saving data files. + </summary> + </member> + <member name="P:DotSpatial.Data.DataManager.ImageReadFilter"> + <summary> + Gets or sets the dialog read filter to use for opening data files. + </summary> + </member> + <member name="P:DotSpatial.Data.DataManager.ImageWriteFilter"> + <summary> + Gets or sets the dialog write filter to use for saving data files. + </summary> + </member> + <member name="P:DotSpatial.Data.DataManager.LoadInRam"> + <summary> + Sets the default condition for how this data manager should try to load layers. + This will be overridden if the inRam property is specified as a parameter. + </summary> + </member> + <member name="P:DotSpatial.Data.DataManager.PreferredProviders"> + <summary> + Gets or sets a dictionary of IDataProviders with corresponding extensions. The + standard order is to try to load the data using a PreferredProvider. If that + fails, then it will check the list of dataProviders, and finally, if that fails, + it will check the plugin Data Providers in directories. + </summary> + </member> + <member name="P:DotSpatial.Data.DataManager.ProgressHandler"> + <summary> + Gets or sets a progress handler for any open operations that are intiated by this + DataManager and don't override this value with an IProgressHandler specified in the parameters. + </summary> + </member> + <member name="E:DotSpatial.Data.DataManager.DirectoryProvidersLoaded"> + <summary> + Occurs after the directory providers have been loaded into the project. + </summary> + </member> + <member name="T:DotSpatial.Data.DataProviderEventArgs"> + <summary> + DataProviders + </summary> + </member> + <member name="M:DotSpatial.Data.DataProviderEventArgs.#ctor(System.Collections.Generic.IEnumerable{DotSpatial.Data.IDataProvider})"> + <summary> + Creates a new instance of DataProviders + </summary> + <param name="providers">Specifies a list of IDataProviders</param> + </member> + <member name="P:DotSpatial.Data.DataProviderEventArgs.Providers"> + <summary> + Gets the list of providers for this event. + </summary> + </member> + <member name="T:DotSpatial.Data.RasterFileMode"> + <summary> + Clarifies how the file should be used + </summary> + </member> + <member name="F:DotSpatial.Data.RasterFileMode.Read"> + <summary> + Read will attempt to read the file if it exists and throw an exception if the file is not found + </summary> + </member> + <member name="F:DotSpatial.Data.RasterFileMode.Write"> + <summary> + Write will create a new file, overwriting it if it previously exists. + </summary> + </member> + <member name="T:DotSpatial.Data.PolygonShapefileFeatureSource"> + <summary> + This class is strictly the vector access code. This does not handle + the attributes, which must be handled independantly. + </summary> + </member> + <member name="M:DotSpatial.Data.PolygonShapefileFeatureSource.#ctor(System.String)"> + <summary> + Sets the fileName and creates a new PolygonshapefileFeatureSource for the specified file. + </summary> + <param name="fileName">The fileName to work with.</param> + </member> + <member name="M:DotSpatial.Data.PolygonShapefileFeatureSource.#ctor(System.String,System.Boolean,System.Boolean)"> + <summary> + Sets the fileName and creates a new PolygonshapefileFeatureSource for the specified file (and builds spatial index if requested) + </summary> + <param name="fileName"></param> + <param name="useSpatialIndexing"></param> + <param name="trackDeletedRows"></param> + </member> + <member name="M:DotSpatial.Data.PolygonShapefileFeatureSource.AppendBasicGeometry(DotSpatial.Data.ShapefileHeader,DotSpatial.Topology.IBasicGeometry,System.Int32)"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.PolygonShapefileFeatureSource.CreateShapeSource"> + <inheritdocs/> + </member> + <member name="M:DotSpatial.Data.PolygonShapefileFeatureSource.UpdateExtents"> + <inheritdocs/> + </member> + <member name="M:DotSpatial.Data.PolygonShapefileFeatureSource.Select(System.String,DotSpatial.Topology.IEnvelope,System.Int32@,System.Int32)"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.PolygonShapefileFeatureSource.SearchAndModifyAttributes(DotSpatial.Topology.IEnvelope,System.Int32,DotSpatial.Data.FeatureSourceRowEditEvent)"> + <inheritdoc/> + </member> + <member name="P:DotSpatial.Data.PolygonShapefileFeatureSource.FeatureType"> + <inheritdocs/> + </member> + <member name="P:DotSpatial.Data.PolygonShapefileFeatureSource.ShapeType"> + <inheritdocs/> + </member> + <member name="P:DotSpatial.Data.PolygonShapefileFeatureSource.ShapeTypeM"> + <inheritdocs/> + </member> + <member name="P:DotSpatial.Data.PolygonShapefileFeatureSource.ShapeTypeZ"> + <inheritdocs/> + </member> + <member name="T:DotSpatial.Data.PolygonShapefileShapeSource"> + <summary> + Retrieves specific shapes. + </summary> + </member> + <member name="M:DotSpatial.Data.PolygonShapefileShapeSource.#ctor(System.String)"> + <summary> + Creates a new instance of the PolygonShapefileShapeSource with the specified polygon + shapefile as the source. + </summary> + <param name="fileName">The string fileName</param> + </member> + <member name="M:DotSpatial.Data.PolygonShapefileShapeSource.#ctor(System.String,DotSpatial.Topology.Index.ISpatialIndex,DotSpatial.Data.ShapefileIndexFile)"> + <summary> + Creates a new instance of the PolygonShapefileShapeSource with the specified polygon shapefile as the source and provided indices + </summary> + <param name="fileName"></param> + <param name="spatialIndex"></param> + <param name="shx"></param> + </member> + <member name="M:DotSpatial.Data.PolygonShapefileShapeSource.GetShapeAtIndex(System.IO.FileStream,DotSpatial.Data.ShapefileIndexFile,DotSpatial.Data.ShapefileHeader,System.Int32,DotSpatial.Topology.IEnvelope)"> + <inheritdocs/> + </member> + <member name="P:DotSpatial.Data.PolygonShapefileShapeSource.ShapeType"> + <inheritdocs/> + </member> + <member name="P:DotSpatial.Data.PolygonShapefileShapeSource.ShapeTypeM"> + <inheritdocs/> + </member> + <member name="P:DotSpatial.Data.PolygonShapefileShapeSource.ShapeTypeZ"> + <inheritdocs/> + </member> + <member name="P:DotSpatial.Data.PolygonShapefileShapeSource.FeatureType"> + <inheritdocs/> + </member> + <member name="T:DotSpatial.Data.ProgressMeter"> + <summary> + This handles the methodology of progress messaging in one place to make it easier to update. + </summary> + </member> + <member name="M:DotSpatial.Data.ProgressMeter.#ctor"> + <summary> + Initializes a new progress meter, but doesn't support the IProgressHandler unless one is specified. + </summary> + </member> + <member name="M:DotSpatial.Data.ProgressMeter.#ctor(DotSpatial.Data.IProgressHandler)"> + <summary> + A progress meter can't actually do anything without a progressHandler, which actually displays the status. + </summary> + <param name="progressHandler">An IProgressHandler that will actually handle the status messages sent by this meter.</param> + </member> + <member name="M:DotSpatial.Data.ProgressMeter.#ctor(DotSpatial.Data.IProgressHandler,System.String)"> + <summary> + A progress meter that simply keeps track of progress and is capable of sending progress messages. + This assumes a MaxValue of 100 unless it is changed later. + </summary> + <param name="progressHandler">Any valid IProgressHandler that will display progress messages</param> + <param name="baseMessage">A base message to use as the basic status for this progress handler.</param> + </member> + <member name="M:DotSpatial.Data.ProgressMeter.#ctor(DotSpatial.Data.IProgressHandler,System.String,System.Object)"> + <summary> + A progress meter that simply keeps track of progress and is capable of sending progress messages. + </summary> + <param name="progressHandler">Any valid implementation if IProgressHandler that will handle the progress function</param> + <param name="baseMessage">The message without any progress information.</param> + <param name="endValue">Percent should show a range between the MinValue and MaxValue. MinValue is assumed to be 0.</param> + </member> + <member name="M:DotSpatial.Data.ProgressMeter.Reset"> + <summary> + Resets the progress meter to the 0 value. This sets the status message to "Ready.". + </summary> + </member> + <member name="M:DotSpatial.Data.ProgressMeter.Next"> + <summary> + This always increments the CurrentValue by one. + </summary> + </member> + <member name="M:DotSpatial.Data.ProgressMeter.SendProgress"> + <summary> + Sends a progress message to the IProgressHandler interface with the current message and progress + </summary> + </member> + <member name="P:DotSpatial.Data.ProgressMeter.BaseMessage"> + <summary> + Gets or sets the string message (without the progress element). + </summary> + </member> + <member name="P:DotSpatial.Data.ProgressMeter.Key"> + <summary> + Gets or sets the string that does not include any mention of progress percentage, but specifies what is occurring. + </summary> + </member> + <member name="P:DotSpatial.Data.ProgressMeter.CurrentPercent"> + <summary> + Gets or sets the current integer progress level from 0 to 100. If a new update is less than or equal to the previous + value, then no progress will be displayed by the ProgressMeter. Values less than 0 are set to 0. Values greater than + 100 are set to 100. + </summary> + </member> + <member name="P:DotSpatial.Data.ProgressMeter.CurrentValue"> + <summary> + Gets or sets the current value relative to the specified MaxValue in order to update the progress. + Setting this will also update OldProgress if there is an integer change in the percentage, and send + a progress message to the IProgressHandler interface. + </summary> + </member> + <member name="P:DotSpatial.Data.ProgressMeter.EndValue"> + <summary> + The value that defines when the meter should show as 100% complete. + EndValue can be less than StartValue, but values closer to EndValue + will show as being closer to 100%. + </summary> + </member> + <member name="P:DotSpatial.Data.ProgressMeter.Silent"> + <summary> + Gets or sets whether the progress meter should send messages to the IProgressHandler. + By default Silent is false, but setting this to true will disable the messaging portion. + </summary> + </member> + <member name="P:DotSpatial.Data.ProgressMeter.StartValue"> + <summary> + The minimum value defines when the meter should show as 0% complete. + </summary> + </member> + <member name="P:DotSpatial.Data.ProgressMeter.StepPercent"> + <summary> + An integer value that is 1 by default. Ordinarily this will send a progress message only when the integer progress + has changed by 1 percentage point. For example, if StepPercent were set to 5, then a progress update would only + be sent out at 5%, 10% and so on. This helps reduce overhead in cases where showing status messages is actually + the majority of the processing time for the function. + </summary> + </member> + <member name="P:DotSpatial.Data.ProgressMeter.PreviousPercent"> + <summary> + Gets or sets the previous integer progress level from 0 to 100. If a new update is less than or equal to the previous + value, then no progress will be displayed by the ProgressMeter. Values less than 0 are set to 0. Values greater than + 100 are set to 100. + </summary> + </member> + <member name="P:DotSpatial.Data.ProgressMeter.ProgressHandler"> + <summary> + Gets or sets the progress handler for this meter + </summary> + </member> + <member name="T:DotSpatial.Symbology.ProjExt"> + <summary> + Extension methods for the IProj interface + </summary> + </member> + <member name="M:DotSpatial.Symbology.ProjExt.PixelToProj(DotSpatial.Data.IProj,System.Drawing.Point)"> + <summary> + Converts a single point location into an equivalent geographic coordinate + </summary> + <param name="self">This IProj</param> + <param name="position">The client coordinate relative to the map control</param> + <returns>The geographic ICoordinate interface</returns> + </member> + <member name="M:DotSpatial.Symbology.ProjExt.PixelToProj(DotSpatial.Data.IProj,System.Drawing.Rectangle)"> + <summary> + Converts a rectangle in pixel coordinates relative to the map control into + a geographic envelope. + </summary> + <param name="self">This IProj</param> + <param name="rect">The rectangle to convert</param> + <returns>An IEnvelope interface</returns> + </member> + <member name="M:DotSpatial.Symbology.ProjExt.PixelToProj(DotSpatial.Data.IProj,System.Collections.Generic.List{System.Drawing.Rectangle})"> + <summary> + Projects all of the rectangles int the specified list of rectangles into geographic regions. + </summary> + <param name="self">This IProj</param> + <param name="clipRects">The clip rectangles</param> + <returns>A List of IEnvelope geographic bounds that correspond to the specified clip rectangles.</returns> + </member> + <member name="M:DotSpatial.Symbology.ProjExt.ProjToPixel(DotSpatial.Data.IProj,DotSpatial.Topology.Coordinate)"> + <summary> + Converts a single geographic location into the equivalent point on the + screen relative to the top left corner of the map. + </summary> + <param name="self">This IProj</param> + <param name="location">The geographic position to transform</param> + <returns>A Point with the new location.</returns> + </member> + <member name="M:DotSpatial.Symbology.ProjExt.ProjToPixel(DotSpatial.Data.IProj,DotSpatial.Data.Extent)"> + <summary> + Converts a single geographic envelope into an equivalent Rectangle + as it would be drawn on the screen. + </summary> + <param name="self">This IProj</param> + <param name="env">The geographic IEnvelope</param> + <returns>A Rectangle</returns> + </member> + <member name="M:DotSpatial.Symbology.ProjExt.ProjToPixel(DotSpatial.Data.IProj,System.Collections.Generic.List{DotSpatial.Data.Extent})"> + <summary> + Translates all of the geographic regions, forming an equivalent list of rectangles. + </summary> + <param name="self">This IProj</param> + <param name="regions">The list of geographic regions to project</param> + <returns>A list of pixel rectangles that describe the specified region</returns> + </member> + <member name="M:DotSpatial.Symbology.ProjExt.ProjToPixel(DotSpatial.Data.IProj,System.Double)"> + <summary> + Calculates an integer length distance in pixels that corresponds to the double + length specified in the image. + </summary> + <param name="self">The IProj that this describes</param> + <param name="distance">The double distance to obtain in pixels</param> + <returns>The integer distance in pixels</returns> + </member> + <member name="T:DotSpatial.Data.RasterBoundDataSet"> + <summary> + This is an abstract base class that represents a datasets that has a RasterBounds on it, and reprojects + by using the RasterBounds. This works for Image and Raster implementations. + </summary> + </member> + <member name="T:DotSpatial.Data.DataSet"> + <summary> + DataSet + </summary> + </member> + <member name="M:DotSpatial.Data.DataSet.ProjectionSupported"> + <summary> + Gets whether or not projection is based on having the libraries available. + </summary> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.DataSet.#ctor"> + <summary> + Creates a new instance of DataSet + </summary> + </member> + <member name="M:DotSpatial.Data.DataSet.Close"> + <summary> + This can be overridden in specific classes if necessary + </summary> + </member> + <member name="M:DotSpatial.Data.DataSet.Reproject(DotSpatial.Projections.ProjectionInfo)"> + <summary> + Reprojects all of the in-ram vertices of featuresets, or else this + simply updates the "Bounds" of the image object. + This will also update the projection to be the specified projection. + </summary> + <param name="targetProjection"> + The projection information to reproject the coordinates to. + </param> + </member> + <member name="M:DotSpatial.Data.DataSet.Dispose(System.Boolean)"> + <summary> + Allows overriding the dispose behavior to handle any resources in addition to what are handled in the + image data class. + </summary> + <param name="disposeManagedResources">A Boolean value that indicates whether the overriding method + should dispose managed resources, or just the unmanaged ones.</param> + </member> + <member name="P:DotSpatial.Data.DataSet.MyExtent"> + <summary> + Gets or sets the cached extent variable. The public Extent is the virtual accessor, + and should not be used from a constructor. MyExtent is protected, not virtual, + and is only visible to inheriting classes, and can be safely set in the constructor. + </summary> + </member> + <member name="P:DotSpatial.Data.DataSet.ProgressMeter"> + <summary> + This is an internal place holder to make it easier to pass around a single progress meter + between methods. This will use lazy instantiation if it is requested before one has + been created. + </summary> + </member> + <member name="P:DotSpatial.Data.DataSet.ProjectionString"> + <summary> + Gets or sets the raw projection string for this dataset. This handles both the + case where projection is unavailable but a projection string needs to + be passed around, and the case when a string is not recognized by the + DotSpatial.Projections library. This is not format restricted, but should match + the original data source as closely as possible. Setting this will also set + the Projection if the Projection library is available and the format successfully + defines a transform by either treating it as an Esri string or a proj4 string. + </summary> + </member> + <member name="P:DotSpatial.Data.DataSet.CanReproject"> + <summary> + Gets a value indicating whether the DotSpatial.Projections assembly is loaded + </summary> + <returns>Boolean, true if the value can reproject.</returns> + </member> + <member name="P:DotSpatial.Data.DataSet.Name"> + <summary> + Gets or sets the string name + </summary> + </member> + <member name="P:DotSpatial.Data.DataSet.Extent"> + <summary> + Gets or sets the extent for the dataset. Usages to Envelope were replaced + as they required an explicit using to DotSpatial.Topology which is not + as intuitive. Extent.ToEnvelope() and new Extent(myEnvelope) convert them. + This is designed to be a virtual member to be overridden by subclasses, + and should not be called directly by the constructor of inheriting classes. + </summary> + </member> + <member name="P:DotSpatial.Data.DataSet.Projection"> + <summary> + Gets or set the projection string + </summary> + </member> + <member name="P:DotSpatial.Data.DataSet.SpaceTimeSupport"> + <summary> + Gets an enumeration specifying if this data supports time, space, both or neither. + </summary> + </member> + <member name="P:DotSpatial.Data.DataSet.TypeName"> + <summary> + Gets or sets the string type name that identifies this dataset + </summary> + </member> + <member name="P:DotSpatial.Data.DataSet.ProgressHandler"> + <summary> + Gets or sets the progress handler to use for internal actions taken by this dataset. + </summary> + </member> + <member name="M:DotSpatial.Data.RasterBoundDataSet.#ctor"> + <summary> + Creates a new instance of the RasterBoundData object, setting up a default RasterBounds. + </summary> + </member> + <member name="M:DotSpatial.Data.RasterBoundDataSet.OnBoundsChanged(DotSpatial.Data.IRasterBounds)"> + <summary> + Occurs when the raster bounds of this data class have changed. + </summary> + </member> + <member name="M:DotSpatial.Data.RasterBoundDataSet.Reproject(DotSpatial.Projections.ProjectionInfo)"> + <summary> + RasterBounds datasets offer a limited sort of reproject on the fly. + This tries to update the bounds by reprojecting the top left and bottom + left and top right coordinates and updating the "affine" transform. + This should not be used if CanReproject is false. + Greater accuracy can be accomplished using the Projective transform, + which is planned to be implemented as a toolbox function. + </summary> + <param name="targetProjection">The projectionInfo to project to.</param> + </member> + <member name="M:DotSpatial.Data.RasterBoundDataSet.Dispose(System.Boolean)"> + <summary> + Disposes the managed memory objects in the ImageData class, and then forwards + the Dispose operation to the internal dataset in the base class, if any. + </summary> + <param name="disposeManagedResources">Boolean, true if both managed and unmanaged resources should be finalized.</param> + </member> + <member name="P:DotSpatial.Data.RasterBoundDataSet.Bounds"> + <summary> + Gets or sets the image bounds being used to define the georeferencing of the image + </summary> + </member> + <member name="P:DotSpatial.Data.RasterBoundDataSet.Extent"> + <summary> + Gets or sets the Bounds.Envelope through an Extents property. + </summary> + </member> + <member name="T:DotSpatial.Data.RasterEventArgs"> + <summary> + An EventArgs specifically tailored to Raster. + </summary> + </member> + <member name="M:DotSpatial.Data.RasterEventArgs.#ctor(DotSpatial.Data.IRaster)"> + <summary> + Initializes a new instance of the RasterEventArgs class. + </summary> + <param name="raster">The IRaster that is involved in this event.</param> + </member> + <member name="P:DotSpatial.Data.RasterEventArgs.Raster"> + <summary> + Gets the Raster associated with this event. + </summary> + </member> + <member name="T:DotSpatial.Data.RowEditEvent"> + <summary> + Callback specified to AttributeTable.Edit() overload + </summary> + <param name="e"></param> + <returns></returns> + </member> + <member name="T:DotSpatial.Data.RowEditEventArgs"> + <summary> + RowEditEvent arguments + </summary> + </member> + <member name="F:DotSpatial.Data.RowEditEventArgs.Columns"> + <summary> + Column information + </summary> + </member> + <member name="F:DotSpatial.Data.RowEditEventArgs.ByteContent"> + <summary> + Actual byte content read from dbase + </summary> + </member> + <member name="F:DotSpatial.Data.RowEditEventArgs.Modified"> + <summary> + One of the SetColumn methods or SetAllColumns has been called + </summary> + </member> + <member name="F:DotSpatial.Data.RowEditEventArgs.RowNumber"> + <summary> + The row being edited + </summary> + </member> + <member name="M:DotSpatial.Data.RowEditEventArgs.#ctor(System.Int32,DotSpatial.Data.Fields)"> + <summary> + Constructor + </summary> + <param name="recordLength"></param> + <param name="columns"></param> + </member> + <member name="M:DotSpatial.Data.RowEditEventArgs.GetChars"> + <summary> + Get the entire buffer as a character array + </summary> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.RowEditEventArgs.ParseColumn(DotSpatial.Data.Field)"> + <summary> + Convert the byte data for a column into the appropriate data value + </summary> + <param name="field">Column information for data value being parsed</param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.RowEditEventArgs.ParseAllColumns"> + <summary> + Convert the all byte data into an array of data values + </summary> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.RowEditEventArgs.SetColumn(DotSpatial.Data.Field,System.Double)"> + <summary> + Convert value to bytes and place in ByteContent at correct location + </summary> + <param name="field">Column information for the conversion</param> + <param name="value"></param> + </member> + <member name="M:DotSpatial.Data.RowEditEventArgs.SetColumn(DotSpatial.Data.Field,System.String)"> + <summary> + Convert value to bytes and place in ByteContent at correct location + </summary> + <param name="field">Column information for the conversion</param> + <param name="value"></param> + </member> + <member name="M:DotSpatial.Data.RowEditEventArgs.SetColumn(DotSpatial.Data.Field,System.Single)"> + <summary> + Convert value to bytes and place in ByteContent at correct location + </summary> + <param name="field">Column information for the conversion</param> + <param name="value"></param> + </member> + <member name="M:DotSpatial.Data.RowEditEventArgs.SetColumn(DotSpatial.Data.Field,System.DBNull)"> + <summary> + Convert value to bytes and place in ByteContent at correct location + </summary> + <param name="field">Column information for the conversion</param> + <param name="dbNull"></param> + </member> + <member name="M:DotSpatial.Data.RowEditEventArgs.SetColumn(DotSpatial.Data.Field,System.Decimal)"> + <summary> + Convert value to bytes and place in ByteContent at correct location + </summary> + <param name="field">Column information for the conversion</param> + <param name="value"></param> + </member> + <member name="M:DotSpatial.Data.RowEditEventArgs.SetColumn(DotSpatial.Data.Field,System.Int64)"> + <summary> + Convert value to bytes and place in ByteContent at correct location + </summary> + <param name="field">Column information for the conversion</param> + <param name="value"></param> + </member> + <member name="M:DotSpatial.Data.RowEditEventArgs.SetColumn(DotSpatial.Data.Field,System.Boolean)"> + <summary> + Convert value to bytes and place in ByteContent at correct location + </summary> + <param name="field">Column information for the conversion</param> + <param name="value"></param> + </member> + <member name="M:DotSpatial.Data.RowEditEventArgs.SetColumn(DotSpatial.Data.Field,System.DateTime)"> + <summary> + Convert value to bytes and place in ByteContent at correct location + </summary> + <param name="field">Column information for the conversion</param> + <param name="value"></param> + </member> + <member name="M:DotSpatial.Data.RowEditEventArgs.SetAllColumns(System.Object[])"> + <summary> + Convert array of values to bytes and fill ByteContent + </summary> + <param name="values"></param> + </member> + <member name="T:DotSpatial.Data.ShapeFactory"> + <summary> + ShapeFactory + </summary> + </member> + <member name="M:DotSpatial.Data.ShapeFactory.#ctor"> + <summary> + for singleton pattern. + </summary> + </member> + <member name="M:DotSpatial.Data.ShapeFactory.CreateMultiPolygonFromCoordinates(System.Collections.Generic.IEnumerable{System.Collections.Generic.IEnumerable{DotSpatial.Topology.Coordinate}})"> + <summary> + Creates a new multi-part polygon shape. Winding order should control holes. + </summary> + <param name="allParts">The list of all the lists of coordinates.</param> + <returns>A new Multi-Polygon Shape.</returns> + </member> + <member name="P:DotSpatial.Data.ShapeFactory.Instance"> + <summary> + Gets the shared instance of the shape factory; + </summary> + </member> + <member name="T:DotSpatial.Data.ShapefileFeatureSourceQuadtree"> + <summary> + Spatial index customized for ShapefileFeatureSources. + </summary> + </member> + <member name="M:DotSpatial.Data.ShapefileFeatureSourceQuadtree.Insert(DotSpatial.Topology.IEnvelope,System.Int32)"> + <summary> + Insert the row + </summary> + <param name="itemEnv"></param> + <param name="item"></param> + </member> + <member name="M:DotSpatial.Data.ShapefileFeatureSourceQuadtree.Remove(DotSpatial.Topology.IEnvelope,System.Int32)"> + <summary> + Remove the row + </summary> + <param name="itemEnv"></param> + <param name="item"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.ShapefileFeatureSourceQuadtree.AdjustNodesForDeletedItem(DotSpatial.Topology.Index.Quadtree.NodeBase,System.Int32)"> + <summary> + When a row is deleted, all other row numbers must be adjusted to compensate for the fact that the shx file gets compressed. + </summary> + <param name="node"></param> + <param name="deletedItem"></param> + </member> + <member name="M:DotSpatial.Data.ShapefileFeatureSourceQuadtree.Remove(DotSpatial.Topology.IEnvelope,System.Object)"> + <summary> + Deprecated. Use Remove(IEnvelope, int item) instead. + </summary> + <param name="itemEnv"></param> + <param name="item"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.ShapefileFeatureSourceQuadtree.Insert(DotSpatial.Topology.IEnvelope,System.Object)"> + <summary> + Deprecated. Use Insert(IEnvelope, int item) instead. + </summary> + <param name="itemEnv"></param> + <param name="item"></param> + </member> + <member name="T:DotSpatial.Data.ShapefileIndexFile"> + <summary> + Index file class for the .shx file + </summary> + </member> + <member name="M:DotSpatial.Data.ShapefileIndexFile.Open(System.String)"> + <summary> + Opens the index file of the specified fileName. If the fileName is not the .shx extension, + then the fileName will be changed too that extension first. + </summary> + <param name="fileName"></param> + </member> + <member name="M:DotSpatial.Data.ShapefileIndexFile.Save"> + <summary> + Saves the file back to the original file, or the currently specified "Filename" property. + </summary> + </member> + <member name="M:DotSpatial.Data.ShapefileIndexFile.SaveAs(System.String)"> + <summary> + Saves the file to the specified fileName. If the extension is not a correct shx extension, + it will be changed to that extensions. + </summary> + <param name="fileName"></param> + </member> + <member name="M:DotSpatial.Data.ShapefileIndexFile.ReadIndexFile(System.String)"> + <summary> + Reads the entire index file in order to get a breakdown of how shapes are broken up. + </summary> + <param name="fileName">A string fileName of the .shx file to read.</param> + <returns>A List of ShapeHeaders that give offsets and lengths so that reading can be optimized</returns> + </member> + <member name="M:DotSpatial.Data.ShapefileIndexFile.WriteHeader(DotSpatial.Data.ShapefileHeader,System.String,System.Int32)"> + <summary> + Writes the current content to the specified file. + </summary> + <param name="header">The header to write</param> + <param name="fileName">Basically the same code can be used for the shp and shx files</param> + <param name="numShapes">The integer number of shapes to write to the file</param> + </member> + <member name="P:DotSpatial.Data.ShapefileIndexFile.Header"> + <summary> + Gets or sets the header + </summary> + </member> + <member name="P:DotSpatial.Data.ShapefileIndexFile.Filename"> + <summary> + Gets or sets the fileName + </summary> + </member> + <member name="P:DotSpatial.Data.ShapefileIndexFile.Shapes"> + <summary> + Gets or sets the list of shape headers + </summary> + </member> + <member name="T:DotSpatial.Data.ShapefileReader"> + <summary> + This combines the attribute table with a shape source in order to allow easy creation of + FeatureTable and FeatureRow constructs. + </summary> + </member> + <member name="M:DotSpatial.Data.ShapefileReader.#ctor(System.String)"> + <summary> + Creates a new ShapefileReader tailored to read a particular file. + </summary> + <param name="filename"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.ShapefileReader.Close"> + <summary> + + </summary> + </member> + <member name="M:DotSpatial.Data.ShapefileReader.GetSchemaTable"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.ShapefileReader.NextResult"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.ShapefileReader.Read"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.ShapefileReader.Dispose"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.ShapefileReader.GetBoolean(System.Int32)"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.ShapefileReader.GetByte(System.Int32)"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.ShapefileReader.GetBytes(System.Int32,System.Int64,System.Byte[],System.Int32,System.Int32)"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.ShapefileReader.GetChar(System.Int32)"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.ShapefileReader.GetChars(System.Int32,System.Int64,System.Char[],System.Int32,System.Int32)"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.ShapefileReader.GetData(System.Int32)"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.ShapefileReader.GetDataTypeName(System.Int32)"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.ShapefileReader.GetDateTime(System.Int32)"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.ShapefileReader.GetDecimal(System.Int32)"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.ShapefileReader.GetDouble(System.Int32)"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.ShapefileReader.GetFieldType(System.Int32)"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.ShapefileReader.GetFloat(System.Int32)"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.ShapefileReader.GetGuid(System.Int32)"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.ShapefileReader.GetInt16(System.Int32)"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.ShapefileReader.GetInt32(System.Int32)"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.ShapefileReader.GetInt64(System.Int32)"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.ShapefileReader.GetName(System.Int32)"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.ShapefileReader.GetOrdinal(System.String)"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.ShapefileReader.GetString(System.Int32)"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.ShapefileReader.GetValue(System.Int32)"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.ShapefileReader.GetValues(System.Object[])"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.ShapefileReader.IsDBNull(System.Int32)"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.ShapefileReader.AdvancePage"> + <summary> + Resets the count, so that reading may continue. + </summary> + </member> + <member name="M:DotSpatial.Data.ShapefileReader.Open"> + <summary> + Ensures that the files can be opened for reading. + </summary> + </member> + <member name="P:DotSpatial.Data.ShapefileReader.Filename"> + <summary> + Gets or sets the name of the shapefile. + </summary> + </member> + <member name="P:DotSpatial.Data.ShapefileReader.Fields"> + <summary> + Gets or sets the array of string field names to access. If this is null or empty, then all the fields are returned. + Fields listed here that do not occur in the shapefile will be ignored. + </summary> + </member> + <member name="P:DotSpatial.Data.ShapefileReader.FilterExpression"> + <summary> + Gets or sets the string filter expression. This is only the "Where" criteria, and doesn't include any other advanced SQL implmenetation. + </summary> + </member> + <member name="P:DotSpatial.Data.ShapefileReader.OrderBy"> + <summary> + Gets or sets a string fieldname to support sorting. + </summary> + </member> + <member name="P:DotSpatial.Data.ShapefileReader.PageSize"> + <summary> + Gets the integer number of the maximum number of results to generate from a shapefile. + </summary> + </member> + <member name="P:DotSpatial.Data.ShapefileReader.Count"> + <summary> + Gets the count of members returned so far. + </summary> + </member> + <member name="P:DotSpatial.Data.ShapefileReader.Offset"> + <summary> + Gets the long row offset where reading should begin. This will advance + </summary> + </member> + <member name="P:DotSpatial.Data.ShapefileReader.Depth"> + <summary> + Shapefiles don't support nested tables. + </summary> + </member> + <member name="P:DotSpatial.Data.ShapefileReader.IsClosed"> + <inheritdoc/> + </member> + <member name="P:DotSpatial.Data.ShapefileReader.RecordsAffected"> + <summary> + Read only reader has no affect on records here. + </summary> + </member> + <member name="P:DotSpatial.Data.ShapefileReader.FieldCount"> + <inheritdoc/> + </member> + <member name="P:DotSpatial.Data.ShapefileReader.Item(System.String)"> + <inheritdoc/> + </member> + <member name="P:DotSpatial.Data.ShapefileReader.Item(System.Int32)"> + <inheritdoc/> + </member> + <member name="T:DotSpatial.Data.ShapeReader"> + <summary> + A class for cycling pages of shapes from a large dataset + </summary> + </member> + <member name="M:DotSpatial.Data.ShapeReader.#ctor(DotSpatial.Data.IShapeSource)"> + <summary> + Creates a new reader class for paging through a shape source. + </summary> + <param name="source">The IShapeSource to cycle through.</param> + </member> + <member name="M:DotSpatial.Data.ShapeReader.GetEnumerator"> + <inheritdocs/> + </member> + <member name="P:DotSpatial.Data.ShapeReader.PageSize"> + <summary> + Gets or sets the integer count of shapes that should be allowed to appear on a single page of results. + This is the maximum, and the actual number of shapes may be considerably smaller than this. + </summary> + </member> + <member name="P:DotSpatial.Data.ShapeReader.Envelope"> + <summary> + Gets or sets the envelope. If this is null, then no envelope is used. + </summary> + </member> + <member name="P:DotSpatial.Data.ShapeReader.FeatureType"> + <summary> + Gets the feature type of the feature source. + </summary> + </member> + <member name="T:DotSpatial.Data.ShapeReader.Enumerator"> + <summary> + Creates an enumerator for pages of shapes returned as dictionaries. + </summary> + </member> + <member name="M:DotSpatial.Data.ShapeReader.Enumerator.#ctor(DotSpatial.Data.ShapeReader)"> + <summary> + Creates ShapePageSet.Enumerator which can be used to cycle very large datasets. + </summary> + <param name="parent"></param> + </member> + <member name="M:DotSpatial.Data.ShapeReader.Enumerator.Dispose"> + <inheritdocs/> + </member> + <member name="M:DotSpatial.Data.ShapeReader.Enumerator.MoveNext"> + <inheritdocs/> + </member> + <member name="M:DotSpatial.Data.ShapeReader.Enumerator.Reset"> + <inheritdocs/> + </member> + <member name="P:DotSpatial.Data.ShapeReader.Enumerator.Current"> + <inheritdocs/> + </member> + <member name="T:DotSpatial.Data.ShapeRelateType"> + <summary> + Controls whether only intersecting shapes should be used or whether all shapes should be used. + </summary> + </member> + <member name="F:DotSpatial.Data.ShapeRelateType.All"> + <summary> + All shapes will be used + </summary> + </member> + <member name="F:DotSpatial.Data.ShapeRelateType.Intersecting"> + <summary> + Only intersecting shapes will be used + </summary> + </member> + <member name="T:DotSpatial.Data.CulturePreferences"> + <summary> + CulturePreferences + </summary> + </member> + <member name="F:DotSpatial.Data.CulturePreferences.CultureInformation"> + <summary> + This culture information is useful for things like Number Formatting. + This defaults to CurrentCulture, but can be specified through preferences or + whatever. + </summary> + </member> + <member name="T:DotSpatial.Data.BufferedBinaryReader"> + <summary> + The buffered binary reader was originally designed by Ted Dunsford to make shapefile reading more + efficient, but ostensibly could be used for other binary reading exercises. To use this class, + simply specify the BufferSize in bytes that you would like to use and begin reading values. + </summary> + </member> + <member name="M:DotSpatial.Data.BufferedBinaryReader.#ctor(System.String)"> + <summary> + Creates a new instance of BufferedBinaryReader. + </summary> + <param name="fileName">The string path of a file to open using this BufferedBinaryReader.</param> + </member> + <member name="M:DotSpatial.Data.BufferedBinaryReader.#ctor(System.String,DotSpatial.Data.IProgressHandler)"> + <summary> + Creates a new instance of BufferedBinaryReader, and specifies where to send progress messages. + </summary> + <param name="fileName">The string path of a file to open using this BufferedBinaryReader.</param> + <param name="progressHandler">Any implementation of IProgressHandler for receiving progress messages.</param> + </member> + <member name="M:DotSpatial.Data.BufferedBinaryReader.Close"> + <summary> + Closes the internal binary reader and underlying file, but does not free + the buffer that is in memory. For that, call the dispose method. + </summary> + </member> + <member name="M:DotSpatial.Data.BufferedBinaryReader.Dispose"> + <summary> + This will not close the file, so be sure to close before calling Dispose. + This will dispose the file stream and set the buffer to null. + </summary> + </member> + <member name="M:DotSpatial.Data.BufferedBinaryReader.FillBuffer"> + <summary> + Instructs the reader to fill its buffer with data. This only does something + if the buffer is not loaded yet. This method is optional since the first + effort at reading the file will automatically load the buffer. + </summary> + </member> + <member name="M:DotSpatial.Data.BufferedBinaryReader.FillBuffer(System.Int32)"> + <summary> + This method will both assign a new maximum buffer size to the reader and + force the reader to load the values into memory. This is unnecessary + unless you plan on closing the file before reading values from this class. + Even if values are loaded, this will assign the MaxBufferSize property + so that future buffers have the specified size. + </summary> + <param name="maxBufferSize">An integer buffer size to assign to the maximum buffer size before reading values.</param> + </member> + <member name="M:DotSpatial.Data.BufferedBinaryReader.Seek(System.Int64,System.IO.SeekOrigin)"> + <summary> + Uses the seek method to quickly reach a desired location to begin reading. + This will not buffer or read values. If the new position is beyond the end + of the current buffer, the next read will load a new buffer. + </summary> + <param name="offset">A 64 bit integer specifying where to skip to in the file.</param> + <param name="origin">A System.IO.SeekOrigin enumeration specifying how to estimate the location.</param> + </member> + <member name="M:DotSpatial.Data.BufferedBinaryReader.ReadBool"> + <summary> + Reads a boolean form the buffer, automatcially loading the next buffer if necessary. + </summary> + <returns>A boolean value converted from bytes in the file.</returns> + </member> + <member name="M:DotSpatial.Data.BufferedBinaryReader.ReadChar"> + <summary> + Reads a character from two bytes in the buffer, automatically loading the next buffer if necessary. + </summary> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.BufferedBinaryReader.ReadChars(System.Int32)"> + <summary> + Reads an array of character from two bytes in the buffer, automatically loading + </summary> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.BufferedBinaryReader.ReadDouble(System.Boolean)"> + <summary> + Reads a double-precision floating point from 8 bytes in the buffer, automatically loading the next buffer if necessary. + </summary> + <param name="isLittleEndian">Boolean, true if the value should be returned with little endian byte ordering.</param> + <returns>A double value converted from bytes in the file.</returns> + </member> + <member name="M:DotSpatial.Data.BufferedBinaryReader.ReadVertices(System.Int32)"> + <summary> + Reads double precision X and Y values that are interwoven + </summary> + <param name="count"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.BufferedBinaryReader.ReadDoubles(System.Int32)"> + <summary> + Reads the specified number of doubles into an array + This uses Buffer.CopyBlock, and seems to work ok + for little-endian in windows. + </summary> + <param name="count">The count of doubles</param> + <returns>An array of doubles</returns> + </member> + <member name="M:DotSpatial.Data.BufferedBinaryReader.ReadIntegers(System.Int32)"> + <summary> + Reads the specified number of integers into an array + </summary> + <param name="count">The integer count of integers to read</param> + <returns>An array of the specified integers and length equal to count</returns> + </member> + <member name="M:DotSpatial.Data.BufferedBinaryReader.ReadInt32"> + <summary> + By default, this will use little Endian ordering. + </summary> + <returns>An Int32 converted from the file.</returns> + </member> + <member name="M:DotSpatial.Data.BufferedBinaryReader.ReadInt32(System.Boolean)"> + <summary> + Reads an integer from the file, using the isLittleEndian argument + to decide whether to flip the bits or not. + </summary> + <param name="isLittleEndian">Boolean, true if the value should be returned with little endian byte ordering.</param> + <returns>an Int32 value converted from bytes in the file.</returns> + </member> + <member name="M:DotSpatial.Data.BufferedBinaryReader.ReadInt16"> + <summary> + Reads a short, sixteen bit integer as bytes in little-endian order + </summary> + <returns>A short value</returns> + </member> + <member name="M:DotSpatial.Data.BufferedBinaryReader.ReadSingle"> + <summary> + Reads a single-precision floading point from 4 bytes in the buffer, automatically loading the next buffer if necessary. + This assumes the value should be little endian. + </summary> + <returns>A single-precision floating point converted from four bytes</returns> + </member> + <member name="M:DotSpatial.Data.BufferedBinaryReader.ReadSingle(System.Boolean)"> + <summary> + Reads a single-precision floading point from 4 bytes in the buffer, automatically loading the next buffer if necessary. + </summary> + <param name="isLittleEndian">Boolean, true if the value should be returned with little endian byte ordering.</param> + <returns>A single-precision floating point converted from four bytes</returns> + </member> + <member name="M:DotSpatial.Data.BufferedBinaryReader.ReadBytes(System.Int32)"> + <summary> + Reads the specified number of bytes. This will throw an exception + if a number of bytes is specified that exeeds the file length. + </summary> + <param name="byteCount">The integer count of the bytes.</param> + <returns>An array of bytes</returns> + </member> + <member name="M:DotSpatial.Data.BufferedBinaryReader.Read(System.Byte[],System.Int32,System.Int32)"> + <summary> + copies count bytes from the internal buffer to the specified buffer index as the starting point in the specified buffer. + </summary> + <param name="buffer">A previously dimensioned array of byte values to fill with data</param> + <param name="index">The index in the argument array to start pasting values to</param> + <param name="count">The number of values to copy into the parameter buffer</param> + </member> + <member name="M:DotSpatial.Data.BufferedBinaryReader.OnFinishedReading"> + <summary> + Fires the FinishedReading event. + </summary> + </member> + <member name="M:DotSpatial.Data.BufferedBinaryReader.OnFinishedBuffering"> + <summary> + Fires the FinishedBuffering event. + </summary> + </member> + <member name="P:DotSpatial.Data.BufferedBinaryReader.ProgressMeter"> + <summary> + Gets the progress meter. + </summary> + </member> + <member name="P:DotSpatial.Data.BufferedBinaryReader.BufferOffset"> + <summary> + Gets a long integer specifying the starting position of the currently loaded buffer + relative to the start of the file. A value of -1 indicates that no buffer is + currently loaded. + </summary> + </member> + <member name="P:DotSpatial.Data.BufferedBinaryReader.BufferSize"> + <summary> + Gets an integer value specifying the size of the buffer currently loaded into memory. + This will either be the MaxBufferSize, or a smaller buffer representing a smaller + remainder existing in the file. + </summary> + </member> + <member name="P:DotSpatial.Data.BufferedBinaryReader.IsBufferLoaded"> + <summary> + Gets a boolean indicating whether there is currently any information loaded into the buffer. + </summary> + </member> + <member name="P:DotSpatial.Data.BufferedBinaryReader.IsFinishedReading"> + <summary> + Gets a boolean value once the offset has reached the end of the file, + and every byte value has been read from the file. + </summary> + </member> + <member name="P:DotSpatial.Data.BufferedBinaryReader.IsFinishedBuffering"> + <summary> + Gets a boolean value once the entire file has been loaded into memory. + This usually will occur before any reading even takes place. + </summary> + </member> + <member name="P:DotSpatial.Data.BufferedBinaryReader.FileLength"> + <summary> + Gets the length in bytes of the file being read. + </summary> + </member> + <member name="P:DotSpatial.Data.BufferedBinaryReader.FileOffset"> + <summary> + Gets the current read position in the file in bytes. + </summary> + </member> + <member name="P:DotSpatial.Data.BufferedBinaryReader.FileRemainder"> + <summary> + Gets a long value specifying how many bytes have not yet been read in the file. + </summary> + </member> + <member name="P:DotSpatial.Data.BufferedBinaryReader.MaxBufferSize"> + <summary> + Gets or sets the buffer size to read in chunks. This does not + describe the size of the actual + </summary> + </member> + <member name="P:DotSpatial.Data.BufferedBinaryReader.ProgressBaseMessage"> + <summary> + Gets or sets the progress message that has no percentage as part of it. + </summary> + </member> + <member name="P:DotSpatial.Data.BufferedBinaryReader.ReadOffset"> + <summary> + This acts like a placeholder on the buffer and indicates where reading will begin (relative to the start of the buffer) + </summary> + </member> + <member name="E:DotSpatial.Data.BufferedBinaryReader.FinishedReading"> + <summary> + Occurs when this reader has read every byte from the file. + </summary> + </member> + <member name="E:DotSpatial.Data.BufferedBinaryReader.FinishedBuffering"> + <summary> + Occurs when the end of the last portion of the file has been + loaded into the file and the file has been closed. + </summary> + </member> + <member name="T:DotSpatial.Data.BufferedBinaryWriter"> + <summary> + The buffered binary reader was originally designed by Ted Dunsford to make shapefile reading more + efficient, but ostensibly could be used for other binary reading exercises. To use this class, + simply specify the BufferSize in bytes that you would like to use and begin reading values. + </summary> + </member> + <member name="M:DotSpatial.Data.BufferedBinaryWriter.#ctor(System.String)"> + <summary> + Creates a new instance of BufferedBinaryReader. + </summary> + <param name="fileName">The string path of a file to open using this BufferedBinaryReader.</param> + </member> + <member name="M:DotSpatial.Data.BufferedBinaryWriter.#ctor(System.String,DotSpatial.Data.IProgressHandler,System.Int64)"> + <summary> + Creates a new instance of BufferedBinaryWriter, and specifies where to send progress messages. + </summary> + <param name="fileName">The string path of a file to open using this BufferedBinaryReader.</param> + <param name="progressHandler">Any implementation of IProgressHandler for receiving progress messages.</param> + <param name="expectedByteCount">A long specifying the number of bytes that will be written for the purposes of tracking progress</param> + </member> + <member name="M:DotSpatial.Data.BufferedBinaryWriter.Close"> + <summary> + Finishes writing whatever is in memory to the file, closes the + internal binary writer, the underlying file, clears the memory + and disposes the filestream. + </summary> + </member> + <member name="M:DotSpatial.Data.BufferedBinaryWriter.PasteBuffer"> + <summary> + Forces the buffer to paste all its existing values into the file, but does not + advance the buffer, or in fact do anything to the buffer. It does advance + the position of the file index. + </summary> + </member> + <member name="M:DotSpatial.Data.BufferedBinaryWriter.Seek(System.Int64,System.IO.SeekOrigin)"> + <summary> + This seeks both in the file AND in the buffer. This is used to write only + desired portions of a buffer that is in memory to a file. + </summary> + <param name="offset">A 64 bit integer specifying where to skip to in the file.</param> + <param name="origin">A System.IO.SeekOrigin enumeration specifying how to estimate the location.</param> + </member> + <member name="M:DotSpatial.Data.BufferedBinaryWriter.Write(System.Boolean)"> + <summary> + Reads a boolean form the buffer, automatcially loading the next buffer if necessary. + </summary> + </member> + <member name="M:DotSpatial.Data.BufferedBinaryWriter.Write(System.Char)"> + <summary> + Reads a character from two bytes in the buffer, automatically loading the next buffer if necessary. + </summary> + <param name="value">A character to write to the buffer, and eventually the file</param> + </member> + <member name="M:DotSpatial.Data.BufferedBinaryWriter.Write(System.Char[])"> + <summary> + Reads an array of character from two bytes in the buffer, automatically loading + </summary> + </member> + <member name="M:DotSpatial.Data.BufferedBinaryWriter.Write(System.Double)"> + <summary> + Reads a double from the buffer, automatically loading the next buffer if necessary. + </summary> + </member> + <member name="M:DotSpatial.Data.BufferedBinaryWriter.Write(System.Double,System.Boolean)"> + <summary> + Writes a double-precision floating point to 8 bytes in the buffer, automatically loading the next buffer if necessary. + </summary> + <param name="value">A double-precision floating point decimal value to write as 8 bytes.</param> + <param name="isLittleEndian">Boolean, true if the value should be returned with little endian byte ordering.</param> + </member> + <member name="M:DotSpatial.Data.BufferedBinaryWriter.Write(System.Double[])"> + <summary> + Writes the specified array of doubles to the file. + </summary> + <param name="values">The values to write.</param> + </member> + <member name="M:DotSpatial.Data.BufferedBinaryWriter.Write(System.Int32[])"> + <summary> + Writes the specified array of integers to the file. + </summary> + <param name="values">The values to write.</param> + </member> + <member name="M:DotSpatial.Data.BufferedBinaryWriter.Write(System.Int32)"> + <summary> + By default, this will use little Endian ordering. + </summary> + </member> + <member name="M:DotSpatial.Data.BufferedBinaryWriter.Write(System.Int32,System.Boolean)"> + <summary> + Reads an integer from the file, using the isLittleEndian argument + to decide whether to flip the bits or not. + </summary> + <param name="value">A 32-bit integer to write as 4 bytes in the buffer.</param> + <param name="isLittleEndian">Boolean, true if the value should be returned with little endian byte ordering.</param> + </member> + <member name="M:DotSpatial.Data.BufferedBinaryWriter.Write(System.Int16)"> + <summary> + Writes an Int16 to the buffer. + </summary> + <param name="value">An Int16 to convert into 2 bytes to write to the buffer.</param> + </member> + <member name="M:DotSpatial.Data.BufferedBinaryWriter.Write(System.Single)"> + <summary> + Writes a single-precision floading point to 4 bytes in the buffer, automatically loading the next buffer if necessary. + This assumes the value should be little endian. + </summary> + <param name="value">A Single to convert to 4 bytes to write to the buffer.</param> + </member> + <member name="M:DotSpatial.Data.BufferedBinaryWriter.Write(System.Single,System.Boolean)"> + <summary> + Reads a single-precision floading point from 4 bytes in the buffer, automatically loading the next buffer if necessary. + </summary> + <param name="value">A single-precision floating point converted from four bytes</param> + <param name="isLittleEndian">Boolean, true if the value should be returned with little endian byte ordering.</param> + </member> + <member name="M:DotSpatial.Data.BufferedBinaryWriter.Write(System.Byte[])"> + <summary> + Writes the specified bytes to the buffer, advancing the buffer automatically if necessary. + </summary> + <param name="value">An array of byte values to write to the buffer.</param> + </member> + <member name="P:DotSpatial.Data.BufferedBinaryWriter.Buffer"> + <summary> + Gets or sets the actual array of bytes currently in the buffer + </summary> + </member> + <member name="P:DotSpatial.Data.BufferedBinaryWriter.BufferOffset"> + <summary> + Gets a long integer specifying the starting position of the currently loaded buffer + relative to the start of the file. A value of -1 indicates that no buffer is + currently loaded. + </summary> + </member> + <member name="P:DotSpatial.Data.BufferedBinaryWriter.BufferSize"> + <summary> + Gets an integer value specifying the size of the buffer currently loaded into memory. + This will either be the MaxBufferSize, or a smaller buffer representing a smaller + remainder existing in the file. + </summary> + </member> + <member name="P:DotSpatial.Data.BufferedBinaryWriter.IsBufferLoaded"> + <summary> + Gets a boolean indicating whether there is currently any information loaded into the buffer. + </summary> + </member> + <member name="P:DotSpatial.Data.BufferedBinaryWriter.FileOffset"> + <summary> + Gets the current read position in the file in bytes. + </summary> + </member> + <member name="P:DotSpatial.Data.BufferedBinaryWriter.MaxBufferSize"> + <summary> + Gets or sets the buffer size to read in chunks. This does not + describe the size of the actual + </summary> + </member> + <member name="P:DotSpatial.Data.BufferedBinaryWriter.ProgressMeter"> + <summary> + Gets or sets the progress meter that is directly linked to the progress handler. + </summary> + </member> + <member name="P:DotSpatial.Data.BufferedBinaryWriter.ProgressHandler"> + <summary> + Gets or sets the progress handler for this binary writer + </summary> + </member> + <member name="P:DotSpatial.Data.BufferedBinaryWriter.WriteOffset"> + <summary> + This acts like a placeholder on the buffer and indicates where reading will begin (relative to the start of the buffer) + </summary> + </member> + <member name="T:DotSpatial.Data.ILog"> + <summary> + LogException + </summary> + </member> + <member name="M:DotSpatial.Data.ILog.Log"> + <summary> + Actually logs the exception. This happens after the message has been set in the constructors of the classes of this exception. + </summary> + </member> + <member name="T:DotSpatial.Data.DataStrings"> + <summary> + A strongly-typed resource class, for looking up localized strings, etc. + </summary> + </member> + <member name="P:DotSpatial.Data.DataStrings.ResourceManager"> + <summary> + Returns the cached ResourceManager instance used by this class. + </summary> + </member> + <member name="P:DotSpatial.Data.DataStrings.Culture"> + <summary> + Overrides the current thread's CurrentUICulture property for all + resource lookups using this strongly typed resource class. + </summary> + </member> + <member name="P:DotSpatial.Data.DataStrings.Argument_Null_S"> + <summary> + Looks up a localized string similar to The argument %S cannot be null.. + </summary> + </member> + <member name="P:DotSpatial.Data.DataStrings.ArgumentCannotBeNegative_S"> + <summary> + Looks up a localized string similar to The argument %S cannot be negative.. + </summary> + </member> + <member name="P:DotSpatial.Data.DataStrings.ArgumentNull_S"> + <summary> + Looks up a localized string similar to The argument %S was null. Try testing for the null case before calling this method.. + </summary> + </member> + <member name="P:DotSpatial.Data.DataStrings.ArgumentOfWrongType_S1_S2"> + <summary> + Looks up a localized string similar to The argument %S1 was incorrect for %S2.. + </summary> + </member> + <member name="P:DotSpatial.Data.DataStrings.CalculatingStatistics"> + <summary> + Looks up a localized string similar to Calculating Statistics. + </summary> + </member> + <member name="P:DotSpatial.Data.DataStrings.CannotCopyToSelf_S"> + <summary> + Looks up a localized string similar to The fileName %S cannot be copied to itself.. + </summary> + </member> + <member name="P:DotSpatial.Data.DataStrings.CopyingValues"> + <summary> + Looks up a localized string similar to Copying Values. + </summary> + </member> + <member name="P:DotSpatial.Data.DataStrings.CurrentElementNotSpecified"> + <summary> + Looks up a localized string similar to The current element was not defined. Before attempting to read the element, first assign the value of the current XML Element to read.. + </summary> + </member> + <member name="P:DotSpatial.Data.DataStrings.EndOfFile"> + <summary> + Looks up a localized string similar to Cannot read past the end of the file.. + </summary> + </member> + <member name="P:DotSpatial.Data.DataStrings.FeatureTypeMismatch"> + <summary> + Looks up a localized string similar to The FeatureType of the feature you are trying to add does not match the feature type of this featureset.. + </summary> + </member> + <member name="P:DotSpatial.Data.DataStrings.FeaturetypeUnspecified"> + <summary> + Looks up a localized string similar to The FeatureType was not specified. Please specify a featuretype before attempting to call this method.. + </summary> + </member> + <member name="P:DotSpatial.Data.DataStrings.FileExists_S"> + <summary> + Looks up a localized string similar to The fileName %S already exists. Do you wish to overwrite it?. + </summary> + </member> + <member name="P:DotSpatial.Data.DataStrings.FileNotFound_S"> + <summary> + Looks up a localized string similar to The fileName %S was not found.. + </summary> + </member> + <member name="P:DotSpatial.Data.DataStrings.FileNotLines_S"> + <summary> + Looks up a localized string similar to The fileName %S contains a feature type other than lines.. + </summary> + </member> + <!-- Badly formed XML comment ignored for member "P:DotSpatial.Data.DataStrings.FileNotMultipoints_S" --> + <!-- Badly formed XML comment ignored for member "P:DotSpatial.Data.DataStrings.FileNotPoints_S" --> + <member name="P:DotSpatial.Data.DataStrings.FileNotPolygons_S"> + <summary> + Looks up a localized string similar to The fileName %S contains a feature type other than polygons.. + </summary> + </member> + <member name="P:DotSpatial.Data.DataStrings.FileTypeNotSupported"> + <summary> + Looks up a localized string similar to The specified file type is not supported.. + </summary> + </member> + <member name="P:DotSpatial.Data.DataStrings.HfaEnumerationNotFound"> + <summary> + Looks up a localized string similar to Attepted to set the enumeration field to the value '%s', which is not known.. + </summary> + </member> + <member name="P:DotSpatial.Data.DataStrings.HfaFieldTypeException"> + <summary> + Looks up a localized string similar to The specified charcter '%S' was not a known field type: 124cCesStlLfdmMbox". + </summary> + </member> + <member name="P:DotSpatial.Data.DataStrings.HfaInvalidCountException"> + <summary> + Looks up a localized string similar to The number of rows and number of columns must both be greater than 0, but the header for this item returned %S1 rows and %S2 columns.. + </summary> + </member> + <member name="P:DotSpatial.Data.DataStrings.HfaNotCompressedException"> + <summary> + Looks up a localized string similar to You must first compress the data before accessing this value.. + </summary> + </member> + <member name="P:DotSpatial.Data.DataStrings.HfaPointerInsertNotSupportedException"> + <summary> + Looks up a localized string similar to Insertion via SetInstValue() is not yet supported for pointers.. + </summary> + </member> + <member name="P:DotSpatial.Data.DataStrings.IndexingErrorIn_S"> + <summary> + Looks up a localized string similar to There was an error while attempting to index %S. + </summary> + </member> + <member name="P:DotSpatial.Data.DataStrings.IO_FileNotFound_S"> + <summary> + Looks up a localized string similar to The file %S could not be found.. + </summary> + </member> + <member name="P:DotSpatial.Data.DataStrings.NotImplemented"> + <summary> + Looks up a localized string similar to This has not yet been implemented.. + </summary> + </member> + <member name="P:DotSpatial.Data.DataStrings.NumberException_TooLarge_S"> + <summary> + Looks up a localized string similar to The value %S was too large to encode with 18 ASCII characters.. + </summary> + </member> + <member name="P:DotSpatial.Data.DataStrings.NumberException_TooSmall_S"> + <summary> + Looks up a localized string similar to The value %S was too small to be encoded with 18 ASCII characters.. + </summary> + </member> + <member name="P:DotSpatial.Data.DataStrings.ParseFailed_S"> + <summary> + Looks up a localized string similar to The value you entered could not be parsed into a %S. Make sure the value is in the valid range.. + </summary> + </member> + <member name="P:DotSpatial.Data.DataStrings.PngInsuficientLengthException"> + <summary> + Looks up a localized string similar to The desired length of %S1 was too long. The total length was %S2 and the offset was %S3.. + </summary> + </member> + <member name="P:DotSpatial.Data.DataStrings.PngInvalidSignatureException"> + <summary> + Looks up a localized string similar to The beginning eight bytes of the specified file did not match the png signature.. + </summary> + </member> + <member name="P:DotSpatial.Data.DataStrings.PyramidByteMismatchException"> + <summary> + Looks up a localized string similar to The number of bytes should be 4 * rows * cols since only ARGB format is supported.. + </summary> + </member> + <member name="P:DotSpatial.Data.DataStrings.PyramidHeaderException"> + <summary> + Looks up a localized string similar to The header has not been defined for the image scale you are attempting to access.. + </summary> + </member> + <member name="P:DotSpatial.Data.DataStrings.PyramidOutOfBoundsException"> + <summary> + Looks up a localized string similar to The rows or columns would extend beyond the specified number of columns or rows for the specified scale.. + </summary> + </member> + <member name="P:DotSpatial.Data.DataStrings.RasterRequiresCast"> + <summary> + Looks up a localized string similar to To work with anything other than an in-memory raster window, you must first cast this raster to the correct data format.. + </summary> + </member> + <member name="P:DotSpatial.Data.DataStrings.RastersNeedSameCellSize"> + <summary> + Looks up a localized string similar to The rasters must have equally sized cells to use this method.. + </summary> + </member> + <member name="P:DotSpatial.Data.DataStrings.RasterTooLarge"> + <summary> + Looks up a localized string similar to The specified raster would be too large to store in memory.. + </summary> + </member> + <member name="P:DotSpatial.Data.DataStrings.ReadingValuesFrom_S"> + <summary> + Looks up a localized string similar to Reading values from %S. + </summary> + </member> + <member name="P:DotSpatial.Data.DataStrings.WritingValues_S"> + <summary> + Looks up a localized string similar to Writing values to %S. + </summary> + </member> + <member name="T:DotSpatial.Data.BoxStatistics"> + <summary> + Box-plot: Tukey 1977 + Basically it is like subdividing the data into 4 quartiles, + denoted like Q1, Q2, Q3, Q4. + ------- + Low Outlier (less than the Quartile - 3/2 Interquartile range) + Q1 (Q1 - 3/2 the Interquartile range to Q1 + Q2 (Quartile 1 to Median) + Q3 (Median to Quartile 3) + Q4 (Q3 to Q3 + 3/2 the Interquartile range + High Outlier (Greater than Q3 plus the interquartile range + </summary> + </member> + <member name="F:DotSpatial.Data.BoxStatistics.HighMedian"> + <summary> + The median between the median and the highest value. + This separates the third and fourth quartiles. + </summary> + </member> + <member name="F:DotSpatial.Data.BoxStatistics.HighWisker"> + <summary> + The highest value that is not considered an outlier. + If the values are not numeric, this will be the Maximum. + </summary> + </member> + <member name="F:DotSpatial.Data.BoxStatistics.LowMedian"> + <summary> + The median between the lowest value and the median value. + This separates the first quartile from the second. + </summary> + </member> + <member name="F:DotSpatial.Data.BoxStatistics.LowWhisker"> + <summary> + The lowest value that is not considered to be an outlier. + If the values are not numeric, this will be the minimum. + </summary> + </member> + <member name="F:DotSpatial.Data.BoxStatistics.Median"> + <summary> + The Median value (the value of the middle member) + </summary> + </member> + <member name="T:DotSpatial.Data.CoordinateType"> + <summary> + CoordinateTypes + </summary> + </member> + <member name="F:DotSpatial.Data.CoordinateType.Regular"> + <summary> + X and Y coordinates only + </summary> + </member> + <member name="F:DotSpatial.Data.CoordinateType.M"> + <summary> + M values are available + </summary> + </member> + <member name="F:DotSpatial.Data.CoordinateType.Z"> + <summary> + Z values are available + </summary> + </member> + <member name="T:DotSpatial.Data.DataTableStatisticsExt"> + <summary> + DataTableStatisticsEM + </summary> + </member> + <member name="M:DotSpatial.Data.DataTableStatisticsExt.GetBoxStatistics(System.Data.DataTable,System.String)"> + <summary> + Inspects the members of the data Table, focusing on the named field. It calculates + the median of the values in the named field. + </summary> + <param name="self"></param> + <param name="fieldName"></param> + <returns></returns> + </member> + <member name="T:DotSpatial.Data.EndPointInteraction"> + <summary> + Used by Segment.ClosestPointTo() to detail how the input point interacts with the line segment + </summary> + </member> + <member name="F:DotSpatial.Data.EndPointInteraction.OnLine"> + <summary> + The vertex found is on the line segment and between P1 and P2 + </summary> + </member> + <member name="F:DotSpatial.Data.EndPointInteraction.PastP1"> + <summary> + The vertex found is beyond the end of P1 + </summary> + </member> + <member name="F:DotSpatial.Data.EndPointInteraction.PastP2"> + <summary> + The vertex found is beyond the end of P2 + </summary> + </member> + <member name="F:DotSpatial.Data.EndPointInteraction.P1equalsP2"> + <summary> + P1 equals P2 so the segment cannot be extended into an infinite line the closest vertex is P1/P2 + </summary> + </member> + <member name="T:DotSpatial.Data.CacheTypes"> + <summary> + Clarifies whether a value is cached in a local variable or updated dynamically + </summary> + </member> + <member name="F:DotSpatial.Data.CacheTypes.Cached"> + <summary> + The value is cached locally, rather than calculated on the fly + </summary> + </member> + <member name="F:DotSpatial.Data.CacheTypes.Dynamic"> + <summary> + The value is calculated each type, rather than using a local cache + </summary> + </member> + <member name="T:DotSpatial.Data.ByteOrder"> + <summary> + Byte order + </summary> + </member> + <member name="F:DotSpatial.Data.ByteOrder.BigEndian"> + <summary> + Big Endian + </summary> + </member> + <member name="F:DotSpatial.Data.ByteOrder.LittleEndian"> + <summary> + Little Endian + </summary> + </member> + <member name="T:DotSpatial.Data.VectorFileType"> + <summary> + Filetypes + </summary> + </member> + <member name="F:DotSpatial.Data.VectorFileType.INVALID"> + <summary> + An unrecognized file format + </summary> + </member> + <member name="F:DotSpatial.Data.VectorFileType.Shapefile"> + <summary> + The Esri Shapefile format (*.shp) + </summary> + </member> + <member name="F:DotSpatial.Data.VectorFileType.CSV"> + <summary> + Comma separated values (*.csv) + </summary> + </member> + <member name="F:DotSpatial.Data.VectorFileType.GML"> + <summary> + Google Markup Language (a variant of the Keyhole Markup Language) (*.gml) + </summary> + </member> + <member name="F:DotSpatial.Data.VectorFileType.MapInfo"> + <summary> + MapInfo format (*.tab) + </summary> + </member> + <member name="F:DotSpatial.Data.VectorFileType.MicrostationDGN"> + <summary> + CAD format (Design) (*.dgn) + </summary> + </member> + <member name="F:DotSpatial.Data.VectorFileType.S57"> + <summary> + S-57 published by International Hydrographic Organization (IHO). (*.000) + </summary> + </member> + <member name="F:DotSpatial.Data.VectorFileType.SDTS"> + <summary> + Spatial Data Transfer Standard (*.sdts) + </summary> + </member> + <member name="F:DotSpatial.Data.VectorFileType.UKNTF"> + <summary> + ? + </summary> + </member> + <member name="F:DotSpatial.Data.VectorFileType.TIGER"> + <summary> + Topologically Integrated Geographic Encoding and Referencing (*.tig) + </summary> + </member> + <member name="F:DotSpatial.Data.VectorFileType.PostgreSQL"> + <summary> + ? + </summary> + </member> + <member name="F:DotSpatial.Data.VectorFileType.ODBC"> + <summary> + MS Excel ODBC Query File? (*.DQY) + maybe ODBC Data Source file? (*.DSN) + </summary> + </member> + <member name="F:DotSpatial.Data.VectorFileType.PGeo"> + <summary> + ? + </summary> + </member> + <member name="F:DotSpatial.Data.VectorFileType.AVC"> + <summary> + ArcInfo Vector Coverage + </summary> + </member> + <member name="F:DotSpatial.Data.VectorFileType.VRT"> + <summary> + Geospatial Data Abstraction Library (GDAL) File (*.VRT) + </summary> + </member> + <member name="F:DotSpatial.Data.VectorFileType.REC"> + <summary> + Record file? (*.REC) + </summary> + </member> + <member name="T:DotSpatial.Data.Field"> + <summary> + This represents the column information for one column of a shapefile. + This specifies precision as well as the typical column information. + </summary> + </member> + <member name="F:DotSpatial.Data.Field._decimalCount"> + <summary> + Represents the number of decimals to preserve after a 0. + </summary> + </member> + <member name="F:DotSpatial.Data.Field._length"> + <summary> + The length of a field in bytes + </summary> + </member> + <member name="M:DotSpatial.Data.Field.#ctor"> + <summary> + Creates a new default field empty field - needed for datatable copy and clone methods. + </summary> + </member> + <member name="M:DotSpatial.Data.Field.#ctor(System.Data.DataColumn)"> + <summary> + Creates a new default field given the specified DataColumn. Numeric types + default to a size of 255, but will be shortened during the save opperation. + The default decimal count for double and long is 0, for Currency is 2, for float is + 3, and for double is 8. These can be changed by changing the DecimalCount property. + </summary> + <param name="inColumn">A System.Data.DataColumn to create a Field from</param> + </member> + <member name="M:DotSpatial.Data.Field.#ctor(System.String)"> + <summary> + Creates a new instance of a field given only a column name + </summary> + <param name="inColumnName">The string Column Name for the new field</param> + </member> + <member name="M:DotSpatial.Data.Field.#ctor(System.String,System.Type)"> + <summary> + Creates a new Field with a specific name for a specified data type + </summary> + <param name="inColumnName">The string name of the column</param> + <param name="inDataType">The System.Type describing the datatype of the field</param> + </member> + <member name="M:DotSpatial.Data.Field.#ctor(System.String,DotSpatial.Data.FieldDataType)"> + <summary> + Creates a new field with a specific name and using a simplified enumeration of possible types. + </summary> + <param name="inColumnName">the string column name.</param> + <param name="type">The type enumeration that clarifies which basic data type to use.</param> + </member> + <member name="M:DotSpatial.Data.Field.#ctor(System.String,System.Char,System.Byte,System.Byte)"> + <summary> + This creates a new instance. Since the data type is + </summary> + <param name="columnName"></param> + <param name="typeCode"></param> + <param name="length"></param> + <param name="decimalCount"></param> + </member> + <member name="M:DotSpatial.Data.Field.SetupDecimalCount"> + <summary> + Internal method that decides an appropriate decimal count, given a data column + </summary> + </member> + <member name="P:DotSpatial.Data.Field.TypeCharacter"> + <summary> + This is the single character dBase code. Only some of these are supported with Esri. + C - Character (Chars, Strings, objects - as ToString(), and structs - as ) + D - Date (DateTime) + T - Time (DateTime) + N - Number (Short, Integer, Long, Float, Double, byte) + L - Logic (True-False, Yes-No) + F - Float + B - Double + </summary> + </member> + <member name="P:DotSpatial.Data.Field.DecimalCount"> + <summary> + Gets or sets the number of places to keep after the 0 in number formats. + As far as dbf fields are concerned, all numeric datatypes use the same + database number format. + </summary> + </member> + <member name="P:DotSpatial.Data.Field.Length"> + <summary> + The character length of the field + </summary> + </member> + <member name="P:DotSpatial.Data.Field.DataAddress"> + <summary> + The offset of the field on a row in the file + </summary> + </member> + <member name="P:DotSpatial.Data.Field.NumberConverter"> + <summary> + Number Converter associated with this field. + </summary> + </member> + <member name="T:DotSpatial.Data.FieldDataType"> + <summary> + FieldDataTypes stores some very simplistic data types to help novices get started more easily. + </summary> + </member> + <member name="F:DotSpatial.Data.FieldDataType.Integer"> + <summary> + 32 Bit integer data type + </summary> + </member> + <member name="F:DotSpatial.Data.FieldDataType.Double"> + <summary> + Double precision floating point data type + </summary> + </member> + <member name="F:DotSpatial.Data.FieldDataType.String"> + <summary> + String data type + </summary> + </member> + <member name="T:DotSpatial.Data.BitmapGrid"> + <summary> + This is not a data class exactly, but instead is for making it easier to modify byte values of a 32 bit ARGB + bitmap, but doesn't require a file. + </summary> + </member> + <member name="M:DotSpatial.Data.BitmapGrid.#ctor(System.Drawing.Image)"> + <summary> + Creates a new instance of MemoryBitmapGrid + </summary> + </member> + <member name="M:DotSpatial.Data.BitmapGrid.#ctor(System.Int32,System.Int32)"> + <summary> + Creates a blank image grid. + </summary> + <param name="numRows"></param> + <param name="numCols"></param> + </member> + <member name="M:DotSpatial.Data.BitmapGrid.Clone"> + <summary> + Creates a clone of this memory bitmap grid by basically cloning the bitmap itself + and then building a new BitmapGrid around the clone. + </summary> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.BitmapGrid.GetEnumerator"> + <summary> + Gets an enumerator for cycling through the color values. + </summary> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.BitmapGrid.Copy"> + <summary> + Creates a disconnected duplicate of this BitmapGrid + </summary> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.BitmapGrid.Clear"> + <summary> + Clears the byte values in the grid, replacing them with 0. + </summary> + </member> + <member name="M:DotSpatial.Data.BitmapGrid.Dispose"> + <summary> + Disposes the unmanaged aspect of the bmp + </summary> + </member> + <member name="M:DotSpatial.Data.BitmapGrid.Fill(System.Drawing.Color)"> + <summary> + Erases over any current content in the values, and copies the + byte values of the specified color in its place. + </summary> + <param name="fillColor">The color to fill the image with</param> + </member> + <member name="M:DotSpatial.Data.BitmapGrid.ConvertToBitmap(System.Drawing.Image)"> + <summary> + Tests the specified bitmap to verify that it is both a Bitmap and in ARGB pixel format. + If it is anything different, then this returns a newly created bitmap with a copy drawn + onto it. + </summary> + <param name="source"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.BitmapGrid.Difference(DotSpatial.Data.BitmapGrid)"> + <summary> + This will calculate the difference. The width and height of the new grid will be the larger + of the rows and columns between the compare grid and this grid. Values outside the range + of one of the grids will simply be filled in as the value stored in the other grid. Because + byte values can't be negative, the difference will be the absolute value. + </summary> + <param name="compare"></param> + <returns>A BitmapGrid with byte values calculated by taking the difference between the two grids.</returns> + </member> + <member name="M:DotSpatial.Data.BitmapGrid.Difference(DotSpatial.Data.BitmapGrid,System.Boolean)"> + <summary> + By default, all the bands have a difference comparison done. This may not have the desired effect + because the alpha channel for most colors is actually just 255. The mathematical difference would + be zero, resulting in an output image that, while being the actual difference, is essentially + entirely invisibile (except where the images don't overlap.) + </summary> + <param name="compare"></param> + <param name="ignoreAlpha"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.BitmapGrid.GetColor(System.Int32,System.Int32)"> + <summary> + Gets a color structure for the specified row and column. + </summary> + <param name="row">The zero based integer row index to get the color from</param> + <param name="col">The zero based integer column index to get the color from</param> + <returns>A System.Color structure created from the byte values in the values array</returns> + </member> + <member name="M:DotSpatial.Data.BitmapGrid.Matches(DotSpatial.Data.BitmapGrid)"> + <summary> + Compares the bytes of this grid to the bytes of another grid. If the measurements + of the other grid don't match this, then this returns false. + </summary> + <param name="otherGrid">The other BitmapGrid to test against</param> + <returns>Boolean, true if the bytes are the same in each case.</returns> + </member> + <member name="M:DotSpatial.Data.BitmapGrid.Randomize"> + <summary> + Replaces all the byte values of this grid with randomly generated values. + </summary> + </member> + <member name="M:DotSpatial.Data.BitmapGrid.SetColor(System.Int32,System.Int32,System.Drawing.Color)"> + <summary> + Sets the color structure by copying the byte ARGB values into the values array. + </summary> + <param name="row">The integer row index to copy values to</param> + <param name="col">The integer column index to copy values to</param> + <param name="color">The color structure to turn into bytes</param> + </member> + <member name="P:DotSpatial.Data.BitmapGrid.BitmapImage"> + <summary> + Setting this will automatically replace the byte array. Getting this will + automatically convert the bytes back into bitmap form. + </summary> + </member> + <member name="P:DotSpatial.Data.BitmapGrid.Height"> + <summary> + Gets the integer height of the bitmap in this grid in pixels. + </summary> + </member> + <member name="P:DotSpatial.Data.BitmapGrid.Stride"> + <summary> + gets the integer stride, or number of actual bytes in a single row. This is not always the + same as the number of columns. + </summary> + </member> + <member name="P:DotSpatial.Data.BitmapGrid.Values"> + <summary> + Gets or sets the array of bytes directly. Setting this can be + dangerous and is not recommended. Setting individual values in the + array is perfectly acceptable, since it won't interfere with + the stride or number of bytes expected. + </summary> + </member> + <member name="P:DotSpatial.Data.BitmapGrid.Width"> + <summary> + Gets the current width (number of columns) of the bitmap in pixels. + </summary> + </member> + <member name="T:DotSpatial.Data.BitmapGrid.BitmapGridEnumerator"> + <summary> + Cycles through the values of a BitmapGrid starting at the top left corner and moving in row major + fashion, (raster-scan fashion, moving across end then down.) + </summary> + </member> + <member name="M:DotSpatial.Data.BitmapGrid.BitmapGridEnumerator.#ctor(DotSpatial.Data.BitmapGrid)"> + <summary> + Creates a new instance of a BitmapGridEnumerator based on the specified parentGrid. This + automatically ignores any bytes in the range past the "width". + </summary> + <param name="parentGrid">The parent grid to cycle through the values of</param> + </member> + <member name="M:DotSpatial.Data.BitmapGrid.BitmapGridEnumerator.Dispose"> + <summary> + This does nothing + </summary> + </member> + <member name="M:DotSpatial.Data.BitmapGrid.BitmapGridEnumerator.MoveNext"> + <summary> + Advances the color to the next position + </summary> + <returns>Boolean, false if there were no more cells in the image</returns> + </member> + <member name="M:DotSpatial.Data.BitmapGrid.BitmapGridEnumerator.Reset"> + <summary> + Resets the enumeration to the top left corner of the image. + </summary> + </member> + <member name="P:DotSpatial.Data.BitmapGrid.BitmapGridEnumerator.Current"> + <summary> + Gets the current color value from this grid + </summary> + </member> + <member name="T:DotSpatial.Data.DotNetImageProvider"> + <summary> + DotNetImageProvider uses the standard image object to support basic image types through standard in-ram treatments. + Images are not responsible for producing grid values that can be represented symbolically. + </summary> + </member> + <member name="T:DotSpatial.Data.IImageDataProvider"> + <summary> + IImageProvider + </summary> + </member> + <member name="T:DotSpatial.Data.IDataProvider"> + <summary> + IDataProvider is what you implement to expand the data handling methods of DotSpatial + </summary> + </member> + <member name="M:DotSpatial.Data.IDataProvider.Open(System.String)"> + <summary> + This open method is only called if this plugin has been given priority for one + of the file extensions supported in the DialogReadFilter property supplied by + this control. Failing to provide a DialogReadFilter will result in this plugin + being added to the list of DataProviders being supplied under the Add Other Data + option in the file menu. + </summary> + <param name="name">A string specifying the complete path and extension of the file to open.</param> + <returns>A List of IDataSets to be added to the Map. These can also be groups of datasets.</returns> + </member> + <member name="P:DotSpatial.Data.IDataProvider.DialogReadFilter"> + <summary> + Gets a dialog read filter that lists each of the file type descriptions and file extensions, delimited + by the | symbol. Each will appear in DotSpatial's open file dialog filter, preceded by the name provided + on this object. + </summary> + </member> + <member name="P:DotSpatial.Data.IDataProvider.DialogWriteFilter"> + <summary> + Gets a dialog filter that lists each of the file type descriptions and extensions for a Save File Dialog. + Each will appear in DotSpatial's open file dialog filter, preceded by the name provided on this object. + In addition, the same extension mapping will be used in order to pair a string driver code to the + extension. + </summary> + </member> + <member name="P:DotSpatial.Data.IDataProvider.Name"> + <summary> + Gets a preferably short name that identifies this data provider. Example might be GDAL. + This will be prepended to each of the DialogReadFilter members from this plugin. + </summary> + </member> + <member name="P:DotSpatial.Data.IDataProvider.ProgressHandler"> + <summary> + Gets or sets the progress handler to use. + </summary> + </member> + <member name="P:DotSpatial.Data.IDataProvider.Description"> + <summary> + This provides a basic description of what your provider does. + </summary> + </member> + <member name="M:DotSpatial.Data.IImageDataProvider.Create(System.String,System.Int32,System.Int32,System.Boolean,DotSpatial.Data.IProgressHandler,DotSpatial.Data.ImageBandType)"> + <summary> + Creates a new instance of an Image. + </summary> + <param name="fileName">The string fileName to use</param> + <param name="width">The integer width in pixels</param> + <param name="height">The integer height in pixels</param> + <param name="inRam">Boolean, true if the entire contents should be stored in memory</param> + <param name="progHandler">A Progress handler to use</param> + <param name="band">The ImageBandType clarifying how to organize the raster bands.</param> + <returns>A New IImageData object allowing access to the content of the image</returns> + </member> + <member name="M:DotSpatial.Data.IImageDataProvider.Open(System.String)"> + <summary> + Opens a new Image with the specified fileName + </summary> + <param name="fileName">The string file to open</param> + <returns>An IImageData object</returns> + </member> + <member name="M:DotSpatial.Data.DotNetImageProvider.Create(System.String,System.Int32,System.Int32,System.Boolean,DotSpatial.Data.IProgressHandler,DotSpatial.Data.ImageBandType)"> + <summary> + Creates a new instance of an Image. + </summary> + <param name="fileName">The string fileName to use</param> + <param name="width">The integer width in pixels</param> + <param name="height">The integer height in pixels</param> + <param name="inRam">Boolean, true if the entire contents should be stored in memory</param> + <param name="progHandler">A Progress handler to use</param> + <param name="band">.Net type ignores this for now.</param> + <returns> + A New IImageData object allowing access to the content of the image + </returns> + </member> + <member name="M:DotSpatial.Data.DotNetImageProvider.Open(System.String)"> + <summary> + Opens a new Image with the specified fileName + </summary> + <param name="fileName">The string file to open</param> + <returns>An IImageData object</returns> + </member> + <member name="P:DotSpatial.Data.DotNetImageProvider.DialogReadFilter"> + <summary> + Gets a dialog read filter that lists each of the file type descriptions and file extensions, delimeted + by the | symbol. Each will appear in DotSpatial's open file dialog filter, preceeded by the name provided + on this object. + </summary> + </member> + <member name="P:DotSpatial.Data.DotNetImageProvider.DialogWriteFilter"> + <summary> + Gets a dialog filter that lists each of the file type descriptions and extensions for a Save File Dialog. + Each will appear in DotSpatial's open file dialog filter, preceeded by the name provided on this object. + </summary> + </member> + <member name="P:DotSpatial.Data.DotNetImageProvider.Name"> + <summary> + Gets a prefereably short name that identifies this data provider. Example might be GDAL. + This will be prepended to each of the DialogReadFilter members from this plugin. + </summary> + </member> + <member name="P:DotSpatial.Data.DotNetImageProvider.Description"> + <summary> + This provides a basic description of what your provider does. + </summary> + </member> + <member name="P:DotSpatial.Data.DotNetImageProvider.ProgressHandler"> + <summary> + Gets or sets the progress handler + </summary> + </member> + <member name="T:DotSpatial.Data.IImageCoverage"> + <summary> + An Image Coverage just consists of several images that can be thought of as a single image region. + Queries for pixel values for a region will simply return the first value in the set that is not + completely transparent. + </summary> + </member> + <member name="T:DotSpatial.Data.IImageSet"> + <summary> + IImageSet is simple interface that gives some basic information that is common between tiled images and + the more general image coverages + </summary> + </member> + <member name="M:DotSpatial.Data.IImageSet.GetBitmap(DotSpatial.Data.Extent,System.Drawing.Size)"> + <summary> + Uses the geographic envelope and the specified pixelSize in order to calculate an + appropriate bitmap for display based on the various images in this set. + </summary> + <param name="envelope">The geographic bounds to display</param> + <param name="pixelSize">The pixelSize of the bitmap to display</param> + <returns>A Bitmap showing the appropriate size and dimensions of the image</returns> + </member> + <member name="M:DotSpatial.Data.IImageSet.GetImages"> + <summary> + This is very generic, but allows the user to cycle through the images currently in the image set, + regardless of whether they are in a list or an array or other data structure. + </summary> + <returns></returns> + </member> + <member name="P:DotSpatial.Data.IImageSet.Count"> + <summary> + Gets the count of the images in the image set + </summary> + </member> + <member name="P:DotSpatial.Data.IImageCoverage.Images"> + <summary> + Gets or sets the list of tiles. + </summary> + </member> + <member name="T:DotSpatial.Data.IImageData"> + <summary> + IImageData + </summary> + </member> + <member name="M:DotSpatial.Data.IImageData.CopyBitmapToValues"> + <summary> + Forces the image to read values from the graphic image format to the byte array format + </summary> + </member> + <member name="M:DotSpatial.Data.IImageData.CopyValues(DotSpatial.Data.IImageData)"> + <summary> + Copies the values from the specified source image. + </summary> + <param name="source"> + The source image to copy values from. + </param> + </member> + <member name="M:DotSpatial.Data.IImageData.CopyValuesToBitmap"> + <summary> + Forces the image to copy values from the byte array format to the image format. + </summary> + </member> + <member name="M:DotSpatial.Data.IImageData.GetColor(System.Int32,System.Int32)"> + <summary> + Creates a color structure from the byte values in the values array that correspond to the + specified position. + </summary> + <param name="row"> + The integer row index for the pixel. + </param> + <param name="column"> + The integer column index for the pixel. + </param> + <returns> + A Color. + </returns> + </member> + <member name="M:DotSpatial.Data.IImageData.Open"> + <summary> + Opens the file, assuming that the fileName has already been specified + </summary> + </member> + <member name="M:DotSpatial.Data.IImageData.Save"> + <summary> + Saves the image and associated world file to the current fileName. + </summary> + </member> + <member name="M:DotSpatial.Data.IImageData.SaveAs(System.String)"> + <summary> + Saves the image to a new fileName. + </summary> + <param name="fileName"> + The string fileName to save the image to. + </param> + </member> + <member name="M:DotSpatial.Data.IImageData.SetBitmap(System.Drawing.Bitmap)"> + <summary> + Sets the bitmap being used for this dataset + </summary> + <param name="image"> + </param> + </member> + <member name="M:DotSpatial.Data.IImageData.GetColorPalette"> + <summary> + This is only used in the palette indexed band type. + </summary> + </member> + <member name="M:DotSpatial.Data.IImageData.SetColorPalette(System.Collections.Generic.IEnumerable{System.Drawing.Color})"> + <summary> + This should update the palette cached and in the file. + </summary> + <param name="value"></param> + </member> + <member name="M:DotSpatial.Data.IImageData.SetColor(System.Int32,System.Int32,System.Drawing.Color)"> + <summary> + Sets the color value into the byte array based on the row and column position of the pixel. + </summary> + <param name="row"> + The integer row index of the pixel to set the color of. + </param> + <param name="column"> + The integer column index of the pixel to set the color of + </param> + <param name="col"> + The color to copy values from + </param> + </member> + <member name="M:DotSpatial.Data.IImageData.ReadBlock(System.Int32,System.Int32,System.Int32,System.Int32)"> + <summary> + Gets a block of data directly, converted into a bitmap. + </summary> + <param name="xOffset">The zero based integer column offset from the left</param> + <param name="yOffset">The zero based integer row offset from the top</param> + <param name="xSize">The integer number of pixel columns in the block. </param> + <param name="ySize">The integer number of pixel rows in the block.</param> + <returns>A Bitmap that is xSize, ySize.</returns> + </member> + <member name="M:DotSpatial.Data.IImageData.WriteBlock(System.Drawing.Bitmap,System.Int32,System.Int32)"> + <summary> + Saves a bitmap of data as a continuous block into the specified location. + </summary> + <param name="value">The bitmap value to save.</param> + <param name="xOffset">The zero based integer column offset from the left</param> + <param name="yOffset">The zero based integer row offset from the top</param> + </member> + <member name="M:DotSpatial.Data.IImageData.UpdateOverviews"> + <summary> + Finalizes the blocks. In the case of a pyramid image, this forces recalculation of the + various overlays. For GDAL images, this may do nothing, since the overlay recalculation + may be on the fly. For InRam images this does nothing. + </summary> + </member> + <member name="P:DotSpatial.Data.IImageData.BytesPerPixel"> + <summary> + Gets or sets an integer indicating how many bytes exist for each pixel. + Eg. 32 ARGB = 4, 24 RGB = 3, 16 bit GrayScale = 2 + </summary> + </member> + <member name="P:DotSpatial.Data.IImageData.Filename"> + <summary> + Gets or sets the fileName. + </summary> + </member> + <member name="P:DotSpatial.Data.IImageData.Height"> + <summary> + Gets the image height in pixels + </summary> + </member> + <member name="P:DotSpatial.Data.IImageData.NumBands"> + <summary> + Gets or sets the number of bands that are in the image. + One band is a gray valued image, 3 bands for color RGB and 4 bands + for ARGB. + </summary> + </member> + <member name="P:DotSpatial.Data.IImageData.Stride"> + <summary> + Gets or sets the stride in bytes. + </summary> + </member> + <member name="P:DotSpatial.Data.IImageData.Values"> + <summary> + Gets a one dimensional array of byte values + </summary> + </member> + <member name="P:DotSpatial.Data.IImageData.Width"> + <summary> + Gets the image width in pixels + </summary> + </member> + <member name="P:DotSpatial.Data.IImageData.WorldFile"> + <summary> + Gets or sets the world file that stores the georeferencing information for this image. + </summary> + </member> + <member name="P:DotSpatial.Data.IImageData.BandType"> + <summary> + Gets or sets the interpretation for the image bands. This currently is only for GDAL images. + </summary> + </member> + <member name="T:DotSpatial.Data.IImageSource"> + <summary> + IImageSource + </summary> + </member> + <member name="M:DotSpatial.Data.IImageSource.ReadWindow(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)"> + <summary> + Returns the data from the file in the form of ARGB bytes. + </summary> + <param name="startRow">The zero based integer index of the first row (Y)</param> + <param name="startColumn">The zero based integer index of the first column (X)</param> + <param name="numRows">The number of rows to read</param> + <param name="numColumns">The number of columns to read</param> + <param name="overview">The integer overview. 0 for the original image. Each successive index divides the length and height in half. </param> + <returns>A Byte of values in ARGB order and in row-major raster-scan sequence</returns> + </member> + <member name="M:DotSpatial.Data.IImageSource.GetBitmap(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)"> + <summary> + This returns the window of data as a bitmap. + </summary> + <param name="startRow">The zero based integer index of the first row (Y)</param> + <param name="startColumn">The zero based integer index of the first column (X)</param> + <param name="numRows">The number of rows to read</param> + <param name="numColumns">The number of columns to read</param> + <param name="overview">The integer overview. 0 for the original image. Each successive index divides the length and height in half. </param> + <returns></returns> + </member> + <member name="P:DotSpatial.Data.IImageSource.Bounds"> + <summary> + Gets or sets the bounds + </summary> + </member> + <member name="P:DotSpatial.Data.IImageSource.NumRows"> + <summary> + Gets the number of rows + </summary> + </member> + <member name="P:DotSpatial.Data.IImageSource.NumColumns"> + <summary> + Gets the total number of columns + </summary> + </member> + <member name="P:DotSpatial.Data.IImageSource.NumOverviews"> + <summary> + Gets the number of overviews, not counting the original image + </summary> + </member> + <member name="T:DotSpatial.Data.ImageCoverage"> + <summary> + TiledImage is a class for actually controlling the data in several tiles. This does not supply + direct accessors for + modifying the bytes directly, and instead expects the user to edit the image on a tile-by-tile basis. However, + the GetBitmap method will produce a representation of the envelope scaled to the specified window. + </summary> + </member> + <member name="M:DotSpatial.Data.ImageCoverage.#ctor"> + <summary> + Creates a new instance of TiledImage + </summary> + </member> + <member name="M:DotSpatial.Data.ImageCoverage.GetBitmap(DotSpatial.Data.Extent,System.Drawing.Size)"> + <summary> + Gets the bitmap for the specified geographic envelope scaled to fit on a bitmap of the specified size in pixels. + </summary> + <param name="envelope"></param> + <param name="pixelSize"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.ImageCoverage.GetImages"> + <inheritdoc /> + </member> + <member name="M:DotSpatial.Data.ImageCoverage.Open"> + <summary> + Cycles through each of the images and calls the open method on each one. + </summary> + </member> + <member name="M:DotSpatial.Data.ImageCoverage.Save"> + <summary> + Cycles through each of the images and calls the save method on each one + </summary> + </member> + <member name="P:DotSpatial.Data.ImageCoverage.FileName"> + <summary> + Gets or sets the Filename + </summary> + </member> + <member name="P:DotSpatial.Data.ImageCoverage.Count"> + <inheritdoc /> + </member> + <member name="P:DotSpatial.Data.ImageCoverage.Extent"> + <inheritdoc /> + </member> + <member name="P:DotSpatial.Data.ImageCoverage.Images"> + <inheritdoc /> + </member> + <member name="T:DotSpatial.Data.ImageData"> + <summary> + ImageData (not named Image because of conflicting with the Dot Net Image object) + </summary> + </member> + <member name="M:DotSpatial.Data.ImageData.#ctor"> + <summary> + Creates a new instance of ImageData + </summary> + </member> + <member name="M:DotSpatial.Data.ImageData.CopyValues(DotSpatial.Data.IImageData)"> + <summary> + Copies the values from the specified source image. + </summary> + <param name="source">The source image to copy values from.</param> + </member> + <member name="M:DotSpatial.Data.ImageData.GetBitmap"> + <summary> + Attempts to create a bitmap for the entire image. This may cause memory exceptions. + </summary> + <returns>A Bitmap of the image.</returns> + </member> + <member name="M:DotSpatial.Data.ImageData.SetBitmap(System.Drawing.Bitmap)"> + <summary> + Sets the bitmap being used for this dataset + </summary> + <param name="image"></param> + </member> + <member name="M:DotSpatial.Data.ImageData.GetBitmap(DotSpatial.Data.Extent,System.Drawing.Size)"> + <summary> + The geographic envelope gives the region that the image should be created for. + The window gives the corresponding pixel dimensions for the image, so that + images matching the resolution of the screen can be used. + </summary> + <param name="envelope">The geographic extents to retrieve data for</param> + <param name="size">The rectangle that defines the size of the drawing area in pixels</param> + <returns>A bitmap captured from the main image </returns> + </member> + <member name="M:DotSpatial.Data.ImageData.GetBitmap(DotSpatial.Data.Extent,System.Drawing.Rectangle)"> + <summary> + The geographic envelope gives the region that the image should be created for. + The window gives the corresponding pixel dimensions for the image, so that + images matching the resolution of the screen can be used. + </summary> + <param name="envelope">The geographic extents to retrieve data for</param> + <param name="window">The rectangle that defines the size of the drawing area in pixels</param> + <returns>A bitmap captured from the main image </returns> + </member> + <member name="M:DotSpatial.Data.ImageData.Open"> + <summary> + Opens the file, assuming that the fileName has already been specified + </summary> + </member> + <member name="M:DotSpatial.Data.ImageData.CopyBitmapToValues"> + <summary> + Forces the image to read values from the graphic image format to the byte array format + </summary> + </member> + <member name="M:DotSpatial.Data.ImageData.Save"> + <summary> + Saves the image and associated world file to the current fileName. + </summary> + </member> + <member name="M:DotSpatial.Data.ImageData.SaveAs(System.String)"> + <summary> + Saves the image to a new fileName. + </summary> + <param name="fileName">The string fileName to save the image to.</param> + </member> + <member name="M:DotSpatial.Data.ImageData.CopyValuesToBitmap"> + <summary> + Forces the image to copy values from the byte array format to the image format. + </summary> + </member> + <member name="M:DotSpatial.Data.ImageData.Create(System.String,System.Int32,System.Int32,DotSpatial.Data.ImageBandType)"> + <summary> + Creates a new image and world file, placing the default bounds at the origin, with one pixel per unit. + </summary> + <param name="fileName">The string fileName</param> + <param name="width">The integer width</param> + <param name="height">The integer height</param> + <param name="bandType">The color band type</param> + </member> + <member name="M:DotSpatial.Data.ImageData.Open(System.String)"> + <summary> + Opens the file with the specified fileName + </summary> + <param name="fileName">The string fileName to open</param> + </member> + <member name="M:DotSpatial.Data.ImageData.GetColor(System.Int32,System.Int32)"> + <summary> + Creates a color structure from the byte values in the values array that correspond to the + specified position. + </summary> + <param name="row">The integer row index for the pixel.</param> + <param name="column">The integer column index for the pixel.</param> + <returns>A Color.</returns> + </member> + <member name="M:DotSpatial.Data.ImageData.SetColor(System.Int32,System.Int32,System.Drawing.Color)"> + <summary> + Sets the color value into the byte array based on the row and column position of the pixel. + </summary> + <param name="row">The integer row index of the pixel to set the color of.</param> + <param name="column">The integer column index of the pixel to set the color of </param> + <param name="col">The color to copy values from</param> + </member> + <member name="M:DotSpatial.Data.ImageData.ReadBlock(System.Int32,System.Int32,System.Int32,System.Int32)"> + <summary> + Gets a block of data directly, converted into a bitmap. + </summary> + <param name="xOffset">The zero based integer column offset from the left</param> + <param name="yOffset">The zero based integer row offset from the top</param> + <param name="xSize">The integer number of pixel columns in the block. </param> + <param name="ySize">The integer number of pixel rows in the block.</param> + <returns>A Bitmap that is xSize, ySize.</returns> + </member> + <member name="M:DotSpatial.Data.ImageData.WriteBlock(System.Drawing.Bitmap,System.Int32,System.Int32)"> + <summary> + Saves a bitmap of data as a continuous block into the specified location. + Be sure to call UpdateOverviews after writing all blocks in pyramid images. + </summary> + <param name="value">The bitmap value to save.</param> + <param name="xOffset">The zero based integer column offset from the left</param> + <param name="yOffset">The zero based integer row offset from the top</param> + </member> + <member name="M:DotSpatial.Data.ImageData.UpdateOverviews"> + <summary> + Finalizes the blocks. In the case of a pyramid image, this forces recalculation of the + various overlays. For GDAL images, this may do nothing, since the overlay recalculation + may be on the fly. For InRam images this does nothing. + </summary> + </member> + <member name="M:DotSpatial.Data.ImageData.GetColorPalette"> + <summary> + This is only used in the palette indexed band type. + </summary> + </member> + <member name="M:DotSpatial.Data.ImageData.SetColorPalette(System.Collections.Generic.IEnumerable{System.Drawing.Color})"> + <summary> + This should update the palette cached and in the file. + </summary> + <param name="value"></param> + </member> + <member name="M:DotSpatial.Data.ImageData.OnBoundsChanged(DotSpatial.Data.IRasterBounds)"> + <summary> + Occurs when the bounds have been set. + </summary> + <param name="bounds">The new bounds.</param> + </member> + <member name="M:DotSpatial.Data.ImageData.Dispose(System.Boolean)"> + <summary> + Disposes the managed memory objects in the ImageData class, and then forwards + the Dispose operation to the internal dataset in the base class, if any. + </summary> + <param name="disposeManagedResources">Boolean, true if both managed and unmanaged resources should be finalized.</param> + </member> + <member name="P:DotSpatial.Data.ImageData.ColorPalette"> + <summary> + Gets or sets the color palette + </summary> + </member> + <member name="P:DotSpatial.Data.ImageData.BytesPerPixel"> + <summary> + Gets or sets an integer indicating how many bytes exist for each pixel. + Eg. 32 ARGB = 4, 24 RGB = 3, 16 bit GrayScale = 2 + </summary> + </member> + <member name="P:DotSpatial.Data.ImageData.Filename"> + <summary> + Gets or sets the fileName. + </summary> + </member> + <member name="P:DotSpatial.Data.ImageData.Height"> + <summary> + Gets the image height in pixels + </summary> + </member> + <member name="P:DotSpatial.Data.ImageData.NumBands"> + <summary> + Gets or sets the number of bands that are in the image. One band is a gray valued image, 3 bands for color RGB and 4 bands + for ARGB. + </summary> + </member> + <member name="P:DotSpatial.Data.ImageData.Stride"> + <summary> + Gets or sets the stride in bytes. + </summary> + </member> + <member name="P:DotSpatial.Data.ImageData.Values"> + <summary> + Gets a one dimensional array of byte values + </summary> + </member> + <member name="P:DotSpatial.Data.ImageData.Width"> + <summary> + Gets the image width in pixels + </summary> + </member> + <member name="P:DotSpatial.Data.ImageData.WorldFile"> + <summary> + Gets or sets the world file that stores the georeferencing information for this image. + </summary> + </member> + <member name="P:DotSpatial.Data.ImageData.BandType"> + <summary> + Gets or sets the interpretation for the image bands. This currently is only for GDAL images. + </summary> + </member> + <member name="T:DotSpatial.Data.ITiledImage"> + <summary> + ITiledImage + </summary> + </member> + <member name="P:DotSpatial.Data.ITiledImage.Bounds"> + <summary> + Gets or sets the bounds for this image + </summary> + </member> + <member name="P:DotSpatial.Data.ITiledImage.Filename"> + <summary> + Gets or sets the fileName for this tiled image. + </summary> + </member> + <member name="P:DotSpatial.Data.ITiledImage.Height"> + <summary> + Gets or sets the integer height in pixels for the combined image at its maximum resolution + </summary> + </member> + <member name="P:DotSpatial.Data.ITiledImage.Stride"> + <summary> + Gets the stride, or total width in pixels of the byte data, which might not match exactly with the visible width. + </summary> + </member> + <member name="P:DotSpatial.Data.ITiledImage.TileWidth"> + <summary> + Gets the tile width + </summary> + </member> + <member name="P:DotSpatial.Data.ITiledImage.TileHeight"> + <summary> + Gets the tile height + </summary> + </member> + <member name="P:DotSpatial.Data.ITiledImage.Width"> + <summary> + Gets or sets the integer pixel width for the combined image at its maximum resolution. + </summary> + </member> + <member name="P:DotSpatial.Data.ITiledImage.WorldFile"> + <summary> + Gets or sets the WorldFile for this set of tiles. + </summary> + </member> + <member name="T:DotSpatial.Data.InRamImageData"> + <summary> + MWImageData + </summary> + </member> + <member name="F:DotSpatial.Data.InRamImageData._myImage"> + <summary> + The _my image. + </summary> + </member> + <member name="M:DotSpatial.Data.InRamImageData.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:DotSpatial.Data.InRamImageData"/> class. + Creates an empty ImageData to be created or loaded + </summary> + </member> + <member name="M:DotSpatial.Data.InRamImageData.#ctor(System.String)"> + <summary> + Initializes a new instance of the <see cref="T:DotSpatial.Data.InRamImageData"/> class. + Creates a new MWImageData class from the specified fileName. + </summary> + <param name="fileName"> + The string filename. + </param> + </member> + <member name="M:DotSpatial.Data.InRamImageData.#ctor(System.Drawing.Image)"> + <summary> + Initializes a new instance of the <see cref="T:DotSpatial.Data.InRamImageData"/> class. + Creates the bitmap from the raw image specified. The bounds should be set on this later. + </summary> + <param name="rawImage"> + The raw image. + </param> + </member> + <member name="M:DotSpatial.Data.InRamImageData.#ctor(System.Drawing.Bitmap,DotSpatial.Data.Extent)"> + <summary> + Initializes a new instance of the <see cref="T:DotSpatial.Data.InRamImageData"/> class. + Uses a bitmap and a geographic envelope in order to define a new imageData object. + </summary> + <param name="rawImage"> + The raw image. + </param> + <param name="bounds"> + The envelope bounds. + </param> + </member> + <member name="M:DotSpatial.Data.InRamImageData.#ctor(System.Int32,System.Int32)"> + <summary> + Initializes a new instance of the <see cref="T:DotSpatial.Data.InRamImageData"/> class. + Constructs a new ImageData of the specified width and height. + </summary> + <param name="width"> + The integer width in pixels. + </param> + <param name="height"> + The integer height in pixels. + </param> + </member> + <member name="M:DotSpatial.Data.InRamImageData.Close"> + <summary> + Closes the image content. + </summary> + </member> + <member name="M:DotSpatial.Data.InRamImageData.CopyBitmapToValues"> + <summary> + Forces the image to read values from the graphic image format to the byte array format + </summary> + </member> + <member name="M:DotSpatial.Data.InRamImageData.CopyValues(DotSpatial.Data.IImageData)"> + <summary> + Copies the values from the specified source image. + </summary> + <param name="source"> + The source image to copy values from. + </param> + </member> + <member name="M:DotSpatial.Data.InRamImageData.CopyValuesToBitmap"> + <summary> + Forces the image to copy values from the byte array format to the image format. + </summary> + </member> + <member name="M:DotSpatial.Data.InRamImageData.Create(System.String,System.Int32,System.Int32,DotSpatial.Data.ImageBandType)"> + <summary> + Creates a new image and world file, placing the default bounds at the origin, with one pixel per unit. + </summary> + <param name="fileName"> + The string fileName + </param> + <param name="width"> + The integer width + </param> + <param name="height"> + The integer height + </param> + <param name="bandType">The ImageBandType that clarifies how the separate bands are layered in the image.</param> + </member> + <member name="M:DotSpatial.Data.InRamImageData.GetBitmap"> + <summary> + Returns the internal bitmap in this case. In other cases, this may have to be constructed + from the unmanaged memory content. + </summary> + <returns> + A Bitmap that represents the entire image. + </returns> + </member> + <member name="M:DotSpatial.Data.InRamImageData.GetBitmap(DotSpatial.Data.Extent,System.Drawing.Rectangle)"> + <summary> + The geographic envelope gives the region that the image should be created for. + The window gives the corresponding pixel dimensions for the image, so that + images matching the resolution of the screen can be used. + </summary> + <param name="envelope"> + The geographic extents to retrieve data for + </param> + <param name="window"> + The rectangle that defines the size of the drawing area in pixels + </param> + <returns> + A bitmap captured from the main image + </returns> + </member> + <member name="M:DotSpatial.Data.InRamImageData.Open"> + <summary> + Opens the file, assuming that the fileName has already been specified using a Dot Net Image object + </summary> + </member> + <member name="M:DotSpatial.Data.InRamImageData.Save"> + <summary> + Saves the current image and world file. + </summary> + </member> + <member name="M:DotSpatial.Data.InRamImageData.SaveAs(System.String)"> + <summary> + Saves the image to the specified fileName + </summary> + <param name="fileName"> + The string fileName to save this as + </param> + </member> + <member name="M:DotSpatial.Data.InRamImageData.SetBitmap(System.Drawing.Bitmap)"> + <summary> + Sets the bitmap + </summary> + <param name="image"> + </param> + </member> + <member name="M:DotSpatial.Data.InRamImageData.Dispose(System.Boolean)"> + <summary> + Release any unmanaged memory objects + </summary> + <param name="disposeManagedResources"> + The dispose Managed Resources. + </param> + </member> + <member name="M:DotSpatial.Data.InRamImageData.MemorySetup"> + <summary> + The memory setup. + </summary> + </member> + <member name="M:DotSpatial.Data.InRamImageData.ReadBlock(System.Int32,System.Int32,System.Int32,System.Int32)"> + <summary> + Gets a block of data directly, converted into a bitmap. + </summary> + <param name="xOffset">The zero based integer column offset from the left</param> + <param name="yOffset">The zero based integer row offset from the top</param> + <param name="xSize">The integer number of pixel columns in the block. </param> + <param name="ySize">The integer number of pixel rows in the block.</param> + <returns>A Bitmap that is xSize, ySize.</returns> + </member> + <member name="M:DotSpatial.Data.InRamImageData.OnBoundsChanged(DotSpatial.Data.IRasterBounds)"> + <summary> + Extends the normal bounds changing behavior to also update the world file. + </summary> + <param name="bounds">Updates the world file.</param> + </member> + <member name="M:DotSpatial.Data.InRamImageData.WriteBlock(System.Drawing.Bitmap,System.Int32,System.Int32)"> + <summary> + Saves a bitmap of data as a continuous block into the specified location. + </summary> + <param name="value">The bitmap value to save.</param> + <param name="xOffset">The zero based integer column offset from the left</param> + <param name="yOffset">The zero based integer row offset from the top</param> + </member> + <member name="T:DotSpatial.Data.BitDepth"> + <summary> + BitDepth + </summary> + </member> + <member name="F:DotSpatial.Data.BitDepth.One"> + <summary> + One bit per band pixel + </summary> + </member> + <member name="F:DotSpatial.Data.BitDepth.Two"> + <summary> + Two bits per band pixel + </summary> + </member> + <member name="F:DotSpatial.Data.BitDepth.Four"> + <summary> + Four bits per band pixel + </summary> + </member> + <member name="F:DotSpatial.Data.BitDepth.Eight"> + <summary> + Eight bits per band pixel (normal) + </summary> + </member> + <member name="F:DotSpatial.Data.BitDepth.Sixteen"> + <summary> + Sixteen bits per band pixel + </summary> + </member> + <member name="T:DotSpatial.Data.ColorType"> + <summary> + ColorType + </summary> + </member> + <member name="F:DotSpatial.Data.ColorType.Greyscale"> + <summary> + Each pixel is a greyscale sample + </summary> + </member> + <member name="F:DotSpatial.Data.ColorType.Truecolor"> + <summary> + Each pixel is an RGB triple + </summary> + </member> + <member name="F:DotSpatial.Data.ColorType.Indexed"> + <summary> + Each pixel is a palette index + </summary> + </member> + <member name="F:DotSpatial.Data.ColorType.GreyscaleAlpha"> + <summary> + Each pixel is a greyscale sample followed by an alpha sample + </summary> + </member> + <member name="F:DotSpatial.Data.ColorType.TruecolorAlpha"> + <summary> + EAch pixel is an RGB triple followed by an alhpa sample + </summary> + </member> + <member name="T:DotSpatial.Data.Crc32"> + <summary> + CRC32 + </summary> + </member> + <member name="F:DotSpatial.Data.Crc32._table"> + <summary> + A table of values + </summary> + </member> + <member name="M:DotSpatial.Data.Crc32.GetCrcOld(System.Byte[])"> + <summary> + Calculates the CRC-32-IEEE 802.3 Checkzum for png according to: + x^32 + x^26 + x^23 + x^22 + x^16 + + x^12 + x^11 + x^10 + x^8 + x^7 + x^5 + x^4 + x^2 + x + 1 + </summary> + <param name="value"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.Crc32.ComputeChecksum(System.Byte[])"> + <summary> + Computes the Checksum + </summary> + <param name="bytes"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.Crc32.ComputeChecksumBytes(System.Byte[])"> + <summary> + Computes the checksum bytes + </summary> + <param name="bytes"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.Crc32.CreateTable2"> + <summary> + Creates a table of checksum values + </summary> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.Crc32.GetCrc2(System.Byte[])"> + <summary> + Calculates the CRC-32-IEEE 802.3 Checkzum for png according to: + x^32 + x^26 + x^23 + x^22 + x^16 + + x^12 + x^11 + x^10 + x^8 + x^7 + x^5 + x^4 + x^2 + x + 1 + </summary> + <param name="value"></param> + <returns>A UInt32 value stored in a long because UINT32 is not CLS compliant</returns> + </member> + <member name="M:DotSpatial.Data.Crc32.UpdateCrc(System.UInt32,System.Byte[],System.Int32)"> + <summary> + Updates the running CRC + </summary> + </member> + <member name="M:DotSpatial.Data.Crc32.CreateTable"> + <summary> + Creates the table according to the png specification + </summary> + <returns></returns> + </member> + <member name="T:DotSpatial.Data.Deflate"> + <summary> + Deflated data content is widely understood by gzip utilities, but this system is specifically designed to work + with png data format, and so will only work with code 8 compression strategy. + </summary> + </member> + <member name="M:DotSpatial.Data.Deflate.Compress(System.Byte[])"> + <summary> + Compress + </summary> + <param name="values"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.Deflate.Decompress(System.Byte[])"> + <summary> + Decompress + </summary> + <param name="values"></param> + <returns></returns> + </member> + <member name="T:DotSpatial.Data.InterlaceMethod"> + <summary> + InterlaceMethods + </summary> + </member> + <member name="F:DotSpatial.Data.InterlaceMethod.NoInterlacing"> + <summary> + No interlacing + </summary> + </member> + <member name="F:DotSpatial.Data.InterlaceMethod.Adam7"> + <summary> + Adam7 interlacing + </summary> + </member> + <member name="T:DotSpatial.Data.MwPng"> + <summary> + mw.png provides read-write support for a png format that also can provide overviews etc. + This cannot work with any possible png file, but rather provides at least one common + format that can be used natively for large files that is better at compression than + just storing the values directly. + http://www.w3.org/TR/2003/REC-PNG-20031110/#11PLTE + </summary> + </member> + <member name="M:DotSpatial.Data.MwPng.Write(System.Drawing.Bitmap,System.String)"> + <summary> + For testing, see if we can write a png ourself that can be opened by .Net png. + </summary> + <param name="image">The image to write to png format</param> + <param name="fileName">The string fileName</param> + </member> + <member name="M:DotSpatial.Data.MwPng.Read(System.String)"> + <summary> + Reads a fileName into the specified bitmap. + </summary> + <param name="fileName"></param> + <returns></returns> + <exception cref="T:DotSpatial.Data.PngInvalidSignatureException">If the file signature doesn't match the png file signature</exception> + </member> + <member name="M:DotSpatial.Data.MwPng.SignatureIsValid(System.Byte[])"> + <summary> + </summary> + <param name="signature"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.MwPng.ToBytesAsUInt32(System.Int64)"> + <summary> + Writes an in Big-endian Uint format. + </summary> + <param name="value"></param> + </member> + <member name="M:DotSpatial.Data.MwPng.Filter(System.Byte[],System.Int32,System.Int32,System.Int32)"> + <summary> + Many rows may be evaluated by this process, but the first value in the array should + be aligned with the left side of the image. + </summary> + <param name="refData">The original bytes to apply the PaethPredictor to.</param> + <param name="offset">The integer offset in the array where the filter should begin application. If this is 0, then + it assumes that there is no previous scan-line to work with.</param> + <param name="length">The number of bytes to filter, starting at the specified offset. This should be evenly divisible by the width.</param> + <param name="width">The integer width of a scan-line for grabbing the c and b bytes</param> + <returns>The entire length of bytes starting with the specified offset</returns> + </member> + <member name="M:DotSpatial.Data.MwPng.UnFilter(System.Byte[],System.Int32,System.Int32,System.Int32)"> + <summary> + Unfilters the data in order to reconstruct the original values. + </summary> + <param name="filterStream">The filtered but decompressed bytes</param> + <param name="offset">the integer offset where reconstruction should begin</param> + <param name="length">The integer length of bytes to deconstruct</param> + <param name="width">The integer width of a scan-line in bytes (not counting any filter type bytes.</param> + <returns></returns> + <exception cref="T:DotSpatial.Data.PngInsuficientLengthException"></exception> + </member> + <member name="M:DotSpatial.Data.MwPng.PaethPredictor(System.Byte,System.Byte,System.Byte)"> + <summary> + B C - For the current pixel X, use the best fit from B, C or A to predict X. + A X + </summary> + <param name="a"></param> + <param name="b"></param> + <param name="c"></param> + <returns></returns> + </member> + <member name="T:DotSpatial.Data.PngHeader"> + <summary> + PngHeader + </summary> + </member> + <member name="F:DotSpatial.Data.PngHeader.CompressionMethod"> + <summary> + At this time, the only compression method recognized is 0 - deflate/inflate with a + sliding window of at most 32768 bytes + </summary> + </member> + <member name="F:DotSpatial.Data.PngHeader.FilterMethod"> + <summary> + At this time, only filter method 0 is outlined in the international standards. + (adaptive filtering with 5 basic filter types) + </summary> + </member> + <member name="M:DotSpatial.Data.PngHeader.#ctor(System.Int32,System.Int32)"> + <summary> + Creates a new instance of PngHeader + </summary> + </member> + <member name="M:DotSpatial.Data.PngHeader.Write(System.IO.Stream)"> + <summary> + Writes the byte-format of this png image header chunk to + </summary> + <param name="stream"></param> + </member> + <member name="M:DotSpatial.Data.PngHeader.ToBytes"> + <summary> + Returns the image header in bytes. + </summary> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.PngHeader.WriteAsUint32(System.Byte[],System.Int32,System.Int64)"> + <summary> + Writes an integer in Big-endian Uint format. + </summary> + <param name="array"></param> + <param name="offset"></param> + <param name="value"></param> + </member> + <member name="M:DotSpatial.Data.PngHeader.Write(System.Byte[],System.Int32,System.Int32)"> + <summary> + Writes an integer in Big-endian Uint format. + </summary> + <param name="array"></param> + <param name="offset"></param> + <param name="value"></param> + </member> + <member name="M:DotSpatial.Data.PngHeader.FromBytes(System.IO.Stream)"> + <summary> + Reads the important content from the stream of bytes + </summary> + <param name="stream"></param> + </member> + <member name="P:DotSpatial.Data.PngHeader.BitDepth"> + <summary> + Gets or sets the bit depth. Depending on the Color Type, not all are allowed: + Greyscale - 1, 2, 4, 8, 16 + Truecolor - 8, 16 + Indexed - 1, 2, 4, 8 + Greyscale/alpha - 8, 16 + TrueColor/alpha - 8, 16 + </summary> + </member> + <member name="P:DotSpatial.Data.PngHeader.ColorType"> + <summary> + Gets or sets the color type. + </summary> + </member> + <member name="P:DotSpatial.Data.PngHeader.Width"> + <summary> + Gets or sets the width + </summary> + </member> + <member name="P:DotSpatial.Data.PngHeader.Height"> + <summary> + Gets or sets the height + </summary> + </member> + <member name="P:DotSpatial.Data.PngHeader.InterlaceMethod"> + <summary> + Gets or sets the interlacing method used for this image. + </summary> + </member> + <member name="T:DotSpatial.Data.PngInsuficientLengthException"> + <summary> + PngInsuficientLengthException + </summary> + </member> + <member name="M:DotSpatial.Data.PngInsuficientLengthException.#ctor(System.Int32,System.Int32,System.Int32)"> + <summary> + Creates a new instance of PngInsuficientLengthException + </summary> + </member> + <member name="T:DotSpatial.Data.PngInvalidSignatureException"> + <summary> + PngInvalidSignatureException + </summary> + </member> + <member name="M:DotSpatial.Data.PngInvalidSignatureException.#ctor"> + <summary> + Creates a new instance of PngInvalidSignatureException + </summary> + </member> + <member name="T:DotSpatial.Data.PyramidByteMismatchException"> + <summary> + PyramidByteMismatch + </summary> + </member> + <member name="T:DotSpatial.Data.PyramidException"> + <summary> + PyramidException + </summary> + </member> + <member name="M:DotSpatial.Data.PyramidException.#ctor(System.String)"> + <summary> + Creates a new instance of PyramidException + </summary> + </member> + <member name="M:DotSpatial.Data.PyramidByteMismatchException.#ctor"> + <summary> + Creates a new instance of PyramidByteMismatch + </summary> + </member> + <member name="T:DotSpatial.Data.PyramidHeader"> + <summary> + PyramidHeader + </summary> + </member> + <member name="M:DotSpatial.Data.PyramidHeader.HeaderSize"> + <summary> + Calculates the header size for this + </summary> + <returns></returns> + </member> + <member name="P:DotSpatial.Data.PyramidHeader.ImageHeaders"> + <summary> + Gets or sets the array that encompasses all of the basic header content + necessary for working with this image. + </summary> + </member> + <member name="T:DotSpatial.Data.PyramidImage"> + <summary> + The Pyramid Image is designed with the expectation that the image will be too big to access all at once. + It is stored with multiple resolutions in a "mwi or DotSpatial Image" format. It is raw bytes in argb order. + The header content is stored in xml format. + </summary> + </member> + <member name="M:DotSpatial.Data.PyramidImage.#ctor"> + <summary> + Creates a new instance of PyramidImage + </summary> + </member> + <member name="M:DotSpatial.Data.PyramidImage.#ctor(System.String)"> + <summary> + Creates a new PyramidImage by reading in the header content for the specified fileName. + </summary> + <param name="fileName"></param> + </member> + <member name="M:DotSpatial.Data.PyramidImage.#ctor(System.String,DotSpatial.Data.IRasterBounds)"> + <summary> + Creates a new Pyramid image, and uses the raster bounds to specify the number or rows and columns. + No data is written at this time. + </summary> + <param name="fileName"></param> + <param name="bounds"></param> + </member> + <member name="M:DotSpatial.Data.PyramidImage.GetBitmap"> + <summary> + For big images this won't work, but this gets the 0 scale original image as a bitmap. + </summary> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.PyramidImage.GetBitmap(DotSpatial.Data.Extent,System.Drawing.Rectangle)"> + <summary> + For big images the scale that is just one step larger than the specified window will be used. + </summary> + <param name="envelope"></param> + <param name="window"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.PyramidImage.Open"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.PyramidImage.CreateHeaders"> + <summary> + Creates the headers using the existing RasterBounds for this image + </summary> + </member> + <member name="M:DotSpatial.Data.PyramidImage.CreateHeaders(DotSpatial.Data.RasterBounds)"> + <summary> + This takes an original image and calculates the header content for all the lower resolution tiles. + This does not actually write the bytes for those images. + </summary> + <param name="originalImage">The raster bounds for the original image.</param> + </member> + <member name="M:DotSpatial.Data.PyramidImage.CreateHeaders(System.Int32,System.Int32,System.Double[])"> + <summary> + This takes an original image and calculates the header content for all the lower resolution tiles. + This does not actually write the bytes for those images. + </summary> + <param name="numRows">The number of rows in the original image</param> + <param name="numColumns">The number of columns in the original image</param> + <param name="affineCoefficients"> + the array of doubles in ABCDEF order + X' = A + Bx + Cy + Y' = D + Ex + Fy + </param> + </member> + <member name="M:DotSpatial.Data.PyramidImage.CreatePyramids2"> + <summary> + This assumes that the base image has been written to the file. This will now attempt to calculate + the down-sampled images. + </summary> + </member> + <member name="M:DotSpatial.Data.PyramidImage.CreatePyramids"> + <summary> + This assumes that the base image has been written to the file. This will now attempt to calculate + the down-sampled images. + </summary> + </member> + <member name="M:DotSpatial.Data.PyramidImage.DownSample(System.Byte[])"> + <summary> + downsamples this row by selecting every other byte + </summary> + <param name="row"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.PyramidImage.Blur(System.Byte[],System.Byte[],System.Byte[])"> + <summary> + This is normally weighted for calculations for the middle row. If the top or bottom row + is null, it will use mirror symetry by grabbing values from the other row instead. + </summary> + <param name="r1"></param> + <param name="r2"></param> + <param name="r3"></param> + </member> + <member name="M:DotSpatial.Data.PyramidImage.ReadWindow(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)"> + <summary> + This writes a window of byte values (ARGB order) to the file. This assumes that the headers already exist. + If the headers have not been created or the bounds extend beyond the header numRows and numColumns for the + specified scale, this will throw an exception. + </summary> + <param name="startRow">The integer start row</param> + <param name="startColumn">The integer start column</param> + <param name="numRows">The integer number of rows in the window</param> + <param name="numColumns">The integer number of columns in the window</param> + <param name="scale">The integer scale. 0 is the original image.</param> + <returns>The bytes created by this process</returns> + <exception cref="T:DotSpatial.Data.PyramidUndefinedHeaderException">Occurs when attempting to write data before the headers are defined</exception> + <exception cref="T:DotSpatial.Data.PyramidOutOfBoundsException">Occurs if the range specified is outside the bounds for the specified image scale</exception> + </member> + <member name="M:DotSpatial.Data.PyramidImage.WriteWindow(System.Byte[],System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)"> + <summary> + This writes a window of byte values (ARGB order) to the file. This assumes that the headers already exist. + If the headers have not been created or the bounds extend beyond the header numRows and numColumns for the + specified scale, this will throw an exception. + </summary> + <param name="bytes">The byte array</param> + <param name="startRow">The integer start row</param> + <param name="startColumn">The integer start column</param> + <param name="numRows">The integer number of rows in the window</param> + <param name="numColumns">The integer number of columns in the window</param> + <param name="scale">The integer scale. 0 is the original image.</param> + <exception cref="T:DotSpatial.Data.PyramidUndefinedHeaderException">Occurs when attempting to write data before the headers are defined</exception> + <exception cref="T:DotSpatial.Data.PyramidOutOfBoundsException">Occurs if the range specified is outside the bounds for the specified image scale</exception> + </member> + <member name="M:DotSpatial.Data.PyramidImage.WriteWindow(System.Byte[],System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,DotSpatial.Data.ProgressMeter)"> + <summary> + This writes a window of byte values (ARGB order) to the file. This assumes that the headers already exist. + If the headers have not been created or the bounds extend beyond the header numRows and numColumns for the + specified scale, this will throw an exception. + </summary> + <param name="bytes">The byte array</param> + <param name="startRow">The integer start row</param> + <param name="startColumn">The integer start column</param> + <param name="numRows">The integer number of rows in the window</param> + <param name="numColumns">The integer number of columns in the window</param> + <param name="scale">The integer scale. 0 is the original image.</param> + <param name="pm">The progress meter to advance by row. Calls Next() for each row.</param> + <exception cref="T:DotSpatial.Data.PyramidUndefinedHeaderException">Occurs when attempting to write data before the headers are defined</exception> + <exception cref="T:DotSpatial.Data.PyramidOutOfBoundsException">Occurs if the range specified is outside the bounds for the specified image scale</exception> + </member> + <member name="M:DotSpatial.Data.PyramidImage.ReadHeader(System.String)"> + <summary> + Reads the header only from the specified mwi file. The header is in xml format. + This is a test. We may have to jurry rig the thing to ensure it ignores the actual + image content. + </summary> + <param name="fileName">Whether this is the mwi or mwh file, this reads the mwh file for the fileName.</param> + </member> + <member name="M:DotSpatial.Data.PyramidImage.WriteHeader(System.String)"> + <summary> + Writes the header to the specified fileName. + </summary> + <param name="fileName">The string fileName to write the header to.</param> + </member> + <member name="M:DotSpatial.Data.PyramidImage.ReadBlock(System.Int32,System.Int32,System.Int32,System.Int32)"> + <summary> + Gets a block of data directly, converted into a bitmap. This is a general + implementation, so assumes you are reading and writing to the 0 scale. + This is always in ARGB format. + </summary> + <param name="xOffset">The zero based integer column offset from the left</param> + <param name="yOffset">The zero based integer row offset from the top</param> + <param name="xSize">The integer number of pixel columns in the block. </param> + <param name="ySize">The integer number of pixel rows in the block.</param> + <returns>A Bitmap that is xSize, ySize.</returns> + </member> + <member name="M:DotSpatial.Data.PyramidImage.WriteBlock(System.Drawing.Bitmap,System.Int32,System.Int32)"> + <summary> + Saves a bitmap of data as a continuous block into the specified location. This + is a general implementation, so assumes you are reading and writing to the 0 scale. + This should be in ARGB pixel format or it will fail. + </summary> + <param name="value">The bitmap value to save.</param> + <param name="xOffset">The zero based integer column offset from the left</param> + <param name="yOffset">The zero based integer row offset from the top</param> + </member> + <member name="M:DotSpatial.Data.PyramidImage.UpdateOverviews"> + <summary> + Updates overviews. In the case of a Pyramid image, this recalculates the values. + </summary> + </member> + <member name="P:DotSpatial.Data.PyramidImage.Header"> + <summary> + Gets or sets the pyramid image header + </summary> + </member> + <member name="T:DotSpatial.Data.PyramidImageHeader"> + <summary> + PyramidImageHeader + </summary> + </member> + <member name="M:DotSpatial.Data.PyramidImageHeader.SetAffine(System.Double[],System.Int32)"> + <summary> + Scale is an integer value that starts at 0 for the original image and represents the number of + times the number of columns and number of rows are divided by 2. + </summary> + <param name="affine">The affine array of the original, unmodified image</param> + <param name="scale">The integer scale starting at 0 for the original image, and increasing by one for each down-sampling</param> + </member> + <member name="M:DotSpatial.Data.PyramidImageHeader.SetNumRows(System.Int32,System.Int32)"> + <summary> + Sets the number of rows based on the integer scale + </summary> + <param name="originalNumRows"></param> + <param name="scale">integer starts at 0 for the original image</param> + </member> + <member name="M:DotSpatial.Data.PyramidImageHeader.SetNumColumns(System.Int32,System.Int32)"> + <summary> + Sets the number of columns based on the integer scale + </summary> + <param name="originalNumColumns"></param> + <param name="scale">integer starts at 0 for the original image</param> + </member> + <member name="P:DotSpatial.Data.PyramidImageHeader.Offset"> + <summary> + Offsets + </summary> + </member> + <member name="P:DotSpatial.Data.PyramidImageHeader.NumRows"> + <summary> + Integer number of rows + </summary> + </member> + <member name="P:DotSpatial.Data.PyramidImageHeader.NumColumns"> + <summary> + Integer number of columns + </summary> + </member> + <member name="P:DotSpatial.Data.PyramidImageHeader.Affine"> + <summary> + Gets or sets the affine coefficients for this image in ABCDEF order + X' = A + BX + CY + Y' = D + EX + FY + </summary> + </member> + <member name="T:DotSpatial.Data.PyramidOutOfBoundsException"> + <summary> + PyramidOutOfBoundsException + </summary> + </member> + <member name="M:DotSpatial.Data.PyramidOutOfBoundsException.#ctor"> + <summary> + Creates a new instance of PyramidOutOfBoundsException + </summary> + </member> + <member name="T:DotSpatial.Data.PyramidUndefinedHeaderException"> + <summary> + PyramidUndefinedHeader + </summary> + </member> + <member name="M:DotSpatial.Data.PyramidUndefinedHeaderException.#ctor"> + <summary> + Creates a new instance of PyramidUndefinedHeader + </summary> + </member> + <member name="T:DotSpatial.Data.TileCollection"> + <summary> + TileCollection + </summary> + </member> + <member name="M:DotSpatial.Data.TileCollection.GetEnumerator"> + <inheritdoc /> + </member> + <member name="M:DotSpatial.Data.TileCollection.#ctor(System.Int32,System.Int32)"> + <summary> + Creates a new instance of TileCollection + </summary> + </member> + <member name="M:DotSpatial.Data.TileCollection.SetTileBounds(System.Double[])"> + <summary> + Calls a method that calculates the propper image bounds for each of the extents of the tiles, + given the affine coefficients for the whole image. + </summary> + <param name="affine"> x' = A + Bx + Cy; y' = D + Ex + Fy</param> + </member> + <member name="M:DotSpatial.Data.TileCollection.GetTileWidth(System.Int32)"> + <summary> + Gets the width of the tile + </summary> + <param name="col"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.TileCollection.GetTileHeight(System.Int32)"> + <summary> + Gets the height of the tile + </summary> + <param name="row"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.TileCollection.NumTilesWide"> + <summary> + Gets the number of tiles in the X direction + </summary> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.TileCollection.NumTilesTall"> + <summary> + Gets the integer number of tiles in the Y direction + </summary> + <returns></returns> + </member> + <member name="P:DotSpatial.Data.TileCollection.Height"> + <summary> + Gets or sets the integer height in pixels for the combined image at its maximum resolution + </summary> + </member> + <member name="P:DotSpatial.Data.TileCollection.Width"> + <summary> + Gets or sets the integer pixel width for the combined image at its maximum resolution. + </summary> + </member> + <member name="P:DotSpatial.Data.TileCollection.Tiles"> + <summary> + Gets or sets the 2D array of tiles + </summary> + </member> + <member name="P:DotSpatial.Data.TileCollection.TileWidth"> + <summary> + The width of the standard sized tile (not counting the remainder) + </summary> + </member> + <member name="P:DotSpatial.Data.TileCollection.TileHeight"> + <summary> + The height of the standard sized tile, not counting the remainder. + </summary> + </member> + <member name="P:DotSpatial.Data.TileCollection.NumTiles"> + <summary> + The total number of tiles + </summary> + </member> + <member name="T:DotSpatial.Data.TileCollection.TileCollectionEnumerator"> + <summary> + Enumerates the collection of tiles + </summary> + </member> + <member name="M:DotSpatial.Data.TileCollection.TileCollectionEnumerator.#ctor(DotSpatial.Data.TileCollection)"> + <summary> + Creates a new instance of hte TileCollectionEnumerator + </summary> + <param name="parent">The parent tileCollection</param> + </member> + <member name="M:DotSpatial.Data.TileCollection.TileCollectionEnumerator.Dispose"> + <inheritdoc /> + </member> + <member name="M:DotSpatial.Data.TileCollection.TileCollectionEnumerator.MoveNext"> + <inheritdoc /> + </member> + <member name="M:DotSpatial.Data.TileCollection.TileCollectionEnumerator.Reset"> + <inheritdoc /> + </member> + <member name="P:DotSpatial.Data.TileCollection.TileCollectionEnumerator.Current"> + <inheritdoc /> + </member> + <member name="T:DotSpatial.Data.TiledImage"> + <summary> + TiledImage is a special kind of image coverage where the images specifically form tiles that + are adjacent and perfectly aligned to represent a larger image. + </summary> + </member> + <member name="M:DotSpatial.Data.TiledImage.#ctor(System.String)"> + <summary> + Creates a new instance of the TiledImage where the fileName is specified. + This doesn't actually open the file until the Open method is called. + </summary> + <param name="fileName"></param> + </member> + <member name="M:DotSpatial.Data.TiledImage.#ctor(System.Int32,System.Int32)"> + <summary> + Creates a new instance of TiledImage + </summary> + </member> + <member name="M:DotSpatial.Data.TiledImage.Open"> + <summary> + This should be overridden with custom file handling + </summary> + </member> + <member name="M:DotSpatial.Data.TiledImage.GetBitmap(DotSpatial.Data.Extent,System.Drawing.Size)"> + <inheritdoc /> + </member> + <member name="M:DotSpatial.Data.TiledImage.Close"> + <inheritdoc /> + </member> + <member name="M:DotSpatial.Data.TiledImage.Init(System.Int32,System.Int32)"> + <summary> + Even if this TiledImage has already been constructed, we can initialize the tile collection later. + </summary> + <param name="width"></param> + <param name="height"></param> + </member> + <member name="M:DotSpatial.Data.TiledImage.SetTileBounds(System.Double[])"> + <summary> + Calls a method that calculates the proper image bounds for each of the extents of the tiles, + given the affine coefficients for the whole image. + </summary> + <param name="affine"> x' = A + Bx + Cy; y' = D + Ex + Fy</param> + </member> + <member name="M:DotSpatial.Data.TiledImage.CopyValues(DotSpatial.Data.IImageData)"> + <inheritdoc /> + </member> + <member name="M:DotSpatial.Data.TiledImage.GetBitmap"> + <inheritdoc /> + </member> + <member name="M:DotSpatial.Data.TiledImage.GetBitmap(DotSpatial.Data.Extent,System.Drawing.Rectangle)"> + <inheritdoc /> + </member> + <member name="M:DotSpatial.Data.TiledImage.GetColor(System.Int32,System.Int32)"> + <inheritdoc /> + </member> + <member name="M:DotSpatial.Data.TiledImage.CopyBitmapToValues"> + <inheritdoc /> + </member> + <member name="M:DotSpatial.Data.TiledImage.Save"> + <inheritdoc /> + </member> + <member name="M:DotSpatial.Data.TiledImage.SaveAs(System.String)"> + <inheritdoc /> + </member> + <member name="M:DotSpatial.Data.TiledImage.SetColor(System.Int32,System.Int32,System.Drawing.Color)"> + <inheritdoc /> + </member> + <member name="M:DotSpatial.Data.TiledImage.CopyValuesToBitmap"> + <inheritdoc /> + </member> + <member name="M:DotSpatial.Data.TiledImage.SetBitmap(System.Drawing.Bitmap)"> + <summary> + Not Implemented + </summary> + <param name="image"></param> + </member> + <member name="M:DotSpatial.Data.TiledImage.GetColorPalette"> + <summary> + Not Implemented. + </summary> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.TiledImage.SetColorPalette(System.Collections.Generic.IEnumerable{System.Drawing.Color})"> + <summary> + Not Implemented + </summary> + <param name="value"></param> + </member> + <member name="M:DotSpatial.Data.TiledImage.ReadBlock(System.Int32,System.Int32,System.Int32,System.Int32)"> + <summary> + Not implemented + </summary> + <param name="xOffset"></param> + <param name="yOffset"></param> + <param name="xSize"></param> + <param name="ySize"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.TiledImage.WriteBlock(System.Drawing.Bitmap,System.Int32,System.Int32)"> + <summary> + Not Implemented + </summary> + <param name="value"></param> + <param name="xOffset"></param> + <param name="yOffset"></param> + </member> + <member name="M:DotSpatial.Data.TiledImage.UpdateOverviews"> + <summary> + Not implemented + </summary> + </member> + <member name="M:DotSpatial.Data.TiledImage.GetImages"> + <inheritdoc /> + </member> + <member name="M:DotSpatial.Data.TiledImage.Dispose(System.Boolean)"> + <inheritdoc /> + </member> + <member name="P:DotSpatial.Data.TiledImage.Tiles"> + <summary> + Gets or sets the array of tiles used for this + </summary> + </member> + <member name="P:DotSpatial.Data.TiledImage.TileCollection"> + <summary> + + </summary> + </member> + <member name="P:DotSpatial.Data.TiledImage.Filename"> + <inheritdoc /> + </member> + <member name="P:DotSpatial.Data.TiledImage.Height"> + <inheritdoc /> + </member> + <member name="P:DotSpatial.Data.TiledImage.Stride"> + <inheritdoc /> + </member> + <member name="P:DotSpatial.Data.TiledImage.Width"> + <inheritdoc /> + </member> + <member name="P:DotSpatial.Data.TiledImage.NumBands"> + <summary> + Gets or sets the number of bands + </summary> + </member> + <member name="P:DotSpatial.Data.TiledImage.BytesPerPixel"> + <inheritdoc /> + </member> + <member name="P:DotSpatial.Data.TiledImage.Values"> + <inheritdoc /> + </member> + <member name="P:DotSpatial.Data.TiledImage.BandType"> + <summary> + Not Implemented + </summary> + </member> + <member name="P:DotSpatial.Data.TiledImage.TileWidth"> + <inheritdoc /> + </member> + <member name="P:DotSpatial.Data.TiledImage.TileHeight"> + <inheritdoc /> + </member> + <member name="P:DotSpatial.Data.TiledImage.Count"> + <inheritdoc /> + </member> + <member name="P:DotSpatial.Data.TiledImage.Extent"> + <inheritdoc /> + </member> + <member name="P:DotSpatial.Data.TiledImage.WorldFile"> + <summary> + Gets or sets the WorldFile for this set of tiles. + </summary> + </member> + <member name="T:DotSpatial.Data.WorldFile"> + <summary> + WorldFiles complement images, giving georeference information for those images. The basic idea is to calculate + everything based on the top left corner of the image. + </summary> + </member> + <member name="M:DotSpatial.Data.WorldFile.#ctor"> + <summary> + Creates a new instance of WorldFile + </summary> + </member> + <member name="M:DotSpatial.Data.WorldFile.#ctor(System.String)"> + <summary> + Automatically creates a new worldfile based on the specified image fileName. + </summary> + <param name="imageFilename">Attempts to open the fileName for the world file for the image if it exists.</param> + </member> + <member name="M:DotSpatial.Data.WorldFile.GetExtension(System.Drawing.Imaging.ImageFormat)"> + <summary> + Returns the string extensions that accompanies one of the dot net image formats. + </summary> + <param name="format">The Imaging.ImageFormat for the image itself</param> + <returns>The string extension</returns> + </member> + <member name="M:DotSpatial.Data.WorldFile.GenerateFilename(System.String)"> + <summary> + Given the fileName of an image, this creates a new fileName with the appropriate extension. + This will also set the fileName of this world file to that extension. + </summary> + <param name="imageFilename">The fileName of the image</param> + <returns>the fileName of the world file</returns> + </member> + <member name="M:DotSpatial.Data.WorldFile.Open"> + <summary> + Opens the worldfile specified by the Filename property and loads the values + </summary> + </member> + <member name="M:DotSpatial.Data.WorldFile.Open(System.String)"> + <summary> + Opens an existing worldfile based on the specified fileName + </summary> + <param name="fileName"></param> + </member> + <member name="M:DotSpatial.Data.WorldFile.Save"> + <summary> + Saves the current affine coordinates to the current fileName + </summary> + </member> + <member name="M:DotSpatial.Data.WorldFile.SaveAs(System.String)"> + <summary> + Saves the current coordinates to a file + </summary> + <param name="fileName">Gets or sets the fileName to use for an image</param> + </member> + <member name="M:DotSpatial.Data.WorldFile.ToMatrix"> + <summary> + Creates a Matrix that is in float coordinates that represents this world file + </summary> + <returns>A Matrix that transforms an image to the geographic coordinates</returns> + </member> + <member name="P:DotSpatial.Data.WorldFile.Affine"> + <summary> + gets the coordinates in the Affine order: + X' = [0] + [1] X + [2] Y + Y' = [3] + [4] X + [5] Y + </summary> + </member> + <member name="P:DotSpatial.Data.WorldFile.Filename"> + <summary> + Gets or sets the fileName to use for this world file. + </summary> + </member> + <member name="P:DotSpatial.Data.WorldFile.CellHeight"> + <summary> + Gets or sets the cellHeight + </summary> + </member> + <member name="P:DotSpatial.Data.WorldFile.CellWidth"> + <summary> + Gets or sets the cellWidth + </summary> + </member> + <member name="P:DotSpatial.Data.WorldFile.TopLeftX"> + <summary> + Gets or sets longitude or X position corresponding to the center of the cell in the top left corner of the image + </summary> + </member> + <member name="P:DotSpatial.Data.WorldFile.TopLeftY"> + <summary> + Gets or sets the latitude or Y position corresponding to the center of the cell in the top left corner of the image + </summary> + </member> + <member name="P:DotSpatial.Data.WorldFile.HorizontalSkew"> + <summary> + Gets or sets how much the longitude or X position of a cell in the image depends on the row position of the cell. + </summary> + </member> + <member name="P:DotSpatial.Data.WorldFile.VerticalSkew"> + <summary> + Gets or sets how much the latitude or Y position of a cell in the image depends on the column position of the cell. + </summary> + </member> + <member name="P:DotSpatial.Data.WorldFile.DialogFilter"> + <summary> + Gets a string list of file extensions that might apply to world files. + </summary> + </member> + <member name="T:DotSpatial.Data.HfaCoordinate"> + <summary> + Coordinate + </summary> + </member> + <member name="F:DotSpatial.Data.HfaCoordinate.X"> + <summary> + Coordinate x-value + </summary> + </member> + <member name="F:DotSpatial.Data.HfaCoordinate.Y"> + <summary> + coordinate y-value + </summary> + </member> + <member name="T:DotSpatial.Data.HfaDatum"> + <summary> + Datum + </summary> + </member> + <member name="M:DotSpatial.Data.HfaDatum.#ctor"> + <summary> + Creates a new instance of Datum + </summary> + </member> + <member name="P:DotSpatial.Data.HfaDatum.Name"> + <summary> + Gets or sets the name of the datum + </summary> + </member> + <member name="P:DotSpatial.Data.HfaDatum.Type"> + <summary> + Gets or sets the datum type + </summary> + </member> + <member name="P:DotSpatial.Data.HfaDatum.Params"> + <summary> + Gets or sets the parameters for the Parametric datum type + </summary> + </member> + <member name="P:DotSpatial.Data.HfaDatum.GridName"> + <summary> + Gets or sets the string name of the grid file + </summary> + </member> + <member name="T:DotSpatial.Data.HfaDatumType"> + <summary> + HfaDatumType + </summary> + </member> + <member name="F:DotSpatial.Data.HfaDatumType.Parametric"> + <summary> + The datum info is 7 doubles + </summary> + </member> + <member name="F:DotSpatial.Data.HfaDatumType.Grid"> + <summary> + The datum info is a name + </summary> + </member> + <member name="F:DotSpatial.Data.HfaDatumType.Regression"> + <summary> + + </summary> + </member> + <member name="F:DotSpatial.Data.HfaDatumType.None"> + <summary> + No Datum info + </summary> + </member> + <member name="T:DotSpatial.Data.HfaEPRJ"> + <summary> + ERDAS Projection Codes + </summary> + </member> + <member name="T:DotSpatial.Data.HfaEPT"> + <summary> + EPT ERDAS DATA TYPES + </summary> + </member> + <member name="F:DotSpatial.Data.HfaEPT.U1"> + <summary> + Unsigned 1 bit + </summary> + </member> + <member name="F:DotSpatial.Data.HfaEPT.U2"> + <summary> + Unsigned 2 bit + </summary> + </member> + <member name="F:DotSpatial.Data.HfaEPT.U4"> + <summary> + Unsigned 4 bit + </summary> + </member> + <member name="F:DotSpatial.Data.HfaEPT.U8"> + <summary> + Unsigned 8 bit + </summary> + </member> + <member name="F:DotSpatial.Data.HfaEPT.S8"> + <summary> + Signed 8 bit + </summary> + </member> + <member name="F:DotSpatial.Data.HfaEPT.U16"> + <summary> + Unsigned 16 bit + </summary> + </member> + <member name="F:DotSpatial.Data.HfaEPT.S16"> + <summary> + Signed 16 bit + </summary> + </member> + <member name="F:DotSpatial.Data.HfaEPT.U32"> + <summary> + Unsigned 32 bit + </summary> + </member> + <member name="F:DotSpatial.Data.HfaEPT.S32"> + <summary> + Signed 32 bit + </summary> + </member> + <member name="F:DotSpatial.Data.HfaEPT.Single"> + <summary> + Single precisions 32 bit floating point + </summary> + </member> + <member name="F:DotSpatial.Data.HfaEPT.Double"> + <summary> + Double precision 64 bit floating point + </summary> + </member> + <member name="F:DotSpatial.Data.HfaEPT.Char64"> + <summary> + 64 bit character? + </summary> + </member> + <member name="F:DotSpatial.Data.HfaEPT.Char128"> + <summary> + 128 bit character? + </summary> + </member> + <member name="T:DotSpatial.Data.HfaExt"> + <summary> + Extension Methods useful for the DotSpatial.Data.Img content + </summary> + </member> + <member name="M:DotSpatial.Data.HfaExt.ExtractTo(System.String,System.Int32@,System.String)"> + <summary> + A common task seems to be parsing the text up to a certain delimiter + starting from a certain index, and then advancing the string pointer. + This advances the index, extracting the string up to the point of the + specified delimeter, or the end of the string, and advancing the string + past the delimeter itself. If the index is equal to the length, + then you are at the end of the string. + </summary> + </member> + <member name="M:DotSpatial.Data.HfaExt.ExtractInteger(System.String)"> + <summary> + Given a string, this reads digits into a numeric value. + </summary> + <param name="input">The string to read the integer from</param> + <returns>An integer read from the string</returns> + </member> + <member name="M:DotSpatial.Data.HfaExt.ExtractTo(System.String,System.String,System.String@)"> + <summary> + This variant of the ExtractTo algorithm effectively splits the string into teh content + before the delimeter and after the delimeter, not counting the delimeter. + </summary> + <param name="input">The string input</param> + <param name="delimeter">The string delimeter</param> + <param name="remainder">the string remainder</param> + </member> + <member name="M:DotSpatial.Data.HfaExt.SkipTo(System.String,System.String)"> + <summary> + This method returns a substring based on the next occurance of the + specified delimeter. + </summary> + <param name="input">The string input</param> + <param name="delimeter">The delimeter</param> + </member> + <member name="T:DotSpatial.Data.Hfa"> + <summary> + Hfa + </summary> + </member> + <member name="M:DotSpatial.Data.Hfa.GetBitCount(DotSpatial.Data.HfaEPT)"> + <summary> + Gets the bitcount of a single member of the specified data type. + </summary> + <param name="dataType">The data type to get the byte count of</param> + <returns>An integer that represents the bit count of the specified type</returns> + </member> + <member name="M:DotSpatial.Data.Hfa.LittleEndian(System.Byte[])"> + <summary> + Reverses the byte order on Big-Endian systems like Unix to conform with the + HFA standard of little endian. + </summary> + <param name="value"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.Hfa.ReadType(System.Byte[],System.Int64)"> + <summary> + Return ReadType + </summary> + <param name="data"></param> + <param name="offset"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.Hfa.ReadInt16(System.Byte[],System.Int64)"> + <summary> + Given the byte array, this reads four bytes and converts this to a 32 bit integer. + This always uses little endian byte order. + </summary> + <param name="data"></param> + <param name="offset"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.Hfa.ReadUInt16(System.Byte[],System.Int64)"> + <summary> + Given the byte array, this reads four bytes and converts this to a 16 bit unsigned short integer. + This always uses little endian byte order. + </summary> + <param name="data"></param> + <param name="offset"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.Hfa.ReadInt32(System.Byte[],System.Int64)"> + <summary> + Given the byte array, this reads four bytes and converts this to a 32 bit integer. + This always uses little endian byte order. + </summary> + <param name="data"></param> + <param name="offset"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.Hfa.ReadSingle(System.Byte[],System.Int64)"> + <summary> + Given the byte array, this reads four bytes and converts this to a 32 bit floating point value + This always uses little endian byte order. + </summary> + <param name="data"></param> + <param name="offset"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.Hfa.ReadDouble(System.Byte[],System.Int64)"> + <summary> + Given the byte array, this reads four bytes and converts this to a 64 bit floating point value + This always uses little endian byte order. + </summary> + <param name="data"></param> + <param name="offset"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.Hfa.ReadUInt32(System.Byte[],System.Int64)"> + <summary> + Given the byte array, this reads four bytes and converts this to a 32 bit unsigned integer. + This always uses little endian byte order. + </summary> + <param name="data"></param> + <param name="offset"></param> + <returns>A UInt32 value stored in a long because UInt32 is not CLS Compliant</returns> + </member> + <member name="M:DotSpatial.Data.Hfa.LittleEndianAsUint32(System.Int64)"> + <summary> + Obtains the 4 byte equivalent for 32 bit Unsigned Integer values + </summary> + <param name="value">The unsigned integer value to convert into bytes</param> + <returns>The bytes in LittleEndian standard, regardless of the system architecture</returns> + </member> + <member name="M:DotSpatial.Data.Hfa.LittleEndian(System.Int32)"> + <summary> + Obtains the 4 byte equivalent for 32 bit Integer values + </summary> + <param name="value">The unsigned integer value to convert into bytes</param> + <returns>The bytes in LittleEndian standard, regardless of the system architecture</returns> + </member> + <member name="M:DotSpatial.Data.Hfa.LittleEndian(System.Single)"> + <summary> + Obtains the 4 byte equivalent for 32bit floating point values + </summary> + <param name="value">The unsigned integer value to convert into bytes</param> + <returns>The bytes in LittleEndian standard, regardless of the system architecture</returns> + </member> + <member name="M:DotSpatial.Data.Hfa.LittleEndian(System.Double)"> + <summary> + Obtains the 8 byte equivalent for 64 bit floating point values + </summary> + <param name="value">The unsigned integer value to convert into bytes</param> + <returns>The bytes in LittleEndian standard, regardless of the system architecture</returns> + </member> + <member name="M:DotSpatial.Data.Hfa.LittleEndianAsUShort(System.Int32)"> + <summary> + Gets the 2 byte equivalent of an unsigned short in little endian format + </summary> + <param name="value"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.Hfa.LittleEndian(System.Int16)"> + <summary> + Gets the 2 byte equivalent of a short in little endian format + </summary> + <param name="value"></param> + <returns></returns> + </member> + <member name="T:DotSpatial.Data.HfaAccess"> + <summary> + HfaAccess + </summary> + </member> + <member name="F:DotSpatial.Data.HfaAccess.ReadOnly"> + <summary> + Read Only with no update access + </summary> + </member> + <member name="F:DotSpatial.Data.HfaAccess.Update"> + <summary> + Read/Write access + </summary> + </member> + <member name="T:DotSpatial.Data.HfaCompress"> + <summary> + HfaCompress - Development on hold, commented out to reduce warnings + </summary> + </member> + <member name="T:DotSpatial.Data.HfaDictionary"> + <summary> + HfaDictionary + </summary> + </member> + <member name="M:DotSpatial.Data.HfaDictionary.#ctor(System.String)"> + <summary> + Creates a new instance of HfaDictionary + </summary> + </member> + <member name="M:DotSpatial.Data.HfaDictionary.AddType(DotSpatial.Data.HfaType)"> + <summary> + Adds the type using the TypeName as the key + </summary> + <param name="type">The type to add</param> + </member> + <member name="M:DotSpatial.Data.HfaDictionary.Dump(System.IO.Stream)"> + <summary> + Writes all the elements from this dictionary to the specified stream. + </summary> + <param name="fp"></param> + </member> + <member name="M:DotSpatial.Data.HfaDictionary.GetItemSize(System.Char)"> + <summary> + Given a character type, this calculates a size. This was originally + on the Dictionary, but I moved this to the HfaInfo instead. + </summary> + <param name="charType"></param> + <returns></returns> + </member> + <member name="T:DotSpatial.Data.HfaEntry"> + <summary> + HfaEntry + </summary> + </member> + <member name="M:DotSpatial.Data.HfaEntry.#ctor(DotSpatial.Data.HfaInfo,System.Int64,DotSpatial.Data.HfaEntry,DotSpatial.Data.HfaEntry)"> + <summary> + Creates a new instance of HfaEntry from the file + </summary> + </member> + <member name="M:DotSpatial.Data.HfaEntry.#ctor(DotSpatial.Data.HfaInfo,System.String,System.String,DotSpatial.Data.HfaEntry)"> + <summary> + Create a new instance of the entry with the intention that it would + be written to disk later + </summary> + <param name="hfaIn"></param> + <param name="name"></param> + <param name="typename"></param> + <param name="parent"></param> + </member> + <member name="M:DotSpatial.Data.HfaEntry.#ctor"> + <summary> + Creates a new instance of HfaEntry + </summary> + </member> + <member name="M:DotSpatial.Data.HfaEntry.LoadData"> + <summary> + Loads the data bytes for this element from the file + </summary> + </member> + <member name="M:DotSpatial.Data.HfaEntry.GetFirstChildName(System.String)"> + <summary> + Parses a name which may have an unwanted : or multiple sub-tree + names separated with periods. + </summary> + <param name="name"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.HfaEntry.GetSubtreeName(System.String)"> + <summary> + If this is null, then there is no further subtree + </summary> + <param name="name"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.HfaEntry.GetNamedChild(System.String)"> + <summary> + This parses a complete "path" separated by periods in order + to search for a specific child node. + </summary> + <param name="name"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.HfaEntry.GetFirstChild"> + <summary> + Gets or sets the HfaEntry that is the child + </summary> + </member> + <member name="P:DotSpatial.Data.HfaEntry.IsDirty"> + <summary> + Gets or sets a boolean indicating if this is changed + </summary> + </member> + <member name="P:DotSpatial.Data.HfaEntry.FilePos"> + <summary> + Gets or sets the long integer file position + </summary> + </member> + <member name="P:DotSpatial.Data.HfaEntry.Hfa"> + <summary> + Gets or sets the HFA Info + </summary> + </member> + <member name="P:DotSpatial.Data.HfaEntry.Parent"> + <summary> + Gets or sets the hfa parent + </summary> + </member> + <member name="P:DotSpatial.Data.HfaEntry.Prev"> + <summary> + Gets or sets the previous entry + </summary> + </member> + <member name="P:DotSpatial.Data.HfaEntry.NextPos"> + <summary> + Gets or sets the long integer position of the next entry in the file + </summary> + </member> + <member name="P:DotSpatial.Data.HfaEntry.Next"> + <summary> + Gets or sets the HfaEntry that is the next entry + </summary> + </member> + <member name="P:DotSpatial.Data.HfaEntry.ChildPos"> + <summary> + Gets or sets the long position of the child + </summary> + </member> + <member name="P:DotSpatial.Data.HfaEntry.Name"> + <summary> + Gets or sets the 64 character name of the entry + </summary> + </member> + <member name="P:DotSpatial.Data.HfaEntry.TypeName"> + <summary> + gets or sets the 32 character typestring + </summary> + </member> + <member name="P:DotSpatial.Data.HfaEntry.Type"> + <summary> + Gets or sets the type for this entry + </summary> + </member> + <member name="P:DotSpatial.Data.HfaEntry.DataPos"> + <summary> + The GUInt32 Data Position of this entry + </summary> + </member> + <member name="P:DotSpatial.Data.HfaEntry.DataSize"> + <summary> + The GUInt32 Data Size of this entry + </summary> + </member> + <member name="P:DotSpatial.Data.HfaEntry.Data"> + <summary> + Gets the data for this entry + </summary> + </member> + <member name="P:DotSpatial.Data.HfaEntry.Children"> + <summary> + Gets or sets the collection of all the children. + </summary> + </member> + <member name="P:DotSpatial.Data.HfaEntry.Child"> + <summary> + Gets or sets the first child belonging to this entry. + </summary> + </member> + <member name="T:DotSpatial.Data.HfaEnumerationNotFoundException"> + <summary> + HfaEnumerationNotFoundException + </summary> + </member> + <member name="M:DotSpatial.Data.HfaEnumerationNotFoundException.#ctor(System.String)"> + <summary> + Creates a new instance of HfaEnumerationNotFoundException + </summary> + </member> + <member name="T:DotSpatial.Data.HfaField"> + <summary> + HfaField + </summary> + </member> + <member name="M:DotSpatial.Data.HfaField.CompleteDefn(DotSpatial.Data.HfaDictionary)"> + <summary> + + </summary> + <param name="dict"></param> + </member> + <member name="M:DotSpatial.Data.HfaField.Dump(System.IO.Stream)"> + <summary> + This writes formatted content for this field to the specified IO stream. + </summary> + <param name="stream">The stream to write to.</param> + </member> + <member name="M:DotSpatial.Data.HfaField.DumpInstValue(System.IO.Stream,System.Byte[],System.Int64,System.Int32,System.String)"> + <summary> + + </summary> + <param name="fpOut"></param> + <param name="data"></param> + <param name="dataOffset"></param> + <param name="dataSize"></param> + <param name="prefix"></param> + </member> + <member name="M:DotSpatial.Data.HfaField.SetInstValue(System.String,System.Int32,System.Byte[],System.Int64,System.Int32,System.Char,System.Object)"> + <summary> + SetInstValue + </summary> + <param name="sField"></param> + <param name="indexValue"></param> + <param name="data"></param> + <param name="dataOffset"></param> + <param name="dataSize"></param> + <param name="reqType"></param> + <param name="value"></param> + <exception cref="T:DotSpatial.Data.HfaPointerInsertNotSupportedException">Attempting to insert a pointer is not supported.</exception> + <exception cref="T:DotSpatial.Data.HfaEnumerationNotFoundException">Occurs if the specified value is not a valid member of the enumeration for this field.</exception> + </member> + <member name="M:DotSpatial.Data.HfaField.GetInstBytes(System.Byte[],System.Int64)"> + <summary> + Scans through the array and estimates the byte size of the field in this case. + </summary> + <param name="data"></param> + <param name="dataOffset"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.HfaField.GetInstCount(System.Byte[],System.Int64)"> + <summary> + Gets the count for a particular instance of a field. This will normally be + the built in value, but for variable fields, this is extracted from the + data itself. + </summary> + <param name="data"></param> + <param name="dataOffset"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.HfaField.ExtractInstValue(System.String,System.Int32,System.Byte[],System.Int64,System.Int32,System.Char,System.Object@,System.Int32@)"> + <summary> + + </summary> + <param name="pszField"></param> + <param name="nIndexValue"></param> + <param name="data"></param> + <param name="dataOffset"></param> + <param name="nDataSize"></param> + <param name="reqType"></param> + <param name="pReqReturn"></param> + <param name="extraOffset">This is used in the case of 'object' pointers where the indexed object is further in the data block.</param> + <returns></returns> + <exception cref="T:DotSpatial.Data.HfaInvalidCountException">Occurs if the count is less than zero for the header of a block of base data</exception> + </member> + <member name="M:DotSpatial.Data.HfaField.Initialize(System.String)"> + <summary> + Parses the input string into a valid HfaField, or returns null + if one could not be created. + </summary> + <param name="input"></param> + <returns></returns> + </member> + <member name="P:DotSpatial.Data.HfaField.NumBytes"> + <summary> + Gets or sets the short integer number of bytes + </summary> + </member> + <member name="P:DotSpatial.Data.HfaField.ItemCount"> + <summary> + Gets or sets the short integer item count + </summary> + </member> + <member name="P:DotSpatial.Data.HfaField.Pointer"> + <summary> + Gets or sets '\0', '*' or 'p' + </summary> + </member> + <member name="P:DotSpatial.Data.HfaField.ItemType"> + <summary> + Gets or sets 1|2|4|e|... + </summary> + </member> + <member name="P:DotSpatial.Data.HfaField.ItemObjectTypeString"> + <summary> + If ItemType == 'o' + </summary> + </member> + <member name="P:DotSpatial.Data.HfaField.ItemObjectType"> + <summary> + Gets or sets the item object type + </summary> + </member> + <member name="P:DotSpatial.Data.HfaField.EnumNames"> + <summary> + Normally null unless this is an enum + </summary> + </member> + <member name="P:DotSpatial.Data.HfaField.FieldName"> + <summary> + Gets or sets the field name + </summary> + </member> + <member name="T:DotSpatial.Data.HfaInfo"> + <summary> + HfaInfo + </summary> + </member> + <member name="M:DotSpatial.Data.HfaInfo.#ctor"> + <summary> + Creates a new instance of HfaInfo + </summary> + </member> + <member name="P:DotSpatial.Data.HfaInfo.Access"> + <summary> + Gets or sets the access type + </summary> + </member> + <member name="P:DotSpatial.Data.HfaInfo.Dictionary"> + <summary> + Gets or sets a dictionary for looking up types based on string type names. + </summary> + </member> + <member name="P:DotSpatial.Data.HfaInfo.Path"> + <summary> + The directory path + </summary> + </member> + <member name="P:DotSpatial.Data.HfaInfo.Filename"> + <summary> + The string fileName sans path + </summary> + </member> + <member name="P:DotSpatial.Data.HfaInfo.IgeFilename"> + <summary> + sans path + </summary> + </member> + <member name="P:DotSpatial.Data.HfaInfo.EndOfFile"> + <summary> + End of file + </summary> + </member> + <member name="P:DotSpatial.Data.HfaInfo.RootPos"> + <summary> + Root position + </summary> + </member> + <member name="P:DotSpatial.Data.HfaInfo.DictionaryPos"> + <summary> + + </summary> + </member> + <member name="P:DotSpatial.Data.HfaInfo.EntryHeaderLength"> + <summary> + The entry header length + </summary> + </member> + <member name="P:DotSpatial.Data.HfaInfo.Version"> + <summary> + The integer version + </summary> + </member> + <member name="P:DotSpatial.Data.HfaInfo.TreeDirty"> + <summary> + Boolean, true if the tree has changed + </summary> + </member> + <member name="P:DotSpatial.Data.HfaInfo.Fp"> + <summary> + The file stream + </summary> + </member> + <member name="T:DotSpatial.Data.HfaInvalidCountException"> + <summary> + HfaInvalidCountException + </summary> + </member> + <member name="M:DotSpatial.Data.HfaInvalidCountException.#ctor(System.Int32,System.Int32)"> + <summary> + Creates a new instance of HfaInvalidCountException + </summary> + </member> + <member name="T:DotSpatial.Data.HfaNotCompressedException"> + <summary> + HfaNotCompressedException + </summary> + </member> + <member name="M:DotSpatial.Data.HfaNotCompressedException.#ctor"> + <summary> + Creates a new instance of HfaNotCompressedException + </summary> + </member> + <member name="T:DotSpatial.Data.HfaPointerInsertNotSupportedException"> + <summary> + HfaPointerInsertNotSupportedException + </summary> + </member> + <member name="M:DotSpatial.Data.HfaPointerInsertNotSupportedException.#ctor"> + <summary> + Creates a new instance of HfaPointerInsertNotSupportedException + </summary> + </member> + <member name="T:DotSpatial.Data.HfaType"> + <summary> + HfaType + </summary> + </member> + <member name="M:DotSpatial.Data.HfaType.CompleteDefn(DotSpatial.Data.HfaDictionary)"> + <summary> + Completes the defenition of this type based on the existing dictionary + </summary> + <param name="dictionary"></param> + </member> + <member name="M:DotSpatial.Data.HfaType.Dump(System.IO.Stream)"> + <summary> + This function writes content to the file for this entire type by writing + the type name and number of bytes, followed by cycling through and writing each + of the fields. + </summary> + <param name="stream"></param> + </member> + <member name="M:DotSpatial.Data.HfaType.DumpInstValue(System.IO.Stream,System.Byte[],System.Int64,System.Int32,System.String)"> + <summary> + Triggers a dump on all the fields of this type. + </summary> + <param name="fpOut"></param> + <param name="data"></param> + <param name="dataOffset"></param> + <param name="dataSize"></param> + <param name="pszPrefix"></param> + </member> + <member name="M:DotSpatial.Data.HfaType.ExtractInstValue(System.String,System.Byte[],System.Int64,System.Int32,System.Char,System.Object@)"> + <summary> + Extracts the value form the byte array + </summary> + <param name="fieldPath"></param> + <param name="data"></param> + <param name="dataOffset"></param> + <param name="dataSize"></param> + <param name="reqType"></param> + <param name="reqReturn"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.HfaType.GetInstBytes(System.Byte[],System.Int64)"> + <summary> + Gets the number of bytes for this type by adding up the byte contribution from each of its fields. + </summary> + <param name="data">The array of bytes to scan.</param> + <param name="dataOffset">The integer index in the array where scanning should begin.</param> + <returns>The integer count.</returns> + </member> + <member name="M:DotSpatial.Data.HfaType.GetInstCount(System.String,System.Byte[],System.Int64,System.Int32)"> + <summary> + Attempts to find the specified field in the field path and extracts the size of the specified field in bytes + </summary> + <param name="fieldPath"></param> + <param name="data"></param> + <param name="dataOffset"></param> + <param name="dataSize"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.HfaType.Intialize(System.String)"> + <summary> + Originally Initialize + </summary> + <param name="input">The input string that contains content for this type</param> + <returns>The remaining string content, unless this fails in which case this may return null</returns> + </member> + <member name="M:DotSpatial.Data.HfaType.SetInstValue(System.String,System.Byte[],System.Int64,System.Int32,System.Char,System.Object)"> + <summary> + + </summary> + <param name="fieldPath"></param> + <param name="data"></param> + <param name="dataOffset"></param> + <param name="dataSize"></param> + <param name="reqType"></param> + <param name="value"></param> + </member> + <member name="P:DotSpatial.Data.HfaType.NumBytes"> + <summary> + The short integer number of bytes + </summary> + </member> + <member name="P:DotSpatial.Data.HfaType.FieldCount"> + <summary> + The short integer number of fields + </summary> + </member> + <member name="P:DotSpatial.Data.HfaType.TypeName"> + <summary> + The type name + </summary> + </member> + <member name="P:DotSpatial.Data.HfaType.Fields"> + <summary> + Gets or sets the list of fields + </summary> + </member> + <member name="T:DotSpatial.Data.HfaFieldTypeException"> + <summary> + HfaTypeException + </summary> + </member> + <member name="M:DotSpatial.Data.HfaFieldTypeException.#ctor(System.Char)"> + <summary> + Creates a new instance of HfaTypeException + </summary> + </member> + <member name="T:DotSpatial.Data.HfaMapInfo"> + <summary> + MapInfo + </summary> + </member> + <member name="P:DotSpatial.Data.HfaMapInfo.LowerRightCenter"> + <summary> + Gets or sets the map coordinats of the center of the lower right pixel + </summary> + </member> + <member name="P:DotSpatial.Data.HfaMapInfo.PixelSize"> + <summary> + Gets or sets the size of a single pixel in map units + </summary> + </member> + <member name="P:DotSpatial.Data.HfaMapInfo.ProName"> + <summary> + Gets or sets the string Projection Name + </summary> + </member> + <member name="P:DotSpatial.Data.HfaMapInfo.Units"> + <summary> + Gets or sets the map units + </summary> + </member> + <member name="P:DotSpatial.Data.HfaMapInfo.UpperLeftCenter"> + <summary> + Gets or sets the map coordinates of center of upper left pixel + </summary> + </member> + <member name="T:DotSpatial.Data.HfaNAD"> + <summary> + NAD + </summary> + </member> + <member name="F:DotSpatial.Data.HfaNAD.NAD27"> + <summary> + Use the North American Datum 1927 + </summary> + </member> + <member name="F:DotSpatial.Data.HfaNAD.NAD83"> + <summary> + Use the North American Datum 1983 + </summary> + </member> + <member name="F:DotSpatial.Data.HfaNAD.HARN"> + <summary> + Use the North America Datum High Accuracy Reference Network + </summary> + </member> + <member name="T:DotSpatial.Data.HfaProParameters"> + <summary> + ProParameters + </summary> + </member> + <member name="M:DotSpatial.Data.HfaProParameters.#ctor"> + <summary> + Creates a new instance of the ProParameters class + </summary> + </member> + <member name="P:DotSpatial.Data.HfaProParameters.ProExeName"> + <summary> + Gets or sets the string exectable name for external projectiosn + </summary> + </member> + <member name="P:DotSpatial.Data.HfaProParameters.ProName"> + <summary> + Gets or sets the string projection name + </summary> + </member> + <member name="P:DotSpatial.Data.HfaProParameters.ProNumber"> + <summary> + Gets or sets the projection number for internal projections + </summary> + </member> + <member name="P:DotSpatial.Data.HfaProParameters.ProParams"> + <summary> + Projection parameters array in the GCTP form + </summary> + </member> + <member name="P:DotSpatial.Data.HfaProParameters.ProType"> + <summary> + Gets or sets the projection type + </summary> + </member> + <member name="P:DotSpatial.Data.HfaProParameters.ProZone"> + <summary> + Gets or sets the projection zone (UTM, SP only) + </summary> + </member> + <member name="P:DotSpatial.Data.HfaProParameters.ProSpheroid"> + <summary> + The projection spheroid + </summary> + </member> + <member name="T:DotSpatial.Data.HfaProType"> + <summary> + ProType + </summary> + </member> + <member name="F:DotSpatial.Data.HfaProType.Internal"> + <summary> + Indicates that hte projection is built into the eprj package as function calls + </summary> + </member> + <member name="F:DotSpatial.Data.HfaProType.External"> + <summary> + Indicates that hte projection is accessible as an exteranl executable + </summary> + </member> + <member name="T:DotSpatial.Data.HfaSize"> + <summary> + Size + </summary> + </member> + <member name="F:DotSpatial.Data.HfaSize.Height"> + <summary> + pixelsize height + </summary> + </member> + <member name="F:DotSpatial.Data.HfaSize.Width"> + <summary> + pixelsize width + </summary> + </member> + <member name="T:DotSpatial.Data.HfaSpheroid"> + <summary> + Spheroid + </summary> + </member> + <member name="P:DotSpatial.Data.HfaSpheroid.A"> + <summary> + Gets or sets the semi-major axis of the ellipsoid + </summary> + </member> + <member name="P:DotSpatial.Data.HfaSpheroid.B"> + <summary> + Gets or sets the semi-minor axis of the ellipsoid + </summary> + </member> + <member name="P:DotSpatial.Data.HfaSpheroid.ESquared"> + <summary> + Gets or sets the eccentricity squared + </summary> + </member> + <member name="P:DotSpatial.Data.HfaSpheroid.Radius"> + <summary> + Gets or sets the radius of the sphere + </summary> + </member> + <member name="P:DotSpatial.Data.HfaSpheroid.SphereName"> + <summary> + Gets or sets the string name o the ellipsoid + </summary> + </member> + <member name="T:DotSpatial.Data.IDataLayer"> + <summary> + IDataLayer + </summary> + </member> + <member name="M:DotSpatial.Data.IDataLayer.CommitTransaction"> + <summary> + This should finalize the transaction, saving changes to the database or disk + </summary> + </member> + <member name="M:DotSpatial.Data.IDataLayer.CreateFeature(DotSpatial.Data.IFeature)"> + <summary> + Creates a feature + </summary> + <param name="feature"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.IDataLayer.CreateShape(DotSpatial.Data.Shape,System.Data.DataRow)"> + <summary> + Creates a feature from a shape and some data row values. + </summary> + <param name="shape"></param> + <param name="attributes"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.IDataLayer.CreateField(DotSpatial.Data.Field)"> + <summary> + Creates a new field for this data layer in the data source + </summary> + <param name="fld"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.IDataLayer.DeleteFeature(System.Int32)"> + <summary> + Deletes the feature at the specified index location + </summary> + <param name="fid">The fid</param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.IDataLayer.Dispose"> + <summary> + Disposes any unmanaged memory objects + </summary> + </member> + <member name="M:DotSpatial.Data.IDataLayer.GetFeature(System.Int32)"> + <summary> + Gets the feature at the specified index + </summary> + <param name="fid"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.IDataLayer.GetShape(System.Int32)"> + <summary> + Gets the shape + </summary> + <param name="fid"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.IDataLayer.GetFeatureCount"> + <summary> + Gets the features + </summary> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.IDataLayer.GetFidColumn"> + <summary> + Gets the name of the feature ID column + </summary> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.IDataLayer.GetGeometryColumn"> + <summary> + Gets the string name of the geometry column + </summary> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.IDataLayer.GetFields"> + <summary> + Returns the field definitions as an array of fields. + </summary> + <returns>An array of field objects that encompass the schema</returns> + </member> + <member name="M:DotSpatial.Data.IDataLayer.RollbackTransaction"> + <summary> + Rolls back the transactions + </summary> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.IDataLayer.GetSpatialRef"> + <summary> + Gets the projection information associated with this projection + </summary> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.IDataLayer.SetFeature(System.Int32,DotSpatial.Data.IFeature)"> + <summary> + sets the specified feature + </summary> + <param name="fid"></param> + <param name="feature"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.IDataLayer.SetShape(System.Int32,DotSpatial.Data.Shape,System.Data.DataRow)"> + <summary> + Sets the shape + </summary> + <param name="fid"></param> + <param name="shape"></param> + <param name="values"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.IDataLayer.SetSpatialFilterRect(System.Double,System.Double,System.Double,System.Double)"> + <summary> + Sets the spatial filter by using the specified rectangular extents instead of a geometry. + </summary> + <param name="xMin">The minimum value in the X direction.</param> + <param name="yMin">The minimum value in the Y direction.</param> + <param name="xMax">The maximum value in the X direction.</param> + <param name="yMax">The maximum value in the Y direction.</param> + <returns>Boolean, true if hte spatial filter rectangle is set.</returns> + </member> + <member name="M:DotSpatial.Data.IDataLayer.StartTransaction"> + <summary> + Starts the transaction + </summary> + </member> + <member name="M:DotSpatial.Data.IDataLayer.SyncToDisk"> + <summary> + Syncrhonize to disk + </summary> + </member> + <member name="M:DotSpatial.Data.IDataLayer.TestCapability"> + <summary> + Test Capability + </summary> + </member> + <member name="P:DotSpatial.Data.IDataLayer.Extent"> + <summary> + Gets the extent of the data layer + </summary> + </member> + <member name="P:DotSpatial.Data.IDataLayer.Name"> + <summary> + Gets the name of this layer + </summary> + </member> + <member name="P:DotSpatial.Data.IDataLayer.SpatialFilter"> + <summary> + Gets or sets the spatial filter so that only members that intersect with the specified + geometry will be returned. + </summary> + </member> + <member name="T:DotSpatial.Data.PluginInfo"> + <summary> + PluginInfo + </summary> + </member> + <member name="M:DotSpatial.Data.PluginInfo.#ctor"> + <summary> + Creates a new instance of PluginInfo + </summary> + </member> + <member name="M:DotSpatial.Data.PluginInfo.#ctor(System.String,System.String)"> + <summary> + Creates a new instance of a PluginInfo class with the specified parameters + </summary> + <param name="inSettings"></param> + <param name="inKey"></param> + </member> + <member name="P:DotSpatial.Data.PluginInfo.Settings"> + <summary> + Settings + </summary> + </member> + <member name="P:DotSpatial.Data.PluginInfo.Key"> + <summary> + Key + </summary> + </member> + <member name="T:DotSpatial.Data.AffineTransform"> + <summary> + AffineTransform + </summary> + </member> + <member name="M:DotSpatial.Data.AffineTransform.#ctor(System.Double[])"> + <summary> + Creates a new instance of AffineTransform + </summary> + </member> + <member name="M:DotSpatial.Data.AffineTransform.CellCenter_ToProj(System.Int32,System.Int32)"> + <summary> + Given any input row or column, this returns the appropriate geographic location for the + position of the center of the cell. + </summary> + <param name="row">The integer row index from 0 to numRows - 1</param> + <param name="column">The integer column index from 0 to numColumns - 1</param> + <returns>The geographic position of the center of the specified cell</returns> + </member> + <member name="M:DotSpatial.Data.AffineTransform.CellTopLeft_ToProj(System.Int32,System.Int32)"> + <summary> + Given the row and column, this returns the geographic position of the top left corner of the cell + </summary> + <param name="row">The integer row index from 0 to numRows - 1</param> + <param name="column">The integer column index from 0 to numColumns - 1</param> + <returns>The geographic position of the top left corner of the specified cell</returns> + </member> + <member name="M:DotSpatial.Data.AffineTransform.CellTopRight_ToProj(System.Int32,System.Int32)"> + <summary> + Given the row and column, this returns the geographic position of the top right corner of the cell + </summary> + <param name="row">The integer row index from 0 to numRows - 1</param> + <param name="column">The integer column index from 0 to numColumns - 1</param> + <returns>The geographic position of the top right corner of the specified cell</returns> + </member> + <member name="M:DotSpatial.Data.AffineTransform.CellBottomLeft_ToProj(System.Int32,System.Int32)"> + <summary> + Given the row and column, this returns the geographic position of the bottom left corner of the cell + </summary> + <param name="row">The integer row index from 0 to numRows - 1</param> + <param name="column">The integer column index from 0 to numColumns - 1</param> + <returns>The geographic position of the bottom left corner of the specified cell</returns> + </member> + <member name="M:DotSpatial.Data.AffineTransform.CellBottomRight_ToProj(System.Int32,System.Int32)"> + <summary> + Given the row and column, this returns the geographic position of the bottom right corner of the cell + </summary> + <param name="row">The integer row index from 0 to numRows - 1</param> + <param name="column">The integer column index from 0 to numColumns - 1</param> + <returns>The geographic position of the bottom right corner of the specified cell</returns> + </member> + <member name="M:DotSpatial.Data.AffineTransform.TransfromToCorner(System.Int32,System.Int32)"> + <summary> + Given the row and column, this returns new affine coefficients transformed to that cell + </summary> + <param name="startRow">The integer row index from 0 to numRows - 1</param> + <param name="startColumn">The integer column index from 0 to numColumns - 1</param> + <returns>Transoformed affine coefficients</returns> + </member> + <member name="M:DotSpatial.Data.AffineTransform.ProjToCell(DotSpatial.Topology.Coordinate)"> + <summary> + Returns the row and column index. + </summary> + <param name="location">Gets or sets the ICoordinate</param> + <returns>An RcIndex that shows the best row or column index for the specified coordinate.</returns> + </member> + <member name="P:DotSpatial.Data.AffineTransform.Coefficients"> + <summary> + Gets or sets the array of coefficients for this transform + </summary> + </member> + <member name="T:DotSpatial.Data.BinaryRasterProvider"> + <summary> + BinaryDataProvider + </summary> + </member> + <member name="T:DotSpatial.Data.IRasterProvider"> + <summary> + A DataProvider that is specific to raster formats. + </summary> + </member> + <member name="M:DotSpatial.Data.IRasterProvider.Create(System.String,System.String,System.Int32,System.Int32,System.Int32,System.Type,System.String[])"> + <summary> + This create new method implies that this provider has the priority for creating a new file. + An instance of the dataset should be created and then returned. By this time, the fileName + will already be checked to see if it exists, and deleted if the user wants to overwrite it. + </summary> + <param name="name">The string fileName for the new instance.</param> + <param name="driverCode">The string short name of the driver for creating the raster.</param> + <param name="xSize">The number of columns in the raster.</param> + <param name="ySize">The number of rows in the raster.</param> + <param name="numBands">The number of bands to create in the raster.</param> + <param name="dataType">The data type to use for the raster.</param> + <param name="options">The options to be used.</param> + <returns>An IRaster</returns> + </member> + <member name="M:DotSpatial.Data.IRasterProvider.Open(System.String)"> + <summary> + This open method is only called if this plugin has been given priority for one + of the file extensions supported in the DialogReadFilter property supplied by + this control. Failing to provide a DialogReadFilter will result in this plugin + being added to the list of DataProviders being supplied under the Add Other Data + option in the file menu. + </summary> + <param name="fileName">A string specifying the complete path and extension of the file to open.</param> + <returns>An IDataSet to be added to the Map. These can also be groups of datasets.</returns> + </member> + <member name="M:DotSpatial.Data.BinaryRasterProvider.Open(System.String)"> + <summary> + This open method is only called if this plugin has been given priority for one + of the file extensions supported in the DialogReadFilter property supplied by + this control. Failing to provide a DialogReadFilter will result in this plugin + being added to the list of DataProviders being supplied under the Add Other Data + option in the file menu. + </summary> + <param name="fileName">A string specifying the complete path and extension of the file to open.</param> + <returns>An IDataSet to be added to the Map. These can also be groups of datasets.</returns> + </member> + <member name="M:DotSpatial.Data.BinaryRasterProvider.Create(System.String,System.String,System.Int32,System.Int32,System.Int32,System.Type,System.String[])"> + <summary> + This create new method implies that this provider has the priority for creating a new file. + An instance of the dataset should be created and then returned. By this time, the fileName + will already be checked to see if it exists, and deleted if the user wants to overwrite it. + </summary> + <param name="name">The string fileName for the new instance</param> + <param name="driverCode">The string short name of the driver for creating the raster</param> + <param name="xSize">The number of columns in the raster</param> + <param name="ySize">The number of rows in the raster</param> + <param name="numBands">The number of bands to create in the raster</param> + <param name="dataType">The data type to use for the raster</param> + <param name="options">The options to be used.</param> + <returns>An IRaster</returns> + </member> + <member name="M:DotSpatial.Data.BinaryRasterProvider.Open"> + <summary> + A Non-File based open. If no DialogReadFilter is provided, DotSpatial will call + this method when this plugin is selected from the Add Other Data option in the + file menu. + </summary> + </member> + <member name="M:DotSpatial.Data.BinaryRasterProvider.GetDataType(System.String)"> + <summary> + Reads a binary header to determine the appropriate data type + </summary> + </member> + <member name="P:DotSpatial.Data.BinaryRasterProvider.DialogReadFilter"> + <summary> + Gets a dialog read filter that lists each of the file type descriptions and file extensions, delimeted + by the | symbol. Each will appear in DotSpatial's open file dialog filter, preceeded by the name provided + on this object. + </summary> + </member> + <member name="P:DotSpatial.Data.BinaryRasterProvider.DialogWriteFilter"> + <summary> + Gets a dialog filter that lists each of the file type descriptions and extensions for a Save File Dialog. + Each will appear in DotSpatial's open file dialog filter, preceeded by the name provided on this object. + </summary> + </member> + <member name="P:DotSpatial.Data.BinaryRasterProvider.Name"> + <summary> + Gets a prefereably short name that identifies this data provider. Example might be GDAL. + This will be prepended to each of the DialogReadFilter members from this plugin. + </summary> + </member> + <member name="P:DotSpatial.Data.BinaryRasterProvider.Description"> + <summary> + This is a basic description that will fall next to your plugin in the Add Other Data dialog. + This will only be shown if your plugin does not supply a DialogReadFilter. + </summary> + </member> + <member name="P:DotSpatial.Data.BinaryRasterProvider.ProgressHandler"> + <summary> + Gets or sets the control or method that should report on progress + </summary> + </member> + <member name="T:DotSpatial.Data.RasterBoundsExt"> + <summary> + RasterBoundsEM + </summary> + </member> + <member name="M:DotSpatial.Data.RasterBoundsExt.Area(DotSpatial.Data.IRasterBounds)"> + <summary> + Calculates the area of this envelope. Because the word Area, + like Volume, is dimension specific, this method only looks + at the X and Y ordinates, and requires at least 2 ordinates. + </summary> + <param name="self">The IEnvelope to use with this method</param> + <returns>The 2D area as a double value.</returns> + </member> + <member name="M:DotSpatial.Data.RasterBoundsExt.Bottom(DotSpatial.Data.IRasterBounds)"> + <summary> + Gets the minY, which is Y - Height. + </summary> + <param name="self">The <c>IRasterBounds</c> that this calculation is for.</param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.RasterBoundsExt.ExpandBy(DotSpatial.Data.IRasterBounds,System.Double)"> + <summary> + Uses the specified distance to expand the envelope by that amount in all dimensions. + </summary> + <param name="self">The <c>IRasterBounds</c> that this calculation is for.</param> + <param name="distance">The double distance to expand in all directions.</param> + </member> + <member name="M:DotSpatial.Data.RasterBoundsExt.Left(DotSpatial.Data.IRasterBounds)"> + <summary> + Gets the left value for this rectangle. This should be the + X coordinate, but is added for clarity. + </summary> + <param name="self">The <c>IRasterBounds</c> that this calculation is for.</param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.RasterBoundsExt.Right(DotSpatial.Data.IRasterBounds)"> + <summary> + Gets the right value, which is X + Width. + </summary> + <param name="self">The <c>IRasterBounds</c> that this calculation is for.</param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.RasterBoundsExt.Top(DotSpatial.Data.IRasterBounds)"> + <summary> + Gets the maxY value, which should be Y. + </summary> + <param name="self">The <c>IRasterBounds</c> that this calculation is for.</param> + <returns>The double value representing the Max Y value of this rectangle</returns> + </member> + <member name="M:DotSpatial.Data.RasterBoundsExt.OpenWorldFile(DotSpatial.Data.IRasterBounds,System.String)"> + <summary> + Use the Open method instead of this extension. This only provides + a default behavior that can optionally be used by implementers + of the IRasterBounds interface. + </summary> + <param name="bounds">The bounds to open</param> + <param name="fileName">The *.wld or *.**w world file to open</param> + </member> + <member name="M:DotSpatial.Data.RasterBoundsExt.SaveWorldFile(DotSpatial.Data.IRasterBounds)"> + <summary> + Use the Save method instead of this extension. This only provides + a default behavior that can optionally be used by implementers + of the IRasterBounds interface. + </summary> + </member> + <member name="M:DotSpatial.Data.RasterBoundsExt.ResampleTransform(DotSpatial.Data.IRasterBounds,System.Int32,System.Int32)"> + <summary> + Generates a new version of the affine transform that will + cover the same region, but using the specified number of + rows and columns instead. + </summary> + <param name="bounds">The raster bounds to resample</param> + <param name="numRows">The new number of rows </param> + <param name="numColumns">The new number of columns</param> + <returns> + X = [0] + [1] * Column + [2] * Row + Y = [3] + [4] * Column + [5] * Row + </returns> + </member> + <member name="M:DotSpatial.Data.RasterBoundsExt.SaveAs(DotSpatial.Data.IRasterBounds,System.String)"> + <summary> + Attempts to save the affine coefficients to the specified worldfile file name + </summary> + <param name="bounds">The bounds to save</param> + <param name="fileName">The fileName to save this bounds to</param> + </member> + <member name="M:DotSpatial.Data.RasterBoundsExt.Get_AffineMatrix(DotSpatial.Data.IRasterBounds)"> + <summary> + Converts creates a float precisions drawing matrix from the double precision affine + coordinates. The Matrix can be manipulated and then set back. Some precision will + be lost, however, as only floats are supported. + </summary> + </member> + <member name="M:DotSpatial.Data.RasterBoundsExt.Set_AffineMatrix(DotSpatial.Data.IRasterBounds,System.Drawing.Drawing2D.Matrix)"> + <summary> + Re-defines the double precision affine transform values based on the specified + system.Drawing.Matrix. + </summary> + <param name="bounds">The bounds to adjust based on the matrix</param> + <param name="matrix">The matrix to use as a guide for adjustments.</param> + </member> + <member name="M:DotSpatial.Data.RasterBoundsExt.BottomLeft(DotSpatial.Data.IRasterBounds)"> + <summary> + Images can be skewed, so this gets the point that actually defines the bottom left + corner of the data in geographic coordinates + </summary> + </member> + <member name="M:DotSpatial.Data.RasterBoundsExt.BottomRight(DotSpatial.Data.IRasterBounds)"> + <summary> + Images can be skewed, so this gets the point that actually defines the bottom right + corner of the data in geographic coordinates + </summary> + </member> + <member name="M:DotSpatial.Data.RasterBoundsExt.TopLeft(DotSpatial.Data.IRasterBounds)"> + <summary> + Images can be skewed, so this gets the point that actually defines the top left + corner of the data in geographic coordinates + </summary> + <param name="bounds">The IRasterBounds to obtain the top left of</param> + </member> + <member name="M:DotSpatial.Data.RasterBoundsExt.TopRight(DotSpatial.Data.IRasterBounds)"> + <summary> + Images can be skewed, so this gets the point that actually defines the top right + corner of the data in geographic coordinates + </summary> + </member> + <member name="M:DotSpatial.Data.RasterBoundsExt.CellCenter_ToProj(DotSpatial.Data.IRasterBounds,System.Int32,System.Int32)"> + <summary> + Given any input row or column, this returns the appropriate geographic location for the + position of the center of the cell. + </summary> + <param name="bounds">The raster bounds to perform the calculation on</param> + <param name="row">The integer row index from 0 to numRows - 1</param> + <param name="column">The integer column index from 0 to numColumns - 1</param> + <returns>The geographic position of the center of the specified cell</returns> + </member> + <member name="M:DotSpatial.Data.RasterBoundsExt.CellTopLeft_ToProj(DotSpatial.Data.IRasterBounds,System.Int32,System.Int32)"> + <summary> + Given the row and column, this returns the geographic position of the top left corner of the cell + </summary> + <param name="bounds">The raster bounds to perform the calculation on</param> + <param name="row">The integer row index from 0 to numRows - 1</param> + <param name="column">The integer column index from 0 to numColumns - 1</param> + <returns>The geographic position of the top left corner of the specified cell</returns> + </member> + <member name="M:DotSpatial.Data.RasterBoundsExt.CellTopRight_ToProj(DotSpatial.Data.IRasterBounds,System.Int32,System.Int32)"> + <summary> + Given the row and column, this returns the geographic position of the top right corner of the cell + </summary> + <param name="bounds">The raster bounds to perform the calculation on</param> + <param name="row">The integer row index from 0 to numRows - 1</param> + <param name="column">The integer column index from 0 to numColumns - 1</param> + <returns>The geographic position of the top right corner of the specified cell</returns> + </member> + <member name="M:DotSpatial.Data.RasterBoundsExt.CellBottomLeft_ToProj(DotSpatial.Data.IRasterBounds,System.Int32,System.Int32)"> + <summary> + Given the row and column, this returns the geographic position of the bottom left corner of the cell + </summary> + <param name="bounds">The raster bounds to perform the calculation on</param> + <param name="row">The integer row index from 0 to numRows - 1</param> + <param name="column">The integer column index from 0 to numColumns - 1</param> + <returns>The geographic position of the bottom left corner of the specified cell</returns> + </member> + <member name="M:DotSpatial.Data.RasterBoundsExt.CellBottomRight_ToProj(DotSpatial.Data.IRasterBounds,System.Int32,System.Int32)"> + <summary> + Given the row and column, this returns the geographic position of the bottom right corner of the cell + </summary> + <param name="bounds">The raster bounds to perform the calculation on</param> + <param name="row">The integer row index from 0 to numRows - 1</param> + <param name="column">The integer column index from 0 to numColumns - 1</param> + <returns>The geographic position of the bottom right corner of the specified cell</returns> + </member> + <member name="M:DotSpatial.Data.RasterBoundsExt.ProjToCell(DotSpatial.Data.IRasterBounds,DotSpatial.Topology.Coordinate)"> + <summary> + Returns the row col index + </summary> + <param name="bounds">The raster bounds to perform the calculation on</param> + <param name="location">Gets or sets the ICoordinate</param> + <returns>An RcIndex that shows the best row or column index for the specified coordinate.</returns> + </member> + <member name="M:DotSpatial.Data.RasterBoundsExt.CellsContainingExtent(DotSpatial.Data.IRasterBounds,DotSpatial.Data.Extent)"> + <summary> + The affine transform can make figuring out what rows and columns are needed from the original image + in order to correctly fill a geographic extent challenging. This attempts to handle that back projection + problem. It returns a System.Drawing.Rectangle in pixel (cell) coordinates that is completely contains + the geographic extents, but is not larger than the bounds of the underlying image. + If geographic extent fully contains extent of IRasterBounds, than returns rectangle which contains full raster image. + If geographic extent partially contains extent of IRasterBounds, than returns rectangle which contains needed edges of full raster image. + It back projects all four corners of the extent and returns the bounding rectangle clipped by the image rectangle. + </summary> + <param name="self">Instance of <see cref="T:DotSpatial.Data.IRasterBounds"/></param> + <param name="extent">Extent to test.</param> + <returns>Rectangle in pixel (cell) coordinates.</returns> + </member> + <member name="T:DotSpatial.Data.RasterExt"> + <summary> + A new model, now that we support 3.5 framework and extension methods that are essentially + derived characteristics away from the IRaster interface, essentially reducing it + to the simplest interface possible for future implementers, while extending the most + easy-to-find functionality to the users. + </summary> + </member> + <member name="M:DotSpatial.Data.RasterExt.ContainsFeature(DotSpatial.Data.IRaster,DotSpatial.Data.IFeature)"> + <summary> + determine if the shape is partially inside grid extents + </summary> + <returns>false, if the shape is completely outside grid extents + true, if it's at least partially inside </returns> + </member> + <member name="M:DotSpatial.Data.RasterExt.IsFullyWindowed(DotSpatial.Data.IRaster)"> + <summary> + Gets a boolean that is true if the Window extents contain are all the information for the raster. + In otherwords, StartRow = StartColumn = 0, EndRow = NumRowsInFile - 1, and EndColumn = NumColumnsInFile - 1 + </summary> + </member> + <member name="M:DotSpatial.Data.RasterExt.MoveTo(DotSpatial.Data.IRaster,DotSpatial.Topology.Coordinate)"> + <summary> + This doesn't change the data, but instead performs a translation where the upper left coordinate + is specified in world coordinates. + </summary> + <param name="raster">Moves this raster so that the upper left coordinate will match the specified position. The skew and cellsize will remain unaltered</param> + <param name="position">The location to move the upper left corner of the raster to in world coordinates.</param> + </member> + <member name="M:DotSpatial.Data.RasterExt.Rotate(DotSpatial.Data.IRaster,System.Single)"> + <summary> + Rotates the geospatial reference points for this image by rotating the affine coordinates. + The center for this rotation will be the center of the image. + </summary> + <param name="raster">The raster to rotate</param> + <param name="degrees">The angle in degrees to rotate the image counter clockwise.</param> + </member> + <member name="M:DotSpatial.Data.RasterExt.RotateAt(DotSpatial.Data.IRaster,System.Single,DotSpatial.Topology.Coordinate)"> + <summary> + Rotates the geospatial reference points for this image by rotating the affine coordinates. + The center for this rotation will be the center of the image. + </summary> + <param name="raster">The raster to rotate about the specified coordinate</param> + <param name="degrees">The angle in degrees to rotate the image counterclockwise.</param> + <param name="center">The point that marks the center of the desired rotation in geographic coordiantes.</param> + </member> + <member name="M:DotSpatial.Data.RasterExt.Scale(DotSpatial.Data.IRaster,System.Single,System.Single)"> + <summary> + This method uses a matrix transform to adjust the scale. The precision of using + a Drawing2D transform is float precision, so some accuracy may be lost. + </summary> + <param name="raster">The raster to apply the scale transform to</param> + <param name="scaleX">The multiplier to adjust the geographic extents of the raster in the X direction</param> + <param name="scaleY">The multiplier to adjust the geographic extents of the raster in the Y direction</param> + </member> + <member name="M:DotSpatial.Data.RasterExt.Shear(DotSpatial.Data.IRaster,System.Single,System.Single)"> + <summary> + This method uses a matrix transform to adjust the shear. The precision of using + a Drawing2D transform is float precision, so some accuracy may be lost. + </summary> + <param name="raster">The raster to apply the transform to</param> + <param name="shearX">The floating point horizontal shear factor</param> + <param name="shearY">The floating ponit vertical shear factor</param> + </member> + <member name="M:DotSpatial.Data.RasterExt.Translate(DotSpatial.Data.IRaster,DotSpatial.Topology.Coordinate)"> + <summary> + Applies a translation transform to the georeferenced coordinates on this raster. + </summary> + <param name="raster">The raster to apply the translation to</param> + <param name="shift">An ICoordinate with shear values</param> + </member> + <member name="M:DotSpatial.Data.RasterExt.GetNearestValue(DotSpatial.Data.IRaster,DotSpatial.Topology.Coordinate)"> + <summary> + Retrieves the data from the cell that is closest to the specified coordinates. This will + return a No-Data value if the specified coordintes are outside of the grid. + </summary> + <param name="raster">The raster to get the value from</param> + <param name="location">A valid implementation of Icoordinate specifying the geographic location.</param> + <returns>The value of type T of the cell that has a center closest to the specified coordinates</returns> + </member> + <member name="M:DotSpatial.Data.RasterExt.GetNearestValue(DotSpatial.Data.IRaster,System.Double,System.Double)"> + <summary> + Retrieves the data from the cell that is closest to the specified coordinates. This will + return a No-Data value if the specified coordintes are outside of the grid. + </summary> + <param name="raster">The raster to get the value from</param> + <param name="x">The longitude or horizontal coordinate</param> + <param name="y">The latitude or vertical coordinate</param> + <returns>The double value of the cell that has a center closest to the specified coordinates</returns> + </member> + <member name="M:DotSpatial.Data.RasterExt.SetNearestValue(DotSpatial.Data.IRaster,System.Double,System.Double,System.Double)"> + <summary> + Retrieves the location from the cell that is closest to the specified coordinates. This will + do nothing if the specified coordinates are outside of the raster. + </summary> + <param name="raster">The IRaster to set the value for</param> + <param name="x">The longitude or horizontal coordinate</param> + <param name="y">The latitude or vertical coordinate</param> + <param name="value">The value to assign to the nearest cell to the specified location</param> + </member> + <member name="M:DotSpatial.Data.RasterExt.SetNearestValue(DotSpatial.Data.IRaster,DotSpatial.Topology.Coordinate,System.Double)"> + <summary> + Retrieves the location from the cell that is closest to the specified coordinates. This will + do nothing if the specified coordinates are outside of the raster. + </summary> + <param name="raster">The IRaster to set the value for</param> + <param name="location">An Icoordinate specifying the location</param> + <param name="value">The value to assign to the nearest cell to the specified location</param> + </member> + <member name="M:DotSpatial.Data.RasterExt.CellToProj(DotSpatial.Data.IRaster,DotSpatial.Data.RcIndex)"> + <summary> + Extends the IRaster interface to return the coordinate of the center of a row column position. + </summary> + <param name="raster">The raster interface to extend</param> + <param name="position">The zero based integer index of the row and column of the cell to locate</param> + <returns>The geographic location of the center of the specified cell</returns> + </member> + <member name="M:DotSpatial.Data.RasterExt.CellToProj(DotSpatial.Data.IRaster,System.Int32,System.Int32)"> + <summary> + Extends the IRaster interface to return the coordinate of the center of a row column position. + </summary> + <param name="raster">The raster interface to extend</param> + <param name="row">The zero based integer index of the row of the cell to locate</param> + <param name="col">The zero based integer index of the column of the cell to locate</param> + <returns>The geographic location of the center of the specified cell</returns> + </member> + <member name="M:DotSpatial.Data.RasterExt.ProjToCell(DotSpatial.Data.IRaster,DotSpatial.Topology.Coordinate)"> + <summary> + Extends the IRaster interface to return the zero based integer row and column indices + </summary> + <param name="raster">The raster interface to extend</param> + <param name="location">The geographic coordinate describing the latitude and longitude</param> + <returns>The RcIndex that describes the zero based integer row and column indices</returns> + </member> + <member name="M:DotSpatial.Data.RasterExt.ProjToCell(DotSpatial.Data.IRaster,System.Double,System.Double)"> + <summary> + Extends the IRaster interface to return the zero based integer row and column indices + </summary> + <param name="raster">The raster interface to extend</param> + <param name="x">A double precision floating point describing the longitude</param> + <param name="y">A double precision floating point describing the latitude</param> + <returns>The RcIndex that describes the zero based integer row and column indices</returns> + </member> + <member name="T:DotSpatial.Data.BgdRaster`1"> + <summary> + BgdRaster + </summary> + </member> + <member name="T:DotSpatial.Data.Raster`1"> + <summary> + Raster + </summary> + </member> + <member name="T:DotSpatial.Data.Raster"> + <summary> + Handles the native file functions for float grids, without relying on GDAL. + </summary> + </member> + <member name="T:DotSpatial.Data.IRaster"> + <summary> + A general + </summary> + </member> + <member name="M:DotSpatial.Data.IRaster.Copy"> + <summary> + This only works for in-ram rasters. This basically makes a new raster that has all the same + in memory values + </summary> + <returns>An IRaster that is a duplicate of this class</returns> + </member> + <member name="M:DotSpatial.Data.IRaster.Copy(System.String,System.Boolean)"> + <summary> + Creates a duplicate version of this file. If copyValues is set to false, then a raster of NoData values is created + that has the same georeferencing information as the source file of this Raster, even if this raster is just a window. + </summary> + <param name="fileName">The string fileName specifying where to create the new file.</param> + <param name="copyValues">If this is false, the same size and georeferencing values are used, but they are all set to NoData.</param> + </member> + <member name="M:DotSpatial.Data.IRaster.GetStatistics"> + <summary> + Even if this is a window, this will cause this raster to show statistics calculated from the entire file. + </summary> + </member> + <member name="M:DotSpatial.Data.IRaster.GetValues(System.Collections.Generic.IEnumerable{System.Int64})"> + <summary> + Most raster methods are optimized for reading in lines or blocks at a time. This one is designed + to be used for scattered points. + </summary> + <param name="indices">The zero based integer index that is Row * NumColumnsInFile + Column</param> + <returns>The list of double values</returns> + </member> + <member name="M:DotSpatial.Data.IRaster.ReadBlock(System.Int32,System.Int32,System.Int32,System.Int32)"> + <summary> + Returns a subset from the file that includes only the specified offsets. The result is a raster, + and the extents are calculated, but the row and column values are in terms of the window, + not the original raster. The band can be controlled by setting the "Current Band" first. + </summary> + <param name="xOff">X axis or horizontal offset (0 based from left)</param> + <param name="yOff">Y axis or vertical offset (0 based from top)</param> + <param name="sizeX">Number of columns</param> + <param name="sizeY">Number of rows</param> + <returns>An IRaster created from the appropriate type;.</returns> + </member> + <member name="M:DotSpatial.Data.IRaster.WriteBlock(DotSpatial.Data.IRaster,System.Int32,System.Int32,System.Int32,System.Int32)"> + <summary> + This writes the values to the file, even if the IRaster has more values than the xSize or ySize + stipulate, and even if the source raster has values of a different type. + </summary> + <param name="blockValues">The IRaster that contains data values to write to the file</param> + <param name="xOff">The 0 based integer horizontal offset from the left</param> + <param name="yOff">The 0 based integer vertical offset from the top</param> + <param name="xSize">The integer number of columns to write</param> + <param name="ySize">The integer number of rows to write</param> + </member> + <member name="M:DotSpatial.Data.IRaster.Save"> + <summary> + Saves changes from any values that are in memory to the file. This will preserve the existing + structure and attempt to only write values to the parts of the file that match the loaded window. + </summary> + </member> + <member name="M:DotSpatial.Data.IRaster.SaveAs(System.String)"> + <summary> + This will save whatever is specified in the startRow, endRow, startColumn, endColumn bounds + to a new file with the specified fileName. + </summary> + <param name="fileName">The string fileName to save the current raster to.</param> + </member> + <member name="M:DotSpatial.Data.IRaster.SetData(DotSpatial.Data.IRaster)"> + <summary> + This code is required to allow a new format to save data from an old format quickly. + It essentially quickly transfers the underlying data values to the new raster. + </summary> + <param name="original"></param> + </member> + <member name="M:DotSpatial.Data.IRaster.ToRaster``1"> + <summary> + Gets this raster (or its Internal Raster) as the appropriately typed raster + so that strong typed access methods are available, instead of just the + regular methods, or null if the type is incorrect. (Check datatype property). + </summary> + <typeparam name="T">The type (int, short, float, etc.)</typeparam> + <returns>The Raster<T> where T are value types like int, short and float. Returns null if the type is wrong.</returns> + </member> + <member name="M:DotSpatial.Data.IRaster.WriteHeader"> + <summary> + Instructs the raster to write only the header content. This is especially useful if you just want to update + the extents or the projection of the raster, without changing the data values. + </summary> + </member> + <member name="M:DotSpatial.Data.IRaster.CategoryNames"> + <summary> + A raster can contain predefined names for its categories + </summary> + <returns>null if raster has no category names</returns> + </member> + <member name="M:DotSpatial.Data.IRaster.CategoryColors"> + <summary> + A raster can contain predefined colors for its categories, for example NLCD GeoTIFF has a palette + </summary> + <returns>null if raster has no category colors</returns> + </member> + <member name="P:DotSpatial.Data.IRaster.ByteSize"> + <summary> + Gets the integer size of each data member of the raster in bytes. + </summary> + </member> + <member name="P:DotSpatial.Data.IRaster.Bands"> + <summary> + Gets or sets the list of bands, which are in turn rasters. The rasters + contain only one band each, instead of the list of all the bands like the + parent raster. + </summary> + </member> + <member name="P:DotSpatial.Data.IRaster.CellHeight"> + <summary> + The geographic height of a cell the projected units. Setting this will + automatically adjust the affine coefficient to a negative value. + </summary> + </member> + <member name="P:DotSpatial.Data.IRaster.CellWidth"> + <summary> + The geographic width of a cell in the projected units + </summary> + </member> + <member name="P:DotSpatial.Data.IRaster.CurrentBand"> + <summary> + This provides a zero-based integer band index that specifies which of the internal bands + is currently being used for requests for data. + </summary> + </member> + <member name="P:DotSpatial.Data.IRaster.CustomFileType"> + <summary> + This does nothing unless the FileType property is set to custom. + In such a case, this string allows new file types to be managed. + </summary> + </member> + <member name="P:DotSpatial.Data.IRaster.DataType"> + <summary> + This reveals the underlying data type + </summary> + </member> + <member name="P:DotSpatial.Data.IRaster.DriverCode"> + <summary> + Gets or sets a short string to identify which driver to use. This is primarilly used by GDAL rasters. + </summary> + </member> + <member name="P:DotSpatial.Data.IRaster.EndColumn"> + <summary> + The integer column index for the right column of this raster. Most of the time this will + be NumColumns - 1. However, if this raster is a window taken from a larger raster, then + it will be the index of the endColumn from the window. + </summary> + </member> + <member name="P:DotSpatial.Data.IRaster.EndRow"> + <summary> + The integer row index for the end row of this raster. Most of the time this will + be numRows - 1. However, if this raster is a window taken from a larger raster, then + it will be the index of the endRow from the window. + </summary> + </member> + <member name="P:DotSpatial.Data.IRaster.Filename"> + <summary> + Gets the complete path and fileName of the current file + </summary> + </member> + <member name="P:DotSpatial.Data.IRaster.FileType"> + <summary> + Gets the file type of this grid. + </summary> + </member> + <member name="P:DotSpatial.Data.IRaster.IsInRam"> + <summary> + Gets a boolean that is true if the data for this raster is in memory. + </summary> + </member> + <member name="P:DotSpatial.Data.IRaster.Maximum"> + <summary> + Gets the maximum data value, not counting no-data values in the grid. + </summary> + </member> + <member name="P:DotSpatial.Data.IRaster.Mean"> + <summary> + Gets the mean of the non-NoData values in this grid. If the data is not InRam, then + the GetStatistics method must be called before these values will be correct. + </summary> + </member> + <member name="P:DotSpatial.Data.IRaster.Minimum"> + <summary> + Gets the minimum data value that is not classified as a no data value in this raster. + </summary> + </member> + <member name="P:DotSpatial.Data.IRaster.NoDataValue"> + <summary> + A float showing the no-data values + </summary> + </member> + <member name="P:DotSpatial.Data.IRaster.Notes"> + <summary> + For binary rasters this will get cut to only 256 characters. + </summary> + </member> + <member name="P:DotSpatial.Data.IRaster.NumBands"> + <summary> + Gets the number of bands. In most traditional grid formats, this is 1. For RGB images, + this would be 3. Some formats may have many bands. + </summary> + </member> + <member name="P:DotSpatial.Data.IRaster.NumColumns"> + <summary> + Gets the horizontal count of the cells in the raster. + </summary> + </member> + <member name="P:DotSpatial.Data.IRaster.NumColumnsInFile"> + <summary> + Gets the integer count of columns in the file, as opposed to the + number represented by this raster, which might just represent a window. + </summary> + </member> + <member name="P:DotSpatial.Data.IRaster.NumRows"> + <summary> + Gets the vertical count of the cells in the raster. + </summary> + </member> + <member name="P:DotSpatial.Data.IRaster.NumRowsInFile"> + <summary> + Gets the number of rows in the source file, as opposed to the number + represented by this raster, which might just represent part of a file. + </summary> + </member> + <member name="P:DotSpatial.Data.IRaster.NumValueCells"> + <summary> + Gets the count of the cells that are not no-data. If the data is not InRam, then + you will have to first call the GetStatistics() method to gain meaningul values. + </summary> + </member> + <member name="P:DotSpatial.Data.IRaster.Options"> + <summary> + Gets or sets the string array of options to use when saving this raster. + </summary> + </member> + <member name="P:DotSpatial.Data.IRaster.Rows"> + <summary> + Gets a list of the rows in this raster that can be accessed independantly. + </summary> + </member> + <member name="P:DotSpatial.Data.IRaster.StartColumn"> + <summary> + The integer column index for the left column of this raster. Most of the time this will + be 0. However, if this raster is a window taken from a file, then + it will be the row index in the file for the top row of this raster. + </summary> + </member> + <member name="P:DotSpatial.Data.IRaster.StartRow"> + <summary> + The integer row index for the top row of this raster. Most of the time this will + be 0. However, if this raster is a window taken from a file, then + it will be the row index in the file for the left row of this raster. + </summary> + </member> + <member name="P:DotSpatial.Data.IRaster.StdDeviation"> + <summary> + Gets the standard deviation of all the Non-nodata cells. If the data is not InRam, + then you will have to first call the GetStatistics() method to get meaningful values. + </summary> + </member> + <member name="P:DotSpatial.Data.IRaster.Tag"> + <summary> + This is provided for future developers to link this raster to other entities. + It has no function internally, so it can be manipulated safely. + </summary> + </member> + <member name="P:DotSpatial.Data.IRaster.Value"> + <summary> + Gets or sets the value on the CurrentBand given a row and column undex + </summary> + </member> + <member name="P:DotSpatial.Data.IRaster.Xllcenter"> + <summary> + The horizontal or longitude coordinate for the lower left cell in the grid + </summary> + </member> + <member name="P:DotSpatial.Data.IRaster.Yllcenter"> + <summary> + The vertical or latitude coordinate for the lower left cell in the grid + </summary> + </member> + <member name="P:DotSpatial.Data.IRaster.Sample"> + <summary> + This doesn't perform calculations, but is simply a place holder where sample + values can be stored and retrieved as a cache. + </summary> + </member> + <member name="E:DotSpatial.Data.IRaster.FileExists"> + <summary> + Occurs when attempting to copy or save to a fileName that already exists. A developer can tap into this event + in order to display an appropriate message. A cancel property allows the developer (and ultimately the user) + decide if the specified event should ultimately be cancelled. + </summary> + </member> + <member name="M:DotSpatial.Data.Raster.#ctor"> + <summary> + Set up the default values + </summary> + </member> + <member name="M:DotSpatial.Data.Raster.Clone"> + <summary> + Creates a memberwise clone of this object. Reference types will be copied, but + they will still point to the same original object. So a clone of this raster + is pointing to the same underlying array of values etc. + </summary> + <returns>A Raster clone of this raster.</returns> + </member> + <member name="M:DotSpatial.Data.Raster.Copy"> + <summary> + Creates a new IRaster that has the identical characteristics and in-ram data to the original. + </summary> + <returns>A Copy of the original raster.</returns> + </member> + <member name="M:DotSpatial.Data.Raster.Copy(System.String,System.Boolean)"> + <summary> + Creates a duplicate version of this file. If copyValues is set to false, then a raster of NoData values is created + that has the same georeferencing information as the source file of this Raster, even if this raster is just a window. + </summary> + <param name="fileName">The string fileName specifying where to create the new file.</param> + <param name="copyValues">If this is false, the same size and georeferencing values are used, but they are all set to NoData.</param> + </member> + <member name="M:DotSpatial.Data.Raster.GetValues(System.Collections.Generic.IEnumerable{System.Int64})"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.Raster.GetStatistics"> + <summary> + Even if this is a window, this will cause this raster to show statistics calculated from the entire file. + </summary> + </member> + <member name="M:DotSpatial.Data.Raster.Save"> + <summary> + Saves the values to a the same file that was created or loaded. + </summary> + </member> + <member name="M:DotSpatial.Data.Raster.SaveAs(System.String)"> + <summary> + Saves the curretn raster to the specified file. The current driver code and options are used. + </summary> + <param name="fileName">The string fileName to save the raster to.</param> + </member> + <member name="M:DotSpatial.Data.Raster.ReadBlock(System.Int32,System.Int32,System.Int32,System.Int32)"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.Raster.WriteBlock(DotSpatial.Data.IRaster,System.Int32,System.Int32,System.Int32,System.Int32)"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.Raster.SetData(DotSpatial.Data.IRaster)"> + <summary> + This code is empty, but can be overridden in subtypes + </summary> + <param name="original"></param> + </member> + <member name="M:DotSpatial.Data.Raster.WriteHeader"> + <summary> + Instructs the file to write header changes only. This is espcially useful for changing the + extents without altering the actual raster values themselves. + </summary> + </member> + <member name="M:DotSpatial.Data.Raster.Create(System.String,System.String,System.Int32,System.Int32,System.Int32,System.Type,System.String[])"> + <summary> + This create new method implies that this provider has the priority for creating a new file. + An instance of the dataset should be created and then returned. By this time, the fileName + will already be checked to see if it exists, and deleted if the user wants to overwrite it. + </summary> + <param name="name">The string fileName for the new instance.</param> + <param name="driverCode">The string short name of the driver for creating the raster.</param> + <param name="xSize">The number of columns in the raster.</param> + <param name="ySize">The number of rows in the raster.</param> + <param name="numBands">The number of bands to create in the raster.</param> + <param name="dataType">The data type to use for the raster.</param> + <param name="options">The options to be used.</param> + </member> + <member name="M:DotSpatial.Data.Raster.GetNoDataCellCount"> + <summary> + Gets the no data cell count. Calls GetStatistics() internally. + </summary> + <returns>The number of cells which are equal to NoDataValue.</returns> + </member> + <member name="M:DotSpatial.Data.Raster.Open(System.String)"> + <summary> + Opens the specified fileName. The DefaultDataManager will determine the best type of raster to handle the specified + file based on the fileName or characteristics of the file. + </summary> + <param name="fileName">The string fileName of the raster to open.</param> + </member> + <member name="M:DotSpatial.Data.Raster.Open"> + <summary> + Opens the specified fileName. The DefaultDataManager will determine the best type of raster to handle the specified + file based on the fileName or characteristics of the file. + </summary> + </member> + <member name="M:DotSpatial.Data.Raster.SaveAs(System.String,System.String)"> + <summary> + Saves the current raster to the specified file, using the specified driver, but with the + options currently specified in the Options property. + </summary> + <param name="fileName">The string fileName to save this raster as</param> + <param name="driverCode">The string driver code.</param> + </member> + <member name="M:DotSpatial.Data.Raster.SaveAs(System.String,System.String,System.String[])"> + <summary> + Saves the current raster to the specified file. + </summary> + <param name="fileName">The string fileName to save the current raster to.</param> + <param name="driverCode">The driver code to use.</param> + <param name="options">the string array of options that depend on the format.</param> + </member> + <member name="M:DotSpatial.Data.Raster.CategoryNames"> + <summary> + By default, Raster does not have any CategoryNames, but this can be overridden + </summary> + </member> + <member name="M:DotSpatial.Data.Raster.CategoryColors"> + <summary> + By default, Raster does not have any CategoryColors, but this can be overridden + </summary> + </member> + <member name="M:DotSpatial.Data.Raster.ToRaster``1"> + <summary> + Gets this raster (or its Internal Raster) as the appropriately typed raster + so that strong typed access methods are available, instead of just the + regular methods. + </summary> + <typeparam name="T">The type (int, short, float, etc.)</typeparam> + <returns>The Raster<T> where T are value types like int, short, float"/></returns> + </member> + <member name="M:DotSpatial.Data.Raster.Dispose(System.Boolean)"> + <summary> + Overrides dispose to correctly handle disposing the objects at the raster level. + </summary> + <param name="disposeManagedResources"></param> + </member> + <member name="M:DotSpatial.Data.Raster.OnFileExists(System.String)"> + <summary> + Fires the FileExists method. If this returns true, then the action should be cancelled. + </summary> + <param name="fileName">The fileName to write to</param> + <returns>Boolean, true if the user doesn't want to overwrite</returns> + </member> + <member name="M:DotSpatial.Data.Raster.ToIntRaster"> + <summary> + Gets this raster (or its Internal Raster) as the appropriately typed raster + so that strong typed access methods are available, instead of just the + regular methods. + </summary> + <returns>A Raster<short></returns> + </member> + <member name="M:DotSpatial.Data.Raster.ToShortRaster"> + <summary> + Gets this raster (or its Internal Raster) as the appropriately typed raster + so that strong typed access methods are available, instead of just the + regular methods. + </summary> + <returns>A Raster<short></returns> + </member> + <member name="M:DotSpatial.Data.Raster.ToFloatRaster"> + <summary> + Gets this raster (or its Internal Raster) as the appropriately typed raster + so that strong typed access methods are available, instead of just the + regular methods. + </summary> + <returns>A Raster<short></returns> + </member> + <member name="M:DotSpatial.Data.Raster.CreateRaster(System.String,System.String,System.Int32,System.Int32,System.Int32,System.Type,System.String[])"> + <summary> + This create new method implies that this provider has the priority for creating a new file. + An instance of the dataset should be created and then returned. By this time, the fileName + will already be checked to see if it exists, and deleted if the user wants to overwrite it. + </summary> + <param name="name">The string fileName for the new instance.</param> + <param name="driverCode">The string short name of the driver for creating the raster.</param> + <param name="xSize">The number of columns in the raster.</param> + <param name="ySize">The number of rows in the raster.</param> + <param name="numBands">The number of bands to create in the raster.</param> + <param name="dataType">The data type to use for the raster.</param> + <param name="options">The options to be used.</param> + <returns>An IRaster</returns> + </member> + <member name="M:DotSpatial.Data.Raster.GetGridFileType(System.String)"> + <summary> + For DotSpatial style binary grids, this returns the filetype + </summary> + <param name="filename">The fileName with extension to test</param> + <returns>A GridFileTypes enumeration listing which file type this is</returns> + </member> + <member name="M:DotSpatial.Data.Raster.OpenFile(System.String)"> + <summary> + This is significantly m + </summary> + <param name="fileName">The string full path for the fileName to open</param> + <returns>A Raster object which is actually one of the type specific rasters, like FloatRaster.</returns> + </member> + <member name="M:DotSpatial.Data.Raster.OpenFile(System.String,System.Boolean)"> + <summary> + Returns a native raster of the appropriate file type and data type by parsing the fileName. + </summary> + <param name="fileName">The string fileName to attempt to open with a native format</param> + <param name="inRam">The boolean value.</param> + <returns>An IRaster which has been opened to the specified file.</returns> + </member> + <member name="M:DotSpatial.Data.Raster.OpenFile(System.String,System.Boolean,DotSpatial.Data.IProgressHandler)"> + <summary> + Returns a native raster of the appropriate file type and data type by parsing the fileName. + </summary> + <param name="fileName">The string fileName to attempt to open with a native format</param> + <param name="inRam">The boolean value.</param> + <param name="progressHandler">An overriding progress manager for this process</param> + <returns>An IRaster which has been opened to the specified file.</returns> + </member> + <member name="E:DotSpatial.Data.Raster.FileExists"> + <summary> + Occurs when attempting to copy or save to a fileName that already exists. A developer can tap into this event + in order to display an appropriate message. A cancel property allows the developer (and ultimately the user) + decide if the specified event should ultimately be cancelled. + </summary> + </member> + <member name="P:DotSpatial.Data.Raster.Sample"> + <summary> + Gets or sets a statistical sampling. This is designed to cache a small, + representative sample of no more than about 10,000 values. This property + does not automatically produce the sample, and so this can be null. + </summary> + </member> + <member name="P:DotSpatial.Data.Raster.LineSpace"> + <summary> + A parameter for accessing some GDAL data. This frequently does nothing and is usually 0. + </summary> + </member> + <member name="P:DotSpatial.Data.Raster.PixelSpace"> + <summary> + A parameter for accessing GDAL. This frequently does nothing and is usually 0. + </summary> + </member> + <member name="P:DotSpatial.Data.Raster.ByteSize"> + <summary> + Gets the size of each raster element in bytes. + </summary> + </member> + <member name="P:DotSpatial.Data.Raster.Bands"> + <summary> + Gets or sets the list of bands, which are in turn rasters. The rasters + contain only one band each, instead of the list of all the bands like the + parent raster. + </summary> + </member> + <member name="P:DotSpatial.Data.Raster.CellHeight"> + <summary> + The geographic height of a cell the projected units. Setting this will + automatically adjust the affine coefficient to a negative value. + </summary> + </member> + <member name="P:DotSpatial.Data.Raster.CellWidth"> + <summary> + The geographic width of a cell in the projected units + </summary> + </member> + <member name="P:DotSpatial.Data.Raster.CurrentBand"> + <summary> + This provides a zero-based integer band index that specifies which of the internal bands + is currently being used for requests for data. + </summary> + </member> + <member name="P:DotSpatial.Data.Raster.CustomFileType"> + <summary> + This does nothing unless the FileType property is set to custom. + In such a case, this string allows new file types to be managed. + </summary> + </member> + <member name="P:DotSpatial.Data.Raster.DataType"> + <summary> + This returns the RasterDataTypes enumeration clarifying the underlying data type for this raster. + </summary> + </member> + <member name="P:DotSpatial.Data.Raster.DriverCode"> + <summary> + Gets or sets the driver code for this raster. + </summary> + </member> + <member name="P:DotSpatial.Data.Raster.EndColumn"> + <summary> + The integer column index for the right column of this raster. Most of the time this will + be NumColumns - 1. However, if this raster is a window taken from a larger raster, then + it will be the index of the endColumn from the window. + </summary> + </member> + <member name="P:DotSpatial.Data.Raster.EndRow"> + <summary> + The integer row index for the end row of this raster. Most of the time this will + be numRows - 1. However, if this raster is a window taken from a larger raster, then + it will be the index of the endRow from the window. + </summary> + </member> + <member name="P:DotSpatial.Data.Raster.Filename"> + <summary> + Gets or Sets the complete path and fileName of the current file + </summary> + </member> + <member name="P:DotSpatial.Data.Raster.FileType"> + <summary> + Returns the grid file type. Only Binary or ASCII are supported natively, without GDAL. + </summary> + </member> + <member name="P:DotSpatial.Data.Raster.IsInRam"> + <summary> + Gets or sets a boolean that is true if the data for this raster is in memory. + </summary> + </member> + <member name="P:DotSpatial.Data.Raster.Maximum"> + <summary> + Gets the maximum data value, not counting no-data values in the grid. + </summary> + </member> + <member name="P:DotSpatial.Data.Raster.Mean"> + <summary> + Gets the mean of the non-NoData values in this grid. If the data is not InRam, then + the GetStatistics method must be called before these values will be correct. + </summary> + </member> + <member name="P:DotSpatial.Data.Raster.Minimum"> + <summary> + Gets the minimum data value that is not classified as a no data value in this raster. + </summary> + </member> + <member name="P:DotSpatial.Data.Raster.NoDataValue"> + <summary> + A double showing the no-data value for this raster. + </summary> + </member> + <member name="P:DotSpatial.Data.Raster.Notes"> + <summary> + For binary rasters this will get cut to only 256 characters. + </summary> + </member> + <member name="P:DotSpatial.Data.Raster.NumBands"> + <summary> + Gets the number of bands. In most traditional grid formats, this is 1. For RGB images, + this would be 3. Some formats may have many bands. + </summary> + </member> + <member name="P:DotSpatial.Data.Raster.NumColumns"> + <summary> + Gets the horizontal count of the cells in the raster. + </summary> + </member> + <member name="P:DotSpatial.Data.Raster.NumColumnsInFile"> + <summary> + Gets the integer count of the number of columns in the source or file that this + raster is a window from. (Usually this will be the same as NumColumns) + </summary> + </member> + <member name="P:DotSpatial.Data.Raster.NumRows"> + <summary> + Gets the vertical count of the cells in the raster. + </summary> + </member> + <member name="P:DotSpatial.Data.Raster.NumRowsInFile"> + <summary> + Gets the integer count of the number of rows in the source or file that this + raster is a window from. (Usually this will be the same as NumColumns.) + </summary> + </member> + <member name="P:DotSpatial.Data.Raster.NumValueCells"> + <summary> + Gets the count of the cells that are not no-data. If the data is not InRam, then + you will have to first call the GetStatistics() method to gain meaningul values. + </summary> + </member> + <member name="P:DotSpatial.Data.Raster.Options"> + <summary> + An extra string array of options that exist for support of some types of GDAL supported raster drivers + </summary> + </member> + <member name="P:DotSpatial.Data.Raster.Rows"> + <summary> + Gets a list of the rows in this raster that can be accessed independantly. + </summary> + </member> + <member name="P:DotSpatial.Data.Raster.StartColumn"> + <summary> + The integer column index for the left column of this raster. Most of the time this will + be 0. However, if this raster is a window taken from a file, then + it will be the row index in the file for the top row of this raster. + </summary> + </member> + <member name="P:DotSpatial.Data.Raster.StartRow"> + <summary> + The integer row index for the top row of this raster. Most of the time this will + be 0. However, if this raster is a window taken from a file, then + it will be the row index in the file for the left row of this raster. + </summary> + </member> + <member name="P:DotSpatial.Data.Raster.StdDeviation"> + <summary> + Gets the standard deviation of all the Non-nodata cells. If the data is not InRam, + then you will have to first call the GetStatistics() method to get meaningful values. + </summary> + </member> + <member name="P:DotSpatial.Data.Raster.Tag"> + <summary> + This is provided for future developers to link this raster to other entities. + It has no function internally, so it can be manipulated safely. + </summary> + </member> + <member name="P:DotSpatial.Data.Raster.Value"> + <summary> + Gets or sets the value on the CurrentBand given a row and column undex + </summary> + </member> + <member name="P:DotSpatial.Data.Raster.Xllcenter"> + <summary> + Gets or sets the X position of the lower left data cell. + Setting this will adjust only the _affine[0] coefficient to ensure that the + lower left corner ends up in the specified location, while keeping all the + other affine coefficients the same. This is like a horizontal Translate + that locks into place the center of the lower left corner of the image. + </summary> + </member> + <member name="P:DotSpatial.Data.Raster.Yllcenter"> + <summary> + Gets or sets the Y position of the lower left data cell. + Setting this will adjust only the _affine[0] coefficient to ensure that the + lower left corner ends up in the specified location, while keeping all the + other affine coefficients the same. This is like a horizontal Translate + that locks into place the center of the lower left corner of the image. + </summary> + </member> + <member name="F:DotSpatial.Data.Raster`1.Data"> + <summary> + The actual data values, stored as a jagged array of values of type T + </summary> + </member> + <member name="M:DotSpatial.Data.Raster`1.#ctor"> + <summary> + Creates a new instance of Raster + </summary> + </member> + <member name="M:DotSpatial.Data.Raster`1.#ctor(System.Int32,System.Int32,DotSpatial.Data.ValueGrid{`0})"> + <summary> + Creates an raster of data type T + </summary> + <param name="numRows">The number of rows in the raster</param> + <param name="numColumns">The number of columns in the raster</param> + <param name="valueGrid">The default ValueGrid only supports standard numeric types, but if a different kind of value grid is needed, this allows it.</param> + </member> + <member name="M:DotSpatial.Data.Raster`1.#ctor(System.Int32,System.Int32)"> + <summary> + Creates a raster of data type T. + </summary> + <param name="numRows">The number of rows in the raster</param> + <param name="numColumns">The number of columns in the raster</param> + </member> + <member name="M:DotSpatial.Data.Raster`1.SetData(DotSpatial.Data.IRaster)"> + <summary> + Used especially by the "save as" situation, this simply creates a new reference pointer for the actual data values. + </summary> + <param name="original"></param> + </member> + <member name="M:DotSpatial.Data.Raster`1.Initialize"> + <summary> + Calls the basic setup for the raster + </summary> + </member> + <member name="M:DotSpatial.Data.Raster`1.Dispose(System.Boolean)"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.Raster`1.Copy"> + <summary> + Creates a deep copy of this raster object so that the data values can be manipulated without + interfering with the original raster. + </summary> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.Raster`1.CopyWindow(System.String,System.Int32,System.Int32,System.Int32,System.Int32,System.Boolean,System.Boolean)"> + <summary> + This creates a completely new raster from the windowed domain on the original raster. This new raster + will not have a source file, and values like NumRowsInFile will correspond to the in memory version. + All the values will be copied to the new source file. InRam must be true at this level. + </summary> + <param name="fileName"></param> + <param name="startRow">The 0 based integer index of the top row to copy from this raster. If this raster is itself a window, 0 represents the startRow from the file.</param> + <param name="endRow">The integer index of the bottom row to copy from this raster. The largest allowed value is NumRows - 1.</param> + <param name="startColumn">The 0 based integer index of the leftmost column to copy from this raster. If this raster is a window, 0 represents the startColumn from the file.</param> + <param name="endColumn">The 0 based integer index of the rightmost column to copy from this raster. The largest allowed value is NumColumns - 1</param> + <param name="copyValues">If this is true, the values are saved to the file. If this is false and the data can be loaded into Ram, no file handling is done. Otherwise, a file of NoData values is created.</param> + <param name="inRam">Boolean. If this is true and the window is small enough, a copy of the values will be loaded into memory.</param> + <returns>An implementation of IRaster</returns> + </member> + <member name="M:DotSpatial.Data.Raster`1.GetStatistics"> + <summary> + Gets the statistics all the values. If the entire content is not currently in-ram, + ReadRow will be used to read individual lines and performing the calculations. + </summary> + </member> + <member name="M:DotSpatial.Data.Raster`1.GetWindow(System.Int32,System.Int32,System.Int32,System.Int32,System.Boolean)"> + <summary> + This creates an IN MEMORY ONLY window from the in-memory window of this raster. If, however, the requested range + is outside of what is contained in the in-memory portions of this raster, an appropriate cast + is required to ensure that you have the correct File handling, like a BinaryRaster etc. + </summary> + <param name="startRow">The 0 based integer index of the top row to get from this raster. If this raster is itself a window, 0 represents the startRow from the file.</param> + <param name="endRow">The integer index of the bottom row to get from this raster. The largest allowed value is NumRows - 1.</param> + <param name="startColumn">The 0 based integer index of the leftmost column to get from this raster. If this raster is a window, 0 represents the startColumn from the file.</param> + <param name="endColumn">The 0 based integer index of the rightmost column to get from this raster. The largest allowed value is NumColumns - 1</param> + <param name="inRam">Boolean. If this is true and the window is small enough, a copy of the values will be loaded into memory.</param> + <returns>An implementation of IRaster</returns> + </member> + <member name="M:DotSpatial.Data.Raster`1.GetWindowStatistics"> + <summary> + Obtains only the statistics for the small window specified by startRow, endRow etc. + this only works if the window is also InRam. + </summary> + </member> + <member name="M:DotSpatial.Data.Raster`1.Open"> + <summary> + Prevent the base raster "factory" style open function from working in subclasses. + </summary> + </member> + <member name="M:DotSpatial.Data.Raster`1.Save"> + <summary> + This saves content from memory stored in the Data field to the file using whatever + file format the file already exists as. + </summary> + </member> + <member name="M:DotSpatial.Data.Raster`1.ReadRow(System.Int32)"> + <summary> + Reads a specific + </summary> + <param name="row"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.Raster`1.ReadRaster"> + <summary> + This method reads the values from the entire band into an array and returns the array as a single array. + This assumes 0 offsets, the size of the entire image, and 0 for the pixel or line space. + </summary> + <returns>An array of values of type T, in row major order</returns> + </member> + <member name="M:DotSpatial.Data.Raster`1.GetValuesT(System.Collections.Generic.IEnumerable{System.Int64})"> + <summary> + Most reading is optimized to read in a block at a time and process it. This method is designed + for seeking through the file. It should work faster than the buffered methods in cases where + an unusually arranged collection of values are required. Sorting the list before calling + this should significantly improve performance. + </summary> + <param name="indices">A list or array of long values that are (Row * NumRowsInFile + Column)</param> + </member> + <member name="M:DotSpatial.Data.Raster`1.GetValues(System.Collections.Generic.IEnumerable{System.Int64})"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.Raster`1.ReadBlock(System.Int32,System.Int32,System.Int32,System.Int32)"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.Raster`1.ReadRaster(System.Int32,System.Int32,System.Int32,System.Int32)"> + <summary> + This Method should be overrridden by classes, and provides the primary ability. + </summary> + <param name="xOff">The horizontal offset of the area to read values from.</param> + <param name="yOff">The vertical offset of the window to read values from.</param> + <param name="sizeX">The number of values to read into the buffer.</param> + <param name="sizeY">The vertical size of the window to read into the buffer.</param> + <returns>The jagged array of raster values of type T.</returns> + </member> + <member name="M:DotSpatial.Data.Raster`1.WriteRow(`0[],System.Int32)"> + <summary> + Reads a specific + </summary> + <param name="buffer">The one dimensional array of values containing all the data for this particular content.</param> + <param name="row">The integer row to write to the raster</param> + </member> + <member name="M:DotSpatial.Data.Raster`1.WriteRaster(`0[][])"> + <summary> + This method reads the values from the entire band into an array and returns the array as a single array. + This assumes 0 offsets, the size of the entire image, and 0 for the pixel or line space. + </summary> + <param name="buffer">The one dimensional array of values containing all the data for this particular content.</param> + </member> + <member name="M:DotSpatial.Data.Raster`1.WriteRaster(`0[][],System.Int32,System.Int32,System.Int32,System.Int32)"> + <summary> + This method reads the values from the entire band into an array and returns the array as a single array. + This specifies a window where the xSize and ySize specified and 0 is used for the pixel and line space. + </summary> + <param name="buffer">The one dimensional array of values containing all the data for this particular content.</param> + <param name="xOff">The horizontal offset of the area to read values from.</param> + <param name="yOff">The vertical offset of the window to read values from.</param> + <param name="xSize">The number of values to read into the buffer.</param> + <param name="ySize">The vertical size of the window to read into the buffer.</param> + </member> + <member name="M:DotSpatial.Data.Raster`1.WriteBlock(DotSpatial.Data.IRaster,System.Int32,System.Int32,System.Int32,System.Int32)"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.Raster`1.UpdateHeader"> + <summary> + During a save opperation, this instructs the program to perform any writing that is not handled by + the write raster content. + </summary> + </member> + <member name="P:DotSpatial.Data.Raster`1.ValuesT"> + <summary> + This is the same as the "Value" member except that it is type specific. + This also supports the "ToDouble" method. + </summary> + </member> + <member name="P:DotSpatial.Data.Raster`1.ByteSize"> + <summary> + Gets the size of each raster element in bytes. + </summary> + <remarks> + This only works for a few numeric types, and will return 0 if it is not identifiable as one + of these basic types: byte, short, int, long, float, double, decimal, sbyte, ushort, uint, ulong, bool. + </remarks> + </member> + <member name="M:DotSpatial.Data.BgdRaster`1.#ctor"> + <summary> + A BgdRaster in created this way probably expects to open a file using the "Open" method, + which allows for progress handlers or other things to be set before what might be a + time consuming read-value process. + </summary> + </member> + <member name="M:DotSpatial.Data.BgdRaster`1.#ctor(System.Int32,System.Int32)"> + <summary> + Creates a new instance of a BGD raster, attempting to store the entire structure in memory if possible. + </summary> + <param name="numRows"></param> + <param name="numColumns"></param> + </member> + <member name="M:DotSpatial.Data.BgdRaster`1.#ctor(System.String,System.Int32,System.Int32)"> + <summary> + This creates a new BGD raster. + </summary> + <param name="fileName"></param> + <param name="numRows"></param> + <param name="numColumns"></param> + </member> + <member name="M:DotSpatial.Data.BgdRaster`1.ReadRaster(System.Int32,System.Int32,System.Int32,System.Int32)"> + <summary> + This Method should be overrridden by classes, and provides the primary ability. + </summary> + <param name="xOff">The horizontal offset of the area to read values from.</param> + <param name="yOff">The vertical offset of the window to read values from.</param> + <param name="sizeX">The number of values to read into the buffer.</param> + <param name="sizeY">The vertical size of the window to read into the buffer.</param> + <returns>A jagged array of type T.</returns> + </member> + <member name="M:DotSpatial.Data.BgdRaster`1.GetValuesT(System.Collections.Generic.IEnumerable{System.Int64})"> + <summary> + Most reading is optimized to read in a block at a time and process it. This method is designed + for seeking through the file. It should work faster than the buffered methods in cases where + an unusually arranged collection of values are required. Sorting the list before calling + this should significantly improve performance. + </summary> + <param name="indices">A list or array of long values that are (Row * NumRowsInFile + Column)</param> + </member> + <member name="M:DotSpatial.Data.BgdRaster`1.WriteRaster(`0[][],System.Int32,System.Int32,System.Int32,System.Int32)"> + <summary> + Writes the bgd content from the specified jagged array of values to the file. + </summary> + <param name="buffer">The data</param> + <param name="xOff">The horizontal offset</param> + <param name="yOff">The vertical offset</param> + <param name="xSize">The number of values to write horizontally</param> + <param name="ySize">The number of values to write vertically</param> + </member> + <member name="M:DotSpatial.Data.BgdRaster`1.Copy(System.String,System.Boolean)"> + <summary> + Copies the raster header, and if copyValues is true, the values to the specified file </summary> + <param name="fileName">The full path of the file to copy content to to</param> + <param name="copyValues">Boolean, true if this should copy values as well as just header information</param> + </member> + <member name="M:DotSpatial.Data.BgdRaster`1.Open"> + <summary> + Opens the specified file + </summary> + </member> + <member name="M:DotSpatial.Data.BgdRaster`1.Save"> + <summary> + Saves the content from this file using the current fileName and header information + </summary> + </member> + <member name="M:DotSpatial.Data.BgdRaster`1.Write(System.String)"> + <summary> + If no file exists, this writes the header and no-data values. If a file exists, it will assume + that data already has been filled in the file and will attempt to insert the data values + as a window into the file. If you want to create a copy of the file and values, just use + System.IO.File.Copy, it almost certainly would be much more optimized. + </summary> + </member> + <member name="M:DotSpatial.Data.BgdRaster`1.WriteHeader"> + <summary> + Writes the header to the fileName + </summary> + </member> + <member name="M:DotSpatial.Data.BgdRaster`1.WriteHeader(System.String)"> + <summary> + The string fileName where this will begin to write data by clearing the existing file + </summary> + </member> + <member name="M:DotSpatial.Data.BgdRaster`1.ReadHeader(System.String)"> + <summary> + Writes the header, regardless of which subtype of binary raster this is written for + </summary> + <param name="fileName">The string fileName specifying what file to load</param> + </member> + <member name="P:DotSpatial.Data.BgdRaster`1.HeaderSize"> + <summary> + Gets the size of the header. There is one no-data value in the header. + </summary> + </member> + <member name="T:DotSpatial.Data.IValueGrid"> + <summary> + An inteface specification for any of the multiple types of IDataBlock. + </summary> + </member> + <member name="P:DotSpatial.Data.IValueGrid.Item(System.Int32,System.Int32)"> + <summary> + Gets or sets a value at the 0 row, 0 column index. + </summary> + <param name="row">The 0 based vertical row index from the top</param> + <param name="column">The 0 based horizontal column index from the left</param> + <returns>An object reference to the actual value in the data member.</returns> + </member> + <member name="P:DotSpatial.Data.IValueGrid.Updated"> + <summary> + Boolean, gets or sets the flag indicating if the values have been changed + since the last time this flag was set to false. + </summary> + </member> + <member name="M:DotSpatial.Data.ValueGrid`1.#ctor(DotSpatial.Data.Raster{`0})"> + <summary> + Constructing an ObjectGrid this way assumes the values are not in ram and will + simply buffer 3 rows. + </summary> + <param name="sourceRaster"></param> + </member> + <member name="M:DotSpatial.Data.ValueGrid`1.ToDouble(`0)"> + <summary> + This involves boxing and unboxing as well as a convert to double, but IConvertible was + not CLS Compliant, so we were always getting warnings about it. I am trying to make + all the code CLS Compliant to remove warnings. + </summary> + <param name="value"></param> + <returns></returns> + </member> + <member name="P:DotSpatial.Data.ValueGrid`1.Item(System.Int32,System.Int32)"> + <summary> + Gets or sets a value at the 0 row, 0 column index. + </summary> + <param name="row">The 0 based vertical row index from the top</param> + <param name="column">The 0 based horizontal column index from the left</param> + <returns>An object reference to the actual value in the data member.</returns> + </member> + <member name="P:DotSpatial.Data.ValueGrid`1.Updated"> + <summary> + This is just a boolean flag that is set to true when the values + are updated. It is the responsibility of the user to set this + value to false again when the situation warents it. + </summary> + </member> + <member name="T:DotSpatial.Data.BinaryRaster`1"> + <summary> + This basically demonstrates how you would combine a type with a calculator in order to + construct a Binary Raster for the Integer type. It is effectively the same as + constructing a new BinaryRaster and specifying the parameter types int and IntCalculator. + </summary> + </member> + <member name="M:DotSpatial.Data.BinaryRaster`1.#ctor"> + <summary> + Creates a completely empty raster that can be custom configured + </summary> + </member> + <member name="M:DotSpatial.Data.BinaryRaster`1.#ctor(System.String,System.Int32,System.Int32)"> + <summary> + Creates a new BinaryRaster with the specified rows and columns. + If if the raster is less than 64 Million cells, it will be created only in memory, + and a Save method should be called when ready to save it to a file. Otherwise, it creates a blank file with + NoData values...which start out as 0. + </summary> + <param name="fileName">The fileName to write to</param> + <param name="numRows">Integer number of rows</param> + <param name="numColumns">Integer number of columns</param> + </member> + <member name="M:DotSpatial.Data.BinaryRaster`1.#ctor(System.String,System.Int32,System.Int32,System.Boolean)"> + <summary> + Creates a new BinaryRaster with the specified rows and columns. + If inRam is true and the raster is less than 64 Million cells, it will be created only in memory, + and a Save method should be called when ready to save it to a file. Otherwise, it creates a blank file with + NoData values. + </summary> + <param name="fileName">The fileName to write to</param> + <param name="numRows">Integer number of rows</param> + <param name="numColumns">Integer number of columns</param> + <param name="inRam">If this is true and the raster is small enough, it will load this into memory and not save anything to the file.</param> + </member> + <member name="M:DotSpatial.Data.BinaryRaster`1.Copy(System.String,System.Boolean)"> + <summary> + Creates a duplicate version of this file. If copyValues is set to false, then a raster of NoData values is created + that has the same georeferencing information as the source file of this Raster, even if this raster is just a window. + If the specified fileName exists, rather than throwing an exception or taking an "overwrite" parameter, this + will throw the FileExists event, and cancel the copy if the cancel argument is set to true. + </summary> + <param name="fileName">The string fileName specifying where to create the new file.</param> + <param name="copyValues">If this is false, the same size and georeferencing values are used, but they are all set to NoData.</param> + </member> + <member name="M:DotSpatial.Data.BinaryRaster`1.CopyWindow(System.String,System.Int32,System.Int32,System.Int32,System.Int32,System.Boolean,System.Boolean)"> + <summary> + This creates a completely new raster from the windowed domain on the original raster. This new raster + will have a separate source file, and values like NumRowsInFile will correspond to the newly created file. + All the values will be copied to the new source file. If inRam = true and the new raster is small enough, + the raster values will be loaded into memory. + </summary> + <param name="fileName"></param> + <param name="startRow">The 0 based integer index of the top row to copy from this raster. If this raster is itself a window, 0 represents the startRow from the file.</param> + <param name="endRow">The integer index of the bottom row to copy from this raster. The largest allowed value is NumRows - 1.</param> + <param name="startColumn">The 0 based integer index of the leftmost column to copy from this raster. If this raster is a window, 0 represents the startColumn from the file.</param> + <param name="endColumn">The 0 based integer index of the rightmost column to copy from this raster. The largest allowed value is NumColumns - 1</param> + <param name="copyValues">If this is true, the values are saved to the file. If this is false and the data can be loaded into Ram, no file handling is done. Otherwise, a file of NoData values is created.</param> + <param name="inRam">Boolean. If this is true and the window is small enough, a copy of the values will be loaded into memory.</param> + <returns>An implementation of IRaster</returns> + </member> + <member name="M:DotSpatial.Data.BinaryRaster`1.GetStatistics"> + <summary> + Gets the statistics for the entire file, not just the window portion specified for this raster. + </summary> + </member> + <member name="M:DotSpatial.Data.BinaryRaster`1.GetWindow(System.Int32,System.Int32,System.Int32,System.Int32,System.Boolean)"> + <summary> + This creates a window from this raster. The window will still save to the same + source file, but only has access to a small window of data, so it can be loaded like a buffer. + The georeferenced extents will be for the new window, not the original raster. startRow and endRow + will exist in the new raster, however, so that it knows how to copy values back to the original raster. + </summary> + <param name="startRow">The 0 based integer index of the top row to get from this raster. If this raster is itself a window, 0 represents the startRow from the file.</param> + <param name="endRow">The integer index of the bottom row to get from this raster. The largest allowed value is NumRows - 1.</param> + <param name="startColumn">The 0 based integer index of the leftmost column to get from this raster. If this raster is a window, 0 represents the startColumn from the file.</param> + <param name="endColumn">The 0 based integer index of the rightmost column to get from this raster. The largest allowed value is NumColumns - 1</param> + <param name="inRam">Boolean. If this is true and the window is small enough, a copy of the values will be loaded into memory.</param> + <returns>An implementation of IRaster</returns> + </member> + <member name="M:DotSpatial.Data.BinaryRaster`1.GetWindowStatistics"> + <summary> + Obtains only the statistics for the small window specified by startRow, endRow etc. + </summary> + </member> + <member name="M:DotSpatial.Data.BinaryRaster`1.Open"> + <summary> + Opens the specified file into this raster. + </summary> + </member> + <member name="M:DotSpatial.Data.BinaryRaster`1.Open(System.String,System.Boolean)"> + <summary> + Opens a new instance of the BinaryRaster + </summary> + <param name="fileName">The string fileName of the raster file to open</param> + <param name="inRam">Boolean, indicates whether or not the values for the raster should be loaded into memory</param> + </member> + <member name="M:DotSpatial.Data.BinaryRaster`1.OpenWindow(System.String,System.Int32,System.Int32,System.Int32,System.Int32,System.Boolean)"> + <summary> + This converts this object into a raster defined by the specified window dimensions. + </summary> + <param name="fileName">The string fileName to open</param> + <param name="startRow">The integer row index to become the first row to load into this raster.</param> + <param name="endRow">The 0 based integer row index to become the last row included in this raster.</param> + <param name="startColumn">The 0 based integer column index for the first column of the raster.</param> + <param name="endColumn">The 0 based integer column index for the last column to include in this raster.</param> + <param name="inRam">Boolean. If this is true and the window is small enough, this will load the window into ram.</param> + </member> + <member name="M:DotSpatial.Data.BinaryRaster`1.PasteRaster(DotSpatial.Data.Raster{`0},System.Int32,System.Int32)"> + <summary> + Copies the contents from the specified sourceRaster into this sourceRaster. If both rasters are InRam, this does not affect the files. + </summary> + <param name="sourceRaster">The raster of values to paste into this raster. If the CellWidth and CellHeight values do not match between the files, + an exception will be thrown. If the sourceRaster overlaps with the edge of this raster, only the intersecting region will be + pasted.</param> + <param name="startRow">Specifies the row in this raster where the top row of the sourceRaster will be pasted </param> + <param name="startColumn">Specifies the column in this raster where the left column of the sourceRaster will be pasted.</param> + </member> + <member name="M:DotSpatial.Data.BinaryRaster`1.Read"> + <summary> + Reads the the contents for the "window" specified by the start and end values + for the rows and columns. + </summary> + </member> + <member name="M:DotSpatial.Data.BinaryRaster`1.ReadHeader(System.String)"> + <summary> + Writes the header, regardless of which subtype of binary raster this is written for + </summary> + <param name="fileName">The string fileName specifying what file to load</param> + </member> + <member name="M:DotSpatial.Data.BinaryRaster`1.WriteHeader(System.String)"> + <summary> + The string fileName where this will begin to write data by clearing the existing file + </summary> + <param name="fileName">a fileName to write data to</param> + </member> + <member name="M:DotSpatial.Data.BinaryRaster`1.WriteValue(System.Int32,System.Int32,System.Int32)"> + <summary> + This would be a horrible choice for any kind of serious process, but is provided as + a way to write values directly to the file. + </summary> + <param name="row">The 0 based integer row index for the file to write to.</param> + <param name="column">The 0 based column index for the file to write to.</param> + <param name="value">The actual value to write.</param> + </member> + <member name="M:DotSpatial.Data.BinaryRaster`1.Save"> + <summary> + Saves the values in memory to the disk. + </summary> + </member> + <member name="M:DotSpatial.Data.BinaryRaster`1.Write(System.String)"> + <summary> + If no file exists, this writes the header and no-data values. If a file exists, it will assume + that data already has been filled in the file and will attempt to insert the data values + as a window into the file. If you want to create a copy of the file and values, just use + System.IO.File.Copy, it almost certainly would be much more optimized. + </summary> + <param name="fileName">The string fileName to write values to.</param> + </member> + <member name="P:DotSpatial.Data.BinaryRaster`1.ByteSize"> + <summary> + Returns the size of T in bytes. This should be overridden, but + exists as a "just-in-case" implementation that works for structs, + but definitely won't work correctly for objects. + </summary> + </member> + <member name="P:DotSpatial.Data.BinaryRaster`1.FileType"> + <summary> + All the binary rasters use the Binary file type + </summary> + </member> + <member name="P:DotSpatial.Data.BinaryRaster`1.NumBands"> + <summary> + This is always 1 band + </summary> + </member> + <member name="P:DotSpatial.Data.BinaryRaster`1.HeaderSize"> + <summary> + Gets the size of the header. There is one no-data value in the header. + </summary> + </member> + <member name="T:DotSpatial.Data.RasterEnumerator`1"> + <summary> + RasterEnumerator + </summary> + </member> + <member name="M:DotSpatial.Data.RasterEnumerator`1.#ctor(System.Collections.Generic.List{DotSpatial.Data.Raster{`0}})"> + <summary> + Creates a new instance of RasterEnumerator + </summary> + <param name="list">The list to build an enumarator for</param> + </member> + <member name="M:DotSpatial.Data.RasterEnumerator`1.Dispose"> + <summary> + Disposes any unmanaged memory objects + </summary> + </member> + <member name="M:DotSpatial.Data.RasterEnumerator`1.MoveNext"> + <summary> + Advances the enumerator to the next member. + </summary> + <returns>A boolean which is false if there are no more members in the list.</returns> + </member> + <member name="M:DotSpatial.Data.RasterEnumerator`1.Reset"> + <summary> + Resets the enumerator to the position before the start of the list. + </summary> + </member> + <member name="P:DotSpatial.Data.RasterEnumerator`1.Current"> + <summary> + Retrieves the current IntRaster from this calculator. + </summary> + </member> + <member name="T:DotSpatial.Data.IRasterBounds"> + <summary> + IRasterBounds + </summary> + </member> + <member name="M:DotSpatial.Data.IRasterBounds.Copy"> + <summary> + Returns a deep copy of this raster bounds object. + </summary> + <returns>An IRasterBounds interface.</returns> + </member> + <member name="M:DotSpatial.Data.IRasterBounds.Open(System.String)"> + <summary> + This is the overridable open method that should be used. + The OpenWorldFile method is called by our RasterBounds class, + but this allows custom files to be loaded and saved. + </summary> + </member> + <member name="M:DotSpatial.Data.IRasterBounds.Save"> + <summary> + This is the overridable save method that should be used. + The OpenWorldFile method is called by our RasterBounds class, + but this allows custom files to be loaded and saved. + </summary> + </member> + <member name="P:DotSpatial.Data.IRasterBounds.AffineCoefficients"> + <summary> + Gets or sets the double affine coefficients that control the world-file + positioning of this image. X' and Y' are real world coords. + X' = [0] + [1] * Column + [2] * Row + Y' = [3] + [4] * Column + [5] * Row + </summary> + </member> + <member name="P:DotSpatial.Data.IRasterBounds.CellWidth"> + <summary> + Gets or sets the desired width per cell. This will keep the skew the same, but + will adjust both the column based and row based width coefficients in order + to match the specified cell width. This can be thought of as the width + of a bounding box that contains an entire grid cell, no matter if it is skewed. + </summary> + </member> + <member name="P:DotSpatial.Data.IRasterBounds.CellHeight"> + <summary> + Gets or sets the desired height per cell. This will keep the skew the same, but + will adjust both the column based and row based height coefficients in order + to match the specified cell height. This can be thought of as the height + of a bounding box that contains an entire grid cell, no matter if it is skewed. + </summary> + </member> + <member name="P:DotSpatial.Data.IRasterBounds.Extent"> + <summary> + Gets or sets the rectangular confines for this envelope. The skew will remain + the same when setting this, but the image will be translated and stretched + to fit in the specified envelope. + </summary> + </member> + <member name="P:DotSpatial.Data.IRasterBounds.NumRows"> + <summary> + Gets the number of rows in the raster. + </summary> + </member> + <member name="P:DotSpatial.Data.IRasterBounds.NumColumns"> + <summary> + Gets the number of columns in the raster. + </summary> + </member> + <member name="P:DotSpatial.Data.IRasterBounds.WorldFile"> + <summary> + Gets or sets the world file name. This won't do anything until the "Load" or "Save" methods are called. + </summary> + </member> + <member name="T:DotSpatial.Data.IValueRow"> + <summary> + A public interface definition for a single row of values that should be supported + by any of the generic data row types. + </summary> + </member> + <member name="P:DotSpatial.Data.IValueRow.Item(System.Int32)"> + <summary> + Gets or sets the value in the position of column. + </summary> + <param name="cell">The 0 based integer column index to access on this row.</param> + <returns>An object reference to the actual data value, which can be many types.</returns> + </member> + <member name="T:DotSpatial.Data.RasterBounds"> + <summary> + RasterBounds + </summary> + </member> + <member name="M:DotSpatial.Data.RasterBounds.#ctor"> + <summary> + Creates a new RasterBounds + </summary> + </member> + <member name="M:DotSpatial.Data.RasterBounds.#ctor(System.Int32,System.Int32,System.String)"> + <summary> + Attempts to read the very simple 6 number world file associated with an image + </summary> + <param name="numRows">The number of rows in this raster</param> + <param name="numColumns">The number of columns in this raster</param> + <param name="worldFileName">A world file to attempt to read</param> + </member> + <member name="M:DotSpatial.Data.RasterBounds.#ctor(System.Int32,System.Int32,System.Double[])"> + <summary> + Creates a new instance of the RasterBounds class + </summary> + <param name="numRows">The number of rows for this raster</param> + <param name="numColumns">The number of columns for this raster</param> + <param name="affineCoefficients">The affine coefficients describing the location of this raster.</param> + </member> + <member name="M:DotSpatial.Data.RasterBounds.#ctor(System.Int32,System.Int32,DotSpatial.Data.Extent)"> + <summary> + Creates a new raster bounds that is georeferenced to the specified envelope. + </summary> + <param name="numRows">The number of rows</param> + <param name="numColumns">The number of columns</param> + <param name="bounds">The bounding envelope</param> + </member> + <member name="M:DotSpatial.Data.RasterBounds.Open(System.String)"> + <summary> + Attempts to load the data from the file listed in WorldFile + </summary> + </member> + <member name="M:DotSpatial.Data.RasterBounds.Save"> + <summary> + Attempts to save the data to the file listed in WorldFile + </summary> + </member> + <member name="M:DotSpatial.Data.RasterBounds.Clone"> + <summary> + Returns a duplicate of this object as an object. + </summary> + <returns>A duplicate of this object as an object.</returns> + </member> + <member name="M:DotSpatial.Data.RasterBounds.Copy"> + <summary> + Creates a duplicate of this RasterBounds class. + </summary> + <returns>A RasterBounds that has the same properties but does not point to the same internal array.</returns> + </member> + <member name="P:DotSpatial.Data.RasterBounds.AffineCoefficients"> + <summary> + Gets or sets the double affine coefficients that control the world-file + positioning of this image. X' and Y' are real world coords. + X' = [0] + [1] * Column + [2] * Row + Y' = [3] + [4] * Column + [5] * Row + </summary> + </member> + <member name="P:DotSpatial.Data.RasterBounds.CellWidth"> + <summary> + Gets or sets the desired width per cell. This will keep the skew the same, but + will adjust both the column based and row based width coefficients in order + to match the specified cell width. This can be thought of as the width + of a bounding box that contains an entire grid cell, no matter if it is skewed. + </summary> + </member> + <member name="P:DotSpatial.Data.RasterBounds.CellHeight"> + <summary> + Gets or sets the desired height per cell. This will keep the skew the same, but + will adjust both the column based and row based height coefficients in order + to match the specified cell height. This can be thought of as the height + of a bounding box that contains an entire grid cell, no matter if it is skewed. + </summary> + </member> + <member name="P:DotSpatial.Data.RasterBounds.Extent"> + <summary> + Gets or sets the rectangular bounding box for this raster. + </summary> + </member> + <member name="P:DotSpatial.Data.RasterBounds.Height"> + <summary> + Gets or sets the height of the entire bounds. This is derived by considering both the + column and row based contributions to the overall height. Changing this will keep + the skew ratio the same, but adjust both portions so that the overall height + will match the specified height. + </summary> + </member> + <member name="P:DotSpatial.Data.RasterBounds.NumRows"> + <summary> + Gets the number of rows in the raster. + </summary> + </member> + <member name="P:DotSpatial.Data.RasterBounds.NumColumns"> + <summary> + Gets the number of columns in the raster. + </summary> + </member> + <member name="P:DotSpatial.Data.RasterBounds.Width"> + <summary> + Gets or sets the geographic width of this raster. This will include the skew term + in the width estimate, so it will adjust both the width and the skew coefficient, + but preserve the ratio of skew to cell width. + </summary> + </member> + <member name="P:DotSpatial.Data.RasterBounds.WorldFile"> + <summary> + Gets or sets the fileName of the wordfile that describes the geographic coordinates of this raster. + </summary> + </member> + <member name="P:DotSpatial.Data.RasterBounds.X"> + <summary> + Gets or sets the horizontal placement of the upper left corner of this bounds. Because + of the skew, this upper left position may not actually be the same as the upper left + corner of the image itself (_affine[0]). Instead, this is the top left corner of + the rectangular extent for this raster. + </summary> + </member> + <member name="P:DotSpatial.Data.RasterBounds.Y"> + <summary> + Gets or sets the vertical placement of the upper left corner of this bounds, which is the + same as the top. The top left corner of the actual image may not be in this position + because of skew, but this represents the maximum Y value of the rectangular extents + that contains the image. + </summary> + </member> + <member name="T:DotSpatial.Data.RasterDataType"> + <summary> + Data types specific to grids + </summary> + </member> + <member name="F:DotSpatial.Data.RasterDataType.INVALID"> + <summary> + An invalid data type + </summary> + </member> + <member name="F:DotSpatial.Data.RasterDataType.SHORT"> + <summary> + Short 16 Bit integers + </summary> + </member> + <member name="F:DotSpatial.Data.RasterDataType.INTEGER"> + <summary> + 32 Bit Integers (old style long) + </summary> + </member> + <member name="F:DotSpatial.Data.RasterDataType.SINGLE"> + <summary> + Float or Single + </summary> + </member> + <member name="F:DotSpatial.Data.RasterDataType.DOUBLE"> + <summary> + Double + </summary> + </member> + <member name="F:DotSpatial.Data.RasterDataType.UNKNOWN"> + <summary> + Unknown + </summary> + </member> + <member name="F:DotSpatial.Data.RasterDataType.BYTE"> + <summary> + Byte + </summary> + </member> + <member name="F:DotSpatial.Data.RasterDataType.CUSTOM"> + <summary> + Specified as the CustomType string + </summary> + </member> + <member name="F:DotSpatial.Data.RasterDataType.LONG"> + <summary> + Signed 64 Bit Integers + </summary> + </member> + <member name="F:DotSpatial.Data.RasterDataType.USHORT"> + <summary> + Unsigned short 16 Bit Integers + </summary> + </member> + <member name="F:DotSpatial.Data.RasterDataType.UINTEGER"> + <summary> + Unsigned 32 Bit Integers + </summary> + </member> + <member name="F:DotSpatial.Data.RasterDataType.ULONG"> + <summary> + Unsigned 64 Bit Integers + </summary> + </member> + <member name="F:DotSpatial.Data.RasterDataType.SBYTE"> + <summary> + Signed 8-bit Integers: -128 to 127 + </summary> + </member> + <member name="F:DotSpatial.Data.RasterDataType.BOOL"> + <summary> + Booleans: True(1) or False(0). + </summary> + </member> + <member name="T:DotSpatial.Data.RasterFileType"> + <summary> + RasterFileTypes + </summary> + </member> + <member name="F:DotSpatial.Data.RasterFileType.ASCII"> + <summary> + Ascii + </summary> + </member> + <member name="F:DotSpatial.Data.RasterFileType.BIL"> + <summary> + Binary interlaced Layers + </summary> + </member> + <member name="F:DotSpatial.Data.RasterFileType.BINARY"> + <summary> + BGD (Original DotSpatial format) + </summary> + </member> + <member name="F:DotSpatial.Data.RasterFileType.DTED"> + <summary> + DTED + </summary> + </member> + <member name="F:DotSpatial.Data.RasterFileType.ECW"> + <summary> + Wavelet format + </summary> + </member> + <member name="F:DotSpatial.Data.RasterFileType.ESRI"> + <summary> + ArcGIS format + </summary> + </member> + <member name="F:DotSpatial.Data.RasterFileType.FLT"> + <summary> + FLT + </summary> + </member> + <member name="F:DotSpatial.Data.RasterFileType.GeoTiff"> + <summary> + GeoTiff + </summary> + </member> + <member name="F:DotSpatial.Data.RasterFileType.MrSID"> + <summary> + SID + </summary> + </member> + <member name="F:DotSpatial.Data.RasterFileType.PAUX"> + <summary> + AUX + </summary> + </member> + <member name="F:DotSpatial.Data.RasterFileType.PCIDsk"> + <summary> + PCIDsk + </summary> + </member> + <member name="F:DotSpatial.Data.RasterFileType.SDTS"> + <summary> + SDTS + </summary> + </member> + <member name="F:DotSpatial.Data.RasterFileType.CUSTOM"> + <summary> + Custom - specified as string + </summary> + </member> + <member name="T:DotSpatial.Data.RcIndex"> + <summary> + A Row, Column indexer for some return types. + </summary> + </member> + <member name="F:DotSpatial.Data.RcIndex.Column"> + <summary> + The zero based integer column index + </summary> + </member> + <member name="F:DotSpatial.Data.RcIndex.Row"> + <summary> + The zero based integer row index + </summary> + </member> + <member name="M:DotSpatial.Data.RcIndex.#ctor(System.Int32,System.Int32)"> + <summary> + Creates a new RcIndex structure with the specified coordinates + </summary> + <param name="row">The integer row index</param> + <param name="column">The integer column index</param> + </member> + <member name="M:DotSpatial.Data.RcIndex.IsEmpty"> + <summary> + Gets a boolean that is true if either row or column index has no value + </summary> + <returns>Boolean, true if either row or column has no value</returns> + </member> + <member name="M:DotSpatial.Data.RcIndex.op_Equality(DotSpatial.Data.RcIndex,DotSpatial.Data.RcIndex)"> + <summary> + Implements the operator ==. + </summary> + <param name="a">A.</param> + <param name="b">The b.</param> + <returns> + The result of the operator. + </returns> + </member> + <member name="M:DotSpatial.Data.RcIndex.op_Inequality(DotSpatial.Data.RcIndex,DotSpatial.Data.RcIndex)"> + <summary> + Implements the operator !=. + </summary> + <param name="a">A.</param> + <param name="b">The b.</param> + <returns> + The result of the operator. + </returns> + </member> + <member name="P:DotSpatial.Data.RcIndex.Empty"> + <summary> + Returns a new RcIndex that is defined as empty when both indices are int. + </summary> + </member> + <member name="M:DotSpatial.Data.Smoother.#ctor(System.Int32,System.Int32,System.Int32,System.Byte[],DotSpatial.Data.IProgressHandler)"> + <summary> + Creates a new instance of Smoother + </summary> + </member> + <member name="M:DotSpatial.Data.Smoother.#ctor(System.Int32,System.Int32,System.Int32,System.IntPtr,DotSpatial.Data.IProgressHandler)"> + <summary> + Creates a new instance of Smoother with IntPtr for input array + </summary> + </member> + <member name="M:DotSpatial.Data.Smoother.Smooth"> + <summary> + Calculates the smoothing by cycling through the values + </summary> + </member> + <member name="T:DotSpatial.Data.ScaleBarInfo"> + <summary> + ScaleBarInfo + </summary> + </member> + <member name="P:DotSpatial.Data.ScaleBarInfo.BackColor"> + <summary> + Gets or sets the backcolor + </summary> + </member> + <member name="P:DotSpatial.Data.ScaleBarInfo.ForeColor"> + <summary> + Gets or sets the forecolor + </summary> + </member> + <member name="P:DotSpatial.Data.ScaleBarInfo.Position"> + <summary> + Gets or sets what position that the scalebar should load in + </summary> + </member> + <member name="P:DotSpatial.Data.ScaleBarInfo.Unit"> + <summary> + Gets or sets the unit for the scalebar. + </summary> + </member> + <member name="P:DotSpatial.Data.ScaleBarInfo.Visible"> + <summary> + Gets or sets whether to show the scale bar. + </summary> + </member> + <member name="T:DotSpatial.Data.ScaleBarPosition"> + <summary> + ScaleBarPositions + </summary> + </member> + <member name="F:DotSpatial.Data.ScaleBarPosition.LowerLeft"> + <summary> + The scalebar should appear in the lower left corner + </summary> + </member> + <member name="F:DotSpatial.Data.ScaleBarPosition.LowerRight"> + <summary> + The scalebar should appear in the lower right corner + </summary> + </member> + <member name="F:DotSpatial.Data.ScaleBarPosition.UpperLeft"> + <summary> + The scalebar should appear in the upper left corner + </summary> + </member> + <member name="F:DotSpatial.Data.ScaleBarPosition.UpperRight"> + <summary> + The scalebar should apepar int eh upper right corner + </summary> + </member> + <member name="T:DotSpatial.Data.SpaceTimeSupport"> + <summary> + SpaceTimeSupport + </summary> + </member> + <member name="F:DotSpatial.Data.SpaceTimeSupport.Spatial"> + <summary> + Spatial (X, Y, Z or M information only) + </summary> + </member> + <member name="F:DotSpatial.Data.SpaceTimeSupport.Temporal"> + <summary> + Temporal (time information only) + </summary> + </member> + <member name="F:DotSpatial.Data.SpaceTimeSupport.SpatioTemporal"> + <summary> + SpatioTemporal (time and space information) + </summary> + </member> + <member name="F:DotSpatial.Data.SpaceTimeSupport.Other"> + <summary> + Other (no temporal or spatial information) + </summary> + </member> + <member name="T:DotSpatial.Data.StatusBarInfo"> + <summary> + StatusBarInfo + </summary> + </member> + <member name="P:DotSpatial.Data.StatusBarInfo.Alternate"> + <summary> + Gets or sets the alternate string to show in the event that GetFromProjection is false. + </summary> + </member> + <member name="P:DotSpatial.Data.StatusBarInfo.GetFromProjection"> + <summary> + Gets or sets a boolean indicating whether or not status bar coordinates should display the unites derived from the projection string. + </summary> + </member> + <member name="T:DotSpatial.Data.StreamExt"> + <summary> + Stream extensions + </summary> + </member> + <member name="M:DotSpatial.Data.StreamExt.ReadBytes(System.IO.Stream,System.Int32)"> + <summary> + Attempts to read count of bytes from stream. + </summary> + <param name="stream">Input stream.</param> + <param name="count">Count of bytes.</param> + <returns>Bytes array.</returns> + </member> + <member name="M:DotSpatial.Data.StreamExt.ReadInt32(System.IO.Stream,DotSpatial.Data.Endian)"> + <summary> + Attempts to read the specified T. If this system is + doesn't match the specified endian, then this will reverse the array of bytes, + so that it corresponds with the big-endian format. + </summary> + <param name="stream">The stream to read the value from</param> + <param name="endian">Specifies what endian property should be used.</param> + <returns>The integer value</returns> + </member> + <member name="M:DotSpatial.Data.StreamExt.ReadInt32(System.IO.Stream,System.Int32,DotSpatial.Data.Endian)"> + <summary> + Reads the specified number of integers. If a value other than the + systems endian format is specified the values will be reversed. + </summary> + <param name="stream">The stream to read from</param> + <param name="count">The integer count of integers to read</param> + <param name="endian">The endian order of the bytes.</param> + <returns>The array of integers that will have count integers.</returns> + </member> + <member name="M:DotSpatial.Data.StreamExt.ReadDouble(System.IO.Stream)"> + <summary> + Reads a double precision value from the stream. If this system + is not little endian, it will reverse the individual memebrs. + </summary> + <param name="stream">The stream to read the values from.</param> + <returns>A double precision value</returns> + </member> + <member name="M:DotSpatial.Data.StreamExt.ReadDouble(System.IO.Stream,System.Int32,DotSpatial.Data.Endian)"> + <summary> + Reads the specified number of double precision values. If this system + does not match the specified endian, the bytes will be reversed. + </summary> + <param name="stream">The stream to read the values from.</param> + <param name="count">The integer count of doubles to read.</param> + <param name="endian">The endian to use.</param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.StreamExt.WriteBe(System.IO.Stream,System.Int32)"> + <summary> + Writes the integer as big endian + </summary> + <param name="stream">The IO stream </param> + <param name="value"></param> + </member> + <member name="M:DotSpatial.Data.StreamExt.WriteLe(System.IO.Stream,System.Int32)"> + <summary> + Writes the endian as little endian + </summary> + <param name="stream"></param> + <param name="value"></param> + </member> + <member name="M:DotSpatial.Data.StreamExt.WriteLe(System.IO.Stream,System.Int32[],System.Int32,System.Int32)"> + <summary> + Checks that the endian order is ok for integers and then writes + the entire array to the stream. + </summary> + <param name="stream"></param> + <param name="values"></param> + <param name="startIndex"></param> + <param name="count"></param> + </member> + <member name="M:DotSpatial.Data.StreamExt.WriteLe(System.IO.Stream,System.Double)"> + <summary> + Writes the specified double value to the stream as little endian + </summary> + <param name="stream"></param> + <param name="value"></param> + </member> + <member name="M:DotSpatial.Data.StreamExt.WriteLe(System.IO.Stream,System.Double[],System.Int32,System.Int32)"> + <summary> + Checks that the endian order is ok for doubles and then writes + the entire array to the stream. + </summary> + <param name="stream">The stream to write to</param> + <param name="values">The double values to write in little endian form</param> + <param name="startIndex">The integer start index in the double array to begin writing</param> + <param name="count">The integer count of doubles to write.</param> + </member> + <member name="T:DotSpatial.Data.ByteBlock"> + <summary> + ByteBlock + </summary> + </member> + <member name="F:DotSpatial.Data.ByteBlock.BlockSize"> + <summary> + The block size of the arrays + </summary> + </member> + <member name="F:DotSpatial.Data.ByteBlock.Blocks"> + <summary> + All the blocks + </summary> + </member> + <member name="F:DotSpatial.Data.ByteBlock.CurrentBlock"> + <summary> + The current block index + </summary> + </member> + <member name="F:DotSpatial.Data.ByteBlock.Offset"> + <summary> + The offset + </summary> + </member> + <member name="M:DotSpatial.Data.ByteBlock.#ctor(System.Int32)"> + <summary> + Creates a new instance of ByteBlock + </summary> + </member> + <member name="M:DotSpatial.Data.ByteBlock.Read(System.Int32,System.IO.Stream)"> + <summary> + Reads the number of bytes using the specified reader. + This handles copying across blocks if necessary. + </summary> + <param name="numBytes">The integer number of bytes to read</param> + <param name="stream">The file or data stream to read from.</param> + </member> + <member name="M:DotSpatial.Data.ByteBlock.Read(System.Int32,DotSpatial.Data.BufferedBinaryReader)"> + <summary> + Reads the number of bytes using the specified reader. + This handles copying across blocks if necessary. + </summary> + <param name="numBytes"></param> + <param name="reader"></param> + </member> + <member name="M:DotSpatial.Data.ByteBlock.IntOffset"> + <summary> + If the bytes were converted to a single, contiguous integer array, this returns + the current offset in that array. + </summary> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.ByteBlock.DoubleOffset"> + <summary> + If the bytes were converted to a single contiguous double array, this returns + the offset in that array. + </summary> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.ByteBlock.Reset"> + <summary> + Resets the indices + </summary> + </member> + <member name="M:DotSpatial.Data.ByteBlock.ToIntArray"> + <summary> + Combines all the blocks into a single array of the specified datatype + </summary> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.ByteBlock.ToDoubleArray"> + <summary> + Combines all the blocks into a single array of the specified datatype + </summary> + <returns></returns> + </member> + <member name="T:DotSpatial.Data.Feature"> + <summary> + A generic vector feature that has the geometry and data components but no drawing information + </summary> + </member> + <member name="T:DotSpatial.Data.IFeature"> + <summary> + A feature doesn't need to be abstract because the geometry is generic and the other + properties are all the same. It supports IRenderable so that even if you don't + know what type of feature this is, you can still tell it to draw itself. You won't + be able to specify any drawing characteristics from this object however. + </summary> + </member> + <member name="M:DotSpatial.Data.IFeature.Copy"> + <summary> + Creates a deep copy of this feature. the new datarow created will not be connected + to a data Table, so it should be added to one. + </summary> + <returns>Returns a deep copy of this feature as an IFeature</returns> + </member> + <member name="M:DotSpatial.Data.IFeature.ToShape"> + <summary> + Creates a new shape based on this feature by itself. + </summary> + <returns>A Shape object</returns> + </member> + <member name="M:DotSpatial.Data.IFeature.CopyAttributes(DotSpatial.Data.IFeature)"> + <summary> + This uses the field names to copy attribute values from the source to this feature. + Even if columns are missing or if there are extra columns, this method should work. + </summary> + <param name="source">The IFeature source to copy attributes from.</param> + </member> + <member name="P:DotSpatial.Data.IFeature.DataRow"> + <summary> + Gets the datarow containing all the attributes related to this geometry + </summary> + </member> + <member name="P:DotSpatial.Data.IFeature.BasicGeometry"> + <summary> + Gets or sets a valid IBasicGeometry associated with the data elements of this feature. + This will be enough geometry information to cast into a full fledged geometry + that can be used in coordination with DotSpatial.Analysis + </summary> + </member> + <member name="P:DotSpatial.Data.IFeature.ContentLength"> + <summary> + Gets or sets the content length. If the geometry for this shape was loaded from a file, this contains the size + of this shape in 16-bit words as per the Esri Shapefile specification. + </summary> + </member> + <member name="P:DotSpatial.Data.IFeature.EnvelopeSource"> + <summary> + Gets or sets a DotSpatial.Data.CacheTypes enumeration specifying whether the Envelope property + returns a cached value in this object or is retrieved directly from the geometry. The + initial case for Shapefiles is to use a cache. Setting the envelope assumes that you + are going to use a cached value and will set this to Cached. Setting this to Dynamic + will cause the Envelope property to reference the geometry. + </summary> + </member> + <member name="P:DotSpatial.Data.IFeature.Fid"> + <summary> + Gets the key that is associated with this feature. This returns -1 if + this feature is not a member of a feature layer. + </summary> + </member> + <member name="P:DotSpatial.Data.IFeature.ParentFeatureSet"> + <summary> + Gets a reference to the IFeatureLayer that contains this item. + </summary> + </member> + <member name="P:DotSpatial.Data.IFeature.RecordNumber"> + <summary> + An index value that is saved in some file formats. + </summary> + </member> + <member name="P:DotSpatial.Data.IFeature.ShapeType"> + <summary> + When a shape is loaded from a Shapefile, this will identify whether M or Z values are used + and whether or not the shape is null. + </summary> + </member> + <member name="P:DotSpatial.Data.IFeature.ShapeIndex"> + <summary> + This is simply a quick access to the Vertices list for this specific + feature. If the Vertices have not yet been defined, this will be null. + </summary> + </member> + <member name="F:DotSpatial.Data.Feature.ComparisonField"> + <summary> + Gets or sets the column to use when sorting lists of features. + If this is set to a column not in the field, the FID is used instead. + This should be assigned before attempting to sort features. Because + this is static, it only has to be set once, and will affect + all the individual comparisions until it is set differently. + </summary> + </member> + <member name="M:DotSpatial.Data.Feature.#ctor(DotSpatial.Data.Shape)"> + <summary> + Creates a feature from the specified shape. This will not handle the attribute content, + which should be handles separately, with full knowledge of the desired schema. + </summary> + <param name="shape">The shape to read the vertices from in order to build a proper geometry.</param> + </member> + <member name="M:DotSpatial.Data.Feature.#ctor(DotSpatial.Data.Vertex)"> + <summary> + Creates a complete geometric feature based on a single point. The attribute datarow is null. + </summary> + <param name="point">The vertex</param> + </member> + <member name="M:DotSpatial.Data.Feature.#ctor(DotSpatial.Topology.Coordinate)"> + <summary> + Creates a single point feature from a new point. + </summary> + <param name="c"></param> + </member> + <member name="M:DotSpatial.Data.Feature.#ctor(DotSpatial.Topology.IBasicGeometry)"> + <summary> + Creates a feature from a geometry + </summary> + <param name="geometry">The geometry to turn into a feature</param> + </member> + <member name="M:DotSpatial.Data.Feature.#ctor(DotSpatial.Topology.IBasicGeometry,DotSpatial.Data.IFeatureSet)"> + <summary> + This constructor allows the creation of a feature but will automatically + add the feature to the parent featureset. + </summary> + <param name="geometry">The IBasicGeometry to use for this feature</param> + <param name="parent">The IFeatureSet to add this feature to.</param> + </member> + <member name="M:DotSpatial.Data.Feature.#ctor"> + <summary> + Constructs a new Feature + </summary> + </member> + <member name="M:DotSpatial.Data.Feature.#ctor(DotSpatial.Topology.FeatureType,System.Collections.Generic.IEnumerable{DotSpatial.Topology.Coordinate})"> + <summary> + Creates a new instance of a feature, by specifying the feature type enumeration and a + set of coordinates that can be either a list or an array as long as it is enumerable. + </summary> + <param name="featureType">The feature type</param> + <param name="coordinates">The coordinates to pass</param> + </member> + <member name="M:DotSpatial.Data.Feature.System#IComparable{DotSpatial#Data#IFeature}#CompareTo(DotSpatial.Data.IFeature)"> + <summary> + The FID comparison will be very slow, so this should only be used + if the ComparisonField property is set. This will allow sorting + features based on their data-row attributes. The data rows + do not have to be identical, as long as both contain a column + with the comparison field. + </summary> + <param name="other">The other IFeature to compare to.</param> + <returns>An integer that controls the sorting based on the values for the specified field name.</returns> + </member> + <member name="M:DotSpatial.Data.Feature.GetBasicGeometryN(System.Int32)"> + <summary> + This returns itself as the first geometry + </summary> + <returns>An IBasicGeometry interface</returns> + <exception cref="T:System.IndexOutOfRangeException">Index cannot be less than 0 or greater than 1</exception> + </member> + <member name="M:DotSpatial.Data.Feature.PointInList(DotSpatial.Topology.Coordinate,System.Collections.Generic.IEnumerable{DotSpatial.Topology.Coordinate})"> + <summary> + Test if a point is in a list of coordinates. + </summary> + <param name="testPoint">TestPoint the point to test for.</param> + <param name="pointList">PointList the list of points to look through.</param> + <returns>true if testPoint is a point in the pointList list.</returns> + </member> + <member name="M:DotSpatial.Data.Feature.DotSpatial#Data#IFeature#Copy"> + <summary> + Creates a deep copy of this feature. + </summary> + <returns>Returns a deep copy of this feature as an IFeature</returns> + </member> + <member name="M:DotSpatial.Data.Feature.CopyAttributes(DotSpatial.Data.IFeature)"> + <summary> + This uses the field names to copy attribute values from the source to this feature. + Even if columns are missing or if there are extra columns, this method should work. + </summary> + <param name="source">The IFeature source to copy attributes from.</param> + </member> + <member name="M:DotSpatial.Data.Feature.System#ICloneable#Clone"> + <summary> + Creates a deep copy of this feature. + </summary> + <returns>Returns a deep copy of this feature as an object</returns> + </member> + <member name="M:DotSpatial.Data.Feature.UpdateEnvelope"> + <summary> + Forces the geometry to update its envelope, and then updates the cached envelope of the feature. + </summary> + </member> + <member name="M:DotSpatial.Data.Feature.ExportToGml"> + <summary> + Creates a new GML string describing the location of this point + </summary> + <returns>A String representing the Geographic Markup Language version of this point</returns> + </member> + <member name="M:DotSpatial.Data.Feature.ToBinary"> + <summary> + Returns the Well-known Binary representation of this <c>Geometry</c>. + For a definition of the Well-known Binary format, see the OpenGIS Simple + Features Specification. + </summary> + <returns>The Well-known Binary representation of this <c>Geometry</c>.</returns> + </member> + <member name="M:DotSpatial.Data.Feature.ToShape"> + <summary> + Creates a new shape based on this feature by itself. + </summary> + <returns>A Shape object</returns> + </member> + <member name="M:DotSpatial.Data.Feature.Copy"> + <summary> + Copies this feature, creating an independant, but identical feature. + </summary> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.Feature.OnCopy(DotSpatial.Data.Feature)"> + <summary> + Occurs during the cloning process and this method also duplicates the envelope and basic geometry. + </summary> + <param name="copy">The feature being copied</param> + </member> + <member name="P:DotSpatial.Data.Feature.NumParts"> + <summary> + Gets or sets the integer number of parts associated with this feature. + Setting this will set a cached value on the feature that is separate + from the geometry and set the NumParts to Cached. + </summary> + </member> + <member name="P:DotSpatial.Data.Feature.NumPartsSource"> + <summary> + Gets or sets a DotSpatial.Data.CacheTypes enumeration. If the value + is dynamic, then NumParts will be read from the geometry on this feature. + If it is cached, then the value is separate from the geometry. + </summary> + </member> + <member name="P:DotSpatial.Data.Feature.Offset"> + <summary> + This specifies the offset, if any in the data file + </summary> + </member> + <member name="P:DotSpatial.Data.Feature.BasicGeometry"> + <summary> + Gets or sets a valid IBasicGeometry associated with the data elements of this feature. + This will be enough geometry information to cast into a full fledged geometry + that can be used in coordination with DotSpatial.Analysis + </summary> + </member> + <member name="P:DotSpatial.Data.Feature.ContentLength"> + <summary> + If the geometry for this shape was loaded from a file, this contains the size + of this shape in 16-bit words as per the Esri Shapefile specification. + </summary> + </member> + <member name="P:DotSpatial.Data.Feature.Coordinates"> + <summary> + Returns an array of coordinates corresponding to the basic feature. + </summary> + </member> + <member name="P:DotSpatial.Data.Feature.DataRow"> + <summary> + Gets the datarow containing all the attributes related to this geometry. + This will query the parent feature layer's data Table by FID and then + cache the value locally. If no parent feature layer exists, then + this is meaningless. You should create a new Feature by doing + FeatureLayer.Features.Add(), which will return a new Feature. + </summary> + </member> + <member name="P:DotSpatial.Data.Feature.Envelope"> + <summary> + This is an envelope, but specified by the file, not by calculating from the geometry. + To obtain a calculated envelope, calling the DynamicEnvelope() + </summary> + </member> + <member name="P:DotSpatial.Data.Feature.EnvelopeSource"> + <summary> + Gets or sets a DotSpatial.Data.CacheTypes enumeration specifying whether the Envelope property + returns a cached value in this object or is retrieved directly from the geometry. The + initial case for Shapefiles is to use a cache. Setting the envelope assumes that you + are going to use a cached value and will set this to Cached. Setting this to Dynamic + will cause the Envelope property to reference the geometry. + </summary> + </member> + <member name="P:DotSpatial.Data.Feature.FeatureType"> + <summary> + Returns either Point, Polygon or Line + </summary> + </member> + <member name="P:DotSpatial.Data.Feature.Fid"> + <summary> + Gets the key that is associated with this feature. This returns -1 if + this feature is not a member of a feature layer. + </summary> + </member> + <member name="P:DotSpatial.Data.Feature.GeometryType"> + <summary> + Shows the type of geometry for this feature + </summary> + </member> + <member name="P:DotSpatial.Data.Feature.NumGeometries"> + <summary> + Returns the NumGeometries in the BasicGeometry of this feature + </summary> + </member> + <member name="P:DotSpatial.Data.Feature.NumPoints"> + <summary> + Gets the integer number of points associated with features. + </summary> + </member> + <member name="P:DotSpatial.Data.Feature.RecordNumber"> + <summary> + An index value that is saved in some file formats. + </summary> + </member> + <member name="P:DotSpatial.Data.Feature.ParentFeatureSet"> + <summary> + Gets a reference to the IFeatureLayer that contains this item. + </summary> + </member> + <member name="P:DotSpatial.Data.Feature.ShapeType"> + <summary> + When a shape is loaded from a Shapefile, this will identify whether M or Z values are used + and whether or not the shape is null. + </summary> + </member> + <member name="P:DotSpatial.Data.Feature.ShapeIndex"> + <summary> + This is simply a quick access to the Vertices list for this specific + feature. If the Vertices have not yet been defined, this will be null. + </summary> + </member> + <member name="T:DotSpatial.Data.FeatureExt"> + <summary> + Extension Methods for the Features + </summary> + </member> + <member name="M:DotSpatial.Data.FeatureExt.Area(DotSpatial.Data.IFeature)"> + <summary> + Calculates the area of the geometric portion of this feature. This is 0 unless the feature + is a polygon, or multi-polygon. + </summary> + <param name="self">The feature to test</param> + <returns>The double valued area</returns> + </member> + <member name="M:DotSpatial.Data.FeatureExt.Buffer(DotSpatial.Data.IFeature,System.Double)"> + <summary> + Generates a new feature from the buffer of this feature. The DataRow of + the new feature will be null. + </summary> + <param name="self">This feature</param> + <param name="distance">The double distance</param> + <returns>An IFeature representing the output from the buffer operation</returns> + </member> + <member name="M:DotSpatial.Data.FeatureExt.Buffer(DotSpatial.Data.IFeature,System.Double,DotSpatial.Topology.BufferStyle)"> + <summary> + Generates a new feature from the buffer of this feature. The DataRow of + the new feature will be null. + </summary> + <param name="self">This feature</param> + <param name="distance">The double distance</param> + <param name="endCapStyle">The end cap style to use</param> + <returns>An IFeature representing the output from the buffer operation</returns> + </member> + <member name="M:DotSpatial.Data.FeatureExt.Buffer(DotSpatial.Data.IFeature,System.Double,System.Int32)"> + <summary> + Generates a new feature from the buffer of this feature. The DataRow of + the new feature will be null. + </summary> + <param name="self">This feature</param> + <param name="distance">The double distance</param> + <param name="quadrantSegments">The number of segments to use to approximate a quadrant of a circle</param> + <returns>An IFeature representing the output from the buffer operation</returns> + </member> + <member name="M:DotSpatial.Data.FeatureExt.Buffer(DotSpatial.Data.IFeature,System.Double,System.Int32,DotSpatial.Topology.BufferStyle)"> + <summary> + Generates a new feature from the buffer of this feature. The DataRow of + the new feature will be null. + </summary> + <param name="self">This feature</param> + <param name="distance">The double distance</param> + <param name="quadrantSegments">The number of segments to use to approximate a quadrant of a circle</param> + <param name="endCapStyle">The end cap style to use</param> + <returns>An IFeature representing the output from the buffer operation</returns> + </member> + <member name="M:DotSpatial.Data.FeatureExt.Buffer(DotSpatial.Data.IFeature,System.Double,DotSpatial.Data.IFeatureSet)"> + <summary> + Generates a buffer, but also adds the newly created feature to the specified output featureset. + This will also compare the field names of the input featureset with the destination featureset. + If a column name exists in both places, it will copy those values to the destination featureset. + </summary> + <param name="self">The feature to calcualate the buffer for.</param> + <param name="distance">The double distance to use for calculating the buffer</param> + <param name="destinationFeatureset">The output featureset to add this feature to and use + as a reference for determining which data columns to copy.</param> + <returns>The IFeature that represents the buffer feature.</returns> + </member> + <member name="M:DotSpatial.Data.FeatureExt.Buffer(DotSpatial.Data.IFeature,System.Double,DotSpatial.Topology.BufferStyle,DotSpatial.Data.IFeatureSet)"> + <summary> + Generates a buffer, but also adds the newly created feature to the specified output featureset. + This will also compare the field names of the input featureset with the destination featureset. + If a column name exists in both places, it will copy those values to the destination featureset. + </summary> + <param name="self">The feature to calcualate the buffer for.</param> + <param name="distance">The double distance to use for calculating the buffer</param> + <param name="endCapStyle">The end cap style to use</param> + <param name="destinationFeatureset">The output featureset to add this feature to and use + as a reference for determining which data columns to copy.</param> + <returns>The IFeature that represents the buffer feature.</returns> + </member> + <member name="M:DotSpatial.Data.FeatureExt.Buffer(DotSpatial.Data.IFeature,System.Double,System.Int32,DotSpatial.Data.IFeatureSet)"> + <summary> + Generates a buffer, but also adds the newly created feature to the specified output featureset. + This will also compare the field names of the input featureset with the destination featureset. + If a column name exists in both places, it will copy those values to the destination featureset. + </summary> + <param name="self">The feature to calcualate the buffer for.</param> + <param name="distance">The double distance to use for calculating the buffer</param> + <param name="quadrantSegments">The number of segments to use to approximate a quadrant of a circle</param> + <param name="destinationFeatureset">The output featureset to add this feature to and use + as a reference for determining which data columns to copy.</param> + <returns>The IFeature that represents the buffer feature.</returns> + </member> + <member name="M:DotSpatial.Data.FeatureExt.Buffer(DotSpatial.Data.IFeature,System.Double,System.Int32,DotSpatial.Topology.BufferStyle,DotSpatial.Data.IFeatureSet)"> + <summary> + Generates a buffer, but also adds the newly created feature to the specified output featureset. + This will also compare the field names of the input featureset with the destination featureset. + If a column name exists in both places, it will copy those values to the destination featureset. + </summary> + <param name="self">The feature to calcualate the buffer for.</param> + <param name="distance">The double distance to use for calculating the buffer</param> + <param name="quadrantSegments">The number of segments to use to approximate a quadrant of a circle</param> + <param name="endCapStyle">The end cap style to use</param> + <param name="destinationFeatureset">The output featureset to add this feature to and use + as a reference for determining which data columns to copy.</param> + <returns>The IFeature that represents the buffer feature.</returns> + </member> + <member name="M:DotSpatial.Data.FeatureExt.Centroid(DotSpatial.Data.IFeature)"> + <summary> + Returns a feature constructed from the centroid of this feature + </summary> + <param name="self">This feature</param> + <returns>An IFeature that is also a point geometry</returns> + </member> + <member name="M:DotSpatial.Data.FeatureExt.Contains(DotSpatial.Data.IFeature,DotSpatial.Data.IFeature)"> + <summary> + Gets a boolean that is true if this feature contains the specified feature + </summary> + <param name="self">This feature</param> + <param name="other">The other feature to test</param> + <returns>Boolean, true if this feature contains the other feature</returns> + </member> + <member name="M:DotSpatial.Data.FeatureExt.Contains(DotSpatial.Data.IFeature,DotSpatial.Topology.IGeometry)"> + <summary> + Gets a boolean that is true if this feature contains the specified feature + </summary> + <param name="self">This feature</param> + <param name="other">The other feature to test</param> + <returns>Boolean, true if this feature contains the other feature</returns> + </member> + <member name="M:DotSpatial.Data.FeatureExt.ConvexHull(DotSpatial.Data.IFeature)"> + <summary> + Calculates a new feature that has a geometry that is the convex hull of this feature. + </summary> + <param name="self">This feature</param> + <returns>A new feature that is the convex hull of this feature.</returns> + </member> + <member name="M:DotSpatial.Data.FeatureExt.ConvexHull(DotSpatial.Data.IFeature,DotSpatial.Data.IFeatureSet)"> + <summary> + Calculates a new feature that has a geometry that is the convex hull of this feature. + This also copies the attributes that are shared between this featureset and the + specified destination featureset, and adds this feature to the destination featureset. + </summary> + <param name="self">This feature</param> + <param name="destinationFeatureset">The destination featureset to add this feature to</param> + <returns>The newly created IFeature</returns> + </member> + <member name="M:DotSpatial.Data.FeatureExt.CoveredBy(DotSpatial.Data.IFeature,DotSpatial.Data.IFeature)"> + <summary> + Gets a boolean that is true if the geometry of this feature is covered by the geometry + of the specified feature + </summary> + <param name="self">This feature</param> + <param name="other">The feature to compare this feature to</param> + <returns>Boolean, true if this feature is covered by the specified feature</returns> + </member> + <member name="M:DotSpatial.Data.FeatureExt.CoveredBy(DotSpatial.Data.IFeature,DotSpatial.Topology.IGeometry)"> + <summary> + Gets a boolean that is true if the geometry of this feature is covered by the geometry + of the specified feature + </summary> + <param name="self">This feature</param> + <param name="other">The feature to compare this feature to</param> + <returns>Boolean, true if this feature is covered by the specified feature</returns> + </member> + <member name="M:DotSpatial.Data.FeatureExt.Covers(DotSpatial.Data.IFeature,DotSpatial.Data.IFeature)"> + <summary> + Gets a boolean that is true if the geometry of this feature covers the geometry + of the specified feature + </summary> + <param name="self">This feature</param> + <param name="other">The feature to compare this feature to</param> + <returns>Boolean, true if this feature covers the specified feature</returns> + </member> + <member name="M:DotSpatial.Data.FeatureExt.Covers(DotSpatial.Data.IFeature,DotSpatial.Topology.IGeometry)"> + <summary> + Gets a boolean that is true if the geometry of this feature covers the geometry + of the specified feature + </summary> + <param name="self">This feature</param> + <param name="other">The feature to compare this feature to</param> + <returns>Boolean, true if this feature covers the specified feature</returns> + </member> + <member name="M:DotSpatial.Data.FeatureExt.Crosses(DotSpatial.Data.IFeature,DotSpatial.Data.IFeature)"> + <summary> + Gets a boolean that is true if the geometry of this feature crosses the geometry + of the specified feature + </summary> + <param name="self">This feature</param> + <param name="other">The feature to compare this feature to</param> + <returns>Boolean, true if this feature crosses the specified feature</returns> + </member> + <member name="M:DotSpatial.Data.FeatureExt.Crosses(DotSpatial.Data.IFeature,DotSpatial.Topology.IGeometry)"> + <summary> + Gets a boolean that is true if the geometry of this feature crosses the geometry + of the specified feature + </summary> + <param name="self">This feature</param> + <param name="other">The feature to compare this feature to</param> + <returns>Boolean, true if this feature crosses the specified feature</returns> + </member> + <member name="M:DotSpatial.Data.FeatureExt.Difference(DotSpatial.Data.IFeature,DotSpatial.Data.IFeature)"> + <summary> + Creates a new Feature that has a geometry that is the difference between this feature and the specified feature. + </summary> + <param name="self">This feature</param> + <param name="other">The other feature to compare to.</param> + <returns>A new feature that is the geometric difference between this feature and the specified feature.</returns> + </member> + <member name="M:DotSpatial.Data.FeatureExt.Difference(DotSpatial.Data.IFeature,DotSpatial.Topology.IGeometry)"> + <summary> + Creates a new Feature that has a geometry that is the difference between this feature and the specified feature. + </summary> + <param name="self">This feature</param> + <param name="other">The other feature to compare to.</param> + <returns>A new feature that is the geometric difference between this feature and the specified feature.</returns> + </member> + <member name="M:DotSpatial.Data.FeatureExt.Difference(DotSpatial.Data.IFeature,DotSpatial.Data.IFeature,DotSpatial.Data.IFeatureSet,DotSpatial.Data.FieldJoinType)"> + <summary> + Creates a new Feature that has a geometry that is the difference between this feature and the specified feature. + This also copies the attributes that are shared between this featureset and the + specified destination featureset, and adds this feature to the destination featureset. + </summary> + <param name="self">This feature</param> + <param name="other">The other feature to compare to.</param> + <param name="destinationFeatureSet">The featureset to add the new feature to.</param> + <param name="joinType">This clarifies the overall join strategy being used with regards to attribute fields.</param> + <returns>A new feature that is the geometric difference between this feature and the specified feature.</returns> + </member> + <member name="M:DotSpatial.Data.FeatureExt.Disjoint(DotSpatial.Data.IFeature,DotSpatial.Data.IFeature)"> + <summary> + Gets a boolean that is true if the geometry of this feature is disjoint with the geometry + of the specified feature + </summary> + <param name="self">This feature</param> + <param name="other">The feature to compare this feature to</param> + <returns>Boolean, true if this feature is disjoint with the specified feature</returns> + </member> + <member name="M:DotSpatial.Data.FeatureExt.Disjoint(DotSpatial.Data.IFeature,DotSpatial.Topology.IGeometry)"> + <summary> + Gets a boolean that is true if the geometry of this feature is disjoint with the geometry + of the specified feature. + </summary> + <param name="self">This feature</param> + <param name="other">The feature to compare this feature to</param> + <returns>Boolean, true if this feature is disjoint with the specified feature</returns> + </member> + <member name="M:DotSpatial.Data.FeatureExt.Distance(DotSpatial.Data.IFeature,DotSpatial.Data.IFeature)"> + <summary> + Distance between features. + </summary> + <param name="self">This feature</param> + <param name="other">The feature to compare this feature to</param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.FeatureExt.Distance(DotSpatial.Data.IFeature,DotSpatial.Topology.IGeometry)"> + <summary> + Gets a boolean that is true if the geometry of this feature is disjoint with the geometry + of the specified feature + </summary> + <param name="self">This feature</param> + <param name="other">The feature to compare this feature to</param> + <returns>Boolean, true if this feature is disjoint with the specified feature</returns> + </member> + <member name="M:DotSpatial.Data.FeatureExt.Intersection(DotSpatial.Data.IFeature,DotSpatial.Data.IFeature)"> + <summary> + Creates a new Feature that has a geometry that is the intersection between this feature and the specified feature. + </summary> + <param name="self">This feature</param> + <param name="other">The other feature to compare to.</param> + <returns>A new feature that is the geometric intersection between this feature and the specified feature.</returns> + </member> + <member name="M:DotSpatial.Data.FeatureExt.Intersection(DotSpatial.Data.IFeature,DotSpatial.Topology.IGeometry)"> + <summary> + Creates a new Feature that has a geometry that is the intersection between this feature and the specified feature. + </summary> + <param name="self">This feature</param> + <param name="other">The other feature to compare to.</param> + <returns>A new feature that is the geometric intersection between this feature and the specified feature.</returns> + </member> + <member name="M:DotSpatial.Data.FeatureExt.Intersection(DotSpatial.Data.IFeature,DotSpatial.Data.IFeature,DotSpatial.Data.IFeatureSet,DotSpatial.Data.FieldJoinType)"> + <summary> + Creates a new Feature that has a geometry that is the intersection between this feature and the specified feature. + This also copies the attributes that are shared between this featureset and the + specified destination featureset, and adds this feature to the destination featureset. + </summary> + <param name="self">This feature</param> + <param name="other">The other feature to compare to.</param> + <param name="destinationFeatureSet">The featureset to add the new feature to.</param> + <param name="joinType">This clarifies the overall join strategy being used with regards to attribute fields.</param> + <returns>A new feature that is the geometric intersection between this feature and the specified feature.</returns> + </member> + <member name="M:DotSpatial.Data.FeatureExt.Intersects(DotSpatial.Data.IFeature,DotSpatial.Data.IFeature)"> + <summary> + Gets a boolean that is true if this feature intersects the other feature. + </summary> + <param name="self">This feature</param> + <param name="other">The other feature to test</param> + <returns>Boolean, true if the two IFeatures intersect</returns> + </member> + <member name="M:DotSpatial.Data.FeatureExt.Intersects(DotSpatial.Data.IFeature,DotSpatial.Topology.IGeometry)"> + <summary> + Gets a boolean that is true if this feature intersects the other feature. + </summary> + <param name="self">This feature</param> + <param name="other">The other feature to test</param> + <returns>Boolean, true if the two IFeatures intersect</returns> + </member> + <member name="M:DotSpatial.Data.FeatureExt.Intersects(DotSpatial.Data.IFeature,DotSpatial.Topology.Coordinate)"> + <summary> + This tests the current feature to see if the geometry intersects with the specified + coordinate. + </summary> + <param name="self">This feature</param> + <param name="coordinate">The coordinate</param> + <returns>Boolean if the coordinate intersects with this feature</returns> + </member> + <member name="M:DotSpatial.Data.FeatureExt.IsWithinDistance(DotSpatial.Data.IFeature,DotSpatial.Data.IFeature,System.Double)"> + <summary> + Gets a boolean that is true if this feature is within the specified distance of the other feature. + </summary> + <param name="self">This feature</param> + <param name="other">The other feature to test</param> + <param name="distance">The double distance criteria</param> + <returns>Boolean, true if the other feature is within the specified distance of this feature</returns> + </member> + <member name="M:DotSpatial.Data.FeatureExt.IsWithinDistance(DotSpatial.Data.IFeature,DotSpatial.Topology.IGeometry,System.Double)"> + <summary> + Gets a boolean that is true if this feature is within the specified distance of the other feature. + </summary> + <param name="self">This feature</param> + <param name="other">The other feature to test</param> + <param name="distance">The double distance criteria</param> + <returns>Boolean, true if the other feature is within the specified distance of this feature</returns> + </member> + <member name="M:DotSpatial.Data.FeatureExt.Overlaps(DotSpatial.Data.IFeature,DotSpatial.Data.IFeature)"> + <summary> + Gets a boolean that is true if this feature overlaps the specified feature + </summary> + <param name="self">This feature</param> + <param name="other">The other feature to test</param> + <returns>Boolean, true if the two IFeatures overlap</returns> + </member> + <member name="M:DotSpatial.Data.FeatureExt.Overlaps(DotSpatial.Data.IFeature,DotSpatial.Topology.IGeometry)"> + <summary> + Gets a boolean that is true if this feature overlaps the specified feature + </summary> + <param name="self">This feature</param> + <param name="other">The other feature to test</param> + <returns>Boolean, true if the two IFeatures overlap</returns> + </member> + <member name="M:DotSpatial.Data.FeatureExt.Relates(DotSpatial.Data.IFeature,DotSpatial.Data.IFeature,System.String)"> + <summary> + Gets a boolean that is true if the relationship between this feature and the other feature + matches the relationship matrix specified by other + </summary> + <param name="self">This feature</param> + <param name="other">The other feature to test</param> + <param name="intersectionPattern">The string relationship pattern to test</param> + <returns>Boolean, true if the other feature's relationship to this feature matches the relate expression.</returns> + </member> + <member name="M:DotSpatial.Data.FeatureExt.Relates(DotSpatial.Data.IFeature,DotSpatial.Topology.IGeometry,System.String)"> + <summary> + Gets a boolean that is true if the relationship between this feature and the other feature + matches the relationship matrix specified by other + </summary> + <param name="self">This feature</param> + <param name="other">The other feature to test</param> + <param name="intersectionPattern">The string relationship pattern to test</param> + <returns>Boolean, true if the other feature's relationship to this feature matches the relate expression.</returns> + </member> + <member name="M:DotSpatial.Data.FeatureExt.Rotate(DotSpatial.Data.IFeature,DotSpatial.Topology.Coordinate,System.Double)"> + <summary> + Rotates the BasicGeometry of the feature by the given radian angle around the given Origin. + </summary> + <param name="self">This feature.</param> + <param name="Origin">The coordinate the feature gets rotated around.</param> + <param name="radAngle">The rotation angle in radian.</param> + </member> + <member name="M:DotSpatial.Data.FeatureExt.SymmetricDifference(DotSpatial.Data.IFeature,DotSpatial.Data.IFeature)"> + <summary> + Creates a new Feature that has a geometry that is the symmetric difference between this feature and the specified feature. + </summary> + <param name="self">This feature</param> + <param name="other">The other feature to compare to.</param> + <returns>A new feature that is the geometric symmetric difference between this feature and the specified feature.</returns> + </member> + <member name="M:DotSpatial.Data.FeatureExt.SymmetricDifference(DotSpatial.Data.IFeature,DotSpatial.Topology.IGeometry)"> + <summary> + Creates a new Feature that has a geometry that is the symmetric difference between this feature and the specified feature. + </summary> + <param name="self">This feature</param> + <param name="other">The other feature to compare to.</param> + <returns>A new feature that is the geometric symmetric difference between this feature and the specified feature.</returns> + </member> + <member name="M:DotSpatial.Data.FeatureExt.SymmetricDifference(DotSpatial.Data.IFeature,DotSpatial.Data.IFeature,DotSpatial.Data.IFeatureSet,DotSpatial.Data.FieldJoinType)"> + <summary> + Creates a new Feature that has a geometry that is the symmetric difference between this feature and the specified feature. + This also copies the attributes that are shared between this featureset and the + specified destination featureset, and adds this feature to the destination featureset. + </summary> + <param name="self">This feature</param> + <param name="other">The other feature to compare to.</param> + <param name="destinationFeatureSet">The featureset to add the new feature to.</param> + <param name="joinType">This clarifies the overall join strategy being used with regards to attribute fields.</param> + <returns>A new feature that is the geometric symmetric difference between this feature and the specified feature.</returns> + </member> + <member name="M:DotSpatial.Data.FeatureExt.Touches(DotSpatial.Data.IFeature,DotSpatial.Data.IFeature)"> + <summary> + Gets a boolean that is true if this feature touches the specified feature + </summary> + <param name="self">This feature</param> + <param name="other">The other feature to test</param> + <returns>Boolean, true if the two IFeatures touch</returns> + </member> + <member name="M:DotSpatial.Data.FeatureExt.Touches(DotSpatial.Data.IFeature,DotSpatial.Topology.IGeometry)"> + <summary> + Gets a boolean that is true if this feature touches the specified feature + </summary> + <param name="self">This feature</param> + <param name="other">The other feature to test</param> + <returns>Boolean, true if the two IFeatures touch</returns> + </member> + <member name="M:DotSpatial.Data.FeatureExt.Union(DotSpatial.Data.IFeature,DotSpatial.Data.IFeature)"> + <summary> + Creates a new Feature that has a geometry that is the union between this feature and the specified feature. + </summary> + <param name="self">This feature</param> + <param name="other">The other feature to compare to.</param> + <returns>A new feature that is the geometric union between this feature and the specified feature.</returns> + </member> + <member name="M:DotSpatial.Data.FeatureExt.Union(DotSpatial.Data.IFeature,DotSpatial.Topology.IGeometry)"> + <summary> + Creates a new Feature that has a geometry that is the union between this feature and the specified feature. + </summary> + <param name="self">This feature</param> + <param name="other">The other feature to compare to.</param> + <returns>A new feature that is the geometric union between this feature and the specified feature.</returns> + </member> + <member name="M:DotSpatial.Data.FeatureExt.Union(DotSpatial.Data.IFeature,DotSpatial.Data.IFeature,DotSpatial.Data.IFeatureSet,DotSpatial.Data.FieldJoinType)"> + <summary> + Creates a new Feature that has a geometry that is the union between this feature and the specified feature. + This also copies the attributes that are shared between this featureset and the + specified destination featureset, and adds this feature to the destination featureset. + </summary> + <param name="self">This feature</param> + <param name="other">The other feature to compare to.</param> + <param name="destinationFeatureSet">The featureset to add the new feature to.</param> + <param name="joinType">Clarifies how the attributes should be handled during the union</param> + <returns>A new feature that is the geometric symmetric difference between this feature and the specified feature.</returns> + </member> + <member name="M:DotSpatial.Data.FeatureExt.Within(DotSpatial.Data.IFeature,DotSpatial.Data.IFeature)"> + <summary> + Gets a boolean that is true if this feature is within the specified feature + </summary> + <param name="self">This feature</param> + <param name="other">The other feature to test</param> + <returns>Boolean, true if this feature is within the specified feature</returns> + </member> + <member name="M:DotSpatial.Data.FeatureExt.Within(DotSpatial.Data.IFeature,DotSpatial.Topology.IGeometry)"> + <summary> + Gets a boolean that is true if this feature is within the specified feature + </summary> + <param name="self">This feature</param> + <param name="other">The other feature to test</param> + <returns>Boolean, true if this feature is within the specified feature</returns> + </member> + <member name="T:DotSpatial.Data.FeatureEventArgs"> + <summary> + FeatureEvent + </summary> + </member> + <member name="M:DotSpatial.Data.FeatureEventArgs.#ctor(DotSpatial.Data.IFeature)"> + <summary> + Creates a new instance of FeatureEvent + </summary> + </member> + <member name="P:DotSpatial.Data.FeatureEventArgs.Feature"> + <summary> + Gets the feature being referenced by this event. + </summary> + </member> + <member name="T:DotSpatial.Data.FeatureList"> + <summary> + A list that keeps track of a "parent" body that is also of type IFeature. + Whenever a member is added to the list, it sets the parent property. + </summary> + </member> + <member name="T:DotSpatial.Data.IFeatureList"> + <summary> + IFeatureList + </summary> + </member> + <member name="M:DotSpatial.Data.IFeatureList.ResumeEvents"> + <summary> + Resumes events + </summary> + </member> + <member name="M:DotSpatial.Data.IFeatureList.SuspendEvents"> + <summary> + Temporarilly disables events + </summary> + </member> + <member name="M:DotSpatial.Data.IFeatureList.ToList"> + <summary> + This is a re-expression of the features using a strong typed + list. This may be the inner list or a copy depending on + implementation. + </summary> + <returns>The features as a List of IFeature.</returns> + </member> + <member name="E:DotSpatial.Data.IFeatureList.FeatureAdded"> + <summary> + Occurs when a new feature is added to the list + </summary> + </member> + <member name="E:DotSpatial.Data.IFeatureList.FeatureRemoved"> + <summary> + Occurs when a feature is removed from the list. + </summary> + </member> + <member name="P:DotSpatial.Data.IFeatureList.EventsSuspended"> + <summary> + Gets or sets whether or not the events have been suspended + </summary> + </member> + <member name="P:DotSpatial.Data.IFeatureList.IncludeAttributes"> + <summary> + If this is false, then features will be added to the list without copying over attribute Table information. + This will allow the attributes to be loaded in a more on-demand later. + </summary> + </member> + <member name="P:DotSpatial.Data.IFeatureList.Parent"> + <summary> + Gets the parent featureset for this list. + </summary> + </member> + <member name="M:DotSpatial.Data.FeatureList.#ctor"> + <summary> + Instantiates a new instance of a FeatureList where no parent is specified. + This will basically simply act as a list and will not allow the features + to be aware of the parent featureset. + </summary> + </member> + <member name="M:DotSpatial.Data.FeatureList.#ctor(DotSpatial.Data.IFeatureSet)"> + <summary> + Instantiates a new instance of a FeatureList where the ParentFeatureSet + is specified so that each feature will be aware of its parent. + </summary> + <param name="parent">The ParentFeatureSet of the specified item</param> + </member> + <member name="M:DotSpatial.Data.FeatureList.Clear"> + <summary> + Removes all elements from the EventList<IFeature>. + </summary> + <exception cref="T:System.ApplicationException">Unable to clear while the ReadOnly property is set to true.</exception> + </member> + <member name="M:DotSpatial.Data.FeatureList.Contains(DotSpatial.Data.IFeature)"> + <summary> + Determines whether an element is in the System.Collections.Generic.List<IFeature>. + </summary> + <param name="item"> The object to locate in the System.Collections.Generic.List<IFeature>. The value can be null for reference types.</param> + <returns>true if item is found in the System.Collections.Generic.List<IFeature> otherwise, false.</returns> + </member> + <member name="M:DotSpatial.Data.FeatureList.GetEnumerator"> + <summary> + Returns an enumerator that iterates through this list + </summary> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.FeatureList.ResumeEvents"> + <summary> + Resumes events + </summary> + </member> + <member name="M:DotSpatial.Data.FeatureList.SuspendEvents"> + <summary> + Temporarilly disables events + </summary> + </member> + <member name="M:DotSpatial.Data.FeatureList.ToList"> + <summary> + Gets the internal list of features. This is quite fast in this case because + the actual internal data store is a list. This does not create a new collection. + </summary> + <returns>The internal list.</returns> + </member> + <member name="M:DotSpatial.Data.FeatureList.Reverse(System.Int32,System.Int32)"> + <summary> + Reverses the order of the elements in the specified range. + </summary> + <param name="index">The zero-based starting index of the range to reverse.</param> + <param name="count">The number of elements in the range to reverse.</param> + <exception cref="T:System.ArgumentException">index and count do not denote a valid range of elements in the EventList<IFeature>.</exception> + <exception cref="T:System.ArgumentOutOfRangeException">index is less than 0.-or-count is less than 0.</exception> + <exception cref="T:System.ApplicationException">Unable to reverse while the ReadOnly property is set to true.</exception> + </member> + <member name="M:DotSpatial.Data.FeatureList.Reverse"> + <summary> + Reverses the order of the elements in the entire EventList<IFeature>. + </summary> + <exception cref="T:System.ApplicationException">Unable to reverse while the ReadOnly property is set to true.</exception> + </member> + <member name="M:DotSpatial.Data.FeatureList.Sort(System.Comparison{DotSpatial.Data.IFeature})"> + <summary> + Sorts the elements in the entire EventList<IFeature> using the specified System.Comparison<IFeature>. + </summary> + <param name="comparison">The System.Comparison<IFeature> to use when comparing elements.</param> + <exception cref="T:System.ArgumentException">The implementation of comparison caused an error during the sort. For example, comparison might not return 0 when comparing an item with itself.</exception> + <exception cref="T:System.ArgumentNullException">comparison is null.</exception> + <exception cref="T:System.ApplicationException">Unable to sort while the ReadOnly property is set to true.</exception> + </member> + <member name="M:DotSpatial.Data.FeatureList.Sort(System.Int32,System.Int32,System.Collections.Generic.IComparer{DotSpatial.Data.IFeature})"> + <summary> + Sorts the elements in a range of elements in EventList<IFeature> using the specified comparer. + </summary> + <param name="index"> The zero-based starting index of the range to sort.</param> + <param name="count">The length of the range to sort.</param> + <param name="comparer">The System.Collections.Generic.IComparer<IFeature> implementation to use when comparing elements, or null to use the default comparer System.Collections.Generic.Comparer<IFeature>.Default.</param> + <exception cref="T:System.ArgumentException">index and count do not specify a valid range in the EventList<IFeature>.-or-The implementation of comparer caused an error during the sort. For example, comparer might not return 0 when comparing an item with itself.</exception> + <exception cref="T:System.ArgumentOutOfRangeException">index is less than 0.-or-count is less than 0.</exception> + <exception cref="T:System.InvalidOperationException"> comparer is null, and the default comparer + System.Collections.Generic.Comparer<IFeature>.Default cannot find implementation of the System.IComparable<IFeature> + generic interface or the System.IComparable interface for type IFeature.</exception> + <exception cref="T:System.ApplicationException">Unable to sort while the ReadOnly property is set to true.</exception> + </member> + <member name="M:DotSpatial.Data.FeatureList.Sort(System.Collections.Generic.IComparer{DotSpatial.Data.IFeature})"> + <summary> + Sorts the elements in the entire DotSpatial.Interfaces.Framework.IEventList<IFeature> using the specified comparer. + </summary> + <param name="comparer"> The System.Collections.Generic.IComparer<IFeature> implementation to use when comparing elements, or null to use the default comparer System.Collections.Generic.Comparer<IFeature>.Default.</param> + <exception cref="T:System.ArgumentException">The implementation of comparer caused an error during the sort. For example, comparer might not return 0 when comparing an item with itself.</exception> + <exception cref="T:System.InvalidOperationException">comparer is null, and the default comparer System.Collections.Generic.Comparer<IFeature>.Default cannot find implementation of the System.IComparable<IFeature> generic interface or the System.IComparable interface for type IFeature.</exception> + <exception cref="T:System.ApplicationException">Unable to sort while the ReadOnly property is set to true.</exception> + </member> + <member name="M:DotSpatial.Data.FeatureList.Sort"> + <summary> + Sorts the elements in the entire DotSpatial.Interfaces.Framework.IEventList<IFeature> using the default comparer. + </summary> + <exception cref="T:System.InvalidOperationException">The default comparer System.Collections.Generic.Comparer<IFeature>.Default cannot find an implementation of the System.IComparable<IFeature> generic interface or the System.IComparable interface for type IFeature.</exception> + <exception cref="T:System.ApplicationException">Unable to sort while the ReadOnly property is set to true.</exception> + </member> + <member name="M:DotSpatial.Data.FeatureList.CopyTo(DotSpatial.Data.IFeature[],System.Int32)"> + <summary> + Copies the entire System.Collections.Generic.List<IFeature> to a compatible one-dimensional array, starting at the specified index of the target array. + </summary> + <param name="array">The one-dimensional System.Array that is the destination of the elements copied from System.Collections.Generic.List<IFeature>. The System.Array must have zero-based indexing.</param> + <param name="arrayIndex"> The zero-based index in array at which copying begins.</param> + <exception cref="T:System.ArgumentException">System.ArgumentException: arrayIndex is equal to or greater than the length of array.-or-The number of elements in the source System.Collections.Generic.List<T> is greater than the available space from arrayIndex to the end of the destination array. </exception> + <exception cref="T:System.ArgumentOutOfRangeException">arrayIndex is less than 0</exception> + <exception cref="T:System.ArgumentNullException">array is null</exception> + </member> + <member name="M:DotSpatial.Data.FeatureList.CopyTo(System.Int32,DotSpatial.Data.IFeature[],System.Int32,System.Int32)"> + <summary> + Copies a range of elements from the EventList<IFeature> to a compatible one-dimensional array, starting at the specified index of the target array. + </summary> + <param name="index">The zero-based index in the source EventList<T> at which copying begins</param> + <param name="array">The one-dimensional System.Array that is the destination of the elements copied from EventList<IFeature>. The System.Array must have zero-based indexing.</param> + <param name="arrayIndex">The zero-based index in array at which copying begins.</param> + <param name="count">The number of elements to copy.</param> + <exception cref="T:System.ArgumentNullException">array is null.</exception> + <exception cref="T:System.ArgumentOutOfRangeException"> index is less than 0.-or-arrayIndex is less than 0.-or-count is less than 0.</exception> + <exception cref="T:System.ArgumentException">index is equal to or greater than the EventList<IFeature>.Count of the source EventList<T>.-or-arrayIndex is equal to or greater than the length of array.-or-The number of elements from index to the end of the source EventList<IFeature> is greater than the available space from arrayIndex to the end of the destination array.</exception> + </member> + <member name="M:DotSpatial.Data.FeatureList.CopyTo(DotSpatial.Data.IFeature[])"> + <summary> + Copies the entire EventList<IFeature> to a compatible one-dimensional array, starting at the beginning of the target array. + </summary> + <param name="array">The one-dimensional System.Array that is the destination of the elements copied from EventList<IFeature>. The System.Array must have zero-based indexing.</param> + <exception cref="T:System.ArgumentException">The number of elements in the source EventList<IFeature> is greater than the number of elements that the destination array can contain.</exception> + <exception cref="T:System.ArgumentNullException">array is null.</exception> + </member> + <member name="M:DotSpatial.Data.FeatureList.IncludeFeature(DotSpatial.Data.IFeature,System.Int32)"> + <summary> + Includes the Feature in the parents DataTable at the given index and raises the FeatureAdded event. + </summary> + <param name="item">Feature that gets included.</param> + <param name="index">Index, where the feature gets included. (-1 = add at the end)</param> + </member> + <member name="M:DotSpatial.Data.FeatureList.ExcludeFeature(DotSpatial.Data.IFeature)"> + <summary> + Removes the given Feature from the parents DataTable and raises the FeatureRemoved event. + </summary> + <param name="item">Feature that gets excluded.</param> + </member> + <member name="M:DotSpatial.Data.FeatureList.ConvertAll``1(System.Converter{DotSpatial.Data.IFeature,``0})"> + <summary> + Converts the elements in the current EventList<IFeature> to another type, and returns a list containing the converted elements. + </summary> + <typeparam name="TOutput">The output type to convert to</typeparam> + <param name="converter">A System.Converter<TInput, TOutput> delegate that converts each element from one type to another type.</param> + <returns>A List<T> of the target type containing the converted elements from the current EventList<T>.</returns> + <exception cref="T:System.ArgumentNullException">converter is null.</exception> + </member> + <member name="M:DotSpatial.Data.FeatureList.Exists(System.Predicate{DotSpatial.Data.IFeature})"> + <summary> + Determines whether the EventList<IFeature> contains elements that match the conditions defined by the specified predicate. + </summary> + <param name="match">The System.Predicate<IFeature> delegate that defines the conditions of the elements to search for.</param> + <returns>true if the EventList<T> contains one or more elements that match the conditions defined by the specified predicate; otherwise, false.</returns> + <exception cref="T:System.ArgumentNullException">match is null.</exception> + </member> + <member name="M:DotSpatial.Data.FeatureList.GetRange(System.Int32,System.Int32)"> + <summary> + Creates a shallow copy of a range of elements in the source EventList<IFeature>. + </summary> + <param name="index">The zero-based EventList<IFeature> index at which the range starts.</param> + <param name="count"> The number of elements in the range.</param> + <returns>A shallow copy of a range of elements in the source EventList<IFeature>.</returns> + <exception cref="T:System.ArgumentOutOfRangeException">index is less than 0.-or-count is less than 0.</exception> + <exception cref="T:System.ArgumentException">index and count do not denote a valid range of elements in the EventList<IFeature>.</exception> + </member> + <member name="M:DotSpatial.Data.FeatureList.ToArray"> + <summary> + Copies the elements of the DotSpatial.Interfaces.Framework.IEventList<IFeature> to a new array. + </summary> + <returns>An array containing copies of the elements of the DotSpatial.Interfaces.Framework.IEventList<IFeature>.</returns> + </member> + <member name="M:DotSpatial.Data.FeatureList.TrimExcess"> + <summary> + Sets the capacity to the actual number of elements in the DotSpatial.Interfaces.Framework.IEventList<IFeature>, if that number is less than a threshold value. + </summary> + </member> + <member name="M:DotSpatial.Data.FeatureList.TrueForAll(System.Predicate{DotSpatial.Data.IFeature})"> + <summary> + Determines whether every element in the DotSpatial.Interfaces.Framework.IEventList<IFeature> matches the conditions defined by the specified predicate. + </summary> + <param name="match">The System.Predicate<IFeature> delegate that defines the conditions to check against the elements.</param> + <returns>true if every element in the DotSpatial.Interfaces.Framework.IEventList<IFeature> matches the conditions defined by the specified predicate; otherwise, false. If the list has no elements, the return value is true.</returns> + <exception cref="T:System.ArgumentNullException">match is null.</exception> + </member> + <member name="M:DotSpatial.Data.FeatureList.IndexOf(DotSpatial.Data.IFeature)"> + <summary> + Searches for the specified object and returns the zero-based index of the first occurrence within the entire System.Collections.Generic.List<IFeature>. + </summary> + <param name="item">The object to locate in the System.Collections.Generic.List<IFeature>. The value can be null for reference types.</param> + <returns>The zero-based index of the first occurrence of item within the entire System.Collections.Generic.List<IFeature>, if found; otherwise, –1.</returns> + </member> + <member name="M:DotSpatial.Data.FeatureList.IndexOf(DotSpatial.Data.IFeature,System.Int32,System.Int32)"> + <summary> + Searches for the specified object and returns the zero-based index of the first occurrence within the range of elements in the EventList<IFeature> that starts at the specified index and contains the specified number of elements. + </summary> + <param name="item">The object to locate in the EventList<IFeature>. The value can be null for reference types.</param> + <param name="index"> The zero-based starting index of the search.</param> + <param name="count">The number of elements in the section to search.</param> + <returns>The zero-based index of the first occurrence of item within the range of elements in the EventList<IFeature> that starts at index and contains count number of elements, if found; otherwise, –1.</returns> + <exception cref="T:System.ArgumentOutOfRangeException"> index is outside the range of valid indexes for the EventList<IFeature>.-or-count is less than 0.-or-index and count do not specify a valid section in the EventList<IFeature>.</exception> + </member> + <member name="M:DotSpatial.Data.FeatureList.IndexOf(DotSpatial.Data.IFeature,System.Int32)"> + <summary> + Searches for the specified object and returns the zero-based index of the first occurrence within the range of elements in the EventList<IFeature> that extends from the specified index to the last element. + </summary> + <param name="item">The object to locate in the EventList<IFeature>. The value can be null for reference types.</param> + <param name="index"> The zero-based starting index of the search.</param> + <returns>The zero-based index of the first occurrence of item within the range of elements in the EventList<IFeature> that extends from index to the last element, if found; otherwise, –1.</returns> + <exception cref="T:System.ArgumentOutOfRangeException">index is outside the range of valid indexes for the EventList<IFeature>.</exception> + </member> + <member name="M:DotSpatial.Data.FeatureList.Insert(System.Int32,DotSpatial.Data.IFeature)"> + <summary> + Inserts an element into the System.Collections.Generic.List<IFeature> at the specified index. + </summary> + <param name="index">The zero-based index at which item should be inserted.</param> + <param name="item">The object to insert. The value can be null for reference types.</param> + <exception cref="T:System.ArgumentOutOfRangeException">index is less than 0.-or-index is greater than System.Collections.Generic.List<IFeature>.Count.</exception> + <exception cref="T:System.ApplicationException">Unable to insert while the ReadOnly property is set to true.</exception> + </member> + <member name="M:DotSpatial.Data.FeatureList.InsertRange(System.Int32,System.Collections.Generic.IEnumerable{DotSpatial.Data.IFeature})"> + <summary> + Inserts the elements of a collection into the EventList<IFeature> at the specified index. + </summary> + <param name="index">The zero-based index at which the new elements should be inserted.</param> + <param name="collection">The collection whose elements should be inserted into the EventList<IFeature>. The collection itself cannot be null, but it can contain elements that are null, if type IFeature is a reference type.</param> + <exception cref="T:System.ArgumentOutOfRangeException">index is less than 0.-or-index is greater than EventList<IFeature>.Count.</exception> + <exception cref="T:System.ArgumentNullException">collection is null.</exception> + <exception cref="T:System.ApplicationException">Unable to insert while the ReadOnly property is set to true.</exception> + </member> + <member name="M:DotSpatial.Data.FeatureList.LastIndexOf(DotSpatial.Data.IFeature,System.Int32,System.Int32)"> + <summary> + Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the EventList<IFeature> that contains the specified number of elements and ends at the specified index. + </summary> + <param name="item">The object to locate in the EventList<IFeature>. The value can be null for reference types.</param> + <param name="index">The zero-based starting index of the backward search.</param> + <param name="count">The number of elements in the section to search.</param> + <returns>The zero-based index of the last occurrence of item within the range of elements in the EventList<IFeature> that contains count number of elements and ends at index, if found; otherwise, –1.</returns> + <exception cref="T:System.ArgumentOutOfRangeException">index is outside the range of valid indexes for the EventList<IFeature>.-or-count is less than 0.-or-index and count do not specify a valid section in the EventList<IFeature>.</exception> + </member> + <member name="M:DotSpatial.Data.FeatureList.LastIndexOf(DotSpatial.Data.IFeature,System.Int32)"> + <summary> + Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the EventList<IFeature> that extends from the first element to the specified index. + </summary> + <param name="item">The object to locate in the EventList<IFeature>. The value can be null for reference types.</param> + <param name="index">The zero-based starting index of the backward search.</param> + <returns>The zero-based index of the last occurrence of item within the range of elements in the EventList<IFeature> that extends from the first element to index, if found; otherwise, –1.</returns> + <exception cref="T:System.ArgumentOutOfRangeException">index is outside the range of valid indexes for the EventList<IFeature>.</exception> + </member> + <member name="M:DotSpatial.Data.FeatureList.LastIndexOf(DotSpatial.Data.IFeature)"> + <summary> + Searches for the specified object and returns the zero-based index of the last occurrence within the entire EventList<IFeature>. + </summary> + <param name="item">The object to locate in the EventList<IFeature>. The value can be null for reference types.</param> + <returns>The zero-based index of the last occurrence of item within the entire the EventList<IFeature>, if found; otherwise, –1.</returns> + </member> + <member name="M:DotSpatial.Data.FeatureList.Remove(DotSpatial.Data.IFeature)"> + <summary> + Removes the first occurrence of a specific object from the System.Collections.Generic.List<IFeature>. + </summary> + <param name="item">The object to remove from the System.Collections.Generic.List<IFeature>. The value can be null for reference types.</param> + <returns>true if item is successfully removed; otherwise, false. This method also returns false if item was not + found in the System.Collections.Generic.List<IFeature>.</returns> + <exception cref="T:System.ApplicationException">Unable to remove while the ReadOnly property is set to true.</exception> + </member> + <member name="M:DotSpatial.Data.FeatureList.RemoveAt(System.Int32)"> + <summary> + Removes the element at the specified index of the System.Collections.Generic.List<IFeature>. + </summary> + <param name="index">The zero-based index of the element to remove.</param> + <exception cref="T:System.ApplicationException">Unable to remove while the ReadOnly property is set to true.</exception> + </member> + <member name="M:DotSpatial.Data.FeatureList.RemoveAll(System.Predicate{DotSpatial.Data.IFeature})"> + <summary> + Removes the all the elements that match the conditions defined by the specified predicate. + </summary> + <param name="match">The System.Predicate<IFeature> delegate that defines the conditions of the elements to remove.</param> + <returns>The number of elements removed from the EventList<IFeature></returns> + <exception cref="T:System.ArgumentNullException">match is null.</exception> + <exception cref="T:System.ApplicationException">Unable to remove while the ReadOnly property is set to true.</exception> + </member> + <member name="M:DotSpatial.Data.FeatureList.RemoveRange(System.Int32,System.Int32)"> + <summary> + Removes a range of elements from the EventList<IFeature>. + </summary> + <param name="index">The zero-based starting index of the range of elements to remove.</param> + <param name="count">The number of elements to remove.</param> + <exception cref="T:System.ArgumentOutOfRangeException">index is less than 0.-or-count is less than 0.</exception> + <exception cref="T:System.ArgumentException">index and count do not denote a valid range of elements in the EventList<IFeature>.</exception> + <exception cref="T:System.ApplicationException">Unable to remove while the ReadOnly property is set to true.</exception> + </member> + <member name="M:DotSpatial.Data.FeatureList.FindAll(System.Predicate{DotSpatial.Data.IFeature})"> + <summary> + Retrieves all the elements that match the conditions described by the specified predicate + </summary> + <param name="match">The System.Predicate that defines the conditions to search for</param> + <returns>A List of matches</returns> + </member> + <member name="M:DotSpatial.Data.FeatureList.FindIndex(System.Int32,System.Int32,System.Predicate{DotSpatial.Data.IFeature})"> + <summary> + Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the range of elements in the EventList<IFeature> that starts at the specified index and contains the specified number of elements. + </summary> + <param name="startIndex">The zero-based starting index of the search.</param> + <param name="count">The number of elements in the section to search.</param> + <param name="match"> The System.Predicate<IFeature> delegate that defines the conditions of the element to search for.</param> + <returns>The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1</returns> + <exception cref="T:System.ArgumentOutOfRangeException">startIndex is outside the range of valid indexes for the EventList<IFeature>.-or-count is less than 0.-or-startIndex and count do not specify a valid section in the EventList<IFeature>.</exception> + <exception cref="T:System.ArgumentNullException">match is null</exception> + </member> + <member name="M:DotSpatial.Data.FeatureList.FindIndex(System.Int32,System.Predicate{DotSpatial.Data.IFeature})"> + <summary> + Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the range of elements in the EventList<IFeature> that extends from the specified index to the last element. + </summary> + <param name="startIndex">The zero-based starting index of the search.</param> + <param name="match">The System.Predicate<IFeature> delegate that defines the conditions of the element to search for.</param> + <returns>The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1.</returns> + <exception cref="T:System.ArgumentOutOfRangeException">startIndex is outside the range of valid indexes for the EventList<IFeature>.</exception> + <exception cref="T:System.ArgumentNullException">match is null.</exception> + </member> + <member name="M:DotSpatial.Data.FeatureList.FindIndex(System.Predicate{DotSpatial.Data.IFeature})"> + <summary> + Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the entire EventList<IFeature>. + </summary> + <param name="match">The System.Predicate<IFeature> delegate that defines the conditions of the element to search for.</param> + <returns>The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1.</returns> + <exception cref="T:System.ArgumentNullException">match is null.</exception> + </member> + <member name="M:DotSpatial.Data.FeatureList.FindLast(System.Predicate{DotSpatial.Data.IFeature})"> + <summary> + Searches for an element that matches the conditions defined by the specified predicate, and returns the last occurrence within the entire EventList<IFeature>. + </summary> + <param name="match">The System.Predicate<IFeature> delegate that defines the conditions of the element to search for.</param> + <returns>The last element that matches the conditions defined by the specified predicate, if found; otherwise, the default value for type IFeature.</returns> + <exception cref="T:System.ArgumentNullException">match is null."</exception> + </member> + <member name="M:DotSpatial.Data.FeatureList.FindLastIndex(System.Int32,System.Int32,System.Predicate{DotSpatial.Data.IFeature})"> + <summary> + Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the range of elements in the EventList<IFeature> that contains the specified number of elements and ends at the specified index. + </summary> + <param name="startIndex">The zero-based starting index of the backward search.</param> + <param name="count">The number of elements in the section to search.</param> + <param name="match"></param> + <returns>The System.Predicate<IFeature> delegate that defines the conditions of the element to search for.</returns> + <exception cref="T:System.ArgumentOutOfRangeException">startIndex is outside the range of valid indexes for the EventList<IFeature>.-or-count is less than 0.-or-startIndex and count do not specify a valid section in the EventList<IFeature>.</exception> + <exception cref="T:System.ArgumentNullException">match is null.</exception> + </member> + <member name="M:DotSpatial.Data.FeatureList.FindLastIndex(System.Int32,System.Predicate{DotSpatial.Data.IFeature})"> + <summary> + Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the range of elements in the EventList<IFeature> that extends from the first element to the specified index. + </summary> + <param name="startIndex"> The zero-based starting index of the backward search.</param> + <param name="match">The System.Predicate<IFeature> delegate that defines the conditions of the element to search for.</param> + <returns>The zero-based index of the last occurrence of an element that matches the conditions defined by match, if found; otherwise, –1.</returns> + <exception cref="T:System.ArgumentOutOfRangeException">: startIndex is outside the range of valid indexes for the EventList<IFeature>.</exception> + </member> + <member name="M:DotSpatial.Data.FeatureList.FindLastIndex(System.Predicate{DotSpatial.Data.IFeature})"> + <summary> + Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the entire EventList<IFeature>. + </summary> + <param name="match">The System.Predicate<IFeature> delegate that defines the conditions of the element to search for.</param> + <returns>The zero-based index of the last occurrence of an element that matches the conditions defined by match, if found; otherwise, –1.</returns> + <exception cref="T:System.ArgumentNullException">match is null.</exception> + </member> + <member name="M:DotSpatial.Data.FeatureList.Add(DotSpatial.Data.IFeature)"> + <summary> + Adds the item to the list, setting the parent to be the list's parent + </summary> + <param name="item"></param> + </member> + <member name="M:DotSpatial.Data.FeatureList.AddRange(System.Collections.Generic.IEnumerable{DotSpatial.Data.IFeature})"> + <summary> + Adds the elements of the specified collection to the end of the System.Collections.Generic.List<T> + </summary> + <param name="collection">collection: The collection whose elements should be added to the end of the + System.Collections.Generic.List<T>. The collection itself cannot be null, but it can contain elements that are null, + if type T is a reference type.</param> + <exception cref="T:System.ApplicationException">Unable to add while the ReadOnly property is set to true.</exception> + </member> + <member name="M:DotSpatial.Data.FeatureList.BinarySearch(DotSpatial.Data.IFeature)"> + <summary> + Searches the entire sorted System.Collections.Generic.List<IFeature> for an element using the default comparer and returns the zero-based index of the element. + </summary> + <param name="item">The object to locate. The value can be null for reference types.</param> + <returns>The zero-based index of item in the sorted System.Collections.Generic.List<IFeature>, if item is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than item or, if there is no larger element, the bitwise complement of System.Collections.Generic.List<IFeature>.Count.</returns> + <exception cref="T:System.InvalidOperationException">The default comparer System.Collections.Generic.Comparer<IFeature>.Default cannot find an implementation of the System.IComparable<IFeature> generic interface or the System.IComparable interface for type IFeature.</exception> + </member> + <member name="M:DotSpatial.Data.FeatureList.OnFeatureAdded(DotSpatial.Data.IFeature)"> + <summary> + Occurs each time a feature is added to the list. This should only be called + if suspend events is false. + </summary> + <param name="feature">The feature that was added.</param> + </member> + <member name="M:DotSpatial.Data.FeatureList.OnFeatureRemoved(DotSpatial.Data.IFeature)"> + <summary> + Occurs each time a feature is removed from the list. This should only be + called if suspend events is false. + </summary> + <param name="feature">he feature that was removed</param> + </member> + <member name="E:DotSpatial.Data.FeatureList.FeatureAdded"> + <summary> + Occurs when a new feature is added to the list + </summary> + </member> + <member name="E:DotSpatial.Data.FeatureList.FeatureRemoved"> + <summary> + Occurs when a feature is removed from the list. + </summary> + </member> + <member name="P:DotSpatial.Data.FeatureList.EventsSuspended"> + <summary> + Gets or sets whether or not the events have been suspended + </summary> + </member> + <member name="P:DotSpatial.Data.FeatureList.Capacity"> + <summary> + Gets or sets the total number of elements the internal data structure can hold without resizing. + </summary> + <returns> + The number of elements that the DotSpatial.Interfaces.Framework.IEventList<IFeature> can contain before resizing is required. + </returns> + <exception cref="T:System.ArgumentOutOfRangeException">DotSpatial.Interfaces.Framework.IEventList<IFeature>.Capacity is set to a value that is less than DotSpatial.Interfaces.Framework.IEventList<IFeature>.Count.</exception> + </member> + <member name="P:DotSpatial.Data.FeatureList.Count"> + <summary> + Gets the count of the members in the list + </summary> + </member> + <member name="P:DotSpatial.Data.FeatureList.Item(System.Int32)"> + <summary> + The default, indexed value of type IFeature + </summary> + <param name="index">The numeric index</param> + <returns>An object of type IFeature corresponding to the index value specified</returns> + </member> + <member name="P:DotSpatial.Data.FeatureList.IsReadOnly"> + <summary> + Gets a boolean property indicating whether this list can be written to. + </summary> + </member> + <member name="P:DotSpatial.Data.FeatureList.IncludeAttributes"> + <summary> + If this is false, then features will be added to the list without copying over attribute Table information. + This will allow the attributes to be loaded in a more on-demand later. + </summary> + </member> + <member name="P:DotSpatial.Data.FeatureList.Parent"> + <summary> + Gets the parent featureset for this list of features. + </summary> + </member> + <member name="T:DotSpatial.Data.FeatureListExt"> + <summary> + FeatureListEm + </summary> + </member> + <member name="M:DotSpatial.Data.FeatureListExt.Add(DotSpatial.Data.IFeatureList,DotSpatial.Topology.Coordinate)"> + <summary> + adding a single coordinate will assume that the feature type should be point for this featureset, even + if it has not already been specified. + </summary> + <param name="self">This IFeatureList</param> + <param name="point">The point to add to the featureset</param> + <exception cref="T:DotSpatial.Data.FeatureTypeMismatchException">Thrown when the feature type already exists, there are already features in the featureset and the featuretype is not equal to point.</exception> + </member> + <member name="M:DotSpatial.Data.FeatureListExt.Add(DotSpatial.Data.IFeatureList,System.Collections.Generic.IEnumerable{DotSpatial.Topology.Coordinate},DotSpatial.Topology.FeatureType)"> + <summary> + This adds the coordinates and specifies what sort of feature type should be added. + </summary> + <param name="self">This IFeatureList</param> + <param name="points">The list or array of coordinates to be added after it is built into the appropriate feature.</param> + <param name="featureType">The feature type.</param> + </member> + <member name="M:DotSpatial.Data.FeatureListExt.Add(DotSpatial.Data.IFeatureList,System.Collections.Generic.IEnumerable{DotSpatial.Topology.Coordinate})"> + <summary> + If the feature type is specified, then this will automatically generate a new feature from the specified coordinates. + This will not work unless the featuretype is specified. + </summary> + <param name="self">This IFeatureList</param> + <param name="points"> + The list or array of coordinates to build into a new feature. + If the feature type is point, then this will create separate features for each coordinate. + For polygons, all the points will be assumed to be in the shell. + </param> + <exception cref="T:DotSpatial.Data.UnspecifiedFeaturetypeException">Thrown if the current FeatureType for the shapefile is unspecified.</exception> + </member> + <member name="M:DotSpatial.Data.FeatureListExt.Add(DotSpatial.Data.IFeatureList,DotSpatial.Topology.IBasicGeometry)"> + <summary> + This method will attempt to add the specified geometry to the list. + If the feature type is currently unspecified, this will specify the feature type. + </summary> + <param name="self">This feature list</param> + <param name="geometry">The geometry to create a new feature from.</param> + <exception cref="T:DotSpatial.Data.FeatureTypeMismatchException">Thrown if the new geometry does not match the currently specified feature type. </exception> + </member> + <member name="T:DotSpatial.Data.FeatureSet"> + <summary> + Rather than being an abstract base class, this is a "router" class that will + make decisions based on the file extension or whatever being used and decide the best + IFeatureSet that matches the specifications. + </summary> + </member> + <member name="T:DotSpatial.Data.IFeatureSet"> + <summary> + A layer contains a list of features of a specific type that matches the geometry type. + While this supports IRenderable, this merely forwards the drawing instructions to + each of its members, but does not allow the control of any default layer properties here. + Calling FeatureDataSource.Open will create a number of layers of the appropriate + specific type and also create a specific layer type that is derived from this class + that does expose default "layer" properties, as well as the symbology elements. + </summary> + </member> + <member name="T:DotSpatial.Data.IAttributeSource"> + <summary> + IDataPageRetriever + </summary> + </member> + <member name="M:DotSpatial.Data.IAttributeSource.GetAttributes(System.Int32,System.Int32)"> + <summary> + Supplies a page of content in the form of a data Table. + </summary> + <param name="startIndex">The integer lower page boundary</param> + <param name="numRows">The integer number of rows to return for the page</param> + <returns>A DataTable made up with the virtual row content.</returns> + </member> + <member name="M:DotSpatial.Data.IAttributeSource.GetAttributes(System.Int32,System.Int32,System.Collections.Generic.IEnumerable{System.String})"> + <summary> + Reads just the content requested in order to satisfy the paging ability of VirtualMode for the DataGridView + </summary> + <param name="startIndex">The integer lower page boundary</param> + <param name="numRows">The integer number of attribute values to return for the page</param> + <param name="fieldNames">The list or array of fieldnames to return.</param> + <returns>A DataTable populated with data rows with only the specified values.</returns> + </member> + <member name="M:DotSpatial.Data.IAttributeSource.SetAttributes(System.Int32,System.Data.DataTable)"> + <summary> + Converts a page of content from a DataTable format, saving it back to the source. + </summary> + <param name="startIndex">The 0 based integer index representing the first row in the file (corresponding to the 0 row of the data table)</param> + <param name="pageValues">The DataTable representing the rows to set. If the row count is larger than the dataset, this will add the rows instead.</param> + </member> + <member name="M:DotSpatial.Data.IAttributeSource.NumRows"> + <summary> + The number of rows + </summary> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.IAttributeSource.GetColumn(System.String)"> + <summary> + Gets the column with the specified name + </summary> + <param name="name">the name to search</param> + <returns>the Field matching the specified name</returns> + </member> + <member name="M:DotSpatial.Data.IAttributeSource.GetColumns"> + <summary> + Gets a copy of the fields used to build the data structure. This is useful for learning + about the existing fields, but doesn't allow direct changes to the underlying data structure. + </summary> + </member> + <member name="M:DotSpatial.Data.IAttributeSource.AddRow(System.Collections.Generic.Dictionary{System.String,System.Object})"> + <summary> + Saves the new row to the data source and updates the file with new content. + </summary> + <param name="values">The values organized against the dictionary of field names.</param> + </member> + <member name="M:DotSpatial.Data.IAttributeSource.Edit(System.Int32,System.Collections.Generic.Dictionary{System.String,System.Object})"> + <summary> + saves a single row to the data source. + </summary> + <param name="index">the integer row (or FID) index</param> + <param name="values">The dictionary of object values by string field name holding the new values to store.</param> + </member> + <member name="M:DotSpatial.Data.IAttributeSource.AddRow(System.Data.DataRow)"> + <summary> + Saves the new row to the data source and updates the file with new content. + </summary> + <param name="values">The values organized against the dictionary of field names.</param> + </member> + <member name="M:DotSpatial.Data.IAttributeSource.Edit(System.Int32,System.Data.DataRow)"> + <summary> + saves a single row to the data source. + </summary> + <param name="index">the integer row (or FID) index</param> + <param name="values">The dictionary of object values by string field name holding the new values to store.</param> + </member> + <member name="M:DotSpatial.Data.IAttributeSource.GetCounts(System.String[],DotSpatial.Data.ICancelProgressHandler,System.Int32)"> + <summary> + Given a string expression, this returns the count of the members that satisfy that expression. + </summary> + <param name="expressions">The array of string expressions to test</param> + <param name="progressHandler">The progress handler that might also instruct this step to be canceled.</param> + <param name="maxSampleSize">The integer maximum sample size from which to draw counts. If this is negative, it will not be used.</param> + <returns>An array of integer counts of the members that match the expression</returns> + </member> + <member name="M:DotSpatial.Data.IFeatureSet.GetColumnNames(System.String)"> + <summary> + Gets the list of string names available as columns from the specified excel file. + </summary> + <param name="xlsFilePath"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.IFeatureSet.Join(System.String,System.String,System.String)"> + <summary> + For attributes that are small enough to be loaded into a data table, this + will join attributes from a foreign table (from an excel file). This method + won't create new rows in this table, so only matching members are brought in, + but no rows are removed either, so not all rows will receive data. + </summary> + <param name="xlsFilePath">The complete path of the file to join</param> + <param name="localJoinField">The field name to join on in this table</param> + <param name="xlsJoinField">The field in the foreign table.</param> + </member> + <member name="M:DotSpatial.Data.IFeatureSet.AddShape(DotSpatial.Data.Shape)"> + <summary> + If this featureset is in index mode, this will append the vertices and shapeindex of the shape. + Otherwise, this will add a new feature based on this shape. If the attributes of the shape are not null, + this will attempt to append a new datarow It is up to the developer + to ensure that the object array of attributes matches the this featureset. If the Attributes of this feature are loaded, + this will add the attributes in ram only. Otherwise, this will attempt to insert the attributes as a + new record using the "AddRow" method. The schema of the object array should match this featureset's column schema. + </summary> + <param name="shape">The shape to add to this featureset.</param> + </member> + <member name="M:DotSpatial.Data.IFeatureSet.AddShapes(System.Collections.Generic.IEnumerable{DotSpatial.Data.Shape})"> + <summary> + Adds any type of list or array of shapes. If this featureset is not in index moded, + it will add the features to the featurelist and suspend events for faster copying. + </summary> + <param name="shapes">An enumerable collection of shapes.</param> + </member> + <member name="M:DotSpatial.Data.IFeatureSet.GetFeature(System.Int32)"> + <summary> + Gets the specified feature by constructing it from the vertices, rather + than requiring that all the features be created. (which takes up a lot of memory). + </summary> + <param name="index">The integer index</param> + </member> + <member name="M:DotSpatial.Data.IFeatureSet.GetShape(System.Int32,System.Boolean)"> + <summary> + Gets a shape at the specified shape index. If the featureset is in + indexmode, this returns a copy of the shape. If not, it will create + a new shape based on the specified feature. + </summary> + <param name="index">The zero based integer index of the shape.</param> + <param name="getAttributes">If getAttributes is true, then this also try to get attributes for that shape. + If attributes are loaded, then it will use the existing datarow. Otherwise, it will read the attributes + from the file. (This second option is not recommended for large repeats. In such a case, the attributes + can be set manually from a larger bulk query of the data source.)</param> + <returns>The Shape object</returns> + </member> + <member name="M:DotSpatial.Data.IFeatureSet.FeatureFromRow(System.Data.DataRow)"> + <summary> + Given a datarow, this will return the associated feature. This FeatureSet + uses an internal dictionary, so that even if the items are re-ordered + or have new members inserted, this lookup will still work. + </summary> + <param name="row">The DataRow for which to obtaind the feature</param> + <returns>The feature to obtain that is associated with the specified data row.</returns> + </member> + <member name="M:DotSpatial.Data.IFeatureSet.AddFeature(DotSpatial.Topology.IBasicGeometry)"> + <summary> + Generates a new feature, adds it to the features and returns the value. + </summary> + <returns>The feature that was added to this featureset</returns> + </member> + <member name="M:DotSpatial.Data.IFeatureSet.AddFid"> + <summary> + Adds the FID values as a field called FID, but only if the FID field + does not already exist + </summary> + </member> + <member name="M:DotSpatial.Data.IFeatureSet.CopyFeatures(DotSpatial.Data.IFeatureSet,System.Boolean)"> + <summary> + Copies all the features from the specified featureset. + </summary> + <param name="source">The source IFeatureSet to copy features from.</param> + <param name="copyAttributes">Boolean, true if the attributes should be copied as well. If this is true, + and the attributes are not loaded, a FillAttributes call will be made.</param> + </member> + <member name="M:DotSpatial.Data.IFeatureSet.CopySubset(System.Collections.Generic.List{System.Int32})"> + <summary> + Retrieves a subset using exclusively the features matching the specified values. + </summary> + <param name="indices">An integer list of indices to copy into the new FeatureSet</param> + <returns>A FeatureSet with the new items.</returns> + </member> + <member name="M:DotSpatial.Data.IFeatureSet.CopySubset(System.String)"> + <summary> + Copies the subset of specified features to create a new featureset that is restricted to + just the members specified. + </summary> + <param name="filterExpression">The string expression to test.</param> + <returns>A FeatureSet that has members that only match the specified members.</returns> + </member> + <member name="M:DotSpatial.Data.IFeatureSet.CopyTableSchema(DotSpatial.Data.IFeatureSet)"> + <summary> + Copies only the names and types of the attribute fields, without copying any of the attributes or features. + </summary> + <param name="source">The source featureSet to obtain the schema from.</param> + </member> + <member name="M:DotSpatial.Data.IFeatureSet.CopyTableSchema(System.Data.DataTable)"> + <summary> + Copies the Table schema (column names/data types) + from a DatatTable, but doesn't copy any values. + </summary> + <param name="sourceTable">The Table to obtain schema from.</param> + </member> + <member name="M:DotSpatial.Data.IFeatureSet.FillAttributes"> + <summary> + Instructs the shapefile to read all the attributes from the file. + This may also be a cue to read values from a database. + </summary> + </member> + <member name="M:DotSpatial.Data.IFeatureSet.FillAttributes(DotSpatial.Data.IProgressHandler)"> + <summary> + Instructs the shapefile to read all the attributes from the file. + This may also be a cue to read values from a database. + </summary> + </member> + <member name="M:DotSpatial.Data.IFeatureSet.Find(System.String)"> + <summary> + Obtains the list of feature indices that match the specified filter expression. + </summary> + <param name="filterExpression">The filter expression to find features for.</param> + <returns>The list of integers that are the FIDs of the specified values.</returns> + </member> + <member name="M:DotSpatial.Data.IFeatureSet.InitializeVertices"> + <summary> + This forces the vertex initialization so that Vertices, ShapeIndices, and the + ShapeIndex property on each feature will no longer be null. + </summary> + </member> + <member name="M:DotSpatial.Data.IFeatureSet.InvalidateVertices"> + <summary> + Switches a boolean so that the next time that the vertices are requested, + they must be re-calculated from the feature coordinates. + </summary> + <remarks>This only affects reading values from the Vertices cache</remarks> + </member> + <member name="M:DotSpatial.Data.IFeatureSet.RemoveShapeAt(System.Int32)"> + <summary> + Attempts to remove the specified shape. + </summary> + <param name="index"> + The integer index of the shape to remove. + </param> + <returns> + Boolean, true if the remove was successful. + </returns> + </member> + <member name="M:DotSpatial.Data.IFeatureSet.RemoveShapesAt(System.Collections.Generic.IEnumerable{System.Int32})"> + <summary> + Attempts to remove a range of shapes by index. This is optimized to + work better for large numbers. For one or two, using RemoveShapeAt might + be faster. + </summary> + <param name="indices"> + The enumerable set of indices to remove. + </param> + </member> + <member name="M:DotSpatial.Data.IFeatureSet.SelectIndices(DotSpatial.Data.Extent)"> + <summary> + Skips the features themselves and uses the shapeindicies instead. + </summary> + <param name="region">The region to select members from</param> + <returns>A list of integer valued shape indices that are selected.</returns> + </member> + <member name="M:DotSpatial.Data.IFeatureSet.Save"> + <summary> + Saves the information in the Layers provided by this datasource onto its existing file location + </summary> + </member> + <member name="M:DotSpatial.Data.IFeatureSet.SaveAs(System.String,System.Boolean)"> + <summary> + Saves a datasource to the file. + </summary> + <param name="fileName">The string fileName location to save to</param> + <param name="overwrite">Boolean, if this is true then it will overwrite a file of the existing name.</param> + </member> + <member name="M:DotSpatial.Data.IFeatureSet.Select(DotSpatial.Data.Extent)"> + <summary> + returns only the features that have envelopes that + intersect with the specified envelope. + </summary> + <param name="region">The specified region to test for intersect with</param> + <returns>A List of the IFeature elements that are contained in this region</returns> + </member> + <member name="M:DotSpatial.Data.IFeatureSet.Select(DotSpatial.Data.Extent,DotSpatial.Data.Extent@)"> + <summary> + returns only the features that have envelopes that + intersect with the specified envelope. + </summary> + <param name="region">The specified region to test for intersect with</param> + <param name="selectedRegion">This returns the geographic extents for the entire selected area.</param> + <returns>A List of the IFeature elements that are contained in this region</returns> + </member> + <member name="M:DotSpatial.Data.IFeatureSet.SelectByAttribute(System.String)"> + <summary> + The string filter expression to use in order to return the desired features. + </summary> + <param name="filterExpression">The features to return.</param> + <returns>The list of desired features.</returns> + </member> + <member name="M:DotSpatial.Data.IFeatureSet.SelectIndexByAttribute(System.String)"> + <summary> + This version is more tightly integrated to the DataTable and returns the row indices, rather + than attempting to link the results to features themselves, which may not even exist. + </summary> + <param name="filterExpression">The filter expression</param> + <returns>The list of indices</returns> + </member> + <member name="M:DotSpatial.Data.IFeatureSet.UpdateExtent"> + <summary> + After changing coordinates, this will force the re-calculation of envelopes on a feature + level as well as on the featureset level. + </summary> + </member> + <member name="E:DotSpatial.Data.IFeatureSet.VerticesInvalidated"> + <summary> + Occurs when the vertices are invalidated, encouraging a re-draw + </summary> + </member> + <member name="E:DotSpatial.Data.IFeatureSet.FeatureAdded"> + <summary> + Occurs when a new feature is added to the list + </summary> + </member> + <member name="E:DotSpatial.Data.IFeatureSet.FeatureRemoved"> + <summary> + Occurs when a feature is removed from the list. + </summary> + </member> + <member name="P:DotSpatial.Data.IFeatureSet.AttributesPopulated"> + <summary> + Gets whether or not the attributes have all been loaded into the data table. + </summary> + </member> + <member name="P:DotSpatial.Data.IFeatureSet.CoordinateType"> + <summary> + Gets or sets the coordinate type across the entire featureset. + </summary> + </member> + <member name="P:DotSpatial.Data.IFeatureSet.DataTable"> + <summary> + Gets the DataTable associated with this specific feature. + </summary> + </member> + <member name="P:DotSpatial.Data.IFeatureSet.Features"> + <summary> + Gets the list of all the features that are included in this layer. + </summary> + </member> + <member name="P:DotSpatial.Data.IFeatureSet.FeatureGeometryFactory"> + <summary> + This is an optional GeometryFactory that can be set to control how the geometries on features are + created. if this is not specified, the default from DotSptaial.Topology is used. + </summary> + </member> + <member name="P:DotSpatial.Data.IFeatureSet.FeatureLookup"> + <summary> + Gets the feature lookup Table itself. + </summary> + </member> + <member name="P:DotSpatial.Data.IFeatureSet.FeatureType"> + <summary> + Gets an enumeration indicating the type of feature represented in this dataset, if any. + </summary> + </member> + <member name="P:DotSpatial.Data.IFeatureSet.Filename"> + <summary> + Gets the string fileName for this feature layer, if any + </summary> + </member> + <member name="P:DotSpatial.Data.IFeatureSet.ShapeIndices"> + <summary> + These specifically allow the user to make sense of the Vertices array. These are + fast acting sealed classes and are not meant to be overridden or support clever + new implementations. + </summary> + </member> + <member name="P:DotSpatial.Data.IFeatureSet.IndexMode"> + <summary> + If this is true, then the ShapeIndices and Vertex values are used, + and features are created on demand. Otherwise the list of Features + is used directly. + </summary> + </member> + <member name="P:DotSpatial.Data.IFeatureSet.Vertex"> + <summary> + Gets an array of Vertex structures with X and Y coordinates + </summary> + </member> + <member name="P:DotSpatial.Data.IFeatureSet.Z"> + <summary> + Z coordinates + </summary> + </member> + <member name="P:DotSpatial.Data.IFeatureSet.M"> + <summary> + M coordinates + </summary> + </member> + <member name="P:DotSpatial.Data.IFeatureSet.VerticesAreValid"> + <summary> + Gets a boolean that indicates whether or not the InvalidateVertices has been called + more recently than the cached vertex array has been built. + </summary> + </member> + <member name="F:DotSpatial.Data.FeatureSet._dataTable"> + <summary> + The _data table. + </summary> + </member> + <member name="F:DotSpatial.Data.FeatureSet._featureLookup"> + <summary> + The _feature lookup. + </summary> + </member> + <member name="F:DotSpatial.Data.FeatureSet._features"> + <summary> + The _features. + </summary> + </member> + <member name="F:DotSpatial.Data.FeatureSet._m"> + <summary> + The _m. + </summary> + </member> + <member name="F:DotSpatial.Data.FeatureSet._shapeIndices"> + <summary> + The _shape indices. + </summary> + </member> + <member name="F:DotSpatial.Data.FeatureSet._vertices"> + <summary> + The _vertices. + </summary> + </member> + <member name="F:DotSpatial.Data.FeatureSet._verticesAreValid"> + <summary> + The _vertices are valid. + </summary> + </member> + <member name="F:DotSpatial.Data.FeatureSet._z"> + <summary> + The _z. + </summary> + </member> + <member name="M:DotSpatial.Data.FeatureSet.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:DotSpatial.Data.FeatureSet"/> class. + This doesn't do anything exactly because there is no file-specific information yet + </summary> + </member> + <member name="M:DotSpatial.Data.FeatureSet.#ctor(DotSpatial.Topology.FeatureType)"> + <summary> + Initializes a new instance of the <see cref="T:DotSpatial.Data.FeatureSet"/> class. + Creates a new FeatureSet + </summary> + <param name="featureType"> + The Feature type like point, line or polygon + </param> + </member> + <member name="M:DotSpatial.Data.FeatureSet.#ctor(System.Data.DataTable,System.Int32,System.Boolean,DotSpatial.Topology.FeatureType)"> + <summary> + Initializes a new instance of the <see cref="T:DotSpatial.Data.FeatureSet"/> class. + This creates a new featureset by checking each row of the table. If the WKB feature + type matches the specified featureTypes, then it will copy that. + </summary> + <param name="wkbTable"> + </param> + <param name="wkbColumnIndex"> + </param> + <param name="indexed"> + </param> + <param name="type"> + </param> + </member> + <member name="M:DotSpatial.Data.FeatureSet.#ctor(System.Collections.Generic.IList{DotSpatial.Data.IFeature})"> + <summary> + Initializes a new instance of the <see cref="T:DotSpatial.Data.FeatureSet"/> class. + Creates a new FeatureSet using a given list of IFeatures. + This will copy the existing features, rather than removing + them from their parent feature set. + </summary> + <param name="inFeatures"> + The list of IFeatures + </param> + </member> + <member name="M:DotSpatial.Data.FeatureSet.AddFeature(DotSpatial.Topology.IBasicGeometry)"> + <summary> + Generates a new feature, adds it to the features and returns the value. + </summary> + <param name="geometry"> + The geometry. + </param> + <returns> + The feature that was added to this featureset + </returns> + </member> + <member name="M:DotSpatial.Data.FeatureSet.DataTableRowDeleted(System.Object,System.Data.DataRowChangeEventArgs)"> + <summary> + The data table row deleted. + </summary> + <param name="sender"> + The sender. + </param> + <param name="e"> + The e. + </param> + </member> + <member name="M:DotSpatial.Data.FeatureSet.FeaturesFeatureAdded(System.Object,DotSpatial.Data.FeatureEventArgs)"> + <summary> + The features feature added. + </summary> + <param name="sender"> + The sender. + </param> + <param name="e"> + The e. + </param> + </member> + <member name="M:DotSpatial.Data.FeatureSet.FeaturesFeatureRemoved(System.Object,DotSpatial.Data.FeatureEventArgs)"> + <summary> + The features feature removed. + </summary> + <param name="sender"> + The object sender. + </param> + <param name="e"> + The FeatureEventArgs. + </param> + </member> + <member name="M:DotSpatial.Data.FeatureSet.AddFid"> + <summary> + Adds the FID values as a field called FID, but only if the FID field + does not already exist. + </summary> + </member> + <member name="M:DotSpatial.Data.FeatureSet.AddShape(DotSpatial.Data.Shape)"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.FeatureSet.AddShapes(System.Collections.Generic.IEnumerable{DotSpatial.Data.Shape})"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.FeatureSet.CopyFeatures(DotSpatial.Data.IFeatureSet,System.Boolean)"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.FeatureSet.DotSpatial#Data#IFeatureSet#CopySubset(System.Collections.Generic.List{System.Int32})"> + <summary> + The copy subset. + </summary> + <param name="indices"> + The indices. + </param> + <returns> + </returns> + </member> + <member name="M:DotSpatial.Data.FeatureSet.DotSpatial#Data#IFeatureSet#CopySubset(System.String)"> + <summary> + The copy subset. + </summary> + <param name="filterExpression"> + The filter expression. + </param> + <returns> + </returns> + </member> + <member name="M:DotSpatial.Data.FeatureSet.CopyTableSchema(DotSpatial.Data.IFeatureSet)"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.FeatureSet.CopyTableSchema(System.Data.DataTable)"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.FeatureSet.FeatureFromRow(System.Data.DataRow)"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.FeatureSet.FillAttributes"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.FeatureSet.FillAttributes(DotSpatial.Data.IProgressHandler)"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.FeatureSet.Find(System.String)"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.FeatureSet.GetColumnNames(System.String)"> + <summary> + Gets the list of string names available as columns from the specified excel file. + </summary> + <param name="xlsFilePath"> + </param> + <returns> + </returns> + Warning. This method should be moved outside of FeatureSet. + </member> + <member name="M:DotSpatial.Data.FeatureSet.GetFeature(System.Int32)"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.FeatureSet.GetShape(System.Int32,System.Boolean)"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.FeatureSet.InitializeVertices"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.FeatureSet.InvalidateVertices"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.FeatureSet.Join(System.String,System.String,System.String)"> + <summary> + For attributes that are small enough to be loaded into a data table, this + will join attributes from a foreign table (from an excel file). This method + won't create new rows in this table, so only matching members are brought in, + but no rows are removed either, so not all rows will receive data. + </summary> + <param name="xlsFilePath"> + The complete path of the file to join + </param> + <param name="localJoinField"> + The field name to join on in this table + </param> + <param name="xlsJoinField"> + The field in the foreign table. + </param> + <returns> + A modified featureset with the changes. + </returns> + </member> + <member name="M:DotSpatial.Data.FeatureSet.Save"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.FeatureSet.SaveAs(System.String,System.Boolean)"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.FeatureSet.Select(DotSpatial.Data.Extent)"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.FeatureSet.Select(DotSpatial.Data.Extent,DotSpatial.Data.Extent@)"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.FeatureSet.SelectByAttribute(System.String)"> + <summary> + Selects using a string filter expression to obtain the desired features. + Field names should be in square brackets. Alternately, if the field name of [FID] + is used, then it will use the row index instead if no FID field is found. + </summary> + <param name="filterExpression"> + The features to return. + </param> + <returns> + The list of desired features. + </returns> + </member> + <member name="M:DotSpatial.Data.FeatureSet.SelectIndexByAttribute(System.String)"> + <summary> + This version is more tightly integrated to the DataTable and returns the row indices, rather + than attempting to link the results to features themselves, which may not even exist. + </summary> + <param name="filterExpression"> + The filter expression + </param> + <returns> + The list of indices + </returns> + </member> + <member name="M:DotSpatial.Data.FeatureSet.SelectIndices(DotSpatial.Data.Extent)"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.FeatureSet.CopySubset(System.Collections.Generic.List{System.Int32})"> + <summary> + Retrieves a subset using exclusively the features matching the specified values. + </summary> + <param name="indices"> + An integer list of indices to copy into the new FeatureSet. + </param> + <returns> + A FeatureSet with the new items. + </returns> + </member> + <member name="M:DotSpatial.Data.FeatureSet.InvalidateEnvelope"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.FeatureSet.Open(System.String)"> + <summary> + This attempts to open the specified file as a valid IFeatureSet. This will require that + the default data manager can work with the file format at runtime. + </summary> + <param name="fileName"> + The string fileName for this featureset. + </param> + </member> + <member name="M:DotSpatial.Data.FeatureSet.OpenFile(System.String)"> + <summary> + This will return the correct feature type by reading the fileName. + </summary> + <param name="fileName"> + A string specifying the file with the extension .shp to open. + </param> + <returns> + A correct featureSet which is exclusively for reading the .shp data + </returns> + </member> + <member name="M:DotSpatial.Data.FeatureSet.OpenFile(System.String,DotSpatial.Data.IProgressHandler)"> + <summary> + Generates a new FeatureSet, if possible, from the specified fileName. + </summary> + <param name="fileName"> + The string fileName to attempt to load into a new FeatureSet. + </param> + <param name="progressHandler"> + An IProgressHandler for progress messages + </param> + </member> + <member name="M:DotSpatial.Data.FeatureSet.GetLine(System.Int32)"> + <summary> + Gets the line for the specified index + </summary> + </member> + <member name="M:DotSpatial.Data.FeatureSet.GetMultiPoint(System.Int32)"> + <summary> + Returns a single multipoint feature for the shape at the specified index + </summary> + </member> + <member name="M:DotSpatial.Data.FeatureSet.GetPoint(System.Int32)"> + <summary> + Gets the point for the shape at the specified index + </summary> + </member> + <member name="M:DotSpatial.Data.FeatureSet.GetPolygon(System.Int32)"> + <summary> + If the FeatureType is polygon, this is the code for converting the vertex array + into a feature. + </summary> + </member> + <member name="M:DotSpatial.Data.FeatureSet.AddAttributes(DotSpatial.Data.Shape)"> + <summary> + handles the attributes while adding a shape + </summary> + <param name="shape"> + </param> + <returns> + A data row, but only if attributes are populated + </returns> + </member> + <member name="M:DotSpatial.Data.FeatureSet.CopySubset(System.String)"> + <summary> + Copies the subset of specified features to create a new featureset that is restricted to + just the members specified. + </summary> + <param name="filterExpression"> + The string expression to test. + </param> + <returns> + A FeatureSet that has members that only match the specified members. + </returns> + </member> + <member name="M:DotSpatial.Data.FeatureSet.PointInList(DotSpatial.Topology.Coordinate,System.Collections.Generic.IEnumerable{DotSpatial.Topology.Coordinate})"> + <summary> + Test if a point is in a list of coordinates. + </summary> + <param name="testPoint"> + TestPoint the point to test for. + </param> + <param name="pointList"> + PointList the list of points to look through. + </param> + <returns> + true if testPoint is a point in the pointList list. + </returns> + </member> + <member name="M:DotSpatial.Data.FeatureSet.RemoveShapeAt(System.Int32)"> + <summary> + Attempts to remove the specified shape. If in memory, this will also remove the + corresponding database row. This has no affect on the underlying datasets. + To impact those, use the + </summary> + <param name="index"> + The integer index o the shape to remove. + </param> + <returns> + Boolean, true if the remove was successful. + </returns> + </member> + <member name="M:DotSpatial.Data.FeatureSet.RemoveShapesAt(System.Collections.Generic.IEnumerable{System.Int32})"> + <summary> + Attempts to remove a range of shapes by index. This is optimized to + work better for large numbers. For one or two, using RemoveShapeAt might + be faster. + </summary> + <param name="indices"> + The enumerable set of indices to remove. + </param> + </member> + <member name="M:DotSpatial.Data.FeatureSet.Reproject(DotSpatial.Projections.ProjectionInfo)"> + <summary> + Reprojects all of the in-ram vertices of this featureset. + This will also update the projection to be the specified projection. + </summary> + <param name="targetProjection"> + The projection information to reproject the coordinates to. + </param> + </member> + <member name="M:DotSpatial.Data.FeatureSet.UpdateExtent"> + <summary> + After changing coordinates, this will force the re-calculation of envelopes on a feature + level or test the shapes in index mode to rebuild an Extent. + </summary> + </member> + <member name="M:DotSpatial.Data.FeatureSet.RelativePathTo(System.String)"> + <summary> + Creates a relative path from one file + or folder to another. + </summary> + <param name="toPath"> + Contains the path that defines the + endpoint of the relative path. + </param> + <returns> + The relative path from the start + directory to the end path. + </returns> + <exception cref="T:System.ArgumentNullException">Occurs when the toPath is NULL</exception> + </member> + <member name="M:DotSpatial.Data.FeatureSet.MakeRelativePath(System.String,System.String)"> + <summary> + Creates a relative path from one file or folder to another. + </summary> + <param name="fromPath">Contains the directory that defines the start of the relative path.</param> + <param name="toPath">Contains the path that defines the endpoint of the relative path.</param> + <returns>The relative path from the start directory to the end path.</returns> + <exception cref="T:System.ArgumentNullException"></exception> + </member> + <member name="M:DotSpatial.Data.FeatureSet.FeaturesFromVertices"> + <summary> + Calculates the features from the shape indices and vertex array. + </summary> + </member> + <member name="M:DotSpatial.Data.FeatureSet.OnDataTableExcluded(System.Data.DataTable)"> + <summary> + Allows the un-wiring of event handlers related to the data Table. + </summary> + <param name="dataTable"> + </param> + </member> + <member name="M:DotSpatial.Data.FeatureSet.OnDataTableIncluded(System.Data.DataTable)"> + <summary> + Allows the wiring of event handlers related to the data Table. + </summary> + <param name="dataTable"> + </param> + </member> + <member name="M:DotSpatial.Data.FeatureSet.OnExcludeFeatures(DotSpatial.Data.IFeatureList)"> + <summary> + Occurs when removing the feature list, allowing events to be disconnected + </summary> + <param name="features"> + </param> + </member> + <member name="M:DotSpatial.Data.FeatureSet.OnIncludeFeatures(DotSpatial.Data.IFeatureList)"> + <summary> + Occurs when setting the feature list, allowing events to be connected + </summary> + <param name="features"> + </param> + </member> + <member name="M:DotSpatial.Data.FeatureSet.AddRow(System.Collections.Generic.Dictionary{System.String,System.Object})"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.FeatureSet.AddRow(System.Data.DataRow)"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.FeatureSet.Edit(System.Int32,System.Collections.Generic.Dictionary{System.String,System.Object})"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.FeatureSet.Edit(System.Int32,System.Data.DataRow)"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.FeatureSet.GetAttributes(System.Int32,System.Int32)"> + <inheritdoc /> + </member> + <member name="M:DotSpatial.Data.FeatureSet.GetAttributes(System.Int32,System.Int32,System.Collections.Generic.IEnumerable{System.String})"> + <summary> + Reads just the content requested in order to satisfy the paging ability of VirtualMode for the DataGridView + </summary> + <param name="startIndex"> + The integer lower page boundary. + </param> + <param name="numRows"> + The integer number of attribute rows to return for the page. + </param> + <param name="fieldNames"> + The list or array of fieldnames to return. + </param> + <returns> + A DataTable populated with data rows with only the specified values. + </returns> + </member> + <member name="M:DotSpatial.Data.FeatureSet.GetColumn(System.String)"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.FeatureSet.GetColumns"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.FeatureSet.GetCounts(System.String[],DotSpatial.Data.ICancelProgressHandler,System.Int32)"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.FeatureSet.NumRows"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.FeatureSet.SetAttributes(System.Int32,System.Data.DataTable)"> + <inheritdoc/> + </member> + <member name="M:DotSpatial.Data.FeatureSet.OnInitializeVertices"> + <summary> + Occurs when the vertices are being re-calculated. + </summary> + </member> + <member name="M:DotSpatial.Data.FeatureSet.OnVerticesInvalidated"> + <summary> + Fires the VerticesInvalidated event + </summary> + </member> + <member name="M:DotSpatial.Data.FeatureSet.UpdateCoordinates"> + <summary> + This forces the cached vertices array to be copied back to the individual X and Y values + of the coordinates themselves. + </summary> + </member> + <member name="M:DotSpatial.Data.FeatureSet.Dispose(System.Boolean)"> + <summary> + Disposes the unmanaged memory objects. + </summary> + <param name="disposeManagedResources">If this is true, managed resources are set to null.</param> + </member> + <member name="E:DotSpatial.Data.FeatureSet.FeatureAdded"> + <summary> + Occurs when a new feature is added to the list + </summary> + </member> + <member name="E:DotSpatial.Data.FeatureSet.FeatureRemoved"> + <summary> + Occurs when a feature is removed from the list. + </summary> + </member> + <member name="E:DotSpatial.Data.FeatureSet.VerticesInvalidated"> + <summary> + Occurs when the vertices are invalidated, encouraging a re-draw + </summary> + </member> + <member name="P:DotSpatial.Data.FeatureSet.FilePath"> + <summary> + Gets or sets the current file path. This is the relative path relative to + the current project folder. For feature sets coming from a database + or a web service, the FilePath property is NULL. + </summary> + <value> + The relative file path. + </value> + <remarks>This property is used when saving source file information to a DSPX project.</remarks> + </member> + <member name="P:DotSpatial.Data.FeatureSet.AttributesPopulated"> + <summary> + Gets whether or not the attributes have all been loaded into the data table. + </summary> + </member> + <member name="P:DotSpatial.Data.FeatureSet.CoordinateType"> + <summary> + Gets or sets the coordinate type across the entire featureset. + </summary> + </member> + <member name="P:DotSpatial.Data.FeatureSet.DataTable"> + <summary> + DataTable is the System.Data.DataTable for all the attributes of this FeatureSet. + This will call FillAttributes if it is accessed and that has not yet been called. + </summary> + </member> + <member name="P:DotSpatial.Data.FeatureSet.Extent"> + <summary> + This is the envelope in Extent form. This may be cached. + </summary> + </member> + <member name="P:DotSpatial.Data.FeatureSet.FeatureGeometryFactory"> + <summary> + This is an optional GeometryFactory that can be set to control how the geometries on features are + created. The "Feature" prefix allows us to access the static Default instance on GeometryFactory. + </summary> + </member> + <member name="P:DotSpatial.Data.FeatureSet.FeatureLookup"> + <summary> + Gets the feature lookup Table itself. + </summary> + </member> + <member name="P:DotSpatial.Data.FeatureSet.FeatureType"> + <summary> + Gets or sets an enumeration specifying whether this + featureset contains Lines, Points, Polygons or an + unspecified type. + </summary> + </member> + <member name="P:DotSpatial.Data.FeatureSet.Features"> + <summary> + A list of the features in this layer + </summary> + </member> + <member name="P:DotSpatial.Data.FeatureSet.Filename"> + <summary> + Gets or sets the file name of a file based feature set. The file name should be the + absolute path including the file extension. For feature sets coming from a database + or a web service, the Filename property is NULL. + </summary> + </member> + <member name="P:DotSpatial.Data.FeatureSet.IndexMode"> + <summary> + If this is true, then the ShapeIndices and Vertex values are used, + and features are created on demand. Otherwise the list of Features + is used directly. + </summary> + </member> + <member name="P:DotSpatial.Data.FeatureSet.M"> + <inheritdoc/> + </member> + <member name="P:DotSpatial.Data.FeatureSet.ShapeIndices"> + <summary> + These specifically allow the user to make sense of the Vertices array. These are + fast acting sealed classes and are not meant to be overridden or support clever + new implementations. + </summary> + </member> + <member name="P:DotSpatial.Data.FeatureSet.Vertex"> + <inheritdoc/> + </member> + <member name="P:DotSpatial.Data.FeatureSet.VerticesAreValid"> + <summary> + Gets a Boolean that indicates whether or not the InvalidateVertices has been called + more recently than the cached vertex array has been built. + </summary> + </member> + <member name="P:DotSpatial.Data.FeatureSet.Z"> + <inheritdoc/> + </member> + <member name="T:DotSpatial.Data.FeatureSetExt"> + <summary> + FeatureSetEM contains extension methods that should work for any IFeatureSet + </summary> + </member> + <member name="M:DotSpatial.Data.FeatureSetExt.Buffer(DotSpatial.Data.IFeatureSet,System.Double,System.Boolean)"> + <summary> + Creates a new polygon featureset that is created by buffering each of the individual shapes. + </summary> + <param name="self">The IFeatureSet to buffer</param> + <param name="distance">The double distance to buffer</param> + <param name="copyAttributes">Boolean, if this is true, then the new featureset will have + the same attributes as the original.</param> + <returns>The newly created IFeatureSet</returns> + </member> + <member name="M:DotSpatial.Data.FeatureSetExt.CombinedFields(DotSpatial.Data.IFeatureSet,DotSpatial.Data.IFeatureSet)"> + <summary> + Generates an empty featureset that has the combined fields from this featureset + and the specified featureset. + </summary> + <param name="self">This featureset</param> + <param name="other">The other featureset to combine fields with.</param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.FeatureSetExt.Dissolve(DotSpatial.Data.IFeatureSet,System.String)"> + <summary> + Calculates a union of any features that have a common value in the specified field. + The output will only contain the specified field. Example: Disolving a county + shapefile based on state name to produce a single polygon shaped like the state. + </summary> + <param name="self">The original featureSet to disolve the features of</param> + <param name="fieldName">The string field name to use for the disolve operation</param> + <returns>A featureset where the geometries of features with the same attribute in the specified field have been combined.</returns> + </member> + <member name="M:DotSpatial.Data.FeatureSetExt.Intersects(DotSpatial.Data.IFeature,DotSpatial.Topology.IEnvelope)"> + <summary> + Tests to see if this feature intersects with the specified envelope + </summary> + <param name="self">This feature</param> + <param name="env">The envelope to test</param> + <returns>Boolean, true if the intersection occurs</returns> + </member> + <member name="M:DotSpatial.Data.FeatureSetExt.UnionShapes(DotSpatial.Data.IFeatureSet,DotSpatial.Data.ShapeRelateType)"> + <summary> + This method will create a new IFeatureSet with the the shapes that intersect merged into single shapes, + or else it will return a new featureset where EVERY shape is unioned into a single, multi-part shape. + </summary> + <param name="self">The source of features to union</param> + <param name="style">This controls whether intersecting or all features are unioned</param> + <returns>An IFeatureSet with the unioned shapes.</returns> + </member> + <member name="M:DotSpatial.Data.FeatureSetExt.Intersection(DotSpatial.Data.IFeatureSet,DotSpatial.Data.IFeatureSet,DotSpatial.Data.FieldJoinType,DotSpatial.Data.IProgressHandler)"> + <summary> + This tests each feature of the input + </summary> + <param name="self">This featureSet</param> + <param name="other">The featureSet to perform intersection with</param> + <param name="joinType">The attribute join type</param> + <param name="progHandler">A progress handler for status messages</param> + <returns>An IFeatureSet with the intersecting features, broken down based on the join Type</returns> + </member> + <member name="T:DotSpatial.Data.FeatureTypeMismatchException"> + <summary> + FeatureTypeMismatchException + </summary> + </member> + <member name="M:DotSpatial.Data.FeatureTypeMismatchException.#ctor"> + <summary> + Creates a new instance of FeatureTypeMismatchException + </summary> + </member> + <member name="T:DotSpatial.Data.FieldJoinType"> + <summary> + FieldJoinType + </summary> + </member> + <member name="F:DotSpatial.Data.FieldJoinType.All"> + <summary> + Output datasets have all fields from both input and output sets. Fields with duplicate field names will be appended with a number. + Features from this dataset may appear more than once if more than one valid intersection occurs with the features from the + other featureset. + </summary> + </member> + <member name="F:DotSpatial.Data.FieldJoinType.ForeignOnly"> + <summary> + The fields will be created from the fields in the other featureset. + </summary> + </member> + <member name="F:DotSpatial.Data.FieldJoinType.LocalOnly"> + <summary> + All the fields from this FeatureSet are used, and all of the features from the other featureset are considered + to be a single geometry so that features from this set will appear no more than once in the output set. + </summary> + </member> + <member name="F:DotSpatial.Data.FieldJoinType.None"> + <summary> + No fields will be copied, but features from this featureset will be considered independantly and added as separate + features to the output featureset. + </summary> + </member> + <member name="F:DotSpatial.Data.AttributeCache.EditRow"> + <summary> + The row being edited + </summary> + </member> + <member name="F:DotSpatial.Data.AttributeCache.Pages"> + <summary> + The pages currently stored in the cache + </summary> + </member> + <member name="M:DotSpatial.Data.AttributeCache.#ctor(DotSpatial.Data.IAttributeSource,System.Int32)"> + <summary> + Constructs a new Cache object that can create data tables by using a DataPageRetriever + </summary> + <param name="dataSupplier">Any structure that implements IDataPageRetriever</param> + <param name="rowsPerPage">The rows per page</param> + </member> + <member name="M:DotSpatial.Data.AttributeCache.GetEnumerator"> + <inheritdoc /> + </member> + <member name="M:DotSpatial.Data.AttributeCache.SaveChanges"> + <summary> + Saves the changes in the edit row to the tabular cache as well as the underlying database + </summary> + </member> + <member name="M:DotSpatial.Data.AttributeCache.RetrieveElement(System.Int32)"> + <summary> + Obtains the element at the specified index + </summary> + <param name="rowIndex"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.AttributeCache.RetrieveElement(System.Int32,System.Int32)"> + <summary> + Obtains the element at the specified index + </summary> + <param name="rowIndex"></param> + <param name="columnIndex"></param> + <returns></returns> + </member> + <member name="P:DotSpatial.Data.AttributeCache.EditRowIndex"> + <summary> + The integer index of the row being edited + </summary> + </member> + <member name="P:DotSpatial.Data.AttributeCache.NumRows"> + <summary> + The number of rows in the data supply + </summary> + </member> + <member name="T:DotSpatial.Data.AttributeCache.AttributeCacheEnumerator"> + <summary> + Enumerates the dictionaries that represent row content stored by field name. + </summary> + </member> + <member name="M:DotSpatial.Data.AttributeCache.AttributeCacheEnumerator.#ctor(DotSpatial.Data.AttributeCache)"> + <summary> + Creates a new AttributeCacheEnumerator + </summary> + <param name="cache"></param> + </member> + <member name="M:DotSpatial.Data.AttributeCache.AttributeCacheEnumerator.Dispose"> + <inheritdoc /> + </member> + <member name="M:DotSpatial.Data.AttributeCache.AttributeCacheEnumerator.MoveNext"> + <inheritdoc /> + </member> + <member name="M:DotSpatial.Data.AttributeCache.AttributeCacheEnumerator.Reset"> + <inheritdoc /> + </member> + <member name="P:DotSpatial.Data.AttributeCache.AttributeCacheEnumerator.Current"> + <inheritdoc /> + </member> + <member name="P:DotSpatial.Data.AttributeCache.AttributeCacheEnumerator.System#Collections#IEnumerator#Current"> + <inheritdoc /> + </member> + <member name="T:DotSpatial.Data.AttributeCache.DataPage"> + <summary> + Represents one page of data. + </summary> + </member> + <member name="F:DotSpatial.Data.AttributeCache.DataPage.Table"> + <summary> + The data Table + </summary> + </member> + <member name="M:DotSpatial.Data.AttributeCache.DataPage.#ctor(System.Data.DataTable,System.Int32)"> + <summary> + A Data page representing one page of data-row values + </summary> + <param name="table">The DataTable that controls the content</param> + <param name="rowIndex">The integer row index</param> + </member> + <member name="M:DotSpatial.Data.AttributeCache.DataPage.Contains(System.Int32)"> + <summary> + Tests to see if the specified index is in this page. + </summary> + <param name="index"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.AttributeCache.DataPage.MapToLowerBoundary(System.Int32)"> + <summary> + Given an arbitrary row index, this calculates what the lower boundary would be for the page containing the index + </summary> + <param name="rowIndex"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.AttributeCache.DataPage.MapToUpperBoundary(System.Int32)"> + <summary> + Given an arbitrary row index, this calculates the upper boundary for the page containing the index + </summary> + <param name="rowIndex"></param> + <returns></returns> + </member> + <member name="P:DotSpatial.Data.AttributeCache.DataPage.LowestIndex"> + <summary> + The integer lowest index of the page + </summary> + </member> + <member name="P:DotSpatial.Data.AttributeCache.DataPage.HighestIndex"> + <summary> + The integer highest index of the page + </summary> + </member> + <member name="T:DotSpatial.Data.AttributePager"> + <summary> + AttributePager + </summary> + </member> + <member name="M:DotSpatial.Data.AttributePager.#ctor(DotSpatial.Data.IAttributeSource,System.Int32)"> + <summary> + Creates a new instance of AttributePager + </summary> + </member> + <member name="M:DotSpatial.Data.AttributePager.GetEnumerator"> + <inheritdoc /> + </member> + <member name="M:DotSpatial.Data.AttributePager.Dispose"> + <summary> + Does nothing + </summary> + </member> + <member name="M:DotSpatial.Data.AttributePager.MoveNext"> + <summary> + Advances to the next attribute + </summary> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.AttributePager.Reset"> + <summary> + reset the attribute pager + </summary> + </member> + <member name="M:DotSpatial.Data.AttributePager.NumPages"> + <summary> + The integer number of pages + </summary> + <returns>the number of pages</returns> + </member> + <member name="M:DotSpatial.Data.AttributePager.RowCount(System.Int32)"> + <summary> + Gets the number of rows on the specified page. + </summary> + <param name="pageindex">The page index</param> + <returns>The number of rows that should be on that page.</returns> + </member> + <member name="M:DotSpatial.Data.AttributePager.Row(System.Int32)"> + <summary> + Loads the appropriate page if it isn't loaded already and returns the DataRow that + matches the specified index + </summary> + <param name="rowIndex">The integer row index</param> + <returns>The DataRow</returns> + </member> + <member name="M:DotSpatial.Data.AttributePager.PageOfRow(System.Int32)"> + <summary> + Returns the page that the specified row is on + </summary> + <param name="rowIndex">The integer row index</param> + <returns>The page of the row in question</returns> + </member> + <member name="P:DotSpatial.Data.AttributePager.Current"> + <summary> + Gets the current table + </summary> + </member> + <member name="P:DotSpatial.Data.AttributePager.StartIndex"> + <summary> + Gets the starting row index of the current page. + </summary> + </member> + <member name="P:DotSpatial.Data.AttributePager.PageSize"> + <summary> + Gets the pages size as a count of the number of rows each data table page should hold + </summary> + </member> + <member name="P:DotSpatial.Data.AttributePager.Item(System.Int32)"> + <summary> + This returns the data table for the corresponding page index, but also sets the + Pager so that it is sitting on the specified page index. + </summary> + <param name="pageIndex"></param> + <returns></returns> + </member> + <member name="T:DotSpatial.Data.AttributeTable"> + <summary> + A class for controlling the attribute Table related information for a shapefile. + </summary> + </member> + <member name="F:DotSpatial.Data.AttributeTable._isFilling"> + <summary> + Indicates that the Fill methode is called from inside itself. + </summary> + </member> + <member name="M:DotSpatial.Data.AttributeTable.#ctor"> + <summary> + Creates a new instance of an attribute Table with no file reference + </summary> + </member> + <member name="M:DotSpatial.Data.AttributeTable.#ctor(System.String)"> + <summary> + Creates a new AttributeTable with the specified fileName, or opens + an existing file with that name. + </summary> + <param name="fileName"></param> + </member> + <member name="M:DotSpatial.Data.AttributeTable.SupplyPageOfData(System.Int32,System.Int32)"> + <summary> + Reads just the content requested in order to satisfy the paging ability of VirtualMode for the DataGridView + </summary> + <param name="lowerPageBoundary"></param> + <param name="rowsPerPage"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.AttributeTable.SupplyPageOfData(System.Int32,System.Int32,System.String)"> + <summary> + Reads just the content requested. + </summary> + <param name="lowerPageBoundary">starting row</param> + <param name="rowsPerPage">number of rows to return</param> + <param name="fieldName">field for which data is to be returned</param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.AttributeTable.SupplyPageOfData(System.Int32,System.Int32,System.Collections.Generic.IEnumerable{System.String})"> + <summary> + Reads just the contents requested. Faster than returning the entire record if you have lots of attributes but only want a few. + </summary> + <param name="lowerPageBoundary">starting row</param> + <param name="rowsPerPage">number of rows to return</param> + <param name="fieldNames">fields for which data is to be returned</param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.AttributeTable.SetAttributes(System.Int32,System.Data.DataTable)"> + <summary> + Reads just the content requested in order to satisfy the paging ability of VirtualMode for the DataGridView + </summary> + <param name="startRow">The 0 based integer index of the start row</param> + <param name="dataValues">The DataTable with the 0 row corresponding to the start row. If this exceeds the size of the data table, it will add rows.</param> + </member> + <member name="M:DotSpatial.Data.AttributeTable.GetAttributes(System.Collections.Generic.IEnumerable{System.Int32})"> + <summary> + Get a DataTable containing the specified rows + </summary> + <param name="rowNumbers"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.AttributeTable.GetFileIndex(System.Int32)"> + <summary> + Accounts for deleted rows and returns the index as it appears in the file + </summary> + <param name="rowIndex"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.AttributeTable.GetRowIndexFromFileIndex(System.Int32)"> + <summary> + Accounts for deleted rows and adjusts a file index to a row index + </summary> + <param name="fileIndex"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.AttributeTable.AddRow(System.Collections.Generic.Dictionary{System.String,System.Object})"> + <summary> + Saves the new row to the data source and updates the file with new content. + </summary> + <param name="values">The values organized against the dictionary of field names.</param> + </member> + <member name="M:DotSpatial.Data.AttributeTable.RemoveRowAt(System.Int32)"> + <summary> + Removes the row at the specified row index from both the table in memory + and by marking it as deleted in the file. This should work even in cases + where the file is very large and working as an AttributeSource. + </summary> + <param name="index"></param> + </member> + <member name="M:DotSpatial.Data.AttributeTable.AddRow(System.Data.DataRow)"> + <summary> + Saves the new row to the data source and updates the file with new content. + </summary> + <param name="values">The values organized against the dictionary of field names.</param> + </member> + <member name="M:DotSpatial.Data.AttributeTable.Edit(System.Int32,System.Collections.Generic.Dictionary{System.String,System.Object})"> + <summary> + saves a single row to the data source. + </summary> + <param name="index">the integer row (or FID) index</param> + <param name="values">The object array holding the new values to store.</param> + </member> + <member name="M:DotSpatial.Data.AttributeTable.Edit(System.Int32,System.Data.DataRow)"> + <summary> + saves a single row to the data source. + </summary> + <param name="index">the integer row (or FID) index</param> + <param name="values">The object array holding the new values to store.</param> + </member> + <member name="M:DotSpatial.Data.AttributeTable.Edit(System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.Int32,System.Data.DataRow}})"> + <summary> + saves a collection of rows to the data source + </summary> + <param name="indexDataRowPairs"></param> + </member> + <member name="M:DotSpatial.Data.AttributeTable.Edit(System.Collections.Generic.IEnumerable{System.Int32},DotSpatial.Data.RowEditEvent)"> + <summary> + Edit the specified rows via a client supplied callback + </summary> + <param name="indices">rows to edit</param> + <param name="rowCallback">client supplied callback</param> + </member> + <member name="M:DotSpatial.Data.AttributeTable.BeginEdit"> + <summary> + Setup before calls to OverwriteDataRow + </summary> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.AttributeTable.EndEdit"> + <summary> + Cleanup after finished calling OverwriteDataRow + </summary> + </member> + <member name="M:DotSpatial.Data.AttributeTable.OverwriteDataRow(System.Int32,System.Object,DotSpatial.Data.NumberConverter[])"> + <summary> + Common code for editing an existing row in the data source + </summary> + <param name="index"></param> + <param name="values"></param> + <param name="ncs"></param> + </member> + <member name="M:DotSpatial.Data.AttributeTable.ReadTableRow(System.Int32,System.Int32,System.Byte[],System.Data.DataTable)"> + <summary> + Read a single dbase record + </summary> + <returns>Returns an IFeature with information appropriate for the current row in the Table</returns> + </member> + <member name="M:DotSpatial.Data.AttributeTable.Open(System.String)"> + <summary> + Reads all the information from the file, including the vector shapes and the database component. + </summary> + </member> + <member name="M:DotSpatial.Data.AttributeTable.Open(System.String,System.Collections.Generic.List{System.Int32})"> + <summary> + Reads the header and if deletedRows is null, searches file for deletedRows if file size indicates possibility of deleted rows. + </summary> + <param name="fileName"></param> + <param name="deletedRows"></param> + </member> + <member name="M:DotSpatial.Data.AttributeTable.Fill(System.Int32)"> + <summary> + This populates the Table with data from the file. + </summary> + <param name="numRows">In the event that the dbf file is not found, this indicates how many blank rows should exist in the attribute Table.</param> + </member> + <member name="M:DotSpatial.Data.AttributeTable.Save"> + <summary> + Attempts to save the file to the path specified by the Filename property. + This should be the .shp extension. + </summary> + </member> + <member name="M:DotSpatial.Data.AttributeTable.SaveAs(System.String,System.Boolean)"> + <summary> + Saves this Table to the specified fileName + </summary> + <param name="fileName">The string fileName to save to</param> + <param name="overwrite">A boolean indicating whether or not to write over the file if it exists.</param> + </member> + <member name="M:DotSpatial.Data.AttributeTable.ColumnNameExists(System.String)"> + <summary> + Tests to see if the list of columns contains the specified name or not. + </summary> + <param name="name">Name of the column we're looking for.</param> + <returns>True, if the column exists.</returns> + </member> + <member name="M:DotSpatial.Data.AttributeTable.WriteTable"> + <summary> + This appends the content of one datarow to a dBase file. + </summary> + <exception cref="T:System.ArgumentNullException">The columnValues parameter was null</exception> + <exception cref="T:System.InvalidOperationException">Header records need to be written first.</exception> + <exception cref="T:System.IO.InvalidDataException">Table property of columnValues parameter cannot be null.</exception> + </member> + <member name="M:DotSpatial.Data.AttributeTable.WriteSpaces(System.Int32)"> + <summary> + Writes a number of spaces equal to numspaces + </summary> + <param name="numspaces">The integer number of spaces to write</param> + </member> + <member name="M:DotSpatial.Data.AttributeTable.Write(System.Double,System.Int32,System.Int32)"> + <summary> + + </summary> + <param name="number"></param> + <param name="length"></param> + <param name="decimalCount"></param> + </member> + <member name="M:DotSpatial.Data.AttributeTable.Write(System.Int64,System.Int32,System.Int32)"> + <summary> + Writes an integer so that it is formatted for dbf. This is still buggy since it is possible to lose info here. + </summary> + <param name="number">The long value</param> + <param name="length">The length of the field.</param> + <param name="decimalCount">The number of digits after the decimal</param> + </member> + <member name="M:DotSpatial.Data.AttributeTable.Write(System.String,System.Int32)"> + <summary> + + </summary> + <param name="text"></param> + <param name="length"></param> + </member> + <member name="M:DotSpatial.Data.AttributeTable.WriteDate(System.DateTime)"> + <summary> + + </summary> + <param name="date"></param> + </member> + <member name="M:DotSpatial.Data.AttributeTable.Write(System.Boolean)"> + <summary> + + </summary> + <param name="flag"></param> + </member> + <member name="M:DotSpatial.Data.AttributeTable.WriteHeader(System.IO.BinaryWriter)"> + <summary> + Write the header data to the DBF file. + </summary> + <param name="writer"></param> + </member> + <member name="M:DotSpatial.Data.AttributeTable.ReadTableRowFromChars(System.Int32,System.IO.BinaryReader)"> + <summary> + Read a single dbase record + </summary> + <returns>Returns an IFeature with information appropriate for the current row in the Table</returns> + </member> + <member name="M:DotSpatial.Data.AttributeTable.ParseColumn(DotSpatial.Data.Field,System.Int32,System.Char[],System.Data.DataTable)"> + <summary> + Parse the character data for one column into an object ready for insertion into a data row + </summary> + <param name="field"></param> + <param name="currentRow"></param> + <param name="cBuffer"></param> + <param name="table"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.AttributeTable.ReadTableHeader(System.IO.BinaryReader)"> + <summary> + Read the header data from the DBF file. + </summary> + <param name="reader">BinaryReader containing the header.</param> + </member> + <member name="M:DotSpatial.Data.AttributeTable.UpgradeColumn(DotSpatial.Data.Field,System.Type,System.Int32,System.Int32,System.Data.DataTable)"> + <summary> + This systematically copies all the existing values to a new data column with the same properties, + but with a new data type. Values that cannot convert will be set to null. + </summary> + <param name="oldDataColumn">The old data column to update</param> + <param name="newDataType">The new data type that the column should become</param> + <param name="currentRow">The row up to which values should be changed for</param> + <param name="columnIndex">The column index of the field being changed</param> + <param name="table"> The Table to apply this strategy to.</param> + <returns>An integer list showing the index values of the rows where the conversion failed.</returns> + </member> + <member name="M:DotSpatial.Data.AttributeTable.OnAttributesFilled"> + <summary> + Fires the AttributesFilled event + </summary> + </member> + <member name="E:DotSpatial.Data.AttributeTable.AttributesFilled"> + <summary> + Occurs after content has been loaded into the attribute data. + </summary> + </member> + <member name="P:DotSpatial.Data.AttributeTable.AttributesPopulated"> + <summary> + gets or sets whether the Attributes have been populated. If data was "opened" from a file, + and a query is made to the DataTable while _attributesPopulated is false, then + a Fill method will be called automatically + </summary> + </member> + <member name="P:DotSpatial.Data.AttributeTable.HeaderLength"> + <summary> + The byte length of the header + </summary> + </member> + <member name="P:DotSpatial.Data.AttributeTable.Columns"> + <summary> + The columns + </summary> + </member> + <member name="P:DotSpatial.Data.AttributeTable.FileType"> + <summary> + The file type + </summary> + </member> + <member name="P:DotSpatial.Data.AttributeTable.Filename"> + <summary> + The fileName of the dbf file + </summary> + </member> + <member name="P:DotSpatial.Data.AttributeTable.NumRecords"> + <summary> + Number of records + </summary> + </member> + <member name="P:DotSpatial.Data.AttributeTable.ProgressHandler"> + <summary> + Gets or sets the progress handler for this Attribute Table. + </summary> + </member> + <member name="P:DotSpatial.Data.AttributeTable.ProgressMeter"> + <summary> + Gets or sets the progress meter that is directly tied to the progress handler + </summary> + </member> + <member name="P:DotSpatial.Data.AttributeTable.RecordLength"> + <summary> + The byte length of each record + </summary> + </member> + <member name="P:DotSpatial.Data.AttributeTable.LanguageDriverId"> + <summary> + Gets the language driver ID (LDID) for this file + </summary> + </member> + <member name="P:DotSpatial.Data.AttributeTable.Encoding"> + <summary> + Gets the encoding used for text-based data and column names (based on LDID) + </summary> + </member> + <member name="P:DotSpatial.Data.AttributeTable.Table"> + <summary> + DataSet + </summary> + </member> + <member name="P:DotSpatial.Data.AttributeTable.UpdateDate"> + <summary> + Last date written to + </summary> + </member> + <member name="P:DotSpatial.Data.AttributeTable.DeletedRows"> + <summary> + Gets the list of raw row numbers that have been marked for deletion + </summary> + </member> + <member name="T:DotSpatial.Data.LineShapefile"> + <summary> + A shapefile class that handles the special case where the vectors are lines + </summary> + </member> + <member name="T:DotSpatial.Data.Shapefile"> + <summary> + This is a generic shapefile that is inherited by other specific shapefile types. + </summary> + </member> + <member name="M:DotSpatial.Data.Shapefile.#ctor"> + <summary> + When creating a new shapefile, this simply prevents the basic values from being null. + </summary> + </member> + <member name="M:DotSpatial.Data.Shapefile.#ctor(DotSpatial.Topology.FeatureType)"> + <summary> + Creates a new shapefile that has a specific feature type + </summary> + <param name="featureType"></param> + </member> + <member name="M:DotSpatial.Data.Shapefile.#ctor(System.String)"> + <summary> + Creates a new instance of a shapefile based on a fileName + </summary> + <param name="fileName"></param> + </member> + <member name="M:DotSpatial.Data.Shapefile.GetCounts(System.String[],DotSpatial.Data.ICancelProgressHandler,System.Int32)"> + <summary> + Gets the count of members that match the expression + </summary> + <param name="expressions">The string expression to test</param> + <param name="progressHandler">THe progress handler that can also cancel the counting</param> + <param name="maxSampleSize">The integer maximum sample size from which to draw counts. If this is negative, it will not be used.</param> + <returns>The integer count of the members that match the expression.</returns> + </member> + <member name="M:DotSpatial.Data.Shapefile.AttributeTableAttributesFilled(System.Object,System.EventArgs)"> + <summary> + This makes the assumption that the organization of the feature list has not + changed since loading the attribute content. + </summary> + <param name="sender"></param> + <param name="e"></param> + </member> + <member name="M:DotSpatial.Data.Shapefile.OpenFile(System.String)"> + <summary> + This will return the correct shapefile type by reading the fileName. + </summary> + <param name="fileName">A string specifying the file with the extension .shp to open.</param> + <returns>A correct shapefile object which is exclusively for reading the .shp data</returns> + </member> + <member name="M:DotSpatial.Data.Shapefile.OpenFile(System.String,DotSpatial.Data.IProgressHandler)"> + <summary> + This will return the correct shapefile type by reading the fileName. + </summary> + <param name="fileName">A string specifying the file with the extension .shp to open.</param> + <param name="progressHandler">receives progress messages and overrides the ProgressHandler on the DataManager.DefaultDataManager</param> + <returns>A correct shapefile object which is exclusively for reading the .shp data</returns> + </member> + <member name="M:DotSpatial.Data.Shapefile.Edit(System.Int32,System.Collections.Generic.Dictionary{System.String,System.Object})"> + <summary> + saves a single row to the data source. + </summary> + <param name="index">the integer row (or FID) index</param> + <param name="values">The object array holding the new values to store.</param> + </member> + <member name="M:DotSpatial.Data.Shapefile.Edit(System.Int32,System.Data.DataRow)"> + <summary> + saves a single row to the data source. + </summary> + <param name="index">the integer row (or FID) index</param> + <param name="values">The object array holding the new values to store.</param> + </member> + <member name="M:DotSpatial.Data.Shapefile.AddRow(System.Collections.Generic.Dictionary{System.String,System.Object})"> + <summary> + Saves the new row to the data source and updates the file with new content. + </summary> + <param name="values">The values organized against the dictionary of field names.</param> + </member> + <member name="M:DotSpatial.Data.Shapefile.AddRow(System.Data.DataRow)"> + <summary> + Saves the new row to the data source and updates the file with new content. + </summary> + <param name="values">The values organized against the dictionary of field names.</param> + </member> + <member name="M:DotSpatial.Data.Shapefile.GetAttributes(System.Int32,System.Int32)"> + <inheritdoc /> + </member> + <member name="M:DotSpatial.Data.Shapefile.SetAttributes(System.Int32,System.Data.DataTable)"> + <summary> + Converts a page of content from a DataTable format, saving it back to the source. + </summary> + <param name="startIndex">The 0 based integer index representing the first row in the file (corresponding to the 0 row of the data table)</param> + <param name="pageValues">The DataTable representing the rows to set. If the row count is larger than the dataset, this will add the rows instead.</param> + </member> + <member name="M:DotSpatial.Data.Shapefile.SelectByAttribute(System.String)"> + <inheritdoc /> + </member> + <member name="M:DotSpatial.Data.Shapefile.FillAttributes"> + <summary> + Reads the attributes from the specified attribute Table. + </summary> + </member> + <member name="M:DotSpatial.Data.Shapefile.SetupFeatureLookup"> + <summary> + Sets up the feature lookup, if it has not been already. + </summary> + </member> + <member name="M:DotSpatial.Data.Shapefile.WriteFileLength(System.String,System.Int32)"> + <summary> + This doesn't rewrite the entire header or erase the existing content. This simply replaces the file length + in the file with the new file length. This is generally because we want to write the header first, + but don't know the total length of a new file until cycling through the entire file. It is easier, therefore + to update the length after editing. + </summary> + <param name="fileName">A string fileName</param> + <param name="length">The integer length of the file in 16-bit words</param> + </member> + <member name="M:DotSpatial.Data.Shapefile.ToInt(System.Byte[],System.Int32@,System.Boolean)"> + <summary> + Reads 4 bytes from the specified byte array starting with offset. + If IsBigEndian = true, then this flips the order of the byte values. + </summary> + <param name="value">An array of bytes that is at least 4 bytes in length from the startIndex</param> + <param name="startIndex">A 0 based integer index where the double value begins</param> + <param name="isLittleEndian">If this is true, then the order of the bytes is reversed before being converted to a double</param> + <returns>A double created from reading the byte array</returns> + </member> + <member name="M:DotSpatial.Data.Shapefile.ToDouble(System.Byte[],System.Int32@,System.Boolean)"> + <summary> + Reads 8 bytes from the specified byte array starting with offset. + If IsBigEndian = true, then this flips the order of the byte values. + </summary> + <param name="value">An array of bytes that is at least 8 bytes in length from the startIndex</param> + <param name="startIndex">A 0 based integer index where the double value begins</param> + <param name="isLittleEndian">If this is true, then the order of the bytes is reversed before being converted to a double</param> + <returns>A double created from reading the byte array</returns> + </member> + <member name="M:DotSpatial.Data.Shapefile.WriteBytes(System.Byte[],System.Int32,System.Double,System.Boolean)"> + <summary> + Converts the double value into bytes and inserts them starting at startIndex into the destArray + </summary> + <param name="destArray">A byte array where the values should be written</param> + <param name="startIndex">The starting index where the values should be inserted</param> + <param name="value">The double value to convert</param> + <param name="isLittleEndian">Specifies whether the value should be written as big or little endian</param> + </member> + <member name="M:DotSpatial.Data.Shapefile.WriteBytes(System.Byte[],System.Int32,System.Int32,System.Boolean)"> + <summary> + Converts the double value into bytes and inserts them starting at startIndex into the destArray. + This will correct this system's natural byte order to reflect what is required to match the + shapefiles specification. + </summary> + <param name="destArray">A byte array where the values should be written</param> + <param name="startIndex">The starting index where the values should be inserted</param> + <param name="value">The integer value to convert</param> + <param name="isLittleEndian">Specifies whether the value should be written as big or little endian</param> + </member> + <member name="M:DotSpatial.Data.Shapefile.ReadIndexFile(System.String)"> + <summary> + Reads the entire index file in order to get a breakdown of how shapes are broken up. + </summary> + <param name="fileName">A string fileName of the .shx file to read.</param> + <returns>A List of ShapeHeaders that give offsets and lengths so that reading can be optimized</returns> + </member> + <member name="M:DotSpatial.Data.Shapefile.UpdateAttributes"> + <summary> + Ensures that the attribute Table will have information that matches the current Table of attribute information + </summary> + </member> + <member name="M:DotSpatial.Data.Shapefile.ReadProjection"> + <summary> + This uses the fileName of this shapefile to read the prj file of the same name + and stores the result in the Projection class. + </summary> + </member> + <member name="M:DotSpatial.Data.Shapefile.SaveProjection"> + <summary> + Automatically uses the fileName of this shapefile to save the projection + </summary> + </member> + <member name="M:DotSpatial.Data.Shapefile.GetAttributes(System.Int32,System.Int32,System.Collections.Generic.IEnumerable{System.String})"> + <summary> + Reads just the content requested in order to satisfy the paging ability of VirtualMode for the DataGridView + </summary> + <param name="startIndex">The integer lower page boundary</param> + <param name="numRows">The integer number of attribute rows to return for the page</param> + <param name="fieldNames">The list or array of fieldnames to return.</param> + <returns>A DataTable populated with data rows with only the specified values.</returns> + </member> + <member name="M:DotSpatial.Data.Shapefile.NumRows"> + <summary> + The number of rows + </summary> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.Shapefile.GetColumns"> + <summary> + This gets a copy of the actual internal list of columns. + This should never be used to make changes to the column collection. + </summary> + </member> + <member name="M:DotSpatial.Data.Shapefile.EnsureValidFileToSave(System.String,System.Boolean)"> + <summary> + Checks that shape file can be saved to given fileName. + </summary> + <param name="fileName">File name to save.</param> + <param name="overwrite">Overwrite file or not.</param> + </member> + <member name="M:DotSpatial.Data.Shapefile.HeaderSaveAs(System.String)"> + <summary> + Saves header + </summary> + <param name="fileName">File to save.</param> + </member> + <member name="P:DotSpatial.Data.Shapefile.BufferSize"> + <summary> + The buffer size is an integer value in bytes specifying how large a piece of memory can be used at any one time. + Reading and writing from the disk is faster when done all at once. The larger this number the more effective + the disk management, but the more ram will be required (and the more likely to trip an out of memory error). + </summary> + </member> + <member name="P:DotSpatial.Data.Shapefile.AttributesPopulated"> + <summary> + Gets whether or not the attributes have all been loaded into the data table. + </summary> + </member> + <member name="P:DotSpatial.Data.Shapefile.DataTable"> + <summary> + This re-directs the DataTable to work with the attribute Table instead. + </summary> + </member> + <member name="P:DotSpatial.Data.Shapefile.Header"> + <summary> + A general header structure that stores some basic information about the shapefile. + </summary> + </member> + <member name="P:DotSpatial.Data.Shapefile.Attributes"> + <summary> + Gets or sets the attribute Table used by this shapefile. + </summary> + </member> + <member name="P:DotSpatial.Data.Shapefile.FilePath"> + <inheritdoc /> + </member> + <member name="M:DotSpatial.Data.LineShapefile.#ctor"> + <summary> + Creates a new instance of a LineShapefile for in-ram handling only. + </summary> + </member> + <member name="M:DotSpatial.Data.LineShapefile.#ctor(System.String)"> + <summary> + Creates a new instance of a LineShapefile that is loaded from the supplied fileName. + </summary> + <param name="fileName">The string fileName of the polygon shapefile to load</param> + </member> + <member name="M:DotSpatial.Data.LineShapefile.Open(System.String,DotSpatial.Data.IProgressHandler)"> + <summary> + Opens a shapefile + </summary> + <param name="fileName">The string fileName of the line shapefile to load</param> + <param name="progressHandler">Any valid implementation of the DotSpatial.Data.IProgressHandler</param> + </member> + <member name="M:DotSpatial.Data.LineShapefile.GetFeature(System.Int32)"> + <summary> + Gets the specified feature by constructing it from the vertices, rather + than requiring that all the features be created. (which takes up a lot of memory). + </summary> + <param name="index">The integer index</param> + </member> + <member name="M:DotSpatial.Data.LineShapefile.SaveAs(System.String,System.Boolean)"> + <summary> + Saves the file to a new location + </summary> + <param name="fileName">The fileName to save</param> + <param name="overwrite">Boolean that specifies whether or not to overwrite the existing file</param> + </member> + <member name="T:DotSpatial.Data.MultiPointShapefile"> + <summary> + A shapefile class that handles the special case where each features has multiple points + </summary> + </member> + <member name="M:DotSpatial.Data.MultiPointShapefile.#ctor"> + <summary> + Creates a new instance of a MultiPointShapefile for in-ram handling only. + </summary> + </member> + <member name="M:DotSpatial.Data.MultiPointShapefile.#ctor(System.String)"> + <summary> + Creates a new instance of a MultiPointShapefile that is loaded from the supplied fileName. + </summary> + <param name="fileName">The string fileName of the polygon shapefile to load</param> + </member> + <member name="M:DotSpatial.Data.MultiPointShapefile.GetFeature(System.Int32)"> + <summary> + Gets the feature at the specified index offset + </summary> + <param name="index">the integer index</param> + <returns>An IFeature created from the shape at the specified offset</returns> + </member> + <member name="M:DotSpatial.Data.MultiPointShapefile.Open(System.String,DotSpatial.Data.IProgressHandler)"> + <summary> + Opens a shapefile + </summary> + <param name="fileName">The string fileName of the point shapefile to load</param> + <param name="progressHandler">Any valid implementation of the DotSpatial.Data.IProgressHandler</param> + </member> + <member name="M:DotSpatial.Data.MultiPointShapefile.SaveAs(System.String,System.Boolean)"> + <summary> + Saves the file to a new location + </summary> + <param name="fileName">The fileName to save</param> + <param name="overwrite">Boolean that specifies whether or not to overwrite the existing file</param> + </member> + <member name="T:DotSpatial.Data.NumberConverter"> + <summary> + Numbers are based on the old school dbf definitions of data formats, and so can only store + a very limited range of values. + </summary> + </member> + <member name="F:DotSpatial.Data.NumberConverter.MaximumLength"> + <summary> + Numbers can contain ASCII text up till 18 characters long, but no longer + </summary> + </member> + <member name="F:DotSpatial.Data.NumberConverter.NumberConversionFormatProvider"> + <summary> + Format provider to use to convert DBF numbers to strings and characters + </summary> + </member> + <member name="M:DotSpatial.Data.NumberConverter.#ctor(System.Int32,System.Int32)"> + <summary> + Creates a new instance of NumberConverter where the length and decimal count are known. + </summary> + </member> + <member name="M:DotSpatial.Data.NumberConverter.#ctor(System.Collections.Generic.IList{System.Double})"> + <summary> + Cycles through the numeric values in the specified column and determines a selection of + length and decimal count can accurately store the data. + </summary> + </member> + <member name="M:DotSpatial.Data.NumberConverter.RandomDouble"> + <summary> + Creates a new, random double that is constrained by the specified length and decimal count. + </summary> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.NumberConverter.RandomFloat"> + <summary> + Creates a new, random float that is constrained by the specified length and decimal count. + </summary> + <returns>A new float. Floats can only store about 8 digits of precision, so specifying a high </returns> + </member> + <member name="M:DotSpatial.Data.NumberConverter.RandomDecimal"> + <summary> + Creates a new, random decimal that is constrained by the specified length and decimal count. + </summary> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.NumberConverter.RandomChars(System.Int32)"> + <summary> + Creates a new random array of characters that represents a number and is constrained by the specified length and decimal count + </summary> + <param name="numDigits">The integer number of significant (non-zero) digits that should be created as part of the number.</param> + <returns>A character array of that matches the length and decimal count specified by this properties on this number converter</returns> + </member> + <member name="M:DotSpatial.Data.NumberConverter.FromString(System.String)"> + <summary> + Converts from a string, or 0 if the parse failed + </summary> + <param name="value">The string value to parse</param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.NumberConverter.ToString(System.Double)"> + <summary> + Converts the specified double value to a string that can be used for the number field + </summary> + <param name="number">The double precision floating point value to convert to a string</param> + <returns>A string version of the specified number</returns> + </member> + <member name="M:DotSpatial.Data.NumberConverter.ToString(System.Decimal)"> + <summary> + Converts the specified decimal value to a string that can be used for the number field + </summary> + <param name="number">The decimal value to convert to a string</param> + <returns>A string version of the specified number</returns> + </member> + <member name="M:DotSpatial.Data.NumberConverter.ToString(System.Single)"> + <summary> + Converts the specified float value to a string that can be used for the number field + </summary> + <param name="number">The floating point value to convert to a string</param> + <returns>A string version of the specified number</returns> + </member> + <member name="M:DotSpatial.Data.NumberConverter.ToChar(System.Double)"> + <summary> + Converts the specified decimal value to a string that can be used for the number field + </summary> + <param name="number">The decimal value to convert to a string</param> + <returns>A string version of the specified number</returns> + </member> + <member name="M:DotSpatial.Data.NumberConverter.ToChar(System.Single)"> + <summary> + Converts the specified decimal value to a string that can be used for the number field + </summary> + <param name="number">The decimal value to convert to a string</param> + <returns>A string version of the specified number</returns> + </member> + <member name="M:DotSpatial.Data.NumberConverter.ToChar(System.Decimal)"> + <summary> + Converts the specified decimal value to a string that can be used for the number field + </summary> + <param name="number">The decimal value to convert to a string</param> + <returns>A string version of the specified number</returns> + </member> + <member name="M:DotSpatial.Data.NumberConverter.UpdateDecimalFormatString"> + <summary> + Compute and update the DecimalFormatString from the precision specifier + </summary> + </member> + <member name="P:DotSpatial.Data.NumberConverter.Length"> + <summary> + Gets or set the length + </summary> + </member> + <member name="P:DotSpatial.Data.NumberConverter.DecimalCount"> + <summary> + Gets or sets the decimal count to use for this number converter + </summary> + </member> + <member name="P:DotSpatial.Data.NumberConverter.DecimalFormatString"> + <summary> + Gets or sets the format string used to convert doubles, floats, and decimals to strings + </summary> + </member> + <member name="T:DotSpatial.Data.NumberException"> + <summary> + NumberException + </summary> + </member> + <member name="M:DotSpatial.Data.NumberException.#ctor(System.String)"> + <summary> + An exception that is specifically fo the NumberConverter class + </summary> + <param name="message">The message for the exception</param> + </member> + <member name="T:DotSpatial.Data.PointShapefile"> + <summary> + A shapefile class that handles the special case where the data type is point + </summary> + </member> + <member name="M:DotSpatial.Data.PointShapefile.#ctor"> + <summary> + Creates a new instance of a PointShapefile for in-ram handling only. + </summary> + </member> + <member name="M:DotSpatial.Data.PointShapefile.#ctor(System.String)"> + <summary> + Creates a new instance of a PointShapefile that is loaded from the supplied fileName. + </summary> + <param name="fileName">The string fileName of the polygon shapefile to load</param> + </member> + <member name="M:DotSpatial.Data.PointShapefile.Open(System.String,DotSpatial.Data.IProgressHandler)"> + <summary> + Opens a shapefile + </summary> + <param name="fileName">The string fileName of the point shapefile to load</param> + <param name="progressHandler">Any valid implementation of the DotSpatial.Data.IProgressHandler</param> + </member> + <member name="M:DotSpatial.Data.PointShapefile.FillPoints(System.String,DotSpatial.Data.IProgressHandler)"> + <summary> + Obtains a typed list of ShapefilePoint structures with double values associated with the various coordinates. + </summary> + <param name="fileName">A string fileName</param> + <param name="progressHandler">Progress handler</param> + </member> + <member name="M:DotSpatial.Data.PointShapefile.GetFeature(System.Int32)"> + <inheritdoc /> + </member> + <member name="M:DotSpatial.Data.PointShapefile.SaveAs(System.String,System.Boolean)"> + <summary> + Saves the shapefile to a different fileName, but still as a shapefile. This method does not support saving to + any other file format. + </summary> + <param name="fileName">The string fileName to save as</param> + <param name="overwrite">A boolean that is true if the file should be overwritten</param> + </member> + <member name="T:DotSpatial.Data.PolygonShapefile"> + <summary> + A shapefile class that handles the special case where the data is made up of polygons + </summary> + </member> + <member name="M:DotSpatial.Data.PolygonShapefile.#ctor"> + <summary> + Creates a new instance of a PolygonShapefile for in-ram handling only. + </summary> + </member> + <member name="M:DotSpatial.Data.PolygonShapefile.#ctor(System.String)"> + <summary> + Creates a new instance of a PolygonShapefile that is loaded from the supplied fileName. + </summary> + <param name="fileName">The string fileName of the polygon shapefile to load</param> + </member> + <member name="M:DotSpatial.Data.PolygonShapefile.Open(System.String,DotSpatial.Data.IProgressHandler)"> + <summary> + Opens a shapefile + </summary> + <param name="fileName">The string fileName of the polygon shapefile to load</param> + <param name="progressHandler">Any valid implementation of the DotSpatial.Data.IProgressHandler</param> + </member> + <member name="M:DotSpatial.Data.PolygonShapefile.GetFeature(System.Int32)"> + <summary> + Gets the specified feature by constructing it from the vertices, rather + than requiring that all the features be created. (which takes up a lot of memory). + </summary> + <param name="index">The integer index</param> + </member> + <member name="M:DotSpatial.Data.PolygonShapefile.SaveAs(System.String,System.Boolean)"> + <summary> + Saves the file to a new location + </summary> + <param name="fileName">The fileName to save</param> + <param name="overwrite">Boolean that specifies whether or not to overwrite the existing file</param> + </member> + <member name="T:DotSpatial.Data.ShapefileHeader"> + <summary> + The header for the .shp file and the .shx file that support shapefiles + </summary> + </member> + <member name="M:DotSpatial.Data.ShapefileHeader.#ctor"> + <summary> + Creates a new, blank ShapeHeader + </summary> + </member> + <member name="M:DotSpatial.Data.ShapefileHeader.#ctor(System.String)"> + <summary> + Opens the specified fileName directly + </summary> + <param name="inFilename">The string fileName to open as a header.</param> + </member> + <member name="M:DotSpatial.Data.ShapefileHeader.Clear"> + <summary> + Resets all the extent values to 0 + </summary> + </member> + <member name="M:DotSpatial.Data.ShapefileHeader.Open(System.String)"> + <summary> + Parses the first 100 bytes of a shapefile into the important values + </summary> + <param name="inFilename">The fileName to read</param> + </member> + <member name="M:DotSpatial.Data.ShapefileHeader.Save"> + <summary> + Saves changes to the .shp file will also automatically update the .shx file. + </summary> + </member> + <member name="M:DotSpatial.Data.ShapefileHeader.SaveAs(System.String)"> + <summary> + Saves changes to the .shp file and will also automatically create the header for the .shx file. + This will no longer automatically delete an existing shapefile. + </summary> + <param name="outFilename">The string fileName to create.</param> + </member> + <member name="M:DotSpatial.Data.ShapefileHeader.Write(System.String,System.Int32)"> + <summary> + Writes the current content to the specified file. + </summary> + <param name="destFilename">The string fileName to write to</param> + <param name="destFileLength">The only difference between the shp header and the + shx header is the file length parameter.</param> + </member> + <member name="M:DotSpatial.Data.ShapefileHeader.ToEnvelope"> + <summary> + Generates a new envelope based on the extents of this shapefile. + </summary> + <returns>An Envelope</returns> + </member> + <member name="M:DotSpatial.Data.ShapefileHeader.ToExtent"> + <summary> + Generates a new extent from the shape header. This will infer the whether the ExtentMZ, ExtentM + or Extent class is the best implementation. Casting is required to access the higher + values from the Extent return type. + </summary> + <returns>Extent, which can be Extent, ExtentM, or ExtentMZ</returns> + </member> + <member name="M:DotSpatial.Data.ShapefileHeader.SetExtent(DotSpatial.Data.IExtent)"> + <summary> + The shape type is assumed to be fixed, and will control how the input extent is treated as far + as M and Z values, rather than updating the shape type based on the extent. + </summary> + </member> + <member name="P:DotSpatial.Data.ShapefileHeader.FileCode"> + <summary> + Gets or sets the integer file code that should always be 9994. + </summary> + </member> + <member name="P:DotSpatial.Data.ShapefileHeader.FileLength"> + <summary> + Gets or sets the integer file length in bytes + </summary> + </member> + <member name="P:DotSpatial.Data.ShapefileHeader.Filename"> + <summary> + Gets or sets the string fileName to use for this header + </summary> + </member> + <member name="P:DotSpatial.Data.ShapefileHeader.ShapeType"> + <summary> + Gets or sets the DotSpatial.Data.Shapefiles.ShapeType enumeration specifying + whether the shapes are points, lines, polygons etc. + </summary> + </member> + <member name="P:DotSpatial.Data.ShapefileHeader.ShxFilename"> + <summary> + Changes the extension of the fileName to .shx instead of .shp + </summary> + </member> + <member name="P:DotSpatial.Data.ShapefileHeader.Version"> + <summary> + Gets or sets the version, which should be 1000 + </summary> + </member> + <member name="P:DotSpatial.Data.ShapefileHeader.Xmin"> + <summary> + The minimum X coordinate for the values in the shapefile + </summary> + </member> + <member name="P:DotSpatial.Data.ShapefileHeader.Xmax"> + <summary> + The maximum X coordinate for the shapes in the shapefile + </summary> + </member> + <member name="P:DotSpatial.Data.ShapefileHeader.Ymin"> + <summary> + The minimum Y coordinate for the values in the shapefile + </summary> + </member> + <member name="P:DotSpatial.Data.ShapefileHeader.Ymax"> + <summary> + The maximum Y coordinate for the shapes in the shapefile + </summary> + </member> + <member name="P:DotSpatial.Data.ShapefileHeader.Zmin"> + <summary> + The minimum Z coordinate for the values in the shapefile + </summary> + </member> + <member name="P:DotSpatial.Data.ShapefileHeader.Zmax"> + <summary> + The maximum Z coordinate for the shapes in the shapefile + </summary> + </member> + <member name="P:DotSpatial.Data.ShapefileHeader.Mmin"> + <summary> + The minimum M coordinate for the values in the shapefile + </summary> + </member> + <member name="P:DotSpatial.Data.ShapefileHeader.Mmax"> + <summary> + The maximum M coordinate for the shapes in the shapefile + </summary> + </member> + <member name="P:DotSpatial.Data.ShapefileHeader.ShxLength"> + <summary> + Gets or sets the length of the shx file in 16 bit words. + </summary> + </member> + <member name="T:DotSpatial.Data.ShapeHeader"> + <summary> + A simple structure that contains the elements of a shapefile that must exist + </summary> + </member> + <member name="F:DotSpatial.Data.ShapeHeader.ContentLength"> + <summary> + The content length + </summary> + </member> + <member name="F:DotSpatial.Data.ShapeHeader.Offset"> + <summary> + The offset in 16-bit words + </summary> + </member> + <member name="P:DotSpatial.Data.ShapeHeader.ByteOffset"> + <summary> + The offset in bytes + </summary> + </member> + <member name="P:DotSpatial.Data.ShapeHeader.ByteLength"> + <summary> + The length in bytes + </summary> + </member> + <member name="T:DotSpatial.Data.FeatureSetPack"> + <summary> + The FeatureSetPack contains a MultiPoint, Line and Polygon FeatureSet which can + handle the various types of geometries that can arrive from a mixed geometry. + </summary> + </member> + <member name="F:DotSpatial.Data.FeatureSetPack.Lines"> + <summary> + The featureset with all the lines + </summary> + </member> + <member name="F:DotSpatial.Data.FeatureSetPack.Points"> + <summary> + The featureset with all the points + </summary> + </member> + <member name="F:DotSpatial.Data.FeatureSetPack.Polygons"> + <summary> + The featureset with all the polygons + </summary> + </member> + <member name="F:DotSpatial.Data.FeatureSetPack._polygonVertices"> + <summary> + Stores the raw vertices from the different shapes in a list while being created. + That way, the final array can be created one time. + </summary> + </member> + <member name="M:DotSpatial.Data.FeatureSetPack.#ctor"> + <summary> + Creates a new instance of the FeatureSetPack + </summary> + </member> + <member name="M:DotSpatial.Data.FeatureSetPack.GetEnumerator"> + <inheritdoc /> + </member> + <member name="M:DotSpatial.Data.FeatureSetPack.Clear"> + <summary> + Clears the vertices and sets up new featuresets. + </summary> + </member> + <member name="M:DotSpatial.Data.FeatureSetPack.Add(System.Double[],DotSpatial.Data.ShapeRange)"> + <summary> + Adds the shape. Assumes that the "part" indices are created with a 0 base, and the number of + vertices is specified. The start range of each part will be updated with the new shape range. + The vertices array itself iwll be updated during hte stop editing step. + </summary> + <param name="shapeVertices"></param> + <param name="shape"></param> + </member> + <member name="M:DotSpatial.Data.FeatureSetPack.StopEditing"> + <summary> + Finishes the featuresets by converting the lists + </summary> + </member> + <member name="M:DotSpatial.Data.FeatureSetPack.Combine(System.Collections.Generic.IEnumerable{System.Double[]},System.Int32)"> + <summary> + Combines the vertices, finalizing the creation + </summary> + <param name="verts"></param> + <param name="length"></param> + <returns></returns> + </member> + <member name="T:DotSpatial.Data.FeatureSetPack.FeatureSetPackEnumerator"> + <summary> + Enuemratres the FeatureSetPack in Polygon, Line, Point order. If any member + is null, it skips that member. + </summary> + </member> + <member name="M:DotSpatial.Data.FeatureSetPack.FeatureSetPackEnumerator.#ctor(DotSpatial.Data.FeatureSetPack)"> + <summary> + Creates the FeatureSetPackEnumerator based on the specified FeaturSetPack + </summary> + <param name="parent">The Pack</param> + </member> + <member name="M:DotSpatial.Data.FeatureSetPack.FeatureSetPackEnumerator.Dispose"> + <inheritdoc /> + </member> + <member name="M:DotSpatial.Data.FeatureSetPack.FeatureSetPackEnumerator.MoveNext"> + <inheritdoc /> + </member> + <member name="M:DotSpatial.Data.FeatureSetPack.FeatureSetPackEnumerator.Reset"> + <inheritdoc /> + </member> + <member name="P:DotSpatial.Data.FeatureSetPack.FeatureSetPackEnumerator.Current"> + <inheritdoc /> + </member> + <member name="T:DotSpatial.Data.WkbFeatureReader"> + <summary> + WKBPointReader + </summary> + </member> + <member name="M:DotSpatial.Data.WkbFeatureReader.CheckEndian(System.Byte[],System.Int32)"> + <summary> + Given the array of bytes, this reverses the bytes based on size. So if size if 4, the + reversal will flip uints of 4 bytes at a time. + </summary> + <param name="data"></param> + <param name="size"></param> + </member> + <member name="M:DotSpatial.Data.WkbFeatureReader.ReadInt32(System.IO.Stream)"> + <summary> + + </summary> + <param name="data">The raw byte data.</param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.WkbFeatureReader.ReadInt32(System.IO.Stream,System.Int32)"> + <summary> + + </summary> + <param name="data">The raw byte data.</param> + <param name="count">The count of integers, not bytes.</param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.WkbFeatureReader.ReadDouble(System.IO.Stream,System.Int32)"> + <summary> + Reads the specified number of doubles + </summary> + <param name="data"></param> + <param name="count"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.WkbFeatureReader.GetFeatureSets(System.Byte[])"> + <summary> + Since WKB can in fact store different kinds of shapes, this will split out + each type of shape into a different featureset. If all the shapes are + the same kind of feature, thre will only be one list of feature types. + </summary> + <param name="data"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.WkbFeatureReader.GetFeatureSets(System.IO.Stream)"> + <summary> + Gets a FeatureSetPack from the wkb + </summary> + <param name="data"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.WkbFeatureReader.ReadFeature(System.IO.Stream,DotSpatial.Data.FeatureSetPack)"> + <summary> + Reads only a single geometry into a feature. This may be a multi-part geometry. + </summary> + <param name="data"></param> + <param name="results"></param> + </member> + <member name="M:DotSpatial.Data.WkbFeatureReader.ReadShape(System.IO.Stream)"> + <summary> + Reads only a single geometry into a feature. This may be a multi-part geometry, + but cannot be a mixed part geometry. Anything that registers as "geometryCollection" + will trigger an exception. + </summary> + <param name="data"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.WkbFeatureReader.ReadShape(System.IO.Stream,DotSpatial.Topology.FeatureType)"> + <summary> + Attempts to read in an entry to the specified feature type. If the feature type does not match + the geometry type, this will return null. (A Point geometry will be accepted by MultiPoint + feature type, but not the other way arround. Either way, this will advance the reader + through the shape feature. Using the Unspecified will always return the shape it reads, + or null in the case of mixed feature collections which are not supported. + </summary> + <param name="data"></param> + <param name="featureType"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.WkbFeatureReader.ReadPoint(System.IO.Stream)"> + <summary> + This assumes that the byte order and shapetype have already been read. + </summary> + <param name="data"></param> + </member> + <member name="M:DotSpatial.Data.WkbFeatureReader.ReadPoint(System.IO.Stream,DotSpatial.Data.FeatureSetPack)"> + <summary> + This assumes that the byte order and shapetype have already been read. + </summary> + <param name="data"></param> + <param name="results"></param> + </member> + <member name="M:DotSpatial.Data.WkbFeatureReader.ReadMultiPoint(System.IO.Stream)"> + <summary> + Reads one multipoint shape from a data stream. + (this assumes that the two bytes (endian and type) have already been read. + </summary> + <param name="data"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.WkbFeatureReader.ReverseCoords(System.Double[])"> + <summary> + Fix introduced by JamesP@esdm.co.uk. 3/11/2010 + Using Array.Reverse does not work because it has the unwanted effect of flipping + the X and Y values. + </summary> + <param name="coords">The double precision XY coordinate array of vertices</param> + <returns>The double array in reverse order.</returns> + </member> + <member name="M:DotSpatial.Data.WkbFeatureReader.IsCounterClockwise(System.Double[])"> + <summary> + Calculates the area and if the area is negative, this is considered a hole. + </summary> + <returns>Boolean, true if this has a negative area and should be thought of as a hole</returns> + </member> + <member name="T:DotSpatial.Data.PartRange"> + <summary> + Vertices require methods to work quickly with data. These are not designed to be inherited, + overridden or equiped with interfaces and properties. + </summary> + </member> + <member name="T:DotSpatial.Data.VertexRange"> + <summary> + RangeIndex + </summary> + </member> + <member name="M:DotSpatial.Data.VertexRange.#ctor"> + <summary> + Creates an empty vertex range that can have the vertices and number of vertices assigned later + </summary> + </member> + <member name="M:DotSpatial.Data.VertexRange.#ctor(System.Double[],System.Int32,System.Int32)"> + <summary> + Creates a new instance of RangeIndex + </summary> + <param name="allVertices">An array of all the vertex locations</param> + <param name="shapeOffset"></param> + <param name="partOffset"></param> + </member> + <member name="M:DotSpatial.Data.VertexRange.GetEnumerator"> + <summary> + Gets an enumerator. This exists to make it easier to cycle values, + but in truth should not be used because it re-adds the property accessor + which slows down the data access, which is the whole point of putting + all the vertices into a jagged array of doubles in the first place. + </summary> + <returns></returns> + </member> + <member name="P:DotSpatial.Data.VertexRange.PartOffset"> + <summary> + For parts, controlling the part offset is perhaps more useful that controlling the shape offset. + </summary> + </member> + <member name="P:DotSpatial.Data.VertexRange.ShapeOffset"> + <summary> + The StartIndex is the sum of the shape offset and the part offset. Controlling them separately + allows the entire shape offset to be adjusted independantly after the part is created. + </summary> + </member> + <member name="P:DotSpatial.Data.VertexRange.StartIndex"> + <summary> + The integer index of the first vertex included in this range. This is overridden + in the case of part ranges to also take into account the shape start index. + </summary> + </member> + <member name="P:DotSpatial.Data.VertexRange.EndIndex"> + <summary> + the integer index of the last vertex included in this range + </summary> + </member> + <member name="P:DotSpatial.Data.VertexRange.NumVertices"> + <summary> + Gets or sets the number of vertices. This will also set the EndIndex + relative to the start position. + </summary> + </member> + <member name="P:DotSpatial.Data.VertexRange.Vertices"> + <summary> + Gets or sets the vertices + </summary> + </member> + <member name="T:DotSpatial.Data.VertexRange.VertexRangeEnumerator"> + <summary> + The enumerator is here to provide an easy method for cycling vertex values + in each range. This sort of defeats the point because it adds + two method calls for advancing each step (one to MoveNext and one to + access the property. The whole point of loading everything + into a single array of vertices in the first place is to avoid + property accessors slowing down the process. However, it's here + if someone wants it. + </summary> + </member> + <member name="M:DotSpatial.Data.VertexRange.VertexRangeEnumerator.#ctor(System.Double[],System.Int32,System.Int32)"> + <summary> + Creates a new instance of the VertexRangeEnumerator + </summary> + <param name="vertices">The vertices to create</param> + <param name="start">The integer index of the first included vertex </param> + <param name="end">The integer index of the last included vertex</param> + </member> + <member name="M:DotSpatial.Data.VertexRange.VertexRangeEnumerator.Dispose"> + <summary> + This does nothing + </summary> + </member> + <member name="M:DotSpatial.Data.VertexRange.VertexRangeEnumerator.MoveNext"> + <summary> + Advances the enumerator to the next position + </summary> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.VertexRange.VertexRangeEnumerator.Reset"> + <summary> + Resets this enumerator to the beginning of the range of vertices + </summary> + </member> + <member name="P:DotSpatial.Data.VertexRange.VertexRangeEnumerator.Current"> + <summary> + Gets the current value. + </summary> + </member> + <member name="M:DotSpatial.Data.PartRange.#ctor(DotSpatial.Topology.FeatureType)"> + <summary> + StartRange, count and vertices will be declared later. + </summary> + <param name="featureType"></param> + </member> + <member name="M:DotSpatial.Data.PartRange.#ctor(System.Double[],System.Int32,System.Int32,DotSpatial.Topology.FeatureType)"> + <summary> + Creates a new instance of Part + </summary> + <param name="allVertices">An array of all the vertex locations</param> + <param name="shapeOffset">The point index of the shape. </param> + <param name="partOffset">The ponit index of the part.</param> + <param name="featureType">The type of features.</param> + </member> + <member name="M:DotSpatial.Data.PartRange.Clone"> + <summary> + This returns a shallow copy, and expects any resetting of the vertex arrays to occur at a + higher level. + </summary> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.PartRange.IsHole"> + <summary> + Calculates the area and if the area is negative, this is considered a hole. + </summary> + <returns>Boolean, true if this has a negative area and should be thought of as a hole</returns> + </member> + <member name="M:DotSpatial.Data.PartRange.CalculateExtent"> + <summary> + This creates a new extent and cylces through the coordinates to calculate what it is. + Since the vertices may change so easilly, this is not cached. + </summary> + <returns></returns> + </member> + <member name="P:DotSpatial.Data.PartRange.Segments"> + <summary> + Gets a segment range enumerator. + </summary> + </member> + <member name="T:DotSpatial.Data.Segment"> + <summary> + Segment + </summary> + </member> + <member name="F:DotSpatial.Data.Segment.P1"> + <summary> + The start point of the segment + </summary> + </member> + <member name="F:DotSpatial.Data.Segment.P2"> + <summary> + the end point of the segment + </summary> + </member> + <member name="M:DotSpatial.Data.Segment.#ctor(System.Double,System.Double,System.Double,System.Double)"> + <summary> + Creates a segment from double valued ordinates. + </summary> + <param name="x1"></param> + <param name="y1"></param> + <param name="x2"></param> + <param name="y2"></param> + </member> + <member name="M:DotSpatial.Data.Segment.#ctor(DotSpatial.Data.Vertex,DotSpatial.Data.Vertex)"> + <summary> + Creates a new instance of Segment + </summary> + </member> + <member name="M:DotSpatial.Data.Segment.Intersects(DotSpatial.Data.Segment)"> + <summary> + Uses the intersection count to detect if there is an intersection + </summary> + <param name="other"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.Segment.DistanceTo(DotSpatial.Topology.Coordinate)"> + <summary> + Calculates the shortest distance to this line segment from the specified MapWinGIS.Point + </summary> + <param name="point">A MapWinGIS.Point specifing the location to find the distance to the line</param> + <returns>A double value that is the shortest distance from the given Point to this line segment</returns> + </member> + <member name="M:DotSpatial.Data.Segment.ClosestPointTo(DotSpatial.Data.Vertex)"> + <summary> + Returns a vertex representing the closest point on this line segment from a given vertex + </summary> + <param name="point">The point we want to be close to</param> + <returns>The point on this segment that is closest to the given point</returns> + </member> + <member name="M:DotSpatial.Data.Segment.ClosestPointTo(DotSpatial.Data.Vertex,System.Boolean,DotSpatial.Data.EndPointInteraction@)"> + <summary> + Returns a vertex representing the closest point on this line segment from a given vertex + </summary> + <param name="point">The point we want to be close to</param> + <param name="isInfiniteLine">If true treat the line as infinitly long</param> + <param name="endPointFlag">Outputs 0 if the vertex is on the line segment, 1 if beyond P0, 2 if beyong P1 and -1 if P1=P2</param> + <returns>The point on this segment or infinite line that is closest to the given point</returns> + </member> + <member name="M:DotSpatial.Data.Segment.ToVector"> + <summary> + Casts this to a vector + </summary> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.Segment.DistanceTo(DotSpatial.Data.Segment)"> + <summary> + Determines the shortest distance between two segments + </summary> + <param name="lineSegment">Segment, The line segment to test against this segment</param> + <returns>Double, the shortest distance between two segments</returns> + </member> + <member name="M:DotSpatial.Data.Segment.IntersectionCount(DotSpatial.Data.Segment)"> + <summary> + Returns 0 if no intersections occur, 1 if an intersection point is found, + and 2 if the segments are colinear and overlap. + </summary> + <param name="other"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.Segment.IntersectsVertex(DotSpatial.Data.Vertex)"> + <summary> + Tests to see if the specified segment contains the point within Epsilon tollerance. + </summary> + <returns></returns> + </member> + <member name="P:DotSpatial.Data.Segment.Epsilon"> + <summary> + Gets or sets the precision for calculating equality, but this is just a re-direction to Vertex.Epsilon + </summary> + </member> + <member name="T:DotSpatial.Data.SegmentRange"> + <summary> + SegmentSet + </summary> + </member> + <member name="M:DotSpatial.Data.SegmentRange.GetEnumerator"> + <inheritdoc /> + </member> + <member name="M:DotSpatial.Data.SegmentRange.#ctor(DotSpatial.Data.PartRange,DotSpatial.Topology.FeatureType)"> + <summary> + Creates a new instance of SegmentSet + </summary> + </member> + <member name="P:DotSpatial.Data.SegmentRange.FeatureType"> + <summary> + Gets the feature type + </summary> + </member> + <member name="P:DotSpatial.Data.SegmentRange.Part"> + <summary> + Gets the part + </summary> + </member> + <member name="T:DotSpatial.Data.SegmentRange.SegmentRangeEnumerator"> + <summary> + Cycles through the points, creating segments. If the feature type is a polygon, then this will + loop around again at the end of the part to create a segment from the first and last vertex. + </summary> + </member> + <member name="M:DotSpatial.Data.SegmentRange.SegmentRangeEnumerator.#ctor(DotSpatial.Data.SegmentRange)"> + <summary> + Creates a new enumerator given the SegmentRange + </summary> + <param name="parent"></param> + </member> + <member name="M:DotSpatial.Data.SegmentRange.SegmentRangeEnumerator.Dispose"> + <summary> + Does nothing + </summary> + </member> + <member name="M:DotSpatial.Data.SegmentRange.SegmentRangeEnumerator.MoveNext"> + <summary> + Advances the enumerator to the next member + </summary> + <returns>True if a member is found, false if there are no more members</returns> + </member> + <member name="M:DotSpatial.Data.SegmentRange.SegmentRangeEnumerator.Reset"> + <inheritdoc /> + </member> + <member name="P:DotSpatial.Data.SegmentRange.SegmentRangeEnumerator.Current"> + <summary> + Gets the current segment + </summary> + </member> + <member name="T:DotSpatial.Data.Shape"> + <summary> + The shape caries information about the raw vertices as well as a shapeRange. + It is effectively away to move around a single shape. + </summary> + </member> + <member name="M:DotSpatial.Data.Shape.#ctor"> + <summary> + Creates a new instance of Shape + </summary> + </member> + <member name="M:DotSpatial.Data.Shape.#ctor(DotSpatial.Topology.FeatureType)"> + <summary> + Creates a new shape type where the shaperange exists and has a type specified + </summary> + <param name="type"></param> + </member> + <member name="M:DotSpatial.Data.Shape.#ctor(DotSpatial.Data.IFeature)"> + <summary> + Creates a shape based on the specified feature. This shape will be standing alone, + all by itself. The fieldnames and field types will be null. + </summary> + <param name="feature"></param> + </member> + <member name="M:DotSpatial.Data.Shape.#ctor(DotSpatial.Topology.IBasicGeometry)"> + <summary> + Creates a shape based on the specified geometry. This shape will be standing alone, + all by itself. The attributes will be null. + </summary> + <param name="geometry">The geometry to create a shape from.</param> + </member> + <member name="M:DotSpatial.Data.Shape.#ctor(DotSpatial.Topology.Coordinate)"> + <summary> + Creates a point shape from a coordinate + </summary> + <param name="coord"></param> + </member> + <member name="M:DotSpatial.Data.Shape.#ctor(DotSpatial.Data.Vertex)"> + <summary> + Creates a point shape from a vertex + </summary> + <param name="coord"></param> + </member> + <member name="M:DotSpatial.Data.Shape.#ctor(DotSpatial.Data.IExtent)"> + <summary> + Creates a clockwise polygon shape from an extent + </summary> + <param name="extent"></param> + </member> + <member name="M:DotSpatial.Data.Shape.#ctor(DotSpatial.Topology.IEnvelope)"> + <summary> + Creates a clockwise polygon shape from an envelope + </summary> + <param name="envelope"></param> + </member> + <member name="M:DotSpatial.Data.Shape.ToGeometry"> + <summary> + Converts this shape into a Geometry using the default factory. + </summary> + <returns>The geometry version of this shape.</returns> + </member> + <member name="M:DotSpatial.Data.Shape.ToGeometry(DotSpatial.Topology.IGeometryFactory)"> + <summary> + Converts this shape into a Geometry. + </summary> + <returns>The geometry version of this shape.</returns> + </member> + <member name="M:DotSpatial.Data.Shape.FromPoint(DotSpatial.Topology.IGeometryFactory)"> + <summary> + Get the point for this shape if this is a point shape. + </summary> + <param name="factory"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.Shape.FromMultiPoint(DotSpatial.Topology.IGeometryFactory)"> + <summary> + Creates a new MultiPoint geometry from a MultiPoint shape + </summary> + <param name="factory">The IGeometryFactory to use to create the new shape.</param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.Shape.FromLine(DotSpatial.Topology.IGeometryFactory)"> + <summary> + Gets the line for the specified index + </summary> + <returns>A LineString or MultiLineString geometry created from this shape.</returns> + </member> + <member name="M:DotSpatial.Data.Shape.FromPolygon(DotSpatial.Topology.IGeometryFactory)"> + <summary> + Creates a Polygon or MultiPolygon from this Polygon shape. + </summary> + <param name="factory">The IGeometryFactory to use to create the new IGeometry.</param> + <returns>The IPolygon or IMultiPolygon created from this shape.</returns> + </member> + <member name="M:DotSpatial.Data.Shape.PointInList(DotSpatial.Topology.Coordinate,System.Collections.Generic.IEnumerable{DotSpatial.Topology.Coordinate})"> + <summary> + Test if a point is in a list of coordinates. + </summary> + <param name="testPoint">TestPoint the point to test for.</param> + <param name="pointList">PointList the list of points to look through.</param> + <returns>true if testPoint is a point in the pointList list.</returns> + </member> + <member name="M:DotSpatial.Data.Shape.CopyAttributes(DotSpatial.Data.IFeature)"> + <summary> + Copies the field names and types from the parent feature set if they are currently null. + Attempts to copy the members of the feature's datarow. This assumes the features have been + loaded into memory and are available on the feature's DataRow property. + </summary> + <param name="feature">An IFeature to copy the attributes from. If the schema is null, this will try to use the parent featureset schema.</param> + </member> + <member name="M:DotSpatial.Data.Shape.ShapeRangeFromGeometry(DotSpatial.Topology.IBasicGeometry,System.Double[],System.Int32)"> + <summary> + Create a ShapeRange from a Geometry to use in constructing a Shape + </summary> + <param name="geometry"></param> + <param name="vertices"></param> + <param name="offset">offset into vertices array where this feature starts</param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.Shape.ShapeRangeFromFeature(DotSpatial.Data.IFeature,System.Double[],System.Int32)"> + <summary> + Create a ShapeRange from a Feature to use in constructing a Shape + </summary> + <param name="feature"></param> + <param name="vertices"></param> + <param name="offset">offset into vertices array where this feature starts</param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.Shape.ShapeRangeFromFeature(DotSpatial.Data.IFeature,System.Double[])"> + <summary> + Create a ShapeRange from a Feature to use in constructing a Shape + </summary> + <param name="feature"></param> + <param name="vertices"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.Shape.AddPart(System.Collections.Generic.IEnumerable{DotSpatial.Topology.Coordinate},DotSpatial.Data.CoordinateType)"> + <summary> + Without changing the feature type or anything else, simply update the local coordinates + to include the new coordinates. All the new coordinates will be considered one part. + Since point and multi-point shapes don't have parts, they will just be appended to the + original part. + </summary> + </member> + <member name="M:DotSpatial.Data.Shape.Clone"> + <summary> + This creates a duplicate shape, also copying the vertex array to + a new array containing just this shape, as well as duplicating the attribute array. + The FieldNames and FieldTypes are a shallow copy since this shouldn't change. + </summary> + <returns></returns> + </member> + <member name="P:DotSpatial.Data.Shape.MinM"> + <summary> + Gets or sets the minimum M + </summary> + </member> + <member name="P:DotSpatial.Data.Shape.MaxM"> + <summary> + Gets or sets the maximum M + </summary> + </member> + <member name="P:DotSpatial.Data.Shape.MinZ"> + <summary> + Gets or sets the minimum Z + </summary> + </member> + <member name="P:DotSpatial.Data.Shape.MaxZ"> + <summary> + Gets or sets the maximum Z + </summary> + </member> + <member name="P:DotSpatial.Data.Shape.Range"> + <summary> + Gives a way to cycle through the vertices of this shape. + </summary> + </member> + <member name="P:DotSpatial.Data.Shape.Vertices"> + <summary> + The double vertices in X1, Y1, X2, Y2, ..., Xn, Yn order. + </summary> + </member> + <member name="P:DotSpatial.Data.Shape.Z"> + <summary> + The Z values if any + </summary> + </member> + <member name="P:DotSpatial.Data.Shape.M"> + <summary> + The M values if any, organized in order. + </summary> + </member> + <member name="P:DotSpatial.Data.Shape.Attributes"> + <summary> + Gets or sets the attributes. Since the most likely use is to copy values from one source to + another, this should be an independant array in each shape and be deep-copied. + </summary> + </member> + <member name="T:DotSpatial.Data.ShapefileDataProvider"> + <summary> + ShapefileDataProvider + </summary> + </member> + <member name="T:DotSpatial.Data.IVectorProvider"> + <summary> + IFeatureProvider + </summary> + </member> + <member name="M:DotSpatial.Data.IVectorProvider.CreateNew(System.String,DotSpatial.Topology.FeatureType,System.Boolean,DotSpatial.Data.IProgressHandler)"> + <summary> + This create new method implies that this provider has the priority for creating a new file. + An instance of the dataset should be created and then returned. By this time, the fileName + will already be checked to see if it exists, and deleted if the user wants to overwrite it. + </summary> + <param name="fileName">The string fileName for the new instance</param> + <param name="featureType">Point, Line, Polygon etc. Sometimes this will be specified, sometimes it will be "Unspecified"</param> + <param name="inRam">Boolean, true if the dataset should attempt to store data entirely in ram</param> + <param name="progressHandler">An IProgressHandler for status messages.</param> + <returns>An IRaster</returns> + </member> + <member name="M:DotSpatial.Data.IVectorProvider.GetFeatureType(System.String)"> + <summary> + This tests the specified file in order to determine what type of vector the file contains. + This returns unspecified if the file format is not supported by this provider. + </summary> + <param name="fileName">The string fileName to test</param> + <returns>A FeatureType clarifying what sort of features are stored on the data type.</returns> + </member> + <member name="M:DotSpatial.Data.ShapefileDataProvider.GetFeatureType(System.String)"> + <summary> + This tests the specified file in order to determine what type of vector the file contains. + This returns unspecified if the file format is not supported by this provider. + </summary> + <param name="fileName">The string fileName to test</param> + <returns>A FeatureType clarifying what sort of features are stored on the data type.</returns> + </member> + <member name="M:DotSpatial.Data.ShapefileDataProvider.CreateNew(System.String,DotSpatial.Topology.FeatureType,System.Boolean,DotSpatial.Data.IProgressHandler)"> + <summary> + This create new method implies that this provider has the priority for creating a new file. + An instance of the dataset should be created and then returned. By this time, the fileName + will already be checked to see if it exists, and deleted if the user wants to overwrite it. + </summary> + <param name="fileName">The string fileName for the new instance</param> + <param name="featureType">Point, Line, Polygon etc. Sometimes this will be specified, sometimes it will be "Unspecified"</param> + <param name="inRam">Boolean, true if the dataset should attempt to store data entirely in ram</param> + <param name="progressHandler">An IProgressHandler for status messages.</param> + <returns>An IRaster</returns> + </member> + <member name="M:DotSpatial.Data.ShapefileDataProvider.Open(System.String)"> + <summary> + This open method is only called if this plugin has been given priority for one + of the file extensions supported in the DialogReadFilter property supplied by + this control. Failing to provide a DialogReadFilter will result in this plugin + being added to the list of DataProviders being supplied under the Add Other Data + option in the file menu. + </summary> + <param name="fileName">A string specifying the complete path and extension of the file to open.</param> + <returns>A List of IDataSets to be added to the Map. These can also be groups of datasets.</returns> + </member> + <member name="P:DotSpatial.Data.ShapefileDataProvider.DialogReadFilter"> + <summary> + Gets a dialog read filter that lists each of the file type descriptions and file extensions, delimeted + by the | symbol. Each will appear in DotSpatial's open file dialog filter, preceded by the name provided + on this object. + </summary> + </member> + <member name="P:DotSpatial.Data.ShapefileDataProvider.DialogWriteFilter"> + <summary> + Gets a dialog filter that lists each of the file type descriptions and extensions for a Save File Dialog. + Each will appear in DotSpatial's open file dialog filter, preceded by the name provided on this object. + </summary> + </member> + <member name="P:DotSpatial.Data.ShapefileDataProvider.Name"> + <summary> + Gets a preferably short name that identifies this data provider. Example might be GDAL. + This will be prepended to each of the DialogReadFilter members from this plugin. + </summary> + </member> + <member name="P:DotSpatial.Data.ShapefileDataProvider.Description"> + <summary> + This is a basic description that will fall next to your plugin in the Add Other Data dialog. + This will only be shown if your plugin does not supply a DialogReadFilter. + </summary> + </member> + <member name="P:DotSpatial.Data.ShapefileDataProvider.ProgressHandler"> + <summary> + Gets or sets the progress handler + </summary> + </member> + <member name="F:DotSpatial.Data.ShapeRange.Epsilon"> + <summary> + Control the epsilon to use for the intersect calculations + </summary> + </member> + <member name="M:DotSpatial.Data.ShapeRange.Clone"> + <summary> + Creates a shallow copy of everything except the parts list and extent, which are deep copies. + </summary> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.ShapeRange.UpgradeExtent"> + <summary> + Considers the ShapeType and upgrades the extent class to accommodate M and Z. + This is automatically called form the setter of ShapeType. + </summary> + </member> + <member name="M:DotSpatial.Data.ShapeRange.#ctor(DotSpatial.Topology.FeatureType,DotSpatial.Data.CoordinateType)"> + <summary> + Creates a blank instance of a shaperange where vertices can be assigned later. + <param name="type">the feature type clarifies point, line, or polygon.</param> + <param name="coordType">The coordinate type clarifies whether M or Z values exist.</param> + </summary> + </member> + <member name="M:DotSpatial.Data.ShapeRange.#ctor(DotSpatial.Data.Vertex)"> + <summary> + Creates a new "point" shape that has only the one point. + </summary> + <param name="v"></param> + </member> + <member name="M:DotSpatial.Data.ShapeRange.#ctor(DotSpatial.Topology.IEnvelope)"> + <summary> + Initializes a new instance of the ShapeRange class. + </summary> + <param name="env">The envelope to turn into a shape range.</param> + </member> + <member name="M:DotSpatial.Data.ShapeRange.#ctor(DotSpatial.Data.Extent)"> + <summary> + This creates a polygon shape from an extent. + </summary> + <param name="ext">The extent to turn into a polygon shape.</param> + </member> + <member name="M:DotSpatial.Data.ShapeRange.CalculateExtents"> + <summary> + Forces each of the parts to adopt an extent equal to a calculated extents. + The extents for the shape will expand to include those. + </summary> + </member> + <member name="M:DotSpatial.Data.ShapeRange.First"> + <summary> + Gets the first vertex from the first part. + </summary> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.ShapeRange.Intersects(DotSpatial.Data.Extent)"> + <summary> + Tests the intersection with an extents + </summary> + <param name="ext"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.ShapeRange.Intersects(DotSpatial.Topology.IEnvelope)"> + <summary> + Tests the intersection using an envelope + </summary> + <param name="envelope"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.ShapeRange.Intersects(DotSpatial.Topology.Coordinate)"> + <summary> + Tests the intersection with a coordinate + </summary> + <param name="coord"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.ShapeRange.Intersects(DotSpatial.Data.Vertex)"> + <summary> + Tests the intersection with a vertex + </summary> + <param name="vert"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.ShapeRange.Intersects(DotSpatial.Data.Shape)"> + <summary> + Tests the intersection with a shape + </summary> + <param name="shape"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.ShapeRange.Intersects(DotSpatial.Data.ShapeRange)"> + <summary> + This calculations processes the intersections + </summary> + <param name="shape">The shape to do intersection calculations with.</param> + </member> + <member name="M:DotSpatial.Data.ShapeRange.SetVertices(System.Double[])"> + <summary> + This sets the vertex array by cycling through each part index and updates. + </summary> + <param name="vertices">The double array of vertices that should be referenced by the parts.</param> + </member> + <member name="M:DotSpatial.Data.ShapeRange.PartIndex(System.Int32)"> + <summary> + Given a vertex, this will determine the part that the vertex is within. + </summary> + <param name="vertexOffset"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.ShapeRange.EndIndex"> + <summary> + gets the integer end index as calculated from the number of points and the start index + </summary> + <returns></returns> + </member> + <member name="P:DotSpatial.Data.ShapeRange.FeatureType"> + <summary> + The feature type + </summary> + </member> + <member name="P:DotSpatial.Data.ShapeRange.ContentLength"> + <summary> + The content length + </summary> + </member> + <member name="P:DotSpatial.Data.ShapeRange.Parts"> + <summary> + If this is null, then there is only one part for this ShapeIndex. + </summary> + </member> + <member name="P:DotSpatial.Data.ShapeRange.RecordNumber"> + <summary> + The record number (for .shp files usually 1-based) + </summary> + </member> + <member name="P:DotSpatial.Data.ShapeRange.StartIndex"> + <summary> + The starting index for the entire shape range. + </summary> + </member> + <member name="P:DotSpatial.Data.ShapeRange.Extent"> + <summary> + Gets or sets the extent of this shape range. Setting this will prevent + the automatic calculations. + </summary> + </member> + <member name="P:DotSpatial.Data.ShapeRange.ShapeType"> + <summary> + The shape type for the header of this shape + </summary> + </member> + <member name="P:DotSpatial.Data.ShapeRange.NumPoints"> + <summary> + The number of points in the entire shape + </summary> + </member> + <member name="P:DotSpatial.Data.ShapeRange.NumParts"> + <summary> + If this is set, then it will cache an integer count that is independant from Parts.Count. + If this is not set, (or set to a negative value) then getting this will return Parts.Count + </summary> + </member> + <member name="T:DotSpatial.Data.ShapeType"> + <summary> + An enumeration listing the various valid shape types supported by Esri Shapefile formats + </summary> + </member> + <member name="F:DotSpatial.Data.ShapeType.NullShape"> + <summary> + 0 - No shape type specified, or the shapetype is invalid + </summary> + </member> + <member name="F:DotSpatial.Data.ShapeType.Point"> + <summary> + 1 - Each shape is a single point + </summary> + </member> + <member name="F:DotSpatial.Data.ShapeType.PolyLine"> + <summary> + 3 - Each shape is a collection of vertices that should be connected to form a striaght line + </summary> + </member> + <member name="F:DotSpatial.Data.ShapeType.Polygon"> + <summary> + 5 - Each shape is a closed linestring + </summary> + </member> + <member name="F:DotSpatial.Data.ShapeType.MultiPoint"> + <summary> + 8 - Each shape consists of severel, unconnected points + </summary> + </member> + <member name="F:DotSpatial.Data.ShapeType.PointZ"> + <summary> + 11 - Each shape is a point with a Z value + </summary> + </member> + <member name="F:DotSpatial.Data.ShapeType.PolyLineZ"> + <summary> + 13 - Each shape is a linestring with each vertex having a z value + </summary> + </member> + <member name="F:DotSpatial.Data.ShapeType.PolygonZ"> + <summary> + 15 - Each shape is a closed linestring with each vertex having a z value + </summary> + </member> + <member name="F:DotSpatial.Data.ShapeType.MultiPointZ"> + <summary> + 18 - Each shape has several unconnected points, each of which has a z value + </summary> + </member> + <member name="F:DotSpatial.Data.ShapeType.PointM"> + <summary> + 21 - Each shape has several unconnected points, each of which has an m and z value + </summary> + </member> + <member name="F:DotSpatial.Data.ShapeType.PolyLineM"> + <summary> + 23 - Each shape is made up of several points connected to form a line, each vertex having an m and z value + </summary> + </member> + <member name="F:DotSpatial.Data.ShapeType.PolygonM"> + <summary> + 25 - Each shape is a closed linestring with each vertex having a z value and m value + </summary> + </member> + <member name="F:DotSpatial.Data.ShapeType.MultiPointM"> + <summary> + 28 - Each shape has several unconnected points, each of which has a z value and m value + </summary> + </member> + <member name="F:DotSpatial.Data.ShapeType.MultiPatch"> + <summary> + 31 - Not sure what this does + </summary> + </member> + <member name="T:DotSpatial.Data.UnspecifiedFeaturetypeException"> + <summary> + UnspecifiedFeaturetypeException + </summary> + </member> + <member name="M:DotSpatial.Data.UnspecifiedFeaturetypeException.#ctor"> + <summary> + Creates a new instance of UnspecifiedFeaturetypeException + </summary> + </member> + <member name="T:DotSpatial.Data.Vertex"> + <summary> + A vertex is a two dimensional structure with an X and a Y value. This is deliberately kept as small as possibl.e + </summary> + </member> + <member name="F:DotSpatial.Data.Vertex.Epsilon"> + <summary> + The tolerance for testing equality + </summary> + </member> + <member name="F:DotSpatial.Data.Vertex.X"> + <summary> + An X coordinate + </summary> + </member> + <member name="F:DotSpatial.Data.Vertex.Y"> + <summary> + The Y coordinate + </summary> + </member> + <member name="M:DotSpatial.Data.Vertex.#ctor(System.Double,System.Double)"> + <summary> + Creates a new instance of Vertex + </summary> + </member> + <member name="M:DotSpatial.Data.Vertex.ToCoordinate"> + <summary> + Casts this vertex to a coordinate + </summary> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.Vertex.Equals(DotSpatial.Data.Vertex)"> + <summary> + + </summary> + <param name="other"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.Vertex.op_Equality(DotSpatial.Data.Vertex,DotSpatial.Data.Vertex)"> + <summary> + + </summary> + <param name="v1"></param> + <param name="v2"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.Vertex.op_Inequality(DotSpatial.Data.Vertex,DotSpatial.Data.Vertex)"> + <summary> + + </summary> + <param name="v1"></param> + <param name="v2"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.Vertex.Equals(System.Object)"> + <inheritdoc /> + </member> + <member name="M:DotSpatial.Data.Vertex.GetHashCode"> + <inheritdoc /> + </member> + <member name="T:DotSpatial.Data.EnvelopeExt"> + <summary> + This class handles some extension methods that also require System.Drawing. + </summary> + </member> + <member name="M:DotSpatial.Data.EnvelopeExt.Reproportion(DotSpatial.Topology.IEnvelope,System.Drawing.Rectangle,System.Drawing.Rectangle)"> + <summary> + This method assumes that there was a direct correlation between this envelope and the original + rectangle. This reproportions this window to match the specified newRectangle. + </summary> + <param name="self">The original envelope</param> + <param name="original">The original rectangle </param> + <param name="newRectangle">The new rectangle</param> + <returns>A new IEnvelope </returns> + </member> + <member name="M:DotSpatial.Data.EnvelopeExt.ToExtent(DotSpatial.Topology.IEnvelope)"> + <summary> + This allows the creation of the correct kind of Extent class from an Envelope, which can contain + M or Z values. + </summary> + <param name="self">The Envelope to convert into an Extent.</param> + <returns></returns> + </member> + <member name="T:DotSpatial.Data.RectangleExt"> + <summary> + Contains various extensions for Rectangle + </summary> + </member> + <member name="M:DotSpatial.Data.RectangleExt.IntersectsWith(System.Drawing.Rectangle,System.Drawing.RectangleF)"> + <summary> + Calculates the intersection by casting the floating point values to integer values. + </summary> + <param name="self">This rectangle</param> + <param name="other">The floating point rectangle to calculate against</param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.RectangleExt.ExpandToInclude(System.Drawing.Rectangle,System.Drawing.Point)"> + <summary> + Tests the location of the point. If the point is outside of the current rectangle, then the bounds + of the rectangle are adjusted to include the new point. + </summary> + <param name="self"></param> + <param name="newPoint"></param> + </member> + <member name="M:DotSpatial.Data.RectangleExt.ExpandBy(System.Drawing.Rectangle,System.Int32)"> + <summary> + Expands the rectangle by the specified integer distance in all directions. + </summary> + <param name="self">The rectangle to expand</param> + <param name="distance">The distance </param> + </member> + <member name="T:DotSpatial.Data.NullException"> + <summary> + NullExceptioncs + </summary> + </member> + <member name="M:DotSpatial.Data.NullException.#ctor"> + <summary> + Creates a new instance of the NullLogException, but does not set the message + or log the exception. + </summary> + </member> + <member name="M:DotSpatial.Data.NullException.#ctor(System.String)"> + <summary> + Creates a new instance of NullException + </summary> + </member> + <member name="T:DotSpatial.Data.ChangeEventList`1"> + <summary> + A list that also includes several events during its existing activities. + List is fussy about inheritance, unfortunately, so this wraps a list + and then makes this class much more inheritable + </summary> + </member> + <member name="T:DotSpatial.Data.CopyList`1"> + <summary> + A Copy list is something that is specifically designed to allow internal items + to be cloned. + </summary> + </member> + <member name="M:DotSpatial.Data.CopyList`1.Clone"> + <summary> + Returns a duplicate of this entire list, where each item has been cloned + if it implements ICloneable. Otherwise, the values will be a shallow copy. + </summary> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.CopyList`1.OnCopy(DotSpatial.Data.CopyList{`0})"> + <summary> + This copies any individual members of the list. If the item can be + cloned, then it copies the cloned item. Otherwise it copies the + regular item. This method can be overridden to handle special behavior + in sub-classes. + </summary> + <param name="copy"></param> + </member> + <member name="T:DotSpatial.Data.IChangeEventList`1"> + <summary> + IChangeEventList + </summary> + </member> + <member name="T:DotSpatial.Data.ISuspendEvents"> + <summary> + IChangeEvent + </summary> + </member> + <member name="M:DotSpatial.Data.ISuspendEvents.ResumeEvents"> + <summary> + Resumes event sending and fires a ListChanged event if any changes have taken place. + This will not track all the individual changes that may have fired in the meantime. + </summary> + </member> + <member name="M:DotSpatial.Data.ISuspendEvents.SuspendEvents"> + <summary> + Temporarilly suspends notice events, allowing a large number of changes. + </summary> + </member> + <member name="P:DotSpatial.Data.ISuspendEvents.EventsSuspended"> + <summary> + Gets whether or not the list is currently suspended + </summary> + </member> + <member name="T:DotSpatial.Data.IChangeItem"> + <summary> + IChangeItem + </summary> + </member> + <member name="E:DotSpatial.Data.IChangeItem.ItemChanged"> + <summary> + Occurs when internal properties or characteristics of this member change. + The member should send itself as the sender of the event. + </summary> + </member> + <member name="E:DotSpatial.Data.IChangeItem.RemoveItem"> + <summary> + An instruction has been sent to remove the specified item from its container. + </summary> + </member> + <member name="M:DotSpatial.Data.IChangeEventList`1.AddRange(System.Collections.Generic.IEnumerable{`0})"> + <summary> + Adds the elements of the specified collection to the end of the System.Collections.Generic.List<T> + </summary> + <param name="collection">collection: The collection whose elements should be added to the end of the + System.Collections.Generic.List<T>. The collection itself cannot be null, but it can contain + elements that are null, + if type T is a reference type.</param> + <exception cref="T:System.ApplicationException">Unable to add while the ReadOnly property is set to + true.</exception> + </member> + <member name="M:DotSpatial.Data.ChangeEventList`1.AddRange(System.Collections.Generic.IEnumerable{`0})"> + <summary> + Adds the elements of the specified collection to the end of the System.Collections.Generic.List<T> + </summary> + <param name="collection">collection: The collection whose elements should be added to the end of the + System.Collections.Generic.List<T>. The collection itself cannot be null, but it can contain elements that are null, + if type T is a reference type.</param> + <exception cref="T:System.ApplicationException">Unable to add while the ReadOnly property is set to true.</exception> + </member> + <member name="M:DotSpatial.Data.ChangeEventList`1.ResumeEvents"> + <summary> + Resumes event sending and fires a ListChanged event if any changes have taken place. + This will not track all the individual changes that may have fired in the meantime. + </summary> + </member> + <member name="M:DotSpatial.Data.ChangeEventList`1.SuspendEvents"> + <summary> + Temporarilly suspends notice events, allowing a large number of changes. + </summary> + </member> + <member name="M:DotSpatial.Data.ChangeEventList`1.OnInnerListSet"> + <summary> + An overriding event handler so that we can signfiy the list has changed + when the inner list has been set to a new list. + </summary> + </member> + <member name="M:DotSpatial.Data.ChangeEventList`1.OnClear"> + <summary> + Overrides the normal clear situation so that we only update after all the members are cleared. + </summary> + </member> + <member name="M:DotSpatial.Data.ChangeEventList`1.OnCopy(DotSpatial.Data.CopyList{`0})"> + <summary> + Occurs during the copy process and overrides the base behavior so that events are suspended. + </summary> + <param name="copy"></param> + </member> + <member name="M:DotSpatial.Data.ChangeEventList`1.OnResumeEvents"> + <summary> + Occurs when ResumeEvents has been called enough times so that events are re-enabled. + </summary> + </member> + <member name="M:DotSpatial.Data.ChangeEventList`1.Reverse(System.Int32,System.Int32)"> + <summary> + Reverses the order of the elements in the specified range. + </summary> + <param name="index">The zero-based starting index of the range to reverse.</param> + <param name="count">The number of elements in the range to reverse.</param> + <exception cref="T:System.ArgumentException">index and count do not denote a valid range of elements in the EventList<T>.</exception> + <exception cref="T:System.ArgumentOutOfRangeException">index is less than 0.-or-count is less than 0.</exception> + <exception cref="T:System.ApplicationException">Unable to reverse while the ReadOnly property is set to true.</exception> + </member> + <member name="M:DotSpatial.Data.ChangeEventList`1.Reverse"> + <summary> + Reverses the order of the elements in the entire EventList<T>. + </summary> + <exception cref="T:System.ApplicationException">Unable to reverse while the ReadOnly property is set to true.</exception> + </member> + <member name="M:DotSpatial.Data.ChangeEventList`1.InsertRange(System.Int32,System.Collections.Generic.IEnumerable{`0})"> + <summary> + Inserts the elements of a collection into the EventList<T> at the specified index. + </summary> + <param name="index">The zero-based index at which the new elements should be inserted.</param> + <param name="collection">The collection whose elements should be inserted into the EventList<T>. The collection itself cannot be null, but it can contain elements that are null, if type T is a reference type.</param> + <exception cref="T:System.ArgumentOutOfRangeException">index is less than 0.-or-index is greater than EventList<T>.Count.</exception> + <exception cref="T:System.ArgumentNullException">collection is null.</exception> + <exception cref="T:System.ApplicationException">Unable to insert while the ReadOnly property is set to true.</exception> + </member> + <member name="M:DotSpatial.Data.ChangeEventList`1.RemoveRange(System.Int32,System.Int32)"> + <summary> + Removes a range of elements from the EventList<T>. + </summary> + <param name="index">The zero-based starting index of the range of elements to remove.</param> + <param name="count">The number of elements to remove.</param> + <exception cref="T:System.ArgumentOutOfRangeException">index is less than 0.-or-count is less than 0.</exception> + <exception cref="T:System.ArgumentException">index and count do not denote a valid range of elements in the EventList<T>.</exception> + <exception cref="T:System.ApplicationException">Unable to remove while the ReadOnly property is set to true.</exception> + </member> + <member name="M:DotSpatial.Data.ChangeEventList`1.BinarySearch(`0)"> + <summary> + Searches the entire sorted System.Collections.Generic.List<T> for an element using the default comparer and returns the zero-based index of the element. + </summary> + <param name="item">The object to locate. The value can be null for reference types.</param> + <returns>The zero-based index of item in the sorted System.Collections.Generic.List<T>, if item is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than item or, if there is no larger element, the bitwise complement of System.Collections.Generic.List<T>.Count.</returns> + <exception cref="T:System.InvalidOperationException">The default comparer System.Collections.Generic.Comparer<T>.Default cannot find an implementation of the System.IComparable<T> generic interface or the System.IComparable interface for type T.</exception> + </member> + <member name="M:DotSpatial.Data.ChangeEventList`1.ItemItemChanged(System.Object,System.EventArgs)"> + <summary> + This is a notification that characteristics of one of the members of the list may have changed, + requiring a refresh, but may not involve a change to the the list itself + </summary> + <param name="sender"></param> + <param name="e"></param> + </member> + <member name="M:DotSpatial.Data.ChangeEventList`1.OnItemChanged(System.Object)"> + <summary> + Occurs when the item is changed. If this list is not suspended, it will forward the change event + on. Otherwise, it will ensure that when resume events is called that the on change method + is fired at that time. + </summary> + <param name="sender"></param> + </member> + <member name="M:DotSpatial.Data.ChangeEventList`1.OnListChanged"> + <summary> + Fires the ListChanged Event + </summary> + </member> + <member name="M:DotSpatial.Data.ChangeEventList`1.OnRemoveItem"> + <summary> + This is either a layer collection or a colorbreak collection, and so + this won't be called by us, but someone might want to override this for their own reasons. + </summary> + </member> + <member name="M:DotSpatial.Data.ChangeEventList`1.OnInclude(`0)"> + <summary> + Occurs when wiring events on a new item + </summary> + <param name="item"></param> + </member> + <member name="M:DotSpatial.Data.ChangeEventList`1.OnExclude(`0)"> + <summary> + Occurs when unwiring events on new items + </summary> + <param name="item"></param> + </member> + <member name="E:DotSpatial.Data.ChangeEventList`1.ItemChanged"> + <summary> + This event is for when it is necessary to do something if any of the internal + members changes. It will also forward the original item calling the message. + </summary> + </member> + <member name="E:DotSpatial.Data.ChangeEventList`1.RemoveItem"> + <summary> + Occurs when this list should be removed from its container + </summary> + </member> + <member name="P:DotSpatial.Data.ChangeEventList`1.EventsSuspended"> + <summary> + Gets whether or not the list is currently suspended + </summary> + </member> + <member name="T:DotSpatial.Data.Collective`1"> + <summary> + Carries event arguments for the generic IEventList + </summary> + </member> + <member name="M:DotSpatial.Data.Collective`1.#ctor(System.Collections.Generic.IEnumerable{`0})"> + <summary> + Creates a new instance of a ListEventArgs class + </summary> + <param name="inCollection">The IEnumerable<T> specified during the event"/></param> + </member> + <member name="P:DotSpatial.Data.Collective`1.Collection"> + <summary> + Gets the list item being referenced by this event + </summary> + </member> + <member name="T:DotSpatial.Data.CollectiveCancel`1"> + <summary> + The same as a ListEventArgs, but provides an option to cancel the event + </summary> + </member> + <member name="M:DotSpatial.Data.CollectiveCancel`1.#ctor(System.Collections.Generic.IEnumerable{`0})"> + <summary> + Creates a new instance of a ListEventArgs class + </summary> + <param name="inCollection">the IEnumerable<T> responsible for the event</param> + </member> + <member name="P:DotSpatial.Data.CollectiveCancel`1.Collection"> + <summary> + Gets the list item being referenced by this event + </summary> + </member> + <member name="T:DotSpatial.Data.CollectiveIndex`1"> + <summary> + Carries event arguments for the generic IEventList + </summary> + </member> + <member name="M:DotSpatial.Data.CollectiveIndex`1.#ctor(System.Collections.Generic.IEnumerable{`0},System.Int32)"> + <summary> + Creates a new instance of a ListEventArgs class + </summary> + <param name="inCollection">The IEnumerable<T> specified during the event"/></param> + <param name="inIndex">The integer index associated with this event</param> + </member> + <member name="P:DotSpatial.Data.CollectiveIndex`1.Collection"> + <summary> + Gets the IEnumerable<T> collection of items involved in this event + </summary> + </member> + <member name="P:DotSpatial.Data.CollectiveIndex`1.Index"> + <summary> + Gets the index in the list where the event is associated + </summary> + </member> + <member name="T:DotSpatial.Data.CollectiveIndexCancelEventArgs`1"> + <summary> + The same as a ListEventArgs, but provides an option to cancel the event + </summary> + </member> + <member name="M:DotSpatial.Data.CollectiveIndexCancelEventArgs`1.#ctor(System.Collections.Generic.IEnumerable{`0},System.Int32)"> + <summary> + Creates a new instance of a ListEventArgs class + </summary> + <param name="inCollection">the IEnumerable<T> responsible for the event</param> + <param name="inIndex">the Integer index associated with this event</param> + </member> + <member name="P:DotSpatial.Data.CollectiveIndexCancelEventArgs`1.Collection"> + <summary> + Gets the IEnumerable<T> collection involved in this event + </summary> + </member> + <member name="P:DotSpatial.Data.CollectiveIndexCancelEventArgs`1.Index"> + <summary> + Gets the integer index in the IEventList where this event occured + </summary> + </member> + <member name="T:DotSpatial.Data.CollectiveIndexCompare`1"> + <summary> + The same as a ListEventArgs, but provides an option to cancel the event + </summary> + </member> + <member name="M:DotSpatial.Data.CollectiveIndexCompare`1.#ctor(System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IComparer{`0},System.Int32)"> + <summary> + Creates a new instance of a ListEventArgs class. + </summary> + <param name="inCollection">the IEnumerable<T> responsible for the event.</param> + <param name="inComparer">The System.Collections.Generic.IComparer<T> being used by this action.</param> + <param name="inIndex">the Integer index associated with this event.</param> + </member> + <member name="P:DotSpatial.Data.CollectiveIndexCompare`1.Collection"> + <summary> + Gets the IEnumerable<T> collection involved in this event + </summary> + </member> + <member name="P:DotSpatial.Data.CollectiveIndexCompare`1.Index"> + <summary> + Gets the integer index in the IEventList where this event occured + </summary> + </member> + <member name="P:DotSpatial.Data.CollectiveIndexCompare`1.Comparer"> + <summary> + The System.Collections.Generic.IComparer<T> being used by this action + </summary> + </member> + <member name="T:DotSpatial.Data.CollectiveIndexCompareCancel`1"> + <summary> + The same as a ListEventArgs, but provides an option to cancel the event + </summary> + </member> + <member name="M:DotSpatial.Data.CollectiveIndexCompareCancel`1.#ctor(System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IComparer{`0},System.Int32)"> + <summary> + Creates a new instance of a ListEventArgs class. + </summary> + <param name="inCollection">the IEnumerable<T> responsible for the event.</param> + <param name="inComparer">The System.Collections.Generic.IComparer<T> being used by this action.</param> + <param name="inIndex">the Integer index associated with this event.</param> + </member> + <member name="P:DotSpatial.Data.CollectiveIndexCompareCancel`1.Collection"> + <summary> + Gets the IEnumerable<T> collection involved in this event + </summary> + </member> + <member name="P:DotSpatial.Data.CollectiveIndexCompareCancel`1.Index"> + <summary> + Gets the integer index in the IEventList where this event occured + </summary> + </member> + <member name="P:DotSpatial.Data.CollectiveIndexCompareCancel`1.Comparer"> + <summary> + The System.Collections.Generic.IComparer<T> being used by this action + </summary> + </member> + <member name="T:DotSpatial.Data.Compare`1"> + <summary> + Carries event arguments for the generic IEventList + </summary> + </member> + <member name="M:DotSpatial.Data.Compare`1.#ctor(System.Collections.Generic.IComparer{`0})"> + <summary> + Creates a new instance of a ListEventArgs class + </summary> + <param name="inComparer">The System.Collections.Generic.IComparer<T> being used by this action </param> + </member> + <member name="P:DotSpatial.Data.Compare`1.Comparer"> + <summary> + Gets the System.Collections.Generic.IComparer<T> being referenced by this event + </summary> + </member> + <member name="T:DotSpatial.Data.CompareCancel`1"> + <summary> + The same as a ListEventArgs, but provides an option to cancel the event + </summary> + </member> + <member name="M:DotSpatial.Data.CompareCancel`1.#ctor(System.Collections.Generic.IComparer{`0})"> + <summary> + Creates a new instance of a ListEventArgs class + </summary> + <param name="inComparer">The System.Collections.Generic.IComparer<T> being used by this action </param> + </member> + <member name="P:DotSpatial.Data.CompareCancel`1.Comparer"> + <summary> + Gets the comparer being used in this action + </summary> + </member> + <member name="T:DotSpatial.Data.ComparisonArgs`1"> + <summary> + Carries event arguments for the generic IEventList + </summary> + </member> + <member name="M:DotSpatial.Data.ComparisonArgs`1.#ctor(System.Comparison{`0})"> + <summary> + Creates a new instance of a ListEventArgs class + </summary> + <param name="inComparison">The System.Comparison<T> being used by this action </param> + </member> + <member name="P:DotSpatial.Data.ComparisonArgs`1.Comparison"> + <summary> + Gets System.Comparison being referenced by this event + </summary> + </member> + <member name="T:DotSpatial.Data.ComparisonCancelEventArgs`1"> + <summary> + The same as a ListEventArgs, but provides an option to cancel the event + </summary> + </member> + <member name="F:DotSpatial.Data.ComparisonCancelEventArgs`1._comparison"> + <summary> + The protected System.Collections.Generic.IComparer<T> being used by this action + </summary> + </member> + <member name="M:DotSpatial.Data.ComparisonCancelEventArgs`1.#ctor(System.Comparison{`0})"> + <summary> + Creates a new instance of a ListEventArgs class + </summary> + <param name="inComparison">The System.Collections.Generic.IComparer<T> being used by this action </param> + </member> + <member name="P:DotSpatial.Data.ComparisonCancelEventArgs`1.Comparison"> + <summary> + Gets the comparer being used in this action + </summary> + </member> + <member name="T:DotSpatial.Data.EventList`1"> + <summary> + A list that also includes several events during its existing activities. + List is fussy about inheritance, unfortunately, so this wraps a list + and then makes this class much more inheritable + </summary> + </member> + <member name="T:DotSpatial.Data.IEventList`1"> + <summary> + This describes a generic tool to help with keeping track of strong typed lists. + The usual list, however, provides no event handling whatsoever. + This list also provides an event for each of the major actions. + </summary> + <typeparam name="T">The type of the members in the list.</typeparam> + </member> + <member name="M:DotSpatial.Data.IEventList`1.AddRange(System.Collections.Generic.IEnumerable{`0})"> + <summary> + Adds the elements of the specified collection to the end of the System.Collections.Generic.List<T> + </summary> + <param name="collection">collection: The collection whose elements should be added to the end of the System.Collections.Generic.List<T>. The collection itself cannot be null, but it can contain elements that are null, if type T is a reference type.</param> + </member> + <member name="M:DotSpatial.Data.IEventList`1.BinarySearch(`0,System.Collections.Generic.IComparer{`0})"> + <summary> + Searches the entire sorted System.Collections.Generic.List<T> for an element using the specified comparer and returns the zero-based index of the element. + </summary> + <param name="item">The object to locate. The value can be null for reference types.</param> + <param name="comparer">The System.Collections.Generic.IComparer<T> implementation to use when comparing elements.-or-null to use the default comparer System.Collections.Generic.Comparer<T>.Default.</param> + <returns>The zero-based index of item in the sorted System.Collections.Generic.List<T>, if item is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than item or, if there is no larger element, the bitwise complement of System.Collections.Generic.List<T>.Count.</returns> + <exception cref="T:System.InvalidOperationException">comparer is null, and the default comparer System.Collections.Generic.Comparer<T>.Default cannot find an implementation of the System.IComparable<T>generic interface or the System.IComparable interface for type T.</exception> + </member> + <member name="M:DotSpatial.Data.IEventList`1.BinarySearch(`0)"> + <summary> + Searches the entire sorted System.Collections.Generic.List<T> for an element using the default comparer and returns the zero-based index of the element. + </summary> + <param name="item">The object to locate. The value can be null for reference types.</param> + <returns>The zero-based index of item in the sorted System.Collections.Generic.List<T>, if item is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than item or, if there is no larger element, the bitwise complement of System.Collections.Generic.List<T>.Count.</returns> + <exception cref="T:System.InvalidOperationException">The default comparer System.Collections.Generic.Comparer<T>.Default cannot find an implementation of the System.IComparable<T> generic interface or the System.IComparable interface for type T.</exception> + </member> + <member name="M:DotSpatial.Data.IEventList`1.BinarySearch(System.Int32,System.Int32,`0,System.Collections.Generic.IComparer{`0})"> + <summary> + Searches a range of elements in the sorted System.Collections.Generic.List<T> for an element using the specified comparer and returns the zero-based index of the element. + </summary> + <param name="index">The zero-based starting index of the range to search.</param> + <param name="count">The length of the range to search.</param> + <param name="item">The object to locate. The value can be null for reference types.</param> + <param name="comparer">The System.Collections.Generic.IComparer<T> implementation to use when comparing elements, or null to use the default comparer System.Collections.Generic.Comparer<T>.Default.</param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.IEventList`1.ConvertAll``1(System.Converter{`0,``0})"> + <summary> + Converts the elements in the current DotSpatial.Interfaces.Framework.IEventList<T> to another type, and returns a list containing the converted elements. + </summary> + <typeparam name="TOutput">The output type to convert to</typeparam> + <param name="converter">A System.Converter<TInput, TOutput> delegate that converts each element from one type to another type.</param> + <returns>A DotSpatial.Interfaces.Framework.IEventList<T> of the target type containing the converted elements from the current DotSpatial.Interfaces.Framework.IEventList<T>.</returns> + <exception cref="T:System.ArgumentNullException">converter is null.</exception> + </member> + <member name="M:DotSpatial.Data.IEventList`1.Exists(System.Predicate{`0})"> + <summary> + Determines whether the DotSpatial.Interfaces.Framework.IEventList<T> contains elements that match the conditions defined by the specified predicate. + </summary> + <param name="match">The System.Predicate<T> delegate that defines the conditions of the elements to search for.</param> + <returns>true if the DotSpatial.Interfaces.Framework.IEventList<T> contains one or more elements that match the conditions defined by the specified predicate; otherwise, false.</returns> + <exception cref="T:System.ArgumentNullException">match is null.</exception> + </member> + <member name="M:DotSpatial.Data.IEventList`1.ForEach(System.Action{`0})"> + <summary> + Performs the specified action on each element of the DotSpatial.Interfaces.Framework.IEventList<T>. + </summary> + <param name="action"> The System.Action<T> delegate to perform on each element of the DotSpatial.Interfaces.Framework.IEventList<T>.</param> + <exception cref="T:System.ArgumentNullException"> action is null.</exception> + </member> + <member name="M:DotSpatial.Data.IEventList`1.GetRange(System.Int32,System.Int32)"> + <summary> + Creates a shallow copy of a range of elements in the source DotSpatial.Interfaces.Framework.IEventList<T>. + </summary> + <param name="index">The zero-based DotSpatial.Interfaces.Framework.IEventList<T> index at which the range starts.</param> + <param name="count"> The number of elements in the range.</param> + <returns>A shallow copy of a range of elements in the source DotSpatial.Interfaces.Framework.IEventList<T>.</returns> + <exception cref="T:System.ArgumentOutOfRangeException">index is less than 0.-or-count is less than 0.</exception> + <exception cref="T:System.ArgumentException">index and count do not denote a valid range of elements in the DotSpatial.Interfaces.Framework.IEventList<T>.</exception> + </member> + <member name="M:DotSpatial.Data.IEventList`1.Reverse(System.Int32,System.Int32)"> + <summary> + Reverses the order of the elements in the specified range. + </summary> + <param name="index">The zero-based starting index of the range to reverse.</param> + <param name="count">The number of elements in the range to reverse.</param> + <exception cref="T:System.ArgumentException">index and count do not denote a valid range of elements in the DotSpatial.Interfaces.Framework.IEventList<T>.</exception> + <exception cref="T:System.ArgumentOutOfRangeException">index is less than 0.-or-count is less than 0.</exception> + </member> + <member name="M:DotSpatial.Data.IEventList`1.Reverse"> + <summary> + Reverses the order of the elements in the entire DotSpatial.Interfaces.Framework.IEventList<T>. + </summary> + </member> + <member name="M:DotSpatial.Data.IEventList`1.Sort(System.Comparison{`0})"> + <summary> + Sorts the elements in the entire DotSpatial.Interfaces.Framework.IEventList<T> using the specified System.Comparison<T>. + </summary> + <param name="comparison">The System.Comparison<T> to use when comparing elements.</param> + <exception cref="T:System.ArgumentException">The implementation of comparison caused an error during the sort. For example, comparison might not return 0 when comparing an item with itself.</exception> + <exception cref="T:System.ArgumentNullException">comparison is null.</exception> + </member> + <member name="M:DotSpatial.Data.IEventList`1.Sort(System.Int32,System.Int32,System.Collections.Generic.IComparer{`0})"> + <summary> + Sorts the elements in a range of elements in DotSpatial.Interfaces.Framework.IEventList<T> using the specified comparer. + </summary> + <param name="index"> The zero-based starting index of the range to sort.</param> + <param name="count">The length of the range to sort.</param> + <param name="comparer">The System.Collections.Generic.IComparer<T> implementation to use when comparing elements, or null to use the default comparer System.Collections.Generic.Comparer<T>.Default.</param> + <exception cref="T:System.ArgumentException">index and count do not specify a valid range in the DotSpatial.Interfaces.Framework.IEventList<T>.-or-The implementation of comparer caused an error during the sort. For example, comparer might not return 0 when comparing an item with itself.</exception> + <exception cref="T:System.ArgumentOutOfRangeException">index is less than 0.-or-count is less than 0.</exception> + <exception cref="T:System.InvalidOperationException"> comparer is null, and the default comparer System.Collections.Generic.Comparer<T>.Default cannot find implementation of the System.IComparable<T> generic interface or the System.IComparable interface for type T.</exception> + </member> + <member name="M:DotSpatial.Data.IEventList`1.Sort(System.Collections.Generic.IComparer{`0})"> + <summary> + Sorts the elements in the entire DotSpatial.Interfaces.Framework.IEventList<T> using the specified comparer. + </summary> + <param name="comparer"> The System.Collections.Generic.IComparer<T> implementation to use when comparing elements, or null to use the default comparer System.Collections.Generic.Comparer<T>.Default.</param> + <exception cref="T:System.ArgumentException">The implementation of comparer caused an error during the sort. For example, comparer might not return 0 when comparing an item with itself.</exception> + <exception cref="T:System.InvalidOperationException">comparer is null, and the default comparer System.Collections.Generic.Comparer<T>.Default cannot find implementation of the System.IComparable<T> generic interface or the System.IComparable interface for type T.</exception> + </member> + <member name="M:DotSpatial.Data.IEventList`1.Sort"> + <summary> + Sorts the elements in the entire DotSpatial.Interfaces.Framework.IEventList<T> using the default comparer. + </summary> + <exception cref="T:System.InvalidOperationException">The default comparer System.Collections.Generic.Comparer<T>.Default cannot find an implementation of the System.IComparable<T> generic interface or the System.IComparable interface for type T.</exception> + </member> + <member name="M:DotSpatial.Data.IEventList`1.ToArray"> + <summary> + Copies the elements of the DotSpatial.Interfaces.Framework.IEventList<T> to a new array. + </summary> + <returns>An array containing copies of the elements of the DotSpatial.Interfaces.Framework.IEventList<T>.</returns> + </member> + <member name="M:DotSpatial.Data.IEventList`1.TrimExcess"> + <summary> + Sets the capacity to the actual number of elements in the DotSpatial.Interfaces.Framework.IEventList<T>, if that number is less than a threshold value. + </summary> + </member> + <member name="M:DotSpatial.Data.IEventList`1.TrueForAll(System.Predicate{`0})"> + <summary> + Determines whether every element in the DotSpatial.Interfaces.Framework.IEventList<T> matches the conditions defined by the specified predicate. + </summary> + <param name="match">The System.Predicate<T> delegate that defines the conditions to check against the elements.</param> + <returns>true if every element in the DotSpatial.Interfaces.Framework.IEventList<T> matches the conditions defined by the specified predicate; otherwise, false. If the list has no elements, the return value is true.</returns> + <exception cref="T:System.ArgumentNullException">match is null.</exception> + </member> + <member name="M:DotSpatial.Data.IEventList`1.IndexOf(`0,System.Int32,System.Int32)"> + <summary> + Searches for the specified object and returns the zero-based index of the first occurrence within the range of elements in the DotSpatial.Interfaces.Framework.IEventList<T> that starts at the specified index and contains the specified number of elements. + </summary> + <param name="item">The object to locate in the DotSpatial.Interfaces.Framework.IEventList<T>. The value can be null for reference types.</param> + <param name="index"> The zero-based starting index of the search.</param> + <param name="count">The number of elements in the section to search.</param> + <returns>The zero-based index of the first occurrence of item within the range of elements in the DotSpatial.Interfaces.Framework.IEventList<T> that starts at index and contains count number of elements, if found; otherwise, –1.</returns> + <exception cref="T:System.ArgumentOutOfRangeException"> index is outside the range of valid indexes for the DotSpatial.Interfaces.Framework.IEventList<T>.-or-count is less than 0.-or-index and count do not specify a valid section in the DotSpatial.Interfaces.Framework.IEventList<T>.</exception> + </member> + <member name="M:DotSpatial.Data.IEventList`1.IndexOf(`0,System.Int32)"> + <summary> + Searches for the specified object and returns the zero-based index of the first occurrence within the range of elements in the DotSpatial.Interfaces.Framework.IEventList<T> that extends from the specified index to the last element. + </summary> + <param name="item">The object to locate in the DotSpatial.Interfaces.Framework.IEventList<T>. The value can be null for reference types.</param> + <param name="index"> The zero-based starting index of the search.</param> + <returns>The zero-based index of the first occurrence of item within the range of elements in the DotSpatial.Interfaces.Framework.IEventList<T> that extends from index to the last element, if found; otherwise, –1.</returns> + <exception cref="T:System.ArgumentOutOfRangeException">index is outside the range of valid indexes for the DotSpatial.Interfaces.Framework.IEventList<T>.</exception> + </member> + <member name="M:DotSpatial.Data.IEventList`1.InsertRange(System.Int32,System.Collections.Generic.IEnumerable{`0})"> + <summary> + Inserts the elements of a collection into the DotSpatial.Interfaces.Framework.IEventList<T> at the specified index. + </summary> + <param name="index">The zero-based index at which the new elements should be inserted.</param> + <param name="collection">The collection whose elements should be inserted into the DotSpatial.Interfaces.Framework.IEventList<T>. The collection itself cannot be null, but it can contain elements that are null, if type T is a reference type.</param> + <exception cref="T:System.ArgumentOutOfRangeException">index is less than 0.-or-index is greater than DotSpatial.Interfaces.Framework.IEventList<T>.Count.</exception> + <exception cref="T:System.ArgumentNullException">collection is null.</exception> + </member> + <member name="M:DotSpatial.Data.IEventList`1.LastIndexOf(`0,System.Int32,System.Int32)"> + <summary> + Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the DotSpatial.Interfaces.Framework.IEventList<T> that contains the specified number of elements and ends at the specified index. + </summary> + <param name="item">The object to locate in the DotSpatial.Interfaces.Framework.IEventList<T>. The value can be null for reference types.</param> + <param name="index">The zero-based starting index of the backward search.</param> + <param name="count">The number of elements in the section to search.</param> + <returns>The zero-based index of the last occurrence of item within the range of elements in the DotSpatial.Interfaces.Framework.IEventList<T> that contains count number of elements and ends at index, if found; otherwise, –1.</returns> + <exception cref="T:System.ArgumentOutOfRangeException">index is outside the range of valid indexes for the DotSpatial.Interfaces.Framework.IEventList<T>.-or-count is less than 0.-or-index and count do not specify a valid section in the DotSpatial.Interfaces.Framework.IEventList<T>.</exception> + </member> + <member name="M:DotSpatial.Data.IEventList`1.LastIndexOf(`0,System.Int32)"> + <summary> + Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the DotSpatial.Interfaces.Framework.IEventList<T> that extends from the first element to the specified index. + </summary> + <param name="item">The object to locate in the DotSpatial.Interfaces.Framework.IEventList<T>. The value can be null for reference types.</param> + <param name="index">The zero-based starting index of the backward search.</param> + <returns>The zero-based index of the last occurrence of item within the range of elements in the DotSpatial.Interfaces.Framework.IEventList<T> that extends from the first element to index, if found; otherwise, –1.</returns> + <exception cref="T:System.ArgumentOutOfRangeException">index is outside the range of valid indexes for the DotSpatial.Interfaces.Framework.IEventList<T>.</exception> + </member> + <member name="M:DotSpatial.Data.IEventList`1.LastIndexOf(`0)"> + <summary> + Searches for the specified object and returns the zero-based index of the last occurrence within the entire DotSpatial.Interfaces.Framework.IEventList<T>. + </summary> + <param name="item">The object to locate in the DotSpatial.Interfaces.Framework.IEventList<T>. The value can be null for reference types.</param> + <returns>The zero-based index of the last occurrence of item within the entire the DotSpatial.Interfaces.Framework.IEventList<T>, if found; otherwise, –1.</returns> + </member> + <member name="M:DotSpatial.Data.IEventList`1.RemoveAll(System.Predicate{`0})"> + <summary> + Removes the all the elements that match the conditions defined by the specified predicate. + </summary> + <param name="match">The System.Predicate<T> delegate that defines the conditions of the elements to remove.</param> + <returns>The number of elements removed from the DotSpatial.Interfaces.Framework.IEventList<T></returns> + <exception cref="T:System.ArgumentNullException">match is null.</exception> + </member> + <member name="M:DotSpatial.Data.IEventList`1.RemoveRange(System.Int32,System.Int32)"> + <summary> + Removes a range of elements from the DotSpatial.Interfaces.Framework.IEventList<T>. + </summary> + <param name="index">The zero-based starting index of the range of elements to remove.</param> + <param name="count">The number of elements to remove.</param> + <exception cref="T:System.ArgumentOutOfRangeException">index is less than 0.-or-count is less than 0.</exception> + <exception cref="T:System.ArgumentException">index and count do not denote a valid range of elements in the DotSpatial.Interfaces.Framework.IEventList<T>.</exception> + </member> + <member name="M:DotSpatial.Data.IEventList`1.FindIndex(System.Int32,System.Int32,System.Predicate{`0})"> + <summary> + Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the range of elements in the DotSpatial.Interfaces.Framework.IEventList<T> that starts at the specified index and contains the specified number of elements. + </summary> + <param name="startIndex">The zero-based starting index of the search.</param> + <param name="count">The number of elements in the section to search.</param> + <param name="match"> The System.Predicate<T> delegate that defines the conditions of the element to search for.</param> + <returns>The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1</returns> + <exception cref="T:System.ArgumentOutOfRangeException">startIndex is outside the range of valid indexes for the DotSpatial.Interfaces.Framework.IEventList<T>.-or-count is less than 0.-or-startIndex and count do not specify a valid section in the DotSpatial.Interfaces.Framework.IEventList<T>.</exception> + <exception cref="T:System.ArgumentNullException">match is null</exception> + </member> + <member name="M:DotSpatial.Data.IEventList`1.FindIndex(System.Int32,System.Predicate{`0})"> + <summary> + Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the range of elements in the DotSpatial.Interfaces.Framework.IEventList<T> that extends from the specified index to the last element. + </summary> + <param name="startIndex">The zero-based starting index of the search.</param> + <param name="match">The System.Predicate<T> delegate that defines the conditions of the element to search for.</param> + <returns>The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1.</returns> + <exception cref="T:System.ArgumentOutOfRangeException">startIndex is outside the range of valid indexes for the DotSpatial.Interfaces.Framework.IEventList<T>.</exception> + <exception cref="T:System.ArgumentNullException">match is null.</exception> + </member> + <member name="M:DotSpatial.Data.IEventList`1.FindIndex(System.Predicate{`0})"> + <summary> + Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the entire DotSpatial.Interfaces.Framework.IEventList<T>. + </summary> + <param name="match">The System.Predicate<T> delegate that defines the conditions of the element to search for.</param> + <returns>The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1.</returns> + <exception cref="T:System.ArgumentNullException">match is null.</exception> + </member> + <member name="M:DotSpatial.Data.IEventList`1.FindLast(System.Predicate{`0})"> + <summary> + Searches for an element that matches the conditions defined by the specified predicate, and returns the last occurrence within the entire DotSpatial.Interfaces.Framework.IEventList<T>. + </summary> + <param name="match">The System.Predicate<T> delegate that defines the conditions of the element to search for.</param> + <returns>The last element that matches the conditions defined by the specified predicate, if found; otherwise, the default value for type T.</returns> + <exception cref="T:System.ArgumentNullException">match is null."</exception> + </member> + <member name="M:DotSpatial.Data.IEventList`1.FindLastIndex(System.Int32,System.Int32,System.Predicate{`0})"> + <summary> + Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the range of elements in the DotSpatial.Interfaces.Framework.IEventList<T> that contains the specified number of elements and ends at the specified index. + </summary> + <param name="startIndex">The zero-based starting index of the backward search.</param> + <param name="count">The number of elements in the section to search.</param> + <param name="match"></param> + <returns>The System.Predicate<T> delegate that defines the conditions of the element to search for.</returns> + <exception cref="T:System.ArgumentOutOfRangeException">startIndex is outside the range of valid indexes for the DotSpatial.Interfaces.Framework.IEventList<T>.-or-count is less than 0.-or-startIndex and count do not specify a valid section in the DotSpatial.Interfaces.Framework.IEventList<T>.</exception> + <exception cref="T:System.ArgumentNullException">match is null.</exception> + </member> + <member name="M:DotSpatial.Data.IEventList`1.FindLastIndex(System.Int32,System.Predicate{`0})"> + <summary> + Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the range of elements in the DotSpatial.Interfaces.Framework.IEventList<T> that extends from the first element to the specified index. + </summary> + <param name="startIndex"> The zero-based starting index of the backward search.</param> + <param name="match">The System.Predicate<T> delegate that defines the conditions of the element to search for.</param> + <returns>The zero-based index of the last occurrence of an element that matches the conditions defined by match, if found; otherwise, –1.</returns> + <exception cref="T:System.ArgumentOutOfRangeException">: startIndex is outside the range of valid indexes for the DotSpatial.Interfaces.Framework.IEventList<T>.</exception> + </member> + <member name="M:DotSpatial.Data.IEventList`1.FindLastIndex(System.Predicate{`0})"> + <summary> + Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the entire DotSpatial.Interfaces.Framework.IEventList<T>. + </summary> + <param name="match">The System.Predicate<T> delegate that defines the conditions of the element to search for.</param> + <returns>The zero-based index of the last occurrence of an element that matches the conditions defined by match, if found; otherwise, –1.</returns> + <exception cref="T:System.ArgumentNullException">match is null.</exception> + </member> + <member name="M:DotSpatial.Data.IEventList`1.CopyTo(System.Int32,`0[],System.Int32,System.Int32)"> + <summary> + Copies a range of elements from the DotSpatial.Interfaces.Framework.IEventList<T> to a compatible one-dimensional array, starting at the specified index of the target array. + </summary> + <param name="index">The zero-based index in the source DotSpatial.Interfaces.Framework.IEventList<T> at which copying begins</param> + <param name="array">The one-dimensional System.Array that is the destination of the elements copied from DotSpatial.Interfaces.Framework.IEventList<T>. The System.Array must have zero-based indexing.</param> + <param name="arrayIndex">The zero-based index in array at which copying begins.</param> + <param name="count">The number of elements to copy.</param> + <exception cref="T:System.ArgumentNullException">array is null.</exception> + <exception cref="T:System.ArgumentOutOfRangeException"> index is less than 0.-or-arrayIndex is less than 0.-or-count is less than 0.</exception> + <exception cref="T:System.ArgumentException">index is equal to or greater than the DotSpatial.Interfaces.Framework.IEventList<T>.Count of the source DotSpatial.Interfaces.Framework.IEventList<T>.-or-arrayIndex is equal to or greater than the length of array.-or-The number of elements from index to the end of the source DotSpatial.Interfaces.Framework.IEventList<T> is greater than the available space from arrayIndex to the end of the destination array.</exception> + </member> + <member name="M:DotSpatial.Data.IEventList`1.CopyTo(`0[])"> + <summary> + Copies the entire DotSpatial.Interfaces.Framework.IEventList<T> to a compatible one-dimensional array, starting at the beginning of the target array. + </summary> + <param name="array">The one-dimensional System.Array that is the destination of the elements copied from DotSpatial.Interfaces.Framework.IEventList<T>. The System.Array must have zero-based indexing.</param> + <exception cref="T:System.ArgumentException">The number of elements in the source DotSpatial.Interfaces.Framework.IEventList<T> is greater than the number of elements that the destination array can contain.</exception> + <exception cref="T:System.ArgumentNullException">array is null.</exception> + </member> + <member name="P:DotSpatial.Data.IEventList`1.Capacity"> + <summary> + Gets or sets the total number of elements the internal data structure can hold without resizing. + </summary> + <returns> + The number of elements that the DotSpatial.Interfaces.Framework.IEventList<T> can contain before resizing is required. + </returns> + <exception cref="T:System.ArgumentOutOfRangeException">DotSpatial.Interfaces.Framework.IEventList<T>.Capacity is set to a value that is less than DotSpatial.Interfaces.Framework.IEventList<T>.Count.</exception> + </member> + <member name="E:DotSpatial.Data.IEventList`1.BeforeItemAdded"> + <summary> + Occurs before an item is added to the List. + There is no index yet specified because it will be added to the + end of the list. + </summary> + </member> + <member name="E:DotSpatial.Data.IEventList`1.BeforeRangeAdded"> + <summary> + Occurs before a range of items is added to the list. + There is no index yet, but this event can be cancelled. + </summary> + </member> + <member name="E:DotSpatial.Data.IEventList`1.AfterItemAdded"> + <summary> + Occurs after an item has already been added to the list. + The index where the item was added is specified. + </summary> + </member> + <member name="E:DotSpatial.Data.IEventList`1.AfterRangeAdded"> + <summary> + Occurs after a range has already been added to the list. + This reveals the index where the beginning of the range + was added, but cannot be canceled. + </summary> + </member> + <member name="E:DotSpatial.Data.IEventList`1.BeforeItemInserted"> + <summary> + Occurs before an item is inserted. The index of the requested + insertion as well as the item being inserted and an option to + cancel the event are specified + </summary> + </member> + <member name="E:DotSpatial.Data.IEventList`1.BeforeRangeInserted"> + <summary> + Occurs before a range is inserted. The index of the requested + insertion location as well as the item being inserted and an option to + cancel the event are provided in the event arguments + </summary> + </member> + <member name="E:DotSpatial.Data.IEventList`1.AfterItemInserted"> + <summary> + Occurs after an item is inserted. + Shows the true index of the item after it was actually added. + </summary> + </member> + <member name="E:DotSpatial.Data.IEventList`1.AfterRangeInserted"> + <summary> + Occurs after an item is inserted. + Shows the true index of the item after it was actually added. + </summary> + </member> + <member name="E:DotSpatial.Data.IEventList`1.BeforeItemRemoved"> + <summary> + Occurs before an item is removed from the List. + Specifies the item, the current index and an option to cancel. + </summary> + </member> + <member name="E:DotSpatial.Data.IEventList`1.BeforeRangeRemoved"> + <summary> + Occurs before a range is removed from the List. + Specifies the range, the current index and an option to cancel. + </summary> + </member> + <member name="E:DotSpatial.Data.IEventList`1.AfterItemRemoved"> + <summary> + Occurs after an item is removed from the List. + Gives a handle to the item that was removed, but it no longer + has a meaningful index value or an option to cancel. + </summary> + </member> + <member name="E:DotSpatial.Data.IEventList`1.AfterRangeRemoved"> + <summary> + Occurs after an item is removed from the List. + Gives a handle to the range that was removed, but it no longer + has a meaningful index value or an option to cancel. + </summary> + </member> + <member name="E:DotSpatial.Data.IEventList`1.BeforeAllMatchingRemoved"> + <summary> + Occurs before all the elements that match a predicate are removed. + Supplies an IEnumerable list in the event args of all the items + that will match the expression. This action can be cancelled. + </summary> + </member> + <member name="E:DotSpatial.Data.IEventList`1.AfterAllMatchingRemoved"> + <summary> + Occurs after all the elements that matched a predicate were + removed. The values are the items that were successfully removed. + The action has already happened, and so cannot be cancelled here. + </summary> + </member> + <member name="E:DotSpatial.Data.IEventList`1.BeforeListCleared"> + <summary> + Occurs before the list is cleared and can cancel the event. + </summary> + </member> + <member name="E:DotSpatial.Data.IEventList`1.AfterListCleared"> + <summary> + Occurs after the list is cleared and this cannot be canceled. + </summary> + </member> + <member name="E:DotSpatial.Data.IEventList`1.ListChanged"> + <summary> + Occurs after a method that sorts or reorganizes the list + </summary> + </member> + <member name="E:DotSpatial.Data.IEventList`1.BeforeRangeReversed"> + <summary> + Occurs before a specific range is reversed + </summary> + </member> + <member name="E:DotSpatial.Data.IEventList`1.AfterRangeReversed"> + <summary> + Occurs after a specific range is reversed + </summary> + </member> + <member name="E:DotSpatial.Data.IEventList`1.BeforeListReversed"> + <summary> + Occurs before the entire list is reversed + </summary> + </member> + <member name="E:DotSpatial.Data.IEventList`1.AfterListReversed"> + <summary> + Occurs after the entire list is reversed + </summary> + </member> + <member name="E:DotSpatial.Data.IEventList`1.AfterReversed"> + <summary> + Occurs just after the list or any sub portion + of the list is sorted. This event occurs in + addition to the specific reversal case. + </summary> + </member> + <member name="E:DotSpatial.Data.IEventList`1.BeforeReversed"> + <summary> + Occurs just before the list or any sub portion + of the list is sorted. This event occurs in + addition to the specific reversal case. + </summary> + </member> + <member name="E:DotSpatial.Data.IEventList`1.BeforeSort"> + <summary> + Occurs just before any of the specific sorting methodsin addition + to the event associated with the specific method. + </summary> + </member> + <member name="E:DotSpatial.Data.IEventList`1.AfterSort"> + <summary> + Occurs after any of the specific sorting methods in addition + to the event associated with the specific method. + </summary> + </member> + <member name="E:DotSpatial.Data.IEventList`1.BeforeListSorted"> + <summary> + Occurs just before the entire list is sorted + </summary> + </member> + <member name="E:DotSpatial.Data.IEventList`1.AfterListSorted"> + <summary> + Occurs after the entire list has been sorted + </summary> + </member> + <member name="E:DotSpatial.Data.IEventList`1.BeforeSortByComparison"> + <summary> + Occurs just before the Sort method that uses a System.Comparison<T> + This event can cancel the action. + </summary> + </member> + <member name="E:DotSpatial.Data.IEventList`1.AfterSortByComparison"> + <summary> + Occurs just after the Sort method that uses a System.Comparison<T> + </summary> + </member> + <member name="E:DotSpatial.Data.IEventList`1.BeforeRangeSorted"> + <summary> + Occurs just before the Sort method that only sorts a specified range. + This event can cancel the action. + </summary> + </member> + <member name="E:DotSpatial.Data.IEventList`1.AfterRangeSorted"> + <summary> + Occurs just after the Sort method that only sorts a specified range. + </summary> + </member> + <member name="F:DotSpatial.Data.EventList`1._isReadOnly"> + <summary> + Decides whether or not this list can be changed. This characteristic + can be set, so that once it becomes readonly, methods that would normally + change the sequence or number of members will be prevented and throw an + Application error. + </summary> + </member> + <member name="F:DotSpatial.Data.EventList`1._list"> + <summary> + The internal list of items + </summary> + </member> + <member name="M:DotSpatial.Data.EventList`1.#ctor"> + <summary> + Initializes a new instance of the EventList<T> class that is empty and has the default initial capacity. + </summary> + </member> + <member name="M:DotSpatial.Data.EventList`1.#ctor(System.Int32)"> + <summary> + Initializes a new instance of the EventList<T> class that is empty and has the specified initial capacity. + </summary> + <param name="capactiy"> The number of elements that the new list can initially store.</param> + <exception cref="T:System.ArgumentOutOfRangeException">capacity is less than 0.</exception> + </member> + <member name="M:DotSpatial.Data.EventList`1.#ctor(System.Collections.Generic.IEnumerable{`0})"> + <summary> + Initializes a new instance of the EventList<T> class that contains elements copied from the specified collection and has sufficient capacity to accommodate the number of elements copied. + </summary> + <param name="collection">The collection whose elements are copied to the new list.</param> + <exception cref="T:System.ArgumentNullException">collection is null.</exception> + </member> + <member name="M:DotSpatial.Data.EventList`1.Add(`0)"> + <summary> + Adds an object to the end of the System.Collections.Generic.List<T>. + </summary> + <param name="item">The object to be added to the end of the System.Collections.Generic.List<T>. + The value can be null for reference types.</param> + <exception cref="T:System.ApplicationException">Unable to add while the ReadOnly property is set to true.</exception> + </member> + <member name="M:DotSpatial.Data.EventList`1.AddRange(System.Collections.Generic.IEnumerable{`0})"> + <summary> + Adds the elements of the specified collection to the end of the System.Collections.Generic.List<T> + </summary> + <param name="collection">collection: The collection whose elements should be added to the end of the + System.Collections.Generic.List<T>. The collection itself cannot be null, but it can contain elements that are null, + if type T is a reference type.</param> + <exception cref="T:System.ApplicationException">Unable to add while the ReadOnly property is set to true.</exception> + </member> + <member name="M:DotSpatial.Data.EventList`1.BinarySearch(`0,System.Collections.Generic.IComparer{`0})"> + <summary> + Searches the entire sorted System.Collections.Generic.List<T> for an element using the specified comparer and returns the zero-based index of the element. + </summary> + <param name="item">The object to locate. The value can be null for reference types.</param> + <param name="comparer">The System.Collections.Generic.IComparer<T> implementation to use when comparing elements.-or-null to use the default comparer System.Collections.Generic.Comparer<T>.Default.</param> + <returns>The zero-based index of item in the sorted System.Collections.Generic.List<T>, if item is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than item or, if there is no larger element, the bitwise complement of System.Collections.Generic.List<T>.Count.</returns> + <exception cref="T:System.InvalidOperationException">comparer is null, and the default comparer + System.Collections.Generic.Comparer<T>.Default cannot find an implementation of the System.IComparable<T>generic + interface or the System.IComparable interface for type T.</exception> + </member> + <member name="M:DotSpatial.Data.EventList`1.BinarySearch(`0)"> + <summary> + Searches the entire sorted System.Collections.Generic.List<T> for an element using the default comparer and returns the zero-based index of the element. + </summary> + <param name="item">The object to locate. The value can be null for reference types.</param> + <returns>The zero-based index of item in the sorted System.Collections.Generic.List<T>, if item is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than item or, if there is no larger element, the bitwise complement of System.Collections.Generic.List<T>.Count.</returns> + <exception cref="T:System.InvalidOperationException">The default comparer System.Collections.Generic.Comparer<T>.Default cannot find an implementation of the System.IComparable<T> generic interface or the System.IComparable interface for type T.</exception> + </member> + <member name="M:DotSpatial.Data.EventList`1.BinarySearch(System.Int32,System.Int32,`0,System.Collections.Generic.IComparer{`0})"> + <summary> + Searches a range of elements in the sorted System.Collections.Generic.List<T> for an element using the specified comparer and returns the zero-based index of the element. + </summary> + <param name="index">The zero-based starting index of the range to search.</param> + <param name="count">The length of the range to search.</param> + <param name="item">The object to locate. The value can be null for reference types.</param> + <param name="comparer">The System.Collections.Generic.IComparer<T> implementation to use when comparing elements, or null to use the default comparer System.Collections.Generic.Comparer<T>.Default.</param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.EventList`1.Clear"> + <summary> + Removes all elements from the EventList<T>. + </summary> + <exception cref="T:System.ApplicationException">Unable to clear while the ReadOnly property is set to true.</exception> + </member> + <member name="M:DotSpatial.Data.EventList`1.Contains(`0)"> + <summary> + Determines whether an element is in the System.Collections.Generic.List<T>. + </summary> + <param name="item"> The object to locate in the System.Collections.Generic.List<T>. The value can be null for reference types.</param> + <returns>true if item is found in the System.Collections.Generic.List<T> otherwise, false.</returns> + </member> + <member name="M:DotSpatial.Data.EventList`1.Exists(System.Predicate{`0})"> + <summary> + Determines whether the EventList<T> contains elements that match the conditions defined by the specified predicate. + </summary> + <param name="match">The System.Predicate<T> delegate that defines the conditions of the elements to search for.</param> + <returns>true if the EventList<T> contains one or more elements that match the conditions defined by the specified predicate; otherwise, false.</returns> + <exception cref="T:System.ArgumentNullException">match is null.</exception> + </member> + <member name="M:DotSpatial.Data.EventList`1.ForEach(System.Action{`0})"> + <summary> + Performs the specified action on each element of the EventList<T>. + </summary> + <param name="action"> The System.Action<T> delegate to perform on each element of the EventList<T>.</param> + <exception cref="T:System.ArgumentNullException"> action is null.</exception> + </member> + <member name="M:DotSpatial.Data.EventList`1.GetEnumerator"> + <summary> + Returns an enumerator that iterates through this list + </summary> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.EventList`1.GetRange(System.Int32,System.Int32)"> + <summary> + Creates a shallow copy of a range of elements in the source EventList<T>. + </summary> + <param name="index">The zero-based EventList<T> index at which the range starts.</param> + <param name="count"> The number of elements in the range.</param> + <returns>A shallow copy of a range of elements in the source EventList<T>.</returns> + <exception cref="T:System.ArgumentOutOfRangeException">index is less than 0.-or-count is less than 0.</exception> + <exception cref="T:System.ArgumentException">index and count do not denote a valid range of elements in the EventList<T>.</exception> + </member> + <member name="M:DotSpatial.Data.EventList`1.IndexOf(`0,System.Int32,System.Int32)"> + <summary> + Searches for the specified object and returns the zero-based index of the first occurrence within the range of elements in the EventList<T> that starts at the specified index and contains the specified number of elements. + </summary> + <param name="item">The object to locate in the EventList<T>. The value can be null for reference types.</param> + <param name="index"> The zero-based starting index of the search.</param> + <param name="count">The number of elements in the section to search.</param> + <returns>The zero-based index of the first occurrence of item within the range of elements in the EventList<T> that starts at index and contains count number of elements, if found; otherwise, –1.</returns> + <exception cref="T:System.ArgumentOutOfRangeException"> index is outside the range of valid indexes for the EventList<T>.-or-count is less than 0.-or-index and count do not specify a valid section in the EventList<T>.</exception> + </member> + <member name="M:DotSpatial.Data.EventList`1.IndexOf(`0,System.Int32)"> + <summary> + Searches for the specified object and returns the zero-based index of the first occurrence within the range of elements in the EventList<T> that extends from the specified index to the last element. + </summary> + <param name="item">The object to locate in the EventList<T>. The value can be null for reference types.</param> + <param name="index"> The zero-based starting index of the search.</param> + <returns>The zero-based index of the first occurrence of item within the range of elements in the EventList<T> that extends from index to the last element, if found; otherwise, –1.</returns> + <exception cref="T:System.ArgumentOutOfRangeException">index is outside the range of valid indexes for the EventList<T>.</exception> + </member> + <member name="M:DotSpatial.Data.EventList`1.IndexOf(`0)"> + <summary> + Searches for the specified object and returns the zero-based index of the first occurrence within the entire System.Collections.Generic.List<T>. + </summary> + <param name="item">The object to locate in the System.Collections.Generic.List<T>. The value can be null for reference types.</param> + <returns>The zero-based index of the first occurrence of item within the entire System.Collections.Generic.List<T>, if found; otherwise, –1.</returns> + </member> + <member name="M:DotSpatial.Data.EventList`1.InsertRange(System.Int32,System.Collections.Generic.IEnumerable{`0})"> + <summary> + Inserts the elements of a collection into the EventList<T> at the specified index. + </summary> + <param name="index">The zero-based index at which the new elements should be inserted.</param> + <param name="collection">The collection whose elements should be inserted into the EventList<T>. The collection itself cannot be null, but it can contain elements that are null, if type T is a reference type.</param> + <exception cref="T:System.ArgumentOutOfRangeException">index is less than 0.-or-index is greater than EventList<T>.Count.</exception> + <exception cref="T:System.ArgumentNullException">collection is null.</exception> + <exception cref="T:System.ApplicationException">Unable to insert while the ReadOnly property is set to true.</exception> + </member> + <member name="M:DotSpatial.Data.EventList`1.Insert(System.Int32,`0)"> + <summary> + Inserts an element into the System.Collections.Generic.List<T> at the specified index. + </summary> + <param name="index">The zero-based index at which item should be inserted.</param> + <param name="item">The object to insert. The value can be null for reference types.</param> + <exception cref="T:System.ArgumentOutOfRangeException">index is less than 0.-or-index is greater than System.Collections.Generic.List<T>.Count.</exception> + <exception cref="T:System.ApplicationException">Unable to insert while the ReadOnly property is set to true.</exception> + </member> + <member name="M:DotSpatial.Data.EventList`1.LastIndexOf(`0,System.Int32,System.Int32)"> + <summary> + Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the EventList<T> that contains the specified number of elements and ends at the specified index. + </summary> + <param name="item">The object to locate in the EventList<T>. The value can be null for reference types.</param> + <param name="index">The zero-based starting index of the backward search.</param> + <param name="count">The number of elements in the section to search.</param> + <returns>The zero-based index of the last occurrence of item within the range of elements in the EventList<T> that contains count number of elements and ends at index, if found; otherwise, –1.</returns> + <exception cref="T:System.ArgumentOutOfRangeException">index is outside the range of valid indexes for the EventList<T>.-or-count is less than 0.-or-index and count do not specify a valid section in the EventList<T>.</exception> + </member> + <member name="M:DotSpatial.Data.EventList`1.LastIndexOf(`0,System.Int32)"> + <summary> + Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the EventList<T> that extends from the first element to the specified index. + </summary> + <param name="item">The object to locate in the EventList<T>. The value can be null for reference types.</param> + <param name="index">The zero-based starting index of the backward search.</param> + <returns>The zero-based index of the last occurrence of item within the range of elements in the EventList<T> that extends from the first element to index, if found; otherwise, –1.</returns> + <exception cref="T:System.ArgumentOutOfRangeException">index is outside the range of valid indexes for the EventList<T>.</exception> + </member> + <member name="M:DotSpatial.Data.EventList`1.LastIndexOf(`0)"> + <summary> + Searches for the specified object and returns the zero-based index of the last occurrence within the entire EventList<T>. + </summary> + <param name="item">The object to locate in the EventList<T>. The value can be null for reference types.</param> + <returns>The zero-based index of the last occurrence of item within the entire the EventList<T>, if found; otherwise, –1.</returns> + </member> + <member name="M:DotSpatial.Data.EventList`1.Remove(`0)"> + <summary> + Removes the first occurrence of a specific object from the System.Collections.Generic.List<T>. + </summary> + <param name="item">The object to remove from the System.Collections.Generic.List<T>. The value can be null for reference types.</param> + <returns>true if item is successfully removed; otherwise, false. This method also returns false if item was not + found in the System.Collections.Generic.List<T>.</returns> + <exception cref="T:System.ApplicationException">Unable to remove while the ReadOnly property is set to true.</exception> + </member> + <member name="M:DotSpatial.Data.EventList`1.RemoveAll(System.Predicate{`0})"> + <summary> + Removes the all the elements that match the conditions defined by the specified predicate. + </summary> + <param name="match">The System.Predicate<T> delegate that defines the conditions of the elements to remove.</param> + <returns>The number of elements removed from the EventList<T></returns> + <exception cref="T:System.ArgumentNullException">match is null.</exception> + <exception cref="T:System.ApplicationException">Unable to remove while the ReadOnly property is set to true.</exception> + </member> + <member name="M:DotSpatial.Data.EventList`1.RemoveAt(System.Int32)"> + <summary> + Removes the element at the specified index of the System.Collections.Generic.List<T>. + </summary> + <param name="index">The zero-based index of the element to remove.</param> + <exception cref="T:System.ApplicationException">Unable to remove while the ReadOnly property is set to true.</exception> + </member> + <member name="M:DotSpatial.Data.EventList`1.RemoveRange(System.Int32,System.Int32)"> + <summary> + Removes a range of elements from the EventList<T>. + </summary> + <param name="index">The zero-based starting index of the range of elements to remove.</param> + <param name="count">The number of elements to remove.</param> + <exception cref="T:System.ArgumentOutOfRangeException">index is less than 0.-or-count is less than 0.</exception> + <exception cref="T:System.ArgumentException">index and count do not denote a valid range of elements in the EventList<T>.</exception> + <exception cref="T:System.ApplicationException">Unable to remove while the ReadOnly property is set to true.</exception> + </member> + <member name="M:DotSpatial.Data.EventList`1.Reverse(System.Int32,System.Int32)"> + <summary> + Reverses the order of the elements in the specified range. + </summary> + <param name="index">The zero-based starting index of the range to reverse.</param> + <param name="count">The number of elements in the range to reverse.</param> + <exception cref="T:System.ArgumentException">index and count do not denote a valid range of elements in the EventList<T>.</exception> + <exception cref="T:System.ArgumentOutOfRangeException">index is less than 0.-or-count is less than 0.</exception> + <exception cref="T:System.ApplicationException">Unable to reverse while the ReadOnly property is set to true.</exception> + </member> + <member name="M:DotSpatial.Data.EventList`1.Reverse"> + <summary> + Reverses the order of the elements in the entire EventList<T>. + </summary> + <exception cref="T:System.ApplicationException">Unable to reverse while the ReadOnly property is set to true.</exception> + </member> + <member name="M:DotSpatial.Data.EventList`1.Sort(System.Comparison{`0})"> + <summary> + Sorts the elements in the entire EventList<T> using the specified System.Comparison<T>. + </summary> + <param name="comparison">The System.Comparison<T> to use when comparing elements.</param> + <exception cref="T:System.ArgumentException">The implementation of comparison caused an error during the sort. For example, comparison might not return 0 when comparing an item with itself.</exception> + <exception cref="T:System.ArgumentNullException">comparison is null.</exception> + <exception cref="T:System.ApplicationException">Unable to sort while the ReadOnly property is set to true.</exception> + </member> + <member name="M:DotSpatial.Data.EventList`1.Sort(System.Int32,System.Int32,System.Collections.Generic.IComparer{`0})"> + <summary> + Sorts the elements in a range of elements in EventList<T> using the specified comparer. + </summary> + <param name="index"> The zero-based starting index of the range to sort.</param> + <param name="count">The length of the range to sort.</param> + <param name="comparer">The System.Collections.Generic.IComparer<T> implementation to use when comparing elements, or null to use the default comparer System.Collections.Generic.Comparer<T>.Default.</param> + <exception cref="T:System.ArgumentException">index and count do not specify a valid range in the EventList<T>.-or-The implementation of comparer caused an error during the sort. For example, comparer might not return 0 when comparing an item with itself.</exception> + <exception cref="T:System.ArgumentOutOfRangeException">index is less than 0.-or-count is less than 0.</exception> + <exception cref="T:System.InvalidOperationException"> comparer is null, and the default comparer + System.Collections.Generic.Comparer<T>.Default cannot find implementation of the System.IComparable<T> + generic interface or the System.IComparable interface for type T.</exception> + <exception cref="T:System.ApplicationException">Unable to sort while the ReadOnly property is set to true.</exception> + </member> + <member name="M:DotSpatial.Data.EventList`1.Sort(System.Collections.Generic.IComparer{`0})"> + <summary> + Sorts the elements in the entire DotSpatial.Interfaces.Framework.IEventList<T> using the specified comparer. + </summary> + <param name="comparer"> The System.Collections.Generic.IComparer<T> implementation to use when comparing elements, or null to use the default comparer System.Collections.Generic.Comparer<T>.Default.</param> + <exception cref="T:System.ArgumentException">The implementation of comparer caused an error during the sort. For example, comparer might not return 0 when comparing an item with itself.</exception> + <exception cref="T:System.InvalidOperationException">comparer is null, and the default comparer System.Collections.Generic.Comparer<T>.Default cannot find implementation of the System.IComparable<T> generic interface or the System.IComparable interface for type T.</exception> + <exception cref="T:System.ApplicationException">Unable to sort while the ReadOnly property is set to true.</exception> + </member> + <member name="M:DotSpatial.Data.EventList`1.Sort"> + <summary> + Sorts the elements in the entire DotSpatial.Interfaces.Framework.IEventList<T> using the default comparer. + </summary> + <exception cref="T:System.InvalidOperationException">The default comparer System.Collections.Generic.Comparer<T>.Default cannot find an implementation of the System.IComparable<T> generic interface or the System.IComparable interface for type T.</exception> + <exception cref="T:System.ApplicationException">Unable to sort while the ReadOnly property is set to true.</exception> + </member> + <member name="M:DotSpatial.Data.EventList`1.ToArray"> + <summary> + Copies the elements of the DotSpatial.Interfaces.Framework.IEventList<T> to a new array. + </summary> + <returns>An array containing copies of the elements of the DotSpatial.Interfaces.Framework.IEventList<T>.</returns> + </member> + <member name="M:DotSpatial.Data.EventList`1.TrimExcess"> + <summary> + Sets the capacity to the actual number of elements in the DotSpatial.Interfaces.Framework.IEventList<T>, if that number is less than a threshold value. + </summary> + <exception cref="T:System.ApplicationException">Unable to trim while the ReadOnly property is set to true.</exception> + </member> + <member name="M:DotSpatial.Data.EventList`1.TrueForAll(System.Predicate{`0})"> + <summary> + Determines whether every element in the DotSpatial.Interfaces.Framework.IEventList<T> matches the conditions defined by the specified predicate. + </summary> + <param name="match">The System.Predicate<T> delegate that defines the conditions to check against the elements.</param> + <returns>true if every element in the DotSpatial.Interfaces.Framework.IEventList<T> matches the conditions defined by the specified predicate; otherwise, false. If the list has no elements, the return value is true.</returns> + <exception cref="T:System.ArgumentNullException">match is null.</exception> + </member> + <member name="M:DotSpatial.Data.EventList`1.FindIndex(System.Int32,System.Int32,System.Predicate{`0})"> + <summary> + Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the range of elements in the EventList<T> that starts at the specified index and contains the specified number of elements. + </summary> + <param name="startIndex">The zero-based starting index of the search.</param> + <param name="count">The number of elements in the section to search.</param> + <param name="match"> The System.Predicate<T> delegate that defines the conditions of the element to search for.</param> + <returns>The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1</returns> + <exception cref="T:System.ArgumentOutOfRangeException">startIndex is outside the range of valid indexes for the EventList<T>.-or-count is less than 0.-or-startIndex and count do not specify a valid section in the EventList<T>.</exception> + <exception cref="T:System.ArgumentNullException">match is null</exception> + </member> + <member name="M:DotSpatial.Data.EventList`1.FindIndex(System.Int32,System.Predicate{`0})"> + <summary> + Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the range of elements in the EventList<T> that extends from the specified index to the last element. + </summary> + <param name="startIndex">The zero-based starting index of the search.</param> + <param name="match">The System.Predicate<T> delegate that defines the conditions of the element to search for.</param> + <returns>The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1.</returns> + <exception cref="T:System.ArgumentOutOfRangeException">startIndex is outside the range of valid indexes for the EventList<T>.</exception> + <exception cref="T:System.ArgumentNullException">match is null.</exception> + </member> + <member name="M:DotSpatial.Data.EventList`1.FindIndex(System.Predicate{`0})"> + <summary> + Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the entire EventList<T>. + </summary> + <param name="match">The System.Predicate<T> delegate that defines the conditions of the element to search for.</param> + <returns>The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1.</returns> + <exception cref="T:System.ArgumentNullException">match is null.</exception> + </member> + <member name="M:DotSpatial.Data.EventList`1.FindLast(System.Predicate{`0})"> + <summary> + Searches for an element that matches the conditions defined by the specified predicate, and returns the last occurrence within the entire EventList<T>. + </summary> + <param name="match">The System.Predicate<T> delegate that defines the conditions of the element to search for.</param> + <returns>The last element that matches the conditions defined by the specified predicate, if found; otherwise, the default value for type T.</returns> + <exception cref="T:System.ArgumentNullException">match is null."</exception> + </member> + <member name="M:DotSpatial.Data.EventList`1.FindLastIndex(System.Int32,System.Int32,System.Predicate{`0})"> + <summary> + Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the range of elements in the EventList<T> that contains the specified number of elements and ends at the specified index. + </summary> + <param name="startIndex">The zero-based starting index of the backward search.</param> + <param name="count">The number of elements in the section to search.</param> + <param name="match"></param> + <returns>The System.Predicate<T> delegate that defines the conditions of the element to search for.</returns> + <exception cref="T:System.ArgumentOutOfRangeException">startIndex is outside the range of valid indexes for the EventList<T>.-or-count is less than 0.-or-startIndex and count do not specify a valid section in the EventList<T>.</exception> + <exception cref="T:System.ArgumentNullException">match is null.</exception> + </member> + <member name="M:DotSpatial.Data.EventList`1.FindLastIndex(System.Int32,System.Predicate{`0})"> + <summary> + Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the range of elements in the EventList<T> that extends from the first element to the specified index. + </summary> + <param name="startIndex"> The zero-based starting index of the backward search.</param> + <param name="match">The System.Predicate<T> delegate that defines the conditions of the element to search for.</param> + <returns>The zero-based index of the last occurrence of an element that matches the conditions defined by match, if found; otherwise, –1.</returns> + <exception cref="T:System.ArgumentOutOfRangeException">: startIndex is outside the range of valid indexes for the EventList<T>.</exception> + </member> + <member name="M:DotSpatial.Data.EventList`1.FindLastIndex(System.Predicate{`0})"> + <summary> + Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the entire EventList<T>. + </summary> + <param name="match">The System.Predicate<T> delegate that defines the conditions of the element to search for.</param> + <returns>The zero-based index of the last occurrence of an element that matches the conditions defined by match, if found; otherwise, –1.</returns> + <exception cref="T:System.ArgumentNullException">match is null.</exception> + </member> + <member name="M:DotSpatial.Data.EventList`1.CopyTo(System.Int32,`0[],System.Int32,System.Int32)"> + <summary> + Copies a range of elements from the EventList<T> to a compatible one-dimensional array, starting at the specified index of the target array. + </summary> + <param name="index">The zero-based index in the source EventList<T> at which copying begins</param> + <param name="array">The one-dimensional System.Array that is the destination of the elements copied from EventList<T>. The System.Array must have zero-based indexing.</param> + <param name="arrayIndex">The zero-based index in array at which copying begins.</param> + <param name="count">The number of elements to copy.</param> + <exception cref="T:System.ArgumentNullException">array is null.</exception> + <exception cref="T:System.ArgumentOutOfRangeException"> index is less than 0.-or-arrayIndex is less than 0.-or-count is less than 0.</exception> + <exception cref="T:System.ArgumentException">index is equal to or greater than the EventList<T>.Count of the source EventList<T>.-or-arrayIndex is equal to or greater than the length of array.-or-The number of elements from index to the end of the source EventList<T> is greater than the available space from arrayIndex to the end of the destination array.</exception> + </member> + <member name="M:DotSpatial.Data.EventList`1.CopyTo(`0[],System.Int32)"> + <summary> + Copies the entire System.Collections.Generic.List<T> to a compatible one-dimensional array, starting at the specified index of the target array. + </summary> + <param name="array">The one-dimensional System.Array that is the destination of the elements copied from System.Collections.Generic.List<T>. The System.Array must have zero-based indexing.</param> + <param name="arrayIndex"> The zero-based index in array at which copying begins.</param> + <exception cref="T:System.ArgumentException">System.ArgumentException: arrayIndex is equal to or greater than the length of array.-or-The number of elements in the source System.Collections.Generic.List<T> is greater than the available space from arrayIndex to the end of the destination array. </exception> + <exception cref="T:System.ArgumentOutOfRangeException">arrayIndex is less than 0</exception> + <exception cref="T:System.ArgumentNullException">array is null</exception> + </member> + <member name="M:DotSpatial.Data.EventList`1.CopyTo(`0[])"> + <summary> + Copies the entire EventList<T> to a compatible one-dimensional array, starting at the beginning of the target array. + </summary> + <param name="array">The one-dimensional System.Array that is the destination of the elements copied from EventList<T>. The System.Array must have zero-based indexing.</param> + <exception cref="T:System.ArgumentException">The number of elements in the source EventList<T> is greater than the number of elements that the destination array can contain.</exception> + <exception cref="T:System.ArgumentNullException">array is null.</exception> + </member> + <member name="M:DotSpatial.Data.EventList`1.ConvertAll``1(System.Converter{`0,``0})"> + <summary> + Converts the elements in the current EventList<T> to another type, and returns a list containing the converted elements. + </summary> + <typeparam name="TOutput">The output type to convert to</typeparam> + <param name="converter">A System.Converter<TInput, TOutput> delegate that converts each element from one type to another type.</param> + <returns>A EventList<T> of the target type containing the converted elements from the current EventList<T>.</returns> + <exception cref="T:System.ArgumentNullException">converter is null.</exception> + </member> + <member name="M:DotSpatial.Data.EventList`1.OnAfterItemAdded(`0,System.Int32)"> + <summary> + Fires the AfterItemAdded Event + </summary> + <param name="item"></param> + <param name="index"></param> + </member> + <member name="M:DotSpatial.Data.EventList`1.OnAfterRangeAdded(System.Collections.Generic.IEnumerable{`0},System.Int32)"> + <summary> + Fires the AfterRangeAdded method + </summary> + <param name="collection"></param> + <param name="index"></param> + </member> + <member name="M:DotSpatial.Data.EventList`1.OnBeforeItemAdded(`0)"> + <summary> + Fires the BeforeItemAdded Event + </summary> + <param name="item"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.EventList`1.OnBeforeRangeAdded(System.Collections.Generic.IEnumerable{`0})"> + <summary> + Fires the BeforeRangeAdded Event + </summary> + <param name="collection"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.EventList`1.OnAfterListCleared"> + <summary> + Fires the AfterListCleared event + </summary> + </member> + <member name="M:DotSpatial.Data.EventList`1.OnBeforeListCleared"> + <summary> + Fires the BeforeListCleared event + </summary> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.EventList`1.OnAfterItemInserted(`0,System.Int32)"> + <summary> + Fires the AfterItemInserted event + </summary> + <param name="item"></param> + <param name="index"></param> + </member> + <member name="M:DotSpatial.Data.EventList`1.OnAfterRangeInserted(System.Collections.Generic.IEnumerable{`0},System.Int32)"> + <summary> + Fires the AfterRangeInserted event + </summary> + <param name="collection"></param> + <param name="index"></param> + </member> + <member name="M:DotSpatial.Data.EventList`1.OnBeforeItemInserted(`0,System.Int32)"> + <summary> + Fires the BeforeItemInserted event + </summary> + <param name="item"></param> + <param name="index"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.EventList`1.OnBeforeRangeInserted(System.Collections.Generic.IEnumerable{`0},System.Int32)"> + <summary> + Fires the BeforeRangeInserted event + </summary> + <param name="collection"></param> + <param name="index"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.EventList`1.OnListChanged"> + <summary> + Fires the ListChanged Event + </summary> + </member> + <member name="M:DotSpatial.Data.EventList`1.OnAfterReversed"> + <summary> + fires the AfterReversed event + </summary> + </member> + <member name="M:DotSpatial.Data.EventList`1.OnBeforeReversed"> + <summary> + Fires the BeforeReversed event + </summary> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.EventList`1.OnBeforeRangeReversed(System.Int32,System.Collections.Generic.IEnumerable{`0})"> + <summary> + Fires the BeforeRangeReversed event + </summary> + <param name="index"></param> + <param name="range"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.EventList`1.OnAfterRangeReversed(System.Int32,System.Collections.Generic.IEnumerable{`0})"> + <summary> + Fires the AfterRangeReversed event + </summary> + <param name="index"></param> + <param name="collection"></param> + </member> + <member name="M:DotSpatial.Data.EventList`1.OnBeforeListReversed"> + <summary> + Fires the BeforeLiestReversed event + </summary> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.EventList`1.OnAfterListReversed"> + <summary> + fires the AfterListReversed Event + </summary> + </member> + <member name="M:DotSpatial.Data.EventList`1.OnBeforeItemRemoved(`0,System.Int32)"> + <summary> + Fires the BeforeItemRemoved event + </summary> + <param name="item"></param> + <param name="index"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.EventList`1.OnBeforeRangeRemoved(System.Collections.Generic.IEnumerable{`0},System.Int32)"> + <summary> + Fires the BeforeRangeRemoved event + </summary> + <param name="collection"></param> + <param name="index"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.EventList`1.OnBeforeAllMatchingRemoved(System.Collections.Generic.IEnumerable{`0})"> + <summary> + Fires the BeforeAllMatchingRemoved event + </summary> + <param name="collection"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.EventList`1.OnAfterAllMatchingRemoved(System.Collections.Generic.IEnumerable{`0})"> + <summary> + Fires the AfterAllMatchingRemoved event + </summary> + <param name="collection"></param> + </member> + <member name="M:DotSpatial.Data.EventList`1.OnAfterItemRemoved(`0)"> + <summary> + Fires the AfterItemRemoved event + </summary> + <param name="item"></param> + </member> + <member name="M:DotSpatial.Data.EventList`1.OnAfterRangeRemoved(System.Collections.Generic.IEnumerable{`0})"> + <summary> + Fires the AfterRangeRemoved Event + </summary> + <param name="collection"></param> + </member> + <member name="M:DotSpatial.Data.EventList`1.OnBeforeSort"> + <summary> + Fires the BeforeSort event + </summary> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.EventList`1.OnAfterSort"> + <summary> + Fires the AfterSort event + </summary> + </member> + <member name="M:DotSpatial.Data.EventList`1.OnBeforeListSorted(System.Collections.Generic.IComparer{`0})"> + <summary> + Fires the BeforeListSorted event + </summary> + <param name="comparer"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.EventList`1.OnAfterListSorted(System.Collections.Generic.IComparer{`0})"> + <summary> + Fires the AfterListSorted event + </summary> + <param name="comparer"></param> + </member> + <member name="M:DotSpatial.Data.EventList`1.OnBeforeSortByComparison(System.Comparison{`0})"> + <summary> + Fires the BeforeSortByComparison + </summary> + <param name="comparison"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.EventList`1.OnAfterSortByComparison(System.Comparison{`0})"> + <summary> + Fires the AfterSortByComparison event + </summary> + <param name="comparison"></param> + </member> + <member name="M:DotSpatial.Data.EventList`1.OnBeforeRangeSorted(System.Int32,System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IComparer{`0})"> + <summary> + Fires the BeforeRangeSorted event + </summary> + <param name="index"></param> + <param name="collection"></param> + <param name="comparer"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.EventList`1.OnAfterRangeSorted(System.Int32,System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IComparer{`0})"> + <summary> + Fires the AfterRangeSorted event + </summary> + <param name="index"></param> + <param name="collection"></param> + <param name="comparer"></param> + </member> + <member name="M:DotSpatial.Data.EventList`1.DotSpatial#Data#IEventList{T}#ConvertAll``1(System.Converter{`0,``0})"> + <summary> + Converts between one output an another + </summary> + <typeparam name="TOutput"></typeparam> + <param name="converter"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.EventList`1.System#Collections#IEnumerable#GetEnumerator"> + <summary> + Gets an Enumerator + </summary> + <returns></returns> + </member> + <member name="P:DotSpatial.Data.EventList`1.Capacity"> + <summary> + Gets or sets the total number of elements the internal data structure can hold without resizing. + </summary> + <returns> + The number of elements that the DotSpatial.Interfaces.Framework.IEventList<T> can contain before resizing is required. + </returns> + <exception cref="T:System.ArgumentOutOfRangeException">DotSpatial.Interfaces.Framework.IEventList<T>.Capacity is set to a value that is less than DotSpatial.Interfaces.Framework.IEventList<T>.Count.</exception> + </member> + <member name="P:DotSpatial.Data.EventList`1.Item(System.Int32)"> + <summary> + The default, indexed value of type T + </summary> + <param name="index">The numeric index</param> + <returns>An object of type T corresponding to the index value specified</returns> + </member> + <member name="P:DotSpatial.Data.EventList`1.Count"> + <summary> + Integer, the total number of items currently stored in the list + </summary> + </member> + <member name="P:DotSpatial.Data.EventList`1.IsReadOnly"> + <summary> + Gets a boolean property indicating whether this list can be written to. + </summary> + </member> + <member name="E:DotSpatial.Data.EventList`1.AfterItemAdded"> + <summary> + Occurs after an item has already been added to the list. + The index where the item was added is specified. + </summary> + </member> + <member name="E:DotSpatial.Data.EventList`1.AfterRangeAdded"> + <summary> + Occurs after a range has already been added to the list. + This reveals the index where the beginning of the range + was added, but cannot be canceled. + </summary> + </member> + <member name="E:DotSpatial.Data.EventList`1.BeforeItemAdded"> + <summary> + Occurs before an item is added to the List. + There is no index yet specified because it will be added to the + end of the list. + </summary> + </member> + <member name="E:DotSpatial.Data.EventList`1.BeforeRangeAdded"> + <summary> + Occurs before a range of items is added to the list. + There is no index yet, but this event can be cancelled. + </summary> + </member> + <member name="E:DotSpatial.Data.EventList`1.AfterListCleared"> + <summary> + Occurs after the the list is cleared. + </summary> + </member> + <member name="E:DotSpatial.Data.EventList`1.BeforeListCleared"> + <summary> + Occurs before the list is cleared and can cancel the event. + </summary> + </member> + <member name="E:DotSpatial.Data.EventList`1.AfterItemInserted"> + <summary> + Occurs after an item is inserted. + Shows the true index of the item after it was actually added. + </summary> + </member> + <member name="E:DotSpatial.Data.EventList`1.AfterRangeInserted"> + <summary> + Occurs after an item is inserted. + Shows the true index of the item after it was actually added. + </summary> + </member> + <member name="E:DotSpatial.Data.EventList`1.BeforeItemInserted"> + <summary> + Occurs before an item is inserted. The index of the requested + insertion as well as the item being inserted and an option to + cancel the event are specified + </summary> + </member> + <member name="E:DotSpatial.Data.EventList`1.BeforeRangeInserted"> + <summary> + Occurs before a range is inserted. The index of the requested + insertion location as well as the item being inserted and an option to + cancel the event are provided in the event arguments + </summary> + </member> + <member name="E:DotSpatial.Data.EventList`1.ListChanged"> + <summary> + Occurs after a method that sorts or reorganizes the list + </summary> + </member> + <member name="E:DotSpatial.Data.EventList`1.AfterReversed"> + <summary> + Occurs just after the list or any sub portion + of the list is sorted. This event occurs in + addition to the specific reversal case. + </summary> + </member> + <member name="E:DotSpatial.Data.EventList`1.BeforeReversed"> + <summary> + Occurs just before the list or any sub portion + of the list is sorted. This event occurs in + addition to the specific reversal case. + </summary> + </member> + <member name="E:DotSpatial.Data.EventList`1.BeforeRangeReversed"> + <summary> + Occurs before a specific range is reversed + </summary> + </member> + <member name="E:DotSpatial.Data.EventList`1.AfterRangeReversed"> + <summary> + Occurs after a specific range is reversed + </summary> + </member> + <member name="E:DotSpatial.Data.EventList`1.BeforeListReversed"> + <summary> + Occurs before the entire list is reversed + </summary> + </member> + <member name="E:DotSpatial.Data.EventList`1.AfterListReversed"> + <summary> + Occurs after the entire list is reversed + </summary> + </member> + <member name="E:DotSpatial.Data.EventList`1.BeforeItemRemoved"> + <summary> + Occurs before an item is removed from the List. + Specifies the item, the current index and an option to cancel. + </summary> + </member> + <member name="E:DotSpatial.Data.EventList`1.BeforeRangeRemoved"> + <summary> + Occurs before a range is removed from the List. + Specifies the range, the current index and an option to cancel. + </summary> + </member> + <member name="E:DotSpatial.Data.EventList`1.BeforeAllMatchingRemoved"> + <summary> + Occurs before all the elements that match a predicate are removed. + Supplies an IEnumerable list in the event args of all the items + that will match the expression. This action can be cancelled. + </summary> + </member> + <member name="E:DotSpatial.Data.EventList`1.AfterAllMatchingRemoved"> + <summary> + Occurs after all the elements that matched a predicate were + removed. The values are the items that were successfully removed. + The action has already happened, and so cannot be cancelled here. + </summary> + </member> + <member name="E:DotSpatial.Data.EventList`1.AfterItemRemoved"> + <summary> + Occurs after an item is removed from the List. + Gives a handle to the item that was removed, but it no longer + has a meaningful index value or an option to cancel. + </summary> + </member> + <member name="E:DotSpatial.Data.EventList`1.AfterRangeRemoved"> + <summary> + Occurs after an item is removed from the List. + Gives a handle to the range that was removed, but it no longer + has a meaningful index value or an option to cancel. + </summary> + </member> + <member name="E:DotSpatial.Data.EventList`1.BeforeSort"> + <summary> + Occurs just before any of the specific sorting methodsin addition + to the event associated with the specific method. + </summary> + </member> + <member name="E:DotSpatial.Data.EventList`1.AfterSort"> + <summary> + Occurs after any of the specific sorting methods in addition + to the event associated with the specific method. + </summary> + </member> + <member name="E:DotSpatial.Data.EventList`1.BeforeListSorted"> + <summary> + Occurs just before the entire list is sorted + </summary> + </member> + <member name="E:DotSpatial.Data.EventList`1.AfterListSorted"> + <summary> + Occurs after the entire list has been sorted + </summary> + </member> + <member name="E:DotSpatial.Data.EventList`1.BeforeSortByComparison"> + <summary> + Occurs just before the Sort method that uses a System.Comparison<T> + This event can cancel the action. + </summary> + </member> + <member name="E:DotSpatial.Data.EventList`1.AfterSortByComparison"> + <summary> + Occurs just after the Sort method that uses a System.Comparison<T> + </summary> + </member> + <member name="E:DotSpatial.Data.EventList`1.BeforeRangeSorted"> + <summary> + Occurs just before the Sort method that only sorts a specified range. + This event can cancel the action. + </summary> + </member> + <member name="E:DotSpatial.Data.EventList`1.AfterRangeSorted"> + <summary> + Occurs just after the Sort method that only sorts a specified range. + </summary> + </member> + <member name="T:DotSpatial.Data.Global"> + <summary> + Global has some basic methods that may be useful in lots of places. + TODO: This class needs to be removed and these methods relocated to easier to find places. + </summary> + </member> + <member name="M:DotSpatial.Data.Global.Convert``1(System.Double)"> + <summary> + Converts a double numeric value into the appropriate T data type using a ChangeType process. + </summary> + <typeparam name="T">The numeric output type created from the double value.</typeparam> + <param name="value">The double value to retrieve the equivalent numeric value for.</param> + <returns>A variable of type T with the value of the value parameter.</returns> + </member> + <member name="M:DotSpatial.Data.Global.ToDouble``1(``0)"> + <summary> + This involves boxing and unboxing as well as a convert to double, but IConvertible was + not CLS Compliant, so we were always getting warnings about it. Ted was trying to make + all the code CLS Compliant to remove warnings. + </summary> + <param name="value"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.Global.MaximumValue``1"> + <summary> + For numeric types, this will return the maximum value. + </summary> + <typeparam name="T">The type of the numeric range to find the maximum for.</typeparam> + <returns>The maximum value for the numeric type specified by T.</returns> + </member> + <member name="M:DotSpatial.Data.Global.MinimumValue``1"> + <summary> + For Numeric types, this will return the minimum value. + </summary> + <typeparam name="T">The type of the numeric range to return the minimum for.</typeparam> + <returns>The the minimum value possible for a numeric value of type T.</returns> + </member> + <member name="M:DotSpatial.Data.Global.SafeCastTo``1(System.Object)"> + <summary> + A Generic Safe Casting method that should simply exist as part of the core framework + </summary> + <typeparam name="T">The type of the member to attempt to cast to.</typeparam> + <param name="obj">The original object to attempt to System.Convert.</param> + <returns>An output variable of type T.</returns> + </member> + <member name="M:DotSpatial.Data.Global.ParseEnum``1(System.String)"> + <summary> + Uses the standard enum parsing, but returns it cast as the specified T parameter + </summary> + <typeparam name="T">The type of the enum to use</typeparam> + <param name="text">The string to parse into a copy of the enumeration</param> + <returns>an enumeration of the specified type</returns> + </member> + <member name="M:DotSpatial.Data.Global.GetByte(System.Object)"> + <summary> + This attempts to convert a value into a byte. If it fails, the byte will be 0. + </summary> + <param name="expression">The expression (like a string) to System.Convert.</param> + <returns>A byte that is 0 if the test fails.</returns> + </member> + <member name="M:DotSpatial.Data.Global.GetDouble(System.Object)"> + <summary> + This attempts to convert a value into a double. If it fails, the double will be double.NaN. + </summary> + <param name="expression">The expression (like a string) to System.Convert.</param> + <returns>A double that is double.NAN if the test fails.</returns> + </member> + <member name="M:DotSpatial.Data.Global.GetFloat(System.Object)"> + <summary> + This attempts to convert a value into a float. If it fails, the float will be 0. + </summary> + <param name="expression">The expression (like a string) to System.Convert.</param> + <returns>A float that is 0 if the test fails.</returns> + </member> + <member name="M:DotSpatial.Data.Global.GetInteger(System.Object)"> + <summary> + This attempts to convert a value into an integer. If it fails, it returns 0. + </summary> + <param name="expression">The expression to test</param> + <returns>true if the value could be cast as a double, false otherwise</returns> + </member> + <member name="M:DotSpatial.Data.Global.GetShort(System.Object)"> + <summary> + This attempts to convert a value into a short. If it fails, it returns 0. + </summary> + <param name="expression">The expression (like a string) to System.Convert.</param> + <returns>A short that is 0 if the test fails.</returns> + </member> + <member name="M:DotSpatial.Data.Global.GetString(System.Object)"> + <summary> + Gets the string form of the number using culture settings + </summary> + <param name="expression">The expression to obtain the string for</param> + <returns>A string</returns> + </member> + <member name="M:DotSpatial.Data.Global.IsByte(System.Object)"> + <summary> + Tests an expression to see if it can be converted into a byte. + </summary> + <param name="expression">The expression to test</param> + <returns>true if the value could be cast as a double, false otherwise</returns> + </member> + <member name="M:DotSpatial.Data.Global.IsDouble(System.Object)"> + <summary> + Tests an expression to see if it can be converted into a double. + </summary> + <param name="expression">The expression to test</param> + <returns>true if the value could be cast as a double, false otherwise</returns> + </member> + <member name="M:DotSpatial.Data.Global.IsFloat(System.Object)"> + <summary> + Tests an expression to see if it can be converted into a float. + </summary> + <param name="expression">The expression to test</param> + <returns>true if the value could be cast as a double, false otherwise</returns> + </member> + <member name="M:DotSpatial.Data.Global.IsInteger(System.Object)"> + <summary> + Tests an expression to see if it can be converted into an integer. + </summary> + <param name="expression">The expression to test</param> + <returns>true if the value could be cast as an integer, false otherwise</returns> + </member> + <member name="M:DotSpatial.Data.Global.IsShort(System.Object)"> + <summary> + Tests an expression to see if it can be converted into a short. + </summary> + <param name="expression">The expression to test</param> + <returns>true if the value could be cast as a double, false otherwise</returns> + </member> + <member name="T:DotSpatial.Data.ICancelProgressHandler"> + <summary> + a IProgressHandler that carries a boolean property allowing the process using the handler to know if you should cancelled + </summary> + </member> + <member name="T:DotSpatial.Data.IProgressHandler"> + <summary> + An interface for sending progress messages. Percent is an integer from 0 to 100. + </summary> + </member> + <member name="M:DotSpatial.Data.IProgressHandler.Progress(System.String,System.Int32,System.String)"> + <summary> + Progress is the method that should receive a progress message. + </summary> + <param name="key">The message string without any information about the status of completion.</param> + <param name="percent">An integer from 0 to 100 that indicates the condition for a status bar etc.</param> + <param name="message">A string containing both information on what the process is, as well as its completion status.</param> + </member> + <member name="P:DotSpatial.Data.ICancelProgressHandler.Cancel"> + <summary> + Returns true if the progress handler has been notified that the running process should be cancelled + </summary> + </member> + <member name="T:DotSpatial.Data.IEventDictionary`2"> + <summary> + Represents a nongeneric collection of key/value pairs. + </summary> + </member> + <member name="M:DotSpatial.Data.IEventDictionary`2.ContainsValue(`1)"> + <summary> + Determines whether the IEventDictionary<TKey, TValue> contains a specific value. + </summary> + <param name="value">The value to locate in the IEventDictionary<TKey, TValue>. The value can be null for reference types.</param> + <returns>true if the IEventDictionary<TKey, TValue> contains an element with the specified value; otherwise, false.</returns> + </member> + <member name="P:DotSpatial.Data.IEventDictionary`2.Count"> + <summary> + Two separate forms of count exist and are ambiguous so this provides a single new count + </summary> + </member> + <member name="P:DotSpatial.Data.IEventDictionary`2.Item(System.Int32)"> + <summary> + Gets or sets the specific KeyValuePair for the specified index + </summary> + <param name="index">The integer index representing the order in the list</param> + <returns>A KeyValuePair that is currently stored at the specified index </returns> + </member> + <member name="E:DotSpatial.Data.IEventDictionary`2.BeforeItemAdded"> + <summary> + Occurs before an item is added to the List. + There is no index yet specified because it will be added to the + end of the list. + </summary> + </member> + <member name="E:DotSpatial.Data.IEventDictionary`2.BeforeRangeAdded"> + <summary> + Occurs before a range of items is added to the list. + There is no index yet, but this event can be cancelled. + </summary> + </member> + <member name="E:DotSpatial.Data.IEventDictionary`2.AfterItemAdded"> + <summary> + Occurs after an item has already been added to the list. + The index where the item was added is specified. + </summary> + </member> + <member name="E:DotSpatial.Data.IEventDictionary`2.AfterRangeAdded"> + <summary> + Occurs after a range has already been added to the list. + This reveals the index where the beginning of the range + was added, but cannot be canceled. + </summary> + </member> + <member name="E:DotSpatial.Data.IEventDictionary`2.BeforeClearing"> + <summary> + Occurs before a clear action, allowing the event to be canceled. + </summary> + </member> + <member name="E:DotSpatial.Data.IEventDictionary`2.AfterClearing"> + <summary> + Occurs after a clear action, allowing the event to be cancled + </summary> + </member> + <member name="E:DotSpatial.Data.IEventDictionary`2.ListChanged"> + <summary> + Occurs after a method that changes either the order or the members of this EventDictionary + </summary> + </member> + <member name="E:DotSpatial.Data.IEventDictionary`2.BeforeItemInserted"> + <summary> + Occurs before an item is inserted. The index of the requested + insertion as well as the item being inserted and an option to + cancel the event are specified + </summary> + </member> + <member name="E:DotSpatial.Data.IEventDictionary`2.BeforeRangeInserted"> + <summary> + Occurs before a range is inserted. The index of the requested + insertion location as well as the item being inserted and an option to + cancel the event are provided in the event arguments + </summary> + </member> + <member name="E:DotSpatial.Data.IEventDictionary`2.AfterItemInserted"> + <summary> + Occurs after an item is inserted. + Shows the true index of the item after it was actually added. + </summary> + </member> + <member name="E:DotSpatial.Data.IEventDictionary`2.AfterRangeInserted"> + <summary> + Occurs after an item is inserted. + Shows the true index of the item after it was actually added. + </summary> + </member> + <member name="E:DotSpatial.Data.IEventDictionary`2.BeforeItemRemoved"> + <summary> + Occurs before an item is removed from the List. + Specifies the item, the current index and an option to cancel. + </summary> + </member> + <member name="E:DotSpatial.Data.IEventDictionary`2.BeforeRangeRemoved"> + <summary> + Occurs before a range is removed from the List. + Specifies the range, the current index and an option to cancel. + </summary> + </member> + <member name="E:DotSpatial.Data.IEventDictionary`2.AfterItemRemoved"> + <summary> + Occurs after an item is removed from the List. + Gives a handle to the item that was removed, but it no longer + has a meaningful index value or an option to cancel. + </summary> + </member> + <member name="E:DotSpatial.Data.IEventDictionary`2.AfterRangeRemoved"> + <summary> + Occurs after an item is removed from the List. + Gives a handle to the range that was removed, but it no longer + has a meaningful index value or an option to cancel. + </summary> + </member> + <member name="E:DotSpatial.Data.IEventDictionary`2.BeforeAllMatchingRemoved"> + <summary> + Occurs before all the elements that match a predicate are removed. + Supplies an IEnumerable list in the event args of all the items + that will match the expression. This action can be cancelled. + </summary> + </member> + <member name="E:DotSpatial.Data.IEventDictionary`2.AfterAllMatchingRemoved"> + <summary> + Occurs after all the elements that matched a predicate were + removed. The values are the items that were successfully removed. + The action has already happened, and so cannot be cancelled here. + </summary> + </member> + <member name="E:DotSpatial.Data.IEventDictionary`2.BeforeItemSet"> + <summary> + Occurs before an item is set. This event can cancel the set opperation. + </summary> + </member> + <member name="E:DotSpatial.Data.IEventDictionary`2.AfterItemSet"> + <summary> + Occurs after an item is successfully set + </summary> + </member> + <member name="T:DotSpatial.Data.IListEM"> + <summary> + IListEM + </summary> + </member> + <member name="M:DotSpatial.Data.IListEM.IncreaseIndex``1(System.Collections.Generic.IList{``0},``0)"> + <summary> + This extension method helps by simply increasing the index value of the specified item + by one. + </summary> + <typeparam name="T">The generic type of this list</typeparam> + <param name="self">This list</param> + <param name="item">The item to increase the index of</param> + </member> + <member name="M:DotSpatial.Data.IListEM.DecreaseIndex``1(System.Collections.Generic.IList{``0},``0)"> + <summary> + Decreases the index of the specified item by one. + </summary> + <typeparam name="T">The type of the list</typeparam> + <param name="self">This list</param> + <param name="item">the item of type T to decrease the index of.</param> + </member> + <member name="T:DotSpatial.Data.INamedList"> + <summary> + INamedList + </summary> + </member> + <member name="M:DotSpatial.Data.INamedList.Demote(System.String)"> + <summary> + Re-orders the list so that the index of the specifeid item is lower, + and threfore will be drawn earlier, and therefore should appear + in a lower position on the list. + </summary> + <param name="name">The name of the item to demote</param> + </member> + <member name="M:DotSpatial.Data.INamedList.GetItem(System.String)"> + <summary> + Gets the item with the specified name as an object. + This enables the INamedList to work with items even + if it doesn't know the strong type. + </summary> + <param name="name">The string name of the item to retrieve</param> + <returns>The actual item cast as an object.</returns> + </member> + <member name="M:DotSpatial.Data.INamedList.GetNameOfObject(System.Object)"> + <summary> + Gets the name of the specified item, even if the strong type of the + item is not known. + </summary> + <param name="item">The item to get the name of cast as an object</param> + <returns>The string name of the specified object.</returns> + </member> + <member name="M:DotSpatial.Data.INamedList.GetNames"> + <summary> + Gets the list of names for the items currently stored in the list, + in the sequence defined by the list of items. + </summary> + </member> + <member name="M:DotSpatial.Data.INamedList.Promote(System.String)"> + <summary> + Re-orders the list so that the index of the specified item is higher, + and therefore will be drawn later, and therefore should appear + in a higher position on the list. + </summary> + <param name="name"></param> + </member> + <member name="M:DotSpatial.Data.INamedList.RefreshNames"> + <summary> + Updates the names to match the current set of actual items. + </summary> + </member> + <member name="M:DotSpatial.Data.INamedList.Remove(System.String)"> + <summary> + Removes the item with the specified name from the list. + </summary> + <param name="name">The string name of the item to remove</param> + </member> + <member name="P:DotSpatial.Data.INamedList.BaseName"> + <summary> + Gets or sets the base name to use for naming items + </summary> + </member> + <member name="P:DotSpatial.Data.INamedList.Count"> + <summary> + Gets the count of the items in the list. + </summary> + </member> + <member name="T:DotSpatial.Data.IndividualEventArgs`1"> + <summary> + Carries event arguments for the generic IEventList + </summary> + </member> + <member name="M:DotSpatial.Data.IndividualEventArgs`1.#ctor(`0)"> + <summary> + Creates a new instance of a ListEventArgs class + </summary> + <param name="inListItem">an object that is being interacted with in the list</param> + </member> + <member name="P:DotSpatial.Data.IndividualEventArgs`1.ListItem"> + <summary> + Gets the list item being referenced by this event + </summary> + </member> + <member name="T:DotSpatial.Data.IndividualCancelEventArgs`1"> + <summary> + The same as a ListEventArgs, but provides an option to cancel the event + </summary> + </member> + <member name="F:DotSpatial.Data.IndividualCancelEventArgs`1._listItem"> + <summary> + The protected object internal to this list event args class + </summary> + </member> + <member name="M:DotSpatial.Data.IndividualCancelEventArgs`1.#ctor(`0)"> + <summary> + Creates a new instance of a ListEventArgs class + </summary> + <param name="inListItem">an object that is being interacted with in the list</param> + </member> + <member name="P:DotSpatial.Data.IndividualCancelEventArgs`1.ListItem"> + <summary> + Gets the list item being referenced by this event + </summary> + </member> + <member name="T:DotSpatial.Data.IndividualDictionaryEventArgs`2"> + <summary> + Carries event arguments for the generic IEventList + </summary> + </member> + <member name="M:DotSpatial.Data.IndividualDictionaryEventArgs`2.#ctor(`0,`1)"> + <summary> + Creates a new instance of a ListEventArgs class + </summary> + <param name="inKey">The key of type <TKey> being referenced</param> + <param name="inValue">an object of type <TValue> that is being referenced</param> + </member> + <member name="P:DotSpatial.Data.IndividualDictionaryEventArgs`2.Key"> + <summary> + Gets the key of the item being referenced by this event + </summary> + </member> + <member name="P:DotSpatial.Data.IndividualDictionaryEventArgs`2.Value"> + <summary> + Gets the actual item being referenced by this event + </summary> + </member> + <member name="T:DotSpatial.Data.IndividualDictionaryCancelEventArgs`2"> + <summary> + Contains properties for both a specified item and an integer index + as well as the option to cancel. + </summary> + </member> + <member name="M:DotSpatial.Data.IndividualDictionaryCancelEventArgs`2.#ctor(`0,`1)"> + <summary> + Creates a new instance of a ListEventArgs class + </summary> + <param name="inKey">The key that provides direct access to the value member being interacted with</param> + <param name="inValue">an object that is being interacted with in the list</param> + </member> + <member name="P:DotSpatial.Data.IndividualDictionaryCancelEventArgs`2.Key"> + <summary> + Gets the key for the member referenced by this event + </summary> + </member> + <member name="P:DotSpatial.Data.IndividualDictionaryCancelEventArgs`2.Value"> + <summary> + Gets the specific item being accessed + </summary> + </member> + <member name="T:DotSpatial.Data.IndividualIndex`1"> + <summary> + Carries event arguments for the generic IEventList + </summary> + </member> + <member name="F:DotSpatial.Data.IndividualIndex`1._listItem"> + <summary> + The protected object internal to this list event args class + </summary> + </member> + <member name="M:DotSpatial.Data.IndividualIndex`1.#ctor(`0)"> + <summary> + Creates a new instance of a ListEventArgs class + </summary> + <param name="inListItem">an object that is being interacted with in the list</param> + </member> + <member name="M:DotSpatial.Data.IndividualIndex`1.#ctor(`0,System.Int32)"> + <summary> + Creates a new instance of a ListEventArgs class + </summary> + <param name="inListItem">The list item that the event belongs to</param> + <param name="inIndex">The list index, if any, that is specified.</param> + </member> + <member name="P:DotSpatial.Data.IndividualIndex`1.ListItem"> + <summary> + Gets the list item being referenced by this event + </summary> + </member> + <member name="P:DotSpatial.Data.IndividualIndex`1.Index"> + <summary> + Gets the index for the ListItem + </summary> + </member> + <member name="T:DotSpatial.Data.IndividualIndexCancel`1"> + <summary> + Contains properties for both a specified item and an integer index + as well as the option to cancel. + </summary> + </member> + <member name="M:DotSpatial.Data.IndividualIndexCancel`1.#ctor(`0)"> + <summary> + Creates a new instance of a ListEventArgs class + </summary> + <param name="inListItem">an object that is being interacted with in the list</param> + </member> + <member name="M:DotSpatial.Data.IndividualIndexCancel`1.#ctor(`0,System.Int32)"> + <summary> + Creates a new instance of a ListEventArgs class + </summary> + <param name="inListItem">The list item that the event belongs to</param> + <param name="inIndex">The list index, if any, that is specified.</param> + </member> + <member name="P:DotSpatial.Data.IndividualIndexCancel`1.ListItem"> + <summary> + Gets the list item being referenced by this event + </summary> + </member> + <member name="P:DotSpatial.Data.IndividualIndexCancel`1.Index"> + <summary> + Gets the index for the ListItem + </summary> + </member> + <member name="T:DotSpatial.Data.IOrderedDictionary`2"> + <summary> + This has the indexing and ordering capabilities, but without all the events of an EventDictionary + </summary> + </member> + <member name="M:DotSpatial.Data.IOrderedDictionary`2.ContainsValue(`1)"> + <summary> + Determines whether the IEventDictionary<TKey, TValue> contains a specific value. + </summary> + <param name="value">The value to locate in the IEventDictionary<TKey, TValue>. The value can be null for reference types.</param> + <returns>true if the IEventDictionary<TKey, TValue> contains an element with the specified value; otherwise, false.</returns> + </member> + <member name="M:DotSpatial.Data.IOrderedDictionary`2.GetValue(`0)"> + <summary> + Obtains a value in the dictionary based on a key. This happens without consulting the + index at all. + </summary> + <param name="key">The Tkey key to search for.</param> + <returns>The TValue to obtain a value for. </returns> + </member> + <member name="M:DotSpatial.Data.IOrderedDictionary`2.SetValue(`0,`1)"> + <summary> + Sets the value associated with a key that is already in the dictionary. + </summary> + <param name="key">The key currently found in the index</param> + <param name="value">the value to be changed</param> + </member> + <member name="M:DotSpatial.Data.IOrderedDictionary`2.GetIndex(System.Int32)"> + <summary> + Gets a pair based on the index value + </summary> + <param name="index"></param> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.IOrderedDictionary`2.SetIndex(System.Int32,System.Collections.Generic.KeyValuePair{`0,`1})"> + <summary> + Sets a pair based on the index value + </summary> + <param name="index"></param> + <param name="item"></param> + </member> + <member name="P:DotSpatial.Data.IOrderedDictionary`2.Count"> + <summary> + Two separate forms of count exist and are ambiguous so this provides a single new count + </summary> + </member> + <member name="P:DotSpatial.Data.IOrderedDictionary`2.Item(System.Int32)"> + <summary> + For ordered dictionaries, the default accessor returns the Key Value Pair associated with the + index. + </summary> + <param name="index"></param> + <returns></returns> + </member> + <member name="T:DotSpatial.Data.IParentItem`1"> + <summary> + Any item which can be contained by a parent item + </summary> + <typeparam name="T">The type class of the potential parent</typeparam> + </member> + <member name="M:DotSpatial.Data.IParentItem`1.GetParentItem"> + <summary> + Gets the parent item relative to this item. + </summary> + </member> + <member name="M:DotSpatial.Data.IParentItem`1.SetParentItem(`0)"> + <summary> + Sets teh parent legend item for this item + </summary> + <param name="value"></param> + </member> + <member name="T:DotSpatial.Data.IReadOnlyList`1"> + <summary> + IReadOnlyList + </summary> + </member> + <member name="M:DotSpatial.Data.IReadOnlyList`1.Contains(`0)"> + <summary> + Tests to see if the specified item is contained in the list. This returns true if the item is contained in the list. + </summary> + <param name="item">The item to test for.</param> + <returns>Boolean, true if the item is found in the list</returns> + </member> + <member name="M:DotSpatial.Data.IReadOnlyList`1.CopyTo(`0[],System.Int32)"> + <summary> + Copies the specified memebers into the array, starting at the specified index. + </summary> + <param name="array">The array to copy values to.</param> + <param name="arrayIndex">The array index where the 0 member of this list should be copied to.</param> + </member> + <member name="M:DotSpatial.Data.IReadOnlyList`1.IndexOf(`0)"> + <summary> + Obtains the index of the specified item + </summary> + <param name="item">The item to find the index of</param> + <returns>An integer representing the index of the specified item</returns> + </member> + <member name="P:DotSpatial.Data.IReadOnlyList`1.Count"> + <summary> + Gets the integer count of items in this list. + </summary> + </member> + <member name="P:DotSpatial.Data.IReadOnlyList`1.IsReadOnly"> + <summary> + Return true because this is a read-only list. + </summary> + </member> + <member name="P:DotSpatial.Data.IReadOnlyList`1.Item(System.Int32)"> + <summary> + Gets the item at the specified index. Ideally, this ReadOnlyList is used with + value types, or else this gives the user considerable power over the core content. + </summary> + <param name="index">The item to obtain from this list</param> + <returns>The item at the specified index.</returns> + </member> + <member name="T:DotSpatial.Data.ITreeList`1"> + <summary> + An all purpose item + </summary> + </member> + <member name="T:DotSpatial.Data.MessageCancelEventArgs"> + <summary> + A set of PaintEventArgs that can be used before a drawing function in order to cancel an event. + </summary> + </member> + <member name="M:DotSpatial.Data.MessageCancelEventArgs.#ctor(System.String)"> + <summary> + Creates a new instance of the MessageCancel Event Arguments + </summary> + <param name="message">A string message to convey with this event.</param> + </member> + <member name="P:DotSpatial.Data.MessageCancelEventArgs.Cancel"> + <summary> + Returns a boolean specifying whether the action that caused this event should be canceled. + </summary> + </member> + <member name="P:DotSpatial.Data.MessageCancelEventArgs.Message"> + <summary> + The message allowing someone to decide whether or not the process should be cancelled. For instance, + when writing a new file, a message might show "The file C:\bob.txt already exists, overwrite it?" + </summary> + </member> + <member name="T:DotSpatial.Data.NamedList`1"> + <summary> + A named list preserves a 1:1 mapping between names and items. It can be used to + reference information in either direction. It essentially provides a string + handle for working with generic typed ILists. This cannot instantiate new + items. (Creating a default T would not work, for instance, for an interface). + </summary> + </member> + <member name="M:DotSpatial.Data.NamedList`1.#ctor"> + <summary> + Creates a new instance of NamedList + </summary> + </member> + <member name="M:DotSpatial.Data.NamedList`1.#ctor(System.Collections.Generic.IList{`0})"> + <summary> + Creates a new instance of a named list. + </summary> + <param name="values">The values to use for the content.</param> + </member> + <member name="M:DotSpatial.Data.NamedList`1.#ctor(System.Collections.Generic.IList{`0},System.String)"> + <summary> + Creates a new instance of a named list. + </summary> + <param name="values">The values to use for the content.</param> + <param name="baseName">The string that should preceed the numbering to describe the individual items.</param> + </member> + <member name="M:DotSpatial.Data.NamedList`1.Demote(System.String)"> + <summary> + Re-orders the list so that the index of the specifeid item is lower, + and threfore will be drawn earlier, and therefore should appear + in a lower position on the list. + </summary> + <param name="name"></param> + </member> + <member name="M:DotSpatial.Data.NamedList`1.GetNameOfObject(System.Object)"> + <summary> + Gets the name of the item corresponding + </summary> + <param name="value">The item cast as an object.</param> + <returns>The string name of the specified object, or null if the cast fails.</returns> + </member> + <member name="M:DotSpatial.Data.NamedList`1.GetItem(System.String)"> + <summary> + Gets the item with the specified name as an object. + This enables the INamedList to work with items even + if it doesn't know the strong type. + </summary> + <param name="name">The string name of the item to retrieve</param> + <returns>The actual item cast as an object.</returns> + </member> + <member name="M:DotSpatial.Data.NamedList`1.GetNames"> + <summary> + Gets the list of names for the items currently stored in the list, + in the sequence defined by the list of items. + </summary> + </member> + <member name="M:DotSpatial.Data.NamedList`1.Promote(System.String)"> + <summary> + Re-orders the list so that the index of the specified item is higher, + and therefore will be drawn later, and therefore should appear + in a higher position on the list. + </summary> + <param name="name"></param> + </member> + <member name="M:DotSpatial.Data.NamedList`1.RefreshNames"> + <summary> + Updates the names to match the current set of actual items. + </summary> + </member> + <member name="M:DotSpatial.Data.NamedList`1.Remove(System.String)"> + <summary> + Removes the item with the specified name from the list. + </summary> + <param name="name">The string name of the item to remove</param> + </member> + <member name="M:DotSpatial.Data.NamedList`1.Demote(`0)"> + <summary> + Re-orders the list so that this item appears closer to the 0 index. + </summary> + <param name="item"></param> + </member> + <member name="M:DotSpatial.Data.NamedList`1.GetName(`0)"> + <summary> + Gets the string name for the specified item + </summary> + <param name="item">The item of type T to find the name for</param> + <returns>The string name corresponding to the specified item.</returns> + </member> + <member name="M:DotSpatial.Data.NamedList`1.Promote(`0)"> + <summary> + Re-orders the list so that the index of the specified item is higher, + and therefore will be drawn later, and therefore should appear + in a higher position on the list. + </summary> + <param name="item"></param> + </member> + <member name="M:DotSpatial.Data.NamedList`1.Remove(`0)"> + <summary> + Removes the specified item + </summary> + <param name="item">The item to remove.</param> + </member> + <member name="P:DotSpatial.Data.NamedList`1.Item(System.String)"> + <summary> + Gets or sets the item corresponding to the specified name. Setting this + will re-use the same name and position in the list, but set a new object. + </summary> + <param name="name">The string name of the item to obtain</param> + <returns>The item of type T corresponding to the specified name</returns> + </member> + <member name="P:DotSpatial.Data.NamedList`1.Items"> + <summary> + Gets the list of actual items. This is basically a reference copy of + the actual collection of items to be contained in this named list. + </summary> + </member> + <member name="P:DotSpatial.Data.NamedList`1.BaseName"> + <summary> + Gets or sets the base name to use for naming items + </summary> + </member> + <member name="P:DotSpatial.Data.NamedList`1.Count"> + <summary> + Gets the count of the items in the list. + </summary> + </member> + <member name="T:DotSpatial.Data.NonNumericException"> + <summary> + NonNumericException + </summary> + </member> + <member name="M:DotSpatial.Data.NonNumericException.#ctor(System.String)"> + <summary> + Creates a new instance of NonNumericException + </summary> + <param name="invalidVariable">The string name of the variable, or value that cannot be parsed as a number.</param> + </member> + <member name="T:DotSpatial.Data.Number"> + <summary> + NumberFormat + </summary> + </member> + <member name="M:DotSpatial.Data.Number.#ctor(System.Object)"> + <summary> + Creates a value from an object + </summary> + <param name="value">A numeric value that is, or can be parsed to a numeric value.</param> + <exception cref="T:DotSpatial.Data.NonNumericException">Not Numeric</exception> + </member> + <member name="M:DotSpatial.Data.Number.#ctor(System.Double)"> + <summary> + Creates a number to fit the specified double value. + </summary> + <param name="value">A double</param> + </member> + <member name="M:DotSpatial.Data.Number.#ctor(System.Int32)"> + <summary> + Creates a number to fit the specified int value + </summary> + <param name="value">An integer</param> + </member> + <member name="M:DotSpatial.Data.Number.#ctor(System.Single)"> + <summary> + Creates a number to fit the specified float value + </summary> + <param name="value">The value to work with</param> + </member> + <member name="M:DotSpatial.Data.Number.#ctor(System.Int16)"> + <summary> + Creates a number from a short + </summary> + <param name="value">A short</param> + </member> + <member name="M:DotSpatial.Data.Number.CompareTo(System.Object)"> + <summary> + Compares this with the specified value. Returns 1 if the other + item is greater than this value, 0 if they are equal and -1 if + the other value is less than this value. + </summary> + <param name="other">The value to be tested.</param> + <returns>An integer: 1 if the other + item is greater than this value, 0 if they are equal and -1 if + the other value is less than this value. </returns> + </member> + <member name="M:DotSpatial.Data.Number.CompareTo(System.Double)"> + <summary> + Compares this with the specified value. Returns 1 if the other + item is greater than this value, 0 if they are equal and -1 if + the other value is less than this value. + </summary> + <param name="other">The value to be tested.</param> + <returns>An integer: 1 if the other + item is greater than this value, 0 if they are equal and -1 if + the other value is less than this value. </returns> + </member> + <member name="M:DotSpatial.Data.Number.CompareTo(DotSpatial.Data.Number)"> + <summary> + Compares this with the specified value. Returns 1 if the other + item is greater than this value, 0 if they are equal and -1 if + the other value is less than this value. + </summary> + <param name="other">The value to be tested.</param> + <returns>An integer: 1 if the other + item is greater than this value, 0 if they are equal and -1 if + the other value is less than this value. </returns> + </member> + <member name="M:DotSpatial.Data.Number.ToString"> + <summary> + Returns this Number as a string. + </summary> + <returns>The string created using the specified number format and precision.</returns> + </member> + <member name="M:DotSpatial.Data.Number.ToString(System.IFormatProvider)"> + <summary> + Returns this Number as a string. + </summary> + <param name="provider">An IFormatProvider that provides culture specific formatting information.</param> + <returns>A string with the formatted number.</returns> + </member> + <member name="M:DotSpatial.Data.Number.ToString(System.String)"> + <summary> + Returns this Number as a string. + </summary> + <param name="format">A string that controls how this value should be formatted.</param> + <returns>A string with the formatted number.</returns> + </member> + <member name="M:DotSpatial.Data.Number.ToString(System.String,System.IFormatProvider)"> + <summary> + Returns this Number as a string. + </summary> + <param name="format">A string that controls how this value should be formatted.</param> + <param name="provider">An IFormatProvider that provides culture specific formatting information.</param> + <returns>A string with the formatted number.</returns> + </member> + <member name="M:DotSpatial.Data.Number.ToInt32"> + <summary> + Gets this number as an int 32 + </summary> + <returns>An integer</returns> + </member> + <member name="M:DotSpatial.Data.Number.ToInt16"> + <summary> + Gets this number as a short, or a short.MaxValue/short.MinValue + </summary> + <returns>A short</returns> + </member> + <member name="M:DotSpatial.Data.Number.ToFloat"> + <summary> + Gets this number as a float + </summary> + <returns>A float </returns> + </member> + <member name="P:DotSpatial.Data.Number.Code"> + <summary> + Gets the alphabetical letter code for ToString(-Code-) + </summary> + </member> + <member name="P:DotSpatial.Data.Number.Format"> + <summary> + A NumberFormats enumeration giving the various formatting options + </summary> + </member> + <member name="P:DotSpatial.Data.Number.IsEmpty"> + <summary> + Tests to see if a value has been assigned to this Number + </summary> + </member> + <member name="P:DotSpatial.Data.Number.DecimalsCount"> + <summary> + Gets or sets the number of digits that folow the decimal + when converting this value to string notation. + </summary> + </member> + <member name="P:DotSpatial.Data.Number.SignificantFigures"> + <summary> + Gets the precision (determined by the data type) which + effectively describes how many significant figures there are. + </summary> + </member> + <member name="P:DotSpatial.Data.Number.Value"> + <summary> + Gets this number as a double + </summary> + <returns>a double</returns> + </member> + <member name="T:DotSpatial.Data.NumberFormat"> + <summary> + NumberFormats + </summary> + </member> + <member name="F:DotSpatial.Data.NumberFormat.Currency"> + <summary> + Currency - C + </summary> + </member> + <member name="F:DotSpatial.Data.NumberFormat.Exponential"> + <summary> + Scientific Notation Exponential - E + </summary> + </member> + <member name="F:DotSpatial.Data.NumberFormat.FixedPoint"> + <summary> + Fixed point - F + The number is converted to a string of the form "-ddd.ddd…" where each 'd' + indicates a digit (0-9). The string starts with a minus sign if the number + is negative. + </summary> + </member> + <member name="F:DotSpatial.Data.NumberFormat.General"> + <summary> + Shortest text - G + </summary> + </member> + <member name="F:DotSpatial.Data.NumberFormat.Number"> + <summary> + Number - N, The number is converted to a string of the form "-d, ddd, ddd.ddd…", + where '-' indicates a negative number symbol if required, 'd' indicates a digit + (0-9), ',' indicates a thousand separator between number groups, and '.' indicates + a decimal point symbol + </summary> + </member> + <member name="F:DotSpatial.Data.NumberFormat.Percent"> + <summary> + Percent, value is multiplied by 100 and shown with a % symbol (cultural specific) + </summary> + </member> + <member name="F:DotSpatial.Data.NumberFormat.Unspecified"> + <summary> + No format specified. + </summary> + </member> + <member name="T:DotSpatial.Data.ReadOnlyList`1"> + <summary> + In cases where we want to allow some basic cycling or checking of values, but we don't want the user to change + the values directly, we can wrap the values in this read-only list, which restricts what the user can do. + </summary> + </member> + <member name="M:DotSpatial.Data.ReadOnlyList`1.#ctor(System.Collections.Generic.IList{`0})"> + <summary> + Creates a new instance of ReadOnlyList + </summary> + </member> + <member name="M:DotSpatial.Data.ReadOnlyList`1.Contains(`0)"> + <summary> + Tests to see if the specified item is contained in the list. This returns true if the item is contained in the list. + </summary> + <param name="item">The item to test for.</param> + <returns>Boolean, true if the item is found in the list</returns> + </member> + <member name="M:DotSpatial.Data.ReadOnlyList`1.CopyTo(`0[],System.Int32)"> + <summary> + Copies the specified memebers into the array, starting at the specified index. + </summary> + <param name="array">The array to copy values to.</param> + <param name="arrayIndex">The array index where the 0 member of this list should be copied to.</param> + </member> + <member name="M:DotSpatial.Data.ReadOnlyList`1.GetEnumerator"> + <summary> + Obtains an enumerator for cycling through the values in this list. + </summary> + <returns>An enumerator for the items in this list.</returns> + </member> + <member name="M:DotSpatial.Data.ReadOnlyList`1.IndexOf(`0)"> + <summary> + Obtains the index of the specified item + </summary> + <param name="item">The item to find the index of</param> + <returns>An integer representing the index of the specified item</returns> + </member> + <member name="P:DotSpatial.Data.ReadOnlyList`1.Count"> + <summary> + Gets the integer count of items in this list. + </summary> + </member> + <member name="P:DotSpatial.Data.ReadOnlyList`1.IsReadOnly"> + <summary> + Return true because this is a read-only list. + </summary> + </member> + <member name="P:DotSpatial.Data.ReadOnlyList`1.Item(System.Int32)"> + <summary> + Gets the item at the specified index. Ideally, this ReadOnlyList is used with + value types, or else this gives the user considerable power over the core content. + </summary> + <param name="index">The item to obtain from this list</param> + <returns>The item at the specified index.</returns> + </member> + <member name="T:DotSpatial.Data.SubclassList`2"> + <summary> + SubclassList is brilliant if I do say so myself. Let's say you have a list of IPointCategory, which is a subclass of IFeatureCategory. + You can't have a strong typed List that is both without creating a special class that can deal with the specific implementations of + each. So I was writing all of the stupid type specific collection classes, when in reality, I just needed a class like this + that could handle the business logic. Then specific instances can just inherit from this class, but specify the two types. + </summary> + <typeparam name="TBase">The base type that is inherited</typeparam> + <typeparam name="TSub">The sub type that inherits from the base type</typeparam> + </member> + <member name="M:DotSpatial.Data.SubclassList`2.Add(`1)"> + <summary> + Allows adding of the sub type + </summary> + <param name="item"></param> + </member> + <member name="M:DotSpatial.Data.SubclassList`2.AddRange(System.Collections.Generic.IEnumerable{`1})"> + <summary> + Adds the entire range of enumerable elements. + </summary> + <param name="items">The items to add</param> + </member> + <member name="M:DotSpatial.Data.SubclassList`2.Contains(`1)"> + <summary> + Tests to see if the list contains the specified item. + </summary> + <param name="item">The item to check the list for.</param> + <returns>Boolean, true if the item is contained in the list.</returns> + </member> + <member name="M:DotSpatial.Data.SubclassList`2.CopyTo(`1[],System.Int32)"> + <summary> + Copies each of the members to the specified array. + </summary> + <param name="array">The array to copy items to.</param> + <param name="arrayIndex">The zero based integer index in the destination array where the first item should be saved.</param> + </member> + <member name="M:DotSpatial.Data.SubclassList`2.GetEnumerator"> + <summary> + Gets an enumerator of type TSub for cycling through the list. + </summary> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.SubclassList`2.IndexOf(`1)"> + <summary> + Gets the zero based integer index of the specified item of type TSub + </summary> + <param name="item">The item to obtain the index of</param> + <returns>The zero based integer index of the specified item</returns> + </member> + <member name="M:DotSpatial.Data.SubclassList`2.Insert(System.Int32,`1)"> + <summary> + inserts the specified item into the specified index + </summary> + <param name="index">The zero based integer index where insertion can take place</param> + <param name="item">The item to insert of type TSub</param> + </member> + <member name="M:DotSpatial.Data.SubclassList`2.Remove(`1)"> + <summary> + Removes the specified item from the list. + </summary> + <param name="item">The item to remove</param> + <returns>Boolean, true if the item was found in the list and removed</returns> + </member> + <member name="P:DotSpatial.Data.SubclassList`2.Item(System.Int32)"> + <summary> + Gets or sets the specific item in the list + </summary> + <param name="index"></param> + <returns></returns> + </member> + <member name="T:DotSpatial.Data.SubclassList`2.SubclassListEnumerator`2"> + <summary> + I can't simply return the enumerator of the internal list because it would be the wrong type. + Furthermore, I need to know both types so that I can cast them appropriately. + </summary> + <typeparam name="TB">The base type that is inherited</typeparam> + <typeparam name="TS">The sub type that inherits from the base type</typeparam> + </member> + <member name="M:DotSpatial.Data.SubclassList`2.SubclassListEnumerator`2.#ctor(System.Collections.Generic.IEnumerator{`2})"> + <summary> + Creates a new instance of the enumerator of the sub-type given an enumerator + of the base type. + </summary> + <param name="internalEnumerator">The internal enumerator.</param> + </member> + <member name="M:DotSpatial.Data.SubclassList`2.SubclassListEnumerator`2.Dispose"> + <summary> + Disposes any unmanaged memory objects + </summary> + </member> + <member name="M:DotSpatial.Data.SubclassList`2.SubclassListEnumerator`2.MoveNext"> + <summary> + Advances the enumerator to the next position + </summary> + <returns>Boolean, false at the end of the list.</returns> + </member> + <member name="M:DotSpatial.Data.SubclassList`2.SubclassListEnumerator`2.Reset"> + <summary> + Resets the enumerator to the beginning of the list + </summary> + </member> + <member name="P:DotSpatial.Data.SubclassList`2.SubclassListEnumerator`2.Current"> + <summary> + Gets the current member returned as type TSub. + </summary> + </member> + <member name="T:DotSpatial.Data.TreeList`1"> + <summary> + A list that keeps track of a "parent" body that is also of type T. + Whenever a member is added to the list, it sets the parent property. + </summary> + </member> + <member name="M:DotSpatial.Data.TreeList`1.#ctor"> + <summary> + Initializes a new instance of list with no parent + </summary> + </member> + <member name="M:DotSpatial.Data.TreeList`1.#ctor(`0)"> + <summary> + Instantiates a new instance of a TreeList of type T, where the specified parent + will be used as the parent for each of the items of type T in the list. + </summary> + <param name="parent">The ParentItem of the specified item</param> + </member> + <member name="M:DotSpatial.Data.TreeList`1.Add(`0)"> + <summary> + Adds the item to the list, setting the parent to be the list's parent + </summary> + <param name="item"></param> + </member> + <member name="M:DotSpatial.Data.TreeList`1.AddRange(System.Collections.Generic.IEnumerable{`0})"> + <summary> + Adds the elements of the specified collection to the end of the System.Collections.Generic.List<T> + </summary> + <param name="collection">collection: The collection whose elements should be added to the end of the + System.Collections.Generic.List<T>. The collection itself cannot be null, but it can contain elements that are null, + if type T is a reference type.</param> + <exception cref="T:System.ApplicationException">Unable to add while the ReadOnly property is set to true.</exception> + </member> + <member name="M:DotSpatial.Data.TreeList`1.BinarySearch(`0)"> + <summary> + Searches the entire sorted System.Collections.Generic.List<T> for an element using the default comparer and returns the zero-based index of the element. + </summary> + <param name="item">The object to locate. The value can be null for reference types.</param> + <returns>The zero-based index of item in the sorted System.Collections.Generic.List<T>, if item is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than item or, if there is no larger element, the bitwise complement of System.Collections.Generic.List<T>.Count.</returns> + <exception cref="T:System.InvalidOperationException">The default comparer System.Collections.Generic.Comparer<T>.Default cannot find an implementation of the System.IComparable<T> generic interface or the System.IComparable interface for type T.</exception> + </member> + <member name="M:DotSpatial.Data.TreeList`1.Clear"> + <summary> + Removes all elements from the EventList<T>. + </summary> + <exception cref="T:System.ApplicationException">Unable to clear while the ReadOnly property is set to true.</exception> + </member> + <member name="M:DotSpatial.Data.TreeList`1.Contains(`0)"> + <summary> + Determines whether an element is in the System.Collections.Generic.List<T>. + </summary> + <param name="item"> The object to locate in the System.Collections.Generic.List<T>. The value can be null for reference types.</param> + <returns>true if item is found in the System.Collections.Generic.List<T>; otherwise, false.</returns> + </member> + <member name="M:DotSpatial.Data.TreeList`1.GetEnumerator"> + <summary> + Returns an enumerator that iterates through this list + </summary> + <returns></returns> + </member> + <member name="M:DotSpatial.Data.TreeList`1.CopyTo(`0[],System.Int32)"> + <summary> + Copies the entire System.Collections.Generic.List<T> to a compatible one-dimensional array, starting at the specified index of the target array. + </summary> + <param name="array">The one-dimensional System.Array that is the destination of the elements copied from System.Collections.Generic.List<T>. The System.Array must have zero-based indexing.</param> + <param name="arrayIndex"> The zero-based index in array at which copying begins.</param> + <exception cref="T:System.ArgumentException">System.ArgumentException: arrayIndex is equal to or greater than the length of array.-or-The number of elements in the source System.Collections.Generic.List<T> is greater than the available space from arrayIndex to the end of the destination array. </exception> + <exception cref="T:System.ArgumentOutOfRangeException">arrayIndex is less than 0</exception> + <exception cref="T:System.ArgumentNullException">array is null</exception> + </member> + <member name="M:DotSpatial.Data.TreeList`1.CopyTo(System.Int32,`0[],System.Int32,System.Int32)"> + <summary> + Copies a range of elements from the EventList<T> to a compatible one-dimensional array, starting at the specified index of the target array. + </summary> + <param name="index">The zero-based index in the source EventList<T> at which copying begins</param> + <param name="array">The one-dimensional System.Array that is the destination of the elements copied from EventList<T>. The System.Array must have zero-based indexing.</param> + <param name="arrayIndex">The zero-based index in array at which copying begins.</param> + <param name="count">The number of elements to copy.</param> + <exception cref="T:System.ArgumentNullException">array is null.</exception> + <exception cref="T:System.ArgumentOutOfRangeException"> index is less than 0.-or-arrayIndex is less than 0.-or-count is less than 0.</exception> + <exception cref="T:System.ArgumentException">index is equal to or greater than the EventList<T>.Count of the source EventList<T>.-or-arrayIndex is equal to or greater than the length of array.-or-The number of elements from index to the end of the source EventList<T> is greater than the available space from arrayIndex to the end of the destination array.</exception> + </member> + <member name="M:DotSpatial.Data.TreeList`1.CopyTo(`0[])"> + <summary> + Copies the entire EventList<T> to a compatible one-dimensional array, starting at the beginning of the target array. + </summary> + <param name="array">The one-dimensional System.Array that is the destination of the elements copied from EventList<T>. The System.Array must have zero-based indexing.</param> + <exception cref="T:System.ArgumentException">The number of elements in the source EventList<T> is greater than the number of elements that the destination array can contain.</exception> + <exception cref="T:System.ArgumentNullException">array is null.</exception> + </member> + <member name="M:DotSpatial.Data.TreeList`1.ConvertAll``1(System.Converter{`0,``0})"> + <summary> + Converts the elements in the current EventList<T> to another type, and returns a list containing the converted elements. + </summary> + <typeparam name="TOutput">The output type to convert to</typeparam> + <param name="converter">A System.Converter<TInput, TOutput> delegate that converts each element from one type to another type.</param> + <returns>A List<T> of the target type containing the converted elements from the current EventList<T>.</returns> + <exception cref="T:System.ArgumentNullException">converter is null.</exception> + </member> + <member name="M:DotSpatial.Data.TreeList`1.Exists(System.Predicate{`0})"> + <summary> + Determines whether the EventList<T> contains elements that match the conditions defined by the specified predicate. + </summary> + <param name="match">The System.Predicate<T> delegate that defines the conditions of the elements to search for.</param> + <returns>true if the EventList<T> contains one or more elements that match the conditions defined by the specified predicate; otherwise, false.</returns> + <exception cref="T:System.ArgumentNullException">match is null.</exception> + </member> + <member name="M:DotSpatial.Data.TreeList`1.GetRange(System.Int32,System.Int32)"> + <summary> + Creates a shallow copy of a range of elements in the source EventList<T>. + </summary> + <param name="index">The zero-based EventList<T> index at which the range starts.</param> + <param name="count"> The number of elements in the range.</param> + <returns>A shallow copy of a range of elements in the source EventList<T>.</returns> + <exception cref="T:System.ArgumentOutOfRangeException">index is less than 0.-or-count is less than 0.</exception> + <exception cref="T:System.ArgumentException">index and count do not denote a valid range of elements in the EventList<T>.</exception> + </member> + <member name="M:DotSpatial.Data.TreeList`1.ToArray"> + <summary> + Copies the elements of the DotSpatial.Interfaces.Framework.IEventList<T> to a new array. + </summary> + <returns>An array containing copies of the elements of the DotSpatial.Interfaces.Framework.IEventList<T>.</returns> + </member> + <member name="M:DotSpatial.Data.TreeList`1.TrimExcess"> + <summary> + Sets the capacity to the actual number of elements in the DotSpatial.Interfaces.Framework.IEventList<T>, if that number is less than a threshold value. + </summary> + </member> + <member name="M:DotSpatial.Data.TreeList`1.TrueForAll(System.Predicate{`0})"> + <summary> + Determines whether every element in the DotSpatial.Interfaces.Framework.IEventList<T> matches the conditions defined by the specified predicate. + </summary> + <param name="match">The System.Predicate<T> delegate that defines the conditions to check against the elements.</param> + <returns>true if every element in the DotSpatial.Interfaces.Framework.IEventList<T> matches the conditions defined by the specified predicate; otherwise, false. If the list has no elements, the return value is true.</returns> + <exception cref="T:System.ArgumentNullException">match is null.</exception> + </member> + <member name="M:DotSpatial.Data.TreeList`1.IndexOf(`0)"> + <summary> + Searches for the specified object and returns the zero-based index of the first occurrence within the entire System.Collections.Generic.List<T>. + </summary> + <param name="item">The object to locate in the System.Collections.Generic.List<T>. The value can be null for reference types.</param> + <returns>The zero-based index of the first occurrence of item within the entire System.Collections.Generic.List<T>, if found; otherwise, –1.</returns> + </member> + <member name="M:DotSpatial.Data.TreeList`1.IndexOf(`0,System.Int32,System.Int32)"> + <summary> + Searches for the specified object and returns the zero-based index of the first occurrence within the range of elements in the EventList<T> that starts at the specified index and contains the specified number of elements. + </summary> + <param name="item">The object to locate in the EventList<T>. The value can be null for reference types.</param> + <param name="index"> The zero-based starting index of the search.</param> + <param name="count">The number of elements in the section to search.</param> + <returns>The zero-based index of the first occurrence of item within the range of elements in the EventList<T> that starts at index and contains count number of elements, if found; otherwise, –1.</returns> + <exception cref="T:System.ArgumentOutOfRangeException"> index is outside the range of valid indexes for the EventList<T>.-or-count is less than 0.-or-index and count do not specify a valid section in the EventList<T>.</exception> + </member> + <member name="M:DotSpatial.Data.TreeList`1.IndexOf(`0,System.Int32)"> + <summary> + Searches for the specified object and returns the zero-based index of the first occurrence within the range of elements in the EventList<T> that extends from the specified index to the last element. + </summary> + <param name="item">The object to locate in the EventList<T>. The value can be null for reference types.</param> + <param name="index"> The zero-based starting index of the search.</param> + <returns>The zero-based index of the first occurrence of item within the range of elements in the EventList<T> that extends from index to the last element, if found; otherwise, –1.</returns> + <exception cref="T:System.ArgumentOutOfRangeException">index is outside the range of valid indexes for the EventList<T>.</exception> + </member> + <member name="M:DotSpatial.Data.TreeList`1.Insert(System.Int32,`0)"> + <summary> + Inserts an element into the System.Collections.Generic.List<T> at the specified index. + </summary> + <param name="index">The zero-based index at which item should be inserted.</param> + <param name="item">The object to insert. The value can be null for reference types.</param> + <exception cref="T:System.ArgumentOutOfRangeException">index is less than 0.-or-index is greater than System.Collections.Generic.List<T>.Count.</exception> + <exception cref="T:System.ApplicationException">Unable to insert while the ReadOnly property is set to true.</exception> + </member> + <member name="M:DotSpatial.Data.TreeList`1.InsertRange(System.Int32,System.Collections.Generic.IEnumerable{`0})"> + <summary> + Inserts the elements of a collection into the EventList<T> at the specified index. + </summary> + <param name="index">The zero-based index at which the new elements should be inserted.</param> + <param name="collection">The collection whose elements should be inserted into the EventList<T>. The collection itself cannot be null, but it can contain elements that are null, if type T is a reference type.</param> + <exception cref="T:System.ArgumentOutOfRangeException">index is less than 0.-or-index is greater than EventList<T>.Count.</exception> + <exception cref="T:System.ArgumentNullException">collection is null.</exception> + <exception cref="T:System.ApplicationException">Unable to insert while the ReadOnly property is set to true.</exception> + </member> + <member name="M:DotSpatial.Data.TreeList`1.LastIndexOf(`0,System.Int32,System.Int32)"> + <summary> + Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the EventList<T> that contains the specified number of elements and ends at the specified index. + </summary> + <param name="item">The object to locate in the EventList<T>. The value can be null for reference types.</param> + <param name="index">The zero-based starting index of the backward search.</param> + <param name="count">The number of elements in the section to search.</param> + <returns>The zero-based index of the last occurrence of item within the range of elements in the EventList<T> that contains count number of elements and ends at index, if found; otherwise, –1.</returns> + <exception cref="T:System.ArgumentOutOfRangeException">index is outside the range of valid indexes for the EventList<T>.-or-count is less than 0.-or-index and count do not specify a valid section in the EventList<T>.</exception> + </member> + <member name="M:DotSpatial.Data.TreeList`1.LastIndexOf(`0,System.Int32)"> + <summary> + Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the EventList<T> that extends from the first element to the specified index. + </summary> + <param name="item">The object to locate in the EventList<T>. The value can be null for reference types.</param> + <param name="index">The zero-based starting index of the backward search.</param> + <returns>The zero-based index of the last occurrence of item within the range of elements in the EventList<T> that extends from the first element to index, if found; otherwise, –1.</returns> + <exception cref="T:System.ArgumentOutOfRangeException">index is outside the range of valid indexes for the EventList<T>.</exception> + </member> + <member name="M:DotSpatial.Data.TreeList`1.LastIndexOf(`0)"> + <summary> + Searches for the specified object and returns the zero-based index of the last occurrence within the entire EventList<T>. + </summary> + <param name="item">The object to locate in the EventList<T>. The value can be null for reference types.</param> + <returns>The zero-based index of the last occurrence of item within the entire the EventList<T>, if found; otherwise, –1.</returns> + </member> + <member name="M:DotSpatial.Data.TreeList`1.Remove(`0)"> + <summary> + Removes the first occurrence of a specific object from the System.Collections.Generic.List<T>. + </summary> + <param name="item">The object to remove from the System.Collections.Generic.List<T>. The value can be null for reference types.</param> + <returns>true if item is successfully removed; otherwise, false. This method also returns false if item was not + found in the System.Collections.Generic.List<T>.</returns> + <exception cref="T:System.ApplicationException">Unable to remove while the ReadOnly property is set to true.</exception> + </member> + <member name="M:DotSpatial.Data.TreeList`1.RemoveAt(System.Int32)"> + <summary> + Removes the element at the specified index of the System.Collections.Generic.List<T>. + </summary> + <param name="index">The zero-based index of the element to remove.</param> + <exception cref="T:System.ApplicationException">Unable to remove while the ReadOnly property is set to true.</exception> + </member> + <member name="M:DotSpatial.Data.TreeList`1.RemoveAll(System.Predicate{`0})"> + <summary> + Removes the all the elements that match the conditions defined by the specified predicate. + </summary> + <param name="match">The System.Predicate<T> delegate that defines the conditions of the elements to remove.</param> + <returns>The number of elements removed from the EventList<T></returns> + <exception cref="T:System.ArgumentNullException">match is null.</exception> + <exception cref="T:System.ApplicationException">Unable to remove while the ReadOnly property is set to true.</exception> + </member> + <member name="M:DotSpatial.Data.TreeList`1.RemoveRange(System.Int32,System.Int32)"> + <summary> + Removes a range of elements from the EventList<T>. + </summary> + <param name="index">The zero-based starting index of the range of elements to remove.</param> + <param name="count">The number of elements to remove.</param> + <exception cref="T:System.ArgumentOutOfRangeException">index is less than 0.-or-count is less than 0.</exception> + <exception cref="T:System.ArgumentException">index and count do not denote a valid range of elements in the EventList<T>.</exception> + <exception cref="T:System.ApplicationException">Unable to remove while the ReadOnly property is set to true.</exception> + </member> + <member name="M:DotSpatial.Data.TreeList`1.Reverse(System.Int32,System.Int32)"> + <summary> + Reverses the order of the elements in the specified range. + </summary> + <param name="index">The zero-based starting index of the range to reverse.</param> + <param name="count">The number of elements in the range to reverse.</param> + <exception cref="T:System.ArgumentException">index and count do not denote a valid range of elements in the EventList<T>.</exception> + <exception cref="T:System.ArgumentOutOfRangeException">index is less than 0.-or-count is less than 0.</exception> + <exception cref="T:System.ApplicationException">Unable to reverse while the ReadOnly property is set to true.</exception> + </member> + <member name="M:DotSpatial.Data.TreeList`1.Reverse"> + <summary> + Reverses the order of the elements in the entire EventList<T>. + </summary> + <exception cref="T:System.ApplicationException">Unable to reverse while the ReadOnly property is set to true.</exception> + </member> + <member name="M:DotSpatial.Data.TreeList`1.Sort(System.Comparison{`0})"> + <summary> + Sorts the elements in the entire EventList<T> using the specified System.Comparison<T>. + </summary> + <param name="comparison">The System.Comparison<T> to use when comparing elements.</param> + <exception cref="T:System.ArgumentException">The implementation of comparison caused an error during the sort. For example, comparison might not return 0 when comparing an item with itself.</exception> + <exception cref="T:System.ArgumentNullException">comparison is null.</exception> + <exception cref="T:System.ApplicationException">Unable to sort while the ReadOnly property is set to true.</exception> + </member> + <member name="M:DotSpatial.Data.TreeList`1.Sort(System.Int32,System.Int32,System.Collections.Generic.IComparer{`0})"> + <summary> + Sorts the elements in a range of elements in EventList<T> using the specified comparer. + </summary> + <param name="index"> The zero-based starting index of the range to sort.</param> + <param name="count">The length of the range to sort.</param> + <param name="comparer">The System.Collections.Generic.IComparer<T> implementation to use when comparing elements, or null to use the default comparer System.Collections.Generic.Comparer<T>.Default.</param> + <exception cref="T:System.ArgumentException">index and count do not specify a valid range in the EventList<T>.-or-The implementation of comparer caused an error during the sort. For example, comparer might not return 0 when comparing an item with itself.</exception> + <exception cref="T:System.ArgumentOutOfRangeException">index is less than 0.-or-count is less than 0.</exception> + <exception cref="T:System.InvalidOperationException"> comparer is null, and the default comparer + System.Collections.Generic.Comparer<T>.Default cannot find implementation of the System.IComparable<T> + generic interface or the System.IComparable interface for type T.</exception> + <exception cref="T:System.ApplicationException">Unable to sort while the ReadOnly property is set to true.</exception> + </member> + <member name="M:DotSpatial.Data.TreeList`1.Sort(System.Collections.Generic.IComparer{`0})"> + <summary> + Sorts the elements in the entire DotSpatial.Interfaces.Framework.IEventList<T> using the specified comparer. + </summary> + <param name="comparer"> The System.Collections.Generic.IComparer<T> implementation to use when comparing elements, or null to use the default comparer System.Collections.Generic.Comparer<T>.Default.</param> + <exception cref="T:System.ArgumentException">The implementation of comparer caused an error during the sort. For example, comparer might not return 0 when comparing an item with itself.</exception> + <exception cref="T:System.InvalidOperationException">comparer is null, and the default comparer System.Collections.Generic.Comparer<T>.Default cannot find implementation of the System.IComparable<T> generic interface or the System.IComparable interface for type T.</exception> + <exception cref="T:System.ApplicationException">Unable to sort while the ReadOnly property is set to true.</exception> + </member> + <member name="M:DotSpatial.Data.TreeList`1.Sort"> + <summary> + Sorts the elements in the entire DotSpatial.Interfaces.Framework.IEventList<T> using the default comparer. + </summary> + <exception cref="T:System.InvalidOperationException">The default comparer System.Collections.Generic.Comparer<T>.Default cannot find an implementation of the System.IComparable<T> generic interface or the System.IComparable interface for type T.</exception> + <exception cref="T:System.ApplicationException">Unable to sort while the ReadOnly property is set to true.</exception> + </member> + <member name="M:DotSpatial.Data.TreeList`1.FindAll(System.Predicate{`0})"> + <summary> + Retrieves all the elements that match the conditions described by the specified predicate + </summary> + <param name="match">The System.Predicate that defines the conditions to search for</param> + <returns>A List of matches</returns> + </member> + <member name="M:DotSpatial.Data.TreeList`1.FindIndex(System.Int32,System.Int32,System.Predicate{`0})"> + <summary> + Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the range of elements in the EventList<T> that starts at the specified index and contains the specified number of elements. + </summary> + <param name="startIndex">The zero-based starting index of the search.</param> + <param name="count">The number of elements in the section to search.</param> + <param name="match"> The System.Predicate<T> delegate that defines the conditions of the element to search for.</param> + <returns>The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1</returns> + <exception cref="T:System.ArgumentOutOfRangeException">startIndex is outside the range of valid indexes for the EventList<T>.-or-count is less than 0.-or-startIndex and count do not specify a valid section in the EventList<T>.</exception> + <exception cref="T:System.ArgumentNullException">match is null</exception> + </member> + <member name="M:DotSpatial.Data.TreeList`1.FindIndex(System.Int32,System.Predicate{`0})"> + <summary> + Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the range of elements in the EventList<T> that extends from the specified index to the last element. + </summary> + <param name="startIndex">The zero-based starting index of the search.</param> + <param name="match">The System.Predicate<T> delegate that defines the conditions of the element to search for.</param> + <returns>The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1.</returns> + <exception cref="T:System.ArgumentOutOfRangeException">startIndex is outside the range of valid indexes for the EventList<T>.</exception> + <exception cref="T:System.ArgumentNullException">match is null.</exception> + </member> + <member name="M:DotSpatial.Data.TreeList`1.FindIndex(System.Predicate{`0})"> + <summary> + Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the entire EventList<T>. + </summary> + <param name="match">The System.Predicate<T> delegate that defines the conditions of the element to search for.</param> + <returns>The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1.</returns> + <exception cref="T:System.ArgumentNullException">match is null.</exception> + </member> + <member name="M:DotSpatial.Data.TreeList`1.FindLast(System.Predicate{`0})"> + <summary> + Searches for an element that matches the conditions defined by the specified predicate, and returns the last occurrence within the entire EventList<T>. + </summary> + <param name="match">The System.Predicate<T> delegate that defines the conditions of the element to search for.</param> + <returns>The last element that matches the conditions defined by the specified predicate, if found; otherwise, the default value for type T.</returns> + <exception cref="T:System.ArgumentNullException">match is null."</exception> + </member> + <member name="M:DotSpatial.Data.TreeList`1.FindLastIndex(System.Int32,System.Int32,System.Predicate{`0})"> + <summary> + Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the range of elements in the EventList<T> that contains the specified number of elements and ends at the specified index. + </summary> + <param name="startIndex">The zero-based starting index of the backward search.</param> + <param name="count">The number of elements in the section to search.</param> + <param name="match"></param> + <returns>The System.Predicate<T> delegate that defines the conditions of the element to search for.</returns> + <exception cref="T:System.ArgumentOutOfRangeException">startIndex is outside the range of valid indexes for the EventList<T>.-or-count is less than 0.-or-startIndex and count do not specify a valid section in the EventList<T>.</exception> + <exception cref="T:System.ArgumentNullException">match is null.</exception> + </member> + <member name="M:DotSpatial.Data.TreeList`1.FindLastIndex(System.Int32,System.Predicate{`0})"> + <summary> + Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the range of elements in the EventList<T> that extends from the first element to the specified index. + </summary> + <param name="startIndex"> The zero-based starting index of the backward search.</param> + <param name="match">The System.Predicate<T> delegate that defines the conditions of the element to search for.</param> + <returns>The zero-based index of the last occurrence of an element that matches the conditions defined by match, if found; otherwise, –1.</returns> + <exception cref="T:System.ArgumentOutOfRangeException">: startIndex is outside the range of valid indexes for the EventList<T>.</exception> + </member> + <member name="M:DotSpatial.Data.TreeList`1.FindLastIndex(System.Predicate{`0})"> + <summary> + Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the entire EventList<T>. + </summary> + <param name="match">The System.Predicate<T> delegate that defines the conditions of the element to search for.</param> + <returns>The zero-based index of the last occurrence of an element that matches the conditions defined by match, if found; otherwise, –1.</returns> + <exception cref="T:System.ArgumentNullException">match is null.</exception> + </member> + <member name="M:DotSpatial.Data.TreeList`1.OnInclude(`0)"> + <summary> + This sets the parent item of the item being added to this treelist. + </summary> + <param name="item">The item being included</param> + </member> + <member name="M:DotSpatial.Data.TreeList`1.OnExclude(`0)"> + <summary> + This reverts the parent item of an item when it is removed from this treelist + </summary> + <param name="item">The item being removed from the list</param> + </member> + <member name="P:DotSpatial.Data.TreeList`1.Capacity"> + <summary> + Gets or sets the total number of elements the internal data structure can hold without resizing. + </summary> + <returns> + The number of elements that the DotSpatial.Interfaces.Framework.IEventList<T> can contain before resizing is required. + </returns> + <exception cref="T:System.ArgumentOutOfRangeException">DotSpatial.Interfaces.Framework.IEventList<T>.Capacity is set to a value that is less than DotSpatial.Interfaces.Framework.IEventList<T>.Count.</exception> + </member> + <member name="P:DotSpatial.Data.TreeList`1.Count"> + <summary> + Gets the count of the members in the list + </summary> + </member> + <member name="P:DotSpatial.Data.TreeList`1.Item(System.Int32)"> + <summary> + The default, indexed value of type T + </summary> + <param name="index">The numeric index</param> + <returns>An object of type T corresponding to the index value specified</returns> + </member> + <member name="P:DotSpatial.Data.TreeList`1.IsReadOnly"> + <summary> + Gets a boolean property indicating whether this list can be written to. + </summary> + </member> + <member name="T:DotSpatial.Data.ValidationType"> + <summary> + ValidationType + </summary> + </member> + <member name="F:DotSpatial.Data.ValidationType.None"> + <summary> + No validation will be performed + </summary> + </member> + <member name="F:DotSpatial.Data.ValidationType.String"> + <summary> + Any string value, including null will be accepted + </summary> + </member> + <member name="F:DotSpatial.Data.ValidationType.Byte"> + <summary> + Only values that can be parsed to byte values will be accepted + </summary> + </member> + <member name="F:DotSpatial.Data.ValidationType.Short"> + <summary> + Only values that can be parsed to short values will be accepted + </summary> + </member> + <member name="F:DotSpatial.Data.ValidationType.Integer"> + <summary> + Only values that can be parsed to integer values will be accepted + </summary> + </member> + <member name="F:DotSpatial.Data.ValidationType.Float"> + <summary> + Only values that can be parsed to float values will be accepted + </summary> + </member> + <member name="F:DotSpatial.Data.ValidationType.Double"> + <summary> + Only values that can be parsed to double values will be accepted + </summary> + </member> + <member name="F:DotSpatial.Data.ValidationType.PositiveShort"> + <summary> + Only values that can be parsed to positive short values will be accepted + </summary> + </member> + <member name="F:DotSpatial.Data.ValidationType.PositiveInteger"> + <summary> + Only values that can be parsed to positive integer values will be accepted + </summary> + </member> + <member name="F:DotSpatial.Data.ValidationType.PositiveFloat"> + <summary> + Only values that can be parsed to positive float values will be accepted + </summary> + </member> + <member name="F:DotSpatial.Data.ValidationType.PositiveDouble"> + <summary> + Only values that can be parsed to positive double values will be accepted + </summary> + </member> + <member name="T:DotSpatial.Data.MockICancelProgressHandler"> + <summary> + This class converts an IProgressHandler to an ICancelProgressHandler. It wraps the IProgressHandler so that + it can be used by a class that requires an ICancelProgressHandler. Cancel will always return false. + </summary> + </member> + <member name="M:DotSpatial.Data.MockICancelProgressHandler.#ctor(DotSpatial.Data.IProgressHandler)"> + <summary> + Initializes a new instance of the <see cref="T:DotSpatial.Data.MockICancelProgressHandler"/> class. + </summary> + <param name="progressHandler">The progress handler.</param> + </member> + <member name="M:DotSpatial.Data.MockICancelProgressHandler.Progress(System.String,System.Int32,System.String)"> + <summary> + Progress is the method that should receive a progress message. + </summary> + <param name="key">The message string without any information about the status of completion.</param> + <param name="percent">An integer from 0 to 100 that indicates the condition for a status bar etc.</param> + <param name="message">A string containing both information on what the process is, as well as its completion status.</param> + </member> + <member name="P:DotSpatial.Data.MockICancelProgressHandler.Cancel"> + <summary> + Returns true if the running process should be cancelled + </summary> + </member> + </members> +</doc> Index: DamClients/DamUI/trunk/release/Install_Version/it-IT/DotSpatial.Projections.Forms.resources.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/TmpImportFiles/soilprofiles.csv =================================================================== diff -u --- DamClients/DamUI/trunk/release/Install_Version/TmpImportFiles/soilprofiles.csv (revision 0) +++ DamClients/DamUI/trunk/release/Install_Version/TmpImportFiles/soilprofiles.csv (revision 2315) @@ -0,0 +1,2 @@ +soilprofile_id;soil_name;aaa;bbb; +1DP1;10;HW-OBO Index: DamClients/DamUI/trunk/release/Install_Version/zh-CN/DotSpatial.Symbology.Forms.resources.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/DevExpress.XtraNavBar.v12.2.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/DevExpress.XtraCharts.v12.2.Wizard.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/TestResults/TestSeriesTestOut.xml =================================================================== diff -u --- DamClients/DamUI/trunk/release/Install_Version/TestResults/TestSeriesTestOut.xml (revision 0) +++ DamClients/DamUI/trunk/release/Install_Version/TestResults/TestSeriesTestOut.xml (revision 2315) @@ -0,0 +1,46 @@ +<?xml version="1.0" encoding="utf-8" standalone="yes"?> +<TimeSeries version="1.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.wldelft.nl/fews/PI"> + <timeZone>4.75</timeZone> + <series> + <header> + <type>accumulative</type> + <locationId>LLANFAIR-04</locationId> + <parameterId>Train speed</parameterId> + <timeStep unit="hour" multiplier="12" divider="60" /> + <startDate date="2009-04-13" time="11:51:42" /> + <endDate date="2009-05-18" time="22:04:16" /> + <missVal>82.9</missVal> + <longName>Llanfairpwllgwyngyllgogerychwyrndrobwllllantysiliogogogoch</longName> + <stationName>Llanfairpwllgwyngyllgogerychwyrndrobwllllantysiliogogogoch Railway Station</stationName> + <units>mph</units> + <sourceOrganisation>British Rail</sourceOrganisation> + <sourceSystem>British railroad system</sourceSystem> + <fileDescription>Llanfair trains</fileDescription> + <creationDate>2009-06-03</creationDate> + <creationTime>11:54:17</creationTime> + <region>North Wales</region> + </header> + <event date="2009-04-13" time="11:51:42" value="103.7" flag="0" /> + <event date="2009-04-13" time="12:51:42" value="88.4" flag="1" /> + <event date="2009-04-13" time="13:51:42" value="120.53" flag="1" /> + <event date="2009-04-13" time="14:51:42" value="108.5" flag="2" /> + <comment>Who knows how to pronounce Llanfairpwllgwyngyllgogerychwyrndrobwllllantysiliogogogoch?</comment> + </series> + <series> + <header> + <type>instantaneous</type> + <locationId>GORSAF-13</locationId> + <parameterId>Bus speed</parameterId> + <timeStep unit="minute" multiplier="18" divider="35" /> + <startDate date="2009-03-29" time="13:04:17" /> + <endDate date="2009-05-04" time="08:52:37" /> + <missVal>109.17</missVal> + </header> + <event date="2009-03-29" time="13:04:17" value="45.7" flag="0" /> + <event date="2009-03-29" time="13:05:17" value="55.4" flag="1" /> + <event date="2009-03-29" time="13:06:17" value="80.57" flag="1" /> + <event date="2009-03-29" time="13:07:17" value="120.45" flag="3" /> + <event date="2009-03-29" time="13:08:17" value="108.45" flag="1" /> + <event date="2009-03-29" time="13:09:17" value="115.6" flag="2" /> + </series> +</TimeSeries> \ No newline at end of file Index: DamClients/DamUI/trunk/release/Install_Version/CsvToDamx.pdb =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.Standard.Maps.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/DevExpress.RichEdit.v12.2.Core.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.DamPiping.Sellmeijer4ForcesCalculator.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/zh-CN/DotSpatial.Modeling.Forms.resources.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/testfile.txt =================================================================== diff -u --- DamClients/DamUI/trunk/release/Install_Version/testfile.txt (revision 0) +++ DamClients/DamUI/trunk/release/Install_Version/testfile.txt (revision 2315) @@ -0,0 +1 @@ +test data \ No newline at end of file Index: DamClients/DamUI/trunk/release/Install_Version/nunit.framework.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/DevExpress.Printing.v12.2.Core.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/NetTopologySuite.IO.GeoTools.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/log4net.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/test.shp =================================================================== diff -u --- DamClients/DamUI/trunk/release/Install_Version/test.shp (revision 0) +++ DamClients/DamUI/trunk/release/Install_Version/test.shp (revision 2315) @@ -0,0 +1,3 @@ +First line +Second line +Third line Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.Dam.Application.pdb =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/pt-BR/DotSpatial.Controls.resources.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/CsvToDamx.exe =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/DotSpatial.Data.pdb =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.Standard.Forms.DExpress.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/DotSpatial.Mono.pdb =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.Geotechnics.TestUtils.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/InputFile.xml =================================================================== diff -u --- DamClients/DamUI/trunk/release/Install_Version/InputFile.xml (revision 0) +++ DamClients/DamUI/trunk/release/Install_Version/InputFile.xml (revision 2315) @@ -0,0 +1,169 @@ +<?xml version="1.0" encoding="utf-8"?> +<Input xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" DamProjectType="Design" FailureMechanismSystemType="2" PipingModelType="Bligh" AnalysisType="AdaptGeometry" ProjectPath="D:\TestDamFolder\Sub" MaxCalculationCores="3"> + <Locations> + <Location SurfaceLineName="SurfaceLine 0" SegmentName="Segment 0" Name="Location 1" DikeEmbankmentMaterial="DikeMat" XSoilGeometry2DOrigin="0.01"> + <DesignOptions RedesignDikeHeight="false" RedesignDikeShoulder="false" ShoulderEmbankmentMaterial="ShoulderMat1" StabilityShoulderGrowSlope="0.5" StabilityShoulderGrowDeltaX="0.51" StabilitySlopeAdaptionDeltaX="0.52" SlopeAdaptionStartCotangent="0.53" SlopeAdaptionEndCotangent="0.54" SlopeAdaptionStepCotangent="0.55" NewDikeTopWidth="0.56" NewDikeSlopeInside="0.57" NewDikeSlopeOutside="0.58" NewShoulderTopSlope="0.59" NewShoulderBaseSlope="0.6" NewMaxHeightShoulderAsFraction="0.61" NewMinDistanceDikeToeStartDitch="0.62" UseNewDitchDefinition="true" NewWidthDitchBottom="0.63" NewSlopeAngleDitch="0.64" NewDepthDitch="0.65" StabilityDesignMethod="SlopeAdaptionBeforeShoulderAdaption" /> + <WaternetOptions PhreaticLineCreationMethod="ExpertKnowledgeRRD" PolderLevel="0.11" HeadPl2="0.28" HeadPl3="0.29" HeadPl4="0.3" DampingFactorPl3="0.12" DampingFactorPl4="0.13" PenetrationLength="0.14" SlopeDampingFactor="0.19" Pl1BelowCrestRiverside="0.2" Pl1BelowCrestPolderside="0.21" Pl1BelowShoulderCrestPolderside="0.22" Pl1BelowToeDikePolderside="0.23" Pl1BelowCrestMiddle="0.15" Pl1FactorBelowShoulderCrest="0.16" IntrusionVerticalWaterPressure="Standard" DikeSoilScenario="ClayDikeOnClay" /> + <DesignScenarios> + <DesignScenario Id="1" RiverLevel="0.51" RiverLevelLow="0.52" DikeTableHeight="0.53" PlLineOffsetBelowDikeTopAtRiver="0.54" PlLineOffsetBelowDikeTopAtPolder="0.55" PlLineOffsetBelowShoulderBaseInside="0.56" PlLineOffsetBelowDikeToeAtPolder="0.57" PlLineOffsetBelowDikeCrestMiddle="0.58" PlLineOffsetFactorBelowShoulderCrest="0.59" HeadPl3="0.6" HeadPl4="0.61" UpliftCriterionStability="0.62" UpliftCriterionPiping="0.63" RequiredSafetyFactorStabilityInnerSlope="0.64" RequiredSafetyFactorStabilityOuterSlope="0.65" RequiredSafetyFactorPiping="0.66" /> + <DesignScenario Id="2" RiverLevel="0.51" RiverLevelLow="0.52" DikeTableHeight="0.53" PlLineOffsetBelowDikeTopAtRiver="0.54" PlLineOffsetBelowDikeTopAtPolder="0.55" PlLineOffsetBelowShoulderBaseInside="0.56" PlLineOffsetBelowDikeToeAtPolder="0.57" PlLineOffsetBelowDikeCrestMiddle="0.58" PlLineOffsetFactorBelowShoulderCrest="0.59" HeadPl3="0.6" HeadPl4="0.61" UpliftCriterionStability="0.62" UpliftCriterionPiping="0.63" RequiredSafetyFactorStabilityInnerSlope="0.64" RequiredSafetyFactorStabilityOuterSlope="0.65" RequiredSafetyFactorPiping="0.66" /> + <DesignScenario Id="3" RiverLevel="0.51" RiverLevelLow="0.52" DikeTableHeight="0.53" PlLineOffsetBelowDikeTopAtRiver="0.54" PlLineOffsetBelowDikeTopAtPolder="0.55" PlLineOffsetBelowShoulderBaseInside="0.56" PlLineOffsetBelowDikeToeAtPolder="0.57" PlLineOffsetBelowDikeCrestMiddle="0.58" PlLineOffsetFactorBelowShoulderCrest="0.59" HeadPl3="0.6" HeadPl4="0.61" UpliftCriterionStability="0.62" UpliftCriterionPiping="0.63" RequiredSafetyFactorStabilityInnerSlope="0.64" RequiredSafetyFactorStabilityOuterSlope="0.65" RequiredSafetyFactorPiping="0.66" /> + </DesignScenarios> + <StabilityOptions MapForSoilgeometries2D="TestMap" SoilDatabaseName="ASoildb.mdb" ZoneType="0" ForbiddenZoneFactor="0.42" ZoneAreaRestSlopeCrestWidth="0.43" TrafficLoad="0.44" MinimumCircleDepth="0" TrafficLoadDegreeOfConsolidation="0.45" /> + <ModelFactors RequiredSafetyFactorStabilityInnerSlope="0.66" RequiredSafetyFactorStabilityOuterSlope="0.67" RequiredSafetyFactorPiping="0.65" UpliftCriterionPiping="0.69" UpliftCriterionStability="0.68" /> + </Location> + <Location SurfaceLineName="SurfaceLine 1" SegmentName="Segment 1" Name="Location 2" DikeEmbankmentMaterial="DikeMat" XSoilGeometry2DOrigin="1.01"> + <DesignOptions RedesignDikeHeight="false" RedesignDikeShoulder="false" ShoulderEmbankmentMaterial="ShoulderMat2" StabilityShoulderGrowSlope="10.5" StabilityShoulderGrowDeltaX="10.51" StabilitySlopeAdaptionDeltaX="10.52" SlopeAdaptionStartCotangent="10.53" SlopeAdaptionEndCotangent="10.54" SlopeAdaptionStepCotangent="10.55" NewDikeTopWidth="10.56" NewDikeSlopeInside="10.57" NewDikeSlopeOutside="10.58" NewShoulderTopSlope="10.59" NewShoulderBaseSlope="10.6" NewMaxHeightShoulderAsFraction="10.61" NewMinDistanceDikeToeStartDitch="10.62" UseNewDitchDefinition="true" NewWidthDitchBottom="10.63" NewSlopeAngleDitch="10.64" NewDepthDitch="10.65" StabilityDesignMethod="SlopeAdaptionBeforeShoulderAdaption" /> + <WaternetOptions PhreaticLineCreationMethod="ExpertKnowledgeLinearInDike" PolderLevel="1.11" HeadPl2="1.28" HeadPl3="1.29" HeadPl4="1.3" DampingFactorPl3="1.12" DampingFactorPl4="1.13" PenetrationLength="1.1400000000000001" SlopeDampingFactor="1.19" Pl1BelowCrestRiverside="1.2" Pl1BelowCrestPolderside="1.21" Pl1BelowShoulderCrestPolderside="1.22" Pl1BelowToeDikePolderside="1.23" Pl1BelowCrestMiddle="1.15" Pl1FactorBelowShoulderCrest="1.16" IntrusionVerticalWaterPressure="Linear" DikeSoilScenario="ClayDikeOnClay" /> + <DesignScenarios> + <DesignScenario Id="1" RiverLevel="0.51" RiverLevelLow="0.52" DikeTableHeight="0.53" PlLineOffsetBelowDikeTopAtRiver="0.54" PlLineOffsetBelowDikeTopAtPolder="0.55" PlLineOffsetBelowShoulderBaseInside="0.56" PlLineOffsetBelowDikeToeAtPolder="0.57" PlLineOffsetBelowDikeCrestMiddle="0.58" PlLineOffsetFactorBelowShoulderCrest="0.59" HeadPl3="0.6" HeadPl4="0.61" UpliftCriterionStability="0.62" UpliftCriterionPiping="0.63" RequiredSafetyFactorStabilityInnerSlope="0.64" RequiredSafetyFactorStabilityOuterSlope="0.65" RequiredSafetyFactorPiping="0.66" /> + <DesignScenario Id="2" RiverLevel="1.51" RiverLevelLow="1.52" DikeTableHeight="1.53" PlLineOffsetBelowDikeTopAtRiver="1.54" PlLineOffsetBelowDikeTopAtPolder="1.55" PlLineOffsetBelowShoulderBaseInside="1.56" PlLineOffsetBelowDikeToeAtPolder="1.5699999999999998" PlLineOffsetBelowDikeCrestMiddle="1.58" PlLineOffsetFactorBelowShoulderCrest="1.5899999999999999" HeadPl3="1.6" HeadPl4="1.6099999999999999" UpliftCriterionStability="1.62" UpliftCriterionPiping="1.63" RequiredSafetyFactorStabilityInnerSlope="1.6400000000000001" RequiredSafetyFactorStabilityOuterSlope="1.65" RequiredSafetyFactorPiping="1.6600000000000001" /> + <DesignScenario Id="3" RiverLevel="2.51" RiverLevelLow="2.52" DikeTableHeight="2.5300000000000002" PlLineOffsetBelowDikeTopAtRiver="2.54" PlLineOffsetBelowDikeTopAtPolder="2.55" PlLineOffsetBelowShoulderBaseInside="2.56" PlLineOffsetBelowDikeToeAtPolder="2.57" PlLineOffsetBelowDikeCrestMiddle="2.58" PlLineOffsetFactorBelowShoulderCrest="2.59" HeadPl3="2.6" HeadPl4="2.61" UpliftCriterionStability="2.62" UpliftCriterionPiping="2.63" RequiredSafetyFactorStabilityInnerSlope="2.64" RequiredSafetyFactorStabilityOuterSlope="2.65" RequiredSafetyFactorPiping="2.66" /> + </DesignScenarios> + <StabilityOptions MapForSoilgeometries2D="TestMap" SoilDatabaseName="ASoildb.mdb" ZoneType="0" ForbiddenZoneFactor="10.42" ZoneAreaRestSlopeCrestWidth="10.43" TrafficLoad="10.44" MinimumCircleDepth="0" TrafficLoadDegreeOfConsolidation="10.45" /> + <ModelFactors RequiredSafetyFactorStabilityInnerSlope="10.66" RequiredSafetyFactorStabilityOuterSlope="10.67" RequiredSafetyFactorPiping="10.65" UpliftCriterionPiping="10.69" UpliftCriterionStability="10.68" /> + </Location> + <Location SurfaceLineName="SurfaceLine 2" SegmentName="Segment 0" Name="Location 3" DikeEmbankmentMaterial="DikeMat" XSoilGeometry2DOrigin="2.01"> + <DesignOptions RedesignDikeHeight="false" RedesignDikeShoulder="false" ShoulderEmbankmentMaterial="ShoulderMat3" StabilityShoulderGrowSlope="20.5" StabilityShoulderGrowDeltaX="20.51" StabilitySlopeAdaptionDeltaX="20.52" SlopeAdaptionStartCotangent="20.53" SlopeAdaptionEndCotangent="20.54" SlopeAdaptionStepCotangent="20.55" NewDikeTopWidth="20.56" NewDikeSlopeInside="20.57" NewDikeSlopeOutside="20.58" NewShoulderTopSlope="20.59" NewShoulderBaseSlope="20.6" NewMaxHeightShoulderAsFraction="20.61" NewMinDistanceDikeToeStartDitch="20.62" UseNewDitchDefinition="true" NewWidthDitchBottom="20.63" NewSlopeAngleDitch="20.64" NewDepthDitch="20.65" StabilityDesignMethod="SlopeAdaptionBeforeShoulderAdaption" /> + <WaternetOptions PhreaticLineCreationMethod="GaugesWithFallbackToExpertKnowledgeRRD" PolderLevel="2.11" HeadPl2="2.2800000000000002" HeadPl3="2.29" HeadPl4="2.3" DampingFactorPl3="2.12" DampingFactorPl4="2.13" PenetrationLength="2.14" SlopeDampingFactor="2.19" Pl1BelowCrestRiverside="2.2" Pl1BelowCrestPolderside="2.21" Pl1BelowShoulderCrestPolderside="2.22" Pl1BelowToeDikePolderside="2.23" Pl1BelowCrestMiddle="2.15" Pl1FactorBelowShoulderCrest="2.16" IntrusionVerticalWaterPressure="FullHydroStatic" DikeSoilScenario="ClayDikeOnClay" /> + <DesignScenarios> + <DesignScenario Id="1" RiverLevel="0.51" RiverLevelLow="0.52" DikeTableHeight="0.53" PlLineOffsetBelowDikeTopAtRiver="0.54" PlLineOffsetBelowDikeTopAtPolder="0.55" PlLineOffsetBelowShoulderBaseInside="0.56" PlLineOffsetBelowDikeToeAtPolder="0.57" PlLineOffsetBelowDikeCrestMiddle="0.58" PlLineOffsetFactorBelowShoulderCrest="0.59" HeadPl3="0.6" HeadPl4="0.61" UpliftCriterionStability="0.62" UpliftCriterionPiping="0.63" RequiredSafetyFactorStabilityInnerSlope="0.64" RequiredSafetyFactorStabilityOuterSlope="0.65" RequiredSafetyFactorPiping="0.66" /> + <DesignScenario Id="2" RiverLevel="2.51" RiverLevelLow="2.52" DikeTableHeight="2.5300000000000002" PlLineOffsetBelowDikeTopAtRiver="2.54" PlLineOffsetBelowDikeTopAtPolder="2.55" PlLineOffsetBelowShoulderBaseInside="2.56" PlLineOffsetBelowDikeToeAtPolder="2.57" PlLineOffsetBelowDikeCrestMiddle="2.58" PlLineOffsetFactorBelowShoulderCrest="2.59" HeadPl3="2.6" HeadPl4="2.61" UpliftCriterionStability="2.62" UpliftCriterionPiping="2.63" RequiredSafetyFactorStabilityInnerSlope="2.64" RequiredSafetyFactorStabilityOuterSlope="2.65" RequiredSafetyFactorPiping="2.66" /> + <DesignScenario Id="3" RiverLevel="4.51" RiverLevelLow="4.52" DikeTableHeight="4.53" PlLineOffsetBelowDikeTopAtRiver="4.54" PlLineOffsetBelowDikeTopAtPolder="4.55" PlLineOffsetBelowShoulderBaseInside="4.5600000000000005" PlLineOffsetBelowDikeToeAtPolder="4.57" PlLineOffsetBelowDikeCrestMiddle="4.58" PlLineOffsetFactorBelowShoulderCrest="4.59" HeadPl3="4.6" HeadPl4="4.61" UpliftCriterionStability="4.62" UpliftCriterionPiping="4.63" RequiredSafetyFactorStabilityInnerSlope="4.64" RequiredSafetyFactorStabilityOuterSlope="4.65" RequiredSafetyFactorPiping="4.66" /> + </DesignScenarios> + <StabilityOptions MapForSoilgeometries2D="TestMap" SoilDatabaseName="ASoildb.mdb" ZoneType="0" ForbiddenZoneFactor="20.42" ZoneAreaRestSlopeCrestWidth="20.43" TrafficLoad="20.44" MinimumCircleDepth="0" TrafficLoadDegreeOfConsolidation="20.45" /> + <ModelFactors RequiredSafetyFactorStabilityInnerSlope="20.66" RequiredSafetyFactorStabilityOuterSlope="20.67" RequiredSafetyFactorPiping="20.65" UpliftCriterionPiping="20.69" UpliftCriterionStability="20.68" /> + </Location> + </Locations> + <SurfaceLines> + <SurfaceLine Name="SurfaceLine 0"> + <Points> + <Point X="0" Z="0" PointType="1" /> + <Point X="2" Z="0.5" PointType="0" /> + <Point X="4" Z="0" PointType="5" /> + <Point X="9" Z="5" PointType="8" /> + <Point X="10" Z="5.2" PointType="0" /> + <Point X="13" Z="5.4" PointType="12" /> + <Point X="18" Z="1" PointType="15" /> + <Point X="24" Z="1" PointType="25" /> + </Points> + </SurfaceLine> + <SurfaceLine Name="SurfaceLine 1"> + <Points> + <Point X="0" Z="0" PointType="1" /> + <Point X="2" Z="0.5" PointType="0" /> + <Point X="4" Z="0" PointType="5" /> + <Point X="9" Z="5" PointType="8" /> + <Point X="10" Z="5.2" PointType="0" /> + <Point X="13" Z="5.4" PointType="12" /> + <Point X="18" Z="1" PointType="15" /> + <Point X="24" Z="1" PointType="25" /> + </Points> + </SurfaceLine> + <SurfaceLine Name="SurfaceLine 2"> + <Points> + <Point X="0" Z="0" PointType="1" /> + <Point X="2" Z="0.5" PointType="0" /> + <Point X="4" Z="0" PointType="5" /> + <Point X="9" Z="5" PointType="8" /> + <Point X="10" Z="5.2" PointType="0" /> + <Point X="13" Z="5.4" PointType="12" /> + <Point X="18" Z="1" PointType="15" /> + <Point X="24" Z="1" PointType="25" /> + </Points> + </SurfaceLine> + </SurfaceLines> + <Soils> + <Soil Name="Soil 0" BeddingAngle="18" DiameterD70="19" PermeabKx="21" WhitesConstant="22" DiameterD90="20" AbovePhreaticLevel="7" BelowPhreaticLevel="8" DryUnitWeight="9" ShearStrengthModel="SuCalculated" UseDefaultShearStrengthModel="false" Cohesion="23" FrictionAngle="24" Ocr="25" SlopeRestProfile="26" DilatancyType="MinusPhi" SoilType="0" /> + <Soil Name="Soil 1" BeddingAngle="18.1" DiameterD70="19.1" PermeabKx="21.1" WhitesConstant="22.1" DiameterD90="20.1" AbovePhreaticLevel="7.1" BelowPhreaticLevel="8.1" DryUnitWeight="9.1" ShearStrengthModel="SuCalculated" UseDefaultShearStrengthModel="false" Cohesion="23.1" FrictionAngle="24.1" Ocr="25.1" SlopeRestProfile="26.1" DilatancyType="MinusPhi" SoilType="1" /> + <Soil Name="Soil 2" BeddingAngle="18.2" DiameterD70="19.2" PermeabKx="21.2" WhitesConstant="22.2" DiameterD90="20.2" AbovePhreaticLevel="7.2" BelowPhreaticLevel="8.2" DryUnitWeight="9.2" ShearStrengthModel="SuCalculated" UseDefaultShearStrengthModel="false" Cohesion="23.2" FrictionAngle="24.2" Ocr="25.2" SlopeRestProfile="26.2" DilatancyType="MinusPhi" SoilType="2" /> + </Soils> + <Segments> + <Segment Name="Segment 0"> + <SoilGeometryProbability SoilProfileName="Profile2D 1" SoilProfileType="2" SegmentFailureMechanismType="1" Probability="0.003" /> + </Segment> + <Segment Name="Segment 1"> + <SoilGeometryProbability SoilProfileName="Profile1D 2" SoilProfileType="0" SegmentFailureMechanismType="2" Probability="0.006" /> + </Segment> + </Segments> + <SoilProfiles1D> + <SoilProfile1D Name="Profile1D 1" BottomLevel="-21.12"> + <Layers1D> + <Layer1D Name="Layer1" SoilName="Soil 0" TopLevel="0" IsAquifer="false" WaterpressureInterpolationModel="0" /> + <Layer1D Name="Layer2" SoilName="Soil 1" TopLevel="-1" IsAquifer="false" WaterpressureInterpolationModel="0" /> + <Layer1D Name="Layer3" SoilName="Soil 2" TopLevel="-2" IsAquifer="true" WaterpressureInterpolationModel="1" /> + </Layers1D> + </SoilProfile1D> + <SoilProfile1D Name="Profile1D 2" BottomLevel="-42.24"> + <Layers1D> + <Layer1D Name="Layer1" SoilName="Soil 0" TopLevel="0" IsAquifer="false" WaterpressureInterpolationModel="0" /> + <Layer1D Name="Layer2" SoilName="Soil 1" TopLevel="-1" IsAquifer="false" WaterpressureInterpolationModel="0" /> + <Layer1D Name="Layer3" SoilName="Soil 2" TopLevel="-2" IsAquifer="true" WaterpressureInterpolationModel="1" /> + </Layers1D> + </SoilProfile1D> + </SoilProfiles1D> + <SoilProfiles2D /> + <StabilityParameters SearchMethod="0" GridDetermination="1" BishopTangentLinesDefinition="1" BishopTangentLinesDistance="0.25" BishopGridVerticalPointsCount="5" BishopGridVerticalPointsDistance="1.1" BishopGridHorizontalPointsCount="4" BishopGridHorizontalPointsDistance="1.2" UpliftVanGridLeftVerticalPointsCount="3" UpliftVanGridLeftVerticalPointsDistance="1.3" UpliftVanGridLeftHorizontalPointsCount="6" UpliftVanGridLeftHorizontalPointsDistance="0.7" UpliftVanGridRightVerticalPointsCount="11" UpliftVanGridRightVerticalPointsDistance="0.14" UpliftVanGridRightHorizontalPointsCount="8" UpliftVanGridRightHorizontalPointsDistance="1.76" UpliftVanTangentLinesDefinition="0" UpliftVanTangentLinesDistance="0.01" /> + <AquiferSoils> + <AquiferSoil Soilname="Soil 0" IsAquifer="true" /> + <AquiferSoil Soilname="Soil 1" IsAquifer="false" /> + <AquiferSoil Soilname="Soil 2" IsAquifer="true" /> + </AquiferSoils> + <OperationalInputTimeSeries> + <TimeSerie ForecastDateTime="2019-04-08T12:14:59.0632236+02:00" Type="instantaneous" LocationId="location0" ParameterId="WaterLevel" StartDateTime="2012-12-31T00:00:00" EndDateTime="2012-12-31T01:00:00" MissVal="-9999" LongName="location0long" StationName="station0" Units="m" SourceOrganisation="organisation0" SourceSystem="system0" FileDescription="filedescription0" Region="region0"> + <TimeStep Divider="0" Multiplier="3600" DividerSpecified="false" MultiplierSpecified="true" TimeStepUnit="0" /> + <Entries> + <TimeSerieEntry DateTime="2012-12-31T01:00:00" Value="0" Flag-nietechtgebruikt="1" BasisFileNameWMF="BasisFileName0" RelativeCalculationPathName="RelativeCalculationPathName0"> + <StochastValue Mean="0" StandardDeviation="0" Distribution="0" /> + </TimeSerieEntry> + <TimeSerieEntry DateTime="2012-12-31T01:10:00" Value="1" Flag-nietechtgebruikt="1" BasisFileNameWMF="BasisFileName0" RelativeCalculationPathName="RelativeCalculationPathName0"> + <StochastValue Mean="1" StandardDeviation="0.1" Distribution="1" /> + </TimeSerieEntry> + <TimeSerieEntry DateTime="2012-12-31T01:20:00" Value="2" Flag-nietechtgebruikt="1" BasisFileNameWMF="BasisFileName0" RelativeCalculationPathName="RelativeCalculationPathName0"> + <StochastValue Mean="2" StandardDeviation="0.2" Distribution="2" /> + </TimeSerieEntry> + </Entries> + </TimeSerie> + <TimeSerie ForecastDateTime="2019-04-08T12:14:59.0652294+02:00" Type="instantaneous" LocationId="location1" ParameterId="WaterPressure" StartDateTime="2012-12-31T00:00:00" EndDateTime="2012-12-31T01:00:00" MissVal="-9999" LongName="location1long" StationName="station1" Units="m" SourceOrganisation="organisation1" SourceSystem="system1" FileDescription="filedescription1" Region="region1"> + <TimeStep Divider="24" Multiplier="0" DividerSpecified="true" MultiplierSpecified="false" TimeStepUnit="3" /> + <Entries> + <TimeSerieEntry DateTime="2012-12-31T01:00:00" Value="0" Flag-nietechtgebruikt="1" BasisFileNameWMF="BasisFileName1" RelativeCalculationPathName="RelativeCalculationPathName1"> + <StochastValue Mean="0" StandardDeviation="0" Distribution="0" /> + </TimeSerieEntry> + <TimeSerieEntry DateTime="2012-12-31T01:10:00" Value="1" Flag-nietechtgebruikt="1" BasisFileNameWMF="BasisFileName1" RelativeCalculationPathName="RelativeCalculationPathName1"> + <StochastValue Mean="1" StandardDeviation="0.1" Distribution="1" /> + </TimeSerieEntry> + <TimeSerieEntry DateTime="2012-12-31T01:20:00" Value="2" Flag-nietechtgebruikt="1" BasisFileNameWMF="BasisFileName1" RelativeCalculationPathName="RelativeCalculationPathName1"> + <StochastValue Mean="2" StandardDeviation="0.2" Distribution="2" /> + </TimeSerieEntry> + </Entries> + </TimeSerie> + </OperationalInputTimeSeries> + <SensorData> + <SensorGroups> + <SensorGroup Id="1"> + <SensorIds SensorId="1" /> + <SensorIds SensorId="2" /> + </SensorGroup> + <SensorGroup Id="2"> + <SensorIds SensorId="3" /> + </SensorGroup> + </SensorGroups> + <Sensors> + <Sensor Id="1" RelativeLocation="12.2" SensorType="1" Name="Sensor 1"> + <PlLineMapping PLineType="1" /> + </Sensor> + <Sensor Id="2" RelativeLocation="24.2" SensorType="2" Name="Sensor 2"> + <PlLineMapping PLineType="1" /> + </Sensor> + <Sensor Id="3" RelativeLocation="8.8" SensorType="0" Name="Sensor 3"> + <PlLineMapping PLineType="3" /> + <PlLineMapping PLineType="4" /> + </Sensor> + </Sensors> + <SensorLocations> + <SensorLocation LocationId="Location 1" SourceTypePl1WaterLevelAtRiver="2" SourceTypePl1PlLineOffsetBelowDikeTopAtRiver="1" SourceTypePl1PlLineOffsetBelowDikeTopAtPolder="1" SourceTypePl1PlLineOffsetBelowShoulderBaseInside="1" SourceTypePl1PlLineOffsetBelowDikeToeAtPolder="1" SourceTypePl1WaterLevelAtPolder="2" SourceTypePl3="2" SourceTypePl4="2" GroupId="1" /> + <SensorLocation LocationId="Location 3" SourceTypePl1WaterLevelAtRiver="2" SourceTypePl1PlLineOffsetBelowDikeTopAtRiver="1" SourceTypePl1PlLineOffsetBelowDikeTopAtPolder="1" SourceTypePl1PlLineOffsetBelowShoulderBaseInside="1" SourceTypePl1PlLineOffsetBelowDikeToeAtPolder="1" SourceTypePl1WaterLevelAtPolder="2" SourceTypePl3="2" SourceTypePl4="2" GroupId="1" /> + </SensorLocations> + </SensorData> +</Input> \ No newline at end of file Index: DamClients/DamUI/trunk/release/Install_Version/dauth.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.Standard.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/LumenWorks.Framework.IO.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/DGSMStabDAM.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/DotSpatial.Plugins.BruTileLayer.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.Dam.BenchmarkTests.pdb =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/DotSpatial.Projections.Forms.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/DevExpress.Office.v12.2.Core.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.Standard.Forms.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/DotSpatial.Serialization.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.Dam.Data.pdb =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.Dam.Version.pdb =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/zh-CN/DotSpatial.Projections.Forms.resources.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.Maps.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.Dam.Data.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/NetTopologySuite.IO.PostGis.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/TmpImportFiles/segments.csv =================================================================== diff -u --- DamClients/DamUI/trunk/release/Install_Version/TmpImportFiles/segments.csv (revision 0) +++ DamClients/DamUI/trunk/release/Install_Version/TmpImportFiles/segments.csv (revision 2315) @@ -0,0 +1,3 @@ +segment_id;soilgeometry2D_name;soilprofile_id;probability;calculation_type +1;GeomA;80;Stability +1;GeomB;20;Stability Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.DamPiping.BlighCalculator.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/BruTile.Desktop.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/LumenWorks.Framework.IO.pdb =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.Dam.Forms.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.DamEngine.Calculators.pdb =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/nl-NL/Deltares.DamPiping.Sellmeijer4ForcesCalculator.resources.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.Dam.Application.exe.config =================================================================== diff -u --- DamClients/DamUI/trunk/release/Install_Version/Deltares.Dam.Application.exe.config (revision 0) +++ DamClients/DamUI/trunk/release/Install_Version/Deltares.Dam.Application.exe.config (revision 2315) @@ -0,0 +1,100 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- +Copyright (C) Stichting Deltares 2019. All rights reserved. + +This file is part of the DAM - UI. + +The DAM - UI is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see <http://www.gnu.org/licenses/>. + +All names, logos, and references to "Deltares" are registered trademarks of +Stichting Deltares and remain full property of Stichting Deltares at all times. +All rights reserved. +--> +<configuration> +<startup><supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.5" /></startup> + <runtime> + <assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1"> + <dependentAssembly> + <assemblyIdentity name="System.Data.SQLite" publicKeyToken="db937bc2d44ff139" culture="neutral" /> + <bindingRedirect oldVersion="0.0.0.0-1.0.94.0" newVersion="1.0.94.0" /> + </dependentAssembly> + <dependentAssembly> + <assemblyIdentity name="DotSpatial.Symbology" publicKeyToken="6178c08da7998387" culture="neutral" /> + <bindingRedirect oldVersion="0.0.0.0-1.6.0.0" newVersion="1.6.0.0" /> + </dependentAssembly> + <dependentAssembly> + <assemblyIdentity name="DotSpatial.Controls" publicKeyToken="4d9e49339a7d240c" culture="neutral" /> + <bindingRedirect oldVersion="0.0.0.0-1.6.0.0" newVersion="1.6.0.0" /> + </dependentAssembly> + <dependentAssembly> + <assemblyIdentity name="DotSpatial.Data" publicKeyToken="c29dbf30e059ca9d" culture="neutral" /> + <bindingRedirect oldVersion="0.0.0.0-1.6.0.0" newVersion="1.6.0.0" /> + </dependentAssembly> + <dependentAssembly> + <assemblyIdentity name="DotSpatial.Projections" publicKeyToken="272632bddd08a38b" culture="neutral" /> + <bindingRedirect oldVersion="0.0.0.0-1.6.0.0" newVersion="1.6.0.0" /> + </dependentAssembly> + <dependentAssembly> + <assemblyIdentity name="DotSpatial.Topology" publicKeyToken="a66b5e9434ca3671" culture="neutral" /> + <bindingRedirect oldVersion="0.0.0.0-1.6.0.0" newVersion="1.6.0.0" /> + </dependentAssembly> + <dependentAssembly> + <assemblyIdentity name="DotSpatial.Serialization" publicKeyToken="441f200f827611e7" culture="neutral" /> + <bindingRedirect oldVersion="0.0.0.0-1.6.0.0" newVersion="1.6.0.0" /> + </dependentAssembly> + <dependentAssembly> + <assemblyIdentity name="DotSpatial.Data.Forms" publicKeyToken="53ab5a198378d4c1" culture="neutral" /> + <bindingRedirect oldVersion="0.0.0.0-0.11.9.6" newVersion="0.11.9.6" /> + </dependentAssembly> + <dependentAssembly> + <assemblyIdentity name="Microsoft.Practices.ServiceLocation" publicKeyToken="31bf3856ad364e35" culture="neutral" /> + <bindingRedirect oldVersion="0.0.0.0-1.2.0.0" newVersion="1.2.0.0" /> + </dependentAssembly> + <dependentAssembly> + <assemblyIdentity name="Deltares.Mathematics" publicKeyToken="582f89ef4e0ea16b" culture="neutral" /> + <bindingRedirect oldVersion="0.0.0.0-18.1.0.1995" newVersion="18.1.0.1995" /> + </dependentAssembly> + <dependentAssembly> + <assemblyIdentity name="Deltares.Geometry" publicKeyToken="a2df6371dee9e0f4" culture="neutral" /> + <bindingRedirect oldVersion="0.0.0.0-18.1.0.2005" newVersion="18.1.0.2005" /> + </dependentAssembly> + <dependentAssembly> + <assemblyIdentity name="Deltares.Standard" publicKeyToken="31fe100197c68040" culture="neutral" /> + <bindingRedirect oldVersion="0.0.0.0-18.1.0.1995" newVersion="18.1.0.1995" /> + </dependentAssembly> + <dependentAssembly> + <assemblyIdentity name="Deltares.Geotechnics" publicKeyToken="704b73ead55eb267" culture="neutral" /> + <bindingRedirect oldVersion="0.0.0.0-18.1.0.2005" newVersion="18.1.0.2005" /> + </dependentAssembly> + <dependentAssembly> + <assemblyIdentity name="Deltares.Geographic" publicKeyToken="d4f3dcd34f9b7bc2" culture="neutral" /> + <bindingRedirect oldVersion="0.0.0.0-18.1.0.2001" newVersion="18.1.0.2001" /> + </dependentAssembly> + <dependentAssembly> + <assemblyIdentity name="Deltares.Probabilistic" publicKeyToken="1ad0f6a98dfa90ad" culture="neutral" /> + <bindingRedirect oldVersion="0.0.0.0-18.1.0.1999" newVersion="18.1.0.1999" /> + </dependentAssembly> + </assemblyBinding> + </runtime> + <appSettings> + <add key="BruTileFileCacheFormat" value="png" /> + <add key="BruTileFileCacheExpire" value="30" /> + <add key="BruTilePermaCacheType" value="FileCache" /> + </appSettings> + <system.net> + <!-- do not remove this unless auto-detection of internet proxy is required --> + <defaultProxy enabled="false" useDefaultCredentials="false" /> + </system.net> + +</configuration> Index: DamClients/DamUI/trunk/release/Install_Version/DotSpatial.Controls.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.Maps.Tests.pdb =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.Dam.IntegrationTests.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/Deltares.DamClientsLibrary.Version.pdb =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/it-IT/DotSpatial.Symbology.Forms.resources.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/cs/DotSpatial.Symbology.Forms.resources.dll =================================================================== diff -u Binary files differ Index: DamClients/DamUI/trunk/release/Install_Version/DevExpress.XtraEditors.v12.2.dll =================================================================== diff -u Binary files differ