diff --git a/BaseModule/bin/Debug/Arction.Wpf.Charting.LightningChart.xml b/BaseModule/bin/Debug/Arction.Wpf.Charting.LightningChart.xml deleted file mode 100644 index 0857f89..0000000 --- a/BaseModule/bin/Debug/Arction.Wpf.Charting.LightningChart.xml +++ /dev/null @@ -1,44835 +0,0 @@ - - - - Arction.Wpf.Charting.LightningChart - - - - - Chart type. - - - - - XY chart, 3D. - - - - - 3D chart. - - - - - Polar chart, 2D. - - - - - Smith chart, 2D. - - - - - Pie chart, 3D. - - - - - Represents a class that provides arguments for the AfterRendering event. - - - - - Creates and initializes a new instance of AfterRenderingEventArgs class. - - - - - The chart that was just rendered. - - - - - General alignment. - - - - - Near. - - - - - Center. - - - - - Far. - - - - - Horizontal alignment. - - - - - Align left. - - - - - Align center. - - - - - Align right. - - - - - XY LegendBox alignment between segments. - - - - - Draw LegendBox near the related segment. - - - - - Draw LegendBox at the center of gap between segments. - - - - - LegendBox alignment when rendered vertically on top of each other. - - - - - LegendBox align by left edge. - - - - - LegendBox aligned at center. - - - - - LegendBox align by right edge. - - - - - 3D Pie title alignment. - - - - - Center. - - - - - Outside. - - - - - Vertical alignment. - - - - - Align top. - - - - - Align center. - - - - - Align bottom. - - - - - Angular units. - - - - - In degrees, circle is divided int 360 units. - - - - - In radian, circle is divided into 2xPI units. - - - - - In gradian, circle is divided into 400 units. - - - - - Annotation3D sizing type. - - - - - Automatic size by text content. - - - - - Manual size in screen coordinates. - - - - - AnnotationPolar sizing type. - - - - - Automatic size by text content. - - - - - Manual size in screen coordinates. - - - - - Annotation style. - - - - - Rectangle. - - - - - Rectangle with arrow. - - - - - Rounded rectangle. - - - - - Rounded rectangle with arrow. - - - - - Arrow. - - - - - Call-out, rectangle. - - - - - Call-out, rounded rectangle. - - - - - Ellipse. - - - - - Ellipse with arrow. - - - - - Triangle. - - - - - Triangle with arrow. - - - - - Annotation target coordinate system. - - - - - Use screen coordinates. - - - - - Use axis values - - - - - AnnotationXY sizing type. - - - - - Automatic size by text content. - - - - - Manual size in screen coordinates. - - - - - Manual size from axis boundaries values. - - - - - Area series point. - - - - - Constructor. - - X value. - Y value. - - - - Constructor. - - X value. - Y value. - Tag. Freely assignable object. - - - - Constructor. - - X value. - Y value. - Tag. Freely assignable object. - Color of the point. For more information see Color property. - - - - Constructor. - - X value. - Y value. - Color of the point. For more information see Color property. - - - - Point Color. - - - - - Tag. Freely assignable object. - - - - - Convert class description to string. - - Class description as a string. - - - - X value. - - - - - Y value. - - - - - Array process info for a thread. - - - - - Count to process within the array - - - - - Start array index - - - - - Arrow style. - - - - - No arrow. - - - - - Square. - - - - - Arrow. - - - - - Circle. - - - - - Caliper. - - - - - 3D axis binding. - - - - - Bind to primary axis. - - - - - Bind to secondary axis. - - - - - 3D axis alignment. - - - - - The axis is inside the 3D chart area. - - - - - The axis is outside the 3D chart area. - - - - - The axis is half inside and half outside the 3D chart area. - - - - - Amplitude axis placement angle. used in polar. - - - - - Calculate's axis angle with respect to calculated angle origin. - - - - - Calculate's axis angle with respect to mathematical angle origin. - - - - - Axis binding. - - - - - Bound to X-axis. - - - - - Bound to Y-axis. - - - - - XY axis dimension. - - - - - X-axis. - - - - - Y-axis. - - - - - 3D axis dimension. - - - - - X-axis. - - - - - Y-axis. - - - - - Z-axis. - - - - - Axis range gap rendering style. - - - - - Empty space. - - - - - Use Fill. - - - - - Draw diagonal line down: \ - - - - - Draw diagonal line up: / - - - - - 3D axis title alignment. - - - - - The axis title is inside the 3D chart area, centered. - - - - - The axis title is inside the 3D chart area, in the beginning of axis. - - - - - The axis title is inside the 3D chart area, in the end of axis. - - - - - The axis title is outside the 3D chart area, centered. - - - - - The axis title is outside the 3D chart area, in the beginning of axis. - - - - - The axis title is outside the 3D chart area, in the end of axis. - - - - - Axis value type. - - - - - Number values. - - - - - Time values. - - - - - DateTime values. - - - - - Map coordinates, degrees. - - - - - Map coordinates, degrees, with N, E, S, W indication. - Example: 40.446195N 79.948862W - - - - - Map coordinates, degrees, arc minutes and seconds, with N, E, S, W indication. - Example: 40°2'13"N 9°58'2"W - - - - - Map coordinates, degrees, arc minutes and seconds, with N, E, S, W indication. - The minute and second values are padded with zeros, if they are < 10. - Example: 40°02'13"N 9°58'02"W - - - - - Wheel action on axis. - - - - - No action. - - - - - Zoom active axis. - - - - - Pan active axis. - - - - - Zoom all axis, if zooming on single axis. - - - - - Pan all axis, if panning on single axis. - - - - - 3D X-axis location. - - - - - Axis is shown in bottom front. - - - - - Axis is shown in bottom back. - - - - - Axis is shown in top front. - - - - - Axis is shown in top back. - - - - - 3D Y-axis location. - - - - - Axis is shown in front left. - - - - - Axis is shown in front right. - - - - - Axis is shown in back left. - - - - - Axis is shown in back right. - - - - - 3D Z-axis location. - - - - - Axis is shown in bottom left. - - - - - Axis is shown in bottom right. - - - - - Axis is shown in top left. - - - - - Axis is shown in top right. - - - - - Bar draw item type for 3D bar draw data. - - - - - Draw item is title. - - - - - Draw item is value text. - - - - - Draw item is bar. - - - - - Bar series value. - - - - - Constructor. - - Location on axis. - Value. - Text. - - - - Constructor. - - Location on axis. - Value. - Text. - Tag. Freely assignable object. - - - - Location on axis. - - - - - Tag. Freely assignable object. - - - - - Text assigned to bar value. - - - - - Convert class description to string. - - Class description as a string. - - - - Value. - - - - - Bar series value for 3D bars. - - - - - Constructor. - - - - - Constructor. - - X value. - Y value. - Z value. - Text assigned to bar value. - - - - Constructor - - X value. - Y value. - Z value. - Text assigned to bar value. - Tag. Freely assignable object. - - - - Tag. Freely assignable object. - - - - - Text assigned to bar value. - - - - - Convert class description to string. - - Class description as a string. - - - - X value. - - - - - Y value. - - - - - Z value. - - - - - Bars grouping. - - - - - Bars are drawn grouped by their indices - - - - - Bars are drawn grouped by their indices. Fit bar widths. - - - - - Bars are drawn grouped by their X values (when Orientation is Vertical). - - - - - Bar shape 3D. - - - - - Box. - - - - - Cylinder. - - - - - Rounded cylinder. - - - - - Cone. - - - - - Cone reversed. - - - - - Pyramid. - - - - - Pyramid reversed. - - - - - Ellipsoid. - - - - - Beveled. - - - - - Bars orientation. - - - - - Horizontal. - - - - - Vertical. - - - - - Bars stacking. - - - - - Bars are shown side-by-side. - - - - - Bars are stacked. - - - - - Bars are stacked and stretched to produce certain sum. - For example, put StackSum to 100 and set y-axis units to % - to illustrate how big portion each series value represents - compared to values of all series. - - - - - Bar labels horizontal alignment. - - - - - Align to left edge of the bar. - - - - - Align to center of the bar. - - - - - Align to right edge of the bar. - - - - - Bar labels vertical alignment. - - - - - Align to bar top. - - - - - Align to bar center. - - - - - Align to bottom of the bar. - - - - - Align to stack segment top (if multiple Y-axis segments are used, or graph top if not). - - - - - Align to stack segment bottom (if multiple Y-axis segments are used, or graph bottom if not). - - - - - Bars view grouping for 3D. - - - - - Bars are stacked on index. - - - - - Bars stacked on X value. - - - - - Bars are stacked by X values and stretched to produce certain sum. - For example, put StackSum to 100 and set y-axis units to % - to illustrate how big portion each series value represents - compared to values of all series. - - - - - Bars are shown next to each other for same index value and fitted to view. - - - - - Grouped by index. - - - - - Grouped by X value. - - - - - Bars are shown in near-far view, first series in list nearest and last farthest. Bar X values control the position in X dimension. - Series title is shown at the start or end edge of series. - - - - - Represents a class that provides arguments for the BeforeRendering event. - - - - - Creates and initializes a new instance of BeforeRenderingEventArgs class. - - - - - The chart that was just rendered. - - - - - The height of the chart. - - - - - The width of the chart. - - - - - Bitmap anti-aliasing options. - - - - - Constructor for Form designer list editor. - - - - - Put ActualPixelWeigth to higher value to make the actual pixel - effect more (not much blurred). Use 1 to get high blur effect. - - - - - Use BlurRadius >= 1. With 1, blur takes current pixel and one pixel from all directions. - - - - - Use ResolutionDivider to divide the output bitmap size. If you want every other and column - to be in the output bitmap, put 2. - - - - - Convert class description to string. - - Class description as a string. - - - - Bitmap fill. - - - - - Constructor for Form designer list editor. - - - - - Constructor. - - - - - param - owner - M:Arction.Wpf.Charting.BitmapFill.#ctor(Arction.Wpf.Charting.IChartNode) - - - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Gets and sets image. - - - - - Gets and sets image alpha. 0 is transparent, 255 fully visible. - - - - - Gets and sets image tint color. - - - - - Gets and sets fill layout. - - - - - OnDeserialized is called just after the object has been deserialized. - - Context - - - - Convert class description to string. - - String - - - - Bitmap fill layout. - - - - - Center the image. - - - - - Stretch to fit width and height. - - - - - Tile images. - - - - - Fit image to fill area and keep original image aspect ratio. - - - - - Bitmap smoothing options - - - - - No smoothing. - - - - - Point smoothing. - - - - - Linear smoothing. - - - - - Anisotropic smoothing. - - - - - PyramidalQuad smoothing. - - - - - GaussianQuad smoothing. - - - - - Border class. - - - - - Simple constructor for Form designer's list editor. - - - - - Constructor. - - Parent. - - - - Primary color. - - - - - Secondary color. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Border style. - - - - - Convert class description to string - - String - - - - Border width. - - - - - Border types. - - - - - No border. - - - - - Border is inside the object. - - - - - Border is outside the object. - - - - - Polar boundaries. Angle minimum...angle maximum and radius minimum... radius maximum. - - - - - Simple constructor for Form designer's list editor. - - - - - Constructor - - Parent. - Angle minimum - Angle maximum - Radius minimum - Radius maximum - - - - Constructor - - Angle minimum - Angle maximum - Radius minimum - Radius maximum - - - - Angle maximum value - - - - - Angle minimum value - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Radius maximum value - - - - - Radius minimum value - - - - - Set all values. - - Angle min value - Radius min value - Angle max value - Radius max value - - - - Convert class description to string - - String - - - - XY boundaries. X minimum...X maximum and Y minimum... Y maximum. - - - - - Constructor for Form designer list editor - - - - - Constructor - - Parent. - X minimum - X maximum - Y minimum - Y maximum - - - - Constructor - - X minimum - X maximum - Y minimum - Y maximum - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Set all values. - - X minimum value - X maximum value - Y minimum value - Y maximum value - - - - Convert class description to string - - String - - - - X maximum value - - - - - X minimum value - - - - - Y maximum value - - - - - Y minimum value - - - - - User interactive object button state. - - - - - Constructor. - - - - - param - button - M:Arction.Wpf.Charting.ButtonState.#ctor(Arction.Wpf.Charting.UserInteractiveDeviceButton,Arction.Wpf.Charting.UserInteractiveDeviceButtonState) - - - - - - - param - state - M:Arction.Wpf.Charting.ButtonState.#ctor(Arction.Wpf.Charting.UserInteractiveDeviceButton,Arction.Wpf.Charting.UserInteractiveDeviceButtonState) - - - - - - - Button. - - - - - State. - - - - - Return ButtonState as string. - - - - - returns - M:Arction.Wpf.Charting.ButtonState.ToString - - - - - - - Represents a class that provides arguments for the Capture event. - - - - - Creates and initializes a new instance of Capture class. - - - - - param - success - M:Arction.Wpf.Charting.CaptureEventArgs.#ctor(System.Boolean,System.String,System.String) - - - - - - - param - fileName - M:Arction.Wpf.Charting.CaptureEventArgs.#ctor(System.Boolean,System.String,System.String) - - - - - - - param - failureReason - M:Arction.Wpf.Charting.CaptureEventArgs.#ctor(System.Boolean,System.String,System.String) - - - - - - - The chart that was just rendered. - - - - - Failure reason, if any. - - - - - File name of capture. Null for clipboard. - - - - - Success status of capture. - - - - - Clipping at the center of the graph. - - - - - No clipping, data values can move over the center to the opposite side of the chart. - - - - - Data values are clipped if their amplitude value passes the center of the chart. - - - - - Data values are clipped at the edge of the InnerCircle, which is at the innermost Amplitude value of the corresponding axis. This value is either the minimum or the maximum AmplitudeAxis value depending on the axis being reversed. - - - - - Represents a class that provides arguments for a chart event. - - - - - Creates and initializes a new instance of ChartEventArgs class. - - - - - Chart event marker vertical position. - - - - - Top. - - - - - Graph top. - - - - - Graph center. - - - - - Graph bottom. - - - - - Bottom. - - - - - Chart exception class. - - - - - ExceptionInfo contains information about the exception as structs - - - - - Information about LightningChart used when throwing errors. - - - - - - - summary - P:Arction.Wpf.Charting.ChartInfo.ActiveView - - - - - - - Number of charts currently alive. - - - - - Gets chart object's screen heigth. - The value is in pixels for WinForms applications and in DIPs for WPF applications. - - - - Gets chart's position on the screen (in pixels) - - - - - Gets chart object's screen width. - The value is in pixels for WinForms applications and in DIPs for WPF applications. - - - - Number of total created charts. - - - - - Is a deployment key set. - - - - - Is a deployment key set (at least once). - - - - - Number of disposed charts. - - - - - List of engine init results. - - - - - Collect information about chart. - - The chart where the data is to be collected from - - - - ID of chart. - - - - - Is the application DPI aware. - - - - - Checks if pixel alignment information is correct - - - - - Checks if pixel alignment system is on - - - - - Has a ChartMessage event been registered and handled correctly. - - - - - Chart license status. - - - - - License nag text. - - - - - Returns pixel currently used pixel alignment offset - - - - - Checks if pixel alignment is on - - - - - Render device information. - - - - - Charts update type. - - - - - Is throwing of chart errors enabled in chart settings. - - - - - Returns struct values as a string. - - Struct values as a string. - - - - Number of charts which were not correctly disposed. - - - - - LightningChart version number. - - - - - ChartMessageInfo is passed on ChartMessage and it contains information about the error event. - Also used as a part of ExceptionInfo. - - - - - LightningChart object where the message happened. - - - - - Description of the message. - - - - - Details of the message. - - - - - Source exception of the message. - - - - - Severity level of the message. - - - - - Type of the message. - - - - - Message source object. - - - - - Stack trace from a possible exception. - - - - - Date and time when the message occurred. - - - - - Returns struct values as a string. - - Struct values as a string. - - - - Chart base node. - - - - - Constructor - - - - - Constructor. - - Owner of node - - - - Checks if the given object is null or disposed, and complains if it's not and returns true. - Idea of this is to do sanity checks on methods, allowing testing of object references required in the method.Disposed check is done only on ChartNodes - Call this with required refs, and if the return value is false, exit the method or do something, but skip the usage and - try to get out of the situation gracefully. - - Notifies the user through . - Null objects cause message and disposed objects cause type message. - - Severity is always . - - Item of which validity is to be checked. - True if there was some problem with the reference. - - - - Checks if any of the given objects are null or disposed, and complains to user if they are, and returns true. - Idea of this is to do sanity checks on methods, allowing testing of object references required in the method.This works identically to , but accepts multiple objects. Disposed check is done only on ChartNodes - Call this with required refs, and if the return value is false, exit the method or do something, but skip the usage and - try to get out of the situation gracefully. - - Notifies the user through . - Null objects cause message and disposed objects cause type message. - - Severity is always . - - Item of which validity is to be checked. - True if there was some problem with any of the references. - - - - MSDN: Makes the instance a clone (deep copy) of the specified Freezable using base (non-animated) property values. - - Source object. - - - - MSDN: Makes the instance a modifiable clone (deep copy) of the specified Freezable using current property values. - - Source object. - - - - Clone private members. - - Source object - - - - Create instance. - - Instance as Freezable - - - - Release all resources used by this instance. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - MSDN: Makes the instance a frozen clone of the specified Freezable using base (non-animated) property values. - - Source object. - - - - MSDN: Makes the current instance a frozen clone of the specified Freezable. If the object has animated dependency properties, their current animated values are copied. - - Source object. - - - - IsDisposed by owner or not - - - - - Generic options controlling LightningChart behavior. - - - - - Chart Options - - - - - Chart Options - - - - - param - owner - M:Arction.Wpf.Charting.ChartOptions.#ctor(Arction.Wpf.Charting.IChartNode) - - - - - - - Boolean to check if automatic LightningChart resizing / repositioning is allowed when - application window DPI changes. - Default value is false. - - - - - Allow internal cursor change. - - - - - Allow user interaction with interaction device (e.g. mouse). Interaction device hit testing with objects - cause CPU overhead when the device is moved. - If user device interaction is not absolute necessary directly within chart - and if you want to maximize the performance, set this false. - - - - - Allows setting a minimum ChartMessage MessageSeverity level. - Messages with a MessageSeverity below the minimum level will not be sent to the user. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Defines if the events raised during rendering should be emitted only at the end of the drawing (frame) - or when the changes occur. - - - - - Controls showing debugging information on chart. - This is intended only for debugging and special situations. - - - - - Selects when to show hints about the use of some critical properties. - - - - - When set to true, throws a on all events - with a level above . - - - - - Convert class description to string - - String - - - - Defines if the chart reacts to wheel events without focus. - This is useful especially on situations when chart is in scrollable control and - it's not wished that the chart processes the wheel events. - - - - - Chart title align. - - - - - Align top-left. - - - - - Align to top-left margin. - - - - - Align top center. - - - - - Align to right margin. - - - - - Align top-right. - - - - - Align left center. - - - - - Align right center. - - - - - Align bottom-left. - - - - - Align to bottom-left margin. - - - - - Align bottom center. - - - - - Align to bottom-right margin. - - - - - Align bottom-right. - - - - - Chart tools provides versatile static methods. - - - - - - - Arction.Wpf.Charting.ChartTools - - - - - - - Adjusts bitmap alpha to given level for every pixel. Doesn't modify the input bitmap. - - Input bitmap. - Alpha. - Bitmap with selected alpha. - - - - Anti-alias bitmap. Makes anti-aliasing for image, or blur-effect. - - Source bitmap to be anti-aliased. - Anti-aliasing options. - Creates the correct size output bitmap and returns it. If invalid parameters are given, returns null. - - - - Covert BitmapFrame to 32 BGRA. - - Input BitmapFrame. - 32BGRA BitmapFrame. - - - - Get a segment (sub-region) of a bitmap. - - Source bitmap. - Index of first column to appear in output bitmap. - Segment width in pixels. - Index of first row to appear in output bitmap. - Segment height in pixels. - Bitmap segment an a new bitmap. - - - - Calculates the gradient color between two colors. - - From-color. - To-color. - Gradient color position in percents (0...100%). - Gradient color. - - - - Get polygon area. - - Polygon route points. - Area of polygon. - - - - Calculate center of gravity (centroid) of a homogenous polygon. - - Polygon route points. - Center of gravity point. - - - - Calculate map coordinate spherical angles, phi and theta. - - Coordinate. - Sphere radius. - Phi angle in degrees. - Theta angle in degrees. - - - - Calculate distance between two coordinates in world map, by using two coordinates. - - First coordinate. - Second coordinate. - Distance in kilometers. - - - - Calculate distance between two coordinates in world map, by using latitude and longitude. - - First coordinate. - Second coordinate. - Distance in kilometers. - - - - Calculate distance between two coordinates in world map, by using latitude and longitude. - - First point longitude. - Second point longitude. - First point latitude. - Second point latitude. - Distance in kilometers. - - - - Calculate distance between two coordinates in world map, by using latitude and longitude. - - First coordinate. - Second coordinate. - Distance in kilometers. - - - - Calculate great circle coords for sphere. - - Begin point. - End point. - Angle step. - - - - returns - M:Arction.Wpf.Charting.ChartTools.CalculateSphereFullGreatCircleCoords(Arction.Wpf.Charting.MapCoordinate,Arction.Wpf.Charting.MapCoordinate,System.Double) - - - - - - - Calculate a spherical route (going shortest way, in sphere surface). This is also known as Great Circle route. - - Route begin coordinate. - Route end coordinate. - Sphere radius. - Angle step. - Route waypoints. - - - - Captures a Control area to a bitmap, very fast. - Great for making - - Chart - - Any other Control - - Form - capture into set of images. - - Control to capture. - Bitmap. - - - - hue = angle of color circle where 0 deg = red, 120 deg = green, 240 deg = blue. - saturation: defines the brilliance and intensity of a color. default = 1,range = 0-1 - value refers to the lightness or darkness of a color. default = 1, range = 0-1 - alfa describes the transparency. default = 1. range = 0-1 - - - - - param - hue - M:Arction.Wpf.Charting.ChartTools.ColorHSVA(System.Double,System.Double,System.Double,System.Double) - - - - - - - param - saturation - M:Arction.Wpf.Charting.ChartTools.ColorHSVA(System.Double,System.Double,System.Double,System.Double) - - - - - - - param - value - M:Arction.Wpf.Charting.ChartTools.ColorHSVA(System.Double,System.Double,System.Double,System.Double) - - - - - - - param - alfa - M:Arction.Wpf.Charting.ChartTools.ColorHSVA(System.Double,System.Double,System.Double,System.Double) - - - - - - - returns - M:Arction.Wpf.Charting.ChartTools.ColorHSVA(System.Double,System.Double,System.Double,System.Double) - - - - - - - Drawing color to integer. - - Color. - Drawing color as ARGB value. - - - - Media color to integer. - - Color. - Media color as ARGB value. - - - - Convert 2-dimensional array to 1-dimensional, row by row - - 2D array - Type of item - 1D array - - - - Convert data values to colors, by given palette. Palette is defined by steps, consisting of value and corresponding color. - E.g. 0 : Black, 50: Yellow, 100: Red. - The output colors are interpolated based on their position between steps. E.g. in this example palette, - data value 60 will be almost yellow, but a little bit blending with red. - - Data values. - Values of palette. Count must be equal to step color count. - Colors of palette. Count must be equal to step value count. - Colors as ARGB integer values. - - - - Convert Array of Double to Bitmap. - - Double array. - Width. - Height. - Maximum value. - Minimum value. - Step count. - Alpha array. - Red array. - Green array. - Blue array. - Bitmap frame. - - - - Convert double array into colors, by using gradient fixed-interval palette. - - Jagged array matrix, M x N. - Colors. - Minimum value, which represents the first color. - Maximum value, which represents the last color. - Bitmap. - - - - Convert Hex to Winforms color - - Hex string - Converted color. If unable to convert a color channel (a, r, g, b), returns 0 to that channel. - - - - Converts image format to 32 bits ARGB. - - Source image, which is not in 32bppArgb format. - Image in 32bbArgb format. - - - - Convert DMS (Degrees, minutes, seconds) value to decimal degrees value. - - Degrees. - Arc minutes. - Arc seconds. - Degrees value. - - - - Convert DMS (Degrees, minutes, seconds) value to decimal degrees value, with given post-fix (N,E,S,W). - - Degrees. - Arc minutes. - Arc seconds. - Postfix. - Degrees value. - - - - Convert map coordinate to a point in 3D space. The 3D space has origin in (0,0,0). - - Map coordinate. - Sphere radius. - 3D point. - - - - Converts time ticks to seconds, accurately. - - Ticks value. - Seconds value. - - - - Create a grayscale bitmap of source bitmap's pixels' alpha level. - White output pixel means A = 255, Black means A = 0, and grayscales values between them. - - Source bitmap whose alpha level is to be investigated pixel-by-pixel. - Bitmap having alpha RGB values as grayscale, and alpha 255 in each output pixel. - - - - Convert 3-dimensional array to texture map. - - 3-Dimensional array. - Color array. - Minimal value of the dataset. - Maximal value of the dataset. - Texture Map. - - - - - - summary - M:Arction.Wpf.Charting.ChartTools.CreateMap(System.String) - - - - - - - param - filePath - M:Arction.Wpf.Charting.ChartTools.CreateMap(System.String) - - - - - - - returns - M:Arction.Wpf.Charting.ChartTools.CreateMap(System.String) - - - - - - - Create Texture Map packed for VolumeRendering. - - Images. - Bitmap frame. - - - - Create a jagged array of Intensity series data (IntensityPoint array). - Extracts IntensityPoint.Value fields. - - Data. - Values array. - - - - Gathers various information for debugging purposes as a string and optionally saves the output to a text file. - Gathered data (if is set to All): system information, LightningChart object information, - list of running processes, DxDiag output, installed Windows hotfixes. - - Data gathering options flags. See . - LightningChart object (optional, leave null if not running with a LightningChart instance). - Path to folder where file is saved (optional, if not specified the data won't be saved to a file and just returned as a string). - Output text file filename (optional, if not specified the default name is created with timestamp). - The gathered data as a string. - - - - Get all controls and its subcontrols - - Control whose controls are to investigated - Give true if control's subcontrols are seeked too (recursive) - List of contorls - - - - Get pixel color of a bitmap. This is much faster method than calling GetPixel() separately for each pixel of a bitmap. - - Bitmap. - Pixel colors as an array. - - - - Gets pixels of System.Drawing.Bitmap object in System.Windows.Media.Color two-dimensional array. - - System.Drawing.Bitmap object. - Two-dimensional System.Windows.Media.Color array. - - - - Create image from assembly embedded resource. Includes assembly name in the beginning of resource name. - - Resource name, without assembly identifier. - E.g. "Resources.ArctionLogo.png", not like "Arction.DemoApp.Resources.ArctionLogo.png" - Assembly where the resource is located - Image if success, else null - - - - Create image from assembly embbedded resource - - Fully qualified resource name. - Assembly where the resource is located. - Image if success, otherwise null. - - - - Create image from assembly embbedded resource. Includes assembly name in the beginning of resource name. - - Resource name, without assembly identifier. - E.g. "Resources.ArctionLogo.png", not like "Arction.DemoApp.Resources.ArctionLogo.png" - Assembly where the resource is located - Image if success, else null - - - - Convert intensity values jagged array to intensity grid points. Fills IntensityPoint.Value fields only. - - Values. - Rectangular array of intensity points. - - - - Makes bilinear interpolation for given data array. - - Source data array. - X density multiplier. - Y density multiplier. - Interpolated data array. - - - - Find out if this process needs 64-bit DLLs. - - True if 64-bit DLLs are needed. False if it's happy with 32-bit DLLs. - - - - - - summary - M:Arction.Wpf.Charting.ChartTools.LoadImages(System.String) - - - - - - - param - folderName - M:Arction.Wpf.Charting.ChartTools.LoadImages(System.String) - - - - - - - returns - M:Arction.Wpf.Charting.ChartTools.LoadImages(System.String) - - - - - - - Media color to draw color. - - Color. - Media color as Drawing color. - - - - Rotate 3D coordinate with yaw - pitch - roll method. - - 3D coordinate. - Rotation angle in degrees, about X-axis. - Rotation angle in degrees, about Y-axis. - Rotation angle in degrees, about Z-axis. - Rotated coordinate. - - - - Rounds the value to nearest multiple of Interval. - - Value to round. - Interval. - Nearest interval multiple. - - - - Test if two point equals. - - Point 1. - Point 2. - True is points are at about same locations. - - - - Show list of loaded assemblies by this application. - - - - - Solve point within a line going from Point1 to Point2. - - First point. - Second point. - Distance from Point1 towards Point2. - Solved point. - Returns true if successfully solved (length is not 0). - - - - Solve point within a line going from Point1 to Point2. - - First point - Second point - Position in range 0...1. - Point in position. - - - - Write a string to log file. The log file is c:\temp\LightningChartLog.txt. - - String to write. - - - - Write a string to log file. - - String to write. - File name. - - - - Zoom to data and label area. - - Chart to apply zooming. - - - - Options for calling GatherApplicationInformation. - - - - - None. - - - - - Get information about the system like operating system, RAM etc. - - - - - Get information about LightningChart object. - - - - - Get information about running processes in the system. - - - - - Get infromation from DxDiag. - - - - - Get installed Windows hotfixes in the system. - - - - - Gather everything - - - - - Defines how/when chart is updated and new frames are rendered. - - - - - Chart is updated in sync fashion on property changes. This is the fastest way to get most performance out of the chart and - to minimize latency. - - - - - Chart is updated on async fashion. The chart will update as fast as possible after property changes, but the property changes will return as fast as possible, and - chart will render new frame at some later point. - - - - - Chart will limit the framerate of the updates to value defined by . - This is similar to the Async option, but keeps prevents new frames to be rendered right after another, thus reducing framerate, but sparing - system resources. - - - - - ChildPropertyChanged flags. These flags must be OR'd on each level, so that root level is reported all the flags. - - - - - No flags, just re-renders the chart. - - - - - All series draw data must be freed, so root level can reconstruct it. - - - - - Update chart title - - - - - Disable zooming - - - - - Do auto Y fit now. - - - - - Free all series legendbox icon - - - - - Draw data of certain series must be freed, so root level can reconstruct it. - - - - - Free a series legendbox icon - - - - - All series draw data of certain axis must be freed, so root level can reconstruct it. - - - - - Free certain draw data synchronized to main thread. Use this to make LightningChartPro free draw data from object finalizer - - - - - Free scrollbar draw data - - - - - Free everything - - - - - Free all draw data of 3D series where this 3D axis is bound - - - - - Surface palette sorting must be updated - - - - - Annotation order must be changed in list of annotations. - - - - - Free map draw data. - - - - - Cancel rendering. - - - - - Recalculate autolabel. - - - - - Free annotation bound to this axis. - - - - - Free non-shiftable series draw data. - - - - - Notification to parent that the settings defining the draw data - related to sender and/or relayer has been modified and the drawdata - needs to be recalculated/updated/redefined/freed. - - It's usually OK to remove the flag from the parameter value - after processing on parent. - - - - - Update LegendBox as some related property has changed. - - - - - Clip area. Prevents owner series data from rendering in Begin...End range. - - - - - Constructor. - - Begin value. Start clipping from here. - End value. End clipping here. - Clip direction, X or Y. - - - - Constructor. - - Begin value. Start clipping from here. - End value. End clipping here. - Clip direction, X or Y. - Tag, freely assignable object. - - - - Constructor. - - Begin value. Start clipping from here. - End value. End clipping here. - Clip direction, X or Y. - Margin pixels. Set positive to clip more, negative to clip less. - - - - Constructor. - - Begin value. Start clipping from here. - End value. End clipping here. - Clip direction, X or Y. - Margin pixels. Set positive to clip more, negative to clip less. - Tag, freely assignable object. - - - - Begin value. Start clipping from here. - - - - - Clip direction, X or Y. - - - - - End value. End clipping here. - - - - - Amount of pixels to clip more from positions calculated from Begin and End values. - 0: Don't clip more or less. - Positive: Clip more, the clipped area is this many pixels wider from both left and right (or top and bottom). - Negative: Clip less, the clipped area is this many pixels narrower from both left and right (or top and bottom). - - - - - Tag. Freely assignable object. - - - - - Convert class description to string. - - Class description as a string. - - - - Clipboard image format. - - - - - Windows bitmap, raster format. - - - - - Portable network graphics, raster format. - - - - - JPG, JPEG, raster format. - - - - - Tagged image format file, raster format. - - - - - Graphic interchange format, raster format. - - - - - Enhanced metafile, vector format. - - - - - Clip direction. - - - - - None. Don't clip, disabled. - - - - - Clip in X direction. - - - - - Clip in Y direction. - - - - - Theme colors. - - - - - Dark color theme. - - - - - Light gray color theme. - - - - - Sky blue color theme. - - - - - Light blue dynamic theme. - - - - - Red Magma theme. - - - - - Auroras theme. - - - - - Brushed metal. - - - - - Red carbon theme. - - - - - Paper theme. - - - - - World cyber space - - - - - Custom Dynamic theme. - - - - - Contour Line Label's properties. - Property tree: if enabled; manipulate format, font and color of text. - Default state is disabled; - - - - - Constructor. - - - - - Constructor. - - Owner of this object. - - - - Color - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Contour Label font - - - - - Labels number format' - - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Description of class. - - description - - - - Is text visible or not - - - - - The contour line type for Surface series, 3D. - - - - - No contour line. - - - - - Performance optimized thin vertical zones based on Y-field (height). All lines use same color. - - - - - Performance optimized thin zone at palette step edge based on Y-field (height in the 3D Surface series data point), various colors set by the palette. - - - - - The contour lines is calculated based on Y-field (height in the 3D Surface series data point). Single color. - - - - - The contour lines are calculated based on Y-field (height). Various colors set by the palette. - - - - - The contour lines are calculated based on Value-field (in the 3D Surface series data point). Single color. - - - - - The contour lines are calculated based on Value-field (in the 3D Surface series data point). Various colors set by the palette. - - - - - The contour line type for Intensity/Color map series, 2D. - - - - - No contour line. - - - - - Performance optimized thin vertical zones based on intensityValue (height). All lines use same color. - - - - - Performance optimized thin zone at palette step edge based on intensityValue (height), various colors set by the palette. - - - - - The contour lines are made with actual lines. Single color. - - - - - The contour lines are made with actual lines. Various colors set by the palette. - - - - - Static class for converting WPF to WinForms objects and vice versa - - - - - Convert WPF color to WinForms color - - Color to convert - Color - - - - Converts image from wpf to winforms - - Source image - Image as winforms - - - - Converts image from wpf to winforms - - Source image - Image as winforms - - - - Convert WinForms color to WPF color - - Color to convert - Color - - - - Converts image from winforms to wpf - - Source image - Image as wpf - - - - Coordinate system selector. - - - - - Use screen coordinates - - - - - Use relative screen coordinates to target. - - - - - Use axis values. - - - - - Coordinate system selector for 3DPie. - - - - - Use screen coordinates. - - - - - Use relative screen coordinates to target. - - - - - Degrees, arc minutes, arc seconds representation coordinate postfix. - - - - - North. - - - - - East. - - - - - South. - - - - - West. - - - - - 2D coordinate, double format. Used with UserInteractiveObject. - - - - - Constructor - - X - Y - - - - Constructor - - X - Y - Tag, freely assignable object - - - - Tag. Freely assignable object - - - - - Convert class description to string - - String - - - - X value - - - - - Y value - - - - - 3D coordinate structure. - - - - - Constructor. - - X value. - Y value. - Z value. - - - - X value. - - - - - Y value. - - - - - Z value. - - - - - Culling of 3D triangles. - - - - - No culling, render all triangles regardless of their normal angle to camera. - - - - - Cull clockwise defined triangles. - - - - - Cull counterclockwise defined triangles - - - - - Cursor styles. - - - - - Vertical cursor. No series values tracking. - - - - - Hair cross vertical cursor. Resolves values from series and draws horizontal line at the section of cursor and series. - - - - - Point tracking. Resolves values from series and draws a point with selected style at the section of cursor and series. - - - - - Represents a class that provides arguments for the CustomLinePointColoringAndShaping base event. - - - - - Creates and initializes a new instance of CustomLinePointColoringAndShapingBaseEventArgs class. - - - - - Tells if Colors array can be modified. - - - - - Tells if Coords array can be modified. - - - - - Custom colors. - - - - - Screen coordinates of line points. - - - - - Data point indices of the points that appear in the Coords and Colors arrays. - Subsequent data points hitting the same screen coordinate may have been reduced. - DataPointIndices array will tell indices which were actually used. - - - - - Has data point indices information available. Not applicable to all series types. - - - - - Page index in sweeping X axis (0 or 1), for others, 0. - - - - - Custom Tick And Grid Style. - - - - - Style Tick and Grid. - - - - - Style Tick. - - - - - Style Grid. Labels are not shown with this style. - - - - - Class to get D3DImage working with remote desktop connection. - - - - - Default constructor. - - - - - Get backbuffer. - - Backbuffer. - - - - Data breaking options. - Defines, if gaps are enabled on series data and by which value. - Default state is disabled and default gap value is Double.NaN; - - - - - Constructor. - - - - - Constructor. - - Owner of this object. - - - - Data gap enabled state. - - - - - TO String - - - - - returns - M:Arction.Wpf.Charting.DataBreakingOptions.ToString - - - - - - - Data gap defining value. - - - - - Default colors - - - - - Annotation arrow color - - - - - Annotation border color - - - - - Annotation gradient fill color - - - - - Annotation fill color - - - - - Annotation text color - - - - - Axis grid strips fill - - - - - Axis labels color - - - - - Axis major div tick 3D - - - - - Axis major division tick color - - - - - Axis scale nibs color, 2D - - - - - Axis scale nibs color, 3D - - - - - Axis title shadow color - - - - - Axis title color - - - - - Axis units color - - - - - Background gradient color - - - - - Background color - - - - - Bar series gradient color - - - - - Bar series color - - - - - Blink gradient color 1 - - - - - Blink gradient color 2 - - - - - Data cursor border color. - - - - - Data cursor Fill1 color. - - - - - Data cursor Fill2 color. - - - - - Data cursor Fill3 color. - - - - - Data cursor label Fill1 color. - - - - - Data cursor table background color. - - - - - Data cursor table border color. - - - - - Default color theme. - - - - - Error bars color - - - - - Graph background gradient color - - - - - Graph background color - - - - - Graph border color - - - - - Legend box border color - - - - - Legend box category text color - - - - - Legend box checkbox border color - - - - - Legend box checkbox mark color - - - - - Legend box gradient color - - - - - Legend box shadow color - - - - - Legend box text color - - - - - LegendBox Units Color - - - - - LegendBox value labels color - - - - - Legend box color - - - - - Line series cursor color - - - - - Map item title - - - - - Polar axis units color - - - - - Polar axis color - - - - - Default color for ScrollBar.BackgroundFill.Color property. - - - - - Default color for ScrollBar.BackgroundFill.GradientColor property. - - - - - Default color for ScrollBar.Border.Color1 property. - - - - - Default color for ScrollBar.Border.Color2 property. - - - - - Default color for ScrollBar.ButtonOptions.BorderColor property. - - - - - Default color for ScrollBar.ButtonOptions.Color1 property. - - - - - Default color for ScrollBar.ButtonOptions.Color2 property. - - - - - Default color for ScrollBar.ButtonOptions.Icon.BorderColor property. - - - - - Default color for ScrollBar.ButtonOptions.Icon.Color1 property. - - - - - Default color for ScrollBar.ButtonOptions.Icon.Color2 property. - - - - - Default color for ScrollBar.ScrollThumbOptions.BorderColor property. - - - - - Default color for ScrollBar.ScrollThumbOptions.Color1 property. - - - - - Default color for ScrollBar.ScrollThumbOptions.Color2 property. - - - - - Default series colors against black background - - - - - Default colors - - - - - Gradient when blinking is not used, on mouse over - - - - - Title shadow color - - - - - Title color - - - - - Wall grid strip color 1 - - - - - Wall grid strip color 2 - - - - - Walls color in 3D view - - - - - X axis color - - - - - Y axis color - - - - - Zoom rectangle fill color - - - - - Zoom rectangle border color - - - - - Flags specifying possible rendering engines. - - - - None of the engines. - - - DX9 engine. - - - DX11 engine. - - - - DigitalLineSeries coordinate solver result. - - - - - Bottom Y-coordinate at cursor position. - - - - - Top Y-coordinate at cursor position. - - - - - Minimum data point index. - - - - - Nearest X-coordinate. - - - - - Data point count for column. - - - - - Solve status. Use values only if SolveStatus is OK. - - - - - Convert class description to string. - - Class description as a string. - - - - DigitalLineSeries value solve result. - - - - - Nearest data point index of the searched X value. Note that e.g. in real-time examples this is only valid when there is no data added to series. - - - - - Nearest X value of the searched X value. - - - - - Solve status. Use result values only if SolveStatus is OK. - - - - - Convert class description to string. - - Class description as a string. - - - - Max Y value on the searched X value. - - - - - Min Y value on the searched X value. - - - - - Directions. - - - - - No direction. - - - - - Right. - - - - - Up. - - - - - Left. - - - - - Down. - - - - - Vertical (right). - - - - - Horizontal (down). - - - - - Double click zoom/pan operation. - - Used as value for property, - to define what happens when device primary button is double clicked. - - - - - Disabled. - - - - - Zoom to fit all data and LabelsArea (the graph) to area limited by margins and . - - - - - Static helper class that contains helpers on DPI related issues. - Meaning mainly PX to DIP conversions. - - - - - Converts given DIP (Device Independent Pixels) values to PX (Screen pixels) using system DPI settings. - - Value to convert in DIPs - If true, the screen width direction DPI factor is used. Height direction otherwise - Converted value in PX. - - - - Converts given rectangle size and position defined in DIP (Device Independent Pixels) to PX (Screen pixels) - values using system DPI settings. - - Rectangle to convert / modify, defined in DIPs. - - - - Converts given DIP (Device Independent Pixels) values to PX (Screen pixels) using system DPI settings. - - Value to convert in DIPs - If true, the screen width direction DPI factor is used. Height direction otherwise - Converted value in PX. - - - - Converts given point defined in DIP (Device Independent Pixels) to PX (Screen pixels) - values using system DPI settings. - - Point to convert, defined in DIPs. - Point in PX - - - - Defines if the system process is DPI aware or not. - Currently there is no way distinguishing between system aware and Per-monitor aware. - - - - - Effective Zoom factor of the system DPI of the screen width. - Factor that describes how many real pixels there are per one DIP in X direction. - - - - - Effective Zoom factor of the system DPI of the screen height. - Factor that describes how many real pixels there are per one DIP in Y direction. - - - - - Converts given PX (Screen pixels) to DIP (Device Independent Pixels) values using system DPI settings. - - Value to convert in pixels. - If true, the screen width direction DPI factor is used. Height direction otherwise - Converted value in DPIs. - - - - Converts given rectangle size and position defined in PX (Screen pixels) to DIP (Device Independent Pixels) values using system DPI settings. - - Rectangle to convert / modify, defined in pixels. - - - - Converts given PX (Screen pixels) to DIP (Device Independent Pixels) values using system DPI settings. - - Value to convert in pixels. - If true, the screen width direction DPI factor is used. Height direction otherwise - Converted value in DPIs. - - - - Converts given point defined in PX (Screen pixels) to DIP (Device Independent Pixels) - values using system DPI settings. - - Point to convert, defined in PX. - Point in DIPs - - - - Draggable handler, handles dragging maneuvers of chart object. - - - - - Constructor. - - - - - Constructor. - - Parent. - - - - Gets or sets whether dragging by user is allowed. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Dragged by user. - - - - - Invoke DraggedByUser event. - - - - - returns - M:Arction.Wpf.Charting.DraggableObject.InvokeDraggedEvent - - - - - - - Moving pixel distance after which state is changed to Drag. - - - - - Reset location, if moved by mouse. - - - - - internal change handler of the AllowDragging property. - - - - - param - value - M:Arction.Wpf.Charting.DraggableObject.SetAllowDragging(System.Boolean) - - - - - - - returns - M:Arction.Wpf.Charting.DraggableObject.SetAllowDragging(System.Boolean) - - - - - - - Set item drag end position. - - X value. - Y value. - True if the position is set due to the end of dragging. - Implemented original for snapping Smith markers. - - - - - Set proper cursor. Default for dragging is hand and for resize SizeAll. - - - - - DX Feature level. - - - - - Unknown DX. - - - - - DX 9.1. - - - - - DX 9.2. - - - - - DX 9.3. - - - - - DX 10.0. - - - - - DX 10.1. - - - - - DX 11.0. - - - - - Background image for dynamic themes. - - - - - No Dynamic background image - - - - - Default for Dynamic Themes BrickWall - - - - - Magma style background image - - - - - Auroras theme - - - - - Brushed metal - - - - - Red carbon theme - - - - - Paper theme - - - - - TurquiseHexagon background image - - - - - World cyper space background image - - - - - Custom background image (Add image to your theme via CustomDynamicBackgroundImage variable) - - - - - Engine Init Result. - - - - - Date and time the engine initialization was tried or the information was created. - This fields can not be trusted if the initialization is not tried. - - - - - Defines the engine type this information concerns. - - - - - List of exceptions encountered on engine initialization. - - - - - If true, initialization of the engine was successful. False if not. - - - - - Used to convert GetLastEngineInitResults to string to help reporting of it's contents. - - - - - returns - M:Arction.Wpf.Charting.EngineInitResult.ToString - - - - - - - List of warnings and other messages encountered during initialization, that would have been reported to the ChartError event if they would have been encountered later. - These messages will be delivered through the ChartError event for the activated device in a patch after the init. - - - - Defines a type for messages that can be received from the rendering engine. - Used to pass messages from engine to LightningChart during initialization. - Usually the messages are warnings or other notifications intended for optimization and debugging. If they are critical they usually result in exceptions. - - - - Summary of the problem on a general level - - - - - Details of the message. - - - - - Severity level of the message. - - - - - Type of the message. - - - - - Conversion to EngineWarning from RD.EngineWarning. There should be a better way for this. - - - - - param - src - M:Arction.Wpf.Charting.EngineWarning.op_Explicit(Arction.RenderingDefinitions.EngineWarning)~Arction.Wpf.Charting.EngineWarning - - - - - - - returns - M:Arction.Wpf.Charting.EngineWarning.op_Explicit(Arction.RenderingDefinitions.EngineWarning)~Arction.Wpf.Charting.EngineWarning - - - - - - - Date and time when the event occurred. - - - - - Enhanced anti-aliasing. Anti-aliasing is made in GPU shader. - This is useful especially for GPUs that don't support anti-aliasing in GPU hardware. - Provides better visual quality and clearness of lines than hardware anti-aliasing. - - - - - Use enhanced anti-aliasing. - - - - - Use only if anti-aliasing is not supported in hardware. - - - - - Don't use enhanced anti-aliasing. Anti-aliasing in hardware is used, if it's supported and enabled in object's settings. - - - - - Event marker symbol. - - - - - Flag symbol. - - - - - Flag with a lightning on it. - - - - - Rectangle. - - - - - Circle (or oval). - - - - - Triangle. - - - - - Struct for containing error and debug information for ChartExceptions. - - - - - Information about LightningChart instance. - - - - - Information about chart message. - - - - - Indicates if data was successfully gathered on an exception. - - - - - Information about users system. - - - - - Return information as a string. - - - - - returns - M:Arction.Wpf.Charting.ExceptionInfo.ToString - - - - - - - Extensions - - - - - Calculate gradient for Wpf - - - - - param - colorFrom - M:Arction.Wpf.Charting.ExtensionsClass.CalculateGradient2(System.Drawing.Color,System.Drawing.Color,System.Double) - - - - - - - param - colorTo - M:Arction.Wpf.Charting.ExtensionsClass.CalculateGradient2(System.Drawing.Color,System.Drawing.Color,System.Double) - - - - - - - param - positionPercents - M:Arction.Wpf.Charting.ExtensionsClass.CalculateGradient2(System.Drawing.Color,System.Drawing.Color,System.Double) - - - - - - - returns - M:Arction.Wpf.Charting.ExtensionsClass.CalculateGradient2(System.Drawing.Color,System.Drawing.Color,System.Double) - - - - - - - Copy array - - - - - param - array - M:Arction.Wpf.Charting.ExtensionsClass.CopyItems(System.Array,System.Array,System.Int32) - - - - - - - param - destination - M:Arction.Wpf.Charting.ExtensionsClass.CopyItems(System.Array,System.Array,System.Int32) - - - - - - - param - length - M:Arction.Wpf.Charting.ExtensionsClass.CopyItems(System.Array,System.Array,System.Int32) - - - - - - - Square distance between two points - - - - - param - from - M:Arction.Wpf.Charting.ExtensionsClass.DistanceSquareTo(Arction.Wpf.Charting.PointDouble2D,Arction.RenderingDefinitions.PointDouble2D) - - - - - - - param - dest - M:Arction.Wpf.Charting.ExtensionsClass.DistanceSquareTo(Arction.Wpf.Charting.PointDouble2D,Arction.RenderingDefinitions.PointDouble2D) - - - - - - - returns - M:Arction.Wpf.Charting.ExtensionsClass.DistanceSquareTo(Arction.Wpf.Charting.PointDouble2D,Arction.RenderingDefinitions.PointDouble2D) - - - - - - - Square distance between two points - - - - - param - from - M:Arction.Wpf.Charting.ExtensionsClass.DistanceSquareTo(Arction.Wpf.Charting.PointDouble2D,Arction.Wpf.Charting.PointDouble2D) - - - - - - - param - dest - M:Arction.Wpf.Charting.ExtensionsClass.DistanceSquareTo(Arction.Wpf.Charting.PointDouble2D,Arction.Wpf.Charting.PointDouble2D) - - - - - - - returns - M:Arction.Wpf.Charting.ExtensionsClass.DistanceSquareTo(Arction.Wpf.Charting.PointDouble2D,Arction.Wpf.Charting.PointDouble2D) - - - - - - - Square distance between two points - - - - - param - from - M:Arction.Wpf.Charting.ExtensionsClass.DistanceSquareTo(Arction.Wpf.Charting.PointFloat,Arction.RenderingDefinitions.PointFloat) - - - - - - - param - dest - M:Arction.Wpf.Charting.ExtensionsClass.DistanceSquareTo(Arction.Wpf.Charting.PointFloat,Arction.RenderingDefinitions.PointFloat) - - - - - - - returns - M:Arction.Wpf.Charting.ExtensionsClass.DistanceSquareTo(Arction.Wpf.Charting.PointFloat,Arction.RenderingDefinitions.PointFloat) - - - - - - - Square distance between two points - - - - - param - from - M:Arction.Wpf.Charting.ExtensionsClass.DistanceSquareTo(Arction.Wpf.Charting.PointFloat,Arction.Wpf.Charting.PointFloat) - - - - - - - param - dest - M:Arction.Wpf.Charting.ExtensionsClass.DistanceSquareTo(Arction.Wpf.Charting.PointFloat,Arction.Wpf.Charting.PointFloat) - - - - - - - returns - M:Arction.Wpf.Charting.ExtensionsClass.DistanceSquareTo(Arction.Wpf.Charting.PointFloat,Arction.Wpf.Charting.PointFloat) - - - - - - - Gathers various information from the current chart for debugging purposes as a string by calling - Optionally saves the output to a text file if file path and file name are specified. - Gathered data (if is set to All): system information, chart information, - list of running processes, DxDiag output, installed Windows hotfixes. - - Chart to collect data from. - Data gathering options flags. See . - Path to folder where file is saved (optional, if not specified the data won't be saved to a file and just returned as a string). - Output text file filename (optional, if not specified the default name is created with timestamp) - The gathered data as a string. - - - - Get item counter - - - - - param - array - M:Arction.Wpf.Charting.ExtensionsClass.GetItemCount(System.Array) - - - - - - - returns - M:Arction.Wpf.Charting.ExtensionsClass.GetItemCount(System.Array) - - - - - - - Removes item from the list and then disposes it. - - - - - param - list - M:Arction.Wpf.Charting.ExtensionsClass.RemoveAndDispose``1(System.Collections.Generic.IList{``0},System.Int32) - - - - - - - param - i - M:Arction.Wpf.Charting.ExtensionsClass.RemoveAndDispose``1(System.Collections.Generic.IList{``0},System.Int32) - - - - - - - typeparam - T - M:Arction.Wpf.Charting.ExtensionsClass.RemoveAndDispose``1(System.Collections.Generic.IList{``0},System.Int32) - - - - - - - Removes item from the list and then disposes it. - - - - - param - list - M:Arction.Wpf.Charting.ExtensionsClass.RemoveAndDispose(System.Collections.IList,System.Int32) - - - - - - - param - i - M:Arction.Wpf.Charting.ExtensionsClass.RemoveAndDispose(System.Collections.IList,System.Int32) - - - - - - - Convert given color to currently active platform. - - - - - param - color - M:Arction.Wpf.Charting.ExtensionsClass.ToCurrentPlat(System.Drawing.Color) - - - - - - - returns - M:Arction.Wpf.Charting.ExtensionsClass.ToCurrentPlat(System.Drawing.Color) - - - - - - - Convert given color to currently active platform. - - - - - param - color - M:Arction.Wpf.Charting.ExtensionsClass.ToCurrentPlat(System.Windows.Media.Color) - - - - - - - returns - M:Arction.Wpf.Charting.ExtensionsClass.ToCurrentPlat(System.Windows.Media.Color) - - - - - - - Change device types to long strings - - - - - param - rdi - M:Arction.Wpf.Charting.ExtensionsClass.ToLongString(Arction.Wpf.Charting.RendererDeviceType) - - - - - - - returns - M:Arction.Wpf.Charting.ExtensionsClass.ToLongString(Arction.Wpf.Charting.RendererDeviceType) - - - - - - - To WPF size - - - - - param - size - M:Arction.Wpf.Charting.ExtensionsClass.ToPlatSize(Arction.Wpf.Charting.SizeInt) - - - - - - - returns - M:Arction.Wpf.Charting.ExtensionsClass.ToPlatSize(Arction.Wpf.Charting.SizeInt) - - - - - - - Make public color - - - - - param - color - M:Arction.Wpf.Charting.ExtensionsClass.ToPublicColor(System.Drawing.Color) - - - - - - - returns - M:Arction.Wpf.Charting.ExtensionsClass.ToPublicColor(System.Drawing.Color) - - - - - - - Change device types to short strings - - - - - param - rdi - M:Arction.Wpf.Charting.ExtensionsClass.ToShortString(Arction.Wpf.Charting.RendererDeviceType) - - - - - - - returns - M:Arction.Wpf.Charting.ExtensionsClass.ToShortString(Arction.Wpf.Charting.RendererDeviceType) - - - - - - - To RD.SizeInt size - - - - - param - size - M:Arction.Wpf.Charting.ExtensionsClass.ToSizeInt(System.Windows.Size) - - - - - - - returns - M:Arction.Wpf.Charting.ExtensionsClass.ToSizeInt(System.Windows.Size) - - - - - - - To WinForm color - - - - - param - color - M:Arction.Wpf.Charting.ExtensionsClass.ToWinFormsColor(Arction.RenderingDefinitions.ColorRD) - - - - - - - returns - M:Arction.Wpf.Charting.ExtensionsClass.ToWinFormsColor(Arction.RenderingDefinitions.ColorRD) - - - - - - - To WinForm color - - - - - param - color - M:Arction.Wpf.Charting.ExtensionsClass.ToWinFormsColor(System.Drawing.Color) - - - - - - - returns - M:Arction.Wpf.Charting.ExtensionsClass.ToWinFormsColor(System.Drawing.Color) - - - - - - - To WinForm color - - - - - param - color - M:Arction.Wpf.Charting.ExtensionsClass.ToWinFormsColor(System.Windows.Media.Color) - - - - - - - returns - M:Arction.Wpf.Charting.ExtensionsClass.ToWinFormsColor(System.Windows.Media.Color) - - - - - - - To WinForm size - - - - - param - size - M:Arction.Wpf.Charting.ExtensionsClass.ToWinFormsSize(System.Windows.Size) - - - - - - - returns - M:Arction.Wpf.Charting.ExtensionsClass.ToWinFormsSize(System.Windows.Size) - - - - - - - To WPF color - - - - - param - color - M:Arction.Wpf.Charting.ExtensionsClass.ToWpfColor(System.Drawing.Color) - - - - - - - returns - M:Arction.Wpf.Charting.ExtensionsClass.ToWpfColor(System.Drawing.Color) - - - - - - - To WPF size - - - - - param - size - M:Arction.Wpf.Charting.ExtensionsClass.ToWpfSize(Arction.Wpf.Charting.SizeInt) - - - - - - - returns - M:Arction.Wpf.Charting.ExtensionsClass.ToWpfSize(Arction.Wpf.Charting.SizeInt) - - - - - - - To WPF size - - - - - param - size - M:Arction.Wpf.Charting.ExtensionsClass.ToWpfSize(System.Drawing.Size) - - - - - - - returns - M:Arction.Wpf.Charting.ExtensionsClass.ToWpfSize(System.Drawing.Size) - - - - - - - Fill class that can be applied to a rectangle - - - - - Constructor for Fill. - - - - - Constructor - - Parent. - - - - Bitmap fill options - - - - - Bitmap texture filtering. - - - - - Fill color - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Gradient color - - - - - Gradient direction in degrees, angle increases counterclockwise. - - - - - Gradient type - - - - - Fill style - - - - - Convert class description to string. - - String. - - - - Fill layout. - - - - - Stretch layout. Image is stretched to rectangle draw area. - - - - - Tile. Use also tile count properties. - - - - - Fonts rendering quality. - - - - - No anti-aliasing, best performance. - - - - - Anti-aliased fonts. - - - - - Best anti-aliasing and quality, lowest performance. - - - - - GPU preference. Is only applicable with D11 device. - - - - - Use default GPU. - - - - - Try to select high performance GPU. - - - - - Try to select GPU at CPU/Motherboard, which usually uses less power than separate GPU. - - - - - Gradient fill type. - - - - - Solid fill, no gradient. - - - - - Linear gradient. - - - - - Gradient is shaded towards circle edges. - - - - - Gradient is shaded towards area edges like ellipse. - - - - - Gradient is shaded from color1 to color2 and back to color1. - - - - - Gradient fill type. - - - - - Solid fill, no gradient. - - - - - Linear gradient. - - - - - Gradient is shaded towards area edges like ellipse. - - - - - Graph segment info. Needed when showing multiple Y-axes stacked. - - - - - Constructor for Form designer list editor. - - - - - First segment top. - - - - - Graph height. - - - - - Segment bottom coordinates. - - - - - Segment count. - - - - - Segment top coordinates. - - - - - Convert class description to string. - - Class description as a string. - - - - Grid source axis. - - - - - No grid. - - - - - Primary axis. - - - - - Secondary axis. - - - - - Selector between custom and normal gridline / ticks rendering. - - - - - Rendering both custom and normal items. - - - - - Custom items are rendered. - - - - - Normal items are rendered. - - - - - Grid options - - - - - Constructor for Form designer list editor - - - - - Constructor - - Parent. - - - - Line color - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Pattern - - - - - Pattern scale - - - - - Convert class description to string - - String - - - - Is grid visible or not - - - - - Empty class for angular grid options. - - - - - Default constructor. - - - - - Constructor - - Parent. - - - - Grid options of round views. - - - - - Constructor for Form designer list editor - - - - - Constructor - - Parent. - - - - Color of the labels. - - - - - Line width. - - - - - Grid options of Smith view. - - - - - Constructor for Form designer list editor - - - - - Constructor - - Parent. - - - - List of manually defined gridlines. - - - - - Dispose - - - - - Arction.Wpf.Charting.GridOptionsSmith - - - - - - - Grid labels visible. - - - - - List of manually defined gridline positions as normed values. - - - - - Determines which gridlines are rendered, both, just the custom ones, - or just the automatic ones. - - - - - Smith Grid extra line options - - - - - Constructor - - - - - Constructor. - - - - - param - Owner - M:Arction.Wpf.Charting.GridOptionsSmithExtraLine.#ctor(Arction.Wpf.Charting.IChartNode) - - - - - - - Real or Imaginary component of the Value of the Gridline position. - - - - - Enumeration specifying how the smith grid are to be formed. - For more information, see AxisSmith.GridType property. - - - - - Determine gridline positions so that each line is positioned in a point where the value is nice and event, - and distance to other lines is approximately value set in GridDivSpacing. - - For more information on actual positioning, see the GridDivSpacing property of AxisSmith. - - - - - Determine gridline positions so that specific number of gridlines are placed on even distances from the center line, that is always - drawn. - Number of gridlines can be set using GridDivCount property. See that for more information about positioning of the gridlines. - - - - - Defines the grids position in relation to other elements in depth direction. - In other words, used in defining in which order different objects are drawn. - - - - - Grid lines behind series. - - - - - Grid lines in front of series. - - - - - Highlight style, when user is over an object. - - - - - No highlight. - - - - - Highlight with brighter color, and possibly thicker object. - - - - - Highlight with blinking color, and possibly thicker object. - - - - - Defines event information for HighlightedStateEventHandler. Contains information for highlighting state changes. - - - - - Defines if the item is currently (on next frame) highlighted or not. - - - - - Reason why the event was launched. Defines the effective source of the event. - - - - - Event type for notifying changes in the highlighting state of an object. - - - - - Base class for all LC objects that can be highlighted. - - - - - Constructor. - - - - - Constructor. - - Owner object. - - - - Gets or sets highlight style. Item can be highlighted by user interactive device or by code. - - - - - Event telling that highlighted state has changed. Contains information of the new state. - - - - - Invokes HighlightedStateChanged events. - - Arguments to use instead of current objects stored MouseEvent arguments. - Can be used to speed up speed up the call if the event is already constructed. - Note that the object is not updated in any way if given, so it can be used to deliver wrong information. - - - Return value of the Charts RaiseEvent method. False if the event could not be emitted, true otherwise. - - True emitting of the event succeeds. If no event listeners is registered, this should return true. - - - - - returns true if the object is highlighted. - - True if the object is highlighted. - - - - Removes forced highlighting. - - - - - Highlights the object. - - This is a kind of "forced" highlight, and the object might be highlighted even if the highlighting type (defined by Highlight property) is set to None. - How the highlighting happens, if any, depends on object. Most objects use the defined type by default, and fall back to Simple highlighting if None is set. - - - - - Item to string. - - String. - - - - Reason/source for highlighting event. - - - - - Items highlighting state has changed because of user action. - - - - - Items highlighting state has changed because of legend box action. - - - - - Items highlighting state has changed because of user action. Items SetHighlight or RemoveHighlight has been called. - - - - - HighLow series point. - - - - - Constructor. - - X value. - Y high value. - Y low value. - - - - Constructor. - - X value. - Y high value. - Y low value. - Tag. Freely assignable object. - - - - Constructor. - - X value. - Y high value. - Y low value. - Tag. Freely assignable object. - Color of the point. For more information see Color property. - - - - Constructor. - - X value. - Y high value. - Y low value. - Color of the point. For more information see Color property. - - - - Point Color. - - - - - Tag. Freely assignable object. - - - - - Convert class description to string. - - Class description as a string. - - - - X value. - - - - - Y high value. - - - - - Y low value. - - - - - Options for defining when to show hints. - - - - - Never show any hints - - - - - Hints are visible only at design time. - - - - - Hints are visible always. - - - - - Horizontal scrollbar. - Values use unsigned 64-bit integer value range. - - - - - Constructor for form editor list editor - - - - - Constructor - - Parent. - - - - Alignment. - - - - - Dispose - - - - - Arction.Wpf.Charting.HorizontalScrollBar - - - - - - - Horizontal scroll bar alignment. - - - - - No alignment. - - - - - Scrollbar is horizontally aligned below the graph area. - Left edge is positioned to graph left edge, and right edge is positioned to graph right edge. - - - - - Scrollbar is horizontally aligned to the center of the graph area. - Left edge is positioned to graph left edge, and right edge is positioned to graph right edge. - - - - - Scrollbar is horizontally aligned above the graph area. - Left edge is positioned to graph left edge, and right edge is positioned to graph right edge. - - - - - Interface for identifying chart objects. - - - - - Colored Point. - - - - - Color of the point. - - - - - Grid options. - - - - - Grid color - - - - - Grid pattern. - - - - - Pattern scale - - - - - Grid to string. - - - - - returns - M:Arction.Wpf.Charting.IGridOptions.ToString - - - - - - - Grid visible. - - - - - Interface of objects that can be highlighted. - - Allows user to highlight the object and define how the object should be highlighted. The objects also report to users when they are highlighted. - - - - - Setter highlighting style. - - - - - Event telling that highlighted state has changed. Contains information of the new state. - - - - - returns true if the object is highlighted. - - True if the object is highlighted. - - - - Removes forced highlighting. - - - - - Highlights the object. - - This is a kind of "forced" highlight, and the object might be highlighted even if the highlighting type (defined by Highlight property) is set to None. - How the highlighting happens, if any, depends on object. Most objects use the defined type by default, and fall back to Simple highlighting if None is set. - - - - - Image type. - - - - - Raster image, composed from pixels, e.g. Windows bitmap. - - - - - Vector image, elements composed from graphics instructions, e.g. Enhanced metafile. - Vector image can be scaled without quality loss, but may be yield to very big file/data size. - - - - - Intensity series fill style. - - - - - No fill. - - - - - Coloring is made from surface data point array colors. - - - - - Single color tone applied over base color. - - - - - Paletted, various colors set by the palette, applied over base color. - - - - - IntensityGridSeries values data order in jagged array. - - - - - First dimension is columns, second rows. - - - - - First dimension is rows, second columns. - - - - - Intensity series data point. - - - - - Constructor. - - X value. - Y value. - Value. - Color of the point. - - - - Constructor. - - X value. - Y value. - Value. - Color of the point. - Tag. Freely assignable object. - - - - Color. - - - - - Check if referenced object is equal to this one. Due Color is not same, even if their components are same, one must check each component separately. - - - - - param - obj - M:Arction.Wpf.Charting.IntensityPoint.Equals(System.Object) - - - - - - - returns - M:Arction.Wpf.Charting.IntensityPoint.Equals(System.Object) - - - - - - - Tag. Freely assignable object. - - - - - Convert class description to string. - - Class description as a string. - - - - Intensity value. - - - - - X-coordinate. - - - - - Y-coordinate. - - - - - IntensitySeries DataCursor ResultTable data visibility flags. - - - - - Show nothing. - - - - - Show X value. - - - - - Show Y value. - - - - - Show value. - - - - - Show color. - - - - - Show X, Y, Value and Color. - - - - - Intensity series optimization. - - - - - Optimize series to give better performance with data changing frequently (node positions, colors and intensity values). - - - - - Optimize series to give better performance with data changing frequently (intensity values only). - - - - - Optimize series to give better performance with data that is not changed frequently. - - - - - IPointPolar interface. - - - - - Amplitude. - - - - - Angle (degrees). - - - - - IPointRound interface. - - - - - Interface of the Smith points. - - - - - Imaginary component of the smith coordinate. - - - - - RealValue component of the smith coordinate. - - - - - Interface for UnitCircle coordinate points. - X and Y coordinates have normed values in range [-1,1]. Point (0,0) - points is at the center of the circle. - - - - - X direction coordinate - - - - - Y direction coordinate - - - - - Base for polar series points. - - - - - Latitude degrees, arc minutes, arc seconds representation coordinate postfix. - - - - - North. - - - - - South. - - - - - 3D legend box items categorization. - - - - - No categorization. - - - - - Categorization by series type. - - - - - Legend box items categorization. - - - - - No categorization. - - - - - Categorization by Y-axes. - - - - - Categorization by series type. - - - - - Legend box layout. - - - - - Horizontal. - - - - - Horizontal, allow row spanning. - - - - - Vertical. - - - - - Vertical, allow row spanning. - - - - - Legend box position. - - - - - Top-left. - - - - - Top center. - - - - - Top-right. - - - - - Left center. - - - - - Right center. - - - - - Bottom-left. - - - - - Bottom center. - - - - - Bottom-right. - - - - - Manual positioning. - - - - - Graph top left. - - - - - Graph top center. - - - - - Graph top right. - - - - - Graph bottom left. - - - - - Graph bottom center. - - - - - Graph bottom right. - - - - - Graph left margin center. - - - - - Graph right margin center. - - - - - Legend box position for XY Views. - - - - - Top-left - - - - - Top center. - - - - - Top-right. - - - - - Left center. - - - - - Right center. - - - - - Bottom-left. - - - - - Bottom center. - - - - - Bottom-right. - - - - - Manual positioning. Offset specifies the legend boxes top-left corner from the views top-left corner. - This differs from TopLeft in that the TopLeft position is calculated from the Graph areas top, not the views. - - - - - Related segment top left. - - - - - Related segment top center. - - - - - Related segment top right. - - - - - Related segment bottom left. - - - - - Related segment bottom center. - - - - - Related segment bottom right. - - - - - Related segment left margin center. - - - - - Related segment right margin center. - - - - - Surface side which is being lit. - - - - - Top surface is lit. - - - - - Bottom surface is lit. - - - - - Surface side which is being lit. - - - - - Top surface is lit. - - - - - Bottom surface is lit. - - - - - Predefined lighting schemes for 3D view. - - - - - Default lighting scheme, with one point of light and one directional light from camera direction. - - - - - Default lighting scheme, with one point of light and one directional light from camera direction. - - - - - Default lighting scheme, with one point of light and one directional light from camera direction. - - - - - 3 point of lights, red, green, blue. - - - - - 3 point of lights, cyan, magenta, yellow. - - - - - LightningChart is an ultimate data visualization chart control for high-speed 2D and 3D purposes. - - - - - Default constructor. Creates new LightningChart object. - - - - - Creates new LightningChart object. - - Takes parameter that can be used in defining certain settings on creation time. Note that some of the settings are dangerous to use, - and the constructor itself is intended for advanced use. In normal situation it's better to use the default parameterless constructor. - - - - - param - renderingSettings - M:Arction.Wpf.Charting.LightningChart.#ctor(Arction.Wpf.Charting.RenderingSettings) - - - - - - - The active view selection - - - - - Getter of the active view object as ViewBase. - - - - - Occurs right after the chart has been rendered. - - - - - Gets or sets background brush. Set a brush that has less alpha than 255 to allow the chart to be seen through. - Also set colors with alpha less than 255 for other chart objects. - - - - - Occurs just before the chart is going to get rendered. This is the place where you can create custom graphics objects etc. - - - - - Begin update. Disables control repaints when a property is changed. - Handy when updating status of many properties or updating series points. - - - - - Alignment offset in pixels (Not in DIP). - - If true, forces redetermination of the parent (takes time). It's hard to know when the parent chain has changed. - - - - returns - M:Arction.Wpf.Charting.LightningChart.CalculatePixelAlignmentOffset(System.Boolean) - - - - - - - Occurs right after the chart has been captured. E.g. CopyToClipBoard or SaveToFile, when there is possibility that rendering may be delayed due e.g. image reading from web. - - - - - Get chart as bitmap. - - - - - param - aaOptions - M:Arction.Wpf.Charting.LightningChart.CaptureToBitmap(Arction.Wpf.Charting.BitmapAntialiasOptions) - - - - - - - returns - M:Arction.Wpf.Charting.LightningChart.CaptureToBitmap(Arction.Wpf.Charting.BitmapAntialiasOptions) - - - - - - - Get the last frame rendered by the chart as byte array containing just pixel data four bytes per pixel. - To get the image data with headers, like in bpm or png format, use SaveToStream method - Chart width in pixels - Chart height in pixels - - - - param - format - M:Arction.Wpf.Charting.LightningChart.CaptureToByteArray(System.Int32@,System.Int32@,Arction.Wpf.Charting.PixelFormat@) - - - - chart's last rendered raw image as byte array. Each pixel is represented by 4 bytes in the order defined by the format parameter. - - - - Gets or sets background fill. - - - - - Chart manager - - - - - Event that notifies if some error has occurred that does not require exception to be thrown, or some other event has happened worth notifying - using system of. - See ChartMessageInfo struct contained in the message for detailed information. - - - - Gets or sets the name of this chart. - - - - - Gets or sets rendering options. - - - - - Gets or sets the color theme of this chart. - - - - - Copy the chart to clipboard bitmap image. - - true if succeeded, false otherwise - - - - Copy the chart to clipboard image by given format. - - Clipboard image format. - true if succeeded, false otherwise - - - - Copy the chart to clipboard image. - - Clipboard image format. - Antialias options. - true if succeeded, false otherwise - - - - Copy the chart to clipboard image. - - Clipboard image format. - Antialias options. - Width of required output - Height of required output - - Allows screen coordinates of certain elements to be - scaled by factor of defined size and original size to keep then in place in relation to other - chart elements in vector exports. - If unsure, use value true. Should be set to false if annotation tables or such constructs are used. - Affects only vector output (emf and svg). - - true if succeeded, false otherwise - - - - Copy the chart to clipboard image by given format. - - Clipboard image format. - Width of required output - Height of required output - - Allows screen coordinates of certain elements to be - scaled by factor of defined size and original size to keep then in place in relation to other - chart elements in vector exports. - If unsure, use value true. Should be set to false if annotation tables or such constructs are used. - Affects only vector output (emf and svg). - - true if succeeded, false otherwise - - - - Copy the chart to clipboard bitmap image. - - Width of required output - Height of required output - true if succeeded, false otherwise - - - - Copy chart to clipboard as emf. - - - - - Sets or gets the Custom Dynamic Theme. - - - - - Clean up any resources being used. - - - - - Effect animation controller - - - - - Enables/disables internal timer which keeps control of the object tree when the chart is being manipulated by property grid, - like in Visual Studio forms designer. - - True to enable, False to disable - - - - End update. Enables control repainting, and refreshes the control. - - - - - Used to convert GetLastEngineInitResults to string to help reporting of it's contents. - - - - - param - results - M:Arction.Wpf.Charting.LightningChart.EngineInitResultsToString(System.Collections.Generic.List{Arction.Wpf.Charting.EngineInitResult}) - - - - EngineInitResults as a string. - - - - Count of rendered frames with the current engine. - - - Number of so far rendered frames with the currently active rendering - engine. - 0 if no engine is active. - - - - - Destroy all buffered draw data and repaint the chart - This is slower than Refresh(), but thorough. - - - - - Get the chart object that is activated by mouse. - Note that this information is not correct if we do not have proper device set. - - Last active object. If unavailable, returns null - - - - Get effectively used BeginUpdate/EndUpdate counter. Use for debugging, if seems that chart does not render. - The value must be 0 in order for the chart to render. If value is larger, some BeginUpdate call has not been closed by matching EndUpdate call.This indicates total value. Use GetBeginUpdateCountPublic to see difference of public - user called - BeginUpdate / EndUpdate methods. - - - - returns - M:Arction.Wpf.Charting.LightningChart.GetBeginUpdateCount - - - - - - - Get public BeginUpdate/EndUpdate counter. Use for debugging, if seems that chart does not render. - Must be zero after EndUpdate(), if one wants chart to render. - - - - - returns - M:Arction.Wpf.Charting.LightningChart.GetBeginUpdateCountPublic - - - - - - - returns a list of EngineInitResult objects of which each defines a tried engine, if its initialization was successful or not and the - reasons why its initialization failed. - - This method is intended for debugging purposes. - The information applies to the last time the engine was tried to be initialized. - The list is recreated each time engine initialization is tried and the old information is lost. - - List describing lastly tried engines and result of the initialization - - - - Getter of the pixel format of the last written data to the OutputStream. - - - - - returns - M:Arction.Wpf.Charting.LightningChart.GetLastOutputStreamFormat - - - - - - - Getter of the image size of the last image written to OutputStream as pixels (not DIP's). - - Size of the last image written to OutputStream. - - - - Get parent window handle (HWND). - Needed when using the control from other systems than .NET. - - Parent window handle. - - - - Get render device information. Gives information about your graphics adapter. - Tells if there is something that prevents the control to run at optimal performance. - - Information about your graphics adapter. - - - - Get Predefined theme Auroras - - - - - returns - M:Arction.Wpf.Charting.LightningChart.GetThemeAuroras - - - - - - - Get Predefined theme Brushed metal - - - - - returns - M:Arction.Wpf.Charting.LightningChart.GetThemeBrushedMetal - - - - - - - Get predefined theme magma. - - - - - returns - M:Arction.Wpf.Charting.LightningChart.GetThemeMagma - - - - - - - Get Predefined theme Paper - - - - - returns - M:Arction.Wpf.Charting.LightningChart.GetThemePaper - - - - - - - Get Predefined theme Red carbon - - - - - returns - M:Arction.Wpf.Charting.LightningChart.GetThemeRedCarbon - - - - - - - Get predefined theme TurgouiseHexagon. - - - - - returns - M:Arction.Wpf.Charting.LightningChart.GetThemeTurquoiseHexagon - - - - - - - Get Predefined theme Wolrd cyber space - - - - - returns - M:Arction.Wpf.Charting.LightningChart.GetThemeWorldCyberSpace - - - - - - - Gets total count of chart instances in application context. - - Total chart count - - - - Version and revision. - - Gets the major and minor numbers of the assembly. - Arction internal revision number of the library. Notation of this value can change. - - - - - - summary - P:Arction.Wpf.Charting.LightningChart.GpuUpdateType - - - - - - - Handle for WPF control. - - - - - Checks if high quality font and transparency background is used with DX11 - and gives warning of this conflict combination. - - - - - Scroll bars list - - - - - Tries to force the engine initialization in a synchronous fashion. Should have - no use in WinForms. - - This method allows user to force the rendering device initialization. - - Note! Do not force during chart events callbacks, except at AfterRendering event! Causes chart to malfunction, if engine is changed during event handler. - - Forces engine reinitialization, even if there should be no reason for it. - true if the call resulted in valid engine that is different from the previous one. - - - - Opposite color - - Color to convert. - The opposite color. - - - - Check if hardware rendering is supported. - - True if supports hardware rendering. - - - - Check if hardware rendering is supported. - - Hardware available by querying adapters in the system - Hardware may have been disable by HKEY_CURRENT_USER\\Software\\Microsoft\\Avalon.Graphics\\DisableHWAcceleration flag. Outputs false if so. - RenderCapability.Tier level test passes - True if all is enabled, and thus supports hardware rendering - - - - Check pixel alignment. - This is quite costly operation. It's faster just to update the value. - - True if the pixel alignment would not be changed if UpdatePixelAlignment would be called. - - - - Finds out if the given coordinate is over the chart control with pixels. - - X coordinate - Y coordinate - True if is over - - - - Check if chart is using hardware rendering. - - True, if hardware rendering is used, false otherwise. - - - - Measure text with given font in DIP units (with rounding). - - Text. - Font. - Dimensions in a point structure [in DIP units]. If unable to measure, returns (0,0). - - - - Measure text with given font in PX units (without rounding). - - Text. - Font. - Dimensions in a point structure [in PX units]. If unable to measure, returns (0,0). - - - - Occurs when mouse released. - - - - - Occurs when any mouse button is pressed while the pointer is over this element. - Overrided the UIElements MouseDown as we mark it handled as per Microsoft guidelines. - This can be used instead to receive the information, or PreviewMouseDown event should be used instead. - - - - - Occurs when any mouse button is pressed while the pointer is over this element. - Overrided the UIElements MouseDown as we mark it handled as per Microsoft guidelines. - This can be used instead to receive the information, or PreviewMouseDown event should be used instead. - - - - - Occurs when any mouse button is released while the pointer is over this element. - Overrided the UIElements MouseUp as we mark it handled as per Microsoft guidelines. - This can be used instead to receive the information, or PreviewMouseUp event should be used instead. - - - - - Occurs when any mouse button is released while the pointer is over this element. - Overrided the UIElements MouseUp as we mark it handled as per Microsoft guidelines. - This can be used instead to receive the information, or PreviewMouseUp event should be used instead. - - - - - Event for DPI change. - Subscribe to this event to receive information of changes on - the DPI and to enable automatic LightningChart resizing / repositioning - application window on DPI changes. See for more information. - - - - Generic chart options. - - - - - Stream to write the rendered frame bitmaps to. - Defaults to null. Set the stream to this property and it will be - written with ran data of the images on every frame. See remarks for the format.This property is intended as the fastest way to capture continuous frames from the chart, especially on - Headless mode. - - - - Getter of the currently used pixel alignment offset. - Call UpdatePixelAlignment to update / recalculate this value. - - - - - returns - M:Arction.Wpf.Charting.LightningChart.PixelAlignmentOffset - - - - - - - Print chart to default printer with default settings using raster output. No header nor footer. - - - - - Print chart to default printer with given settings. - - Image type: Raster or vector. Default is Raster. - Enable background fill. Default is false. - Enable graph fill. Default is false. - Enable double raster resolution. Default is false. - Header text. - Footer text. - Keep aspect ratio. Default is true. - Margins. - - - - Print preview of chart. - - - - - Print preview of chart. - - Header text. - Footer text. - Close preview window after printed. - - - - Show page setup dialog and print if ok clicked and allowed. - - Reset page setup to default values. - Print if pressed ok on dialog. - - - - Show printer selection dialog and print if allowed. - - - - - RendererDevice has changed. - This event is called almost every time the engine changes. Please see remarks for the exceptions - - - - Reset BeginUpdate/EndUpdate counter. Usually not required to call. - - - - - Reset page settings. - - - - - Read Trader Key - - What Provider wanted to be use. - - - - returns - M:Arction.Wpf.Charting.LightningChart.RTK(System.String) - - - - - - - Save the chart into a image file with no extra anti-aliasing applied. - - Target file name. You must include file extension (png, bmp, jpg, tif, gif, emf, svg). - True if the image was successfully written to file. - Returns false on invalid file extension or on file write failure. - - - - Save the chart into a image file by using given anti-aliasing options. - - Target file name. You must include file extension (png, bmp, jpg, tif, gif, wmf, emf, svg). - - - - param - antialiasOptions - M:Arction.Wpf.Charting.LightningChart.SaveToFile(System.String,Arction.Wpf.Charting.BitmapAntialiasOptions) - - - - True if the image was successfully written to file. - Anti-aliasing options - Returns false on invalid file extension, on file write failure and on other problems on image creation or saving. - - - - Save the chart into a image file by using given anti-aliasing options. - - Target file name. You must include file extension (png, bmp, jpg, tif, gif, wmf, emf, svg). - Anti-aliasing options - Width of required output in pixels - Height of required output in pixels - - Allows screen coordinates of certain elements to be - scaled by factor of defined size and original size to keep then in place in relation to other - chart elements in vector exports. - If unsure, use value true. Should be set to false if annotation tables or such constructs are used. - Affects only vector output (emf and svg). - - True if the image was successfully written to file. - Returns false on invalid file extension, on file write failure and on other problems on image creation or saving. - - - - Save to file as given size. - - Target file name. You must include file extension (png, bmp, jpg, tif, gif, emf, svg). - Width of required output in pixels (Not in DIPs) - Height of required output in pixels (Not in DIPs) - - Allows screen coordinates of certain elements to be - scaled by factor of defined size and original size to keep then in place in relation to other - chart elements in vector exports. - If unsure, use value true. Should be set to false if annotation tables or such constructs are used. - Affects only vector output (emf and svg). - - True if the image was successfully written to file. - Returns false on invalid file extension or on file write failure. - - - - Save the chart into stream in bitmap format. - - Stream to write to. - true if succeeded, false otherwise - - - - Save the chart into stream in given format and anti-aliasing options. - - Stream to write to. - Image format. - true if succeeded, false otherwise - - - - Save the chart into stream in given format and anti-aliasing options. - Note that the stream's position is at the end. In order to read it to some other variable, - rewind it first using seek. - - Stream to write to. - Image format. - Anti-alias options. - True if succeeded, false otherwise. - - - - Save the chart into stream in given format and anti-aliasing options. - - Stream to write to. - Image format. - Antialias options. - Width of required output - Height of required output - - Allows screen coordinates of certain elements to be - scaled by factor of defined size and original size to keep then in place in relation to other - chart elements in vector exports. - If unsure, use value true. Should be set to false if annotation tables or such constructs are used. - Affects only vector output (emf and svg). - - true if succeeded, false otherwise - - - - Save the chart into stream in given format and anti-aliasing options. - - Stream to write to. - Image format. - Width of required output - Height of required output - - Allows screen coordinates of certain elements to be - scaled by factor of defined size and original size to keep then in place in relation to other - chart elements in vector exports. - If unsure, use value true. Should be set to false if annotation tables or such constructs are used. - Affects only vector output (emf and svg). - - true if succeeded, false otherwise - - - - Save the chart into stream in given size. - - Stream to write to. - Width of required output - Height of required output - true if succeeded, false otherwise - - - - Set Deployment Key - - - - - param - deploymentKey - M:Arction.Wpf.Charting.LightningChart.SetDeploymentKey(System.String) - - - - - - - Set parent window handle (HWND). - Needed when using the control from other systems than .NET. - Parent window handle. - - - - param - hwnd - M:Arction.Wpf.Charting.LightningChart.SetParentWindow(System.IntPtr) - - - - - - - - - summary - M:Arction.Wpf.Charting.LightningChart.System#Windows#IWeakEventListener#ReceiveWeakEvent(System.Type,System.Object,System.EventArgs) - - - - - - - param - managerType - M:Arction.Wpf.Charting.LightningChart.System#Windows#IWeakEventListener#ReceiveWeakEvent(System.Type,System.Object,System.EventArgs) - - - - - - - param - sender - M:Arction.Wpf.Charting.LightningChart.System#Windows#IWeakEventListener#ReceiveWeakEvent(System.Type,System.Object,System.EventArgs) - - - - - - - param - e - M:Arction.Wpf.Charting.LightningChart.System#Windows#IWeakEventListener#ReceiveWeakEvent(System.Type,System.Object,System.EventArgs) - - - - - - - returns - M:Arction.Wpf.Charting.LightningChart.System#Windows#IWeakEventListener#ReceiveWeakEvent(System.Type,System.Object,System.EventArgs) - - - - - - - Title of the chart - - - - - Convert class description to string - - string - - - - Occurs when the total chart instance count has changed. - - - - - Disable DirectX present calls, but let the rendering routines run otherwise - - - - - Enable DirectX present calls again - - - - - Update custom themes. - - - - - Forces update of WPF pixel alignment. - Calling this should not be required normally. - - - - - Version info. - - - - - Scroll bars list - - - - - 3D chart view - - - - - 3D pie chart view. - - - - - Polar chart view. - - - - - Smith chart view. - - - - - XY graph view. - - - - - The delegate to use for handlers that receive the AfterRendering event. - - The object that raised the event. - Provides data for the AfterRendering event. - - - - Alf Error Level - - - - - The delegate to use for handlers that receive the BeforeRendering event. - - The object that raised the event. - Provides data for the BeforeRendering event. - - - - The delegate to use for handlers that receive the Capture event. - - The object that raised the event. - Provides data for the Capture event. - - - - Delegate for ChartMessage event. - - - - - - Delegate for event. - - Chart where the DPI change occurred. - New DPI X-value. - New DPI Y-value. - Allow window to be resized after event handler is called. - You should set this to true, if you choose not to react the WM_DPICHANGED - event on application side. If set to true, LightningChart will - mark the event as handled, and touch window size / position.The default value is false. - - - - Rectangle structure. - - - - - Bottom - - - - - Left - - - - - Right - - - - - Top - - - - - Delegate for RenderEngineChanged event. - - Renderer device type. - Render device info. - Chart where the device was changed. - Time stamp. - - - - Dynamic lighningchart basic theme - - - - - Theme base class. all variables has some pre defined value - - - - - Alpha level 0-255 - - - - - Annotation border color - - - - - Annotation text color - - - - - Axis color - - - - - Axis label color - - - - - Axis title color - - - - - Background color - - - - - Background gradient color - - - - - What color to gradient - - - - - Chart title color - - - - - HSVA color saturation - - - - - HSVA color strength - - - - - Color where to gradient is shaded - - - - - Custom dynamic image of dynamic theme background - - - - - Custom palette color - - - - - - - summary - P:Arction.Wpf.Charting.LightningChart.ThemeBasics.customPaletteSteps - - - - - - - - - summary - P:Arction.Wpf.Charting.LightningChart.ThemeBasics.darkLightBlendColor - - - - - - - DataCursor ResultTable text color. - - - - - Dispose unmanaged objects - - - - - Background image fill style - - - - - Enum for dynamic background image for resources - - - - - Enum for Dynamic background layout - - - - - Force labels to White - - - - - Gradient strength - - - - - Graph background color - - - - - Graph background gradient color - - - - - Grid and Ticks color - - - - - Legend Fill color - - - - - Legend fill gradient color - - - - - Legend text color - - - - - Marker single color - - - - - - - summary - P:Arction.Wpf.Charting.LightningChart.ThemeBasics.masterColor - - - - - - - Starting HSVA degree - - - - - Axis multi color - - - - - Series in multicolor - - - - - Scrollbar background Fill color - - - - - Scrollbar front fill color - - - - - Sectors single color - - - - - Step value for next color of HSVA table (masterhuedeg + stepvalue*n) - - - - - View3D walls coloring - - - - - Dark light blend color - - - - - The delegate to use for handlers that receive the TotalChartCountChanged event. - - The object that raised the event. - Provides data for the TotalChartCountChanged event. - - - - 3D wallcolors - - - - - 3D wall colors - - - - - Ambient color - - - - - Diffuse color - - - - - Emissive color - - - - - Grid strip 1 color - - - - - Grid strip 2 color - - - - - Specular color - - - - - Specular power color - - - - - Light types. - - - - - Directional with parallel light beams. - - - - - Point of light, like sun. - - - - - Limiting style for series rendering on y-axis. - - - - - No limit, data will not be limited to y-axis range, if it happens to exceed. - - - - - Clip to y-axis range. E.g. line will be clipped, if over axis range. - - - - - Clamp data to axis range. E.g. line will be rendered horizontally on y-axis edge, if it exceed. - - - - - Line anti-aliasing. - - - - - No anti-aliasing. - - - - - Normal, suitable for most cases. The smoothing quality is determined by chart's AntiAliasLevel. - - - - - Line anti-aliasing type. - - - - - Quadrilateral Anti-Aliasing. - - - - - Alpha Blending Line Anti-Aliasing. - - - - - Line rendering optimization for 3D lines. - - - - - Line rendering with one pixel wide line. - - - - - Line rendering as flat with specified width (by world coordinates). - - - - - Line as shaded with specified width. - - - - - Line patterns. - - - - - Solid line. - - - - - Dot line. - - - - - Dash line. - - - - - Dash-dot line. - - - - - Small dot line. - - - - - Line series coordinate solver result. - - - - - Bottom Y-coordinate at cursor position. - - - - - Top Y-coordinate at cursor position. - - - - - Minimum data point index. - - - - - Nearest X-coordinate. - - - - - Data point count for column. - - - - - Solve status. Use values only if SolveStatus is OK. - - - - - Convert class description to string. - - Class description as a string. - - - - Line series value solver status. - - - - - Point found. - - - - - Matching point not found. Empty series? - - - - - Line series statistics. - - - - - Point count. - - - - - Reset parameters. - - - - - Is structure data valid or not. - - - - - Convert class description to string. - - Class description as a string. - - - - Visible point count. - - - - - Maximum visible X value. - - - - - Minimum visible X value. - - - - - Maximum visible Y value. - - - - - Minimum visible Y value. - - - - - Maximum X value. - - - - - Minimum X value. - - - - - LineSeries value solve result. - - - - - Nearest data point index of the searched X value. Note that e.g. in real-time examples this is only valid when there is no data added to series. - - - - - Nearest X value of the searched X value. - - - - - Solve status. Use result values only if SolveStatus is OK. - - - - - Convert class description to string. - - Class description as a string. - - - - Max Y value on the searched X value. - - - - - Min Y value on the searched X value. - - - - - Line drawing parameters - - - - - Constructor for Form designer list editor - - - - - Constructor. - - Parent. - - - - Gets and sets anti-aliased line. - Drawing anti-aliased draws the line with smooth edges, but will increase CPU/GPU overhead. - In order to have an effect, must be set to a value higher than 1. - - - - - Gets and sets line color. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Gets and sets pattern of line. - - - - - Gets and sets pattern scale. - - - - - Convert class description to string - - String - - - - Gets and sets width of line. - - - - - Line drawing parameters - - - - - Constructor for Form designer list editor - - - - - Constructor. - - Parent. - - - - Gets and sets anti-aliased line. This is a dependency property. - Drawing anti-aliased draws the line with smooth edges, but will increase CPU/GPU overhead. - - Note that line width is defined in 3D world coordinates, not in pixels as with 2D line. - With DX11, thicker (triangle) lines cannot be rendered without - anti-aliasing unless is set to a value lower than 1. - - - - - Gets and sets line color. - - - - - Clean up any resources being used. - - True if managed resources should be disposed, otherwise false. - - - - Gets and sets line rendering optimization. - - - - - 3D LineStyle as ordinary LineStyle. - - - - - param - s - M:Arction.Wpf.Charting.LineStyle3D.op_Implicit(Arction.Wpf.Charting.LineStyle3D)~Arction.Wpf.Charting.LineStyle - - - - - - - returns - M:Arction.Wpf.Charting.LineStyle3D.op_Implicit(Arction.Wpf.Charting.LineStyle3D)~Arction.Wpf.Charting.LineStyle - - - - - - - Gets and sets pattern of line. - - - - - Gets and sets pattern scale. - - - - - Convert class description to string. - - String. - - - - Gets and sets line width. - - - - - Line drawing parameters - - - - - Constructor for Form designer list editor - - - - - Constructor. - - Parent. - - - - Gets and sets anti-aliased line. This is a dependency property. - Drawing anti-aliased draws the line with smooth edges, but will increase CPU/GPU overhead. - - Note that line width is defined in 3D world coordinates, not in pixels as with 2D line. - With DX11 thicker (triangle) lines cannot be rendered without - anti-aliasing unless is set to a value lower than 1. - - - - - Gets and sets line color. - - - - - Clean up any resources being used. - - True if managed resources should be disposed, otherwise false. - - - - OnDeserialized is called just after the object has been deserialized. - - Context. - - - - Gets and sets pattern of line. - - - - - Gets and sets pattern scale. - - - - - Convert class description to string - - String. - - - - Logarithmic axis labels type. - - - - - No special formatting. - - - - - When LogBase is 10, shows the labels like 1.0E-3, 1.0E-2 1.0E-1, 1.0E0, 1.0E1, 1.0E2 etc. - - - - - When LogBase is Math.E (neper), shows the labels like 1e, 2e, 3e... - - - - - Longitude degrees, arc minutes, arc seconds representation coordinate postfix. - - - - - East. - - - - - West. - - - - - Map geo coordinate. - - - - - Constructor. - - Latitude, as decimal degrees. - Longitude, as decimal degrees. - - - - Constructor. - - Latitude, degrees. - Latitude, arc minutes. - Latitude, arc seconds, with decimals. - Heading letter, N or S. - Longitude, degrees. - Longitude, arc minutes. - Longitude, arc seconds, with decimals. - Heading letter, E or W. - - - - Latitude, in decimal degrees, with sign. - - - - - Longitude, in decimal degrees, with sign. - - - - - Convert class description to string. - - Class description as a string. - - - - Chart tools provides versatile static methods - - - - - - - Arction.Wpf.Charting.MathRoutines - - - - - - - Retrieve the input angle value as positive angle of the first full rotation in degrees. - Note that the range contains 0, but not the "full angle" of 360 degrees. - Angle to find the equivalent angle in degrees. - Angle matching the input in first full positive round as degrees. - - - - Solve smallest absolute difference between two angles in degrees. - This takes in account the periodic nature of the values, meaning that full circles do not affect the difference. - Useful in comparing the difference of angles, e.g. on testing if angles are the same. Note that the type of angle unit affects the result. Use for radians. - One of the angles to calculate the difference between in degrees. Order of parameter does not matter. - One of the angles to calculate the difference between in degrees. Order of parameter does not matter. - Difference of provided angles in degrees. Always positive. - - - - Solve smallest absolute difference between two angles in radians. - This takes in account the periodic nature of the values, meaning that full circles do not affect the difference. - Useful in comparing the difference of angles, e.g. on testing if angles are the same. Note that the type of angle unit affects the result. Use for degrees and examples. - One of the angles to calculate the difference between in radians. Order of parameter does not matter. - One of the angles to calculate the difference between in radians. Order of parameter does not matter. - Difference of provided angles in radians. Always positive. - - - - Retrieve the input angle value as positive angle of the first full rotation in radians. - Note that the range contains 0, but not the "full angle" of PI radians. - Angle to find the equivalent angle in radians. - Angle matching the input in first full positive round as radians. - - - - Calculates angle of line going from pointFrom to pointTo - - From point - To point - RotateAngle in radians, in range 0...2*Pi - - - - Calculates angle of line going from pointFrom to pointTo - - Point 1 X - Point 2 X - Point 1 Y - Point 2 Y - RotateAngle in radians, in range 0...2*Pi - - - - Calculates intersection point(-s) of two circles. - - Center of the first circle. - Radius of the first circle. - Center of the second circle. - Radius of the second circle. - Intersection point output. - Intersection point output. - Success status returns 1 or 2. Returns 0 if could not solve the intersection. - - - - Calculates intersection point of two lines. Line 1: goes through A1 and A2 - Line 2: goes through B1 and B2 - - Line A point 1 - Line A point 2 - Line B point 1 - Line B point 2 - intersection point output - Success status. Returns false if could not solve the intersection - - - - Calculates intersection point of two lines. Line 1: goes through A1 and A2 - Line 2: goes through B1 and B2 - - Line A point 1 - Line A point 2 - Line B point 1 - Line B point 2 - intersection point output - Success status. Returns false if could not solve the intersection - - - - Convert degrees to radians. - - Degrees value. - Radians value. - - - - Calculates distance between two points. - - Point 1. - Point 2. - Distance between two points. - - - - Gaussian function - - argument of function - mean - standard division - - - - returns - M:Arction.Wpf.Charting.MathRoutines.Gaussian(System.Double,System.Double,System.Double) - - - - - - - - Convert gradians to radians. - - Radians value. - Gradians value. - - - - Hyptrochoid - - - - - - - - - param - counter - M:Arction.Wpf.Charting.MathRoutines.Hypotrochoid(System.Int32,System.Double,System.Double[0:,0:],System.Double,System.Double,System.Double,System.Double,System.Int32) - - - - - - - param - iStep - M:Arction.Wpf.Charting.MathRoutines.Hypotrochoid(System.Int32,System.Double,System.Double[0:,0:],System.Double,System.Double,System.Double,System.Double,System.Int32) - - - - - - - param - points - M:Arction.Wpf.Charting.MathRoutines.Hypotrochoid(System.Int32,System.Double,System.Double[0:,0:],System.Double,System.Double,System.Double,System.Double,System.Int32) - - - - - - - param - _xMax - M:Arction.Wpf.Charting.MathRoutines.Hypotrochoid(System.Int32,System.Double,System.Double[0:,0:],System.Double,System.Double,System.Double,System.Double,System.Int32) - - - - - - - param - _yMax - M:Arction.Wpf.Charting.MathRoutines.Hypotrochoid(System.Int32,System.Double,System.Double[0:,0:],System.Double,System.Double,System.Double,System.Double,System.Int32) - - - - - - - param - _yMin - M:Arction.Wpf.Charting.MathRoutines.Hypotrochoid(System.Int32,System.Double,System.Double[0:,0:],System.Double,System.Double,System.Double,System.Double,System.Int32) - - - - - - - param - _xMin - M:Arction.Wpf.Charting.MathRoutines.Hypotrochoid(System.Int32,System.Double,System.Double[0:,0:],System.Double,System.Double,System.Double,System.Double,System.Int32) - - - - - - - param - _iDeliveredPoints - M:Arction.Wpf.Charting.MathRoutines.Hypotrochoid(System.Int32,System.Double,System.Double[0:,0:],System.Double,System.Double,System.Double,System.Double,System.Int32) - - - - - - - Calculate linear fit from given points. Makes best fit with Least Square regression method. - A line equation is y = k*x + b, that is, y = gradient * x + coefficient - - X values - Y values - Line gradient - Coefficient, Y value of intersection where X = 0 - True if success - - - - Calculate linear line fit for given points - - X values that are used to calculate the factors. This is the point set where the regression line is fitted to. - Y values that are used to calculate the factors. Length must be equal to xInFactorization length. - X values whose Y values are to be solved, using the factors - Fitted Y values, the length equals to xValuesToFit length. Returns null if failed. - - - - Calculates intersection point of two lines. Line 1: goes through A1 and A2. - Line 2: goes through B1 and B2. - Algorithm copied from http://local.wasp.uwa.edu.au/~pbourke/geometry/lineline2d/ - - Line A point 1. - Line A point 2. - Line B point 1. - Line B point 2. - Intersection point output - Success status. Returns false if could not solve the intersection. - - - - Calculates intersection point of two lines. Line 1: goes through A1 and A2. - Line 2: goes through B1 and B2. - Algorithm copied from http://local.wasp.uwa.edu.au/~pbourke/geometry/lineline2d/ - - Line A point 1. - Line A point 2. - Line B point 1. - Line B point 2. - Intersection point output - Success status. Returns false if could not solve the intersection. - - - - Mystery curve - - - - - - - - - param - counter - M:Arction.Wpf.Charting.MathRoutines.MysteryCurve(System.Int32,System.Double,System.Double[0:,0:],System.Double,System.Double,System.Double,System.Double,System.Int32) - - - - - - - param - iStep - M:Arction.Wpf.Charting.MathRoutines.MysteryCurve(System.Int32,System.Double,System.Double[0:,0:],System.Double,System.Double,System.Double,System.Double,System.Int32) - - - - - - - param - points - M:Arction.Wpf.Charting.MathRoutines.MysteryCurve(System.Int32,System.Double,System.Double[0:,0:],System.Double,System.Double,System.Double,System.Double,System.Int32) - - - - - - - param - _xMax - M:Arction.Wpf.Charting.MathRoutines.MysteryCurve(System.Int32,System.Double,System.Double[0:,0:],System.Double,System.Double,System.Double,System.Double,System.Int32) - - - - - - - param - _yMax - M:Arction.Wpf.Charting.MathRoutines.MysteryCurve(System.Int32,System.Double,System.Double[0:,0:],System.Double,System.Double,System.Double,System.Double,System.Int32) - - - - - - - param - _yMin - M:Arction.Wpf.Charting.MathRoutines.MysteryCurve(System.Int32,System.Double,System.Double[0:,0:],System.Double,System.Double,System.Double,System.Double,System.Int32) - - - - - - - param - _xMin - M:Arction.Wpf.Charting.MathRoutines.MysteryCurve(System.Int32,System.Double,System.Double[0:,0:],System.Double,System.Double,System.Double,System.Double,System.Int32) - - - - - - - param - _iDeliveredPoints - M:Arction.Wpf.Charting.MathRoutines.MysteryCurve(System.Int32,System.Double,System.Double[0:,0:],System.Double,System.Double,System.Double,System.Double,System.Int32) - - - - - - - Calculates distance from line to point. - - Line point 1. - Line point 2. - Point. - Distance from line to point. - - - - Calculates distance from line to point. - - Line point 1. - Line point 2. - Point. - Point at line, which is nearest to of reference point. - Normalized distance from p1 to linePoint. - Distance from line to point. - - - - Calculates distance from line segment to point. - - Line point 1. - Line point 2. - Point. - Distance from line segment to point. - - - - Check whether point is inside polygon. - Algorithm from: http://www.ecse.rpi.edu/Homepages/wrf/Research/Short_Notes/pnpoly.html - Copyright (c) 1970-2003, Wm. Randolph Franklin. - Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: - 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimers. - 2. Redistributions in binary form must reproduce the above copyright notice in the documentation and/or other materials provided with the distribution. - 3. The name of W. Randolph Franklin may not be used to endorse or promote products derived from this Software without specific prior written permission. - THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - - Point. - Polygon points. - True, if point is inside polygon, false otherwise. - - - - Calculate polymial line fit. Calculates polynomial factors, and uses these factors to solve Y values based on given X value array. - - X values that are used to calculate the factors. This is the point set where the regression line is fitted to. - Y values that are used to calculate the factors. Length must be equal to xInFactorization length. - X values whose Y values are to be solved, using the factors - Order of polynomial. Usually more than 3 shouldn't be used - Fitted Y values, the length equals to xValuesToFit length. Returns null if failed. - - - - Calculate polymial line fit. Calculates polynomial factors, and uses these factors to solve Y values based on given X value array. - - X values that are used to calculate the factors. This is the point set where the regression line is fitted to. - Y values that are used to calculate the factors. Length must be equal to xInFactorization length. - X values whose Y values are to be solved, using the factors - Order of polynomial. Usually more than 3 shouldn't be used - Polynomial result factors, length = order+1. For example, when having order 2, you can plot line with equation: Y = factors[0] + factors[1]*X + factors[2]*X^2 - Fitted Y values, the length equals to xValuesToFit length. Returns null if failed. - - - - Convert radians to degrees. - - Radians value. - Degrees value. - - - - Make radians as degrees string. - - Radians value. - Radians as degrees string. - - - - Convert radians to gradians. - - Radians value. - Gradians value. - - - - Make radians as gradians string. - - Radians value. - Radians as gradians string. - - - - Make radians as string. - - Radians value. - Radians as string. - - - - Calculates relative distance between two points. - - Point 1. - Point 2. - Relative distance between two points. - - - - Replace NaN numbers with given value - - Array to check and replace - Value to store when NaN is found - - - - Replace NaN numbers with given value - - Array to check and replace - Value to store when NaN is found - - - - Rotate point. - - Point (in math coordinate system). - Angle in radians. - Point in pixel coordinate system. - - - - Convert double value to nearest integer. The fast way. - - Value to convert - Nearest integer - - - - Convert float value to nearest integer. The fast way. - - Value to convert - Nearest integer - - - - Calculate standard deviation of values - - values - Stardard deviation - - - - MeshModel rendering order. - - - - - Render before other series. - - - - - Render after other series. - - - - - Tells the severity level of ChartMessage event. - Used to determine which kind of actions should be taken on the message event. - - - - - NoMinimumLevel is only used in setting ChartMessageMinimumLevel to allow all messages to be sent to the user. - Should not be used in ChartMessage events as this will cause a warning. - - - - - Debug message. The user is usually not interested in this. - - - - - Information, not an error. Should not require any actions from the user. - Some incorrect usage of LightningChart has happened which shouldn't impact chart performance. - - - - - Warning, not an error. User action might be required. - Incorrect usage of LightningChart has happened, like setting an illegal property value - or mismatching data point types which might cause minor problems with the application. - - - - - An error happened that should have been recovered. User action might be required. - User must listen to ChartMessage events or the message will be thrown as an exception. - - - - - An error happened in the application that the chart couldn't recover from. - User must listen to ChartMessage events or the message will be thrown as an exception. - - - - - Critical error, will result in an exception in all cases. - - - - - Detailed information about the type of the ChartMessage event - - - - - Unknown message type - - - - - Unable to allocate memory for operation. You should run the garbage collection GC.Collect(), - and then try the operation again - - - - - Invalid property value has been set - - - - - Series data X coordinate to Y coordinate resolver data has become invalid, because points have been added. - Do not use markers as 'TrackSeries' with X axis monitoring monitoring scroll modes. Instead, you should - define them as 'AtYValue' and convert them 'TrackSeries' when opening data in review mode, and set the - scroll mode to 'None'. - - - - - You are requesting a tracking operation on a series, that is not trackable (does not implement ITrackable) - - - - - Samples use different format than you try to use - - - - - Series has been configured to use different data point type than you are trying to use - - - - - The selected feature can't be used with logarithmic axis - - - - - Shader model 3 is not supported by the GPU. Some parts of the chart cannot be drawn as intended. - - - - - Render device create failed. - - - - - Saving to file failed. - - - - - Canceled svg rendering. - - - - - EndUpdate() is called more often than BeginUpdate(). - - - - - Copying to clipboard failed. - - - - - Invalid save file format. E.g. one can't save 3D graph as vector. - - - - - Assembly not found. - - - - - IsBindableDataUsed is 'true' but non-bindable data collection - (e.g. PointLineSeries.Points) is modified instead of bindable data - collection (e.g. PointLineSeries.PointsWpf). - - - - - Axis index for axis related item is invalid. - - - - - Segment or segment index for y-axis is invalid. - - - - - Item view differs from drawing view. - - - - - Volume Model is too big. - - - - - Volume model is not found. - - - - - Problem with licensing. - Make sure the license is properly installed. - - - - - Problem delivering or calling client side event handlers. - - - - - Some exception occurred when graphics object tried to draw image. - - - - - Some method implementation is missing. - - - - - Illegal update action on a disposed object detected. - - - - - Chart objects parent changed. This could indicate sharing chart's object between multiple parents which is not supported. - - - - - Requested camera orientation is problematic and might result in different - result than expected. - - This is similar to but more specific. - At this case the user defined camera orientation was somehow problematic on - current settings. - - - - - Some problem appeared with positioning 3D camera or some other viewpoint / - view area. - This is similar to but more general. - - - - - Something caused the rendering engine to reinitialize. - - - - - Catched a null reference exception. - - - - - Missing rendering device. - - - - - Shader loading failed. - - - - - Render device is not available anymore. - - - - - Rendering caused invalid call exception. - Possibly caused by updating chart from a separate thread without synchronizing it with main program thread. - You should use BeginInvoke or Invoke methods for synchronization. - - - - - Unable to create texture. - - - - - Rendering performance warning. - - - - - Fast WPF presentation element has retrieved the front buffer, and normal presentation of the LC can continue. - - - - - Fast WPF presentation element has lost the front buffer, and LC cannot be presented using it. - This can happen for multiple different valid and normal - reasons, like hiding of the window, changing to different tab, using through remote desktop, etc, and usually does not require attention. - After this the chart will try to use slower fallback presentation method. - - - - - Error on creation of SharpDX Buffer. - - - - - Some of the requirements are not met. Details might present more information. - - - - - Some suspicios or alarming happened with resource management (memory, handles.. ) - This might result in rendering device being lost and hopefully reacquired. - - - - - Presentation of image has encountered a timeout problem. - This might be because of a large things to draw, slow system etc, but might indicate a real problem as well. - - - - Use of the detected GPU has been blacklisted for the given purpose. - - - - - Engine warning message. - - - - - Load from a file operation failed. - - - - - Requested operation was not finished. - Zooming, drawing or some other operation did not finish as expected. Output might - differ from expected. - Details will elaborate the issue. . - - - - - LightningChart specific mouse cursors - - - - - - - Arction.Wpf.Charting.MouseCursors - - - - - - - Cross - - - - - Default cursor. - - - - - Drag'n'drop cursor - - - - - Drag'n'drop cursor with plus sign - - - - - Hand. - - - - - HSplit cursor. - - - - - No - - - - - NoMoveHoriz - - - - - Pan cursor - - - - - Pan X cursor - - - - - Pan Y cursor - - - - - Rotation cursor - - - - - 3D scrolling cursor - - - - - ScrollNS - - - - - SizeAll cursor. Used for round view angle dragging. - - - - - SizeNESW - - - - - SizeNS - - - - - SizeNWSE - - - - - SizeWE - - - - - VSplit cursor. - - - - - Zoom in X dimension - - - - - Zoom in both X and Y dimensions - - - - - Zoom in Y dimension - - - - - Flags specifying point movement dimension. - - - - Move on X dimension. - - - Move on Y dimension. - - - Move on Z dimension. - - - - Touch zoom direction options. - - - - - Zoom on both directions, but direction is determined by touch points. - - - - - Zoom on X-axis. - - - - - Zoom on Y-axis. - - - - - Zoom on both axis. - - - - - Obj file data container + color array for vertices. - - - - - Constructor. - - - - - param - count - M:Arction.Wpf.Charting.ObjectFileData.#ctor(System.Int32) - - - - - - - Order change action. - - - - - Bring object to front. - - - - - Send to back. - - - - - Move one step backwards. - - - - - Move one step forward. - - - - - - Camera orientation / rotation interpretation types, giving meaning for - , and - settings and their calculation - order, thus affecting camera position and - orientation. See remarks for generic information on camera placement and orientation. - See different enumeration values and property - for more information on available options, their usage and effects. - - - - - - - XYZ Mixed mode orientation interpretation. - - - Camera position is defined as X-Y extrinsic rotation and camera up direction by world Z-axis rotation. - - - This was the only available angle property interpretation used in LC up to version 8.3. - - - This interpretation has some problematic features and will be deprecated in the future. - It's highly suggested to move using interpretation. - See Remarks for more information - - - - - - Overlay elements horizontal alignment. - - - - - Align left. - - - - - Align to left margin. - - - - - Centered align. - - - - - Align right. - - - - - Align to right margin. - - - - - Palette step. - - - - - Constructor for PaletteStep. - - - - - Constructor - - Parent. - - - - Constructor - - Parent. - Color. - Value. - - - - Step color - - - - - Clean up any resources being used. - - True if managed resources should be disposed, otherwise false. - - - - Step maximum value - - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Show palette step labels. - - - - - Convert class description to string. - - String. - - - - Surface palette type. - - - - - Uniform colored palette, clear steps. - - - - - Gradient palette, smooth steps. - - - - - Pan direction. - - - - - Horizontal pan only. - - - - - Vertical pan only. - - - - - Pan in horizontal and vertical direction. - - - - - Result of persistent rendering. - - - - - Ok. - - - - - Invalid X-axis in scrolling mode. - - - - - Invalid owner view. - - - - - X-axis assigned to the layer must be same than X-axis of the series. - - - - - 3D Pie style. - - - - - Pie. - - - - - Donut. - - - - - Pie titles style. - - - - - Titles are on shown on top of the pie slices. - - - - - Values are on shown on top of the pie slices. - - - - - Percents are on shown on top of the pie slices. - - - - - Describes a pixel format of an image or texture. - - - - - No format defined - - - - - Byte order is ARGB - - - - - Byte order is BGRA - - - - - Defines 3D plane orientation. - - - - - Plane in X - Y direction. - - - - - Plane in X - Z direction. - - - - - Plane in Y - Z direction. - - - - - 3D plane orientation for X-axis. - - - - - Plane in X - Y direction. - - - - - Plane in X - Z direction. - - - - - 3D plane orientation for Y-axis. - - - - - Plane in X - Y direction. - - - - - Plane in Y - Z direction. - - - - - 3D plane orientation for Z-axis. - - - - - Plane in X - Z direction. - - - - - Plane in Y - Z direction. - - - - - Specifies a singular color destination of a point. - - - - - None of the colors. - - - - - Target is point's Color1 - - - - - Target is point's Color2 - - - - - Target is point's Color3 - - - - - Target is Border color of the point. - - - - - Point, double format. - - - - - Construct the point by using PointDoubleXY as source info. - - Source point - - - - Constructor. - - X value. - Y value. - - - - Object equals to PointDouble. - - Object. - True if object equals to PointDouble, otherwise false. - - - - Identity of two points. - - PointDouble a. - PointDouble b. - True if points are identical, otherwise false. - - - - Difference of two points. - - PointDouble a. - PointDouble b. - True if points are different, otherwise false. - - - - Convert class description to string. - - Class description as a string. - - - - X value. - - - - - Y value. - - - - - Point, double format. - - - - - Constructor. - - X. - Y. - - - - Constructor. - - X value. - Y value. - Tag, freely assignable object. - - - - Tag. Freely assignable object. - - - - - Convert class description to string. - - Class description as a string. - - - - X value. - - - - - Y value. - - - - - Point 3D as double coordinates. - - - - - Constructor. - - X-coordinate. - Y-coordinate. - Z-coordinate. - - - - Constructor. - - X-coordinate. - Y-coordinate. - Z-coordinate. - Tag. Freely assignable object. - - - - Tag. Freely assignable object. - - - - - Convert class description to string. - - Class description as a string. - - - - X-coordinate. - - - - - Y-coordinate. - - - - - Z-coordinate. - - - - - XY point. - - - - - Constructor - - - - - Constructor - - Parent. - X value. - Y value. - - - - Constructor - - X value. - Y value. - - - - Clean up any resources being used. - - True if managed resources should be disposed, otherwise false. - - - - Set all values. - - X value. - Y value. - - - - Convert class description to string. - - String. - - - - X value - - - - - Y value - - - - - XYZ point. - - - - - Constructor. - - - - - Constructor - - Parent. - X value. - Y value. - Z value. - - - - Constructor - - X value. - Y value. - Z value. - - - - Clean up any resources being used. - - True if managed resources should be disposed, otherwise false. - - - - Set all values. - - X value. - Y value. - Z value. - - - - Convert class description to string. - - String. - - - - X value - - - - - Y value - - - - - Z value - - - - - Point, float format. - - - - - Construct the point by using PointFloatXY as source info. - - Source point. - - - - Constructor. - - X value. - Y value. - - - - Object equals to PointFloat. - - Object. - True if object equals to PointFloat, otherwise false. - - - - Get Hash Code. - - - - - returns - M:Arction.Wpf.Charting.PointFloat.GetHashCode - - - - - - - Test if the value is zero or close to it. - - - - - param - AllowedVariance - M:Arction.Wpf.Charting.PointFloat.IsZero(System.Single) - - - - - - - returns - M:Arction.Wpf.Charting.PointFloat.IsZero(System.Single) - - - - - - - Create new NaN Point. - - - - - Summarize two points. - - PointFloat. - PointFloat. - Point with new coordinates. - - - - Summarize two points. - - PointFloat. - PointFloat. - Point with new coordinates. - - - - Summarize two points. - - PointFloat. - PointFloat. - Point with new coordinates. - - - - Increase point's coordinates by number. - - PointFloat. - Float value. - Point with new coordinates. - - - - Increase point's coordinates by number. - - Float value. - PointFloat. - Point with new coordinates. - - - - Divide two points. - - PointFloat. - PointFloat. - Point with new coordinates. - - - - Divide point's coordinates by number. - - PointFloat. - Float value. - Point with new coordinates. - - - - Divide point's coordinates by number. - - Float value. - PointFloat. - Point with new coordinates. - - - - Identity of two points. - - PointFloat a. - PointFloat b. - True if points are identical, otherwise false. - - - - Difference of two points. - - PointFloat a. - PointFloat b. - True if points are different, otherwise false. - - - - Multiply two points. - - PointFloat. - PointFloat. - Point with new coordinates. - - - - Multiply point's coordinates by number. - - PointFloat. - Float value. - Point with new coordinates. - - - - Multiply point's coordinates by number. - - Float value. - PointFloat. - Point with new coordinates. - - - - Subtraction of two points. - - PointFloat. - PointFloat. - Point with new coordinates. - - - - Subtraction of two points. - - PointFloat. - PointFloat. - Point with new coordinates. - - - - Subtraction of two points. - - PointFloat. - PointFloat. - Point with new coordinates. - - - - Decrease point's coordinates by number. - - PointFloat. - Float value. - Point with new coordinates. - - - - Decrease point's coordinates by number. - - Float value. - PointFloat. - Point with new coordinates. - - - - Convert class description to string. - - Class description as a string. - - - - X value. - - - - - Y value. - - - - - Create new Zero Point. - - - - - Point 3D, float format. - - - - - Constructor. - - X value. - Y value. - Z value. - Z - - - - Convert to Vector3. - - - - - param - point - M:Arction.Wpf.Charting.PointFloat3D.op_Implicit(Arction.Wpf.Charting.PointFloat3D)~SharpDX.Vector3 - - - - - - - returns - M:Arction.Wpf.Charting.PointFloat3D.op_Implicit(Arction.Wpf.Charting.PointFloat3D)~SharpDX.Vector3 - - - - - - - Convert class description to string. - - Class description as a string. - - - - X value. - - - - - Y value. - - - - - Z value. - - - - - XY point. - - - - - Constructor - - - - - Constructor - - Parent. - X value. - Y value. - - - - Constructor - - X value. - Y value. - - - - Clean up any resources being used. - - True if managed resources should be disposed, otherwise false. - - - - Set all values. - - X value. - Y value. - - - - Convert class description to string. - - String. - - - - X value - - - - - Y value - - - - - 3D point. - - - - - Constructor. - - - - - Constructor - - Parent. - X-coordinate. - Y-coordinate. - Z-coordinate. - - - - Constructor. - - X-coordinate. - Y-coordinate. - Z-coordinate. - - - - Clean up any resources being used. - - True if managed resources should be disposed, otherwise false. - - - - - - summary - M:Arction.Wpf.Charting.PointFloatXYZ.SetValues(System.Single,System.Single,System.Single) - - - - X value. - Y value. - Z value. - - - - Convert class description to string. - - String. - - - - X value - - - - - Y value - - - - - Z value - - - - - Point, integer format. - - - - - Constructor. - - X value. - Y value. - - - - Constructor for floats. Converts float parameters to integers. - - X value. - Y value. - - - - Transform PointFloat to PointInt. - - PointFloat to convert into PointInt. - Point with integer coordinates. - - - - Implicit converter from System.Drawing.Point to PointInt. - - Point to convert into PointInt. - New PointInt object with same X and Y values as the input. - - - - Convert class description to string. - - Class description as a string. - - - - X value. - - - - - Y value. - - - - - XY point, integer. - - - - - Constructor. - - - - - Constructor - - Parent. - X value. - Y value. - - - - Constructor. - - X value. - Y value. - - - - Clean up any resources being used. - - True if managed resources should be disposed, otherwise false. - - - - Set all values. - - X value. - Y value. - - - - Convert class description to string. - - String. - - - - X value - - - - - Y value - - - - - Polar point. - - - - - Constructor. Initializes Angle and Amplitude to zeroes. - - - - - Constructor for PointPolar. - - - - - param - owner - M:Arction.Wpf.Charting.PointPolar.#ctor(Arction.Wpf.Charting.IChartNode) - - - - - - - Constructor - - Angle in radians. - Amplitude. - Owner object. Defaults to null. - - - - Amplitude value - - - - - Angle value (degrees) - - - - - Clean up any resources being used. - - True if managed resources should be disposed, otherwise false. - - - - Set all values. - - Angle. - Amplitude. - - - - Value to string converter. Uses default double.ToString() formatting - for both values. - - Formatted string. - - - - Value to string converter. Uses given formatting - for both values. - - Double.ToString() formatting string to use - with both values. - Formatted string. - - - - RGB point. - - - - - Constructor. - - - - - Constructor - - Parent. - R-component. - G-component. - B-component. - - - - Constructor. - - R-coordinate. - G-coordinate. - B-coordinate. - - - - B value - - - - - Clean up any resources being used. - - True if managed resources should be disposed, otherwise false. - - - - G value - - - - - R value - - - - - Set all values. - - R value. - G value. - B value. - - - - Convert class description to string. - - String. - - - - Round chart point. - - - - - Constructor for PointRound. - - - - - Constructor - - Parent. - - - - Clean up any resources being used. - - True if managed resources should be disposed, otherwise false. - - - - X-coordinate on PointRound. - - - - - Y-coordinate on PointRound. - - - - - Set all values. - - X value. - Y value. - - - - Convert class description to string. - - String. - - - - Point shape 3D. - - - - - Box. - - - - - Sphere. - - - - - Cylinder. - - - - - Cone. - - - - - Torus. - - - - - Ellipsoid. - - - - - Shape style - - - - - Constructor for Form designer list editor - - - - - Constructor - - - Parent / Owner of the item. - The LightnignChart object this item will be placed at. - E.g, if this item is set to PointShape property of a - FreeFormPointLineSeries, the series is the parent of this item. - - - - Constructor. - - Parent. - Shape. - Color 1. - Color 2. - Color 3 (not used in all shapes). - Border color. - Border width. - Width. - Height. - Rotation angle in degrees. - Thickness of the shape. - Gradient fill type. - Bitmap image. - Linear gradient direction. - - - - Shape style. - - - - - typeparam - SHAPE - T:Arction.Wpf.Charting.PointShapeStyleBase`1 - - - - - - - Constructor for Form designer list editor - - - - - Constructor. - - Parent. - - - - Constructor - - Parent. - Shape. - Color 1. - Color 2. - Color 3 (not used in all shapes). - Border color. - Border width. - Width. - Height. - Rotation angle in degrees. - Thickness of the shape. - Gradient fill type. - Bitmap image. - Linear gradient direction. - - - - Point rotation angle in degrees. - - - - - Anti-aliased point. - Drawing anti-aliased draws the point with smooth edges, but will increase CPU/GPU overhead. - - - - - Bitmap alpha level. - - - - - Bitmap image, which is used when Shape is set to 'Bitmap'. - - - - - Bitmap image tint color. Keep it White to display it normally. - - - - - Body thickness. Applies to Cross and Flag and FlagLightning shapes. - - - - - Border color. - - - - - Border width. - - - - - Color 1. - - - - - Color 2. - - - - - Color 3. Not used in all shapes. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Gradient fill. - - - - - Height. - - - - - Gradient direction. - - - - - OnDeserialized is called just after the object has been deserialized. - - Context. - - - - Shape. Some fill options are not used on every shape kind. - - - - - Convert class description to string. - - String. - - - - Sets Width and Height properties from bitmap image dimensions. - - - - - Width. - - - - - Smith point. - - - - - PointSmith default constructor. - Object keeps state information of whether the object is at initial state, - and some properties use this information for special purposes. - - - - - PointSmith constructor. - - Owner">Owner element to notify of value changes. - - - - PointSmith constructor. - - Source point to take all values from. Parent is null. - - - - PointSmith copy constructor. - - Source point to take all values from, including parent. - - - - PointSmith constructor. - - RealValue part of the value. - Imaginary part of the value. - Owner">Owner element to notify of value changes. - - - - Clean up any resources being used. - - True if managed resources should be disposed, otherwise false. - - - - Imaginary component of the smith coordinate. - - - - - Real component of the smith coordinate. - - - - - Set all values. - - Real Value. - Imaginary Value. - - - - Value to string converter. Uses default double.ToString() formatting - for both values. - - - - - returns - M:Arction.Wpf.Charting.PointSmith.ToString - - - - - - - Value to string converter. Uses given formatting - for both values. - - Double.ToString() formatting string to use - with both values. - - - - returns - M:Arction.Wpf.Charting.PointSmith.ToString(System.String) - - - - - - - Points rendering optimization. - - - - - No optimization, use point style. - - - - - Render points as pixels (1x1 points), to gain improvement in performance. - - - - - Render points as pixels, best performance gain for large data sets. - - - - - Points rendering optimization for 3D PointLineSeries. - - - - - No optimization, use point style. - - - - - Render points as pixels (1x1 points), to gain improvement in performance. - - - - - Points type. - - - - - X-Y points. - - - - - X-Y points with error tolerance indicator. - - - - - Points type, 3D. - - - - - Points. - - - - - Compact points, to save memory. This Type does not have Color field, therefore, IndividualPointColors property should be disabled. Not applicable with fully bindable chart. - - - - - Colored compact points, to save memory. Not applicable with fully bindable chart. - - - - - UnitCircle coordinate point. - X and Y coordinates have normed values in range [-1,1]. Point (0,0) - points is at the center of the circle. - - - - - Constructor for Form designer list editor - - - - - param - owner - M:Arction.Wpf.Charting.PointUnitCircle.#ctor(Arction.Wpf.Charting.IChartNode) - - - - - - - Constructor - - X coordinate - Y coordinate - Owner object. Defaults to null. - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Set all values, except owner. - - Source point to take values from. - - - - Set all values. - - X coordinate - Y coordinate - - - - Value to string converter. Uses default double.ToString() formatting - for both values. - - Formatted string - - - - Value to string converter. Uses given formatting - for both values. - - Double.ToString() formatting string to use - with both values. - Formatted string - - - - X direction coordinate - - - - - Y direction coordinate - - - - - Wheel action on polar circumference. - - - - - No action. - - - - - Rotate single axis. - - - - - Rotate all axes. - - - - - Polar line coloring style. - - - - - Colored by color from line style. - - - - - Paletted by Angle, various colors set by the palette, applied over base color. - - - - - Paletted by Amplitude, various colors set by the palette, applied over base color. - - - - - Paletted by Value, various colors set by the palette, applied over base color. - - - - - Polar legend box items categorization. - - - - - No categorization. - - - - - Categorization by axes. - - - - - Categorization by series type. - - - - - Polar series point. - - - - - Constructor. - - Angle, in degrees. - Amplitude. - - - - Constructor. - - Angle, in degrees. - Amplitude. - Tag. Freely assignable object. - - - - Constructor. - - Angle, in degrees. - Amplitude. - Tag. Freely assignable object. - Color of the point. - - - - Constructor. - - Angle, in degrees. - Amplitude. - Value. - - - - Constructor. - - Angle, in degrees. - Amplitude. - Value. - Tag. Freely assignable object. - - - - Constructor. - - Angle, in degrees. - Amplitude. - Value. - Tag. Freely assignable object. - Color of the point. - - - - Constructor. - - Angle, in degrees. - Amplitude. - Value. - Color of the point. - - - - Constructor. - - Angle, in degrees. - Amplitude. - Color of the point. - - - - Amplitude. - - - - - Angle (degrees). - - - - - Color of the point. - This is used only if the series PointStyles IndividiualPointColor is not set to Off. - - - - - Tag. Freely assignable object. - - - - - Convert class description to string. - - Class description as a string. - - - - Value (float). - - - - - Point, Polygon3D format (x,z). - - - - - Constructor. - - X value. - Z value. - - - - Constructor. - - X value. - Z value. - Tag. Freely assignable object. - - - - Tag. Freely assignable object. - - - - - Convert class description to string. - - Class description as a string. - - - - X value. - - - - - Z value. - - - - - Polygon title horizontal alignment. - - - - - Align left. - - - - - Align center. - - - - - Align to center of gravity. - - - - - Align right. - - - - - Polygon title vertical alignment. - - - - - Align top. - - - - - Align center. - - - - - Align to center of gravity. - - - - - Align bottom. - - - - - Predefined camera for 3D view. - - - - - Default perspective camera, located in front of the model, and having some sideways offset. - - - - - Orthographic camera, located in positive Y space and targeting down in the center of the 3D model. - X dimension vertically, Z dimension horizontally. - - - - - Orthographic camera, located in positive Y space and targeting down in the center of the 3D model. Z dimension vertically, X dimension horizontally. - - - - - Orthographic camera, located in negative Y space and targeting down in the center of the 3D model. - X dimension vertically, Z dimension horizontally. - - - - - Orthographic camera, located in negative Y space and targeting down in the center of the 3D model. Z dimension vertically, X dimension horizontally. - - - - - Orthographic camera, located in negative Z space and targeting towards the center of the 3D model. Y dimension vertically, X dimension horizontally. - - - - - Orthographic camera, located in positive Z space and targeting towards the center of the 3D model. Y dimension vertically, X dimension horizontally. - - - - - Orthographic camera, located in negative X space and targeting towards the center of the 3D model. Y dimension vertically, Z dimension horizontally. - - - - - Orthographic camera, located in positive X space and targeting towards the center of the 3D model. Y dimension vertically, Z dimension horizontally. - - - - - Perspective camera, located in positive Y space and targeting down in the center of the 3D model. - X dimension vertically, Z dimension horizontally. - - - - - Perspective camera, located in positive Y space and targeting down in the center of the 3D model. Z dimension vertically, X dimension horizontally. - - - - - Perspective camera, located in negative Y space and targeting down in the center of the 3D model. - X dimension vertically, Z dimension horizontally. - - - - - Perspective camera, located in negative Y space and targeting down in the center of the 3D model. Z dimension vertically, X dimension horizontally. - - - - - Perspective camera, located in negative Z space and targeting towards the center of the 3D model. Y dimension vertically, X dimension horizontally. - - - - - Perspective camera, located in positive Z space and targeting towards the center of the 3D model. Y dimension vertically, X dimension horizontally. - - - - - Perspective camera, located in negative X space and targeting towards the center of the 3D model. Y dimension vertically, Z dimension horizontally. - - - - - Perspective camera, located in positive X space and targeting towards the center of the 3D model. Y dimension vertically, Z dimension horizontally. - - - - - Perspective camera for 3D pie. - - - - - Orthographic top camera. - - - - - Projection types for 3D camera. - - - - - Orthographic projection. - - - - - Orthographic projection with dimensions scaling. - Works the same way as OrthographicCamera property worked in LightningChart v8.3 and previous versions. - Slower zooming than Orthographic ProjectionType. - - - - - Perspective projection. - - - - - Range for Generic Types. - - - - - typeparam - T - T:Arction.Wpf.Charting.Range`1 - - - - - - - Constructor - - - - - Constructor. - - Parent. - Minimum-coordinate. - Maximum-coordinate. - - - - Constructor. - Minimum-coordinate.Maximum-coordinate. - - - - param - min - M:Arction.Wpf.Charting.Range`1.#ctor(`0,`0) - - - - - - - param - max - M:Arction.Wpf.Charting.Range`1.#ctor(`0,`0) - - - - - - - Clean up any resources being used. - - True if managed resources should be disposed, otherwise false. - - - - Max value - - - - - Min value - - - - - Set all values. - - Minimum-coordinate. - Maximum-coordinate. - - - - Convert class description to string. - - String. - - - - Axis range at Zoomed event. - - - - - Axis. - - - - - New maximum value. - - - - - New minimum value. - - - - - Old maximum value. - - - - - Old minimum value. - - - - - Axis range information. - - - - - Axis. - - - - - Current maximum value. - - - - - Current minimum value. - - - - - Range for PointInt. - - - - - Range of PointRGB - - - - - Range of PointRGB - - - - - param - owner - M:Arction.Wpf.Charting.RangeInt.#ctor(Arction.Wpf.Charting.IChartNode,System.Int32,System.Int32) - - - - - - - param - min - M:Arction.Wpf.Charting.RangeInt.#ctor(Arction.Wpf.Charting.IChartNode,System.Int32,System.Int32) - - - - - - - param - max - M:Arction.Wpf.Charting.RangeInt.#ctor(Arction.Wpf.Charting.IChartNode,System.Int32,System.Int32) - - - - - - - Range of PointRGB - - - - - param - min - M:Arction.Wpf.Charting.RangeInt.#ctor(System.Int32,System.Int32) - - - - - - - param - max - M:Arction.Wpf.Charting.RangeInt.#ctor(System.Int32,System.Int32) - - - - - - - Range for PointRGB. - - - - - Range of PointRGB - - - - - Range of PointRGB - - - - - param - owner - M:Arction.Wpf.Charting.RangeRGB.#ctor(Arction.Wpf.Charting.IChartNode,Arction.Wpf.Charting.PointRGB,Arction.Wpf.Charting.PointRGB) - - - - - - - param - min - M:Arction.Wpf.Charting.RangeRGB.#ctor(Arction.Wpf.Charting.IChartNode,Arction.Wpf.Charting.PointRGB,Arction.Wpf.Charting.PointRGB) - - - - - - - param - max - M:Arction.Wpf.Charting.RangeRGB.#ctor(Arction.Wpf.Charting.IChartNode,Arction.Wpf.Charting.PointRGB,Arction.Wpf.Charting.PointRGB) - - - - - - - Range of PointRGB - - - - - param - min - M:Arction.Wpf.Charting.RangeRGB.#ctor(Arction.Wpf.Charting.PointRGB,Arction.Wpf.Charting.PointRGB) - - - - - - - param - max - M:Arction.Wpf.Charting.RangeRGB.#ctor(Arction.Wpf.Charting.PointRGB,Arction.Wpf.Charting.PointRGB) - - - - - - - Range for PointDoubleXYZ. - - - - - Range of PointFloatXYZ - - - - - Range of PointDoubleXYZ - - - - - param - owner - M:Arction.Wpf.Charting.RangeXYZ.#ctor(Arction.Wpf.Charting.IChartNode,Arction.Wpf.Charting.PointDoubleXYZ,Arction.Wpf.Charting.PointDoubleXYZ) - - - - - - - param - min - M:Arction.Wpf.Charting.RangeXYZ.#ctor(Arction.Wpf.Charting.IChartNode,Arction.Wpf.Charting.PointDoubleXYZ,Arction.Wpf.Charting.PointDoubleXYZ) - - - - - - - param - max - M:Arction.Wpf.Charting.RangeXYZ.#ctor(Arction.Wpf.Charting.IChartNode,Arction.Wpf.Charting.PointDoubleXYZ,Arction.Wpf.Charting.PointDoubleXYZ) - - - - - - - Range of PointDoubleXYZ - - - - - param - min - M:Arction.Wpf.Charting.RangeXYZ.#ctor(Arction.Wpf.Charting.PointDoubleXYZ,Arction.Wpf.Charting.PointDoubleXYZ) - - - - - - - param - max - M:Arction.Wpf.Charting.RangeXYZ.#ctor(Arction.Wpf.Charting.PointDoubleXYZ,Arction.Wpf.Charting.PointDoubleXYZ) - - - - - - - Ray Function specifier - - - - - Accumulation function combines the data from entire dataset and - provides an opportunity to control the opacity of the model. - - - - - Isosurface rendering extracts normals from the dataset according to - threshold settings and visualize the surface of desirable tissue. - - - - - MaximalIntensity rendering shows the most bright structures inside the dataset. - - - - - Rectangle in XY coordinate system. - - - - - Constructor - - Location x coordinate - Location y coordinate - Width - Height - - - - Height. - - - - - Tells if the rectangle is empty. - - - - - Width. - - - - - Top left X-coordinate. - - - - - Top left Y-coordinate. - - - - - Rectangle in XY coordinate system for floats. - - - - - Constructor - - Location x coordinate - Location y coordinate - Width - Height - - - - Height. - - - - - Tells if the rectangle is empty. - - - - - Width. - - - - - Top left x-coordinate. - - - - - Top left y-coordinate. - - - - - Rectangle zooming mode, which tells how axis ranges (Minimum and Maximum on X and Y axes) are updated by rectangle zooming operation. - - - - - Zooms on X-axis range. Y-axis range remain as is. - - - - - Zooms on Y-axis range. X-axis range remain as is. - - - - - Zooms on X and Y-axis. - - - - - Zooms on X-axis, around X-axis ZoomOrigin value. Y-axis range will be set by mouse start and end coordinates. - - - - - Zooms on Y-axis, around Y-axis ZoomOrigin value. X-axis range will be set by mouse start and end coordinates. - - - - - Zooms on both X and Y-axis about axes ZoomOrigin values. - - - - - Rectangle fill style. - - - - - No fill. - - - - - Color, gradient or solid. - - - - - Bitmap is drawn op top of the gradient color. - - - - - Gradient color is drawn on top of the Bitmap. - - - - - Regression type. - - - - - No regression. - - - - - Line fit. - - - - - Polynomial fit. - - - - - Render device info structure. - - - - - Active objects. - - - - - All GPUs installed in the system. - - - - - True if anti-aliasing is supported. - - - - - Is the device created. If false, the other fields of this structure are not valid. - - - - - True if D2D v1.1 is supported, false if not. - The v1.1 is required for HW text rendering on DX11. - On DX9 this is always false. - - - - - - - summary - F:Arction.Wpf.Charting.RenderDeviceInfo.D3DImageUsed - - - - - - - Adapter Description. - - - - - True if software is DPI aware. - - - - - DPI in X direction. - - - - - DPI Factor in X direction. - - - - - DPI in Y direction. - - - - - DPI Factor in Y direction. - - - - - Rendering engine name. - - - - - Rendering engine name (short). - - - - - True if your graphics adapter supports fast vertex format. - Fast vertices are not available for old graphics adapters. - If false, the rendering performance is not optimal, since - slower vertex formats must be used. - Getting a new graphics adapter is strongly recommended, - ensure it is at least DirectX 10 level, for best performance. - - - - - True if your graphics adapter supports vertex processing in hardware (GPU). - If false, the vertex calculation has to be done in software (computer CPU), - and the performance is not optimal. - - - - - Maximum index buffer size. - - - - - True if 32-bit index buffers are supported. - If only 16-index buffers are supported, returns false. In this case the 3D surfaces may be limited into smaller sizes. - - - - - Anti Alias Level. - - - - - Memory on the graphics card (if information is available). - - - - - True if optimal pure device mode is supported. - - - - - Current renderer device type. - - - - - Current renderer device type. - - - - - True if shader model 3 is supported. Both vertex and pixel shaders are format 3 or greater. - - - - - Maximum texture height. - - - - - Maximum texture width. - - - - - Limited support for textures which size is not power of two. - - - - - Convert structure contents into string. - - Structure contents as a string. - - - - GPU chip manufacturer ID. - - - - - Rendering device type. - - - - - Automatic order suggested by LightningChart, which, in general, should produce the - best results. Value can change based on current status of different engines. - - - - - Automatic order, preferring DX9 over DX11. - - - - - Automatic order, preferring DX11 over DX9. - DX11 looks better and is faster than DX9 on many occasions. - - - - - Force hardware rendering for D9 device. - - - - - Force software rendering for D9 device. - - - - - Force hardware rendering for D11 device. - - - - - Force software rendering for D11 device. - - - - - Defines that no engine is used or not to be used. - This can be used to fully disable rendering on LightningChart, and thus save (free) resources required by the rendering system. - After setting this as DeviceType, it might be useful to call GC.Collect() on some occasions. - - - - - Rendering settings, that can be given as chart constructor parameter to set the creation time parameters. - Speeds up creating of the chart, if non-default values are given, preventing the chart rendering engine to be re-created several times. - Note that the values are only read once after the chart is created, and changing them later has no effect. - To change values after chart has been created, use Charts ChartRenderOptions property on WPF, or RenderOptions property on WinForms, both of type This object can be shared between multiple charts. - - - - Constructor for Form designer list editor. - - - - - Anti-aliasing factor. 1 = no anti-aliasing. - The larger the value, the smoother the image will be, but at steep cost of performance on some display adapters. - Only objects having AntiAlias property will be anti-aliased, if it's set to 'Normal'. - - - - - Delegate to register to the ChartMessage event. Initialized this way the chart error event is launched even before the object has been fully constructed. - Intended primarily as debug measure for cases when LC crashes on constructor and we need more information on why it happens. - - - - Temporary debug setting for disabling D2D system and text rendering on DX11. - - - - - Default rendering device engine to use. Defaults to Auto. - - - - - Identifies that we do not actually have a graphical interface. This is true for instance for services or - console applications. This can also be used if the chart is intended to run on background without an actual interface. - - - - - Wait for next refresh, V-Sync. - If the computer is fast enough, disabling this can give higher refresh rate than the screen refresh rate is. - By disabling this, rendering does not wait next screen refresh turn. - Enabling this may improve performance especially in slow computers. - - - - - Right-to-left zoom action. - - - - - Disabled. - - - - - Rectangle zoom in, like from zooming left to right. - - - - - Zoom out, by given factor. - - - - - Right-to-left zoom action. - - - - - Disabled. - - - - - Zoom to show all data, does not take graph or labels into account. - - - - - Zooming based on the default zoom and centering settings. - Resets ZoomScale and ZoomCenter properties to default values. - - - - - Zooming based on LabelsArea, showing the graph and the labels, ignores data outside the graph. - - - - - Rectangle zoom in, like from zooming left to right. - - - - - Zoom out, by given factor. - - - - - Zoom to previous level. - - - - - Right-to-left zoom action. - - - - - Disabled. - - - - - FitView. - - - - - Rectangle zoom in, like from zooming left to right. - - - - - Zoom out, by given factor. - - - - - Reverts to specified axis Revert range values. - - - - - Zoom to previous level. - - - - - Round grid mark location in relation to circle. - - - - - Tick mark is outside circle. - - - - - Tick mark is inside circle. - - - - - Sample data line series sample storage format. - - - - - Single floating point number. Use this to save memory. - - - - - Double floating point number. Use this for better accuracy. - - - - - Settings for Volume Model Sampling Rate Manager. - - - - - Constructor - - - - - Constructor - - Parent. - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Enable sampling rate - - - - - Inertness rate for the sampling rate - - - - - Enable sampling rate - - - - - Settings for minimal and maximal sampling rate of the volume model - - - - - Target FPS of the Volume rendering visualisation - - - - - Convert class description to string. - - String. - - - - Scale multiple flags. - - - - - Allow values that are 2-based, like 2, 0.2, 0.02... - - - - - Allow values that are 5-based, like 5, 0.5, 0.05... - - - - - Axis scale type. - - - - - Linear scale. - - - - - Logarithmic scale. - - - - - Vertical scroll bar. - Values use unsigned 64-bit integer value range. - - - - - Constructor for form editor list editor - - - - - Constructor - - Parent. - - - - Background fill - - - - - Border around the bar - - - - - Button options - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Is scrollbar enabled or not - - - - - Is mouse over item. - - mouse x-coordinate - mouse y-coordinate - Use DIP instead of pixels as parameters - true if mouse is over item, false otherwise - - - - Is scrollbar listening to key presses or not - - - - - Key control focus rectangle line style. - - - - - Large change - - - - - Maximum value - - - - - Minimum value - - - - - Offset from position set by Alignment property - - - - - Repeat interval when user interactive device primary button is kept down, in milliseconds - - - - - Occurs when the scroll bar thumb has been moved. - - - - - Scroll box options - - - - - Size. - - - - - Small change - - - - - Value - - - - - Occurs when the Value property has been changed. - - - - - User interactive device wheel change. Increment or decrement when wheel has scrolled over the scroll bar. - - - - - Is scrollbar visible or not - - - - - The delegate to use for handlers that receive the Scroll event. - - The object that raised the event. - Provides data for the Scroll event. - - - - Scroll bar scrolling type. - - - - - Small decrement. - - - - - Small increment. - - - - - Large decrement. - - - - - Large increment. - - - - - Scroll box is dragged. - - - - - Device wheel has been scrolled down. - - - - - Device wheel has been scrolled up. - - - - - Scroll button options - - - - - Constructor for Form designer list editor - - - - - Constructor - - - - - param - owner - M:Arction.Wpf.Charting.ScrollButtonOptions.#ctor(Arction.Wpf.Charting.ScrollBarBase) - - - - - - - Automatically size the scroll buttons. Width and height are set to match bar height. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Arrow icons inside button. - The definition applies to Right button. Left button icon is drawn rotated by 180 degrees. - - - - - OnDeserialized is called just after the object has been deserialized. - - Context. - - - - Width - - - - - Scroll bar button style. - - - - - Rectangular shape. - - - - - Oval shape - - - - - Represents a class that provides arguments for the Scroll event. - - - - - Creates and initializes a new instance of ScrollEventArgs class. - - - - - The new value. - - - - - The old value. - - - - - Identifies what kind of scrolling occurred. - - - - - Represents a scroll bar thumb. - - - - - Default constructor. - - - - - Constructor. - - - - - param - owner - M:Arction.Wpf.Charting.ScrollThumbOptions.#ctor(Arction.Wpf.Charting.ScrollBarBase) - - - - - - - Automatically size the scroll buttons. Height is set to match bar height. - - - - - Border color - - - - - Border width - - - - - Color 1 - - - - - Color 2 - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Gradient fill - - - - - Height in pixels. - - - - - Gradient direction - - - - - OnDeserialized is called just after the object has been deserialized. - - Context. - - - - Button style - - - - - Line segment from A to B. - - - - - Constructor. - - Point A, X value. - Point A, Y value. - Point B, X value. - Point B, Y value. - - - - Constructor. - - Point A, X value. - Point A, Y value. - Point B, X value. - Point B, Y value. - Tag, freely assignable object. - - - - Point A, X value. - - - - - Point A, Y value. - - - - - Point B, X value. - - - - - Point B, Y value. - - - - - Tag. Freely assignable object. - - - - - Convert class description to string. - - Class description as a string. - - - - CSV file export separator. - - - - - Use comma as value separator, and point as decimal separator. - - - - - Use semicolon as value separator, and comma as decimal separator. - - - - - Decimal separator is detected from system settings. - If it's comma, a semicolon is used as value separator. Else a comma is used as value separator. - - - - - Series point with error tolerance. - - - - - Constructor, with error bar values set to 0. - - X value. - Y value. - - - - Constructor. - - X value. - Y value. - Error bar X, to negative direction. - Error bar X, to positive direction. - Error bar Y, to negative direction. - Error bar Y, to positive direction. - - - - Constructor. - - X value. - Y value. - Error bar X, to negative direction. - Error bar X, to positive direction. - Error bar Y, to negative direction. - Error bar Y, to positive direction. - Tag, freely assignable object. - - - - Constructor. - - X value. - Y value. - Error bar X, to negative direction. - Error bar X, to positive direction. - Error bar Y, to negative direction. - Error bar Y, to positive direction. - Tag, freely assignable object. - Color of the point. For more information see Color property. - - - - Constructor. - - X value. - Y value - Error bar X, to negative direction. - Error bar X, to positive direction. - Error bar Y, to negative direction. - Error bar Y, to positive direction. - Color of the point. For more information see Color property. - - - - Constructor, with error bar values set to 0. - - X value. - Y value. - Tag, freely assignable object. - - - - Constructor, with error bar values set to 0. - - X value. - Y value. - Tag, freely assignable object. - Color of the point. For more information see Color property. - - - - Constructor, with error bar values set to 0. - - X value. - Y value. - Color of the point. For more information see Color property. - - - - X amount to X-axis reverse direction - - - - - X amount to X-axis positive direction. - - - - - Y amount to Y-axis reverse direction. - - - - - Y amount to Y-axis positive direction. - - - - - Color of the point. - This is used only if the series PointStyles IndividiualPointColor is not set to Off. - - - - - Tag. Freely assignable object. - - - - - Convert class description to string. - - Class description as a string. - - - - X value. - - - - - Y value. - - - - - Series event marker horizontal position. - - - - - Snap to nearest data point. - - - - - Position at given X value (series value, not coordinate). - - - - - Series event marker vertical position. - - - - - Track the series. The Y value is solved from X value. You can use this only for series implementing ITrackable interface or with FreeformPointLineSeries. - Not applicable in X-axis scrolling modes Scrolling, Stepping, Sweeping (monitoring modes). - The resolver data is not valid for performance reasons. You should insert a marker - as AtYValue in monitoring mode and convert it as TrackSeries when entering data review mode. - Works only on series implementing ITrackable or with FreeformPointLineSeries. - - - - Position at given Y value (series value, not coordinate). - - - - - Position at zero level. - - - - - Position at Y-axis top. - - - - - Position at Y-axis center. - - - - - Position at Y-axis bottom. - - - - - Point shape for XY series event markers. - - - - - Hollow Basic Active. - - - - - Hollow Basic. - - - - - Hollow Harmonic. - - - - - Active Sideband Cursor. - - - - - Sideband Cursor. - - - - - Hollow Tailed Active. - - - - - Hollow Tailed. - - - - - Rectangle. - - - - - Triangle. - - - - - Circle. - - - - - Flag. - - - - - Flag with lightning bolt. - - - - - Cross. - - - - - Aiming cross. - - - - - Bitmap graphics. - - - - - Hollow Y-axis shape with Cursor. - - - - - Hollow active Y-axis shape with Cursor. - - - - - Shape style for SeriesEventMarkers. - - - - - Constructor for Form designer list editor. - - - - - Constructor - - Parent. - - - - Constructor - - Parent. - Shape. - Color 1. - Color 2. - Color 3 (not used in all shapes). - Border color. - Border width. - Width. - Height. - Rotation angle in degrees. - Thickness of the shape. - Gradient fill type. - Bitmap image. - Linear gradient direction. - - - - Series point. - - - - - Constructor. - - X value. - Y value. - - - - Constructor. - - X value. - Y value. - Tag, freely assignable object. - - - - Constructor. - - X value. - Y value. - Tag, freely assignable object. - Color of the point. For more information see Color property. - - - - Constructor. - - X value. - Y value. - Color of the point. For more information see Color property. - - - - Color of the point. - This is used only if the series PointStyles IndividiualPointColor is not set to Off. - - - - - Tag. Freely assignable object. - - - - - Convert class description to string. - - Class description as a string. - - - - X value. - - - - - Y value. - - - - - PointLineSeries3D series point. - - - - - Constructor. - - X-coordinate. - Y-coordinate. - Z-coordinate. - - - - Constructor. - - X-coordinate. - Y-coordinate. - Z-coordinate. - Color of the point. - - - - Constructor. - - X-coordinate. - Y-coordinate. - Z-coordinate. - Color of the point. - Point size factor. - - - - Constructor. - - X-coordinate. - Y-coordinate. - Z-coordinate. - Color of the point. - Point size factor. - Object assigned to point. - - - - Color. - - - - - Size factor. - - - - - Tag. Freely assignable object. - - - - - X value. - - - - - Y value. - - - - - Z value. - - - - - PointLineSeries3D series point, compact format to save memory. - - - - - Constructor. - - X value. - Y value. - Z value. - - - - X value. - - - - - Y value. - - - - - Z value. - - - - - PointLineSeries3D series point with color, compact format to save memory. - - - - - Constructor. - - X value. - Y value. - Z value. - Color of the point. - - - - Color as integer. - - - - - X value. - - - - - Y value. - - - - - Z value. - - - - - Shade mode. - - - - - Flat shading, lighting does not affect coloring. - - - - - Gouraud shading, lighting does affect coloring. - - - - - Shadow class shows a shadow behind it's master object - - - - - Constructor for Form designer list editor. - - - - - Constructor - - Parent. - - - - Color - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Shadow offset from the object - - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Convert class description to string. - - String - - - - Is shadow visible or not - - - - - Point shape. - - - - - Hollow Basic Active. - - - - - Hollow Basic. - - - - - Hollow Harmonic. - - - - - Active Sideband Cursor. - - - - - Sideband Cursor. - - - - - Hollow Tailed Active. - - - - - Hollow Tailed. - - - - - Rectangle. - - - - - Triangle. - - - - - Circle. - - - - - Flag. - - - - - Flag with lightning bolt. - - - - - Cross. - - - - - Aiming cross. - - - - - Bitmap graphics. - - - - - Shape type. Used with 3D PointLineSeries. - - - - - Use 2D shapes. - - - - - Use 3D shapes. - - - - - Extensions methods. - - - - - Converts an enum type value to string reading its description attribute. - - Value to be converted to string - Generic type - Description attribute of the enum value - - - - Shared FontStyle enumeration. - - - - - Normal. - - - - - Oblique, which is like Italic. - - - - - Italic. - - - - - Shared FontWeight enumeration. - - - - - Weight is 100. - - - - - Weight is 200. - - - - - Weight is 200. - - - - - Weight is 300. - - - - - Weight is 350. - - - - - Weight is 400. - - - - - Weight is 400. - - - - - Weight is 500. - - - - - Weight is 600. - - - - - Weight is 600. - - - - - Weight is 700. - - - - - Weight is 800. - - - - - Weight is 800. - - - - - Weight is 900. - - - - - Weight is 900. - - - - - Weight is 950. - - - - - Weight is 950. - - - - - 2D size. - - - - - Constructor. - - - - - Constructor. - - Parent. - Width. - Height. - - - - Constructor. - - Width. - Height. - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Height - - - - - Set width and height values. - - Width. - Height. - - - - Convert class description to string. - - Class description as string. - - - - Width - - - - - 3D size. - - - - - Constructor. - - - - - Constructor. - - Parent. - Width. - Height. - Depth. - - - - Constructor. - - Width. - Height. - Depth. - - - - Depth - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Height - - - - - Set width and height values. - - Width. - Height. - Depth. - - - - Convert class description to string. - - Class description as string. - - - - Width - - - - - Size, float format. - - - - - Construct from SizeFloatXY type. - - Size. - - - - Constructor. - - Width. - Height. - - - - Height. - - - - - Convert class description to string. - - Class description as a string. - - - - Width. - - - - - 2D size. - - - - - Constructor. - - - - - Constructor. - - Parent. - Width. - Height. - - - - Constructor. - - Width. - Height. - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Height - - - - - Set width and height values. - - Width. - Height. - - - - Convert class description to string. - - Class description as string. - - - - Width - - - - - 3D size. - - - - - Constructor. - - - - - Constructor. - - Parent. - Width. - Height. - Depth. - - - - Constructor. - - Width. - Height. - Depth. - - - - Depth - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Height - - - - - Set width, height and depth values. - - Width. - Height. - Depth. - - - - Convert class description to string. - - Class description as string. - - - - Width - - - - - Size, int format. - - - - - Constructor. - - Width. - Height. - - - - Height. - - - - - Convert class description to string. - - Class description as a string. - - - - Width. - - - - - Smith series point. - - - - - Constructor. - - Real component. - Imaginary component. - - - - Constructor. - - Real component. - Imaginary component. - Tag. Freely assignable object. - - - - Imaginary component of the smith coordinate. - - - - - Real component of the smith coordinate. - - - - - Tag. Freely assignable object. - - - - - Convert class description to string. - - Class description as a string. - - - - Static X Grid - - - - - Constructor for Form designer list editor. - - - - - Constructor. - - Parent. - - - - Is the grid behind or in front - - - - - Division count (grid line count - 1) - - - - - Convert class description to string. - - Class description as string. - - - - Stock series data for one day. - - - - - Constructor. - - Open. - Close. - High. - Low. - Transaction. - Volume. - X axis value, date. - - - - Constructor. - - Open. - Close. - High. - Low. - Transaction. - Volume. - X axis value, date. - Tag. Freely assignable object. - - - - Constructor. - - Year. - Month. - Day. - Open. - Close. - High. - Low. - Volume. - Transaction. - - - - Constructor. - - Year. - Month. - Day. - Open. - Close. - High. - Low. - Volume. - Transaction. - Tag. Freely assignable object. - - - - Close. - - - - - X value, date. - - - - - Check if referenced object is equal to this one. - - - - - param - obj - M:Arction.Wpf.Charting.StockSeriesData.Equals(System.Object) - - - - - - - returns - M:Arction.Wpf.Charting.StockSeriesData.Equals(System.Object) - - - - - - - High. - - - - - Low. - - - - - Open. - - - - - Tag. Freely assignable object. - - - - - Convert class description to string. - - Class description as a string. - - - - Transaction, sum of share prices paid. - - - - - Volume, count of shares traded. - - - - - StockSeries packing state. - - - - - Packing is enabled. - - - - - Packing is disabled. - - - - - Stock style. - - - - - CandleStick. - - - - - Optimized CandleStick, only solid or left-to-right linear fill available. - - - - - Bars. - - - - - Surface series fill style. - - - - - No fill. - - - - - Coloring is made from surface data point array colors. - - - - - Single color tone applied over base color. - - - - - Paletted by Y (height), various colors set by the palette, applied over base color. - - - - - Paletted by Value field, various colors set by the palette. - - - - - Fill with bitmap. - - - - - 3D surface legend box title position. - - - - - Left. - - - - - Top. - - - - - 3D Surface performance optimization. - - - - - Optimize surface to give better performance with data changing frequently. - - - - - Optimize surface to give better performance with data that is not changed frequently. - - - - - 3D Surface series data point. - - - - - Constructor. - - X-coordinate. - Y-coordinate. - Z-coordinate. - Value. - Color of the point. - - - - Constructor. - - X-coordinate. - Y-coordinate. - Z-coordinate. - Value. - Color of the point. - Tag. Freely assignable object. - - - - Constructor. - - X-coordinate. - Y-coordinate. - Z-coordinate. - Color of the point. - - - - Constructor. - - X-coordinate. - Y-coordinate. - Z-coordinate. - Color of the point. - Tag. Freely assignable object. - - - - Color. - - - - - Tag. Freely assignable object. - - - - - Convert class description to string. - - Class description as a string. - - - - Value field. - - - - - X-coordinate. - - - - - Y-coordinate. - - - - - Z-coordinate. - - - - - Surface series rendering order. - - - - - Render before PointLineSeries. - - - - - Render after PointLineSeries. - - - - - Surface series wireframe type. - - - - - No wireframe. - - - - - Wireframe mesh, solid color. - - - - - Wireframe mesh, paletted color by Value. - - - - - Source data point colored. - - - - - Dots. - - - - - Dots, paletted. - - - - - Dots, source data point colored. - - - - - Surface series 3D wireframe type. - - - - - No wireframe. - - - - - Wireframe mesh, solid color. - - - - - Wireframe mesh, paletted color by Y. - - - - - Source data point colored. - - - - - Wireframe mesh, paletted color by Value. - - - - - Dots. - - - - - Dots, paletted by Y. - - - - - Dots, source data point colored. - - - - - Dots, paletted by Value. - - - - - Contains information about the users system. - - - - - Available ram in the system. - - - - - System local culture information. - - - - - GC Finalization Survivors. - - - - - Gathers gargabe collector statistics. - - - - - Gathers system information. - - Sets whether GC information is collected. - Collection is really slow, can take even seconds, so shouldn't be collected on exceptions! - - - - GC Gen 0 Heap Size. - - - - - GC Gen 1 Heap Size. - - - - - GC Gen 2 Heap Size. - - - - - Is current system 64 bit. - - - - - .NET Framework version of the application - - - - - Current operating system. - - - - - Returns struct values as a string. - - Struct values as a string. - - - - Amount of ram used by the process. - - - - - 3D annotation target crosshair style. - - - - - Show/hide automatically. - - - - - Show always. - - - - - Don't show. - - - - - Target image format. - - - - - Windows bitmap, raster format. - - - - - Portable network graphics, raster format. - - - - - JPG, JPEG, raster format. - - - - - Tagged image format file, raster format. - - - - - Graphic interchange format, raster format. - - - - - Enhanced metafile, vector format. - - - - - Scalable vector grapics, vector format. - - - - - Windows metafile, vector format. - - - - - TextShadow class shows a shadow behind it's master text. - - - - - Constructor for Form designer list editor. - - - - - Constructor. - - Parent. - - - - High-contrast shadow color - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Color - - - - - Drop-shadow offset from the object - - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Text shadow style - - - - - Convert class description to string. - - Class description as a string. - - - - Text shadow style. - - - - - No shadow. - - - - - Drop shadow with offset control. - - - - - High-contrast shading all around the text. - - - - - Texture wrapping. Descriptions copied from MSDN: https://msdn.microsoft.com/en-us/library/windows/desktop/bb322814(v=vs.85).aspx - - - - - Tiles the texture at every integer junction. For example, for u values between 0 and 3, the texture is repeated three times. No mirroring is performed. - - - - - Similar to Wrap, except that the texture is flipped at every integer junction. For u values between 0 and 1, for example, the texture is addressed normally; between 1 and 2, the texture is flipped (mirrored); between 2 and 3, the texture is normal again, and so on. - - - - - Texture coordinates outside the range [0.0, 1.0] are set to the texture color at 0.0 or 1.0, respectively. - - - - - Texture coordinates outside the range [0.0, 1.0] are set to the border color. - - - - - Similar to Mirror and Clamp. Takes the absolute value of the texture coordinate (thus, mirroring around 0), and then clamps to the maximum value. The most common usage is for volume textures, where support for the full MirrorOnce texture-addressing mode is not necessary, but the data is symmetrical around the one axis. - - - - - Represents a class that provides arguments for the TotalChartCountChanged event. - - - - - Creates and initializes a new instance of TotalChartCountChangedEventArgs class. - - - - - The new total count of chart instances. - - - - - Triggered oscilloscope view options - - - - - Constructor for Form designer list editor - - - - - Constructor - - X axis - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Triggering edge - - - - - Seek the trig position - - - - - param - triggeredXPosition - M:Arction.Wpf.Charting.Triggering.SeekToTrigger(System.Double@) - - - - True if seek position was found and X axis was shifted - - - - Major grid options for static X major grid - - - - - Major grid options for static X minor grid - - - - - Convert class description to string - - String - - - - Is triggering active - - - - - The triggering position has been changed. - - - - - Percents of graph width where the triggered position is drawn - - - - - Trigger level in units of Y axis of triggering line series - - - - - Index of series used for triggering. Give -1 when you don't want to assign it. - - Thrown if series index is invalid. - - - - Triggering series type. - - - - - Delegate for event OnTrigPosChanged - - True if trigged, else false. - Triggered x position - Triggering level that was used. - Chart who raised the event - Triggering series - - - - Triggering edge direction. - - - - - Raising edge. - - - - - Falling edge. - - - - - Triggering series type. - - - - - A PointLineSeries is used for triggering. - - - - - A SampleDataSeries is used for triggering. - - - - - A SampleDataBlockSeries is used for triggering. - - - - - A LiteLineSeries is used for triggering. - - - - - A DigitalLineSeries is used for triggering. - - - - - Base class for UI Settings. LC users see these objects as the usable objects handled in the LC. - In effect these only store the settings for the actually drawed objects, that inherit IBGListener interface and cache the drawing information. - This is part of a test to remove object sharing limitations from LC. - - - - - constructor - - - - - Disposes object. - - - - - Internal dispose. Override this if you have anything to dispose or settings to reset. - Remember to call the base classes implementation. - - true if called from Dispose, False if called from Finalizer. If false, do NOT touch any managed objects. - - - - Friendly scale calculation conditions. - - - - - Find nearest bigger - - - - - Find nearest - - - - - Find nearest smaller - - - - - Button related to user action. E.g. with mouse. Pen could have many buttons, touch not, which would be using None or Primary. Event would describe the action in touch case. - - - - - No button related to event. - - - - - Primary button. Usually left with mouse. - - - - - Secondary button. Usually right with mouse. - - - - - Tertiary button, not handled in chart so far, but could be given out. - - - - - Some other button, not handled in chart so far, but could be given out. - - - - - Some other button, not handled in chart so far, but could be given out. - - - - - Barrel button (from pen/stylys). - - - - - Button was not recognized. Should not happen. - - - - - UserInteractiveObject action related to device button. - - - - - No action. - - - - - Pan. - - - - - Zoom. - - - - - UserInteractiveObject action related to device button, for 3D view. - - - - - No action. - - - - - Pan. - - - - - Rotate. - - - - - Pans the PrimaryX and PrimaryZ axis ranges. - - - - - Pans the PrimaryX and PrimaryY axis ranges. - - - - - Pans the PrimaryY and PrimaryZ axis ranges. - - - - - Zoom on XY plane. - - - - - Zoom on XZ plane. - - - - - Zoom on YZ plane. - - - - - Zoom on X-axis. - - - - - Zoom on Y-axis. - - - - - Zoom on Z-axis. - - - - - UserInteractiveObject action related to device button, for 3D Pie. - - - - - No action. - - - - - Pan. - - - - - Rotate. - - - - - State related to user interactive device button. - - - - - Button was/is pressed down. - - - - - Button was/is released. - - - - - Mouse/Pointer/Touch/Pen/input device related event arguments. Position is pixels. - - - - - Constructor. - - - - - param - buttonsState - M:Arction.Wpf.Charting.UserInteractiveDeviceEventArgs.#ctor(Arction.Wpf.Charting.ButtonState,Arction.Wpf.Charting.CoordXY,System.Double,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.UInt32,System.Boolean) - - - - - - - param - position - M:Arction.Wpf.Charting.UserInteractiveDeviceEventArgs.#ctor(Arction.Wpf.Charting.ButtonState,Arction.Wpf.Charting.CoordXY,System.Double,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.UInt32,System.Boolean) - - - - - - - param - delta - M:Arction.Wpf.Charting.UserInteractiveDeviceEventArgs.#ctor(Arction.Wpf.Charting.ButtonState,Arction.Wpf.Charting.CoordXY,System.Double,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.UInt32,System.Boolean) - - - - - - - param - eventType - M:Arction.Wpf.Charting.UserInteractiveDeviceEventArgs.#ctor(Arction.Wpf.Charting.ButtonState,Arction.Wpf.Charting.CoordXY,System.Double,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.UInt32,System.Boolean) - - - - - - - param - pointerId - M:Arction.Wpf.Charting.UserInteractiveDeviceEventArgs.#ctor(Arction.Wpf.Charting.ButtonState,Arction.Wpf.Charting.CoordXY,System.Double,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.UInt32,System.Boolean) - - - - - - - param - handled - M:Arction.Wpf.Charting.UserInteractiveDeviceEventArgs.#ctor(Arction.Wpf.Charting.ButtonState,Arction.Wpf.Charting.CoordXY,System.Double,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.UInt32,System.Boolean) - - - - - - - Constructor. - - - - - param - button - M:Arction.Wpf.Charting.UserInteractiveDeviceEventArgs.#ctor(Arction.Wpf.Charting.UserInteractiveDeviceButton,Arction.Wpf.Charting.UserInteractiveDeviceButtonState,Arction.Wpf.Charting.CoordXY,System.Int32,Arction.Wpf.Charting.UserInteractiveDeviceEventType) - - - - - - - param - state - M:Arction.Wpf.Charting.UserInteractiveDeviceEventArgs.#ctor(Arction.Wpf.Charting.UserInteractiveDeviceButton,Arction.Wpf.Charting.UserInteractiveDeviceButtonState,Arction.Wpf.Charting.CoordXY,System.Int32,Arction.Wpf.Charting.UserInteractiveDeviceEventType) - - - - - - - param - point - M:Arction.Wpf.Charting.UserInteractiveDeviceEventArgs.#ctor(Arction.Wpf.Charting.UserInteractiveDeviceButton,Arction.Wpf.Charting.UserInteractiveDeviceButtonState,Arction.Wpf.Charting.CoordXY,System.Int32,Arction.Wpf.Charting.UserInteractiveDeviceEventType) - - - - - - - param - delta - M:Arction.Wpf.Charting.UserInteractiveDeviceEventArgs.#ctor(Arction.Wpf.Charting.UserInteractiveDeviceButton,Arction.Wpf.Charting.UserInteractiveDeviceButtonState,Arction.Wpf.Charting.CoordXY,System.Int32,Arction.Wpf.Charting.UserInteractiveDeviceEventType) - - - - - - - param - eventType - M:Arction.Wpf.Charting.UserInteractiveDeviceEventArgs.#ctor(Arction.Wpf.Charting.UserInteractiveDeviceButton,Arction.Wpf.Charting.UserInteractiveDeviceButtonState,Arction.Wpf.Charting.CoordXY,System.Int32,Arction.Wpf.Charting.UserInteractiveDeviceEventType) - - - - - - - Buttons with states. Buttons are enumerated as flagged. - - - - - Wheel related value. - - - - - Event type. - - - - - Event handled status. - - - - - Check if given button is pressed. - - Button to check. - True, if is pressed, false otherwise. - - - - Check if given button is released. - - Button to check. - True, if is released, false otherwise. - - - - Pointer Id. Mainly used with UWP. - - - - - Position in pixel coordinates. - - - - - Return button state and event type as string. - - - - - returns - M:Arction.Wpf.Charting.UserInteractiveDeviceEventArgs.ToString - - - - - - - User interactive device event types. - - - - - Button has been pressed down. - - - - - Device has been moved. - - - - - Button has been released. - - - - - Button has been pressed down and released. - - - - - Button has been clicked twice. - - - - - Wheel was scrolled. - - - - - User interaction base class, handles basic user interactions on some chart object. - - - - - Constructor. - - - - - Constructor. - - Parent. - - - - Gets or sets whether allow user interaction. - - - - - Clean up any resources being used. - - True if managed resources should be disposed, otherwise false. - - - - Handle event when not over. - - - - - Handle when over. - - - - - Invoke ButtonClick event. - - - - - returns - M:Arction.Wpf.Charting.UserInteractiveObject.InvokeButtonClickEvent - - - - - - - Invoke ButtonDoubleClick event. - - - - - returns - M:Arction.Wpf.Charting.UserInteractiveObject.InvokeButtonDoubleClickEvent - - - - - - - Invoke ButtonDown event. - - - - - returns - M:Arction.Wpf.Charting.UserInteractiveObject.InvokeButtonDownEvent - - - - - - - Invoke ButtonUp event. - - - - - returns - M:Arction.Wpf.Charting.UserInteractiveObject.InvokeButtonUpEvent - - - - - - - Invoke OverOff event. - - true if event was delivered. See LightningChart.RaiseEvent method for more information. Return value of that is used. - - - - Invoke OverOn event. - - true if event was delivered. See LightningChart.RaiseEvent method for more information. Return value of that is used. - - - - Defines if position is over an item. - - x-coordinate. - y-coordinate. - Use DIP instead of pixels as parameters. - true if position is over item, false otherwise - - - - Last mouse x-coordinate. - - - - - Last mouse y-coordinate. - - - - - Current mouse x-coordinate as PX. - - - - - Current mouse y-coordinate as PX. - - - - - User interactive device event type. - - - - - Mouse button has been clicked. - - - - - Mouse button has been doubleclicked. - - - - - Mouse button has been pressed down. - - - - - Mouse has been moved outside of object. - - - - - Mouse has been moved over object. - - - - - Mouse button has been released. - - - - - Set chart cursor. - - Cursor - - - - Item center position when dragging starts. - - - - - Set proper drag cursor. Default is hand. - - - - - Item to string. - - - - - returns - M:Arction.Wpf.Charting.UserInteractiveObject.ToString - - - - - - - Interaction state. - - - - - No action. - - - - - No action, user interactive device is over. - - - - - Primary user interactive device button down. - - - - - Clicked once with primary user interactive device button. - - - - - Clicked twice with primary user interactive device button. - - - - - Selecting (primary user interactive device button down) and then moving enough. - - - - - Secondary user interactive device button down. - - - - - Secondary user interactive device button clicked. - - - - - Secondary user interactive device button double clicked. - - - - - Secondary user interactive device button up. - - - - - Clicked on border or like. - - - - - Released primary interactive device button. - - - - - Rotate item. - - - - - Other user interactive device button down. - - - - - Other user interactive device button clicked. - - - - - Other user interactive device button double clicked. - - - - - Other user interactive device button up. - - - - - UserInteractiveObjectInt contains interactive item. Internal use only. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Tag. Freely assignable object. - - - - - Grid bands in between major grid lines. - - - - - None. - - - - - X. - - - - - Y. - - - - - Both. - - - - - Grid bands in between major grid lines. - - - - - None. - - - - - X. - - - - - Z. - - - - - Both. - - - - - Grid bands in between major grid lines. - - - - - None. - - - - - Y. - - - - - Z. - - - - - Both. - - - - - Wall type. - - - - - Left wall. - - - - - Right wall. - - - - - Back wall. - - - - - Front wall. - - - - - Top wall. - - - - - Bottom wall. - - - - - Value range palette. - - - - - Constructor for Form designer list editor. - - - - - Constructor. - - Owner series - - - - Create steps. - - - - - returns - M:Arction.Wpf.Charting.ValueRangePalette.CreateDefaultSteps - - - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Format PaletteStep Value text event. - - - - - Calculate color corresponding the given value, with the value-range palette defined. - - Value. - Color. - Color by value. - - - - Step minimum value. - - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Show palette step minimum label. - - - - - Palette steps - - - - - Convert class description to string - - String - - - - Palette coloring type. - - - - - Delegate for FormatStepValueText event. - - Event sender. - Step value. - - - - Waterfall series contour line type. - - - - - No contour line. - - - - - Performance optimized thin zone at palette step edge. - - - - - Performance optimized thin zone at palette step edge, various colors set by the palette. - - - - - Waterfall series wireframe type. - - - - - No wireframe. - - - - - Wireframe mesh, solid color. - - - - - Wireframe, source data point colored. - - - - - Wireframe mesh, paletted color by Y. - - - - - Wireframe mesh, paletted color by Value. - - - - - Vertical direction. - - - - - Up. - - - - - Center (no direction). - - - - - Down. - - - - - Represents a vertical scroll bar control. Values use unsigned 64-bit integer value range. - - - - - Creates and initializes a new instance of VerticalScrollBar class. - - - - - Creates and initializes a new instance of VerticalScrollBar class. - - The chart that owns this scroll bar. - - - - Alignment. - - - - - Clean up any resources being used. - - true if managed resources should be disposed; otherwise, false. - - - - Vertical scroll bar alignment. - - - - - No alignment. - - - - - Scrollbar is vertically aligned to the right of the graph area. - Left edge is positioned to graph left edge, and right edge is positioned to graph right edge. - - - - - Scrollbar is vertically aligned to the center of the graph area. - Left edge is positioned to graph left edge, and right edge is positioned to graph right edge. - - - - - Scrollbar is vertically aligned to the left of the graph area. - Left edge is positioned to graph left edge, and right edge is positioned to graph right edge - - - - - Wheel zooming. - - - - - Wheel zoom is disabled - - - - - Horizontal zoom only, applies X-axes. - - - - - Vertical zoom only, applies Y-axes - - - - - Zoom in horizontal and vertical direction, applies X and Y-axes - - - - - Aspect ratio. - - - - - Adjust axis range manually. - - - - - Set aspect ratio manually. - - - - - Calculate aspect ratio based on view center latitude. Applicable only, when map is used. - Y-axis center point defines the latitude, proper XY aspect ratio is calculated based in it and X-axis width is modified accordingly. - This simulates the projection so that width of objects in the center of the screen are approximately of correct aspect ratio. - The estimation can produce bad output on large scale and large center latitude values. - - - - - Work around warp class - - - - - Constructor - - - - - Work Around Warp Exception - - - - - param - info - M:Arction.Wpf.Charting.WorkAroundWarpException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext) - - - - - - - param - context - M:Arction.Wpf.Charting.WorkAroundWarpException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext) - - - - - - - Work Around Warp Exception - - - - - param - message - M:Arction.Wpf.Charting.WorkAroundWarpException.#ctor(System.String) - - - - - - - Work Around Warp Exception - - - - - param - message - M:Arction.Wpf.Charting.WorkAroundWarpException.#ctor(System.String,System.Exception) - - - - - - - param - inner - M:Arction.Wpf.Charting.WorkAroundWarpException.#ctor(System.String,System.Exception) - - - - - - - WPF font. Converts WPF font to WinForms font. - - - - - Constructor. - - - - - Constructor. - - Parent. - - - - Constructor. - - - - - param - size - M:Arction.Wpf.Charting.WpfFont.#ctor(System.Double) - - - - - - - Constructor. - - - - - param - font - M:Arction.Wpf.Charting.WpfFont.#ctor(System.Drawing.Font) - - - - - - - Constructor. - - - - - param - family - M:Arction.Wpf.Charting.WpfFont.#ctor(System.Drawing.FontFamily,System.Double,System.Drawing.FontStyle) - - - - - - - param - emSize - M:Arction.Wpf.Charting.WpfFont.#ctor(System.Drawing.FontFamily,System.Double,System.Drawing.FontStyle) - - - - - - - param - fontStyle - M:Arction.Wpf.Charting.WpfFont.#ctor(System.Drawing.FontFamily,System.Double,System.Drawing.FontStyle) - - - - - - - Constructor. - - - - - param - fontFamily - M:Arction.Wpf.Charting.WpfFont.#ctor(System.String) - - - - - - - Constructor. - - Font family - Size as wpf units - - - - Constructor. - - Font family - Size as wpf units - Bold - Italics - - - - Constructor. - - Font family - Size as wpf units - Size string to be saved in serialization - Bold - Italics - - - - Gets or sets bold. This is a dependency property. - - - - - Identifies the Bold dependency property. - - - - - Create members. - - - - - Create instance. - - Instance as Freezable - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Gets or sets font family. This is a dependency property. - - - - - Identifies the Family dependency property. - - - - - Identifies the Height dependency property. - - - - - Gets or sets italic. This is a dependency property. - - - - - Identifies the Italic dependency property. - - - - - Gets or sets font size in inch/96 units (DIP). This is a dependency property. - - - - - Identifies the Size dependency property. - - - - - Convert to string. - - - - - returns - M:Arction.Wpf.Charting.WpfFont.ToString - - - - - - - Capslock device enumerators - - - - - Device driver version - - - - - Device classification - - - - - Horizontal size in millimeters - - - - - Vertical size in millimeters - - - - - Horizontal width in pixels - - - - - Vertical height in pixels - - - - - Number of bits per pixel - - - - - Number of planes - - - - - Number of brushes the device has - - - - - Number of pens the device has - - - - - Number of markers the device has - - - - - Number of fonts the device has - - - - - Number of colors the device supports - - - - - Size required for device descriptor - - - - - Curve capabilities - - - - - Line capabilities - - - - - Polygonal capabilities - - - - - Text capabilities - - - - - Clipping capabilities - - - - - Bitblt capabilities - - - - - Length of the X leg - - - - - Length of the Y leg - - - - - Length of the hypotenuse - - - - - Shading and Blending caps - - - - - Logical pixels inch in X - - - - - Logical pixels inch in Y - - - - - Number of entries in physical palette - - - - - Number of reserved entries in palette - - - - - Actual color resolution - - - - - Physical Width in device units - - - - - Physical Height in device units - - - - - Physical Printable Area x margin - - - - - Physical Printable Area y margin - - - - - Scaling factor x - - - - - Scaling factor y - - - - - Current vertical refresh rate of the display device (for displays only) in Hz - - - - - Vertical height of entire desktop in pixels - - - - - Horizontal width of entire desktop in pixels - - - - - Preferred blt alignment - - - - - X-axis auto placement locations related to chart draw area. - - - - - Use default location. - - - - - All axis to bottom. - - - - - All axis to top. - - - - - First axis to bottom, next top, etc. - - - - - First axis to top, next bottom, etc. - - - - - Axis is put on top or bottom depending on axis ExplicitAutoPlacementSide value. - - - - - X-axis explicit automatic location. - - - - - Draw axis on the top of graph. - - - - - Draw axis on the bottom of graph. - - - - - Scrolling types. - - - - - X-axis is not automatically scrolled. - - - - - X-axis will be scrolled when scroll position approaches end of the graph. - - - - - Steps the view with Step when scroll position reaches end of the graph. - - - - - Previous trace will be left in the background and new trace will be swept over it. - - - - - The X-axis minimum and maximum are set by detected level trigging position. - - - - - Horizontal alignment of X-axis title. - - - - - Align left. - - - - - Align center. - - - - - Align right. - - - - - Center to axis value. - - - - - Vertical alignment of X-axis title. - - - - - Align top. - - - - - Align center. - - - - - Align bottom. - - - - - Grid bands in between major grid lines - - - - - None. - - - - - X. - - - - - Y. - - - - - Both. - - - - - Y-axis arrangement mode, when there's several Y-axes defined. - - - - - Stack Y-axes. - - - - - Layered Y axes. - - - - - Segmented Y axes. - - - - - Y-axis auto placement locations related to chart draw area. - - - - - Use default location. - - - - - All axis to left. - - - - - All axis to right. - - - - - First axis to left, next right, etc. - - - - - First axis to right next left, etc. - - - - - Axis is put on left or right depending on axis ExplicitAutoPlacementSide value. - - - - - Y-axis explicit automatic location. - - - - - Draw axis on the left side of graph. - - - - - Draw axis on the right side of graph. - - - - - Y-axis position. - - - - - Left. - - - - - Right. - - - - - Horizontal alignment of Y-axis title. - - - - - Align left. - - - - - Align center. - - - - - Align right. - - - - - Vertical alignment of Y-axis title. - - - - - Align top. - - - - - Align center. - - - - - Align bottom. - - - - - Center to axis value. - - - - - Zoom area options for View3D and ViewPie3D - - - - - Zoom to fit all data and LabelsArea (the graph) to area limited by margins and . - - - - - Zoom area options for polar and smith charts. - - - - - Zoom to show all data, does not take graph or labels into account. - - - - - Zooming based on LabelsArea, showing the graph and the labels, ignores data outside the graph. - - - - - Zooming based on the default zoom and centering settings, returns the initial zoom level. - - - - - Represents a class that provides arguments for the AnchorAdjustedByUser event. - - - - - Creates and initializes a new instance of AnchorAdjustedByUserEventArgs class. - - - - - The annotation whose anchor was adjusted by user interactive device. - - - - - If you update the chart in the event handler, set to true to prevent flickering. - - - - - New anchor. - - - - - Old anchor. - - - - - Annotation for 3D views. - - - - - Constructor for Form designer list editor. - - - - - Constructor. - - Parent. - X-axis binding. - Y-axis binding. - Z-axis binding. - - - - Adjust location axis value when user moved. - - sweep page index - - - - Apply wheel change on target point. - - - - - Dispose Annotation3D. - - - - - Arction.Wpf.Charting.Annotations.Annotation3D - - - - - - - Handle over resize nib. - - - - - User interactive device wheel state changed. Update Z of target. - - wheel change - event type - - - - Location as axis values. - - - - - Location axis value coordinates have been changed by user. - - - - - Move target by user. - - User device X coordinate - User device Y coordinate - Rendering location on device button down. Not used in 3D. - - - - Owner view. - - - - - Reset wheel value. - - - - - Updated axes from owner view. - - - - - X-axis binding. - - - - - Y-axis binding. - - - - - Z-axis binding. - - - - - The delegate to use for handlers that receive the LocationAxisValuesChangedByUser event. - - - Provides data for the LocationAxisValuesChangedByUser event. - - - - Annotation base class for 3D views. - - - - - Adjust target Z-value. - - Change value in world coordinates. - - - - Apply wheel change on target point. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Handle over resize nib. - - - - - Handle over target nib. - - - - - Move value location by user. - - User interactive device x coordinate - User interactive device y coordinate - render location on button down - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Annotation has been resized by user. - - - - - Show target location crosshair. - - - - - Annotation sizing type. - - - - - Target as axis values. - - - - - Target has been changed by user. - - - - - Define target crosshair line style. - - - - - Wheel change step. - - - - - The delegate to use for handlers that receive the ResizedByUser event. - - - Provides data for the ResizedByUser event. - - - - The delegate to use for handlers that receive the TargetChangedByUser event. - - - Provides data for the TargetChangedByUser event. - - - - Annotation for 3DPie view. - - - - - Constructor for Form designer list editor. - - - - - Constructor. - - Parent. - - - - Apply wheel change on target point. - - - - - Mouse wheel state changed. Update Z of target. - - wheel change value - mouse event type - - - - Location coordinate system selection. - - - - - Move target by user interactive device. - - x coordinate - y coordinate - render location on button down - - - - Owner view. - - - - - Annotations base class. - - - - - Constructor. - - Parent. - - - - Adjust location axis value when user interactive device moved. - - sweep page index - - - - Allow anchor move by user. Anchor is centerpoint of rotation and start point of arrow. - - - - - Allow resizing by user. - - - - - Allow rotation by user. - - - - - Allow user to move target. - - - - - Rotation uses this point as a center point. Tells - where to place the anchored point within the control area. - For X-dimension, value 0 represents left coordinate of the object and 1 right coordinate. - For Y-dimension, value 0 represents top coordinate of the object and 1 bottom coordinate. - To define anchor point outside the object area, define values outside range 0...1. - - - - - Anchor has been adjusted by user. - - - - - Arrow end aspect ratio (width / height). - - - - - Arrow line style. - - - - - Lead arrow style, in the beginning of line. - - - - - Lead arrow style, in Target location. - - - - - Padding between text and borders when automatic size is used. - - - - - Border line style. - - - - - Defines if border is visible. - - - - - Change object position in list of annotations. - - Order change action. - - - - Corner rounding radius, in pixels. - - - - - Detect sweep page at position. - - x coordinate - - - - returns - M:Arction.Wpf.Charting.Annotations.AnnotationBase.DetectPositionOverSweepPageIndex(System.Int32) - - - - - - - Clean up any resources being used. - - True if managed resources should be disposed, otherwise false. - - - - Fill. - - - - - Handle user over resize nib. - - - - - Handle user over target nib. - - - - - Wheel state changed. - - wheel change value - event type - - - - Is position over Annotation. - - x-coordinate - y-coordinate - Use DIP instead of pixels as parameters - - - - returns - M:Arction.Wpf.Charting.Annotations.AnnotationBase.IsPositionOver(System.Int32,System.Int32,System.Boolean) - - - - - - - Text is rendered on layers. - - - - - Location coordinate system selection. - - - - - Location offset in pixels, relative to location. - - - - - Location relative screen coordinate offset has been changed by user. - - - - - Location screen coordinates have been changed by user. - - - - - Location as screen coordinates in pixels. - - - - - Render box center for 1st sweep page. - - - - - Render box center for 2nd sweep page. - - - - - Move target by user. - - x coordinate - y coordinate - render location on button down - - - - Move value location by user. - - x coordinate - y coordinate - render location on button down - - - - Nib style. Appearance of the mouse-interactive nibs. - - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Reset wheel value. - - - - - Rotation angle, in degrees. The rotation is done around the element's center of rotation. - - - - - Annotation has been rotated by user. - - - - - Defines if annotation is in 'Selected' state, allowing resizing, rotating and anchor adjustment. - - - - - Set proper cursor. Default for dragging is hand and for resize SizeAll. - - - - - Shadow beneath the object. - - - - - Size as screen coordinates. - - - - - Style selects the main layout of annotation. - - - - - Target coordinate system selection. - - - - - Target as screen coordinates. Target is the point that the arrow or call-out tip points to. - - - - - Annotation text. - - - - - Text style. Appearance of the text. - - - - - Description of class. - - Description. - - - - Defines if annotation is visible. - - - - - The delegate to use for handlers that receive the AnchorAdjustedByUser event. - - The object that raised the event. - Provides data for the AnchorAdjustedByUser event. - - - - The delegate to use for handlers that receive the LocationRelativeOffsetChangedByUser event. - - The object that raised the event. - Provides data for the LocationRelativeOffsetChangedByUser event. - - - - The delegate to use for handlers that receive the LocationScreenCoordinatesChangedByUser event. - - The object that raised the event. - Provides data for the LocationScreenCoordinatesChangedByUser event. - - - - The delegate to use for handlers that receive the RotatedByUser event. - - The object that raised the event. - Provides data for the RotatedByUser event. - - - - Annotation nib style. - - - - - Constructor. - - - - - Constructor. - - Parent. - - - - Nib color alpha. - - - - - Nib color. - - - - - Clean up any resources being used. - - True if managed resources should be disposed, otherwise false. - - - - Size factor. - - - - - Converts class description to string. - - Class description as a string. - - - - Annotation for ViewPolar. - - - - - Constructor for property grid editor. - - - - - Constructor. - - Parent. - Polar axis you want to bind. - - - - Adjust location axis value when user interactive device moved. - - sweep page index - - - - Index of Polar axis assigned to this Annotation. Give -1 when you don't want to assign it yet to any Polar axis. - - - - - Clean up any resources being used. - - True if managed resources should be disposed, otherwise false. - - - - Handle mouse over resize nib. - - - - - Location as axis values. - - - - - Location axis values coordinates have been changed by user - - - - - Move target by user. - - X coordinate - X coordinate - Rendering location on button down - - - - Move value location. - - X coordinate - X coordinate - Rendering location on button down - - - - Sets the annotation location to axis values that match the given - screen coordinates. - - - - - param - Coords - M:Arction.Wpf.Charting.Annotations.AnnotationPolar.SetLocationFromAxisValues(Arction.Wpf.Charting.PointFloat) - - - - - - - Target as axis values. - - - - - Target has been changed by user - - - - - The delegate to use for handlers that receive the LocationAxisValuesChangedByUser event. - - - Provides data for the LocationAxisValuesChangedByUser event. - - - - The delegate to use for handlers that receive the TargetChangedByUser event. - - - Provides data for the TargetChangedByUser event. - - - - Represents a class that provides arguments for the AnnotationResizedByUser event. - - - - - Creates and initializes a new instance of AnnotationResizedByUser3DBaseEventArgs class. - - - - - The annotation that was resized by user. - - - - - Represents a class that provides arguments for the AnnotationResizedByUser event. - - - - - Creates and initializes a new instance of AnnotationResizedByUserEventArgs class. - - - - - The angle of the left edge. Applies when the rotation angle is 0. - - - - - The angle of the right edge. Applies when the rotation angle is 0. - - - - - If you update the chart in the event handler, set to true to prevent flickering. - - - - - The new size in screen coordinates. - - - - - The old size in screen coordinates. - - - - - The radius of the bottom edge. Applies when the rotation angle is 0. - - - - - The radius of the top edge. Applies when the rotation angle is 0. - - - - - Represents a class that provides arguments for the AnnotationResizedByUser event. - - - - - Creates and initializes a new instance of AnnotationResizedByUserRoundEventArgs class. - - - - - The annotation that was resized by user. - - - - - Represents a class that provides arguments for the AnnotationResizedByUser event. - - - - - Creates and initializes a new instance of AnnotationResizedByUserXYEventArgs class. - - - - - The annotation that was resized by user. - - - - - Annotation for round views (ViewPolar and ViewSmith). - - - - - Constructor for property grid editor. - - - - - Constructor. - - Parent. - - - - Annotation has been resized by user. - - - - - Sets the annotation location to axis values that match the given - screen coordinates. - - - - - param - Coords - M:Arction.Wpf.Charting.Annotations.AnnotationRound.SetLocationFromAxisValues(Arction.Wpf.Charting.PointFloat) - - - - - - - Annotation sizing type. - - - - - The delegate to use for handlers that receive the ResizedByUser event. - - - Provides data for the ResizedByUser event. - - - - Annotation for ViewSmith. - - - - - Constructor for property grid editor. - - - - - Constructor. - - Parent. - Smith axis you want to bind. - - - - Adjust location axis value when user interactive device moved. - - sweep page index - - - - Clean up any resources being used. - - True if managed resources should be disposed, otherwise false. - - - - Handle mouse over resize nib. - - - - - Location as axis values. - - - - - Location axis values coordinates have been changed by user - - - - - Move target by user. - - mouse X coordinate - mouse X coordinate - Rendering location on button down - - - - Move value location by user. - - X coordinate - X coordinate - Rendering location on button down - - - - Sets the annotation location to axis values that match the given - screen coordinates. - - - - - param - Coords - M:Arction.Wpf.Charting.Annotations.AnnotationSmith.SetLocationFromAxisValues(Arction.Wpf.Charting.PointFloat) - - - - - - - Target as axis values. - - - - - Target has been changed by user - - - - - The delegate to use for handlers that receive the LocationAxisValuesChangedByUser event. - - - Provides data for the LocationAxisValuesChangedByUser event. - - - - The delegate to use for handlers that receive the TargetChangedByUser event. - - - Provides data for the TargetChangedByUser event. - - - - Annotation text style. - - - - - Constructor for Form designer list editor. - - - - - Constructor. - - Parent. - - - - Color. - - - - - Clean up any resources being used. - - True if managed resources should be disposed, otherwise false. - - - - Title font. - - - - - Horizontal alignment. - - - - - Multi-line text horizontal alignment. - - - - - OnDeserialized is called just after the object has been deserialized. - - Context. - - - - Shadow below the text. - - - - - Converts class description to string. - - Class description as a string. - - - - Vertical alignment. - - - - - Defines if text is visible or not. - - - - - Annotation for ViewXY. - - - - - Constructor for Form designer list editor. - - - - - Constructor. - - X-axis you want to bind. - Y-axis you want to bind. - Parent. - - - - Adjust location axis value when user interactive device moved. - - sweep page index - - - - Index of X-axis assigned to this series. Give -1 when you don't want to assign it yet to any X-axis. - - - - - Index of Y-axis assigned to this series. Give -1 when you don't want to assign it yet to any Y-axis. - - - - - Main box boundaries in axis values. - - - - - Annotation is drawn behind series or marker if enabled. - - - - - If set, limits the annotation in graph area. - Note that ClipOnScaleBreak affects the clipping as well. - - - - Defines if annotation is clipped at X-axis breaks. - Note that when true, the annotation is clipped at the start/end X-axis even if there are not breaks defined. - - - - The annotation doesn’t show up in the sweeping gap area when enabled. Applies only when X-axis ScrollMode is Sweeping. - - - - - Detect sweep page at position. - - x coordinate - - - - returns - M:Arction.Wpf.Charting.Annotations.AnnotationXY.DetectPositionOverSweepPageIndex(System.Int32) - - - - - - - Clean up any resources being used. - - True if managed resources should be disposed, otherwise false. - - - - Handle mouse over resize nib. - - - - - Handle mouse over target nib. - - - - - Keep annotation always visible, inside graph area. - - - - - Location as axis values. - - - - - Location axis values coordinates have been changed by user - - - - - Move target by user. - - x coordinate - y coordinate - render location on button down - - - - Move value location by user. - - x coordinate - y coordinate - render location on user interactive device button down - - - - Render annotation behind X-axes. - - - - - Annotation has been resized by user. - - - - - Annotation sizing type. - - - - - Target as axis values. Target is the point that the arrow or call-out tip points to. - - - - - Target has been changed by user - - - - - Converts class description to string. - - Class description as a string. - - - - The delegate to use for handlers that receive the LocationAxisValuesChangedByUser event. - - - Provides data for the LocationAxisValuesChangedByUser event. - - - - The delegate to use for handlers that receive the ResizedByUser event. - - - Provides data for the AnnotationResizedByUser event. - - - - The delegate to use for handlers that receive the TargetChangedByUser event. - - - Provides data for the TargetChangedByUser event. - - - - Represents a class that provides arguments for the LocationAxisValuesChangedByUser event. - - - - - Creates and initializes a new instance of LocationAxisValuesChangedByUser3DEventArgs class. - - - - - Represents a class that provides arguments for the LocationAxisValuesChangedByUser event. - - - - - Creates and initializes a new instance of LocationAxisValuesChangedByUserPolarEventArgs class. - - - - - Represents a class that provides arguments for the LocationAxisValuesChangedByUser event. - - - - - Creates and initializes a new instance of LocationAxisValuesChangedByUserSmithEventArgs class. - - - - - Represents a class that provides arguments for the LocationAxisValuesChangedByUser event. - - - - - Creates and initializes a new instance of LocationAxisValuesChangedByUserXYEventArgs class. - - - - - Represents a class that provides arguments for the LocationRelativeOffsetChangedByUser event. - - - - - Creates and initializes a new instance of LocationRelativeOffsetChangedByUserEventArgs class. - - - - - The annotation whose location relative offset was changed by user interactive device. - - - - - If you update the chart in the event handler, set to true to prevent flickering. - - - - - X-value. - - - - - Y-value. - - - - - Represents a class that provides arguments for the LocationScreenCoordinatesChangedByUser event. - - - - - Creates and initializes a new instance of LocationScreenCoordinatesChangedByUserEventArgs class. - - - - - Represents a class that provides arguments for the RotatedByUser event. - - - - - Creates and initializes a new instance of RotatedByUserEventArgs class. - - - - - The annotation that was rotated by user interactive device. - - - - - If you update the chart in the event handler, set to true to prevent flickering. - - - - - New angle of the annotation. - - - - - Represents a class that provides arguments for the TargetChangedByUser event. - - - - - Creates and initializes a new instance of TargetChangedByUser3DEventArgs class. - - - - - The annotation whose target was changed by user. - - - - - X-value. - - - - - Y-value. - - - - - Z-value. - - - - - Represents a class that provides arguments for the TargetChangedByUser event. - - - - - - - Arction.Wpf.Charting.Annotations.TargetChangedByUserEventArgs - - - - - - - If you update the chart in the event handler, set to true to prevent flickering. - - - - - Represents a class that provides arguments for the TargetChangedByUser event. - - - - - Creates and initializes a new instance of TargetChangedByUserPolarEventArgs class. - - - - - Angle value. - - - - - The annotation whose target was changed by user. - - - - - Radius value. - - - - - Represents a class that provides arguments for the TargetChangedByUser event. - - - - - Creates and initializes a new instance of TargetChangedByUserPolarEventArgs class. - - - - - The annotation whose target was changed by user interactive device. - - - - - Imaginary value. - - - - - RealValue value. - - - - - Represents a class that provides arguments for the TargetChangedByUser event. - - - - - Creates and initializes a new instance of TargetChangedByUserXYEventArgs class. - - - - - The annotation whose target was changed by user interactive device. - - - - - X-value. - - - - - Y-value. - - - - - Delivers information of rendered angle. - - - - - Angle Changed EventArgs. - - - - - Rendered Angle value in degrees. - - - - - Axis, sender of the event. - - - - - 3D axis base class. - - - - - Axis min and max values adjust by user. Draws scale nibs in the ends of the axis. - - - - - Axis scrolling by user. Drag from axis line. - - - - - Initialize members. - - - - - Alignment in the corner of 3D chart space. - - - - - Create drag nib. - - - - - Create major grid. - - - - - Create major grid style. - - - - - Create minor grid. - - - - - Create minor tick style. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Axis scrolling or scaling snaps to divisions. - - - - - Get list of walls where grid is drawn using this axis. - - List of walls. - - - - Get major tick values. - - Array of major tick values. - - - - Is mouse over a series. - - Mouse X-coordinate. - Mouse Y-coordinate. - Use DIP instead of pixels as parameters. - True if mouse is over a series. Otherwise false. - - - - Gap between labels and ticks. Value is in pixels. - - - - - Axis material. - - - - - OnDeserialized is called just after the object has been deserialized. - - Context. - - - - Owner view. - - - - - Set true if you want to have low values higher - and the high values lower on the graph. - - - - - Scale nib appearance. - - - - - Set proper drag cursor. Default is hand. - - - - - Axis title. - - - - - Axis units. - - - - - Convert axis value into respective coordinate in 3D world space. - Takes View.Dimensions into account. - - Value to convert. - 3D world coordinate. If view or dimensions can't be solved, returns NaN. - - - - Convert 3D world coordinate into respective axis value. - Takes View.Dimensions into account. - - 3D world coordinate. - Axis values. If view or dimensions can't be solved, returns NaN. - - - - Base class for X- and Y-axes. - - - - - Constructor. - - - - - param - owner - M:Arction.Wpf.Charting.Axes.AxisBase.#ctor(Arction.Wpf.Charting.IChartNode) - - - - - - - Labels gap in percents of their height when AutoDivSpacing is enabled. - - - - - Automatic division spacing. - - - - - Automatically determines number of decimals or time format. - - - - - Axis line color. - - - - - Thickness of the axis line. - - - - - Converts axis value to DateTime. - The returned value uses value origin set by DateOrigin properties. - - Axis value in seconds. - DateTime object. - - - - Calculates user friendly scale range. Fits the decimals so that they got values of 1, 2 and 5. - - Range. - Value format. - Condition. - Flags. - User friendly scale range. - - - - Minimum value range (maximum - minimum). - - - - - Initialize members. - - - - - Create labels font. - - - - - Create major grid. - - - - - Create major grid style. - - - - - Create minor grid. - - - - - Create minor grid style. - - - - - Custom axis ticks. Allows uneven major division spacing and label text setting. - Note that to see the ticks you must set CustomAxisTicksEnabled property to true. - - - - - Custom ticks on/off. Uses the ticks defined in CustomTicks property. - If this is enabled, only major ticks are drawn, not minor. - - - - - Date origin day. Keep this as close as possible to your actual first date. - Applies when using DateTime formatted axis. - - - - - Date origin month. Keep this as close as possible to your actual first date. - Applies when using DateTime formatted axis. - - - - - Date origin year. Keep this as close as possible to your actual first date. - Applies when using DateTime formatted axis. - - - - - Gets or sets the string presentation of axis range. This property effects when ValueType is DateTime. - - - - - Converts a DateTime object to value on this axis. - The returned value uses value origin set by DateOrigin properties. - - DateTime object to convert. - Value in seconds. - - - - Clean up any resources being used. - - True if managed resources should be disposed, otherwise false. - - - - Reduce divisions when Automatic division spacing is not set, and divisions get too close to each other. - - - - - Format axis value to string. - - Value. - Format string, applied when axis type is time. - Format string, applied when axis type is number or map coordinates. - When axis is typed as Log10Exponential or LogE_MultiplesOfNeper and base is accordingly, this flag will allow value to be formatted with "E" style. - Formatted axis value as string. - - - - Event to format axis tick value to custom string. - - - - - Get last used label format string. - "E" is for 10 base log. - "e" is for Neper base log. - "" is for custom label format (unknown for chart). - Consider using String.Format(returned format string) to format values. - - Format string for labels. - - - - Sets new custom ticks to take effect instantly. - Call this after you have added the ticks in code. - - - - - When true, keeps division count instead of division magnitude, when axis min or max is changed. - When false, keeps division magnitude instead of count. - - - - - Labels rotation angle, in degrees. - - - - - Labels color. - - - - - Labels font. - - - - - Labels number format, used when ValueType is 'Number'. - - - - - Labels number format, used when ValueType is 'Time'. - - - - - Defines if labels are visible or not. - - - - - Logarithmic base. Applies only when ScaleType is set to Logarithmic. - - - - - Logarithmic axis labels special formatting type. - - - - - Values below this limit will get this limit value when logarithmic presentation is used. - This is needed to handle 0 and values below that. - - - - - Double variable inaccuracy tolerance. - - - - - Major tick interval (units / division). - - - - - Major division count. - - - - - Major division ticks style. - - - - - Grid at major divisions. - - - - - Maximum axis value. - - - - - Maximum axis value. Use this property when axis' ValueType is DateTime. - - - - - Minimum axis value. - - - - - Minimum axis value. Use this property when X axis' ValueType is DateTime. - - - - - Minor division count. The count of divisions inside a major division. - - - - - Minor division ticks style. - - - - - Grid at minor divisions. - - - - - OnDeserialized is called just after the object has been deserialized. - - Context - - - - Range has changed (Minimum and/or Maximum value). - - - - - Axis scale type. - - - - - Set DateOriginYear, DateOriginMonth and DateOriginDay all at same time. - - Date. - - - - Set date time range. This effects when ValueType is DateTime. - - Minimum. - Maximum. - - - - Internal setter of the maximum property. For bindables calls the SetCurrentValue and thus affects the value changed callback, on non-bindable calls the property setter. - Does not call the setter for bindables as that would cause breaking of the binding as it calls SetValue. - - Value to set as maximum. - - - - Internal setter the minimum property. For bindables calls the SetCurrentValue and thus affects the value changed callback, on non-bindable calls the property setter. - Does not call the setter for bindables as that would cause breaking of the binding as it calls SetValue. - - Value to set as minimum. - - - - Set axis range. - - Minimum axis value. - Maximum axis value. - - - - Converts time value to string by given format. - Handles also negative values and formats having more than three second fractions. - - Time format string. - Value in seconds. - Formatted string. - - - - Value type: time, numeric or coordinates. - - - - - Defines if axis is visible or not. - - - - - The delegate to use for handlers that receive the event. - - - Provides data for the FormatValueLabel event. - - - - The delegate to use for handlers that receive the RangeChanged event. - - - Provides data for the RangeChanged event. - - - - Axis drag nib represents a dragging area on the end of X or Y axis. - The range of axis is modified by dragging the nib. - - - - - Constructor, for serialization purposes. - - - - - Constructor. - - Parent. - - - - Nib color - - - - - Clean up any resources being used. - - True if managed resources should be disposed, otherwise false. - - - - OnDeserialized is called just after the object has been deserialized. - - Context. - - - - Nib move reversed. - - - - - Nib size - - - - - Convert class description to string. - - String. - - - - Axis drag nib represents a dragging area on the both ends of axis. - The range of axis is modified by dragging the nib. - - - - - Constructor, for serialization purposes - - - - - Constructor - - Parent. - - - - Nib color - - - - - Create members. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Nib move reversed. - - - - - Nib size - - - - - Convert class description to string - - String - - - - Polar axis (angle) class. - - - - - Constructor for properties editor - - - - - Constructor. - - - - - param - owner - M:Arction.Wpf.Charting.Axes.AxisPolar.#ctor(Arction.Wpf.Charting.Views.ViewPolar.ViewPolar) - - - - - - - Base class for polar axes. - - - - - Constructor. - - - - - Constructor - - - - - param - owner - M:Arction.Wpf.Charting.Axes.AxisPolarBase.#ctor(Arction.Wpf.Charting.Views.ViewPolar.ViewPolarBase) - - - - - - - Allow axis scrolling by user. Drag from axis line. - - - - - Amplitude axis angle. - - - - - Amplitude axis placement angle decider (with respect to mathematical origin i.e, absolute or user defined origin i.e, relative). - - - - - Show amplitude axis. - - - - - Offset of the axis labels angle in degrees. - - - - - Amplitude labels visible. - - - - - Amplitude Axis direction is reversed. If false, amplitudes increase from center to edge, if true, they increase from edge to center. - Does not affect the angular axis in any way. - - - - - Axis' angle offset from original estimate. Multiple polar axes added equally spaced on a circle starting from East direction. - - - - - Axis angle direction is reversed. If false, angles increase counter clockwise, if true, they increase towards clockwise direction. - Does not affect the amplitude axis in any way. - - - - - Defines if the angular axis ticks are shown or not. - - - - - Create members. - - - - - Coordinate to value converter. - - Screen coordinate to convert into polar value - Flag useDip - Polar value matching the given screen coordinates. - - - - Coordinate to value. - - x-coordinate - y-coordinate - Angle as degrees. - Value as axis units. - Flag useDip - - - - Create font for labels - - - - - Create major grid - - - - - Create minor grid - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Axis scrolling or scaling snaps to divisions. - - - - - Inner circle radius as percentage of full circle. - - - - - When true, keeps division count instead of division magnitude, when axis min or max is changed. - When false, keeps division magnitude instead of count. - - - - - Defines if the angular ticks should be rendered or not. - - - - - drag start angle - - - - - origin angle at drag start - - - - - The View this axis is connected to. - - - - - Major tick interval (units / div). - - - - - Major division count. - - - - - Major division ticks style. - - - - - Grid at major divisions. - - - - - Inner margin between this and the next axis (the one inside this one). - Note that this does nothing if there is no axis inside this one. - - - - - Maximum axis amplitude value. - - - - - Minimum axis amplitude value. - - - - - Minor division count. The count of divisions inside a major division. - - - - - Minor division ticks style. - - - - - Grid at minor divisions. - - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Range has changed (Minimum or Maximum value) - - - - - Set proper cursor. - - - - - Set axis range. - - Minimum axis value - Maximum value - - - - Event to format amplitude as a custom string. - - - - - Item to string. - - - - - returns - M:Arction.Wpf.Charting.Axes.AxisPolarBase.ToString - - - - - - - Defines if the axis shares the same space with the previous axis - in the view's axis collection. If the OuterMargin, font size, - TickMark location and other angular axis position affecting - settings are the same as with the previous axis, the axis lines are - aligned. - - - - - Value to coordinates. - - Polar axis values to convert into screen coordinates. - Angle in the point is in relation to normal 0 angle, not the current axis drawing angle. - - Flag useDip - Screen coordinates matching the requested polar axis values. - - - - Value to coordinates. - - - - - param - Point - M:Arction.Wpf.Charting.Axes.AxisPolarBase.ValueToCoord(Arction.Wpf.Charting.IPointRound,System.Boolean) - - - - Flag useDip - - - - returns - M:Arction.Wpf.Charting.Axes.AxisPolarBase.ValueToCoord(Arction.Wpf.Charting.IPointRound,System.Boolean) - - - - - - - Convert value to string. - - Arguments - - - - The delegate to use for handlers that receive the RangeChanged event. - - The object that raised the event. - Provides data for the RangeChanged event. - - - - The delegate to use for handlers that receive the SupplyCustomAmplitudeString event. - - The object that raised the event. - Provides data for the SupplyCustomAmplitudeString event. - - - - Base class for round axes. - - - - - Constructor. - - - - - Constructor. - - - - - param - owner - M:Arction.Wpf.Charting.Axes.AxisRoundBase.#ctor(Arction.Wpf.Charting.Views.ViewRound.ViewRoundBase) - - - - - - - Axis min and max values adjust by user. Draws scale nibs in the ends of the axis. - - - - - Event that reports that the amplitude axis angle has changed. - - - - - Angle in degrees the amplitude axis line is drawn at. - - - - - Convert angle to string. - - Arguments - - - - Event that reports that the angular axis angle has changed. - - - - - If false considers AngularAxisMajorDivCount, if true calculates number of grid lines on angular axis. - - - - - Angular axis circle visible. - - - - - Specifies the number of major grid lines on angular axis if auto div spacing is set to false. - - - - - Angle in degrees the angular axis circle is drawn at. - - - - - Angular label visible. - - - - - Displayed angular unit. Default is degrees. - - - - - Anti-aliased draw. - Drawing anti-aliased draws the axis with smooth edges, but will increase CPU/GPU overhead. - - - - - Automatically format labels. - - - - - Axis line color. - - - - - Thickness of the axis line. - - - - - Minimum value range (max - min) - - - - - Create members. - - - - - Create new angular grid options. - - - - - Create labels' font. - - - - - Clean up any resources being used. - - True if managed resources should be disposed, otherwise false. - - - - Angular grid options. - - - - - Defines if the grid should be drawn behind or top of series information and axes. - - - - - Check if mouse is over item. - - X-coordinate. - Y-coordinate. - Use DIP instead of pixels as parameters. - - - - returns - M:Arction.Wpf.Charting.Axes.AxisRoundBase.IsPositionOver(System.Int32,System.Int32,System.Boolean) - - - - - - - Labels font - - - - - Gap between labels and ticks in pixels. - - - - - Axis dragging cursor. - - - - - Circumference dragging cursor. - - - - - Scale dragging cursor. - - - - - A length of original vector. - - - - - Center point in pixels. - - - - - Measured rectangle for text. - Values in PX. - - - - - Outer margin around this axis. - Distance from the outmost axis item to the edge of the background. - The item is either the axis line or label, depending on TickMarkLocation - property. - - - - - OnDeserialized is called just after the object has been deserialized. - - Context. - - - - Rebuilds angular grid, ticks and labels - - - - - Scale nib appearance. - - - - - Set proper cursor. - - - - - Event to format angle as a custom string. - - - - - Tick mark location. - - - - - Axis title. - - - - - Axis units. - - - - - Converts given point to screen coordinates. - - Value of the given view. Actual interpretation depends on view type. - Defines if the produced coordinates are to be in DIPs (Device independent pixels) or - in actual pixels - Screen coordinates of the given point. - - - - Defines if axis is visible or not. - - - - - The delegate to use for handlers that receive the AmplitudeAxisAngleChanged event. - - Sender of the event. - Arguments describing the angle change. - - - - The delegate to use for handlers that receive the SupplyCustomAngleString event. - - The object that raised the event. - Provides data for the SupplyCustomAngleString event. - - - - Smith axis class. - - - - - Constructor for properties editor. - - - - - Constructor. - - - - - param - owner - M:Arction.Wpf.Charting.Axes.AxisSmith.#ctor(Arction.Wpf.Charting.Views.ViewSmith.ViewSmithBase) - - - - - - - Create members. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Base class for smith axes. - - - - - Constructor. - - - - - Constructor - - - - - param - owner - M:Arction.Wpf.Charting.Axes.AxisSmithBase.#ctor(Arction.Wpf.Charting.Views.ViewSmith.ViewSmithBase) - - - - - - - Convert the normalized imaginary value to absolute scale. - - Normed imaginary axis value to convert back to absolute values. - Absolute Imaginary axis value. - - - - Convert the normalized real value to absolute scale. - - >Normed RealValue axis value to convert back to absolute value. - Absolute RealValue-axis value. - - - - Converts absolute smith view value to normed value. - Normed value 1 is at the center of the chart. - Normed value 1 matches the given absolute reference value. - - Smith values imaginary or real part to convert. - Normed smith value. - - - - Angular ticks style. - - - - - Convert angle to string. - - Dummy - Arguments - - - - Convert value to string. - - Dummy - Arguments - - - - Defines if the gridline is visible outside the chart circle. - - - - - Create members. - - - - - Converts Screen Coordinates to absolute Real/Imaginary value pair. - - - - - param - coord - M:Arction.Wpf.Charting.Axes.AxisSmithBase.CoordToValue(Arction.Wpf.Charting.PointFloat,System.Boolean) - - - - - - - param - useDIP - M:Arction.Wpf.Charting.Axes.AxisSmithBase.CoordToValue(Arction.Wpf.Charting.PointFloat,System.Boolean) - - - - - - - returns - M:Arction.Wpf.Charting.Axes.AxisSmithBase.CoordToValue(Arction.Wpf.Charting.PointFloat,System.Boolean) - - - - - - - Screen Coordinate to absolute RealValue,Imaginary value pair. - - X-coordinate in the chart area. - Y-coordinate in the chart area. Values grow downwards. - Value of the RealValue axis corresponding to the given coordinate pair. - Value of the Imaginary axis corresponding to the given coordinate pair. Values grow upwards. - Use DIP instead of pixels as parameters. - - - - Create angular grid options - - - - - Create imaginary grid options - - - - - Create real grid options - - - - - Create labels' font - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Number of gridlines in the view. - Used only if GridType is GridTypeSmith.DivCount - - - - - Approximate distance between gridlines in pixels. - Used only if GridType is GridTypeSmith.Distance. - - - - - Gridline options for the real-part grid. - - - - - Gridline options for the real-part grid. - - - - - Defines how the grid is defined. - If the value is Distance, GridDivSpacing property will affect the positioning and amount of gridlines. - Otherwise GridDivCount will be used in calculations. - - - - - Defines if the gridline is visible outside the chart circle. - - - - - Determines if the axis shows absolute or normalized values. - - - - - Reference resistance value at the center of the unit circle. - Used in value scaling. - - - - - Normalize the absolute imaginary axis value. - Means z(d) => r+jx, where ImgR(z(d)) = j(X/Z0). - - Absolute imaginary axis value to normalize to -1..1 range. - Normalized imaginary axis value, in range -1..1. Values can be larger, of course, but then they reside outside the unit circle. - - - - Normalize the absolute real axis value. - Means z(d) => r+jx, where RealR(z(d)) = R/Z0. - - Absolute real axis value to normalize. - Normalized real axis value. Normalized to range 0..1. Values outside this range do not fit in the Unit circle. - - - - Converts normed smith view value to absolute value. - Normed value 1 matches the given absolute reference value. - - Smith values imaginary or real part to convert. - Absolute smith value. - - - - OnDeserialized is called just after the object has been deserialized. - - Context - - - - Range has changed (Minimum or Maximum value). - - - - - Show Real axis. - - - - - Reference value (maximum) of the real Axis. - - - - - Determines if the axis shows absolute or normalized values. - - - - - Event to format imaginary value as a custom string. - - - - - Event to format real value as a custom string. - - - - - Item to string. - - String. - - - - Converts given smith value to screen coordinates. - - Smith value to convert. - Use DIP instead of pixels as parameters. - Screen coordinates matching the given parameter. - - - - Converts smith value to screen coordinates. - - Smith value to convert. - Use DIP instead of pixels as parameters. - Unrounded screen coordinates. - - - - Converts smith value to screen coordinates. - - Value of the RealValue axis. - Value of the Imaginary axis. Positive values upwards. - X-coordinate in the chart area. - Y-coordinate in the chart area. Values grow downwards. - Use DIP instead of pixels as parameters. - - - - Value to Unit Circle (UC) value. - - - - - param - point - M:Arction.Wpf.Charting.Axes.AxisSmithBase.ValueToUCValue(Arction.Wpf.Charting.IPointSmith) - - - - - - - returns - M:Arction.Wpf.Charting.Axes.AxisSmithBase.ValueToUCValue(Arction.Wpf.Charting.IPointSmith) - - - - - - - The delegate to use for handlers that receive the RangeChanged event. - - The object that raised the event. - Provides data for the RangeChanged event. - - - - The delegate to use for handlers that receive the SupplyCustomImgString event. - - The object that raised the event. - Provides data for the SupplyCustomImgString event. - - - - The delegate to use for handlers that receive the SupplyCustomRealString event. - - The object that raised the event. - Provides data for the SupplyCustomRealString event. - - - - Axis tick style class. - - - - - Constructor for Form designer list editor. - - - - - Constructor. - - Parent. - - - - Tick alignment. - - - - - Line color. - - - - - Create members. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Line length. - - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Convert class description to string . - - String. - - - - Defines if division ticks are visible or not. - - - - - Axis tick style class for round views. - - - - - Constructor for Form designer list editor. - - - - - Constructor. - - Parent. - - - - Tick mark width. - - - - - X axis class - - - - - Constructor for Form designer's list editor - - - - - Constructor - - - - - param - owner - M:Arction.Wpf.Charting.Axes.AxisX.#ctor(Arction.Wpf.Charting.Views.ViewXY.ViewXY) - - - - - - - Axis min and max values adjust by user. - - - - - Initialize members. - - - - - Convert X screen coordinates to values on X axis. - - X values - X screen coordinates - If true, xCoords is interpreted as coordinates in DIPs, otherwise in PX. - True if the coordinate was successfully converted. - Throws exception if x coordinate is not over graph area. - - - - Convert X screen coordinate (in DIPs or PX) to value on X axis. - - X screen coordinate - X value - Limits coordinate in visible graph range. Does not validate sweeping gap either. - Defines if the xCoord parameter is interpreted as DIP's or PX. - True if the coordinate was successfully converted. Returns false if the coordinate range validation failed. - graph area or it's over a sweeping gap. - Throws exception if x coordinate is not over graph area. - - - - Create major grid style. - - - - - Create minor tick style. - - - - - Create scale nib. - - - - - Create title. - - - - - Create units. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Axis automatic location, when XAxisAutoPlacement is Explicit. - - - - - Modifies the axis ranges so that all the data fits into the view. - - Defines if the scale was actually changed due to this operation. - Forces recalculation of the Min / Max values, instead of using cached values. - - - - GridSegmentIndex. - Clip grid inside segment of the index. - If this set to -1, no grid cliping occurs of the X-axis. - If index is greater than zero, clip the grid of the certain segment. - - - - - Labels position. - - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - X-axis placement as percents of the graph height. - 0 sets the axis in top edge, 50 in the middle and 100 in bottom edge. - - - - - ScaleBreaks list. Used to not display defined axis value ranges. - - - - - Scrolling gap, percents of graph width. - Used when ScrollType is set to Scrolling. - If this set to 0, scrolling occurs when scroll position reaches end of the X-axis. - Valid range is 0...90 % - - - - - Scroll mode. In real-time monitoring, set 'Scrolling', 'Sweeping' or 'Stepping', and - give current monitoring position via ScrollPosition property. - If not real-time monitoring, but displaying data normally, you should set this to 'None' (default). - - - - - Current real-time scrolling position, in X axis values. - This is intended to be updated by the real-time monitoring process. - - - - - Stepping interval. - Used when ScrollType is set to Stepping. - Current scrolling position, in number values (ValueType = Number) or seconds (ValueType = Time). - - - - - Sweeping gap, percents of graph width. - Used when ScrollType is set to Sweeping. - Valid range is 0...20 % - - - - - Axis title. - - - - - Converts object to string representation - - Object as string. - - - - Triggering options. Used when ScrollMode is 'Triggered'. - - - - - Axis units. - - - - - Converts X value to screen coordinates - - X values - If true return values are in DIPs, otherwise in PX. - X screen coordinates - - - - Converts X value to screen coordinate - - X value - Defines if the return value is in DIP's or PX. - X screen coordinate - - - - Converts X value to screen coordinate. - Version that returns double instead of float. - - X value - Defines if the return value is in DIP's or PX. - X screen coordinate - - - - Axis alignment from its calculated position. - - - - - 3D X-axis. - - - - - Constructor for Form designer's list editor. - - - - - Constructor. - - Parent. - Is this axis primary. If not primary, it's secondary. - - - - Manually set location. This selection is ignored when AutoLocation is used. - - - - - Orientation plane of the axis bar and ticks. - - - - - XY view axis base class. - - - - - Axis min and max values adjust by user. Draws scale nibs in the ends of the axis. - - - - - Axis scrolling by user. Drag from axis line. - - - - - Allow series adding to this axis by dragging it from other axis of this chart - or from another chart's axis. Once the drag drop operation is complete, the series - is removed from the axis/chart where the drag begun and the series is assigned for the target axis. - - - - - Initialize members. Implementation differs with WPF slightly. - - - - - Create scale nib. - - - - - Dispose. - - - - - Arction.Wpf.Charting.Axes.AxisXYBase - - - - - - - Axis scrolling or scaling snaps to divisions. - - - - - Defines if labels are shown at minimum and maximum axis values. - - - - - - - summary - P:Arction.Wpf.Charting.Axes.AxisXYBase.EndPointMajorTickThreshold - - - - - - - Get active axis area (in PX). - - Axis active rectangle with absolute coordinates [PX]. - - - - Get major ticks for current axis range. - - Major tick positions, in ascending order. - - - - Grid strip color. - Views AxisLayout.AxisGridStrips property must define the strips to be used in order for this color to have any effect. - - - - - Defines if mouse is over an item. - - Mouse X-coordinate. - Mouse Y-coordinate. - Use DIP instead of pixels as parameters. - True if mouse is over item, false otherwise. - - - - Gap between labels and ticks. Value is in pixels. - - - - - Axis scrolling cursor - - - - - Scale dragging cursor - - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Owner view. - - - - - Panning is enabled. - - - - - Defines if end point labels should be always visible, and nearby major tick labels should be hidden instead of the axis end point labels. - - - - - Range revert enabled. Disable this if you don't want the RangeRevert operation to effect this axis. - - - - - Range revert maximum. Sets axis Maximum to this value when Range revert operation is applied with mouse, or called by code. - - - - - Range revert minimum. Sets axis Minimum to this value when Range revert operation is applied with mouse, or called by code. - - - - - Set true if you want to have low values higher - and the high values lower on the graph. - - - - - Scale nib appearance. - - - - - Set proper cursor. Default for dragging is hand and for resize SizeAll. - - - - - Store Revert values, minimum and maximum at same time. - - Minimum - Maximum - - - - Zooming is enabled. - - - - - Gets or sets zoom origin. - - - - - Y-axis class. - - - - - Constructor for Form designer's list editor. - - - - - Constructor. - - - - - param - owner - M:Arction.Wpf.Charting.Axes.AxisY.#ctor(Arction.Wpf.Charting.Views.ViewXY.ViewXY) - - - - - - - Constructor. - - - - - param - owner - M:Arction.Wpf.Charting.Axes.AxisY.#ctor(Arction.Wpf.Charting.Views.ViewXY.ViewXY,System.Boolean) - - - - - - - param - attachToView - M:Arction.Wpf.Charting.Axes.AxisY.#ctor(Arction.Wpf.Charting.Views.ViewXY.ViewXY,System.Boolean) - - - - - - - Axis alignment from its calculated position. - - - - - Allow automatic Y fitting. - - - - - Initialize members. - - - - - Convert screen coordinates to values. - - Screen coordinates - Output values - If true, coordsY is interpreted as coordinates in DIPs, otherwise in PX. - - - - param - useDIP - M:Arction.Wpf.Charting.Axes.AxisY.CoordsToValues(System.Single[],System.Double[]@,System.Boolean) - - - - True if OK. - - - - Convert screen coordinate to value. - - Y screen coordinate. - Output value. - Use DIP instead of pixels as parameters. - True if OK. - - - - Create scale nib. - - - - - Create title. - - - - - Create units. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Axis automatic location, when YAxisAutoPlacement is Explicit. - - - - - Fit axis minimum and maxium to show all series values. Note that first argument's value type defines Margin's units (Pixels or Percents). - - Margin to leave between axis minimum or maximum and series values, - in percents of minimum...maximum range. - Method sets this true if Y-axis minimum or maximum has changed. - If true, all series points are searched, resulting to better accuracy, but with a cost raised CPU load. - Ignore zeros values from logarithmic axis fitting. - - - - Fit axis minimum and maximum to show all series values, while keeping the range withing given limits. - Note that first argument's value type defines Margin's units (Pixels or Percents). - - Margin to leave between axis minimum or maximum and series values, - in percents of minimum...maximum range. - Method sets this true if Y-axis minimum or maximum has changed. - If true, all series points are searched, resulting to better accuracy, but with a cost raised CPU load. - Ignore zeros values from logarithmic axis fitting. - Minimum limit. If detected minimum is below limit minimum, the limit applies. - Maximum limit. If detected minimum is below limit minimum, the limit applies. - - - - Fit axis minimum and maxium to show all series values. Note that first argument's value type defines Margin's units (Pixels or Percents). - - Margin to leave between data and segment boundaries, - in pixels of minimum...maximum range. - Method sets this true if Y-axis minimum or maximum has changed. - If true, all series points are searched, resulting to better accuracy, but with a cost raised CPU load. - Ignore zeros values from logarithmic axis fitting. - - - - Fit axis minimum and maximum to show all series values, while keeping the range withing given limits. - Note that first argument's value type defines Margin's units (Pixels or Percents). - - Margin to leave between data and segment boundaries, - in pixels of minimum...maximum range. - Method sets this true if Y-axis minimum or maximum has changed. - If true, all series points are searched, resulting to better accuracy, but with a cost raised CPU load. - Ignore zeros values from logarithmic axis fitting. - Minimum limit. If detected minimum is below limit minimum, the limit applies. - Maximum limit. If detected minimum is below limit minimum, the limit applies. - - - - Get bar series minimum and maximum value, bound to this Y axis. - If stacked bar view is used, returns the highest stack sum. - - Total minimum. - Total maximum. - Ignore zeros. - True if successfully got. - - - - Gets the axis graph segment top and height in pixels. - - Segment top in pixels. - Segment height in pixels. - True on successful result, else false. - - - - Get minimum and maximum of all series that are using this axis. - - Maximum. - Minimum. - True if success. False if no data found. - - - - Miniature scale symbol. - - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Palette is retrieved from this series for Y value range. - - - - - Y-axis placement as percents of the graph width. - 0 sets the axis in left edge, 50 in the middle and 100 in right edge. - - - - - Position offset shifts the axis by pixel count set. - It allows placing the axis for example outside the graph area, - handy feature when you have many Y axis and you don't want them to overlap series data. - - - - - Axis segment index. - - - - - Axis title. - - - - - Converts object to string representation. - - Object as string. - - - - Axis units. - - - - - Use palette from referenced series for Y-axis coloring. - - - - - Convert values to Y-coordinates. - - Axis values. - Use DIP instead of pixels as parameters. - Coordinates. - - - - Convert value to Y-coordinate. - - Axis value. - Use DIP instead of pixels as parameters. - Coordinate. - - - - 3D Y-axis. - - - - - Constructor for Form designer's list editor - - - - - Constructor. - - Parent. - Is this axis primary. If not primary, it's secondary. - - - - Clean up any resources being used. - - True if managed resources should be disposed, otherwise false. - - - - Manually set location. This selection is ignored when AutoLocation is used. - - - - - Orientation plane of the axis bar and ticks. - - - - - 3D Z-axis. - - - - - Constructor for Form designer's list editor. - - - - - Constructor. - - Parent. - Is this axis primary. If not primary, it's secondary. - - - - Clean up any resources being used. - - True if managed resources should be disposed, otherwise false. - - - - Manually set location. This selection is ignored when AutoLocation is used. - - - - - Orientation plane of the axis bar and ticks. - - - - - Custom axis tick. - - - - - Constructor for Form designer's list editor. - - - - - Constructor. - - Parent. - - - - Constructor. - - Parent. - Value on axis. - Label text. - - - - Constructor. - - Parent. - Value on axis. - Color. - Tick length in pixels. - Visibility. - Style, is grid or tick visible, or both. - Label text. - - - - Value at axis. - - - - - Used to set Line color. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Used to set Label text. - - - - - Used to set Tick Length. - - - - - OnDeserialized is called just after the object has been deserialized. - - Context - - - - Used to set Custom Tick And Grid Style. - - - - - Convert class description to string. - - String. - - - - Used to define visibility. - - - - - Represents a class that provides arguments for the event. - - - - - Creates and initializes a new instance of FormatValueLabelEventArgs class. - - - - - Axis object. - - - - - Axis tick value. - - - - - Represents a base class for RangeChanged event argument classes. - - - - - Creates and initializes a new instance of RangeChangedBaseEventArgs class. - - - - - Set 'true' to prevent flickering if you update the chart in the event handler. - - - - - X value, new maximum value. - - - - - Y value, new minimum value. - - - - - Represents a class that provides arguments for the RangeChanged event. - - - - - Creates and initializes a new instance of RangeChangedEventArgs class. - - - - - Axis object. - - - - - Represents a class that provides arguments for the RangeChanged event. - - - - - Creates and initializes a new instance of RangeChangedPolarEventArgs class. - - - - - Axis object. - - - - - Represents a class that provides arguments for the RangeChanged event. - - - - - Axis object. - - - - - Set 'true' to prevent flickering if you update the chart in the event handler. - - - - - New reference value of the axis. - - - - - Exclude range for excluding defined values from axis values. - Also contains Gap, which tells in DIPs, how large the range will be on window. - The gap can be rendered by diagonal line or fill or just remain empty. - - - - - Constructor for Form designer's list editor. - - - - - Constructor. - - Parent. - - - - Constructor. - - Owner axis. - Begin value. - End value. - Gap in DIPs. - - - - Range begin value. - - - - - IComparison implementation based on Begin value. If Begin values are same, order is determined by End values. - - Other instance to compare to. - -1 if this is before other, 0 if equal (Begins are same), 1 of this is after other. - - - - Gap of lines in pixels. Applied, if fill style is line. - - - - - Clean up any resources being used. - - True if managed resources should be disposed, otherwise false. - - - - Enabled. - - - - - Range end value. - - - - - Gap Fill. Applicable if Style is set to Fill. - - - - - Gap of range in pixels. - - - - - Gap line style, if style is diagonal line. - - - - - OnDeserialized is called just after the object has been deserialized. - - Context - - - - Tells if another ScaleBreaks overlaps this. - - Compared ScaleBreaks. - True, if overlaps, false otherwise. - - - - Gap style. - - - - - Convert class description to string. - - String. - - - - Represents a class that provides arguments for the SupplyCustomAmplitudeString event. - - - - - Creates and initializes a new instance of SupplyCustomAmplitudeStringEventArgs class. - - - - - Value. - - - - - Value as string. - - - - - Represents a class that provides arguments for the SupplyCustomAngleString event. - - - - - Creates and initializes a new instance of SupplyCustomAngleStringEventArgs class. - - - - - Angle. - - - - - Angle as string. - - - - - Angle the label text is drawn at. - Modify this to change the angle. - - - - - Imaginary value event arguments class. - - - - - Constructor. - - Imaginary value. - Axis. - - - - Imaginary value. - - - - - Imaginary value as string. - - - - - Axis value event arguments class. - - - - - Constructor. - - Real value. - Axis. - - - - Real value. - - - - - Real value as string. - - - - - Chart manager handles charts co-operation. - - - - - Creates and initializes a new instance of this class. - - - - - Creates and initializes a new instance of this class. - - The component container. - - - - List of charts to be coordinated. Don't add items with form designer. Instead, use ChartManager property for each chart to assign the manager. - - - - - Use separate thread for forced garbage collection. - Increases data drawing smoothness, but causes some extra CPU overhead. - Recommended to be used with multi-core processors. - - - - - Name of the component - - - - - Series dragging has finished on a chart, over an Y-axis. - - - - - Series dragging has started on a chart - - - - - Convert class description to string - - String - - - - Delegate for SeriesDragFinished event - - Chart where the dragging has been finished - Chart where the dragging has been started - Series being dragged - Y-axis where the dragging has been finished - - - - Delegate for SeriesDragStarted event. - - Chart where the dragging has been started. - Series being dragged. - - - - Cylindrical / 3D cartesian coordinates converter class. - XZ plane is the reference plane (polar coordinates plane). - - - - - Convert cylindrical point to cartesian XYZ point. - - Cylindrical point. - Cartesian point. - - - - Convert cylindrical point array to a surface point array. Fills X, Y and Z fields of SurfacePoints. - - Cylindrical points. - Surface point array. - - - - Convert cylindrical point array to a series point array. Fills X, Y and Z fields of SeriesPoints3D. - - Cylindrical points. - Series point array. - - - - Convert a cartesian XYZ point into cylindrical point. - - Cartesian point. - Cylindrical point. - - - - Cylindrical point. - - - - - Heading angle. Also called as azimuth and absolute bearing. - - - - - Distance along XZ plane. - - - - - Y value. - - - - - Spherical to 3D cartesian coordinates converter class. - Assumes spherical data point to be defined in azimuth / elevation system coordinates. - For elevation, the XZ plane is the reference plane. (e.g. equatorial plane). Elevation is angle measured from that plane. - To apply values from polar inclination system, use formula Elevation = 90 - Inclination. - - - - - Convert spherical point to cartesian XYZ point. - - Spherical point. - Cartesian point. - - - - Convert spherical point array to a surface point array. Fills X, Y and Z fields of SurfacePoints - - Spherical points - Surface point array - - - - Convert spherical point array to a series point array. Fills X, Y and Z fields of SeriesPoints3D. - - Spherical points. - Series point array. - - - - Convert a cartesian XYZ point into spherical point. - - Cartesian point. - Spherical point. - - - - Spherical point. - - - - - Distance from origin (0, 0, 0). - - - - - Elevation angle. - Also called as Elevation or Altitude, measured from XZ plane. ElevationAngle is 90 degrees - Inclination angle. - - - - - Heading angle. Also called as azimuth and absolute bearing. - - - - - Interaction logic for HalfDonut - - - - - HalfDonut User control made by LightningChart Polar view - - - - - Add a slice. SliceValue must be non negative. If negative, won't be added. - - Value of Slice - Slice indicator AKA tag,name... - Slice color. - - - - HSVA Alpha 0-1. - - - - - Angle origin in degrees. Valid range is 0-360. - - - - - When updating multiple properties at once, use BeginUpdate before and EndUpdate after property changes to reduce the number of rendered frames. - - - - - Change slice color. - - Index of the slice - New color - - - - returns - M:Arction.Wpf.Charting.CustomControls.HalfDonut.ChangeSliceColor(System.Int32,System.Windows.Media.Color) - - - - - - - Color steps between slices. Used when ColorScale is set to HSV or HSVA. - - - - - Custom hover text. - - - - - Custom left side text. - - - - - Custom marker text. - - - - - Custom needle text. - - - - - Custom right side text. - - - - - Digit count shown in texts. - - - - - Disposes the HalfDonut. - - - - - End and start point text. - - - - - Sector end angle. Value must be between StartAngle (exclusive) and 360 (inclusive). - - - - - When updating multiple properties at once, use BeginUpdate before and EndUpdate after property changes to reduce the number of rendered frames. - - - - - Gets the internal LightningChart component. - - LightningChart object - - - - Gets the left side text AnnotationPolar. - - - - - returns - M:Arction.Wpf.Charting.CustomControls.HalfDonut.GetLeftSideText - - - - - - - Gets the marker as a Sector. - - - - - returns - M:Arction.Wpf.Charting.CustomControls.HalfDonut.GetMarker - - - - - - - Gets the needle object as AnnotationPolar. - - - - - returns - M:Arction.Wpf.Charting.CustomControls.HalfDonut.GetNeedle - - - - - - - Gets the right side text as AnnotationPolar. - - - - - returns - M:Arction.Wpf.Charting.CustomControls.HalfDonut.GetRightSideText - - - - - - - Background color. - - - - - Font of texts. - - - - - Hides or shows a slice. - - slice index - Boolean to show or hide a slice - If successful - - - - End indicator text. - - - - - Start indicator text. - - - - - InitializeComponent - - - - - Inner circle color. - - - - - Marker color. - - - - - Marker value radial offset percentage. - - - - - Value of indicator marker. - - - - - Marker width. - - - - - Middle annotation text. - - - - - Middle text location in PointPolar values. - - - - - Needle color. - - - - - Needle target value. - - - - - Needle value type. - - - - - Overlay annotation. - - - - - Removes the slice at given index. - - - - - param - i - M:Arction.Wpf.Charting.CustomControls.HalfDonut.RemoveSlice(System.Int32) - - - - - - - returns - M:Arction.Wpf.Charting.CustomControls.HalfDonut.RemoveSlice(System.Int32) - - - - - - - HSVA Saturation 0-1. - - - - - Selected color palette. - - - - - Show legend box. - - - - - Show needle indicator. - - - - - Show tool tips above Donut sectors. - - - - - Slice click functionality. - - - - - Returns total slice count. - - Slice count - - - - Sector start angle. Value must be between 0 (inclusive) and EndAngle (exclusive). - - - - - Starting color value. Should be between 0 and 360. - - - - - Half donut title. - - - - - HSVA value 0-1. - - - - - Color scale. - - - - - Use Hue, Saturation, Value Colors static colors. - - - - - Use Hue, Saturation, Value, Alpha Colors. - Set alpha through Alpha. - Saturation through Saturation. - Value through Value. - - - - - Use Colors defined in individual slices. - - - - - End and StartPoint text selection. - - - - - Show default text in end and start point - - - - - Custom text - - - - - Hover annotation text. - - - - - Shows default hover annotation texts (indicator and value). - - - - - Update CustomHoverText string to show it in an annotation. - - - - - Needle value type. - PercentualAndOverall is default. - - - - - Show procentual value between marker and needle and overall value of half donut. - - - - - Show Custom Texts - - - - - Slice click function. - - - - - Disable Click functionality - - - - - Removes the slice when clicked - - - - - Hides the slice when clicked - - - - - Interaction logic for HalfDonutControlPanel.xaml - - - - - This Control panel can control multiple HalfDonuts at once. - - - - - List of HalfDonuts - - - - - InitializeComponent - - - - - Selected Theme of HalfDonut Control panel. - - - - - Half donut theme - - - - - Themes. - - - - - Dark theme for light Background. - - - - - Light theme for dark Background. - - - - - Series type to invalidate. - - - - - Invalidate all Pointlineseries - - - - - Invalidate all AreaSeries - - - - - Invalidate All HighlowSeries - - - - - Invalidate All FreeformPointlineSeries - - - - - Invalidate All ChartEventMarkers - - - - - Invalidate All LineCollections - - - - - Invalidate SampleDataBlockSeries - - - - - Invalidate SampleDataSeries - - - - - Invalidate DigitalLineSeries - - - - - Invalidate StockSeries - - - - - Invalidate BarSeries - - - - - Invalidate IntensityGridSeries - - - - - Invalidate IntensityMeshSeries - - - - - Invalidate PolygonSeries - - - - - Invalidate LiteFreeFormLineSeries - - - - - Invalidate LiteLineSeries - - - - - Invalidate AllSeries - - - - - Series property to change - - - - - Lines of series - - - - - Points of Series - - - - - Fill of series - - - - - Show Y axis range indicator - - - - - AutoFit - - - - - Interaction logic for ViolinPlot.xaml - - - - - ViolinPlot Custom Control. Depicts distributions of numeric data for one or more groups using density curves. - - - - - Adds a Violin (e.g. KDE) with whiskers. - Whiskers show the range from minimum to maximum. - - Minimum value - Maximum value - X-value the Violin is centered to - Width as X-axis range - Caption text - Fill color - X-axis label text - KDE profile - - - - Begin updating. Disables control repaints when a property is changed. - - - - - Dispose - - - - - End updating. Enables control repainting and refreshes the control. - - - - - Gets inner LightningChart object. - - LightningChart object - - - - InitializeComponent - - - - - Sets X-axis title - - Axis title - - - - Sets Y-axis title - - Axis title - - - - Empty space left on top and bottom of the chart. - - Empty space in axis units - - - - ZoomBar UserControl - ZoomBar user control can be used to get an overview of the whole dataset and to zoom the referenced LightningCahrt instance to specific areas - - - - - ZoomBar user control can be used to get an overview of the whole dataset and to zoom the referenced LightningCahrt instance to specific areas - - Reference of LightningChart instance - - - - ZoomBar user control can be used to get an overview of the whole dataset and to zoom the referenced LightningCahrt instance to specific areas - - Reference of LightningChart instance - ZoomBarOptions - - - - Updates AreaSeries with new data points in a real-time chart. - - Index of the Area Series - Area series data array - - - - Updates BarSeries with new data points in a real-time chart. - - Index of the BarSeries - X-value for the bar - Y-value for the bar - Label text for the bar - - - - Updates ChartEventMarkers in a real-time chart. - - Chart event marker to be added - - - - Updates DigitalLineSeries with new data points in a real-time chart. - - Index of the DigitalLineSeries - Data array - - - - Updates FreeformPointLineSeries with new data points in a real-time chart. - - Index of the FreeformPointLineSeries - Data point X-value array - Data point Y-value array - - - - Updates HighLowSeries with new data points in a real-time chart. - - Index of the HighLowSeries - HighLow data array - - - - Updates Line Collections with new line segments in a real-time chart. - - Index of the LineCollection - Segment line to be added - - - - Updates LiteFreeformLineSeries with new data points in a real-time chart. - - Index of the LiteFreeformLineSeries - Data array - - - - Updates LiteLineSeries with new data points in a real-time chart. - - Index of the LiteLineSeries - Data point array - - - - Updates PointLineSeries with new data points in a real-time chart. - - Index of the PointLineSeries - Data point array - - - - Updates SampleDataBlockSeries with new data points in a real-time chart. - - Index of the SampleDataBlockSeries - Sample data array - - - - Updates SampleDataSeries with new data points in a real-time chart. - - Index of the SampleDataSeries - Data samples as double array - - - - Updates SampleDataSeries with new data points in a real-time chart. - - Index of the SampleDataSeries - Data samples as float array - - - - Updates StockSeries with new data points in a real-time chart. - - Index of the StockSeries - Stock series data array - - - - BeginUpdate for real-time ZoomBar. Disables updating control when a property has been changed. - - - - - Disposes the control. - - - - - Automatically adjusts the axis ranges to fit all the data on the chart. - - - - - EndUpdate for real-time ZoomBar. Enables updating control. - - - - - Gets the inner LightningChart object. - - - - - returns - M:Arction.Wpf.Charting.CustomControls.ZoomBar.GetInnerChart - - - - - - - InitializeComponent - - - - - Invalidates specific series types. - - Series type to update. - - - - Invalidates the Zoom bar's Y-axes. - - - - - Updates SampleDataSeries with new data points in a real-time chart. - - Index of the SampleDataSeries - Data samples as double array - First index where to insert data - - - - Updates SampleDataSeries with new data points in a real-time chart. - - Index of the SampleDataSeries - Data samples as float array - First index where to insert data - - - - Updates which LightningChart instance is being referenced. - - LightningChart instance - - - - Updates which LightningChart instance is being referenced. - - LightningChart instance - Zoom bar options - - - - Options to control the Zoom bar's behaviour. - - - - - Zoom Bar options - - - - - Default constructor - - - - - Automatically fits Zoom bar to show all data. - - - - - Fits Zoom bar automatically when new data is added. - - - - - Raise PropertyChanged - - - - param - e - M:Arction.Wpf.Charting.CustomControls.ZoomBarOptions.OnPropertyChanged(Arction.Wpf.Charting.CustomControls.ZoomBarOptions.PropertyChangedInOptions) - - - - - - - Series to be used in the Zoom bar. - - - - - Fits Zoom bar vertically to show all data. - - - - - Mouse wheel zoom level - - - - - Series to be shown in the Zoom bar. - - - - - What series is activated for ZoomBar - - - - - AreaSeries - - - - - BarSeries - - - - - ChartEventMarkers - - - - - DigitalLineSeries - - - - - FreeformPointlineSeries - - - - - HighlowSeries - - - - - IntensityGridSeries - - - - - IntensityMeshSeries - - - - - LineCollections - - - - - LiteFreeFormPointLineSeries - - - - - LiteLineSeries - - - - - PointLinesSeries - - - - - PolygonSeries - - - - - SampleDataBlockSeries - - - - - SampleDataSeries - - - - - StockSeries - - - - - For AreaSeries based series - - - - - Constructor - - - - - Points visibility - - - - - Line visibility - - - - - Raise PropertyChanged - - - - param - e - M:Arction.Wpf.Charting.CustomControls.ZoomBarOptions.AreaSeriesBased.OnPropertyChanged(Arction.Wpf.Charting.CustomControls.ZoomBarOptions.AreaSeriesBased.PropertyChangedInOptions) - - - - - - - Points visibility - - - - - Error message event class - - - - - For PointLine based series - - - - - Constructor - - - - - Line visibility - - - - - Raise PropertyChanged - - - - param - e - M:Arction.Wpf.Charting.CustomControls.ZoomBarOptions.PointsAndLines.OnPropertyChanged(Arction.Wpf.Charting.CustomControls.ZoomBarOptions.PointsAndLines.PropertyChangedInOptions) - - - - - - - Points visibility - - - - - Error message event class - - - - - Error message event class - - - - - DataCursor shows information about the closest data value to the mouse cursor. - - - - - Simple constructor for Form designer's list editor. - - - - - Constructor. - - Parent. - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Label font. - - - - - Line style. - - - - - Increases performance in real-time applications by updating the cursor less frequently. - - - - - Customization options for the result table. - - - - - Show Color indicator above the result table. - - - - - Show haircross lines. - - - - - Show axis labels. - - - - - Show result table. - - - - - Show Tag indicator in the result table. - - - - - Show tracking point. - - - - - Automatically snaps to the nearest point in any direction. - - - - - Tag field name in the result table if ShowTag is enabled. - - - - - Convert class description to string - - String - - - - Tracking point style. - - - - - DataCursor Visible state. - - - - - ResultTable showing information about the closest data value. - - - - - Simple constructor for Form designer's list editor. - - - - - Constructor. - - Parent. - - - - Result table background fill. - - - - - Border options for the result table. - - - - - Data row font. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Padding is the empty space between the border and internal visuals. - - - - - Rotation angle in degrees. The rotation is done around the element's closest corner point. - - - - - Text color. Used for both series title and data labels and values. - - - - - Title text font. - - - - - Convert class description to string - - String - - - - Use series title color instead of TextColor property in the texts. - - - - - Chart event marker class. You can mark some interesting event with a marker, which can - be a of great value later on. - - - - - Constructor. - - - - - Chart event marker constructor. - - X value. - Label. - If true, set X-axis value with xValue. - X-axis to bind. - Otherwise the marker is only positioned using Offset coordinates. - Offset. - ViewXY that owns this object. - Symbol options. - Vertical position. - - - - param - axisX - M:Arction.Wpf.Charting.EventMarkers.ChartEventMarker.#ctor(Arction.Wpf.Charting.Views.ViewXY.ViewXY,Arction.Wpf.Charting.PointShapeStyle,Arction.Wpf.Charting.ChartEventMarkerVerticalPosition,System.Boolean,Arction.Wpf.Charting.Axes.AxisX,System.Double,Arction.Wpf.Charting.Titles.EventMarkerTitle,Arction.Wpf.Charting.PointInt) - - - - - - - Index of X-axis assigned to this series. Give -1 when you don't want to assign it yet to any X-axis. - - - - - Defines if the marker is bound to X-axis by XValue. - - - - - Clip inside X-axis range. - - - - - Create symbol. - - - - - Event marker X or Y value has been changed - - - - - Set item drag end position as axis values. - - - - - param - x - M:Arction.Wpf.Charting.EventMarkers.ChartEventMarker.SetItemDragPosition(System.Int32,System.Int32,System.Boolean) - - - - - - - param - y - M:Arction.Wpf.Charting.EventMarkers.ChartEventMarker.SetItemDragPosition(System.Int32,System.Int32,System.Boolean) - - - - - - - param - FinalPosition - M:Arction.Wpf.Charting.EventMarkers.ChartEventMarker.SetItemDragPosition(System.Int32,System.Int32,System.Boolean) - - - - - - - Item center position when dragging starts. - - - - - Item to string. - - String. - - - - Event marker vertical position. - - - - - X value of event. - - - - - The delegate to use for handlers that receive the PositionChanged event. - - The object that raised the event. - Provides data for the PositionChanged event. - - - - Event marker common base class for XY and polar chart. - - - - - typeparam - SYMBOL - T:Arction.Wpf.Charting.EventMarkers.EventMarkerCommonBase`1 - - - - - - - Constructor for Form editor. - - - - - Constructor. - - Parent. - - - - Marker is clipped inside graph area. - - - - - Create label. - - - - - Create offset. - - - - - Create symbol. - - - - - Clean up any resources being used. - - True if managed resources should be disposed, otherwise false. - - - - Defines if mouse is over an item. - - Mouse X-coordinate. - Mouse Y-coordinate. - Use DIP instead of pixels as parameters. - True if mouse is over item, false otherwise. - - - - Event marker title label. - - - - - Cursor under dragging. Override this if needed - - - - - Symbol offset from it's designated position. - - - - - OnDeserialized is called just after the object has been deserialized. - - Context. - - - - Set item drag end position as axis values. - - - - - param - x - M:Arction.Wpf.Charting.EventMarkers.EventMarkerCommonBase`1.SetItemDragPosition(System.Int32,System.Int32,System.Boolean) - - - - - - - param - y - M:Arction.Wpf.Charting.EventMarkers.EventMarkerCommonBase`1.SetItemDragPosition(System.Int32,System.Int32,System.Boolean) - - - - - - - param - FinalPosition - M:Arction.Wpf.Charting.EventMarkers.EventMarkerCommonBase`1.SetItemDragPosition(System.Int32,System.Int32,System.Boolean) - - - - - - - Item center position when dragging starts. - - - - - Marker symbol. - - - - - Defines if event marker is visible or not. - - - - - Fill class that can be applied to a rectangle. - - - - - Constructor for Form editor. - - - - - Constructor. - - Parent. - - - - Bitmap fill options. - - - - - Fill color. - - - - - Create members. - - - - - Create bitmap fill. - - - - - Clean up any resources being used. - - True if managed resources should be disposed, otherwise false. - - - - Gradient color. - - - - - Gradient direction. - - - - - Gradient type. - - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Fill style. - - - - - Polar event marker class. You can mark some interesting event with a marker, which can - be a of great value later on. - - - - - Constructor for Form editor. - - - - - Polar event marker constructor. - - Parent. - Axis to connect to. - Symbol options. - Angle value. - Amplitude. - Label. - Offset. - - - - Amplitude of event. - - - - - Angle value of event. - - - - - Index of polar axis assigned to this series. Give -1 when you don't want to assign it yet to any axis. - - - - - Defines how the marker should be clipped at the center of the graph. - - - - - Occurs when position is changed. - - - - - returns - M:Arction.Wpf.Charting.EventMarkers.PolarEventMarker.EmitPositionChanged - - - - - - - Occurs when the X-axis position of the event marker has changed. - - - - - Set item drag end position. - - - - - param - x - M:Arction.Wpf.Charting.EventMarkers.PolarEventMarker.SetItemDragPosition(System.Int32,System.Int32,System.Boolean) - - - - - - - param - y - M:Arction.Wpf.Charting.EventMarkers.PolarEventMarker.SetItemDragPosition(System.Int32,System.Int32,System.Boolean) - - - - - - - param - FinalPosition - M:Arction.Wpf.Charting.EventMarkers.PolarEventMarker.SetItemDragPosition(System.Int32,System.Int32,System.Boolean) - - - - - - - Convert class description to string. - - String. - - - - The delegate to use for handlers that receive the PositionChanged event. - - The object that raised the event. - Provides data for the CheckBoxStateChanged event. - - - - Represents a class that provides arguments for the PositionChanged event. - - - - - Polar Position Changed EventArgs. - - - - - Represents a class that provides arguments for the PositionChanged event. - - - - - Creates and initializes a new instance of PositionChangedEventArgs class. - - - - - Marker. - - - - - X value. - - - - - Represents a class that provides arguments for the PositionChanged event. - - - - - Creates and initializes a new instance of PositionChangedSeriesEventMarkerEventArgs class. - - - - - Set 'true' to prevent flickering if you update the chart in the event handler. - - - - - Marker. - - - - - X value. - - - - - Y value. - - - - - Polar event marker base class. - - - - - Constructor. - - Parent. - - - - Create symbol. - - - - - Occurs when position is changed. - - True if CancelRendering was set to true. - - - - Getter of the series for the marker to snap to. - - - Current series the snapping is enabled to, if set. Null if none is set. - - - - - Setter of the series for the marker to snap to. - - - - - param - snapSeries - M:Arction.Wpf.Charting.EventMarkers.RoundEventMarkerBase.SetSnapSeries(Arction.Wpf.Charting.SeriesRound.SeriesBaseRound) - - - - - - - Snapping series selector. The selected series is snapped to, if - the SnapMode is set to Selected. Otherwise this has no meaning. - The Series must be of this view. - - - - - Snapping mode. Defines how the marker should behave when dragged. - - - - - Convert class description to string - - String - - - - Marker snap type. - - - - - Marker does not snap to any series points. - Snapping disabled. This is usually the default and the fastest - option. - - - - - Marker snaps to the closest point of a selected series. - Selected series can be set by using SetSnappingSeries method. - - - - - Marker snaps to the closest point of any active and visible series. - - - - - Represents a class that provides arguments for the PositionChanged event. - - - - - typeparam - P - T:Arction.Wpf.Charting.EventMarkers.RoundPositionChangedEventArgs`2 - - - - - - - typeparam - M - T:Arction.Wpf.Charting.EventMarkers.RoundPositionChangedEventArgs`2 - - - - - - - Creates and initializes a new instance of PositionChangedEventArgs class. - - - - - If you update the chart in the event handler, set to true to prevent flickering. - - - - - Marker. - - - - - New position of the marker. - - - - - Event marker that can be attached to a series. - - - - - Constructor for Form editor. - - - - - Series event marker constructor. - - - - - param - owner - M:Arction.Wpf.Charting.EventMarkers.SeriesEventMarker.#ctor(Arction.Wpf.Charting.SeriesXY.SeriesBaseXY) - - - - - - - Series event marker constructor. - - Parent. - Symbol. - Vertical position. - X value. - Y value. - Label. - - - - Create symbol. - - - - - Clean up any resources being used. - - True if managed resources should be disposed, otherwise false. - - - - Get the series who owns this marker. - - Owner series. - - - - Horizontal position. - - - - - Is mouse over item. - - Mouse X-coordinate - Mouse Y-coordinate - Use DIP instead of pixels as parameters. - True if mouse is over item, false otherwise. - - - - Event marker X or Y value has been changed. - - - - - Set item drag end position as axis values. - - - - - param - x - M:Arction.Wpf.Charting.EventMarkers.SeriesEventMarker.SetItemDragPosition(System.Int32,System.Int32,System.Boolean) - - - - - - - param - y - M:Arction.Wpf.Charting.EventMarkers.SeriesEventMarker.SetItemDragPosition(System.Int32,System.Int32,System.Boolean) - - - - - - - param - FinalPosition - M:Arction.Wpf.Charting.EventMarkers.SeriesEventMarker.SetItemDragPosition(System.Int32,System.Int32,System.Boolean) - - - - - - - Item to string. - - String. - - - - Vertical position. - - - - - X value of marker. - - - - - Y value of marker. - - - - - The delegate to use for handlers that receive the PositionChanged event. - - The object that raised the event. - Provides data for the PositionChanged event. - - - - Polar event marker class. You can mark some interesting event with a marker, which can - be a of great value later on. - - - - - Constructor for Form editor. - - - - - Polar event marker constructor - - Parent. - Axis to connect to. - Symbol options. - Real value. - Imaginary value. - Label. - Offset. - - - - Clean up any resources being used. - - True if managed resources should be disposed, otherwise false. - - - - Occurs when position is changed - - - - - returns - M:Arction.Wpf.Charting.EventMarkers.SmithEventMarker.EmitPositionChanged - - - - - - - Imaginary value of event. - - - - - OnDeserialized is called just after the object has been deserialized. - - Context - - - - Occurs when the position of the event marker has changed. - - - - - Real value of event. - - - - - Set item drag end position. - - X-coordinate - Y-coordinate - - - - param - finalPosition - M:Arction.Wpf.Charting.EventMarkers.SmithEventMarker.SetItemDragPosition(System.Int32,System.Int32,System.Boolean) - - - - - - - Convert class description to string. - - String. - - - - The delegate to use for handlers that receive the PositionChanged event. - - The object that raised the event. - Provides data for the CheckBoxStateChanged event. - - - - Represents a class that provides arguments for the PositionChanged event. - - - - - Smith Position Changed EventArgs. - - - - - New position of the marker. - - - - - Public extensions methods. - - - - - Convert given angle in degrees to radians. - - Angle in degrees - Corresponding angle in radians. - - - - Convert given angle in degrees to radians. - - Angle in degrees - Corresponding angle in radians. - - - - Converts given coordinates defined in DIP (Device Independent Pixels) to PX (Screen pixels) values using system DPI settings. - - Coordinates to convert, defined in DIPs. - Converted coordinates in PX. - - - - Converts given rectangle size and position defined in DIP (Device Independent Pixels) to PX (Screen pixels) - values using system DPI settings. - - Rectangle to convert, defined in DIPs. - Converted rectangle in PX. - - - - Converts given DIP (Device Independent Pixels) values to PX (Screen pixels) using system DPI settings. - - Value to convert in DIPs - If true, the screen width direction DPI factor is used. Height direction otherwise - Converted value in PX. - - - - Converts given DIP (Device Independent Pixels) values to PX (Screen pixels) using system DPI settings. - - Value to convert in DIPs - If true, the screen width direction DPI factor is used. Height direction otherwise - Converted value in PX. - - - - Convert GetLastEngineInitResults to string to help reporting of it's contents. - - - - - param - list - M:Arction.Wpf.Charting.Extensions.Extensions.ItemsToString(System.Collections.IList) - - - - - - - returns - M:Arction.Wpf.Charting.Extensions.Extensions.ItemsToString(System.Collections.IList) - - - - - - - Converts given coordinates defined in PX (Screen pixels) to DIP (Device Independent Pixels) values using system DPI settings. - - Coordinates to convert, defined in pixels. - Converted coordinates in DPIs. - - - - Converts given PX (Screen pixels) to DIP (Device Independent Pixels) values using system DPI settings. - - Value to convert in pixels. - If true, the screen width direction DPI factor is used. Height direction otherwise - Converted value in DPIs. - - - - Converts given rectangle size and position defined in PX (Screen pixels) to DIP (Device Independent Pixels) values using system DPI settings. - - Rectangle to convert, defined in pixels. - Converted rectangle in DPIs. - - - - Converts given PX (Screen pixels) to DIP (Device Independent Pixels) values using system DPI settings. - - Value to convert in pixels. - If true, the screen width direction DPI factor is used. Height direction otherwise - Converted value in DPIs. - - - - Converts given PX (Screen pixels) to DIP (Device Independent Pixels) values using system DPI settings. - - Value to convert in pixels. - If true, the screen width direction DPI factor is used. Height direction otherwise - Converted value in DPIs. - - - - Convert given angle in radians to degrees. - - Angle in radians - Corresponding angle in degrees. - - - - Convert given angle in radians to degrees. - - Angle in radians - Corresponding angle in degrees. - - - - Tile disk cache. - Cache is located at given path. Default is temp folder. - - - - - Constructor. - - - - - Constructor. - - Parent. - - - - Clean up any resources being used. - - True if managed resources should be disposed, otherwise false. - - - - Map license key. - - - - - Button click on map item event arguments. - - - - - Constructor. - - Map item. - Layer. - - - - Layer. - - - - - Map item. - - - - - City. - - - - - Constructor. - - - - - Constructor. - - - - - param - owner - M:Arction.Wpf.Charting.Maps.City.#ctor(Arction.Wpf.Charting.Maps.MapLayer) - - - - - - - Constructor. - - - - - param - owner - M:Arction.Wpf.Charting.Maps.City.#ctor(Arction.Wpf.Charting.Maps.MapLayer,System.Int32) - - - - - - - param - id - M:Arction.Wpf.Charting.Maps.City.#ctor(Arction.Wpf.Charting.Maps.MapLayer,System.Int32) - - - - - - - Country name. - - - - - Location. - - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Population. - - - - - City options. - - - - - Constructor. - - - - - Constructor. - - - - - param - mapData - M:Arction.Wpf.Charting.Maps.CityOptions.#ctor(Arction.Wpf.Charting.Maps.Map) - - - - - - - Create default population categories. - - List of PopulationCategories. - - - - Clean up any resources being used. - - True if managed resources should be disposed, otherwise false. - - - - Major city population. City is considered major if its population is same or exceeds this value. - - - - - Population categories. - - - - - Show cities. - - - - - Convert class description to string. - - String. - - - - Cities type. Determines which kind of cities are shown. - - - - - Cities are not shown. - - - - - Major cities. - - - - - All cities. - - - - - Represents a class that provides arguments for the ConversionStateChanged event. - - - - - Creates and initializes a new instance of ConversionStateChangedEventArgs class. - - - - - Conversion counter. - - - - - Conversion progress indicator. - - - - - Status message. - - - - - Line. - - - - - Constructor. - - - - - Constructor. - - - - - param - owner - M:Arction.Wpf.Charting.Maps.Line.#ctor(Arction.Wpf.Charting.Maps.MapLayer,Arction.Wpf.Charting.Maps.MapLayer.LayerType) - - - - - - - param - lType - M:Arction.Wpf.Charting.Maps.Line.#ctor(Arction.Wpf.Charting.Maps.MapLayer,Arction.Wpf.Charting.Maps.MapLayer.LayerType) - - - - - - - Constructor. - - - - - param - owner - M:Arction.Wpf.Charting.Maps.Line.#ctor(Arction.Wpf.Charting.Maps.MapLayer,Arction.Wpf.Charting.Maps.MapLayer.LayerType,System.Int32) - - - - - - - param - lType - M:Arction.Wpf.Charting.Maps.Line.#ctor(Arction.Wpf.Charting.Maps.MapLayer,Arction.Wpf.Charting.Maps.MapLayer.LayerType,System.Int32) - - - - - - - param - id - M:Arction.Wpf.Charting.Maps.Line.#ctor(Arction.Wpf.Charting.Maps.MapLayer,Arction.Wpf.Charting.Maps.MapLayer.LayerType,System.Int32) - - - - - - - Construct members. - - - - - Overridden dispose method. - - - - - Arction.Wpf.Charting.Maps.Line - - - - - - - Line style. - - - - - OnDeserialized is called just after the object has been deserialized. - - Context - - - - LineLayer. - - - - - Constructor. - - - - - Constructor. - - - - - param - owner - M:Arction.Wpf.Charting.Maps.LineLayer.#ctor(Arction.Wpf.Charting.Maps.Map) - - - - - - - Automatically adjust line width. - - - - - Construct initialized members. - - - - - Line draw style. Determine how line is drawn. - - - - - Line width coefficient. Adjust line width. - - - - - Line options. - - - - - Constructor. - - - - - Constructor. - - - - - param - owner - M:Arction.Wpf.Charting.Maps.LineOptions.#ctor(Arction.Wpf.Charting.Maps.Map) - - - - - - - Create members. - - - - - Clean up any resources being used. - - True if managed resources should be disposed, otherwise false. - - - - Label style. - - - - - Line style. - - - - - Convert class description to string. - - String. - - - - Represents a class that provides arguments for the LoadError event. - - - - - Creates and initializes a new instance of LoadErrorEventArgs class. - - - - - Provides a detailed error description. - - - - - Map name. - - - - - Provides a short error description. - - - - - Map data container. - - - - - Constructor. - - - - - Constructor. - - X-axis to bind the map to. - Y-axis to bind the map to. - Parent. - - - - Allow user interaction. - - - - - Map backgrounds. - - - - - Occurs when a button is pressed down while the user interactive device is on the map item. - - - - - Center on map item. - - Map item. - - - - Center on coordinates. - - Longitude. - Latitude. - - - - City draw options. - - - - - Clears tile cache folder. - - - - - Map description. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Map file name. Use with Path value to indicate map file. - - - - - Show whole map. - - - - - Fit map item to view. - - Map item. - - - - Fit to given rectangle. - - - - - param - xMin - M:Arction.Wpf.Charting.Maps.Map.Fit(System.Double,System.Double,System.Double,System.Double) - - - - - - - param - yMin - M:Arction.Wpf.Charting.Maps.Map.Fit(System.Double,System.Double,System.Double,System.Double) - - - - - - - param - xMax - M:Arction.Wpf.Charting.Maps.Map.Fit(System.Double,System.Double,System.Double,System.Double) - - - - - - - param - yMax - M:Arction.Wpf.Charting.Maps.Map.Fit(System.Double,System.Double,System.Double,System.Double) - - - - - - - Get visible map items per layer. - - List of visible map items per layer. - - - - Highlight map item when user interactive device over. - - - - - Import new layer from shp data and insert it into map on given layer. Other layers are moved if necessary. - - Shp file name. - Target layer index. - Success status. - - - - Import new layer from shp data and insert it into map on given layer. Other layers are moved if necessary. - - Shp file name. - Target layer index. - Configuration file name. - Success status. - - - - Import new layer from shp data and replace data on given layer. - - Shp file name. - Target layer index. - Success status. - - - - Import new layer from shp data and replace data on given layer. - - Shp file name. - Target layer index. - Configuration file name. - Success status. - - - - Lake draw options. - - - - - Land draw options. - - - - - Map layers. - - - - - Occurs when a map loading error occurs. - - - - - Occurs when the map changes. - - - - - Internal area name list. - - - - - OnDeserialized is called just after the object has been deserialized. - - Context. - - - - Rendering optimization. - - - - - Other map type draw options. - - - - - Show all labels, even if they overlap each other. - - - - - Occurs when the user interactive device is moved out over the map item. - - - - - Occurs when the user interactive device is moved in over the map item. - - - - - Map folder. - - - - - Refresh map name list. Map names are available at Names property. - - - - - Layer index before intensity series will be drawn. Use -1 to draw intensity series after all map layers. - - - - - River options. - - - - - Road options. - - - - - Simple highlight map item color when user interactive device is over. - - - - - Tile cache folder. - - - - - Map tile layers. - - - - - Convert class description to string. - - String. - - - - Map type. - - - - - Layer index of item on which user interactive device is. - - - - - Index of X axis related to map. - - - - - Index of Y axis related to map. - - - - - The delegate to use for handlers that receive the ButtonDownOnMapItem event. - - The object that raised the event. - Provides data for the ButtonDownOnMapItem event. - - - - Draw style. - - - - - No draw. - - - - - Options specific draw. - - - - - Individual draw style. - - - - - The delegate to use for handlers that receive the LoadError event. - - The object that raised the event. - Provides data for the LoadError event. - - - - The delegate to use for handlers that receive the MapChanged event. - - The object that raised the event. - Provides data for the MapChanged event. - - - - Map type. - - - - - Map is not shown. - - - - - Australia mid resolution map. - - - - - Canada and USA states/provinces mid resolution map. - - - - - Europe low resolution map. - - - - - Europe mid resolution map. - - - - - Europe high resolution map. - - - - - Other map type (used, when users own map is shown). - - - - - USA mid resolution map with lakes and rivers. - - - - - USA high resolution map with lakes and rivers. - - - - - USA mid resolution map with states, lakes and rivers. - - - - - USA high resolution map with states, lakes and rivers. - - - - - USA mid resolution map with states, lakes, rivers and roads. - - - - - World low resolution map. - - - - - World middle resolution map. - - - - - World in high resolution. - - - - - World low resolution map with lakes and rivers. - - - - - World middle resolution map with lakes and rivers. - - - - - North America low resolution map. - - - - - North America middle resolution map. - - - - - North America high resolution map. - - - - - The delegate to use for handlers that receive the OverOffMapItem event. - - The object that raised the event. - Provides data for the OverOffMapItem event. - - - - The delegate to use for handlers that receive the OverOnMapItem event. - - The object that raised the event. - Provides data for the OverOnMapItem event. - - - - Rendering optimization. - - - - - No optimization. - - - - - All map layers are rendered in same cached back buffer image. - This will give significantly better performance when the map contents and visible X and Y range remain same. - - - - - Map background. - - - - - Constructor. - - - - - Constructor. - - Parent. - - - - Constructor - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Image object. - - - - - Image alpha. 0 is transparent, 255 fully visible (opaque). - - - - - Maximum latitude. - - - - - Minimum latitude. - - - - - Maximum longitude. - - - - - Minimum longitude. - - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Convert class description to string. - - String. - - - - Defines if visible. - - - - - Represents a class that provides arguments for the MapChanged event. - - - - - Creates and initializes a new instance of MapChangedEventArgs class. - - - - - The new map name. - - - - - The old map name. - - - - - Map data container. - - - - - Constructor. - - Wait conversion to end. - - - - Occurs when the state of the map conversion changes. - - - - - Convert shp file by xml configuration. - - Shp file name. - Configuration file name. - Stream to mapdata file. - - - - Get converted map. - - - - - returns - M:Arction.Wpf.Charting.Maps.MapConverter.GetConvertedMap - - - - - - - Select shp files for conversion and convert them. - - True: Conversion started, false: conversion not started. - - - - Map conversion progress indication. - - - - - Map conversion is running. - - - - - Map conversion is done. - - - - - Map conversion canceled. - - - - - Map conversion is aborted. See Status field in the event for more details. - - - - - Map conversion result. - - - - - OK - - - - - Canceled by user from wizard. - - - - - Invalid layer index. - - - - - SHP file not found. - - - - - XML configuration file not found. - - - - - SHP file empty. - - - - - SHP file content and XML configuration file does not match. - - - - - Unauthorized access. - - - - - Access limited to file. - - - - - User has not selected any files from file selection dialog. - - - - - Map file not compatible with this version of control. - - - - - The delegate to use for handlers that receive the ConversionStateChanged event. - - The object that raised the event. - Provides data for the ConversionStateChanged event. - - - - Map header. - - - - - Constructor. - - - - - Map description. - - - - - Map file name. - - - - - Map name. - - - - - Map item. - - - - - Constructor. - - - - - Constructor. - - - - - param - owner - M:Arction.Wpf.Charting.Maps.MapItem.#ctor(Arction.Wpf.Charting.Maps.MapLayer,Arction.Wpf.Charting.Maps.MapLayer.LayerType) - - - - - - - param - type - M:Arction.Wpf.Charting.Maps.MapItem.#ctor(Arction.Wpf.Charting.Maps.MapLayer,Arction.Wpf.Charting.Maps.MapLayer.LayerType) - - - - - - - Constructor. - - - - - param - owner - M:Arction.Wpf.Charting.Maps.MapItem.#ctor(Arction.Wpf.Charting.Maps.MapLayer,Arction.Wpf.Charting.Maps.MapLayer.LayerType,System.Int32) - - - - - - - param - type - M:Arction.Wpf.Charting.Maps.MapItem.#ctor(Arction.Wpf.Charting.Maps.MapLayer,Arction.Wpf.Charting.Maps.MapLayer.LayerType,System.Int32) - - - - - - - param - id - M:Arction.Wpf.Charting.Maps.MapItem.#ctor(Arction.Wpf.Charting.Maps.MapLayer,Arction.Wpf.Charting.Maps.MapLayer.LayerType,System.Int32) - - - - - - - Create members. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Get values. - - Values. - - - - Name. - - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Represents a class that provides arguments for the MapItemAction event. - - - - - Creates and initializes a new instance of MapItemActionEventArgs class. - - - - - Layer. - - - - - Map Item. - - - - - Map items. - - - - - Constructor. - - - - - Map layers (areas, lines, points). - - - - - City title. - - - - - Constructor. - - - - - Constructor. - - - - - param - owner - M:Arction.Wpf.Charting.Maps.MapItemTitle.#ctor(Arction.Wpf.Charting.IChartNode) - - - - - - - Title text. - - - - - Layer. - - - - - Constructor. - - - - - Constructor. - - Parent. - - - - Construct initialized members. - - - - - Clean up any resources being used. - - True if managed resources should be disposed, otherwise false. - - - - Frees all the draw data. Called at least at MapLayer dispose. - - - - - Layer items. - - - - - Name of layer. - - - - - Priority. Layers with zero are drawn on top. - - - - - Convert class description to string. - - String. - - - - Layer type. - - - - - Defines if visible. - - - - - Layer type. - - - - - City. - - - - - Land. - - - - - Lake. - - - - - Road. - - - - - River. - - - - - Other. May contain lines or regions. - - - - - Property change notification implementation. Use this as base class for any class which need to implement INotifyPropertyChanged interface. - - - - - - - Arction.Wpf.Charting.Maps.NotifyPropertyChanges - - - - - - - Method to be called on property change. - - Name of changed property. - - - - Event to be called on property change. - - - - - PointLayer. - - - - - Constructor. - - - - - Constructor. - - - - - param - owner - M:Arction.Wpf.Charting.Maps.PointLayer.#ctor(Arction.Wpf.Charting.Maps.Map) - - - - - - - Main color. - - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Convert class description to string. - - String. - - - - Population category. - - - - - Constructor. - - - - - Constructor. - - - - - param - owner - M:Arction.Wpf.Charting.Maps.PopulationCategory.#ctor(Arction.Wpf.Charting.Maps.CityOptions) - - - - - - - Constructor. - - - - - param - owner - M:Arction.Wpf.Charting.Maps.PopulationCategory.#ctor(Arction.Wpf.Charting.Maps.CityOptions,System.UInt32) - - - - - - - param - uiMinPopulation - M:Arction.Wpf.Charting.Maps.PopulationCategory.#ctor(Arction.Wpf.Charting.Maps.CityOptions,System.UInt32) - - - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Defines label style. - - - - - Defines minimum population. - - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Defines point draw style. - - - - - Convert class description to string. - - String. - - - - Region. - - - - - Constructor. - - - - - Constructor. - - - - - param - owner - M:Arction.Wpf.Charting.Maps.Region.#ctor(Arction.Wpf.Charting.Maps.MapLayer,Arction.Wpf.Charting.Maps.MapLayer.LayerType) - - - - - - - param - lType - M:Arction.Wpf.Charting.Maps.Region.#ctor(Arction.Wpf.Charting.Maps.MapLayer,Arction.Wpf.Charting.Maps.MapLayer.LayerType) - - - - - - - Constructor. - - - - - param - owner - M:Arction.Wpf.Charting.Maps.Region.#ctor(Arction.Wpf.Charting.Maps.MapLayer,Arction.Wpf.Charting.Maps.MapLayer.LayerType,System.Int32) - - - - - - - param - lType - M:Arction.Wpf.Charting.Maps.Region.#ctor(Arction.Wpf.Charting.Maps.MapLayer,Arction.Wpf.Charting.Maps.MapLayer.LayerType,System.Int32) - - - - - - - param - id - M:Arction.Wpf.Charting.Maps.Region.#ctor(Arction.Wpf.Charting.Maps.MapLayer,Arction.Wpf.Charting.Maps.MapLayer.LayerType,System.Int32) - - - - - - - Area border line style. - - - - - Center point of largest area. - - - - - Create members. - - - - - Clean up any resources being used. - - True if managed resources should be disposed, otherwise false. - - - - Max X draw coordinate. - - - - - Max Y draw coordinate. - - - - - Min X draw coordinate. - - - - - Min Y draw coordinate. - - - - - Defines Fill. - - - - - Hole indexes. - - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Points of border lines of all areas. - - - - - Read border points. - - Reader. - Border count. - Bytes in float. - - - - returns - M:Arction.Wpf.Charting.Maps.Region.ReadBorderPoints(System.IO.BinaryReader,System.Int32,System.Int32) - - - - - - - Read header. - - Reader - Border count. - Hole count. - Item count. - - - - Read hole indexes. - - Reader - Hole count - - - - Read triangle points. - - Reader - Region count. - Bytes in float. - - - - - RegionLayer. - - - - - Constructor. - - - - - Constructor. - - - - - param - owner - M:Arction.Wpf.Charting.Maps.RegionLayer.#ctor(Arction.Wpf.Charting.Maps.Map) - - - - - - - Border draw style. Determine how border is drawn. - - - - - Region draw style. Determine which property is used to draw area if any. - - - - - Region options. - - - - - Constructor. - - - - - Constructor. - - - - - param - owner - M:Arction.Wpf.Charting.Maps.RegionOptions.#ctor(Arction.Wpf.Charting.Maps.Map) - - - - - - - Anti-alias fill. - - - - - Create members. - - - - - Clean up any resources being used. - - True if managed resources should be disposed, otherwise false. - - - - Defines Fill. - - - - - Defines if Fill is visible. - - - - - Defines label style. - - - - - Defines line style. - - - - - Defines if the line is visible. - - - - - Convert class description to string. - - String. - - - - Stencil area used to mask in/out areas when drawing data. - - - - - Constructor. - - - - - Constructor. - - Parent. - - - - Add data to stencil area from map layer. - - Map layer. - - - - Add polygon described by points. - - Polygon points. - - - - Add polygon described by points. - - Polygon points. - - - - Add polygons described by array of arrays. - - Polygon points. - - - - Add polygons described by array of arrays. - - Polygon points. - - - - Clear data. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Ignore holes in the area. - - - - - Map layer indexes. - - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Convert class description to string. - - String. - - - - Class to write certain map area and zoom levels to file system folder. - - - - - Constructor. - - cache folder location - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Occurs during tile fetching. - - - - - Start writing from given map area to cache folder. Supports only Street and Satellite layers. - - Minimum longitude. - Maximum longitude. - Minimum latitude. - Maximum latitude. - Start zoom level. - End zoom level. - Layer type, only Street and Satellite supported. - True, if started successfully. Otherwise (layer type not valid) false. - - - - Stop cache writing. - - - - - The delegate to use for handlers that receive the Progress event. - - The object that raised the event. - Provides data for the TileFetchProgress event. - - - - Represents a class that provides arguments for the TileFetchFailed event. - - - - - Creates and initializes a new instance of TileFetchFailedEventArgs class. - - - - - HTTP status of the failed map tile fetch operation. - - - - - Represents a class that provides arguments for the TileFetchProgress event. - - - - - Creates and initializes a new instance of TileFetchProgressEventArgs class. - - - - - Should the fetching be canceled. - - - - - The progress percentage. - - - - - Represents a class that provides arguments for the TileFormatValue event. - - - - - Creates and initializes a new instance of TileFormatValueEventArgs class. - - - - - The tile layer whose value is to be formatted. - - - - - The actual value. - - - - - A user-formatted string of the actual value. - - - - - Map tile layer. Get image to front or back of map. - - - - - Constructor. - - - - - Constructor. - - owner (map) - - - - Is layer drawn above or below map. Default is above (true). - - - - - Tile layer alpha level. Valid range is 0..255. - - - - - Cache fetch count. Use to enhance your cache usage. - - - - - Cache images to a file folder. Speeds up the tile fetching when using same zoom levels and regions. - - - - - Clean up any resources being used. - - True if managed resources should be disposed, otherwise false. - - - - Get zoom level. - - - - - returns - M:Arction.Wpf.Charting.Maps.TileLayer.GetZoomLevel - - - - - - - ApiKey from Here. - - - - - Use production server of map provider. Enable this when releasing application customer. - - - - - OnDeserialized is called just after the object has been deserialized. - - Context. - - - - Used for refreshing tile data. - - - - - Remove tiles (minus some at the edges), which are not currently visible. - - - - - Used for getting server call count. - - - - - Occurs when a map tile fetch operation fails. - - - - - Item to string. - - - - - returns - M:Arction.Wpf.Charting.Maps.TileLayer.ToString - - - - - - - Defines layer type. - - - - - Defines if property is visible. - - - - - Layer type. - - - - - Street. - - - - - Images from satellite or airplane. - - - - - The delegate to use for handlers that receive the TileFetchFailed event. - - The object that raised the event. - Provides data for the TileFetchFailed event. - - - - Overlay element base class. Overlay elements are UI controls on front of the chart. - - - - - Constructor for form editor list editor. - - - - - Constructor . - - Parent. - - - - Rotation uses this point as a center point. Location tells - where to place the anchored point on the control area. - For X dimension, value 0 represents left coordinate of the object and 1 right coordinate. - For Y dimension, value 0 represents top coordinate of the object and 1 bottom coordinate. - To define anchor point outside the object area, define values outside range 0...1. - - - - - Border around the object - - - - - Constructor. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Fill. - - - - - If set, limits the element graph margins area. - - - - - Location where the anchor point is placed. - - - - - Element rotation angle, in degrees. The rotation is done around the element's center of rotation. - - - - - Shadow beneath the object - - - - - Defines Size. - - - - - Convert class description to string. - - String. - - - - Is element visible. - - - - - Overlay label shows text with background and border. - - - - - Constructor for form editor list editor. - - - - - Constructor. - - Parent. - - - - Constructor - - - - - Dispose - - - - - Arction.Wpf.Charting.OverlayElements.OverlayLabel - - - - - - - Text. - - - - - Text style. - - - - - 3D Bar series. - - - - - Constructor for Form designer list editor. - - - - - Constructor. - - Parent. - X-axis you want to bind. - Y-axis you want to bind. - Z-axis you want to bind. - - - - Add value to end of Values array. - - X value. - Y value. - Z value. - Refresh chart after value adding. - Text. - New value index. - - - - Add values to end of series. - - Values. - Update chart after adding. Updating will raise CPU load, - so you maybe don't want to use this with every call if points are added many times per second. - Value count after adding. - - - - Bar depth. - - - - - Bar width. - - - - - Base level. - - - - - Points initial size - - - - - Clear series. - - - - - Corner percentage on rounded cylinder and beveled styles. - - - - - Detail level on some draw styles. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Get info of bar over which the user interactive device is over. - - Bar value index. - Bar X value. - Bar Y value. - Bar Z value. - True if info found, false otherwise. - - - - Get Text by given index. - - Value index. - Text value. If invalid index is given, returns "". - - - - Get X value by given index. - - Value index. - X value. If invalid index is given, returns 0. - - - - Get Y value by given index. - - Value index. - Y value. If invalid index is given, returns 0. - - - - Get Z value by given index. - - Value index. - Z value. If invalid index is given, returns 0. - - - - Loads series data from a CSV file. - - CSV file. If file does not exist, LoadFromCSV returns false. - Value and floating point number separator. - True if import succeeds. Otherwise false. - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Saves series data into CSV file. - - Target file. If file already exists, it will be overwritten. - Value and floating point number separator definition. - True if export is successful. - - - - Bar shape. - - - - - The event for formatting a value to a custom string. - - - - - Series title. - - - - - Item to string. - - - - - returns - M:Arction.Wpf.Charting.Series3D.BarSeries3D.ToString - - - - - - - Value count stored in the Values array. - - - - - Series value text display properties. - - - - - Values array. - - - - - Event callback caller. - - - - - param - sender - M:Arction.Wpf.Charting.Series3D.BarSeries3D.ValueToString(System.Object,Arction.Wpf.Charting.Series3D.SupplyCustomValueStringEventArgs) - - - - Event. - - - - The delegate to use for handlers that receive the SupplyCustomValueString event. - - The object that raised the event. - Provides data for the SupplyCustomValueString event. - - - - 3D Point line series. Allows drawing a line with points, or just line, or just points. - - - - - Constructor mainly for visual designer. - - - - - Constructor. - - Parent. - X-axis you want to bind. - Y-axis you want to bind. - Z-axis you want to bind. - - - - Add SeriesPoint3D points to end of series. - - Points. - Update chart after adding. Updating will raise CPU load, - so you maybe don't want to use this with every call if points are added many times per second. - Count of points in the Points array. - - - - Add SeriesPointCompact3D points to end of series. - - Points. - - - - param - invalidateChart - M:Arction.Wpf.Charting.Series3D.PointLineSeries3D.AddPoints(Arction.Wpf.Charting.SeriesPointCompact3D[],System.Boolean) - - - - Count of points in the PointsCompact array. - - - - Add SeriesPointCompactColored3D points to end of series. - - - - - param - points - M:Arction.Wpf.Charting.Series3D.PointLineSeries3D.AddPoints(Arction.Wpf.Charting.SeriesPointCompactColored3D[],System.Boolean) - - - - - - - param - invalidateChart - M:Arction.Wpf.Charting.Series3D.PointLineSeries3D.AddPoints(Arction.Wpf.Charting.SeriesPointCompactColored3D[],System.Boolean) - - - - Count of points in PointsCompactColored array. - - - - Points initial size - - - - - Clear all points - - - - - Connects end and start point by drawing line between them. - - - - - Data breaking options. Defines, if gaps are enabled on series data and by which value. - Default state is disabled and default gap value is Double.NaN; - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Each point can have different color. - - - - - Each point can have different size. - - - - - Additional method to check if position is over, solves also index of the nearest point or line segment if it hits it. - - X screen coordinate. - Y screen coordinate. - Index of nearest point or line segment. - Is the mouse over line. - Is the mouse over a point. - Use DIP instead of pixels for coordinates. - - - - returns - M:Arction.Wpf.Charting.Series3D.PointLineSeries3D.IsPositionOver(System.Int32,System.Int32,System.Int32@,System.Boolean@,System.Boolean@,System.Boolean) - - - - - - - Get last data index at hit coordinates. Return -1 if did not hit. - - - - - Line style - - - - - Is line visible or not - - - - - Loads series data from a CSV file. Note that this loads only points with set point type (PointsType property). - - CSV file name. If file does not exist, LoadFromCSV returns false. - Value and floating point number separator. - True if import succeeds. Otherwise false. - - - - Draw lines with color gradients between points. - - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Point count stored in the Points array - - - - - Points array. - - - - - Compact points array. - - - - - Colored compact points array. - - - - - Point rendering optimization. - - - - - Point style settings - - - - - Series points type - - - - - Are points visible or not - - - - - Saves series data into CSV file. Note that this saves only points with set point type (PointsType property). - - Target file. If file already exists, it will be overwritten. - Value and floating point number separator definition. - True if export is successful. - - - - Series title - - - - - Item to string. - - - - - returns - M:Arction.Wpf.Charting.Series3D.PointLineSeries3D.ToString - - - - - - - Base class for all 3D series - - - - - Constructor - - - - - param - owner - M:Arction.Wpf.Charting.Series3D.SeriesBase3D.#ctor(Arction.Wpf.Charting.Views.View3D.View3D,Arction.Wpf.Charting.Axis3DBinding,Arction.Wpf.Charting.Axis3DBinding,Arction.Wpf.Charting.Axis3DBinding) - - - - - - - param - xAxis - M:Arction.Wpf.Charting.Series3D.SeriesBase3D.#ctor(Arction.Wpf.Charting.Views.View3D.View3D,Arction.Wpf.Charting.Axis3DBinding,Arction.Wpf.Charting.Axis3DBinding,Arction.Wpf.Charting.Axis3DBinding) - - - - - - - param - yAxis - M:Arction.Wpf.Charting.Series3D.SeriesBase3D.#ctor(Arction.Wpf.Charting.Views.View3D.View3D,Arction.Wpf.Charting.Axis3DBinding,Arction.Wpf.Charting.Axis3DBinding,Arction.Wpf.Charting.Axis3DBinding) - - - - - - - param - zAxis - M:Arction.Wpf.Charting.Series3D.SeriesBase3D.#ctor(Arction.Wpf.Charting.Views.View3D.View3D,Arction.Wpf.Charting.Axis3DBinding,Arction.Wpf.Charting.Axis3DBinding,Arction.Wpf.Charting.Axis3DBinding) - - - - - - - Clear the series - - - - - Create material. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Get series minimum and maximum data values. - - Minimum data values - Maximum data values - true if data exists, false otherwise - - - - Get X axis object to which this series is bound to - - Axis - - - - Get Y axis object to which this series is bound to - - Axis - - - - Get Z axis object to which this series is bound to - - Axis - - - - Include in autofit. - - - - - Series data has been modified directly by it's array. - Use this method to notify chart that this series needs a refresh - - - - - Is position over series. - - X-coordinate - Y-coordinate - Use DIP instead of pixels as parameters - True if position is over series. Else false. - - - - Loads series data from a CSV file. - - CSV file. If file does not exist, LoadFromCSV returns false. - Value and floating point number separator. - True if import succeeds. Otherwise false. - - - - Min/max values for series are calculated. - - - - - Series material - - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Get item as LegendBoxMouseObject. - - related object - - - - returns - M:Arction.Wpf.Charting.Series3D.SeriesBase3D.op_Implicit(Arction.Wpf.Charting.Series3D.SeriesBase3D)~Arction.Wpf.Charting.Views.LegendBoxObject - - - - - - - Owner view - - - - - Saves series data into CSV file - - Target file. If file already exists, it will be overwritten. - Value and floating point number separator definition - True if export is successful - - - - Enlists the series title text in Legend box of the chart - - - - - Item to string. - - - - - returns - M:Arction.Wpf.Charting.Series3D.SeriesBase3D.ToString - - - - - - - Is the series visible - - - - - X axis binding - - - - - Y axis binding - - - - - Z axis binding - - - - - Represents a class that provides arguments for the SupplyCustomValueString event. - - - - - Creates and initializes a new instance of SupplyCustomValueStringEventArgs class. - - - - - Series. - - - - - Value. - - - - - Value as string. - - - - - Surface grid series. - - - - - Constructor for Form designer list editor - - - - - Constructor - - Parent. - X-axis you want to bind. - Y-axis you want to bind. - Z-axis you want to bind. - - - - Surface Bitmap fill style fill. - - - - - Contour line type - - - - - Contour line width - - - - - Create new data array. - - X size. - Z size. - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - If set, draws wireframe through the filled surface, making it always visible from above the surface and below it. - Alternatively, you may prefer setting this false and using WireframeOffset to shift the wireframe slightly up or down, - making it visible only on the other side of the filled surface. - - - - - Surface fill - - - - - Get series minimum and maximum data values. - - Minimum data values. - Maximum data values. - True if data exists, false otherwise. - - - - Insert new column on the back and drop the first column of data off. This is a performance optimized - method for adding one column periodically in real-time, like in FFT spectrum monitor. Refreshes chart. - - New column Y values. - X maximum of the series, after scrolling. - X minimum of the series, after scrolling. - X-axis maximum, after scrolling. - X-axis minimum, after scrolling. - Return value. - - - - Insert new data row on the back and drop the first row of data off. This is a performance optimized - method for adding one row periodically in real-time, like in FFT spectrum monitor. Refreshes chart. - - New row Y values. - Z maximum of the series, after scrolling. - Z minimum of the series, after scrolling. - Z-axis maximum, after scrolling. - Z-axis minimum, after scrolling. - Return value. - - - - Surface side which is being lit. - - - - - Maximum X range value - - - - - Maximum Z range value - - - - - Minimum X range value - - - - - Minimum Z range value - - - - - Sets X and Z range at same time. Very CPU efficient way compared to separately setting - RangeMinX, RangeMaxX, RangeMinZ and RangeMaxZ properties. - - Minimum X. - Maximum X. - Minimum Z. - Maximum Z. - - - - Use smooth shading. Otherwise the surface is drawn with sharp triangles. - - - - - Item to string. - - - - - returns - M:Arction.Wpf.Charting.Series3D.SurfaceGridSeries3D.ToString - - - - - - - Wireframe type - - - - - Surface grid row or column insertion return value. - - - - - Successfully done. - - - - - No data to scroll - - - - - Contour lines are in use. Use FastContourZones or FastPalettedZones instead - - - - - Can't use wireframe. Present the series without it. - - - - - Surface mesh series. - - - - - Constructor for Form designer list editor - - - - - Constructor. - - Parent. - X-axis you want to bind. - Y-axis you want to bind. - Z-axis you want to bind. - - - - Surface Bitmap fill style fill. - - - - - Contour line style - - - - - Contour line width - - - - - Clean up any resources being used. - - True if managed resources should be disposed, otherwise false. - - - - If set, draws wireframe through the filled surface, making it always visible from above the surface and below it. - Alternatively, you may prefer setting this false and using WireframeOffset to shift the wireframe slightly up or down, - making it visible only on the other side of the filled surface. - - - - - Surface fill. - - - - - Insert new column on the back and drop the first column of data off. Refreshes chart. - - New column points. - True if successful, false if series data array doesn't exist. - - - - Insert new row on the back and drop the first row of data off. Refreshes chart. - - New row points. - True if successful, false if series data array doesn't exist. - - - - Surface side which is being lit. - - - - - Use smooth shading. Otherwise the surface is drawn with sharp triangles. - - - - - Item to string. - - - - - returns - M:Arction.Wpf.Charting.Series3D.SurfaceMeshSeries3D.ToString - - - - - - - Wireframe type - - - - - Surface series base. - - - - - Constructor - - Parent. - X-axis you want to bind. - Y-axis you want to bind. You can give null if X axis binding is used. - Z-axis you want to bind. - - - - Allow tracing of the surface cell when user interactive device is over. - - - - - Base color for filling. - - - - - Check if the given surface size can be used with the GPU. - GPU index buffer capacity is verified. - - X size. - Z size. - True if index buffer size on the GPU is sufficient, else false. - - - - Clears the series by setting Data Y values to InitialValues. - Sets the data point colors to BaseColor. - - - - - Surface fill color saturation. High value gives brighter colors. - - - - - Contour line color. - - - - - Color palette for Y value information. - - - - - Create material. - - - - - Create new data array. - - X size. - Z size. - - - - Create palette. - - - - - Create title. - - - - - Create wireframe offset. - - - - - Series 3D point data. - - - - - Disable depth buffer test. Disabling this improves performance, but may cause erroneous painting order of objects. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Free all vertex and index buffer data - - - - - param - disposeVertexBuffers - M:Arction.Wpf.Charting.Series3D.SurfaceSeries3DBase.DisposeStaticBuffers(System.Boolean,System.Boolean,System.Boolean) - - - - - - - param - disposeIndexBuffers - M:Arction.Wpf.Charting.Series3D.SurfaceSeries3DBase.DisposeStaticBuffers(System.Boolean,System.Boolean,System.Boolean) - - - - - - - param - disposeSurfaceCache - M:Arction.Wpf.Charting.Series3D.SurfaceSeries3DBase.DisposeStaticBuffers(System.Boolean,System.Boolean,System.Boolean) - - - - - - - Fade away surface/waterfall towards back (higher data row numbers), with given percent. - Valid range is from 0(no fadeaway) to 100 (full fadeaway). - - - - - Height (Y-axis value range) for fast contour zones. The fast contour zone is a contour line equivalent. - - - - - Get color from Data array value. - - Column index of Data array. - Row index of Data array. - Color. If invalid index is given, returns Color.Black. - - - - Get color from Data array value. - - Column index of Data array. - Row index of Data array. - Color. - True, if indexes at valid range, otherwise false and outputs Color.Black. - - - - Get value from Data array value. - - Column index of Data array. - Row index of Data array. - Z value. If invalid index is given, returns 0. - - - - Get value from Data array value. - - Column index of Data array. - Row index of Data array. - Data value at position. Zero, in case of failure. - True, if indexes at valid range, otherwise false. - - - - Get Data array X value. - - Column index of Data array. - Row index of Data array. - X value. If invalid index is given, returns 0. - - - - Get Data array X value. - - Column index of Data array. - Row index of Data array. - X-value at position. Zero, in case of failure. - True, if indexes at valid range, otherwise false. - - - - Get Data array Y value. - - Column index of Data array. - Row index of Data array. - Y value. If invalid index is given, returns 0. - - - - Get Data array Y value. - - Column index of Data array. - Row index of Data array. - Y-value at position. Zero, in case of failure. - True, if indexes at valid range, otherwise false. - - - - Get Data array Z value. - - Column index of Data array. - Row index of Data array. - Z value. If invalid index is given, returns 0. - - - - Get Data array Z value. - - Column index of Data array. - Row index of Data array. - Z-value at position. Zero, in case of failure. - True, if indexes at valid range, otherwise false. - - - - General handler for mouse over event. Check also mouse hit columns. - - - - - Initial value for data Y. Clears the series. It is applied when creating or resizing Data array. - - - - - Detect if position is over the series. Also solves the column and row index where position is over of. - - Screen X coordinate - Screen Y coordinate - Column index. If failed, contains -1 - Row index. If failed, contains -1 - Use DIPs instead of pixels - True if position is over the series - - - - Loads series data from a CSV file. - - CSV file. If file does not exist, LoadFromCSV returns false. - Value and floating point number separator. - True if import succeeds. Otherwise false. - - - - Lock object for data array modification and reading - - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Rebuilds rendering data. Expert's method for allowing multi-threaded application to pre-build rendering data before rendering stage. - Rendering stage must always be synchronized to main thread, but this call can be called parallel for every series of this type. - - - - - Drawing order related to PointLineSeries. - - - - - Saves series data into CSV file. - - Target file. If file already exists, it will be overwritten. - Value and floating point number separator definition. - True if export is successful. - - - - Set data values from X, Y, Z and color. - - Column index of Data array. - Row index of Data array. - X value. - Y value. - Z value. - Value. - Color. Effects only if Fill is set to SourcePointColoring. - False if invalid index. Otherwise true. - - - - Create data based on bitmap file contents. Data array will have dimensions of the bitmap Width X Height. - Use options to reduce resolution and smooth it if needed. - Height data of is calculated for each pixel from R, G, and B sum. 0 (black) will have the minimum value, - and maximum value is obtained from 3*255 (white). If bitmap has alpha value of 0, the data is set to -INF, - and the value is not drawn. - - Minimum X. - Maximum X. - Minimum Y. - Maximum Y. - Minimum Z. - Maximum Z. - Input bitmap. - Bitmap resolution decrement and smoothing options. Give null to use pure bitmap data only. - Sets NegativeInfinity when bitmap pixel has alpha = 0. - True if data was successfully filled, else false. - - - - Set grid size, both X and Z at same time. If you already have a large existing data, - using this method is faster than setting SizeX and SizeZ separately. - - X size. - Z size. - - - - Grid size in X dimension (Data array columns). - - - - - Grid size in Z dimension (Data array rows). - - - - - Solve nearest data point to given screen coordinate [input in DIP]. Takes the data point distance from camera into account. - Only solves the point when coordinate is over the surface. - - X screen coordinate as DIP - Y screen coordinate as DIP - Nearest point solved - Column index in Data array - Row index in Data array - True if solved, else false. - - - - Suppress all light calculations on this surface series. - - - - - Series title - - - - - Solid fill tone color - - - - - Item to string. - - - - - returns - M:Arction.Wpf.Charting.Series3D.SurfaceSeries3DBase.ToString - - - - - - - Occurs when the user interactive device has been moved over to a different surface series cell. - - - - - Wireframe line style. - - - - - Wireframe shift amount from fill. - Keep some amount of shift, to avoid 3D render engine Z buffer fighting. - - - - - The delegate to use for handlers that receive the TraceCellChangedEvent event. - - The object that raised the event. - Provides data for the TraceCellChangedEvent event. - - - - Represents a class that provides arguments for the TraceCellChanged event. - - - - - Creates and initializes a new instance of TraceCellChangedEventArgs class. - - - - - The new column index (X-dimension). - - - - - The new row index (Z-dimension). - - - - - The series that raised the event. - - - - - Waterfall series. Shows multiple waterfall areas stacked Z direction. As a specialty, the strips can be freely bent, in X and Z directions. - - - - - Constructor for Form designer list editor. - - - - - Constructor - - Parent. - X-axis you want to bind. - Y-axis you want to bind. - Z-axis you want to bind. - - - - Base level (Y value) - - - - - Contour line type - - - - - Create palette. - - - - - Create title. - - - - - Create wireframe offset. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Surface fill - - - - - Surface side which is being lit correctly. - - - - - Item to string. - - - - - returns - M:Arction.Wpf.Charting.Series3D.WaterfallSeries3D.ToString - - - - - - - Wireframe style - - - - - Area series for polar chart. - - - - - Constructor for Form designer list editor - - - - - Constructor. - - Parent. - Polar axis you want to bind. - - - - Initialize members. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Area fill color. - - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Item to string. - - - - - returns - M:Arction.Wpf.Charting.SeriesPolar.AreaSeriesPolar.ToString - - - - - - - Represents a class that provides arguments for the CustomLinePointColoringAndShaping event. - - - - - Creates and initializes a new instance of CustomLinePointColoringAndShapingPolarEventArgs class. - - - - - The series to which this event is associated. - - - - - Point line series for polar chart. You can define the line style and point style. Add points with AddPoints method. - - - - - Constructor for Form designer list editor. - - - - - Constructor. - - Parent. - Polar axis you want to bind. - - - - Determines whether series is drawn as polygon instead of polyline, i.e. line is drawn from last point to first. - - - - - Custom line coloring and line coordinates event. Event handler must give color for each data point received in the handler. - The coordinates can be adjusted as well and new line points can be inserted. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Method to update colors and coordinates with the one if user sets those - - - - - param - coords - M:Arction.Wpf.Charting.SeriesPolar.PointLineSeriesPolar.GetCustomLinePointColorsAndShaping(Arction.RenderingDefinitions.PointFloat[]@,System.Boolean,System.Boolean,System.Int32[]@) - - - - - - - param - canModifyCoords - M:Arction.Wpf.Charting.SeriesPolar.PointLineSeriesPolar.GetCustomLinePointColorsAndShaping(Arction.RenderingDefinitions.PointFloat[]@,System.Boolean,System.Boolean,System.Int32[]@) - - - - - - - param - canModifyColors - M:Arction.Wpf.Charting.SeriesPolar.PointLineSeriesPolar.GetCustomLinePointColorsAndShaping(Arction.RenderingDefinitions.PointFloat[]@,System.Boolean,System.Boolean,System.Int32[]@) - - - - - - - param - dataPointIndices - M:Arction.Wpf.Charting.SeriesPolar.PointLineSeriesPolar.GetCustomLinePointColorsAndShaping(Arction.RenderingDefinitions.PointFloat[]@,System.Boolean,System.Boolean,System.Int32[]@) - - - - - - - returns - M:Arction.Wpf.Charting.SeriesPolar.PointLineSeriesPolar.GetCustomLinePointColorsAndShaping(Arction.RenderingDefinitions.PointFloat[]@,System.Boolean,System.Boolean,System.Int32[]@) - - - - - - - Check if the event CustomLinePointColoringAndShaping is subscribed - - - - - returns - M:Arction.Wpf.Charting.SeriesPolar.PointLineSeriesPolar.IsCustomLinePointColorsAndShapingSubscribedTo - - - - - - - Palette value LegendBox format string. - - - - - Item to string. - - - - - returns - M:Arction.Wpf.Charting.SeriesPolar.PointLineSeriesPolar.ToString - - - - - - - Palette value units texts. - - - - - The delegate to use for handlers that receive the CustomLinePointColoringAndShaping event. - - The object that raised the event. - Provides data for the CustomLinePointColoringAndShaping event. - - - - Sector class. - - - - - Constructor for Form designer list editor. - - - - - Constructor. - - Parent. - Polar axis you want to bind. - - - - Index of polar axis assigned to this series. Give -1 when you don't want to assign it yet to any axis. - - - - - Sector begin angle. - - - - - Is the sector behind series or on front of it. - - - - - Borderline style. - - - - - Border location relative to sector edge. - - - - - Defines how the sector should be clipped at the center of the graph. - - - - - Does nothing on this series type - - - - - Defines if the sector is drawn outside the main chart circle. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Sector end angle. - - - - - Fill. - - - - - Is position over item. - - x-coordinate in PX - y-coordinate in PX - Use DIP instead of pixels as parameters - true if position is over item, false otherwise - - - - Sector max amplitude. - - - - - Sector min amplitude. - - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Get item as LegendBoxMouseObject. - - related object - - - - returns - M:Arction.Wpf.Charting.SeriesPolar.Sector.op_Implicit(Arction.Wpf.Charting.SeriesPolar.Sector)~Arction.Wpf.Charting.Views.LegendBoxObject - - - - - - - Owner view. - - - - - Set proper dragging cursor, or mouse-over cursor. - - - - - Enlists the series title text in Legend box of the chart - - - - - Sector title - - - - - Item to string. - - - - - returns - M:Arction.Wpf.Charting.SeriesPolar.Sector.ToString - - - - - - - Is the series visible - - - - - Edge style. - - - - - Border is not drawn. - - - - - Border is drawn out of area. - - - - - Border is drawn in center of edge. - - - - - Border is container in the sector draw area. - - - - - Base class for all polar series. - - - - - Constructor for Form designer list editor. - - - - - Constructor - - - - - param - owner - M:Arction.Wpf.Charting.SeriesPolar.SeriesBasePolar.#ctor(Arction.Wpf.Charting.Views.ViewPolar.ViewPolar,Arction.Wpf.Charting.Axes.AxisPolar) - - - - - - - param - axisPolar - M:Arction.Wpf.Charting.SeriesPolar.SeriesBasePolar.#ctor(Arction.Wpf.Charting.Views.ViewPolar.ViewPolar,Arction.Wpf.Charting.Axes.AxisPolar) - - - - - - - Add points to end of series - - Points - Update chart after adding. Updating will raise CPU load, - so you maybe don't want to use this with every call if points are added many times per second. - Point count after adding - - - - List of assignable axes. - - - - - Index of polar axis assigned to this series. Give -1 when you don't want to assign it yet to any axis. - - - - - Defines how the series should be clipped at the center of the graph. - - - - - Clear all points - - - - - Method to update colors and coordinates with the one if user sets those - This is only applicable if event CustomLinePointColoringAndShaping is subscribed - - - - - param - coords - M:Arction.Wpf.Charting.SeriesPolar.SeriesBasePolar.GetCustomLinePointColorsAndShaping(Arction.RenderingDefinitions.PointFloat[]@,System.Boolean,System.Boolean,System.Int32[]@) - - - - - - - param - canModifyCoords - M:Arction.Wpf.Charting.SeriesPolar.SeriesBasePolar.GetCustomLinePointColorsAndShaping(Arction.RenderingDefinitions.PointFloat[]@,System.Boolean,System.Boolean,System.Int32[]@) - - - - - - - param - canModifyColors - M:Arction.Wpf.Charting.SeriesPolar.SeriesBasePolar.GetCustomLinePointColorsAndShaping(Arction.RenderingDefinitions.PointFloat[]@,System.Boolean,System.Boolean,System.Int32[]@) - - - - - - - param - dataPointIndices - M:Arction.Wpf.Charting.SeriesPolar.SeriesBasePolar.GetCustomLinePointColorsAndShaping(Arction.RenderingDefinitions.PointFloat[]@,System.Boolean,System.Boolean,System.Int32[]@) - - - - - - - returns - M:Arction.Wpf.Charting.SeriesPolar.SeriesBasePolar.GetCustomLinePointColorsAndShaping(Arction.RenderingDefinitions.PointFloat[]@,System.Boolean,System.Boolean,System.Int32[]@) - - - - - - - Get minimum and maximum amplitude values within given angle range - - Minimum amplitude value - Maximum amplitude value - Angle range start - Angle range end - True if values were successfully detected - - - - Get min and max amplitude value withing given angle range [Obsolete. Using GetMinMaxFromAngleRange instead recommended] - - Minimum amplitude value - Maximum amplitude value - Angle range start - Angle range end - True if values were successfully detected - - - - Check if the event CustomLinePointColoringAndShaping is subscribed - - - - - returns - M:Arction.Wpf.Charting.SeriesPolar.SeriesBasePolar.IsCustomLinePointColorsAndShapingSubscribedTo - - - - - - - Loads series data from a CSV file. - - CSV file name. If file does not exist, LoadFromCSV returns false. - Value and floating point number separator. - True if import succeeds. Otherwise false. - - - - Series points - - - - - Saves series data into CSV file - - Target file. If file already exists, it will be overwritten. - Value and floating point number separator definition - True if export is successful - - - - Tries to find the closest point of the series to the given coordinates [input in PX]. - - X screen coordinate (as PX) to find the nearest series point from. - Y screen coordinate (as PX) to find the nearest series point from. - Angle value of the found point. - Amplitude value of the found point. - True if nearest point was found, false otherwise. - - - - Base class for all polar series. - - - - - Constructor for Form designer list editor. - - - - - Constructor - - - - - param - owner - M:Arction.Wpf.Charting.SeriesRound.SeriesBaseRound.#ctor(Arction.Wpf.Charting.Views.ViewRound.ViewRoundBase) - - - - - - - Defines if the series can be snapped to by markers. - Note that the snapping must be properly enabled on the marker as well. - This allows use of hidden series that can be snapped to. - - - - - Points initial size - - - - - Defines if the series is drawn outside the main chart circle. - - - - - Turn on coloring by Value - - - - - Create members - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Get minimum and maximum Y-coordinate on certain range. - - - - - param - yMin - M:Arction.Wpf.Charting.SeriesRound.SeriesBaseRound.GetMinMaxFromXRange(System.Double@,System.Double@,System.Double,System.Double) - - - - - - - param - yMax - M:Arction.Wpf.Charting.SeriesRound.SeriesBaseRound.GetMinMaxFromXRange(System.Double@,System.Double@,System.Double,System.Double) - - - - - - - param - xRangeMin - M:Arction.Wpf.Charting.SeriesRound.SeriesBaseRound.GetMinMaxFromXRange(System.Double@,System.Double@,System.Double,System.Double) - - - - - - - param - xRangeMax - M:Arction.Wpf.Charting.SeriesRound.SeriesBaseRound.GetMinMaxFromXRange(System.Double@,System.Double@,System.Double,System.Double) - - - - - - - returns - M:Arction.Wpf.Charting.SeriesRound.SeriesBaseRound.GetMinMaxFromXRange(System.Double@,System.Double@,System.Double,System.Double) - - - - - - - Defines if the series affects ZoomToFit operations. - If false, the series is ignored on ZoomToFit. - - - - - Series data has been modified directly by it's array. - Use this method to notify chart that this series needs a refresh - - - - - Is position over series. - - X coordinate - Y coordinate - Use DIP instead of pixels as parameters - true if position is over series. Else false. - - - - Line style - - - - - Is line visible or not - - - - - Lock object for points array modification and reading - - - - - View - - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Get item as LegendBoxMouseObject. - - related object - - - - returns - M:Arction.Wpf.Charting.SeriesRound.SeriesBaseRound.op_Implicit(Arction.Wpf.Charting.SeriesRound.SeriesBaseRound)~Arction.Wpf.Charting.Views.LegendBoxObject - - - - - - - Owner view - - - - - Parse value from string to double - - - - - param - value - M:Arction.Wpf.Charting.SeriesRound.SeriesBaseRound.ParseDouble(System.String) - - - - - - - returns - M:Arction.Wpf.Charting.SeriesRound.SeriesBaseRound.ParseDouble(System.String) - - - - - - - Point count stored in the Points array - - - - - Point style - - - - - Are points visible or not - - - - - Enlists the series title text in Legend box of the chart - - - - - Series title - - - - - Palette for color by Value - - - - - Is the series visible. - - - - - Point line series for smith chart. You can define the line style and point style. Add points with AddPoints method. - - - - - Constructor for Form designer list editor. - - - - - Constructor. - - Parent. - Smith axis this point liner series belongs to. - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Item to string. - - - - - returns - M:Arction.Wpf.Charting.SeriesSmith.PointLineSeriesSmith.ToString - - - - - - - Base class for all polar series. - - - - - Constructor for Form designer list editor. - - - - - Constructor - - - - - param - owner - M:Arction.Wpf.Charting.SeriesSmith.SeriesBaseSmith.#ctor(Arction.Wpf.Charting.Views.ViewSmith.ViewSmith,Arction.Wpf.Charting.Axes.AxisSmith) - - - - - - - param - axisSmith - M:Arction.Wpf.Charting.SeriesSmith.SeriesBaseSmith.#ctor(Arction.Wpf.Charting.Views.ViewSmith.ViewSmith,Arction.Wpf.Charting.Axes.AxisSmith) - - - - - - - Add points to end of series - - Points - Update chart after adding. Updating will raise CPU load, - so you maybe don't want to use this with every call if points are added many times per second. - Point count after adding - - - - Clear all points - - - - - Get min and max amplitude value withing given angle range - - Minimum amplitude value - Maximum amplitude value - Angle range start - Angle range end - True if values were successfully detected - - - - Series points - - - - - Tries to find the closest point of the series to the given coordinates. - - X screen coordinate to find the nearest series point from. - X screen coordinate to find the nearest series point from. - Angle value of the found point. - Amplitude value of the found point. - True if nearest point was found, false otherwise. - - - - Area series. - - - - - Constructor for Form designer list editor - - - - - Constructor. - - Parent. - Y axis you want to bind. - X axis you want to bind. - - - - Add values. - - Values array. - Total point count after adding. - - - - Base value - - - - - Clear all data. - - - - - Create members. - - - - - Create high point style. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Get point by given index. - - Index of point to get. - Point. - False if invalid index is given, otherwise true. - - - - Get point by given index. - - Index of point to get. - X value. - Y value. - False if invalid index is given, otherwise true. - - - - Loads series data from a CSV file. - - CSV file. If file does not exist, LoadFromCSV returns false. - Value and floating point number separator. - True if import succeeds. Otherwise false. - - - - Area series points array, to store data at once. - - - - - Points style. - - - - - Points visible. - - - - - Saves series data into CSV file - - Target file. If file already exists, it will be overwritten. - Value and floating point number separator definition - True if save is successful - - - - Band series is X or Y axis bound vertical or horizontal rectangular area, which ranges from - graph bottom to top (X bound) or left to right (Y bound) - from left to right having full width of the graph. - - - - - Constructor for Form designer list editor. - - - - - Constructor. - - Parent. - X-axis you want to bind. - Y-axis you want to bind. - - - - Allows moving the band by user. Move the band by dragging the band anywhere but not from its edge. - - - - - Allows resizing the band by user. Resize the band by dragging the band from its edge. - - - - - Is the band behind line series or on front of it. - - - - - Is the band bound to X or Y axis - - - - - Border color - - - - - Border width - - - - - Does nothing on this series type. - - - - - Create members. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Moved by user. - - - - - Fill - - - - - Invoke dragged by user event. - - - - - returns - M:Arction.Wpf.Charting.SeriesXY.Band.InvokeDraggedByUserEvent - - - - - - - Invoke resized by user event. - - - - - returns - M:Arction.Wpf.Charting.SeriesXY.Band.InvokeResizedByUserEvent - - - - - - - Check if position is over border. - - y-coordinate - x-coordinate - Edge on which user interactive device is - - - - Is position over band. - - x-coordinate - y-coordinate - Use DIP instead of pixels as parameters - true if position is over item, false otherwise - - - - Mouse moving pixel distance after which state is changed to Drag. - This is also in MouseMoveItem, but that's not inherited, but SeriesBaseXY instead. - - - - - Maximum value for ValueBegin or ValueEnd - - - - - Minimum value for ValueBegin or ValueEnd - - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Band resize border width. - - - - - Band has been resized by user. - - - - - Set proper dragging cursor, or over cursor. - - - - - Set begin and end values. - - Begin value. - End value. - - - - Series title - - - - - Description of class. - - description - - - - Limit the ValueBegin and ValueEnd inside the MinLimit...MaxLimit range, if enabled. - - - - - Band begin value - - - - - Band end value - - - - - Band begin and/or end value have been changed. - - - - - User interactive device over border status. - - - - - No edge. - - - - - Right. - - - - - Top. - - - - - Left. - - - - - Bottom. - - - - - The delegate to use for handlers that receive the ResizedByUser event. - - - Provides data for the ResizedByUser event. - - - - The delegate to use for handlers that receive the ValuesChanged event. - - - Provides data for the ValuesChanged event. - - - - Represents a class that provides arguments for the ResizedByUser event. - - - - - Creates and initializes a new instance of BandResizedByUserEventArgs class. - - - - - Band. - - - - - Set 'true' to prevent flickering if you update the chart in the event handler. - - - - - Begin value. - - - - - End value. - - - - - Bar series. Bars series present the data as vertical column(s). - - - - - Constructor for Form designer list editor. - - - - - Constructor. - - Parent. - X-axis you want to bind. - Y-axis you want to bind. - - - - Add value to end of Values array - - X value - Y value - Refresh chart after value adding - Text - New value index - - - - Bar width in pixels - - - - - Base level value. - - - - - Border color - - - - - Border width - - - - - Clear all points - - - - - Create members. - - - - - Cursor tracking enabled. - - - - - Delete a value by given index. - - Index of value to be deleted. - Refresh chart after value deleting. - False if invalid index is given, otherwise true. - - - - Delete values having smaller X value than given value. - - X value. - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Fill - - - - - Get rendered bar rectangles of all data items of this series. - - - - - returns - M:Arction.Wpf.Charting.SeriesXY.BarSeries.GetBarRectangles - - - - - - - Get Text by given index. - - Value index. - Text value. If invalid index is given, returns "". - - - - Get X value by given index. - - Value index. - X value. If invalid index is given, returns 0. - - - - Get Y value by given index. - - Value index. - Y value. If invalid index is given, returns 0. - - - - Notify series that data has been changed and refresh is required. - - - - - Is position over item. - - x-coordinate - y-coordinate - Use DIP instead of pixels as parameters - True if is over item, false otherwise - - - - Is position over item. - - x-coordinate - y-coordinate - Index of value the position is over of - Use DIP instead of pixels as parameters - True if position is over item, false otherwise - - - - Bar labels style - - - - - Loads series data from a CSV file. - - CSV file. If file does not exist, LoadFromCSV returns false. - Value and floating point number separator. - True if import succeeds. Otherwise false. - - - - Lock object for values array modification and reading - - - - - Occurs when old data points have been dropped. - - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Saves series data into CSV file. - - Target file. If file already exists, it will be overwritten. - Value and floating point number separator definition - True if save is successful - - - - Set value by given index - - Index of value to be set - X value - Y value - Refresh chart after value setting - Text - False if invalid index is given, else true - - - - Shadow below the bar - - - - - Sort data values ascending or descending. Makes big values to be drawn closest to axis zero if sort by ascending. - - If true, sort ascending else descending. - - - - Series title - - - - - Item to string. - - - - - returns - M:Arction.Wpf.Charting.SeriesXY.BarSeries.ToString - - - - - - - Series values - - - - - Values count stored in the Values array. - - - - - The delegate to use for handlers that receive the OldDataDropped event. - - The object that raised the event. - Provides data for the OldDataDropped event. - - - - Represents a class that provides arguments for the BeforeSeriesRendering event. - - - - - Creates and initializes a new instance of BeforeSeriesRenderingEventArgs class. - - - - - If you update the chart in the event handler, set to true to prevent flickering. - - - - - The series that is about to be rendered. - - - - - Base class for block series. - - - - - Constructor. - - - - - Constructor. - - - - - param - owner - M:Arction.Wpf.Charting.SeriesXY.BlockSeriesBase.#ctor(Arction.Wpf.Charting.Views.ViewXY.ViewXY,Arction.Wpf.Charting.Axes.AxisX,Arction.Wpf.Charting.Axes.AxisY) - - - - - - - param - axisX - M:Arction.Wpf.Charting.SeriesXY.BlockSeriesBase.#ctor(Arction.Wpf.Charting.Views.ViewXY.ViewXY,Arction.Wpf.Charting.Axes.AxisX,Arction.Wpf.Charting.Axes.AxisY) - - - - - - - param - axisY - M:Arction.Wpf.Charting.SeriesXY.BlockSeriesBase.#ctor(Arction.Wpf.Charting.Views.ViewXY.ViewXY,Arction.Wpf.Charting.Axes.AxisX,Arction.Wpf.Charting.Axes.AxisY) - - - - - - - Clear all data. - - - - - Gets and sets line color. - - - - - Create members. - - - - - Create title. - - - - - DataCursor tracking enabled. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Get minimum and maximum Y value withing given X range. - - Minimum Y value. - Maximum Y value. - X range start. - X range end. - Ignore zeros. - True if values were successfully detected. - - - - Get minimum X and maximum X of series X values - - X minimum. - X maximum. - True if minimum X and maximum X was obtained successfully. - - - - Series data has been modified directly by it's array. - Use this method to notify chart that this series needs a refresh. - - - - - Is position over series. - - X coordinate. - Y coordinate. - Use DIP instead of pixels as parameters - true if position is over series. Else false. - - - - Offset y value. This is added to each data value when rendering. - - - - - Tells how often the source data is cleared when using X axis scroll mode. - Valid range is 1...100. - 1 frees the source data after every 1/10 scroll page. - Use this when there's not much memory available. - 100 frees the source data after every 100/10 = 10 pages. - One need to set ViewXY.DropOldSeriesData to true to enable this functionality. - - - - - Series event markers. - - - - - Solve nearest sample to given X and Y screen coordinate. - - X screen coordinate. - Y screen coordinate. - Nearest sample X. - Nearest sample Y. - Nearest sample index in the SampleSingle or SamplesDouble array. - True if successfully solved. - - - - Solve nearest sample to given X and Y value. - - X value. - Y value. - Nearest sample X. - Nearest sample Y. - Nearest sample index in the SampleSingle or SamplesDouble array. - True if successfully solved. - - - - Solve y value at x value. - - Data x value. - Solve result. - - - - Series title - - - - - Gets and sets width of line. - - - - - Typed base class for block series. - - - - - - Constructor for Form designer list editor. - - - - - Constructor - - Parent. - Y-axis you want to bind. - X-axis you want to bind. - - - - Actual point count in series. - - - - - returns - M:Arction.Wpf.Charting.SeriesXY.BlockSeriesBase`1.ActualPointCount - - - - - - - Initial size - - - - - Create members. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Constant line is a horizontal line attached to a Y-axis value. It is drawn - from left to right having full width of the graph. - - - - - Constructor for Form designer list editor. - - - - - Constructor - - Parent. - X-axis you want to bind. - Y-axis you want to bind. - - - - Allows moving the constant line by user. - - - - - Is the constant line behind lineseries or on front of it. - - - - - Does nothing on this series type. - - - - - Create members. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Is position over item. - - x-coordinate - y-coordinate - Use DIP instead of pixels as parameters - true if position is over item, false otherwise - - - - Line style - - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Item center position when dragging starts. - - - - - Set proper cursor. - - - - - Series title - - - - - Constant line value - - - - - Value has been changed. - - - - - The delegate to use for handlers that receive the ValueChanged event. - - The object that raised the event. - Provides data for the ValueChanged event. - - - - Represents a class that provides arguments for the CustomLinePointColoringAndShaping event. - - - - - Creates and initializes a new instance of CustomLinePointColoringAndShapingEventArgs class. - - - - - The series to which this event is associated. - - - - - Represents a class that provides arguments for the CustomStockDataAppearance event. - - - - - Creates and initializes a new instance of CustomStockDataAppearanceEventArgs class. - - - - - Bar color (down). - - - - - Bar color (up). - - - - - Candle fill colors (down). - - - - - Candle fill gradient colors (down). - - - - - Candle fill colors (down). - - - - - Candle fill gradient colors (up). - - - - - Stock series data. - - - - - Item widths. - - - - - Digital line series. Uses arrays of uints as input data: uint[], where each value corresponds to 32 bit of data. Can be only used with Linear axis and DirectX11 engine. - - - - - Constructor. - - - - - Constructor. - - Series swner. - Attached x-axis. - Attached y-axis. - - - - Add bits to end of series. Each input value correspond to 32 bit values. - - Data array. - Update chart after adding data. Updating will raise CPU load, - which is why usage of this method is not recommended with every call if points are added many times per second. - Series bit count after adding. - - - - Added bit count. - - - - - - - summary - M:Arction.Wpf.Charting.SeriesXY.DigitalLineSeries.Clear - - - - - - - Construct some properties. - - - - - Delete points having smaller X value than given value. - - X value. - Compact memory. - - - - Digital High value. - - - - - Digital Low value. - - - - - Series bools. Each uint contains 32 bits corresponding to bool. - - - - - First sample time stamp, usually 1/SamplingFrequency. - - - - - Get minimum and maximum Y value withing given X range. - - Minimum Y value. - Maximum Y value. - X range start. - X range end. - Ignore zeros. - True if values were successfully detected. - - - - Get sample at index. - - Index to sample. - Sample at index. - - - - Get minimum X and maximum X of series X values - - X minimum. - X maximum. - True if minimum X and maximum X was obtained successfully. - - - - Is position over series. - - X coordinate. - Y coordinate. - Use DIP instead of pixels as parameters - true if position is over series. Else false. - - - - Get value at index. - - Index to data. - Data value at index. - - - - Occurs when old data samples have been dropped. - - - - - Sampling frequency, in Hz. (sample interval is 1/SamplingFrequency). - - - - - Detect triggering position from series data. - - Output triggered X position. - Trigger level Y value. - Minimum X value that is investigated. - Maximum X value that is investigated. - Triggering edge. - True if trigger position was detected, otherwise false. - - - - Find nearest series point of given X-coordinate and get corresponding Y-coordinate. - - X-coordinate in pixels or DIP. - Use DIP instead of pixels as parameters. - Solve result. - - - - Solve Y value on given X value. Returned value will be interpolated, if X is between sequential points X values. - - X value. - Solve status. NearestX will be double.NaN if point is not in the data range. - - - - The delegate to use for handlers that receive the OldDataDropped event. - - The object that raised the event. - Provides data for the OldDataDropped event. - - - - Freeform point line series. You can define the line and points style. Add points with AddPoints method. - - - - - Constructor for Form designer list editor. - - - - - Constructor. - - Parent. - X-axis you want to bind. - Y-axis you want to bind. - - - - Add points with error tolerance to end of series. - - Points. - Update chart after adding. Updating will raise CPU load, - so you maybe don't want to use this with every call if points are added many times per second. - Point count after adding. - - - - Add points to end of series. - - Points. - Update chart after adding. Updating will raise CPU load, - so you maybe don't want to use this with every call if points are added many times per second. - Point count after adding. - - - - Add points to end of series. - - X values. - Y values. - Update chart after adding. Updating will raise CPU load, - so you maybe don't want to use this with every call if points are added many times per second. - Point count after adding. - - - - Points initial size - - - - - Clear all points - - - - - Create members. - - - - - Cursor tracking enabled. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Error bars. - - - - - Gets last (newest) point. - - Last point. - - - - Get min and max Y value within given X range. - - Minimum Y value. - Maximum Y value. - X range start. - X range end. - Ignore zeros. - True if values were successfully detected. - - - - This is similar to GetMinMaxFromXRange, but tailored for Series with DataBreaking. - Get min and max Y value within given X range, but Ignore some values (gap defining value). - - Minimum Y value. - Maximum Y value. - X range start. - X range end. - Gap defining value. - True if values were successfully detected. - - - - Get minimum X and maximum X of series X values. - - X minimum. - X maximum. - True if minimum X and maximum X was obtained successfully. - - - - Get X values array. - - X values array. - - - - Get Y values array. - - Y values array. - - - - Selects how to use the individual point colors. Sets which PointStyle color is replaced with PointColor. - - - - - Invalidate data array. Statistics and draw data are recalculated. - - - - - Loads series data from a CSV file. Note that this loads points according to value. So if you need to load both, change PointsType accordingly between two calls to this method. - - CSV file name. If file does not exist, LoadFromCSV returns false. - Value and floating point number separator. - True if import succeeds. Otherwise false. - - - - Gets the index of oldest point in Points array. - When PointCountLimitEnabled is true, the Points array is used as an circular point buffer. - This is 0 always when PointCountLimitEnabled is false. - To read Points, when OldestPointIndex is 0: - Read from index 0 till PointCount-1. - To read Points, when OldestPointIndex is > 0: - First read from OldestPointIndex till PointCountLimit-1. Then read from index 0 till OldestPointIndex-1. - - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Point count limit. If you add points more than limited count, first - points are automatically removed. The limiter only applies if PointCountLimitEnabled is true. - If PointCountLimitEnabled is true, the array of corresponding size will be create in memory. - - - - - Limit point count by dropping oldest points. The point count is limited to PointCountLimit. - - - - - Series points - - - - - Points type - - - - - Series points with error tolerance indicators - - - - - Saves series data into CSV file. Note that this save points according to value. So if you need to save both, change PointsType accordingly between two calls to this method. - - Target file. If file already exists, it will be overwritten. - Value and floating point number separator definition - True if save is successful - - - - Set X value of Points array item. - - Point index in Points array. - X value. - - - - Set Y value of Points array item. - - Point index in Points array. - Y value. - - - - Solve nearest data point to given X and Y screen coordinate [input in DIP]. - - X screen coordinate as DIP. - Y screen coordinate as DIP. - Nearest data point X. - Nearest data point Y. - Nearest data point index in the Points or PointsWithErrors array. - True if successfully solved. - - - - Solve nearest data point to given X and Y value. - - X value. - Y value. - Nearest data point X. - Nearest data point Y. - Nearest data point index in the Points or PointsWithErrors array. - True if successfully solved. - - - - Find all instances of FreeformPointLineSeries’ intersection with vertical line going through the given X-coordinate. - The intersection point is described by segment of line (pair of LineSeries’ points) it is found. - Each intersection point is returned as structure, and method returns the list of those structures. - - Note that you might be interested in using - for some of the use cases. - X-coordinate in pixels or DIP.Use DIP instead of pixels as parameters.Iterable list of solve results. - - - - param - x - M:Arction.Wpf.Charting.SeriesXY.FreeformPointLineSeries.SolveYCoordsAtXCoord(System.Single,System.Boolean) - - - - - - - param - useDIP - M:Arction.Wpf.Charting.SeriesXY.FreeformPointLineSeries.SolveYCoordsAtXCoord(System.Single,System.Boolean) - - - - - - - returns - M:Arction.Wpf.Charting.SeriesXY.FreeformPointLineSeries.SolveYCoordsAtXCoord(System.Single,System.Boolean) - - - - - - - Find all instances of FreeformPointLineSeries’ intersection with vertical line going through the given X-value. - The intersection point is described by segment of line (pair of LineSeries’ points) it is found. - Each intersection point is returned as structure, and method returns the list of those structures. - - Note that you might be interested in using - for some of the use cases. - X-value.Iterable list of solve results. - - - - param - x - M:Arction.Wpf.Charting.SeriesXY.FreeformPointLineSeries.SolveYValuesAtXValue(System.Double) - - - - - - - returns - M:Arction.Wpf.Charting.SeriesXY.FreeformPointLineSeries.SolveYValuesAtXValue(System.Double) - - - - - - - HighLow series. - - - - - Constructor for Form designer list editor - - - - - Constructor. - - Parent. - X-axis you want to bind. - Y-axis you want to bind. - - - - Add values. - - Values array. - Total point count after adding. - - - - Clear all data. - - - - - Create members. - - - - - Create low line style. - - - - - Create high point style. - - - - - Create low point style. - - - - - Create title. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Get point by given index. - - Index of point to get. - Point. - False if invalid index is given, otherwise true. - - - - Line style for high edge. - - - - - Line style for low edge. - - - - - High line visible. - - - - - Low line visible. - - - - - Loads series data from a CSV file. - - CSV file. If file does not exist, LoadFromCSV returns false. - Value and floating point number separator. - True if import succeeds. Otherwise false. - - - - Points array - - - - - Point style high - - - - - Point style low - - - - - High points visible. - - - - - Low points visible. - - - - - Reverse fill. - - - - - Saves series data into CSV file. - - Target file. If file already exists, it will be overwritten. - Value and floating point number separator definition - True if save is successful - - - - HighLow series. - - - - - Constructor. - - Parent. - X-axis you want to bind. - Y-axis you want to bind. You can give null if X-axis binding is used. - - - - Anti-alias area draw. - - - - - Points initial size - - - - - Clear all draw data. - - - - - Create members. - - - - - Draws a connecting area over ExcludeRange gap, if this flag is set. - - - - - Create fill. - - - - - Create line style. - - - - - Create reverse fill. - - - - - Create title. - - - - - Cursor tracking enabled. - - - - - Deceed fill. - - - - - Deceed limit (value "of below"). - - - - - Delete points having smaller X value than given value - - - - - param - xValue - M:Arction.Wpf.Charting.SeriesXY.HighLowSeriesBase.DeletePointsBeforeX(System.Double) - - - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Exceed fill. - - - - - Exceed limit. - - - - - Normal fill. - - - - - Get min and max Y value within given X range. - - Minimum Y value. - Maximum Y value. - X range start. - X range end. - Ignore zeros. - True if values were successfully detected. - - - - Get minimum X and maximum X of series X values - - X min - X max - True if minimum X and maximum X was obtained successfully - - - - Selects how to use the individual point colors. Sets which PointStyle color is replaced with PointColor. - - - - - Invalidate data array. Statistics and draw data are recalculated. - - - - - Is position over series. - - X coordinate - Y coordinate - Use DIP instead of pixels as parameters - true if position is over series. Else false. - - - - Occurs when old data points have been dropped. - - - - - Stabilize scrolling mode by rounding shifting to nearest integer pixel position. - Reduces wobbling of the scrolling waveform, but may show as slight X-dimensional distortion. - Only applies when XAxis ScrollMode = Scrolling. - - - - Tells how often the draw data is cleared when using X-axis scroll mode. - Valid range is 1...100 - 1 frees the draw data and the reconstructs the draw data after every 1/10 scroll page. - Use this when there's not much memory available. - 100 frees the draw data and the reconstructs the draw data after every 100/10 = 10 pages. - Use this when smooth scroll with high FPS is important. Reserves some extra memory. - - - - - Seek visible range first series point index (actually one point before that) - - Start x value - Sweep page index - Start point index. If unable to find start point, returns -1 - - - - Simple highlight color when user interactive device is over. - - - - - Find nearest series point of given X-coordinate and get corresponding Y-coordinate. - - X-coordinate in pixels or DIP. - Use DIP instead of pixels as parameters. - Solve result. - - - - Solve y-value or range on given x-value. - - x-value - Solve status. - - - - Use limits. - - - - - The delegate to use for handlers that receive the OldDataDropped event. - - The object that raised the event. - Provides data for the OldDataDropped event. - - - - Interface for triggering X axis position from series values - The triggering can be done from raising and falling edge. - - - - - Detect triggering position from series data. - - Output triggered X position - Trigger level Y value - Minimum X value that is investigated - Maximum X value that is investigated - Triggering edge - True if trigger position was detected, else false. - - - - Intensity grid series. Evenly spaced intensity value series. - - - - - Constructor for Form designer list editor. - - - - - Constructor. - - Parent. - X-axis you want to bind. - Y-axis you want to bind. - - - - Create members. - - - - - Create new data array. - - X-size - Y-size - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Get minimums and maximums of Series X, Y and data Values. - - Minimum X. - Maximum X. - Minimum Y. - Maximum Y. - Minimum data value. - Maximum data value. - True if data could be analyzed and output values are valid, otherwise false. - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Render as non-interpolated bitmap, data point in the middle of each cell - - - - - Maximum X range value. - - - - - Maximum Y range value - - - - - Minimum X range value - - - - - Minimum Y range value - - - - - Sets X and Y range at same time. Very CPU efficient way compared to separately setting - RangeMinX, RangeMaxX, RangeMinY and RangeMaxY properties. - - Minimum X. - Maximum X. - Minimum Y. - Maximum Y. - - - - Intensity mesh series. Nodes can be freely located in X-Y space. - - - - - Constructor for Form designer list editor - - - - - Constructor. - - Parent. - X-axis you want to bind. - Y-axis you want to bind. - - - - Create members. - - - - - Clean up any resources being used. - - True if managed resources should be disposed, otherwise false. - - - - Get minimums and maximums of Series X, Y and data Values. - - Minimum X. - Maximum X. - Minimum Y. - Maximum Y. - Minimum data value. - Maximum data value. - True if data could be analyzed and output values are valid, otherwise false. - - - - Base class for intensity series classes. - - - - - Constructor. - - - - - Constructor. - - - - - param - owner - M:Arction.Wpf.Charting.SeriesXY.IntensitySeriesBase.#ctor(Arction.Wpf.Charting.IChartNode) - - - - - - - Check if the given surface size can be used with the GPU. - GPU index buffer capacity is verified. - - X size. - Z size. - True if index buffer size on the GPU is sufficient, else false. - - - - Clears the series. Initializes Data with InitialValues. - Sets the data point colors to BaseColor. - - - - - Create members. - - - - - Contour Line Label's properties. - Property tree: if enabled; format, font and color of text. - Default state is disabled; - - - - - Line style. - - - - - Contour line style. - - - - - Create new data array. - - X size. - Y size. - - - - Enable DataCursor tracking. - - - - - Intensity point data. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Free all vertex and index buffer data - - - - - param - sweepPageIndex - M:Arction.Wpf.Charting.SeriesXY.IntensitySeriesBase.DisposeStaticBuffers(System.Int32) - - - - - - - Data value range for fast contour zones. The fast contour zone is a contour line equivalent. - - - - - Fill. - - - - - Render with full interpolation. If only half interpolation is used, it can give performance increment with large intensity series. - - - - - Get Contour to the List of levels, which is List of polylines/routes. - The contour lines are rebuild with current palette steps' value and color. - - The List of list of polylines for each contour step value. - The list of contour's step values. - The list of contour's step colors. - - - - Get Data array color - - Column index of Data array - Row index of Data array - Color. If invalid index is given, returns Color.Black. - - - - Get Data array color. - - Column index of Data array - Row index of Data array - Color. - True, if valid indexes. If invalid index is given, false and returns Color.Black. - - - - Get Data array value. - - Column index of Data array. - Row index of Data array. - Z value. If invalid index is given, returns 0. - - - - Get Data array value. - - Column index of Data array. - Row index of Data array. - Y value. In case of error, 0. - True, if valid indexes, false otherwise. - - - - Get Data array X value. - - Column index of Data array. - Row index of Data array. - X value. If invalid index is given, returns 0. - - - - Get Data array X value. - - Column index of Data array. - Row index of Data array. - X value. In case of error, 0. - True, if valid indexes, false otherwise. - - - - Get Data array Y value. - - Column index of Data array. - Row index of Data array. - Y value. If invalid index is given, returns 0. - - - - Get Data array Y value. - - Column index of Data array. - Row index of Data array. - Y value. In case of error, 0. - True, if valid indexes, false otherwise. - - - - Get minimums and maximums of Series X, Y and data Values. - - Minimum X. - Maximum X. - Minimum Y. - Maximum Y. - Minimum data value. - Maximum data value. - True if data could be analyzed and output values are valid, otherwise false. - - - - Initial value for data Y. Clears the series. It is applied when creating or resizing Data array. - - - - - Invalidate colors only. Use this together with Optimization = DynamicValuesData. - Does not update the geometry to the GPU when not needed, allowing significantly faster rendering. - - - - - Series data has been modified directly by its array. - Use this method to notify chart that this series needs a refresh. - - - - - Invalidate stencil data. - - - - - Invalidate values data only. Use this together with Optimization = DynamicValuesData. - Does not update the geometry to the GPU when not needed, allowing significantly faster rendering. - - - - - Check if coordinate is over cell in the series. - - X-coordinate. - Y-coordinate. - Returned column index. - Returned row index. - Use DIP instead of pixels as parameters. - True, if coordinate is over some cell, false otherwise. - - - - Is position over series. - - X coordinate - Y coordinate - Use DIP instead of pixels as parameters - true if position is over series. Else false. - - - - Intensity series units, shown in legend box. Use this for intensity data units, not Y-axis units. - - - - - Numeric format for showing legend box value labels. - - - - - Value type: time, numeric or coordinates. Affects legend box value formatting. - - - - - Loads series data from a CSV file. - - CSV file name. If file does not exist, LoadFromCSV returns false. - Value and floating point number separator. - True if import succeeds. Otherwise false. - - - - Lock object for data array modification and reading - - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Optimization selection for the series usage. Use StaticData if data does not changed frequently, - allowing faster updates when other objects in the chart are updating. - DynamicData selection is better when the data is changed many times / second. - - - - - Rebuilds rendering data. Expert's method for allowing multi-threaded application to pre-build rendering data before rendering stage. - Rendering stage must always be synchronized to main thread, but this call can be called parallel for every series of this type. - - X-axis minimum. - X-axis maximum. - X-axis sweeping page index (set 0 if sweeping is not used). - Graph segment top. - Graph segment height. - - - - Saves series data into a CSV file. - - Target file. If file already exists, it will be overwritten. - Value and floating point number separator definition - True if save is successful - - - - Sets colors. Doesn't update the Data array contents itself. - Very handy to make the chart render fast when the colors are being changed frequently, - especially with IntensityGridSeries' PixelRendering mode enabled. - - Data. The alignment must be M x N, all rows must be of equal length. - Jagged array order dimensions order. Is first array dimension columns and second dimension rows, or vice versa. - Success status. - - - - - - summary - M:Arction.Wpf.Charting.SeriesXY.IntensitySeriesBase.SetDataValue(System.Int32,System.Int32,System.Double,System.Double,System.Double,System.Windows.Media.Color) - - - - - - - param - columnIndex - M:Arction.Wpf.Charting.SeriesXY.IntensitySeriesBase.SetDataValue(System.Int32,System.Int32,System.Double,System.Double,System.Double,System.Windows.Media.Color) - - - - - - - param - rowIndex - M:Arction.Wpf.Charting.SeriesXY.IntensitySeriesBase.SetDataValue(System.Int32,System.Int32,System.Double,System.Double,System.Double,System.Windows.Media.Color) - - - - - - - param - x - M:Arction.Wpf.Charting.SeriesXY.IntensitySeriesBase.SetDataValue(System.Int32,System.Int32,System.Double,System.Double,System.Double,System.Windows.Media.Color) - - - - - - - param - y - M:Arction.Wpf.Charting.SeriesXY.IntensitySeriesBase.SetDataValue(System.Int32,System.Int32,System.Double,System.Double,System.Double,System.Windows.Media.Color) - - - - - - - param - value - M:Arction.Wpf.Charting.SeriesXY.IntensitySeriesBase.SetDataValue(System.Int32,System.Int32,System.Double,System.Double,System.Double,System.Windows.Media.Color) - - - - - - - param - color - M:Arction.Wpf.Charting.SeriesXY.IntensitySeriesBase.SetDataValue(System.Int32,System.Int32,System.Double,System.Double,System.Double,System.Windows.Media.Color) - - - - - - - returns - M:Arction.Wpf.Charting.SeriesXY.IntensitySeriesBase.SetDataValue(System.Int32,System.Int32,System.Double,System.Double,System.Double,System.Windows.Media.Color) - - - - - - - Create data based on bitmap file contents. Data array will have dimensions of the bitmap Width X Height. - Use options to reduce resolution and smooth it if needed. - Height data of is calculated for each pixel from R, G, and B sum. 0 (black) will have the minimum value, - and maximum value is obtained from 3*255 (white). If bitmap has alpha value of 0, the data is set to -INF, - and the value is not drawn. - - Minimum X. - Maximum X. - Minimum Y. - Maximum Y. - Minimum intensity. - Maximum intensity. - Input bitmap. - Bitmap resolution decrement and smoothing options. Give null to use pure bitmap data only. - True if data was successfully filled, else false. - - - - Set grid size, both X and Y at same time. If you already have a large existing data, - using this method is faster than setting SizeX and SizeY separately. - - X size. - Y size. - - - - Sets values. Doesn't update the Data array contents itself. - Very handy to make the chart render fast when the data is being changed frequently, - especially with IntensityGridSeries' PixelRendering mode enabled. - - Data. The alignment must be M x N, all rows must be of equal length. - Jagged array order dimensions order. Is first array dimension columns and second dimension rows, or vice versa. - Success status. - - - - Sets values. Doesn't update the Data array contents itself. - Very handy to make the chart render fast when the data is being changed frequently, - especially with IntensityGridSeries' PixelRendering mode enabled. - - Data. The alignment must be M x N, all rows must be of equal length. - Jagged array order dimensions order. Is first array dimension columns and second dimension rows, or vice versa. - Success status. - - - - Show nodes. - - - - - Grid size in X dimension (Data array columns). - - - - - Grid size in Y dimension (Data array rows). - - - - - Stencil. - - - - - Series title. - - - - - Surface tone color. - - - - - Tracing the surface cell is enabled. - - - - - Tracing has been moved to over different intensity series cell. - - - - - Color palette for Y value information. - - - - - Wireframe line style. - - - - - Wireframe type. - - - - - Determine DataCursor ResultTable visible data. - - - - - Delegate for TraceCellChanged event - - Sender - X coordinate - Y coordinate - Nearest data column index at coordinate - Nearest data row index at coordinate - New column index (X dimension) - New row index (Y dimension) - Nearest intensity point, in corner of the cell. Not available when PixelRendering is enabled. - Screen X coordinate of nearest data column to mouse coordinate. Not available when PixelRendering is enabled. - Screen Y coordinate of nearest data column to mouse coordinate. Not available when PixelRendering is enabled. - - - - IntensitySeries stencil. Use to mask drawable regions in/out. - - - - - Constructor. - - - - - Constructor. - - - - - param - owner - M:Arction.Wpf.Charting.SeriesXY.IntensitySeriesStencil.#ctor(Arction.Wpf.Charting.SeriesXY.IntensitySeriesBase) - - - - - - - Additive stencil areas. Used like positive mask. - - - - - Create members. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Subtractive stencil areas. Used like negative mask. - - - - - Convert class description to string - - String - - - - Interface flag for series that can be - - Shifted in real-time, by using incremental rendering data construction, - with XAxis.ScrollMode == Scrolling/Sweeping/Stepping, and setting XAxis.ScrollPosition periodically. - These series implementing this interface are very powerful in rendering of data that is appended in real-time. - - - - - Interface for series which return only single LineSeriesSolveResult. - - - - - Find nearest series point of given X-coordinate and get corresponding Y-coordinate. - - X-coordinate in pixels or DIP. - Use DIP instead of pixels as parameters. - Solve result. - - - - Find nearest series point of given X-value and get corresponding Y-value. - - X-value. - Solve result. - - - - Interface flag for series that can be - - Tracked with LineSeriesCursor - - SeriesEventMarkers can be set to SeriesEventMarkerVerticalPosition can be set to TrackSeries - - - - - Line collection. Just a bunch of lines, going from point A to B. This is not a polyline. - - - - - Constructor. - - - - - Constructor. - - Parent. - X-axis you want to bind. - Y-axis you want to bind. - - - - LineCollection will be drawn behind bars. - - - - - Clear all data. - - - - - Create members. - - - - - Cursor tracking enabled. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Get segment indexes for segments under point. - - x-coordinate. - y-coordinate. - Use dips instead of pixels. - - - - returns - M:Arction.Wpf.Charting.SeriesXY.LineCollection.GetSegmentsAtPoint(System.Double,System.Double,System.Boolean) - - - - - - - Series data has been modified directly by it's array. - Use this method to notify chart that this series needs a refresh. If this is not called after data has been changed - the lines are not drawn correctly. - - - - - Is position over series. - - X coordinate. - Y coordinate. - Use DIP instead of pixels as parameters - true if position is over series. Else false. - - - - Array of line segments. - Note that you need to call InvalidateData method if you modify the array's items directly for the changes to affect the drawing. - Calling InvalidateData is not necessary if the whole array is set. - - - - - Line style. - - - - - Loads series data from a CSV file. - - CSV file name. If file does not exist, LoadFromCSV returns false. - Value and floating point number separator. - True if import succeeds. Otherwise false. - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Saves series data into CSV file. - - Target file. If file already exists, it will be overwritten. - Value and floating point number separator definition - True if save is successful - - - - Statistics of the series - - - - - Series title - - - - - Item to string. - - - - - returns - M:Arction.Wpf.Charting.SeriesXY.LineCollection.ToString - - - - - - - Lite freeform line series. Uses arrays of points as input data: double[N,2]. Can be only used with Linear axis and DirectX11 engine. - - - - - Constructor. - - - - - Constructor. - - Series swner. - Attached x-axis. - Attached y-axis. - - - - Add points to end of series, [N,2] format, where [i,0] is x and [i,1] is y. - - Data array. - Update chart after adding data. Updating will raise CPU load, - which is why usage of this method is not recommended with every call if points are added many times per second. - Series point count after adding. - - - - Construct some properties. - - - - - Get minimum and maximum Y value withing given X range. - - Minimum Y value. - Maximum Y value. - X range start. - X range end. - Ignore zeros. - True if values were successfully detected. - - - - Get point at index. - - Index to point. - Point at index. - - - - Get minimum X and maximum X of series X values - - X minimum. - X maximum. - True if minimum X and maximum X was obtained successfully. - - - - Is position over series. - - X coordinate. - Y coordinate. - Use DIP instead of pixels as parameters - true if position is over series. Else false. - - - - Get point at index. - - Index to point. - Point at index. - - - - Line rendering limit on y-axis. - - - - - Occurs when old data samples have been dropped. - - - - - Added point count. - - - - - Point count limit. Series will contain at least this amount of points, but will limit to higher count based on data blocks. - - - - - Enable/disable point count limiter. See - - - - Series points. - - - - - - - summary - M:Arction.Wpf.Charting.SeriesXY.LiteFreeformLineSeries.SolveNearestSampleByValue(System.Double,System.Double,System.Double@,System.Double@,System.Int32@) - - - - - - - param - xValue - M:Arction.Wpf.Charting.SeriesXY.LiteFreeformLineSeries.SolveNearestSampleByValue(System.Double,System.Double,System.Double@,System.Double@,System.Int32@) - - - - - - - param - yValue - M:Arction.Wpf.Charting.SeriesXY.LiteFreeformLineSeries.SolveNearestSampleByValue(System.Double,System.Double,System.Double@,System.Double@,System.Int32@) - - - - - - - param - nearestSampleXValue - M:Arction.Wpf.Charting.SeriesXY.LiteFreeformLineSeries.SolveNearestSampleByValue(System.Double,System.Double,System.Double@,System.Double@,System.Int32@) - - - - - - - param - nearestSampleYValue - M:Arction.Wpf.Charting.SeriesXY.LiteFreeformLineSeries.SolveNearestSampleByValue(System.Double,System.Double,System.Double@,System.Double@,System.Int32@) - - - - - - - param - nearestIndex - M:Arction.Wpf.Charting.SeriesXY.LiteFreeformLineSeries.SolveNearestSampleByValue(System.Double,System.Double,System.Double@,System.Double@,System.Int32@) - - - - - - - returns - M:Arction.Wpf.Charting.SeriesXY.LiteFreeformLineSeries.SolveNearestSampleByValue(System.Double,System.Double,System.Double@,System.Double@,System.Int32@) - - - - - - - Find nearest series point of given X-coordinate and get corresponding Y-coordinate. - - X-coordinate in pixels or DIP. - Use DIP instead of pixels as parameters. - Solve result. - - - - Solve Y value on given X value. Returned value will be interpolated, if X is between sequential points X values. - - X value. - Solve status. NearestX will be double.NaN if point is not in the data range. - - - - The delegate to use for handlers that receive the OldDataDropped event. - - The object that raised the event. - Provides data for the OldDataDropped event. - - - - Lite line series. Uses arrays of points as input data: double[N,2]. Can be only used with Linear axis and DirectX11 engine. - - - - - Constructor. - - - - - Constructor. - - Series swner. - Attached x-axis. - Attached y-axis. - - - - Add points to end of series, [N,2] format, where [i,0] is x and [i,1] is y. - - Data array. - Update chart after adding data. Updating will raise CPU load, - which is why usage of this method is not recommended with every call if points are added many times per second. - Series sample count after adding. - - - - Construct some properties. - - - - - Delete points having smaller X value than given value. - - X value. - Compact memory. - - - - Get minimum and maximum Y value withing given X range. - - Minimum Y value. - Maximum Y value. - X range start. - X range end. - Ignore zeros. - True if values were successfully detected. - - - - Get point at index. - - Index to point. - Point at index. - - - - Get minimum X and maximum X of series X values - - X minimum. - X maximum. - True if minimum X and maximum X was obtained successfully. - - - - Get point at index. - - Index to point. - Point at index. - - - - Line rendering limit on y-axis. - - - - - Occurs when old data samples have been dropped. - - - - - Added point count. - - - - - Series points. - - - - - Detect triggering position from series data. - - Output triggered X position. - Trigger level Y value. - Minimum X value that is investigated. - Maximum X value that is investigated. - Triggering edge. - True if trigger position was detected, otherwise false. - - - - Find nearest series point of given X-coordinate and get corresponding Y-coordinate. - - X-coordinate in pixels or DIP. - Use DIP instead of pixels as parameters. - Solve result. - - - - Solve Y value on given X value. Returned value will be interpolated, if X is between sequential points X values. - - X value. - Solve status. NearestX will be double.NaN if point is not in the data range. - - - - The delegate to use for handlers that receive the OldDataDropped event. - - The object that raised the event. - Provides data for the OldDataDropped event. - - - - Represents a class that provides arguments for the OldDataDropped event. - - - - - Creates and initializes a new instance of OldDataDroppedBarSeriesEventArgs class. - - - - - The series whose old data was dropped. - - - - - Represents a class that provides arguments for the OldDataDropped event. - - - - - Creates and initializes a new instance of OldDataDroppedDigitalLineSeriesEventArgs class. - - - - - The series whose old data was dropped. - - - - - Represents an abstract base class for event arguments classes that provide arguments for OldDataDropped events. - - - - - - - Arction.Wpf.Charting.SeriesXY.OldDataDroppedEventArgs - - - - - - - The dropping limit, upper end. - - - - - The minimum data point X that was dropped. - - - - - Represents a class that provides arguments for the OldDataDropped event. - - - - - Creates and initializes a new instance of OldDataDroppedHighLowSeriesBaseEventArgs class. - - - - - The series whose old data was dropped. - - - - - Represents a class that provides arguments for the OldDataDropped event. - - - - - Creates and initializes a new instance of OldDataDroppedLiteFreeFormLineSeriesEventArgs class. - - - - - The series whose old data was dropped. - - - - - Represents a class that provides arguments for the OldDataDropped event. - - - - - Creates and initializes a new instance of OldDataDroppedLiteLineSeriesEventArgs class. - - - - - The series whose old data was dropped. - - - - - Represents a class that provides arguments for the OldDataDropped event. - - - - - Creates and initializes a new instance of OldDataDroppedPointLineSeriesEventArgs class. - - - - - The series whose old data was dropped. - - - - - Represents a class that provides arguments for the OldDataDropped event. - - - - - Creates and initializes a new instance of OldDataDroppedSampleDataSeriesEventArgs class. - - - - - The series whose old data was dropped. - - - - - Represents a class that provides arguments for the OldDataDropped event. - - - - - Creates and initializes a new instance of OldDataDroppedSampleDataSeriesEventArgs class. - - - - - The series whose old data was dropped. - - - - - Represents a class that provides arguments for the OldDataDropped event. - - - - - Creates and initializes a new instance of OldDataDroppedSampleDataSeriesEventArgs class. - - - - - The series whose old data was dropped. - - - - - Point line series. You can define the line style and point style. Add points with AddPoints method. - - - - - Constructor for Form designer list editor - - - - - Constructor - - Owner view - Y axis you want to bind - X axis you want to bind - - - - Add points with error tolerance to end of series - - Points - Update chart after adding. Updating will raise CPU load, - so you maybe don't want to use this with every call if points are added many times per second. - Point count after adding - - - - Add points to end of series - - Points - Update chart after adding. Updating will raise CPU load, - so you maybe don't want to use this with every call if points are added many times per second. - Point count after AddPoints method call. - - - - Add points to end of series - - X values array - Y values array - Update chart after adding. Updating will raise CPU load, - so you maybe don't want to use this with every call if points are added many times per second. - Point count after adding - - - - Check that rule X[i+1] >= X[i] is followed - - True if rule followed, or less than 2 points in the series. Else false. - - - - Points initial size - - - - - Clear all points - - - - - Create members. - - - - - Draws a connecting line over ExcludeRange gap, if this flag is set. - - - - - Cursor tracking enabled. - - - - - Delete points having smaller X value than given value - - - - - param - xValue - M:Arction.Wpf.Charting.SeriesXY.PointLineSeries.DeletePointsBeforeX(System.Double) - - - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Error bars. - - - - - Get min and max Y value within given X range - - Minimum Y value - Maximum Y value - X range start - X range end - Ignore zeros - True if values were successfully detected - - - - This is similar to GetMinMaxFromXRange, but tailored for Series wth DataBreaking. - Get min and max Y value within given X range, but Ignore some values (gap defining value) - - Minimum Y value - Maximum Y value - X range start - X range end - Gap defining value - True if values were successfully detected - - - - Get the factors that are used in regression line plotting - - Factors, length = polynomial order+1. For example, when having order 2, you can plot line with equation: Y = factors[0] + factors[1]*X + factors[2]*X^2 - - - - Get minimum X and maximum X of series X values - - X min - X max - True if minimum X and maximum X was obtained successfully - - - - Get X values array. - - X values array - - - - Get Y values array. - - Y values array - - - - Selects how to use the individual point colors. Sets which PointStyle color is replaced with PointColor. - - - - - Invalidate data array. Statistics and draw data are recalculated. - - - - - Loads series data from a CSV file. - - CSV file name. If file does not exist, LoadFromCSV returns false. - Value and floating point number separator. - True if import succeeds. Otherwise false. - - - - Occurs when old data points have been dropped. - - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Series points. - - - - - Points type. - - - - - Series points with error tolerance indicators. - - - - - Regression fitting to data points. - - - - - Polynomial regression order. - - - - - Saves series data into CSV file - - Target file. If file already exists, it will be overwritten. - Value and floating point number separator definition - True if save is successful - - - - Stabilize scrolling mode by rounding shifting to nearest integer pixel position. - Reduces wobbling of the scrolling waveform, but may show as slight X-dimensional distortion. - Only applies when XAxis ScrollMode = Scrolling. - - - - Tells how often the draw data is cleared when using X-axis scroll mode. - Valid range is 1...100 - 1 frees the draw data and the reconstructs the draw data after every 1/10 scroll page. - Use this when there's not much memory available. - 100 frees the draw data and the reconstructs the draw data after every 100/10 = 10 pages. - Use this when smooth scroll with high FPS is important. Reserves some extra memory. - - - - - Detect triggering position from series data - - Output triggered X position - Trigger level Y value - Minimum X value that is investigated - Maximum X value that is investigated - Triggering edge - True if trigger position was detected, else false. - - - - Seek visible range first series point index (actually one point before that) - - Start x value - Current start point index - Start point index. If unable to find start point, returns -1 - - - - Fill Points array from X and Y values - - X values array - Y values array - - - - Set X value of Points array item. - - Point index in Points array - X value - - - - Set Y value of Points array item. - - Point index in Points array - Y value - - - - Solve nearest data point to given X and Y screen coordinate [input in DIP]. - - X screen coordinate as DIP - Y screen coordinate as DIP - Nearest data point X - Nearest data point Y - Nearest data point index in the Points or PointsWithErrors array - True if successfully solved - - - - Solve nearest data point to given X and Y value. - - X value - Y value - Nearest data point X - Nearest data point Y - Nearest data point index in the Points or PointsWithErrors array. - True if successfully solved - - - - Solve y-value or range on given x-value. - - x-value - Solve status. - - - - The delegate to use for handlers that receive the OldDataDropped event. - - The object that raised the event. - Provides data for the OldDataDropped event. - - - - Base class for point line series. - - - - - Creates and initializes a new instance of this class. - - - - - Creates and initializes a new instance of this class. - - - - - param - owner - M:Arction.Wpf.Charting.SeriesXY.PointLineSeriesBase.#ctor(Arction.Wpf.Charting.Views.ViewXY.ViewXY) - - - - - - - Clear the series data - - - - - Create members. - - - - - Create line style. - - - - - Create title. - - - - - Custom line coloring and line coordinates event. Event handler must give color for each data point received in the handler. - The coordinates can be adjusted as well and new line points can be inserted. - - - - - Data breaking options. Defines, if gaps are enabled on series data and by which value. - Default state is disabled and default gap value is Double.NaN; - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Get minimum and maximum Y value within given X range. - - Minimum Y value. - Maximum Y value. - X range start. - X range end. - Ignore zeros. - True if values were successfully detected. - - - - This is similar to GetMinMaxFromXRange, but tailored for Series with DataBreaking. - Get minimum and maximum Y value within given X range, but Ignore some values (gap defining value). - - Minimum Y value. - Maximum Y value. - X range start. - X range end. - Gap defining. - True if values were successfully detected. - - - - Get minimum X and maximum X of series X values - - X minimum. - X maximum. - True if minimum X and maximum X was obtained successfully. - - - - Is position over series - - X coordinate. - Y coordinate. - Use DIP instead of pixels as parameters - true if position is over series. Else false. - - - - Render chart if item list changed. - - - - - param - sender - M:Arction.Wpf.Charting.SeriesXY.PointLineSeriesBase.ItemListChanged(System.Object,System.ComponentModel.ListChangedEventArgs) - - - - - - - param - e - M:Arction.Wpf.Charting.SeriesXY.PointLineSeriesBase.ItemListChanged(System.Object,System.ComponentModel.ListChangedEventArgs) - - - - - - - Line style - - - - - Is line visible or not - - - - - Lock object for cursor y-value resolver data - - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Point count stored in the Points array - - - - - Points rendering optimization - - - - - Point style - - - - - Are points visible or not - - - - - Series event markers - - - - - Set proper drag cursor. Default is hand. - - - - - Statistics of the series - - - - - Series title - - - - - Use palette for line coloring. - - - - - Color palette for Y value range. - - - - - The delegate to use for handlers that receive the CustomLinePointColoringAndShaping event. - - The object that raised the event. - Provides data for the CustomLinePointColoringAndShaping event. - - - - Polygon series. Points must be in clockwise order. - - - - - Constructor. - - - - - Constructor. - - Parent. - X-axis you want to bind. - Y-axis you want to bind. - - - - Antialias area draw. - - - - - Draw behind series. - - - - - Border style. - - - - - Show border. - - - - - Clear all data. - - - - - Create members. - - - - - Cursor tracking enabled. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Polygon fill. - - - - - Get minimum and maximum X and Y values. - - X minimum. - X maximum. - Y minimum. - Y maximum. - True if point count is greater than 0 - - - - Intersections of polygon lines is allowed. - - - - - Series data has been modified directly by it's array. - Use this method to notify chart that this series needs a refresh - - - - - Is position over item. - - x-coordinate - y-coordinate - Use DIP instead of pixels as parameters - true if position is over item, false otherwise - - - - Loads series data from a CSV file. - - CSV file name. If file does not exist, LoadFromCSV returns false. - Value and floating point number separator. - True if import succeeds. Otherwise false. - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Series points. - - - - - Saves series data into CSV file - - Target file. If file already exists, it will be overwritten. - Value and floating point number separator definition - True if save is successful - - - - Simple highlight color when user interactive device is over. - - - - - Statistics of the line series - - - - - Series title. - - - - - Item to string. - - - - - returns - M:Arction.Wpf.Charting.SeriesXY.PolygonSeries.ToString - - - - - - - Triangulation conversion progress indication. - - - - - Conversion is running. - - - - - Conversion is done. - - - - - Base class for single line series which are progressive by X-value. - - - - - Creates and initializes a new instance of this class. - - - - - Creates and initializes a new instance of this class. - - - - - param - owner - M:Arction.Wpf.Charting.SeriesXY.ProgressiveSingleLineSeriesBase.#ctor(Arction.Wpf.Charting.Views.ViewXY.ViewXY) - - - - - - - Find nearest series point of given X-coordinate and get corresponding Y-coordinate. - - X-coordinate in pixels or DIP. - Use DIP instead of pixels as parameters. - Solve result. - - - - Find nearest series point of given X-value and get corresponding Y-value. - - X-value. - Solve result. - - - - Block sample data series class. Can be only used with Linear axis and DirectX11 engine. - - - - - Constructor. - - - - - Constructor. - - - - - param - owner - M:Arction.Wpf.Charting.SeriesXY.SampleDataBlockSeries.#ctor(Arction.Wpf.Charting.Views.ViewXY.ViewXY,Arction.Wpf.Charting.Axes.AxisX,Arction.Wpf.Charting.Axes.AxisY) - - - - - - - param - axisX - M:Arction.Wpf.Charting.SeriesXY.SampleDataBlockSeries.#ctor(Arction.Wpf.Charting.Views.ViewXY.ViewXY,Arction.Wpf.Charting.Axes.AxisX,Arction.Wpf.Charting.Axes.AxisY) - - - - - - - param - axisY - M:Arction.Wpf.Charting.SeriesXY.SampleDataBlockSeries.#ctor(Arction.Wpf.Charting.Views.ViewXY.ViewXY,Arction.Wpf.Charting.Axes.AxisX,Arction.Wpf.Charting.Axes.AxisY) - - - - - - - Add samples to end of series, float format. - - Samples array. - Update chart after adding samples. Updating will raise CPU load, - which is why usage of this method is not recommended with every call if points are added many times per second. - Series sample count after adding. - - - - Create members. - - - - - Delete samples having smaller X value than given value. - - X value. - Compact memory. - - - - First sample time stamp, usually 1/SamplingFrequency. - - - - - Get minimum and maximum Y value withing given X range. - - Minimum Y value. - Maximum Y value. - X range start. - X range end. - Ignore zeros. - True if values were successfully detected. - - - - This is similar to GetMinMaxFromXRange, but tailored for Series with DataBreaking. - Get minimum and maximum Y value within given X range, but Ignore some values (gap defining value). - - Minimum Y value. - Maximum Y value. - X range start. - X range end. - Gap defining value. - True if values were successfully detected. - - - - Get sample at index. - - Sample index for whole data. - Y-value at index - - - - Get minimum X and maximum X of series X values. - - X minimum. - X maximum. - True if minimum X and maximum X was obtained successfully. - - - - Get point at index. - - Index to data. - Data point at index. - - - - Line rendering limit on y-axis. - - - - - Loads series data from a CSV file. - - CSV file name. If file does not exist, LoadFromCSV returns false. - Value and floating point number separator. - True if import succeeds. Otherwise false. - - - - Occurs when old data samples have been dropped. - - - - - Added sample count. - - - - - Series samples. - - - - - Sampling frequency, in Hz. (sample interval is 1/SamplingFrequency). - - - - - Saves sample data into CSV file. - - Target file. If file already exists, it will be overwritten. - Value and floating point number separator definition - True if save is successful - - - - Detect triggering position from series data. - - Output triggered X position. - Trigger level Y value. - Minimum X value that is investigated. - Maximum X value that is investigated. - Triggering edge. - True if trigger position was detected, otherwise false. - - - - Solve nearest sample to given X and Y value. - - X value. - Y value. - Nearest sample X. - Nearest sample Y. - Nearest sample index in the SampleSingle or SamplesDouble array. - True if successfully solved. - - - - Find nearest series point of given X-coordinate and get corresponding Y-coordinate. - - X-coordinate in pixels or DIP. - Use DIP instead of pixels as parameters. - Solve result. - - - - Solve Y value on given X value. Returned value will be interpolated, if X is between sequential points X values. - - X value. - Solve status. NearestX will be double.NaN if point is not in the data range. - - - - The delegate to use for handlers that receive the OldDataDropped event. - - The object that raised the event. - Provides data for the OldDataDropped event. - - - - Sample data series class. - - - - - Constructor for Form designer list editor. - - - - - Constructor - - Parent. - Y-axis you want to bind. - X-axis you want to bind. - - - - Adds offset to all samples (Increments all samples by given value). - - Offset. - - - - Add samples to end of series, double format. - - Samples array - Update chart after adding. Updating will raise CPU load, - which is why usage of this method is not recommended with every call if points are added many times per second. - Series sample count after adding. - - - - Add samples to end of series, float format. - - Samples array. - Update chart after adding samples. Updating will raise CPU load, - which is why usage of this method is not recommended with every call if points are added many times per second. - Series sample count after adding. - - - - Initial size - - - - - Clear all samples. - - - - - Create members. - - - - - Cursor tracking enabled. - - - - - Delete samples having smaller X value than given value. - - X value. - Compact memory. - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - First sample time stamp, usually 1/SamplingFrequency - - - - - Get minimum and maximum Y value withing given X range. - - Minimum Y value. - Maximum Y value. - X range start. - X range end. - Ignore zeros. - True if values were successfully detected. - - - - This is similar to GetMinMaxFromXRange, but tailored for Series with DataBreaking. - Get minimum and maximum Y value within given X range, but Ignore some values (gap defining value). - - Minimum Y value. - Maximum Y value. - X range start. - X range end. - Gap defining value. - True if values were successfully detected. - - - - Get minimum X and maximum X of series X values. - - X minimum. - X maximum. - True if minimum X and maximum X was obtained successfully. - - - - Loads series data from a CSV file. - - CSV file name. If file does not exist, LoadFromCSV returns false. - Value and floating point number separator. - True if import succeeds. Otherwise false. - - - - Multiplies the samples in the samples array with given factor. - - Factor. - - - - Occurs when old data samples have been dropped. - - - - - Sample format - - - - - Series samples, Double format - - Thrown when trying to set samples that are not - compatible with chosen SampleFormat. - - - - Series samples, Single format - - Thrown when trying to set samples that are not - compatible with chosen SampleFormat. - - - - Sampling frequency, in Hz. (sample interval is 1/SamplingFrequency) - - - - - Saves sample data into CSV file. - - Target file. If file already exists, it will be overwritten. - Value and floating point number separator definition - True if save is successful - - - - Stabilize scrolling mode by rounding shifting to nearest integer pixel position. - Reduces wobbling of the scrolling waveform, but may show as slight X-dimensional distortion. - Only applies when XAxis ScrollMode = Scrolling - - - - Tells how often the draw data is cleared when using X axis scroll mode. - Valid range is 1...100 - 1 frees the draw data and the reconstructs the draw data after every 1/10 scroll page. - Use this when there's not much memory available. - 100 frees the draw data and the reconstructs the draw data after every 100/10 = 10 pages. - Use this when smooth scroll with high FPS is important. Reserves some extra memory. - - - - - Detect triggering position from series data. - - Output triggered X position. - Trigger level Y value. - Minimum X value that is investigated. - Maximum X value that is investigated. - Triggering edge. - True if trigger position was detected, otherwise false. - - - - Seek visible range first series point index (actually one point before that) - - Start x value - Start point index. If unable to find start point, returns -1 - - - - Solve nearest sample to given X and Y screen coordinate. - - X screen coordinate. - Y screen coordinate. - Nearest sample X. - Nearest sample Y. - Nearest sample index in the SampleSingle or SamplesDouble array. - True if successfully solved. - - - - Solve nearest sample to given X and Y value. - - X value. - Y value. - Nearest sample X. - Nearest sample Y. - Nearest sample index in the SampleSingle or SamplesDouble array. - True if successfully solved. - - - - Solve Y value on given X value. Returned value will be interpolated, if X is between sequential points X values. - - X value. - Solve status. NearestX will be double.NaN if point is not in the data range. - - - - The delegate to use for handlers that receive the OldDataDropped event. - - The object that raised the event. - Provides data for the OldDataDropped event. - - - - Base class for all series - - - - - Constructor - - - - - Constructor - - - - - param - owner - M:Arction.Wpf.Charting.SeriesXY.SeriesBaseXY.#ctor(Arction.Wpf.Charting.IChartNode) - - - - - - - Allow series reacting to user interaction device movement. Device hit testing with objects - cause CPU overhead when the device is moved. - If user interaction is not absolute necessary directly within chart - and if you want to maximize the performance, set this false. - - - - - List of assignable X axes - - - - - List of assignable Y axes - - - - - Index of X axis assigned to this series. Give -1 when you don't want to assign it yet to any X axis. - - - - - Index of Y axis assigned to this series. Give -1 when you don't want to assign it yet to any Y axis. - - - - - Occurs just before the rendering of the series takes place. - - - - - Clear the series - - - - - Create members. - - - - - Disable dragging from Y axis to another Y axis or from chart to another chart. - Set this true if you want to zoom in the series area, and keep other user interactive device interactivity features available. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Get clipping areas. - - Array reference to ClipAreas. If you modify the array, notify the chart with SetClipAreas method. - - - - Include series values in automatic fit. - - - - - Series data has been modified directly by it's array. - Use this method to notify chart that this series needs a refresh - - - - - Is mouse over item. - - mouse x-coordinate - mouse y-coordinate - Use DIP instead of pixels as parameters - false if mouse is not inside graph, true otherwise - - - - Legendbox index. - - - - - Limit Y draw range to segment area when y-axes are stacked. - - - - - Loads series data from a CSV file. - - Full path to the CSV file. - Value separator that is used in the CSV file. - - - - returns - M:Arction.Wpf.Charting.SeriesXY.SeriesBaseXY.LoadFromCSV(System.String,Arction.Wpf.Charting.SeparatorCSV) - - - - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Get item as LegendBoxMouseObject. - - related object - - - - returns - M:Arction.Wpf.Charting.SeriesXY.SeriesBaseXY.op_Implicit(Arction.Wpf.Charting.SeriesXY.SeriesBaseXY)~Arction.Wpf.Charting.Views.LegendBoxObject - - - - - - - Owner view. - - - - - Saves series data into CSV file - - Target file. If file already exists, it will be overwritten. - Value and floating point number separator definition - True if export is successful - - - - Set clipping areas. Give null to disable all clip areas. - - - - - param - clipAreas - M:Arction.Wpf.Charting.SeriesXY.SeriesBaseXY.SetClipAreas(Arction.Wpf.Charting.ClipArea[]) - - - - - - - Enlists the series title text in Legend box of the chart - - - - - Item to string. - - - - - returns - M:Arction.Wpf.Charting.SeriesXY.SeriesBaseXY.ToString - - - - - - - Is the series visible - - - - - The delegate to use for handlers that receive the BeforeSeriesRendering event. - - The object that raised the event. - Provides data for the BeforeSeriesRendering event. - - - - CandleStick series - - - - - Constructor - - - - - Constructor - - Parent. - Y axis you want to bind - X axis you want to bind - - - - Add points to end of series - - Series points - Update chart after adding. Updating will raise CPU load, - so you maybe don't want to use this with every call if points are added many times per second. - Point count after adding - - - - StockSeries is drawn behind line series. - - - - - Points initial size - - - - - Clear all points - - - - - Stick color when series Close value less than Open. - - - - - Stick color when series Close value greater than Open. - - - - - Create members. - - - - - Cursor tracking enabled. - - - - - Stock data appearance coloring delegate. - - - - - Series data count. - - - - - Series data points - - - - - Delete Points having smaller X value than given value. - - X value. - x axis what to check - Compact memory. - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Fill border. - - - - - Fill when series Close value less than Open. - - - - - Fill when series Close value greater than Open. - - - - - Get item which the user interactive device is over. - - Item on user interactive device location - True if info found, false otherwise. - - - - Get min and max Y value withing given X range - - Minimum Y value - Maximum Y value - X range start - X range end - Ignore zeros - True if values were successfully detected - - - - Get minimum X and maximum X of series X values - - X min - X max - True if minimum X and maximum X was obtained successfully - - - - Is position over series. - - Y coordinate - X coordinate - Use DIP instead of pixels as parameters - true if is over series. Else false. - - - - Item width. - - - - - Loads series data from a CSV file. - - CSV file. If file does not exist, LoadFromCSV returns false. - Value and floating point number separator. - True if import succeeds. Otherwise false. - - - - Name of series. - - - - - Occurs when old data points have been dropped. - - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Packing state. If packing is On, several data values will be packed to a single rendered item. - - - - - Saves series data into CSV file - - Target file. If file already exists, it will be overwritten. - Value and floating point number separator definition - True if save is successful - - - - Tells how often the draw data is cleared when using X-axis scroll mode. - Valid range is 1...100 - 1 frees the draw data and the reconstructs the draw data after every 1/10 scroll page. - Use this when there's not much memory available. - 100 frees the draw data and the reconstructs the draw data after every 100/10 = 10 pages. - Use this when smooth scroll with high FPS is important. Reserves some extra memory. - - - - - Series event markers - - - - - Statistics of the series. - - - - - Stick width. - - - - - Stock style. - - - - - Series title - - - - - The delegate to use for handlers that receive the CustomStockDataAppearance event. - - - Provides data for the CustomStockDataAppearance event. - - - - The delegate to use for handlers that receive the OldDataDropped event. - - The object that raised the event. - Provides data for the OldDataDropped event. - - - - Represents a class that provides arguments for the ValueChanged event. - - - - - Creates and initializes a new instance of ConstantLineValueChangedEventArgs class. - - - - - If you update the chart in the event handler, set to true to prevent flickering. - - - - - The ConstantLine object whose value was changed. - - - - - New value. - - - - - Represents a class that provides arguments for the ValuesChanged event. - - - - - Creates and initializes a new instance of BandValuesChangedEventArgs class. - - - - - Sender. - - - - - Set 'true' to prevent flickering if you update the chart in the event handler. - - - - - New begin value. - - - - - New end value. - - - - - Axis title. Shows title text for axis. - - - - - Constructor, for serialization purposes. - - - - - Constructor. - - Parent. - - - - Alignment value. - - - - - Title distance from axis line. Value is ignored, if AxisTitleAutoPlacement is enabled. - - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Item to string. - - Item as a string. - - - - 3D axis title. Shows title text for axis. - - - - - Constructor, for serialization purposes. - - - - - Constuctor. - - Parent. - - - - Vertical alignment - - - - - Moving of title not supported in 3D view. - - - - - Allow title to be upside down. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Title distance from axis line, in 3D world space - - - - - Is position over item. - - x-coordinate - y-coordinate - Use DIP instead of pixels as parameters - true if position is over item, false otherwise - - - - Item to string. - - - - - returns - M:Arction.Wpf.Charting.Titles.AxisTitle3D.ToString - - - - - - - X-axis title. Shows title text for X-axis. - - - - - Constructor, for serialization purposes. - - - - - Constructor. - - Parent. - - - - Horizontal alignment - - - - - Vertical alignment. Value is ignored, if XAxisTitleAutoPlacement is enabled. - - - - - Y-axis title. Shows title text for Y-axis. - - - - - Constructor, for serialization purposes. - - - - - Constructor. - - Parent. - - - - Horizontal alignment. Value is ignored, if YAxisTitleAutoPlacement is enabled. - - - - - Vertical alignment - - - - - Bar series bars title style - - - - - Constructor, for serialization purposes - - - - - Constructor - - - - - param - owner - M:Arction.Wpf.Charting.Titles.BarLabelsStyle.#ctor(Arction.Wpf.Charting.IChartNode) - - - - - - - Create font. - - - - - Create shadow. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Label distance from bar edge - - - - - Horizontal alignment - - - - - Label shift from it's align origin - - - - - Set true if you want to draw text outside the bar / graph segment - - - - - Title text - - - - - Vertical alignment - - - - - Bordered, filled title. Used for creating titles with borders and fill. - - - - - Constructor. - - - - - Constructor. - - Parent. - - - - Border around the object - - - - - Create border. - - - - - Create fill. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Fill - - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Item center position when dragging starts. - - - - - Chart title. Shows title text for the chart. - - - - - Constructor, for serialization purposes. - - - - - Constructor. - - Parent. - - - - Vertical alignment - - - - - Create font. - - - - - Create shadow. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Title shift from it's align origin - - - - - Convert class description to string. - - Class description as a string. - - - - Event marker title. Shows text near an event marker. - - - - - Constructor, for serialization purposes. - - - - - Constructor. - - Parent. - - - - Constructor. - - Parent. - Text. - Horizontal alignment. - Vertical alignment. - Font. - Color. - RotateAngle in degrees. - Distance from symbol. - Shadow. - - - - Create shadow. - - - - - Text distance from symbol - - - - - Horizontal alignment - - - - - Vertical alignment - - - - - LegendBox item title. - - - - - Constructor. - - - - - Constructor. - - Parent. - - - - Color - - - - - Create members. - - - - - Create font. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Title font - - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Title text - - - - - Mini scale title. Shows text near mini scale axes. - - - - - Constructor, for serialization purposes - - - - - Constructor - - - - - param - owner - M:Arction.Wpf.Charting.Titles.MiniScaleTitle.#ctor(Arction.Wpf.Charting.IChartNode) - - - - - - - Alignment - - - - - Create shadow. - - - - - Label distance from dimension line - - - - - Overlay elements title style - - - - - Constructor, for serialization purposes - - - - - Constructor - - - - - param - owner - M:Arction.Wpf.Charting.Titles.OverlayElementTextStyle.#ctor(Arction.Wpf.Charting.IChartNode) - - - - - - - Create font. - - - - - Create shadow. - - - - - Is the text clipped on element edges - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Text distance from element edge, if aligned to edge - - - - - Horizontal alignment - - - - - Text shift from it's align origin - - - - - Vertical alignment - - - - - Polar sector title. - - - - - Constructor, for serialization purposes. - - - - - Constructor. - - Parent. - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Offset - - - - - Radial offset of title as percentage. 0 = axis begin, 100 = axis end. - - - - - Polygon series title class. - - - - - Constructor, for serialization purposes - - - - - Constructor - - - - - param - owner - M:Arction.Wpf.Charting.Titles.PolygonSeriesTitle.#ctor(Arction.Wpf.Charting.IChartNode) - - - - - - - Place title automatically on chart near the series data. - - - - - Create font. - - - - - Create shadow. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Horizontal alignment within X axis - - - - - If set, limits text inside graph margins area - - - - - Lock title position to current X and Y data values. Prevent automatic title placement routine from relocating the title. - - - - - Title offset of its aligned position - - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Vertical alignment within Y axis - - - - - Round axes title. Shows title text for axis. - - - - - Constructor, for serialization purposes. - - - - - Constructor. - - Parent. - - - - Title distance from axis line - - - - - Is position over item. - - x-coordinate - y-coordinate - Use DIP instead of pixels as parameters. - True if position is over item, false otherwise. - - - - Radial offset of title as percentage. 0 = axis begin, 100 = axis end. - this affects first, then RadialOffsetPixels. - - - - - Radial offset of title as pixels. 0 = axis begin, 100 = axis end. - RadialOffsetPercentage affects first, then this. - - - - - Item to string. - - - - - returns - M:Arction.Wpf.Charting.Titles.RoundAxisTitle.ToString - - - - - - - Vertical alignment - - - - - Round series title. - - - - - Constructor, for serialization purposes - - - - - Constructor. - - Parent. - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Offset - - - - - Series title class. It's a base class for most of series titles - - - - - Constructor, for serialization purposes - - - - - Constructor - - - - - param - owner - M:Arction.Wpf.Charting.Titles.SeriesTitle.#ctor(Arction.Wpf.Charting.IChartNode) - - - - - - - Place title automatically on chart near the series data. - - - - - Create shadow. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Horizontal alignment within X axis - - - - - If set, limits text inside graph margins area - - - - - Lock title position to current X and Y data values. Prevent automatic title placement routine from relocating the title. - - - - - Title offset of its aligned position - - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Set item drag end position - - - - - param - x - M:Arction.Wpf.Charting.Titles.SeriesTitle.SetItemDragPosition(System.Int32,System.Int32,System.Boolean) - - - - - - - param - y - M:Arction.Wpf.Charting.Titles.SeriesTitle.SetItemDragPosition(System.Int32,System.Int32,System.Boolean) - - - - - - - param - FinalPosition - M:Arction.Wpf.Charting.Titles.SeriesTitle.SetItemDragPosition(System.Int32,System.Int32,System.Boolean) - - - - - - - Item to string. - - - - - returns - M:Arction.Wpf.Charting.Titles.SeriesTitle.ToString - - - - - - - Vertical alignment within Y axis - - - - - Series3D title base class. - - - - - Constructor, for serialization purposes - - - - - Constructor - - - - - param - owner - M:Arction.Wpf.Charting.Titles.SeriesTitle3D.#ctor(Arction.Wpf.Charting.IChartNode) - - - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Offset as world values. - - - - - Series3DBar title. - - - - - Constructor, for serialization purposes. - - - - - Constructor. - - Parent. - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Offset as world values. - - - - - Series3D title base class. It's a base class for all 3D-series titles - - - - - Constructor. - - - - - Constructor - - - - - param - owner - M:Arction.Wpf.Charting.Titles.SeriesTitle3DBase.#ctor(Arction.Wpf.Charting.IChartNode) - - - - - - - Allow user to move title. - - - - - Base class for titles. - - - - - Constructor, for serialization purposes. - - - - - Constructor. - - Parent. - - - - Text rotation angle, in degrees. The rotation is applied around text center point. - - - - - Color - - - - - Create font. - - - - - Create shadow. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Title draw rectangle (read only). Note, accurate only for Angle=0. Otherwise, reliable only Width, Height and central point. - - - - - Title font - - - - - Is position over item. - - x-coordinate - y-coordinate - Use DIP instead of pixels as parameters - true if position is over item, false otherwise - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Item center position when dragging starts. - - - - - Shadow below the text - - - - - Title text. - - - - - Is title visible or not - - - - - 3DBar value title. - - - - - Constructor, for serialization purposes. - - - - - Constructor. - - Parent. - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Title text. Not applicable with value title! - - - - - Offset as world values. - - - - - General type converter. - - - - - - - Arction.Wpf.Charting.TypeConverters.GeneralTypeConverter - - - - - - - Determines if conversion is possible. - If special byte[] serialization is enabled, this reports it possible to convert byte[] to LC types. - Context. - Source type. - True, if conversion can be done. - - - - Determines if conversions to requested type can happen. - If special byte[] serialization is enabled, this reports it possible to convert LC types to byte[]. - Context. - Destination type. - True, if conversion can be done. - - - - Converts given object to the type of this converter. - - Context. - Culture. - Value. - Deserialized object, if it was successful. - - - - Converts object to the requested type. - Conversion to byte[] is handled by TreeBinarySerializer by calling ConvertToBytes. - Context. - Culture. - Value. - Destination type. - Object converted to the requested type, if supported. - - - - Returns a collection of properties for the type of array specified by the value parameter, - using the specified context and attributes. - - Attributes. - Value. - Context. - Property descriptors. - - - - Returns whether this object supports properties, using the specified context. - - Context. - Are properties supported. - - - - Represents a class that provides arguments for the CheckBoxStateChanged event. - - - - - Creates and initializes a new instance of CheckBoxStateChangedEventArgs class. - - - - - Is the check box checked. - - - - - The series whose check box state was changed. - - - - - LegendBox shows the series names and line/point styles in a box. - - - - - Constructor. - - Parent. - - - - Allow resize by user interactive device. - - - - - Automatic sizing based on contents. - - - - - Border color. - - - - - Border width. - - - - - Checkbox color. - - - - - LegendBox checkbox size in DPI. - - - - - Occurs when the state of a series title check box has changed. - - - - - Checkbox mark color. - - - - - Create offset. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Fill. - - - - - Get rendered rectangle. - - Rendered rectangle. - - - - Height. Applies when AutoSize is not used. - - - - - Highlight series, if user interactive device is over it or title on legend box. - - - - - Highlighted series title color on legend box. - - - - - Is mouse over item. - - Mouse X-coordinate. Units depend on useDIP parameter value. - Mouse Y-coordinate. - Use DIP instead of pixels as parameters. - True if mouse is over item, false otherwise. - - - - LegendBox layout. - - - - - Check if LegendBox series title highlight state can be updated. Used in user interactive device event. - - - - - returns - M:Arction.Wpf.Charting.Views.LegendBoxBase.LegendBoxTitleStateUpdateEnabled - - - - - - - Allow LegendBox moving from series title, which prevents sending messages from the series title clicks. - - - - - Offset from location calculated by Position property. - - - - - LegendBox scroll bar visibility setting. - - - - - Series title color. - - - - - Series title font. - - - - - Series title mouse click event handler. - - - - - Occurs when a user interactive device button is clicked on a series title. - - - - - Series title mouse double click event handler. - - - - - Occurs when a mouse button is double-clicked on a series title. - - - - - Series title mouse down event handler. - - - - - Occurs when a user interactive device is pressed down on a series title. - - - - - Series title mouse up event handler. - - - - - Occurs when a user interactive device button is released over a series title. - - - - - Set item drag end position - - - - - param - x - M:Arction.Wpf.Charting.Views.LegendBoxBase.SetItemDragPosition(System.Int32,System.Int32,System.Boolean) - - - - - - - param - y - M:Arction.Wpf.Charting.Views.LegendBoxBase.SetItemDragPosition(System.Int32,System.Int32,System.Boolean) - - - - - - - param - FinalPosition - M:Arction.Wpf.Charting.Views.LegendBoxBase.SetItemDragPosition(System.Int32,System.Int32,System.Boolean) - - - - - - - Item draw position when dragging starts. - - - - - Set cursor. - - - - - Shadow beneath the LegendBox. - - - - - Show checkboxes for selecting visibility of series. - - - - - Show icons. - - - - - Convert class description to string. - - Class description as a string. - - - - Units text color. - - - - - Units text font. - - - - - Use series title color. If false, uses Items color. - - - - - Series value label color. - - - - - Series value text font. - - - - - Width. Applies when AutoSize is not used. - - - - - Is LegendBox visible. - - - - - The delegate to use for handlers that receive the CheckBoxStateChanged event. - - The object that raised the event. - Provides data for the CheckBoxStateChanged event. - - - - Scroll Bar visibility. - - - - - No scroll bars. - - - - - Horizontal bar. - - - - - Vertical bar. - - - - - Both scroll bars. - - - - - The delegate to use for handlers that receive the SeriesTitleMouseAction event. - - The object that raised the event. - Provides data for the SeriesTitleMouseAction event. - - - - LegendBox object. Actually checkbox and title region area container to handle user interactive device events. - - - - - Dispose - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - LegendBox shows the series names and drawing styles in a box. - - - - - Simple constructor for Form designer's list editor. - - - - - Constructor. - - - - - param - legendBox - M:Arction.Wpf.Charting.Views.LegendBoxSurfaces.#ctor(Arction.Wpf.Charting.Views.LegendBoxBase) - - - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Scale border color. - - - - - Scale border width. - - - - - Scale size in pixels, primary dimension - - - - - Scale size in pixels, secondary dimension - - - - - Scale grid size in pixels. - - - - - Scale title position. - - - - - Convert class description to string. - - Class description as a string. - - - - Show/hide scale. - - - - - Represents a class that provides arguments for the Margins changed event for views. - - - - - Creates and initializes a new instance of MarginsChangedEventArgs class. - - - - - Bottom margin new value. - - - - - Left margin new value. - - - - - Right margin new value. - - - - - Top margin new value. - - - - - Bottom margin old value. - - - - - Left margin old value. - - - - - Right margin old value. - - - - - Top margin old value. - - - - - View rendering options. - - - - - Simple constructor for Form designer's list editor. - - - - - Constructor. - - - - - param - chart - M:Arction.Wpf.Charting.Views.RenderOptionsCommon.#ctor(Arction.Wpf.Charting.IChartNode) - - - - - - - Anti-aliasing factor. 0 and 1 = No anti-aliasing. - The larger the value, the smoother the image will be, but at steep cost of performance on some display adapters. - Only objects having will be anti-aliased. - - Note that with DX11 thicker (triangle) lines cannot be rendered without - anti-aliasing unless this property's value is set to be lower than 1. - - - - - Determines if the D2D system is used or not. Text rendering does not work on DX11 without D2D. This is intended only as Debug measure at this time, and the property will be removed later. - - - - - Rendering device type to use, or selection logic for the engine to be used. - Note that reading this value does not provide information of the current device, just the requested one. More information on remarks. - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Fonts rendering quality. - - - - - Force device create on control resize. Some virtual machine environment require this to be set to true. - - - - - Maximum frames to present in second. - - - - - Gets or sets GPU preference setting. This is a dependency property. - - - - - Defines if the LightningChart expects to have a graphical interface or not. - This allows the LC to be used in the background, without connections to interface. - - This has effect on multiple different things. For instance device type selection will cause - the engine to change instantly on selection, not when LC is connected to visual tree. - - - - - Use thread safe updates to force the control draw itself though Invoke. - Enabling this may cause slower updates, and should not be used in applications running without auxiliary threads updating the chart data or properties. - Alternatively, you can use Invoke method of your parent form or control. - You should always update the chart data from by Invoking in application side. - - - - - Anti-aliasing type of single pixel width anti-aliased lines. Applicable only on DX11 and when - AntiAliasLevel is above 1. - Lines thicker than 1 pixel are rendered using triangles, and use triangle drawing AA system. - ALAA option produces generally best looking line and is faster than QLAA. There is some problems with ALAA - with Warp though. - - Note that on DX11, the usage of alpha-line anti-aliasing can be also controlled through - - - - - Anti-aliasing type of single pixel width anti-aliased lines. Applicable only on DX11 and when - AntiAliasLevel is above 1. - Lines thicker than 1 pixel are rendered using triangles, and use triangle drawing AA system. - ALAA option produces generally best looking line and is faster than QLAA. There is some problems with ALAA - with Warp though. - - Note that on DX11, the usage of quadrilateral-line anti-aliasing can be also controlled through - - - - - Debug Line offset of the DX11 line drawing. - LightningChart internally uses coordinate system where the coordinate - points to the center of the pixel. Meaning that screen coordinate (0,0) - is at the center of the top-left pixel. In DX9 this is the same. In DX11 - the point (0,0) is at the top-left corner of the top-left pixel, and the - center of the pixel is at point (0.5, 0.5). - The points are moved by this offset in DX11 engine, so that the chart can - use the same coordinate system with all engines. The default value of - (0.5, 0.5) is the "correct" one, but it can be modified by this property. - - - - - RemoteDeskTop graphics card ID. - - - - - Convert class description to string. - - Class description as a string. - - - - Update chart always when resizing control. - - - - - Update chart after this interval (ms) after resizing ends, if UpdateAlwaysOnResize is false. - - - - - Defines how / when chart is updated and new frames are rendered. - - - - - - Wait for next refresh, V-Sync. - If the computer is fast enough, disabling this can give higher refresh rate than the screen refresh rate is. - By disabling this, rendering does not wait next screen refresh turn. - - - - - Rendering options for ViewXY. - - - - - Represents a class that provides arguments for the SeriesTitleMouseAction event. - - - - - Creates and initializes a new instance of SeriesTitleMouseActionEventArgs class. - - - - - The series that was manipulated with a user. - - - - - General stucture for UserEventArguments. - - - - - Border rendered around graph area - - - - - Constructor for Form editor/xaml. - - - - - Constructor - - View owner - - - - param - Visible - M:Arction.Wpf.Charting.Views.ThinBorder.#ctor(Arction.Wpf.Charting.IChartNode,System.Boolean) - - - - - - - Color Of Border - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Override ToString - - - - - returns - M:Arction.Wpf.Charting.Views.ThinBorder.ToString - - - - - - - Boolean for showing border - - - - - XY graph view. Allows super-fast drawing of lines and bars. - - - - - Constructor. - - - - - Constructor. - - - - - param - owner - M:Arction.Wpf.Charting.Views.View2D.#ctor(Arction.Wpf.Charting.LightningChart) - - - - - - - Create zoom pan options - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Free Zoom data - - - - - Gets a rectangle defining the area inside margins in DIPs. - - - - - param - useDIP - M:Arction.Wpf.Charting.Views.View2D.GetMarginsRect(System.Boolean) - - - - Surrounding rectangle. - - - - Graph background fill - - - - - Graph background filling - - - - - param - value - M:Arction.Wpf.Charting.Views.View2D.SetGraphBackground(Arction.Wpf.Charting.Fill) - - - - - - - Object types. - - - - - Type of Axis. - - - - - Type of Series. - - - - - Type of LegendBox. - - - - - Type of Sectors. - - - - - View base class. - - - - - Protected constructor. - - - - - Constructor. - - - - - param - owner - M:Arction.Wpf.Charting.Views.ViewBase.#ctor(Arction.Wpf.Charting.LightningChart) - - - - - - - Handler of margin / size based items. Should be called after either size or margins changes. - Should update all values that depend on those. - - - - - Paddings - - - - - user interactive device button has been clicked. - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.ViewBase.DeviceButtonClicked(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - param - eventType - M:Arction.Wpf.Charting.Views.ViewBase.DeviceButtonClicked(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - param - chart - M:Arction.Wpf.Charting.Views.ViewBase.DeviceButtonClicked(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - returns - M:Arction.Wpf.Charting.Views.ViewBase.DeviceButtonClicked(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - User interactive device button has been double clicked. - For double click the behaviour is almost similar to single click, only raised event differs. - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.ViewBase.DeviceButtonDoubleClicked(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - param - eventType - M:Arction.Wpf.Charting.Views.ViewBase.DeviceButtonDoubleClicked(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - param - chart - M:Arction.Wpf.Charting.Views.ViewBase.DeviceButtonDoubleClicked(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - returns - M:Arction.Wpf.Charting.Views.ViewBase.DeviceButtonDoubleClicked(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - User interactive device button has been pressed down. - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.ViewBase.DeviceButtonDown(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - param - eventType - M:Arction.Wpf.Charting.Views.ViewBase.DeviceButtonDown(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - param - chart - M:Arction.Wpf.Charting.Views.ViewBase.DeviceButtonDown(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - returns - M:Arction.Wpf.Charting.Views.ViewBase.DeviceButtonDown(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - User interactive device button has been released. - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.ViewBase.DeviceButtonUp(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - param - eventType - M:Arction.Wpf.Charting.Views.ViewBase.DeviceButtonUp(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - param - chart - M:Arction.Wpf.Charting.Views.ViewBase.DeviceButtonUp(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - returns - M:Arction.Wpf.Charting.Views.ViewBase.DeviceButtonUp(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Getter of the ZoomPadding, supported by Round and 3D Views - ZoomPanOptions. - - ZoomPadding of the given view, if supported. - - - - Occurs when a user interactive device button is clicked over the legend box scroll bars - - - - - param - legendBox - M:Arction.Wpf.Charting.Views.ViewBase.HandleDeviceButtonClickedOnLegendBoxScrollBars(Arction.Wpf.Charting.Views.LegendBoxBase,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean) - - - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.ViewBase.HandleDeviceButtonClickedOnLegendBoxScrollBars(Arction.Wpf.Charting.Views.LegendBoxBase,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean) - - - - - - - param - eventType - M:Arction.Wpf.Charting.Views.ViewBase.HandleDeviceButtonClickedOnLegendBoxScrollBars(Arction.Wpf.Charting.Views.LegendBoxBase,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean) - - - - - - - param - bIsOutsideGraphArea - M:Arction.Wpf.Charting.Views.ViewBase.HandleDeviceButtonClickedOnLegendBoxScrollBars(Arction.Wpf.Charting.Views.LegendBoxBase,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean) - - - - - - - returns - M:Arction.Wpf.Charting.Views.ViewBase.HandleDeviceButtonClickedOnLegendBoxScrollBars(Arction.Wpf.Charting.Views.LegendBoxBase,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean) - - - - - - - Handle user interactive device button down. - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.ViewBase.HandleDeviceButtonDownAction(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,Arction.Wpf.Charting.UserInteractiveObject) - - - - - - - param - bIsOutsideGraphArea - M:Arction.Wpf.Charting.Views.ViewBase.HandleDeviceButtonDownAction(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,Arction.Wpf.Charting.UserInteractiveObject) - - - - - - - param - item - M:Arction.Wpf.Charting.Views.ViewBase.HandleDeviceButtonDownAction(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,Arction.Wpf.Charting.UserInteractiveObject) - - - - - - - returns - M:Arction.Wpf.Charting.Views.ViewBase.HandleDeviceButtonDownAction(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,Arction.Wpf.Charting.UserInteractiveObject) - - - - - - - Occurs when a user interactive device button is down on the legend box scroll bars - - - - - param - legendBox - M:Arction.Wpf.Charting.Views.ViewBase.HandleDeviceButtonDownOnLegendBoxScrollBars(Arction.Wpf.Charting.Views.LegendBoxBase,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean) - - - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.ViewBase.HandleDeviceButtonDownOnLegendBoxScrollBars(Arction.Wpf.Charting.Views.LegendBoxBase,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean) - - - - - - - param - eventType - M:Arction.Wpf.Charting.Views.ViewBase.HandleDeviceButtonDownOnLegendBoxScrollBars(Arction.Wpf.Charting.Views.LegendBoxBase,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean) - - - - - - - param - bIsOutsideGraphArea - M:Arction.Wpf.Charting.Views.ViewBase.HandleDeviceButtonDownOnLegendBoxScrollBars(Arction.Wpf.Charting.Views.LegendBoxBase,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean) - - - - - - - returns - M:Arction.Wpf.Charting.Views.ViewBase.HandleDeviceButtonDownOnLegendBoxScrollBars(Arction.Wpf.Charting.Views.LegendBoxBase,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean) - - - - - - - Handle user interactive device button up event. - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.ViewBase.HandleDeviceButtonUpAction(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,Arction.Wpf.Charting.UserInteractiveObject) - - - - - - - param - eventType - M:Arction.Wpf.Charting.Views.ViewBase.HandleDeviceButtonUpAction(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,Arction.Wpf.Charting.UserInteractiveObject) - - - - - - - param - bIsOutsideGraphArea - M:Arction.Wpf.Charting.Views.ViewBase.HandleDeviceButtonUpAction(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,Arction.Wpf.Charting.UserInteractiveObject) - - - - - - - param - interactedObjectFirst - M:Arction.Wpf.Charting.Views.ViewBase.HandleDeviceButtonUpAction(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,Arction.Wpf.Charting.UserInteractiveObject) - - - - - - - param - bExit - M:Arction.Wpf.Charting.Views.ViewBase.HandleDeviceButtonUpAction(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,Arction.Wpf.Charting.UserInteractiveObject) - - - - - - - param - item - M:Arction.Wpf.Charting.Views.ViewBase.HandleDeviceButtonUpAction(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,Arction.Wpf.Charting.UserInteractiveObject) - - - - - - - Occurs when a user interactive device button is up over the legend box scroll bars. - - - - - param - legendBox - M:Arction.Wpf.Charting.Views.ViewBase.HandleDeviceButtonUpOnLegendBoxScrollBars(Arction.Wpf.Charting.Views.LegendBoxBase,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@) - - - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.ViewBase.HandleDeviceButtonUpOnLegendBoxScrollBars(Arction.Wpf.Charting.Views.LegendBoxBase,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@) - - - - - - - param - eventType - M:Arction.Wpf.Charting.Views.ViewBase.HandleDeviceButtonUpOnLegendBoxScrollBars(Arction.Wpf.Charting.Views.LegendBoxBase,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@) - - - - - - - param - bIsOutsideGraphArea - M:Arction.Wpf.Charting.Views.ViewBase.HandleDeviceButtonUpOnLegendBoxScrollBars(Arction.Wpf.Charting.Views.LegendBoxBase,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@) - - - - - - - param - mousedObjectFirst - M:Arction.Wpf.Charting.Views.ViewBase.HandleDeviceButtonUpOnLegendBoxScrollBars(Arction.Wpf.Charting.Views.LegendBoxBase,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@) - - - - - - - param - exit - M:Arction.Wpf.Charting.Views.ViewBase.HandleDeviceButtonUpOnLegendBoxScrollBars(Arction.Wpf.Charting.Views.LegendBoxBase,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@) - - - - - - - Handle user interactive device move. - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.ViewBase.HandleDeviceMoveAction(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,Arction.Wpf.Charting.UserInteractiveObject) - - - - - - - param - bIsOutsideGraphArea - M:Arction.Wpf.Charting.Views.ViewBase.HandleDeviceMoveAction(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,Arction.Wpf.Charting.UserInteractiveObject) - - - - - - - param - item - M:Arction.Wpf.Charting.Views.ViewBase.HandleDeviceMoveAction(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,Arction.Wpf.Charting.UserInteractiveObject) - - - - - - - returns - M:Arction.Wpf.Charting.Views.ViewBase.HandleDeviceMoveAction(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,Arction.Wpf.Charting.UserInteractiveObject) - - - - - - - Occurs when a user interactive device is moved over the legend box scroll bars - - - - - param - legendBox - M:Arction.Wpf.Charting.Views.ViewBase.HandleDeviceMoveOnLegendBoxScrollBars(Arction.Wpf.Charting.Views.LegendBoxBase,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean) - - - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.ViewBase.HandleDeviceMoveOnLegendBoxScrollBars(Arction.Wpf.Charting.Views.LegendBoxBase,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean) - - - - - - - param - bIsOutsideGraphArea - M:Arction.Wpf.Charting.Views.ViewBase.HandleDeviceMoveOnLegendBoxScrollBars(Arction.Wpf.Charting.Views.LegendBoxBase,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean) - - - - - - - returns - M:Arction.Wpf.Charting.Views.ViewBase.HandleDeviceMoveOnLegendBoxScrollBars(Arction.Wpf.Charting.Views.LegendBoxBase,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean) - - - - - - - Handle ScrollBar user interactive device button clicked event. - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.ViewBase.HandleHorizontalScrollBarsDeviceButtonClicked(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean) - - - - - - - param - eventType - M:Arction.Wpf.Charting.Views.ViewBase.HandleHorizontalScrollBarsDeviceButtonClicked(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean) - - - - - - - param - bIsOutsideGraphArea - M:Arction.Wpf.Charting.Views.ViewBase.HandleHorizontalScrollBarsDeviceButtonClicked(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean) - - - - - - - returns - M:Arction.Wpf.Charting.Views.ViewBase.HandleHorizontalScrollBarsDeviceButtonClicked(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean) - - - - - - - Handle ScrollBar user interactive device button down event. - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.ViewBase.HandleHorizontalScrollBarsDeviceButtonDown(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean) - - - - - - - param - eventType - M:Arction.Wpf.Charting.Views.ViewBase.HandleHorizontalScrollBarsDeviceButtonDown(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean) - - - - - - - param - bIsOutsideGraphArea - M:Arction.Wpf.Charting.Views.ViewBase.HandleHorizontalScrollBarsDeviceButtonDown(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean) - - - - - - - returns - M:Arction.Wpf.Charting.Views.ViewBase.HandleHorizontalScrollBarsDeviceButtonDown(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean) - - - - - - - Handle horizontal scroll bars interactive device button up event. - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.ViewBase.HandleHorizontalScrollBarsDeviceButtonUp(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@) - - - - - - - param - eventType - M:Arction.Wpf.Charting.Views.ViewBase.HandleHorizontalScrollBarsDeviceButtonUp(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@) - - - - - - - param - bIsOutsideGraphArea - M:Arction.Wpf.Charting.Views.ViewBase.HandleHorizontalScrollBarsDeviceButtonUp(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@) - - - - - - - param - mousedObjectFirst - M:Arction.Wpf.Charting.Views.ViewBase.HandleHorizontalScrollBarsDeviceButtonUp(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@) - - - - - - - param - exit - M:Arction.Wpf.Charting.Views.ViewBase.HandleHorizontalScrollBarsDeviceButtonUp(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@) - - - - - - - Handle ScrollBar user interactive device move on different views. - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.ViewBase.HandleHorizontalScrollBarsDeviceMove(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,Arction.Wpf.Charting.UserInteractiveObject) - - - - - - - param - bIsOutsideGraphArea - M:Arction.Wpf.Charting.Views.ViewBase.HandleHorizontalScrollBarsDeviceMove(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,Arction.Wpf.Charting.UserInteractiveObject) - - - - - - - param - mibHandled - M:Arction.Wpf.Charting.Views.ViewBase.HandleHorizontalScrollBarsDeviceMove(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,Arction.Wpf.Charting.UserInteractiveObject) - - - - - - - returns - M:Arction.Wpf.Charting.Views.ViewBase.HandleHorizontalScrollBarsDeviceMove(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,Arction.Wpf.Charting.UserInteractiveObject) - - - - - - - Handle margins changed - - - - - Occurs when vertical scroll bars were clicked by device button. - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.ViewBase.HandleVerticalScrollBarsDeviceButtonClicked(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean) - - - - - - - param - eventType - M:Arction.Wpf.Charting.Views.ViewBase.HandleVerticalScrollBarsDeviceButtonClicked(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean) - - - - - - - param - bIsOutsideGraphArea - M:Arction.Wpf.Charting.Views.ViewBase.HandleVerticalScrollBarsDeviceButtonClicked(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean) - - - - - - - returns - M:Arction.Wpf.Charting.Views.ViewBase.HandleVerticalScrollBarsDeviceButtonClicked(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean) - - - - - - - Handle ScrollBar user interactive device button down event. - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.ViewBase.HandleVerticalScrollBarsDeviceButtonDown(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean) - - - - - - - param - eventType - M:Arction.Wpf.Charting.Views.ViewBase.HandleVerticalScrollBarsDeviceButtonDown(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean) - - - - - - - param - bIsOutsideGraphArea - M:Arction.Wpf.Charting.Views.ViewBase.HandleVerticalScrollBarsDeviceButtonDown(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean) - - - - - - - returns - M:Arction.Wpf.Charting.Views.ViewBase.HandleVerticalScrollBarsDeviceButtonDown(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean) - - - - - - - Handle vertical scroll bars user interactive device button up event. - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.ViewBase.HandleVerticalScrollBarsDeviceButtonUp(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@) - - - - - - - param - eventType - M:Arction.Wpf.Charting.Views.ViewBase.HandleVerticalScrollBarsDeviceButtonUp(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@) - - - - - - - param - bIsOutsideGraphArea - M:Arction.Wpf.Charting.Views.ViewBase.HandleVerticalScrollBarsDeviceButtonUp(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@) - - - - - - - param - mousedObjectFirst - M:Arction.Wpf.Charting.Views.ViewBase.HandleVerticalScrollBarsDeviceButtonUp(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@) - - - - - - - param - exit - M:Arction.Wpf.Charting.Views.ViewBase.HandleVerticalScrollBarsDeviceButtonUp(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@) - - - - - - - Handle vertical scroll bar user interactive device move on different views. - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.ViewBase.HandleVerticalScrollBarsDeviceMove(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,Arction.Wpf.Charting.UserInteractiveObject) - - - - - - - param - bIsOutsideGraphArea - M:Arction.Wpf.Charting.Views.ViewBase.HandleVerticalScrollBarsDeviceMove(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,Arction.Wpf.Charting.UserInteractiveObject) - - - - - - - param - mibHandled - M:Arction.Wpf.Charting.Views.ViewBase.HandleVerticalScrollBarsDeviceMove(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,Arction.Wpf.Charting.UserInteractiveObject) - - - - - - - returns - M:Arction.Wpf.Charting.Views.ViewBase.HandleVerticalScrollBarsDeviceMove(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,Arction.Wpf.Charting.UserInteractiveObject) - - - - - - - Render chart if item list changed. - - - - - param - sender - M:Arction.Wpf.Charting.Views.ViewBase.ItemListChanged(System.Object,System.ComponentModel.ListChangedEventArgs) - - - - - - - param - e - M:Arction.Wpf.Charting.Views.ViewBase.ItemListChanged(System.Object,System.ComponentModel.ListChangedEventArgs) - - - - - - - User interactive device over graph. - - - - - Precalculated center of the margin area in PX, not DIPs. - - - - - Margins between control's edges and for example graph area borders in DIPs. - If using ViewXY AxisLayout.AutoAdjustMargins must be disabled this to apply. - - - - - Margins changed. - - - - - Don't deal with mouse move if the coordinate has not changed. It causes massive - CPU load when having lots of data and effect timer is running. - - - - - param - iMouseX - M:Arction.Wpf.Charting.Views.ViewBase.MoveOnSameCoordinate(System.Int32,System.Int32) - - - - - - - param - iMouseY - M:Arction.Wpf.Charting.Views.ViewBase.MoveOnSameCoordinate(System.Int32,System.Int32) - - - - - - - returns - M:Arction.Wpf.Charting.Views.ViewBase.MoveOnSameCoordinate(System.Int32,System.Int32) - - - - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Gets Owner chart of the view. - - - - - Check is position is over graph. - - - - - - - param - coord - M:Arction.Wpf.Charting.Views.ViewBase.PositionOverGraph(Arction.Wpf.Charting.CoordXY) - - - - - - - returns - M:Arction.Wpf.Charting.Views.ViewBase.PositionOverGraph(Arction.Wpf.Charting.CoordXY) - - - - - - - Reset interactive object state to idle. - - - - - param - mib - M:Arction.Wpf.Charting.Views.ViewBase.SetInteractiveObjectToIdle(Arction.Wpf.Charting.UserInteractiveObject) - - - - - - - User interactive device has been moved. - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.ViewBase.UserInteractiveDeviceMoved(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - param - eventType - M:Arction.Wpf.Charting.Views.ViewBase.UserInteractiveDeviceMoved(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - param - chart - M:Arction.Wpf.Charting.Views.ViewBase.UserInteractiveDeviceMoved(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - returns - M:Arction.Wpf.Charting.Views.ViewBase.UserInteractiveDeviceMoved(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - Mouse wheel has been scrolled. - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.ViewBase.WheelScrolled(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.LightningChart) - - - - - - - param - chart - M:Arction.Wpf.Charting.Views.ViewBase.WheelScrolled(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.LightningChart) - - - - - - - returns - M:Arction.Wpf.Charting.Views.ViewBase.WheelScrolled(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.LightningChart) - - - - - - - The delegate to use for handlers that receive the Margins changed event. - - - Provides data for the Margins changed event. - - - - Zoom, pan and auto-fitting options base for ViewXY. - - - - - Simple constructor for Form designer's list editor. - - - - - Constructor. - - Parent. - - - - User interactive device primary button action. - - - - - User interactive device secondary button action. - - - - - User interactive device tertiary button action. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - User interactive device panning threshold in pixels. Pan occurs only when device button is pressed down and the device - movement equals the given pixel value or is more. - - - - - Gets or sets rectangle zooming threshold. - - - - - Convert class description to string. - - Class description as a string. - - - - Zoom factor. It's used when zooming in with a user interactive device button click combined with Shift and/or Ctrl key. - Shift key makes zooming in X dimension, Ctrl in Y dimension. Device primary button zooms in, secondary buttom zooms out. - - - - - Zoom out rectangle fill. - - - - - Gets or sets zoom out rectangle line style. - - - - - Zoom rectangle fill. - - - - - Zoom rectangle line style - - - - - Bar view options - - - - - Constructor, for serialization purposes - - - - - Constructor - - - - - param - owner - M:Arction.Wpf.Charting.Views.View3D.BarViewOptions3D.#ctor(Arction.Wpf.Charting.IChartNode) - - - - - - - Space between bars in same group as world values. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Space between bar groups as world values, when grouping is fitted. - - - - - Space between edge and nearest groups as world values, when grouping is fitted. - - - - - Stack sum. The series values amongst different series are stacked - and stretched to make this sum. - - - - - Convert class description to string - - String - - - - Grouping series to view. - - - - - Bitmap fill for 3D surface mesh. - - - - - Default constructor. - - - - - Constructor - - - - - param - owner - M:Arction.Wpf.Charting.Views.View3D.BitmapFill3D.#ctor(Arction.Wpf.Charting.IChartNode) - - - - - - - Antialias. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Image object - - - - - Image alpha. 0 is transparent, 255 fully visible - - - - - Flip image horizontally - - - - - Mirror bitmap vertically. - - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Convert object to string. - - - - - returns - M:Arction.Wpf.Charting.Views.View3D.BitmapFill3D.ToString - - - - - - - Camera in 3D view. - Defines how and from what direction the world is seen from. - - - - Constructor. - - - - - Constructor. - - Camera owner view. - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Converts view distance value into a orthographic view area. - Used for building projection matrix. - - - - - param - distance - M:Arction.Wpf.Charting.Views.View3D.Camera3D.DistanceToOrthographicViewArea(System.Double) - - - - Orthographic view area. - - - - Field of view, that is, perspective angle. - - - - - Getter of the far clipping distance for the 3D projection. - This is an advanced setting that is not supported in normal use and should not be modified. - - Current far clipping distance. - - - - Gets camera location in 3D world space. - - Camera location. - - - - Getter of the near clipping distance for the 3D projection. - This is an advanced setting that is not supported in normal use and should not be modified. - - Current near clipping distance. - - - - Locks user pointer device (mouse etc) based rotation to use current - camera orientation settings for rotation axis. - This affects the way horizontal rotation behaves on certain - values. - - This has no effect when is - . - - This method is intended mostly as internal operation of LC. It's run - when , or - properties are changed, causing horizontal - rotation axis to be locked based on the current rotation settings. - The method has been left as public for special cases, where users - need to make the same operation without modifying the rotation - parameters. - - - - - Minimum View distance. Limits the adjust range of ViewDistance. - In some cases, you don't want to let the user set the camera too near. - - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Type of orientation angle definition used in camera orientation. - - This affects how on the orientation angles (, - and ) are interpreted - and how do they affect the camera orientation / position. - - See for more detailed description of options. - - - - - Converts orthographic view's area into a view distance value. - - - - - param - ViewArea - M:Arction.Wpf.Charting.Views.View3D.Camera3D.OrthographicViewAreaToDistance(Arction.Wpf.Charting.SizeFloat) - - - - Orthographic view's area as view distance. - - - - Converts orthographic view's area into a view distance value. - - Orthographic view area. - Aspect ratio. - Field of view, in radians. - Orthographic view's area as view distance. - - - - Gets or sets camera projection type. - - - - - Part of defining camera orientation and position, by setting its - looking direction - rotation around X-axis (pitch, elevation) in degrees. - Selected Orientation mode () defines - how the value affects camera orientation and position. - See enumeration for more information. - and - needs to be set as well for defining - camera orientation. The rotation values are taken into - account on a specific order, NOT on the order they are set. - In some orientation modes setting this value - causes user device horizontal rotation axis to be set. - - - - - Maximum allowed value of property. - This can be used to limit camera orientation / location - to some specific area. - - - - - Minimum allowed value of property. - This can be used to limit camera orientation / location - to some specific area. - - - - - Part of defining camera orientation and position, by setting its - looking direction - rotation around Y-axis (Yaw, Heading, Bearing) in degrees. - Selected Orientation mode () defines - how the value affects camera orientation and position. - See enumeration for more information. - and - needs to be set as well for defining - camera orientation. The rotation values are taken into - account on a specific order, NOT on the order they are set. - In some orientation modes setting this value - causes user device horizontal rotation axis to be set. - - - - - Maximum allowed value of property. - This can be used to limit camera orientation / location - to some specific area. - - - - - Minimum allowed value of property. - This can be used to limit camera orientation / location - to some specific area. - - - - - Part of defining camera orientation and position, by setting its - looking direction - rotation around Z-axis (pitch, elevation) in degrees. - This property has highly different effects on different - orientation modes. - Selected Orientation mode () defines - how the value affects camera orientation and position. - See enumeration for more information. - and - needs to be set as well for defining - camera orientation. The rotation values are taken into - account on a specific order, NOT on the order they are set. - In some orientation modes setting this value - causes user device horizontal rotation axis to be set. - - - - - Maximum allowed value of property. - This can be used to limit camera orientation / location - to some specific area. - - - - - Minimum allowed value of property. - This can be used to limit camera orientation / location - to some specific area. - - - - - Same as setting RotationX, RotationY and RotationZ properties - separately. Allows easier setting of the properties and - is faster than separate setting of the properties. - - - - - param - X - M:Arction.Wpf.Charting.Views.View3D.Camera3D.SetEulerAngles(System.Double,System.Double,System.Double) - - - - - - - param - Y - M:Arction.Wpf.Charting.Views.View3D.Camera3D.SetEulerAngles(System.Double,System.Double,System.Double) - - - - - - - param - Z - M:Arction.Wpf.Charting.Views.View3D.Camera3D.SetEulerAngles(System.Double,System.Double,System.Double) - - - - - - - Setter of the far clipping distance for the 3D projection. - This is an advanced setting that is not supported in normal use and should not be modified. - - New far clipping distance. - - - - Setter of the near clipping distance for the 3D projection. - This is an advanced setting that is not supported in normal use and should not be modified. - - New near clipping distance. - - - - Sets camera orientation angles to values based given predefined orientation setting. - - Predefined camera orientation setting to be used. - - - - Target 3D world coordinate. Camera is targeted towards this coordinate. - Use (0,0,0) to center in the 3D view. - View distance is calculated from this target. - - - - - Convert class description to string - - String - - - - View distance. You should use values in range 10...1000. - Distance is calculated from Target. - - - - - On View3D a certain area is selected that axes are shown around. In effect the axes form a cube that the axes are drawn on three edges of. - The area is further specified by drawing walls on some of it's faces. The area can also be visualized by drawing a framebox around it. - The FrameBox consists of lines drawn along the edges of the cube. - - - - - Constructor - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Color of the FrameBox line color. - - - - - Style that defines how the FrameBox is presented. - - - - - Convert class description to string. - - Class description as a string. - - - - Style to present the framebox with. - - - - - Framemebox is not shown. - - - - - Framebox is shown on all of the edges of the cube. - - - - - Represents a class that provides arguments for the GeometryConstructed event. - - - - - Creates and initializes a new instance of GeometryConstructedEventArgs class. - - - - - MeshModel object. - - - - - X-coordinate array. - - - - - Y-coordinate array. - - - - - Z-coordinate array. - - - - - Legend box for 3D series. - - - - - Constructor. - - - - - Constructor - - Parent. - - - - Categorization. - - - - - Category title color - - - - - Category font - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Occurs when the mouse pointer moves out over the series title. - - - - - Occurs when the mouse pointer moves in over the series title. - - - - - Surface scales. - - - - - Convert class description to string - - String - - - - The delegate to use for handlers that receive the SeriesTitleMouseMoveOverOff event. - - The object that raised the event. - Provides data for the SeriesTitleMouseMoveOverOff event. - - - - The delegate to use for handlers that receive the SeriesTitleMouseMoveOverOn event. - - The object that raised the event. - Provides data for the SeriesTitleMouseMoveOverOn event. - - - - Base class for 3D view LegendBox. - - - - - Constructor. - - - - - Constructor. - - Parent. - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Position of the legend box in relation to rest of the chart. - - - - - Light in 3D. - - - - - Constructor. Don't use from code. - - - - - Constructor - - Parent. - - - - Ambient color of the light - - - - - Lighting attenuation, constant. - Atten = 1 / (att0 + att1 * d + att2 * d2) - - - - - Lighting attenuation, linear factor. - Atten = 1 / (att0 + att1 * d + att2 * d2) - - - - - Lighting attenuation, quadratic factor. - Atten = 1 / (att0 + att1 * d + att2 * d2) - - - - - Diffuse color of the light - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Is the light switched on - - - - - Light location - - - - - Use the view camera location as the location of the light. - - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Specular color of the light - - - - - Target coordinates. Applies to Directional light and Spotlight types. - - - - - Convert class description to string. - - Class description as a string. - - - - Palette coloring type - - - - - Material for 3D objects - - - - - Constructor. - - - - - Constructor - - - - - param - owner - M:Arction.Wpf.Charting.Views.View3D.Material3D.#ctor(Arction.Wpf.Charting.IChartNode) - - - - - - - Ambient color - - - - - Material main color - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Emissive color - - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Specular color - - - - - Specular power - - - - - Convert class description to string - - String - - - - Mesh model. - - - - - Constructor. - - - - - Constructor. Use primary axis for axis binding. - - Parent. - - - - Constructor. - - Parent. - X-axis binding. - Y-axis binding. - Z-axis binding. - - - - Construct object. - - - - - Create a mesh model from positions, texture coordinates, bitmap and optional indices. - - Vertex array. - Texture coordinate array. - Bitmap. - Texture wrapping mode. - Optional index array. - Success code. - - - - Create a mesh model from positions, normals, texture coordinates, bitmap and optional indices. - - Vertex array. - Vertex normals array. - Texture coordinate array. - Bitmap. - Texture wrapping mode. - Optional index array. - Success code. - - - - Create a mesh model from positions and optionally colors. - - Vertex array. - Color array, optional. - Success code. - - - - Create a mesh model from positions, colors, normals and optional indices. - - Vertex array. - Color array. - Vertex normals array. - Optional index array. - Success code. - - - - Create a mesh model from positions and colors. Positions must be triplets of triangle points and each color in input is color of each triangle. - - Triangle position array. - Color per triangle (array of Int32). - Optional normal array. - Success code. - - - - Create a mesh model from positions and colors. Positions must be triplets of triangle points and each color in input is color of each triangle. - - Triangle position array. - Color per triangle (array of Color). - Optional normal array. - Success code. - - - - Face culling determines which faces are not rendered based on their winding order. If model show wrong faces, culling may be an issue. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Render as filled. - - - - - Geometry has been constructed. - - - - - Is position over item. - - x-coordinate - y-coordinate - Use DIP instead of pixels as parameters - True if position is over item, false otherwise - - - - Load from obj format file (.obj). - - Filename. - - - - Load from obj format resource. - - Resource name. - - - - Load from obj file stream (.obj). - - Source stream (obj file formatted). - - - - Model file name. - - - - - Position (offset) in axis values. - - - - - Sets MeshModel's rendering order in relation to other series. - - - - - Rotating angles, in degrees - - - - - MeshModel shading mode. - - - - - Scaling factor. - - - - - Convert class description to string - - String - - - - Enable sending events of model face tracking. - - - - - User has traced a triangle of mesh with user interactive device. - - - - - Update mesh bitmap, without reconstructing the geometry. - - Bitmap image. - - - - Update mesh colors. The color order must be identical with event vertex array. - - Array of colors. - - - - Update mesh wireframe colors. The color order must be identical with event vertex array. - - Array of colors. - - - - Render as wireframe. - - - - - Wireframe color. - - - - - Visible. - - - - - X axis binding - - - - - Y axis binding - - - - - Z axis binding - - - - - Return value of various Create() methods. - - - - - Success. - - - - - No vertexes. - - - - - Normal count does not match vertex count. - - - - - Texture coordinate count does not match vertex count. - - - - - Color count does not match vertex count. - - - - - No colors. - - - - - Normal and color count do not match. - - - - - The delegate to use for handlers that receive the GeometryConstructed event. - - - Provides data for the GeometryConstructed event. - - - - The delegate to use for handlers that receive the TriangleTraced event. - - - Provides data for the TriangleTraced event. - - - - Represents a class that provides arguments for the TriangleTracedEventArgs event. - - - - - Creates and initializes a new instance of MouseTraceTriangleChanged class. - - - - - Axis values of traced triangle intersection point. - - - - - MeshModel object. - - - - - Model spaced coordinates of traced triangle. - - - - - Index to nearest coordinate of traced triangle. Value is in range 0..2. - - - - - World spaced coordinates of traced triangle. Position, sizing and rotation affect this value. - - - - - Orientation Arrows 3D Options - - - - - Constructor, for serialization purposes - - - - - Constructor - - - - - param - owner - M:Arction.Wpf.Charting.Views.View3D.OrientationArrowsOptions3D.#ctor(Arction.Wpf.Charting.IChartNode) - - - - - - - Orientation Arrow's length in screen pixels, maximum projection. - - - - - Orientation Arrow's width in screen pixels. - - - - - Color of X-axis Orientation Arrow. Default 'Red' - - - - - Color of Y-axis Orientation Arrow. Default 'Green' - - - - - Color of Z-axis Orientation Arrow. Default 'Blue' - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Convert class description to string - - String - - - - Is Orientation Arrows visible or not. - - - - - Point style in 3D - - - - - Constructor - - - - - Constructor - - - - - param - owner - M:Arction.Wpf.Charting.Views.View3D.PointStyle3D.#ctor(Arction.Wpf.Charting.IChartNode) - - - - - - - Detail level effecting some shape styles - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Rotating angles of 3D shape, in degrees - - - - - Shape type for 2D type. - - - - - Shape - - - - - Shape type. - - - - - Point size, 3D shape - - - - - Convert class description to string - - String - - - - Polygon in 3D. - - - - - Constructor. - - - - - Constructor. - - - - - param - owner - M:Arction.Wpf.Charting.Views.View3D.Polygon3D.#ctor(Arction.Wpf.Charting.Views.View3D.View3D) - - - - - - - Constructor. - - Parent. - X-axis binding. - Y-axis binding. - Z-axis binding. - - - - Clears the Points array. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Is position over polygon. - - X coordinate - Y coordinate - - - - param - useDIP - M:Arction.Wpf.Charting.Views.View3D.Polygon3D.IsPositionOver(System.Int32,System.Int32,System.Boolean) - - - - - - - returns - M:Arction.Wpf.Charting.Views.View3D.Polygon3D.IsPositionOver(System.Int32,System.Int32,System.Boolean) - - - - - - - Material. - - - - - Series points - - - - - Rotation of polygon. - - - - - Object as string. - - Object as a string. - - - - Visible. - - - - - X axis binding - - - - - Y axis binding - - - - - YMax - - - - - YMin - - - - - Z axis binding - - - - - Rectangle in 3D. - - - - - Constructor. - - - - - Constructor. - - - - - param - owner - M:Arction.Wpf.Charting.Views.View3D.Rectangle3D.#ctor(Arction.Wpf.Charting.Views.View3D.View3D) - - - - - - - Constructor. - - Parent. - X-axis binding. - Y-axis binding. - Z-axis binding. - - - - Center of rectangle. - - - - - Create member. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Rectangle fill. - - - - - Free DrawData. - - - - - Is Mouse Over. - - Mouse X-coordinate. - Mouse Y-coordinate. - Use DIP. - - - - returns - M:Arction.Wpf.Charting.Views.View3D.Rectangle3D.IsPositionOver(System.Int32,System.Int32,System.Boolean) - - - - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Rotation of rectangle. - - - - - Rectangle size. - - - - - Object as string. - - Object as a string. - - - - Visible. - - - - - X axis binding - - - - - Y axis binding - - - - - Z axis binding - - - - - Rectangle3D visual properties. - - - - - Constructor. - - - - - Constructor. - - Parent. - - - - Create material. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Image object - - - - - Image alpha. 0 is transparent, 255 fully visible (opaque). - - - - - Fill layout - - - - - Series material - - - - - Tile count on height dimension - - - - - Tile count on width dimension. - - - - - Convert class description to string - - Class description as a string. - - - - Use Image when drawing. - - - - - Represents a class that provides arguments for the SeriesTitleUserInteractiveDeviceMoved event. - - - - - Creates and initializes a new instance of SeriesTitleUserInteractiveDeviceMoved class. - - - - SeriesTitleMoved - The series over which the user interactive device was moved in or out. - - - - - User interaction based rotation snapping options for View3D and especially Camera3D. - - - - - Simple constructor for Form designer's list editor. - - - - - Constructor. - - Parent. - - - - Disposes the object - - - - - Arction.Wpf.Charting.Views.View3D.UserInteractionRotateSnappingOptions - - - - - - - Snap enabled - - - - - Snap Tolerance - - - - - Snap angle - - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Defines if the snapping is enabled or not. - - - - - Angle as degrees that the view direction can be away from the - defined snap angle for the snapping to happen. - - - - - Snap to vertical plane of angle 0. - - - - - Snap to vertical plane of angle 45. - - - - - Convert class description to string. - - Class description as a string. - - - - Enum of possible angles to control through interface. - These can be converted to angles using GetAngle() method. - - - - - No angle - - - - - Zero angle - - - - - 45 degree angle - - - - - Wall base class. - - - - - Constructor. - - - - - Constructor - - Owner of wall - Wall type - - - - Hides the wall if it gets between the camera and chart contents - - - - - Create members. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Full transparent wall except grid lines - - - - - Get grid strip color for first dimension - - Grid strip color - - - - Get grid strip color for second dimension - - Grid strip color - - - - Get wall type - - Wall type - - - - Is position over wall. - - X coordinate - Y coordinate - Use DIP instead of pixels as parameters - true if position is over series. Else false. - - - - Major grid shift towards camera. - - - - - Minor grid shift towards camera. - - - - - Wall material - - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Set grid strip color for first dimension - - Color - - - - Set grid strip color for second dimension - - Color - - - - Thickness of the wall - - - - - Convert class description to string - - String - - - - Update Custom Tick - - - - - param - aCatDimIndex - M:Arction.Wpf.Charting.Views.View3D.WallBase.UpdateCustomTickIndex(System.Int32[],System.Int32@,System.Double,System.Collections.Generic.IList{Arction.Wpf.Charting.Axes.CustomAxisTick}) - - - - - - - param - catIndex - M:Arction.Wpf.Charting.Views.View3D.WallBase.UpdateCustomTickIndex(System.Int32[],System.Int32@,System.Double,System.Collections.Generic.IList{Arction.Wpf.Charting.Axes.CustomAxisTick}) - - - - - - - param - value - M:Arction.Wpf.Charting.Views.View3D.WallBase.UpdateCustomTickIndex(System.Int32[],System.Int32@,System.Double,System.Collections.Generic.IList{Arction.Wpf.Charting.Axes.CustomAxisTick}) - - - - - - - param - list - M:Arction.Wpf.Charting.Views.View3D.WallBase.UpdateCustomTickIndex(System.Int32[],System.Int32@,System.Double,System.Collections.Generic.IList{Arction.Wpf.Charting.Axes.CustomAxisTick}) - - - - - - - Is the wall visible or not - - - - - XY plane wall. - - - - - Constructor. - - - - - Constructor. - - Parent. - Wall type. - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Grid strip color for X dimension - - - - - Grid strip color for Y dimension - - - - - Grid color strips - - - - - Convert class description to string. - - Class description as a string. - - - - Source axis for X grid - - - - - Source axis for Y grid - - - - - XZ plane wall. - - - - - Constructor. - - - - - Constructor. - - Parent. - Wall type. - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Grid strip color for X dimension - - - - - Grid strip color for Z dimension - - - - - Grid color strips - - - - - Convert class description to string - - String - - - - Source axis for X grid - - - - - Source axis for Z grid - - - - - YZ plane wall - - - - - Constructor. - - - - - Constructor - - - - - param - owner - M:Arction.Wpf.Charting.Views.View3D.WallYZ.#ctor(Arction.Wpf.Charting.IChartNode,Arction.Wpf.Charting.WallType) - - - - - - - param - type - M:Arction.Wpf.Charting.Views.View3D.WallYZ.#ctor(Arction.Wpf.Charting.IChartNode,Arction.Wpf.Charting.WallType) - - - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Grid strip color for Y dimension - - - - - Grid strip color for Z dimension - - - - - Grid color strips - - - - - Convert class description to string - - String - - - - Source axis for Y grid - - - - - Source axis for Z grid - - - - - Code related to DataCursor at View3D. - - - - - Constructor. - - - - - Constructor. - - Parent. - - - - List of 3D annotations. - - - - - 3D bar series list. - - - - - Bar view options 3D. - - - - - Camera viewpoint has changed. - - - - - Clip series and Mesh model inside space limited axis ranges. - - - - - Convert 3D world coordinates into screen coordinates. - - 3D world coordinates. - Screen coordinates. - - - - Converts 3D world space coordinate to series value, using the axes bound to the series. - - Series - X-coordinate. - Y-coordinate. - Z-coordinate. - Series value - - - - Converts series points to 3D world space coordinates, using the axes bound to the series. - - Series. - Points to convert. - 3D world space coordinate. - - - - Converts series points to 3D world space coordinates, using the axes bound to the series. - - Series. - Array of SeriesPointCompact3D to convert. - 3D world space coordinate. - - - - Converts series points to 3D world space coordinates, using the axes bound to the series. - - Series. - Array of SeriesPointCompactColored3D to convert. - 3D world space coordinate. - - - - Converts series points to screen coordinates, using the axes bound to the series. - - 3D series. - Array of SeriesPoint3D to convert. - Array of screen coordinates. - - - - Converts compact series points to screen coordinates, using the axes bound to the series. - - 3D series. - Array of SeriesPointCompact3D to convert. - Array of screen coordinates. - - - - Converts compact colored series points to screen coordinates, using the axes bound to the series. - - 3D series. - Array of SeriesPointCompactColored3D to convert. - Array of screen coordinates. - - - - Converts series value range to 3D world space range, using the axes bound to the series. - - Series. - X-range. - Y-range. - Z-range. - 3D world space ranges. - - - - Converts series value to 3D world space coordinate, using the axes bound to the series. - - Series. - X-value. - Y-value. - Z-value. - 3D world space coordinate. - - - - Converts series value to screen coordinate, using the axes bound to the series. - - Series. - X-value. - Y-value. - Z-value. - Screen coordinate. - - - - Data cursor shows series data value at or near mouse position. - - - - - User interactive device button has been clicked. - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.View3D.View3D.DeviceButtonClicked(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - param - eventType - M:Arction.Wpf.Charting.Views.View3D.View3D.DeviceButtonClicked(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - param - chart - M:Arction.Wpf.Charting.Views.View3D.View3D.DeviceButtonClicked(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - returns - M:Arction.Wpf.Charting.Views.View3D.View3D.DeviceButtonClicked(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - Mouse button has been clicked down. - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.View3D.View3D.DeviceButtonDown(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - param - eventType - M:Arction.Wpf.Charting.Views.View3D.View3D.DeviceButtonDown(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - param - chart - M:Arction.Wpf.Charting.Views.View3D.View3D.DeviceButtonDown(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - returns - M:Arction.Wpf.Charting.Views.View3D.View3D.DeviceButtonDown(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - Mouse button has been released. - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.View3D.View3D.DeviceButtonUp(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - param - eventType - M:Arction.Wpf.Charting.Views.View3D.View3D.DeviceButtonUp(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - param - chart - M:Arction.Wpf.Charting.Views.View3D.View3D.DeviceButtonUp(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - returns - M:Arction.Wpf.Charting.Views.View3D.View3D.DeviceButtonUp(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - 3D world dimensions have changed. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Framebox that shows the graph area, in extension to walls. - - - - - Get list of series having this axis bound as X-, Y- or Z-axis, primary or secondary. - - 3D axis. - List of series. - - - - Get all 3D series. - - List of 3D series. - - - - Get all 3D surface series. - - List of 3D surface series. - - - - Get all 3D but surface series. - - List of all 3D but surface series. - - - - Get list of axes. - - List of axes. - - - - Get list of walls. - - List of walls. - - - - Handle mouse down. - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.View3D.View3D.HandleDeviceButtonDownAction(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,Arction.Wpf.Charting.UserInteractiveObject) - - - - - - - param - bIsOutsideGraphArea - M:Arction.Wpf.Charting.Views.View3D.View3D.HandleDeviceButtonDownAction(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,Arction.Wpf.Charting.UserInteractiveObject) - - - - - - - param - item - M:Arction.Wpf.Charting.Views.View3D.View3D.HandleDeviceButtonDownAction(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,Arction.Wpf.Charting.UserInteractiveObject) - - - - - - - returns - M:Arction.Wpf.Charting.Views.View3D.View3D.HandleDeviceButtonDownAction(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,Arction.Wpf.Charting.UserInteractiveObject) - - - - - - - Handler gets Graph segment information - - - - - Finds out if the given position is over graph area. - - X-coordinate. - Y-coordinate. - Use DIP for input point. - True if is over - - - - Legend box for 3D view. - - - - - Generates DrawData for axis aligned framebox of a given 3D rectangle (somebody would call it box or cube). - - Rectangle to draw the box of. - Color to use with the lines. - DrawData of the edges of the box drawn using given color and AntiAliased hairline. - - - - Mesh model list. - - - - - Move 3D point to screen coordinate on directions based on the basis. - - Tell which axises to use for moving: Primary or Secondary. - Point with axis values. - Point in screen coordinates to which direction startPoint will be moved. - Tells dimension on which to move the point. - Use DIPs as coordinates. - - - - returns - M:Arction.Wpf.Charting.Views.View3D.View3D.MovePoint(Arction.Wpf.Charting.Axis3DBinding,Arction.Wpf.Charting.PointDouble3D,Arction.Wpf.Charting.PointFloatXY,Arction.Wpf.Charting.MovementDimension,System.Boolean) - - - - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Orientation arrows options. - - - - - 3D point line series list. - - - - - List of 3D polygons. - - - - - Position over Graph. - - Position - - - - returns - M:Arction.Wpf.Charting.Views.View3D.View3D.PositionOverGraph(Arction.Wpf.Charting.CoordXY) - - - - - - - Raise camera view changed event. - - - - - Raise dimension changed event. - - - - - Rectangle3D list. - - - - - Virtual method that is called when walls sorting becomes dirty. - Before this the sorting dirtiness was kept (and still is) using m_bSortingDirty. - We need to know when the sorting becomes dirty so that we can mark the FrameBox dirty, - as there is little point doing the check on every frame. - - - - - Surface grid series list. - - - - - Surface mesh series list. - - - - - Convert class description to string. - - Class description as a string. - - - - User interactive device has been moved. - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.View3D.View3D.UserInteractiveDeviceMoved(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - param - eventType - M:Arction.Wpf.Charting.Views.View3D.View3D.UserInteractiveDeviceMoved(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - param - chart - M:Arction.Wpf.Charting.Views.View3D.View3D.UserInteractiveDeviceMoved(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - returns - M:Arction.Wpf.Charting.Views.View3D.View3D.UserInteractiveDeviceMoved(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - Back wall. - - - - - Bottom wall (floor). - - - - - Front wall. - - - - - Left wall. - - - - - Right wall. - - - - - Top wall (ceiling). - - - - - Waterfall series list. - - - - - Wheel scrolled. - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.View3D.View3D.WheelScrolled(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.LightningChart) - - - - - - - param - chart - M:Arction.Wpf.Charting.Views.View3D.View3D.WheelScrolled(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.LightningChart) - - - - - - - returns - M:Arction.Wpf.Charting.Views.View3D.View3D.WheelScrolled(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.LightningChart) - - - - - - - Volume model list. - - - - - Primary X-axis for 3D view. - - - - - Secondary X-axis for 3D view. - - - - - Primary Y-axis for 3D view. - - - - - Secondary Y-axis for 3D view. - - - - - Primary Z-axis for 3D view. - - - - - Secondary Z-axis for 3D view. - - - - - Zoom, pan and rotation options. - - - - - Delegate for CameraViewChanged event. - - New camera view point. - View containing the camera. - Chart where the error occurred. - - - - Delegate for DimensionsChanged event. - - New width. - New height. - New depth. - View3D containing the camera. - Chart where the error occurred. - - - - 3D view base class. - - - - - Constructor - - - - - Constructor. - - Parent. - - - - Adjust selected annotation target z value. - - z change - - - - Automatically size margins based on LegendBox position and size. - - - - - Border Options for View - - - - - re-calculates the margin area and drawcenter, marks - all affected to dirty. - - - - - Camera (point of view). - - - - - Convert a 3D point to screen coordinate. - - X-coordinate. - Y-coordinate. - Z-coordinate. - Point in screen coordinates. - - - - Create camera. - - - - - Create default lights. - - - - - returns - M:Arction.Wpf.Charting.Views.View3D.View3DBase.CreateDefaultLights - - - - - - - Create dimensions. - - - - - User interactive device button has been double clicked. - For double click the behavior is almost similar to single click, only raised event differs. - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.View3D.View3DBase.DeviceButtonDoubleClicked(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - param - eventType - M:Arction.Wpf.Charting.Views.View3D.View3DBase.DeviceButtonDoubleClicked(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - param - chart - M:Arction.Wpf.Charting.Views.View3D.View3DBase.DeviceButtonDoubleClicked(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - returns - M:Arction.Wpf.Charting.Views.View3D.View3DBase.DeviceButtonDoubleClicked(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - Dimensions (size) of the 3D chart view - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Get Pan Sensitivity - - - - - returns - M:Arction.Wpf.Charting.Views.View3D.View3DBase.GetPanSensitivity - - - - - - - Get Rotation Sensitivity set as public property. - - - - - returns - M:Arction.Wpf.Charting.Views.View3D.View3DBase.GetRotationSensitivity - - - - - - - Getter of the ZoomPadding, supported by Round and 3D Views - ZoomPanOptions. - - ZoomPadding of the given view, if supported. - - - - List of lights - - - - - Lights list changed - - - - - param - sender - M:Arction.Wpf.Charting.Views.View3D.View3DBase.LightsListChanged(System.Object,System.ComponentModel.ListChangedEventArgs) - - - - - - - param - e - M:Arction.Wpf.Charting.Views.View3D.View3DBase.LightsListChanged(System.Object,System.ComponentModel.ListChangedEventArgs) - - - - - - - Camera rotation on X axis. - - - - - Camera rotation on Y axis. - - - - - Camera rotation on Z axis. - - - - - Panning and zooming start camera location. - - - - - Panning and zooming start camera target. - - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Convert 3D point coordinates to world coordinates. - - X-value. - Y-value. - Z-value. - X-axis. - Y-axis. - Z-axis. - - - - returns - M:Arction.Wpf.Charting.Views.View3D.View3DBase.Point3DToCoordW(System.Double,System.Double,System.Double,Arction.Wpf.Charting.Axes.Axis3DBase,Arction.Wpf.Charting.Axes.Axis3DBase,Arction.Wpf.Charting.Axes.Axis3DBase) - - - - - - - Check is position is over graph. - - Position - - - - returns - M:Arction.Wpf.Charting.Views.View3D.View3DBase.PositionOverGraph(Arction.Wpf.Charting.CoordXY) - - - - - - - Raise camera view changed event. - - - - - Raise dimension changed event. - - - - - Set a predefined lighting scheme. - - Lighting scheme. - - - - Set predefined lighting scheme without refresh. - - - - - param - scheme - M:Arction.Wpf.Charting.Views.View3D.View3DBase.SetPredefinedLightingSchemeWithoutRefresh(Arction.Wpf.Charting.LightingScheme) - - - - - - - Sorting Dirty - - - - - User interactive device has been moved. - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.View3D.View3DBase.UserInteractiveDeviceMoved(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - param - eventType - M:Arction.Wpf.Charting.Views.View3D.View3DBase.UserInteractiveDeviceMoved(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - param - chart - M:Arction.Wpf.Charting.Views.View3D.View3DBase.UserInteractiveDeviceMoved(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - returns - M:Arction.Wpf.Charting.Views.View3D.View3DBase.UserInteractiveDeviceMoved(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - Mouse wheel scrolled. - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.View3D.View3DBase.WheelScrolled(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.LightningChart) - - - - - - - param - chart - M:Arction.Wpf.Charting.Views.View3D.View3DBase.WheelScrolled(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.LightningChart) - - - - - - - returns - M:Arction.Wpf.Charting.Views.View3D.View3DBase.WheelScrolled(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.LightningChart) - - - - - - - Zooms the view so that the data is visible at maximum possible size. - - Area is either the full drawing area inside - or area which is further limited by , depending - on case. For more information, see options at . - - - - - param - area - M:Arction.Wpf.Charting.Views.View3D.View3DBase.ZoomToFit(Arction.Wpf.Charting.ZoomArea3D) - - - - - - - Volume model. - - - - - Constructor. - - - - - Constructor. - - Parent. - - - - Constructor. - - Parent. - Texture map. - Texture map width. - Texture map height. - Amount of slices. - - - - Constructor. - - Parent. - Path to the folder with slices. - - - - Constructor. - - Parent. - Path to the texture map. - Amount of slices on texture map. - - - - Constructor. - - Parent. - Texture map. - Amount of slices on texture map. - - - - Constructor. - - Parent. - An array of slices. - - - - Constructor. Use primary axis for axis binding. - - Parent. - - - - Constructor. - - Parent. - X-axis binding. - Y-axis binding. - Z-axis binding. - - - - Constructor. - - Path to the folder with slices. - - - - Constructor. - - Path to the texture map. - Amount of slices on texture map. - - - - Brightness option of the transfer function - - - - - skip color for volume model not to draw - - - - - Clip color range of VolumeModel where color component values between 0.0-1, inclusive. - - - - - Construct object. - - - - - Darkness option of the transfer function - - - - - Model bitmap data. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Sampling rate for empty space skipping settings. Low level increases performance, but can reveal some artifacts. - - - - - Is position over item. - - x-coordinate - y-coordinate - true if position is over item, false otherwise - - - - Receive a texture map as byte array and assigns it to the volume data. - - Slice map data. - Slice map width. - Slice map height. - Amount of slices in the slice map. - - - - Receive a texture map and set assigns it to the volume data. - - Path to the texture map. - Amount of slices per side. - - - - Receive a texture map and assigns it to the volume data. - - Texture map. - Amount of slices on texture map. - - - - Receive an array of slices and assign it to the volume data. - - Path to the folder with slices. - - - - Receive an array of slices and assign it to the volume data. - - An array of slices. - True, if can load data, false otherwise. - - - - Opacity for semi-transparent volume rendering functions - - - - - Position. - - - - - Enum specifies Ray Function, which is used to render the model. - - - - - Rotating angles, in degrees - - - - - Set of setting for Sampling Rate Manager - - - - - Set Chart. - - - - - param - chart - M:Arction.Wpf.Charting.Views.View3D.VolumeModel.SetChart(Arction.Wpf.Charting.LightningChart) - - - - - - - Point size - - - - - Slice Range settings per every dimension - - - - - Smoothness factor for Iso-Surface rendering - - - - - Threshold settings, to cut away unaccepted part of the model - - - - - Convert class description to string. - - Class description as a string. - - - - Visible. - - - - - X axis binding - - - - - Y axis binding - - - - - Z axis binding - - - - - Zoom, pan and rotation options for View3D. - - - - - Simple constructor for Form designer's list editor. - - - - - Constructor. - - Parent. - - - - Auto fit axis ranges to added series data values. - - - - - Device wheel action on axis. - - - - - Draw cross at zoom box front face when zooming out. - - - - - Zoom out factor. Used when box-zooming out. - - - - - User interactive device primary button action. - - - - - User interactive device secondary button action. - - - - - User interactive device tertiary button action. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Get Auto-Fit range, two opposite corner points of drawing region as axis values. - - Minimum axis coordinates. - Maximum axis coordinates. - True, if range could be fetched, false otherwise. - - - - Limit box zooming inside graph. - - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Gets or sets rectangle zooming threshold. - - - - - Right-to-left zoom action. - - - - - Convert class description to string. - - Class description as a string. - - - - Wheel reactive axis thickness. - - - - - Zoom box color. - - - - - Zoom box edge line style when box-zooming in. - - - - - Zoom box edge line style when box-zooming out. - - - - - Zoom, pan and rotation options for 3D Views - - - - - Simple constructor for Form designer's list editor. - - - - - Constructor - - View owner - - - - Allow zoom in / out with user interactive device wheel. - - - - - User interactive device primary button double click action. - Determines what zoom / pan operation to do at double click of device primary button. - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Enable multitouch panning. - - - - - Enable multitouch zooming. - - - - - Pan sensitivity. 1 = normal sensitivity. - - - - - Rotation sensitivity. 1 = normal sensitivity. - - - - - Zoom factor. It's used when zooming (moving camera closer to 3D model center) in or out by user interactive device wheel. - - - - - Padding affecting zooming operations. The empty space left between the zoom area and the margins. - - - - - LegendBox for 3D pie. - - - - - Constructor for editor. - - - - - Constructor. - - Parent. - - - - Occurs when the mouse pointer moves out over the series title. - - - - - Occurs when the mouse pointer moves in over the series title. - - - - - Item to string. - - Item as a string. - - - - The delegate to use for handlers that receive the SeriesTitleMouseMoveOverOff event. - - The object that raised the event. - Provides data for the SeriesTitleMouseMoveOverOff event. - - - - The delegate to use for handlers that receive the SeriesTitleMouseMoveOverOn event. - - The object that raised the event. - Provides data for the SeriesTitleMouseMoveOverOn event. - - - - Material for 3D pie objects - - - - - Constructor. - - - - - Constructor - - - - - param - owner - M:Arction.Wpf.Charting.Views.ViewPie3D.MaterialPie3D.#ctor(Arction.Wpf.Charting.IChartNode) - - - - - - - Ambient color - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Emissive color - - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Specular color - - - - - Specular power - - - - - Convert class description to string - - String - - - - Pie slice. - - - - - Constructor. - - - - - Constructor. - - Value of the pie slice. - Add to owner view's Values list. - Color. - Parent. - Title text. - - - - Blinks the series color when user interactive device is over it. If this is false, only simple highlight - will be shown. - - - - - Pie slice color. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Expand slice a bit further from center. - - - - - Is position over item. - - x-coordinate - y-coordinate - Use DIP instead of pixels as parameters - true if position is over item, false otherwise - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Get item as LegendBoxMouseObject. - - related object - - - - returns - M:Arction.Wpf.Charting.Views.ViewPie3D.PieSlice.op_Implicit(Arction.Wpf.Charting.Views.ViewPie3D.PieSlice)~Arction.Wpf.Charting.Views.LegendBoxObject - - - - - - - Enlists the series title text in Legend box of the chart - - - - - Pie slice title. - - - - - Name alignment. - - - - - Convert class description to string. - - Class description as a string. - - - - Pie slice value. - - - - - Represents a class that provides arguments for the SeriesTitleDeviceMoved event. - - - - - Creates and initializes a new instance of SeriesTitleDeviceMovedEventArgs class. - - - - - The series over which the mouse pointer was moved in or out. - - - - - 3D pie view class - - - - - Constructor. - - - - - Constructor - - Parent. - - - - List of annotations. - - - - - Camera viewpoint has changed - - - - - Create camera. - - - - - Create dimensions. - - - - - User interactive device button clicked. - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.ViewPie3D.ViewPie3D.DeviceButtonClicked(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - param - eventType - M:Arction.Wpf.Charting.Views.ViewPie3D.ViewPie3D.DeviceButtonClicked(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - param - chart - M:Arction.Wpf.Charting.Views.ViewPie3D.ViewPie3D.DeviceButtonClicked(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - returns - M:Arction.Wpf.Charting.Views.ViewPie3D.ViewPie3D.DeviceButtonClicked(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - User interactive device button down. - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.ViewPie3D.ViewPie3D.DeviceButtonDown(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - param - eventType - M:Arction.Wpf.Charting.Views.ViewPie3D.ViewPie3D.DeviceButtonDown(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - param - chart - M:Arction.Wpf.Charting.Views.ViewPie3D.ViewPie3D.DeviceButtonDown(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - returns - M:Arction.Wpf.Charting.Views.ViewPie3D.ViewPie3D.DeviceButtonDown(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - User interactive device button up. - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.ViewPie3D.ViewPie3D.DeviceButtonUp(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - param - eventType - M:Arction.Wpf.Charting.Views.ViewPie3D.ViewPie3D.DeviceButtonUp(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - param - chart - M:Arction.Wpf.Charting.Views.ViewPie3D.ViewPie3D.DeviceButtonUp(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - returns - M:Arction.Wpf.Charting.Views.ViewPie3D.ViewPie3D.DeviceButtonUp(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - Dimensions (size) of the 3D chart view - - - - - 3D world dimensions have changed - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Donut inner diameter, in percents. - - - - - Explode percent. - - - - - Handler gets Graph segment information - - - - - Pie legend box. - - - - - Lighting scheme. - - - - - Pie material. - - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Raise camera view changed event. - - - - - Raise dimension changed event. - - - - - Edge rounding percentage. - - - - - Set pie size. - - Size. Default is 150 - - - - Pie first item start angle. - - - - - 3D pie draw style. - - - - - Pie thickness. - - - - - Number formatting string used when a numeric titles style is selected - - - - - Titles style - - - - - Convert class description to string - - String - - - - User interactive device has been moved. - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.ViewPie3D.ViewPie3D.UserInteractiveDeviceMoved(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - param - eventType - M:Arction.Wpf.Charting.Views.ViewPie3D.ViewPie3D.UserInteractiveDeviceMoved(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - param - chart - M:Arction.Wpf.Charting.Views.ViewPie3D.ViewPie3D.UserInteractiveDeviceMoved(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - returns - M:Arction.Wpf.Charting.Views.ViewPie3D.ViewPie3D.UserInteractiveDeviceMoved(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - Pie slice values. - - - - - User interactive device wheel scrolled. - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.ViewPie3D.ViewPie3D.WheelScrolled(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.LightningChart) - - - - - - - param - chart - M:Arction.Wpf.Charting.Views.ViewPie3D.ViewPie3D.WheelScrolled(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.LightningChart) - - - - - - - returns - M:Arction.Wpf.Charting.Views.ViewPie3D.ViewPie3D.WheelScrolled(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.LightningChart) - - - - - - - Zoom, pan and rotation options. - - - - - Delegate for CameraViewChanged event - - New camera view point - View containing the camera - Chart where the error occurred - - - - Delegate for DimensionsChanged event - - New width - New height - New depth - View3D containing the camera - Chart where the error occurred - - - - Zoom, pan and rotation options for View3D - - - - - Simple constructor for Form designer's list editor. - - - - - Constructor - - Parent. - - - - Device primary button action. - - - - - Device secondary button action. - - - - - Device tertiary button action. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Get Auto-Fit range, two opposite corner points of drawing region as axis values. - - Minimum axis coordinates. - Maximum axis coordinates. - True, if range could be fetched. Otherwise false. - - - - Convert class description to string. - - Class description as a string. - - - - LegendBox for polar series. - - - - - Constructor. - - - - - Constructor. - - Parent. - - - - Categorization. - - - - - Category title color - - - - - Category font - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Palatte scales. - - - - - Convert class description to string. - - Class description as a string. - - - - ViewPolar class inherits ViewPolarBase. - - - - - Constructs new ViewPolar. - - - - - Constructs new ViewPolar. - - Parent. - - - - Polar axis list. - - - - - Placement of Amplitude Axis is done automatically. If false, it will consider start angle as 0. - - - - - Calculates radius in pixels for given zoom factor. - - - - - Radius in pixels. - - - - Common construct method, called from the base class. - - - - - Create Polar Axes. - - Default Polar Axes. - - - - Check if user interactive device button was clicked - - - - - param - Type - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolar.DeviceButtonClickCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean) - - - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolar.DeviceButtonClickCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean) - - - - - - - param - eventType - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolar.DeviceButtonClickCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean) - - - - - - - param - bIsOutsideGraphArea - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolar.DeviceButtonClickCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean) - - - - - - - param - Front - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolar.DeviceButtonClickCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean) - - - - - - - returns - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolar.DeviceButtonClickCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean) - - - - - - - Check if user interactive device button is down. - - - - - param - type - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolar.DeviceButtonDownCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,System.Boolean) - - - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolar.DeviceButtonDownCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,System.Boolean) - - - - - - - param - bIsOutsideGraphArea - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolar.DeviceButtonDownCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,System.Boolean) - - - - - - - param - front - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolar.DeviceButtonDownCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,System.Boolean) - - - - - - - returns - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolar.DeviceButtonDownCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,System.Boolean) - - - - - - - Check if user interactive device button is up. - - - - - param - Type - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolar.DeviceButtonUpCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,System.Boolean) - - - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolar.DeviceButtonUpCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,System.Boolean) - - - - - - - param - eventType - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolar.DeviceButtonUpCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,System.Boolean) - - - - - - - param - bIsOutsideGraphArea - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolar.DeviceButtonUpCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,System.Boolean) - - - - - - - param - bMousedObjectFirst - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolar.DeviceButtonUpCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,System.Boolean) - - - - - - - param - bExit - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolar.DeviceButtonUpCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,System.Boolean) - - - - - - - param - Front - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolar.DeviceButtonUpCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,System.Boolean) - - - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Free markers. - - - - - param - creatingDeviceOrDisposing - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolar.FreeMarkersDrawData(System.Boolean) - - - - - - - Getter of the current views top-left and bottom-right corner axis values for the given axis. - - Axis index to get the view values of. - Views top-left corner axis values. - Views bottom-right corner axis values. - - - - Getter of the current views top-left, bottom-left, top-right and bottom-right corner axis values. - - Index of the axis to get the corner values in relation to. - Views top-left corner axis values. - Views top-right corner axis values. - Views bottom-right corner axis values. - Views bottom-left corner axis values. - - - - Occurs when user interactive device is moved. - - - - - param - Type - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolar.HandleDeviceMoved(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,Arction.Wpf.Charting.UserInteractiveObject,System.Boolean) - - - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolar.HandleDeviceMoved(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,Arction.Wpf.Charting.UserInteractiveObject,System.Boolean) - - - - - - - param - bIsOutsideGraphArea - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolar.HandleDeviceMoved(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,Arction.Wpf.Charting.UserInteractiveObject,System.Boolean) - - - - - - - param - mibHandled - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolar.HandleDeviceMoved(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,Arction.Wpf.Charting.UserInteractiveObject,System.Boolean) - - - - - - - param - Front - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolar.HandleDeviceMoved(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,Arction.Wpf.Charting.UserInteractiveObject,System.Boolean) - - - - - - - returns - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolar.HandleDeviceMoved(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,Arction.Wpf.Charting.UserInteractiveObject,System.Boolean) - - - - - - - Handler gets Graph segment information - - - - - Virtual method that is called when zoom or panning properties have changed. The Chart update cycle has not - been ended yet. - Implement to react to the event. - - - - - Number of axes on last SetSubnodeOwners call. - - - - - To be called as beginingn of user interactive device move and click checks / handling to cleanup states. - - - - - Mouse wheel has been scrolled. - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolar.WheelScrolled(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.LightningChart) - - - - - - - param - chart - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolar.WheelScrolled(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.LightningChart) - - - - - - - returns - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolar.WheelScrolled(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.LightningChart) - - - - - - - Zooms the view to given rectangle, defined by the axis values of the diagonal corners of the rectangle. - If the rectangle is of wrong aspect ratio, center point of the given rectangle is followed. - - Index of the axis to set the corner values in relation to. - One corner axis values. - One corner axis values. - - - - Visible views center as unit circle coordinates. - - - - - Polar chart view's base class. - - - - - Annotations list. - - - - - Polar area series list. - - - - - re-calculates the margin area and drawcenter, marks - all affected to dirty. - - - - - Call base constructor - - - - - Creates the legend box. - - - - - Create new Zoom Pan Options for Polar - - - - - Check if mouse was clicked - - - - - param - type - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolarBase.DeviceButtonClickCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean) - - - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolarBase.DeviceButtonClickCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean) - - - - - - - param - eventType - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolarBase.DeviceButtonClickCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean) - - - - - - - param - bIsOutsideGraphArea - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolarBase.DeviceButtonClickCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean) - - - - - - - param - front - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolarBase.DeviceButtonClickCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean) - - - - - - - returns - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolarBase.DeviceButtonClickCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean) - - - - - - - Virtual method to override if the class wants to handle - user interactive device down event of axis on proper time. - - Type of an object - Event - Check if device is outside or inside the Graph area - - - - param - front - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolarBase.DeviceButtonDownCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,System.Boolean) - - - - True if the event was consumed. - - - - Checks if the user interactive device up event applies to the given item. - - - - - param - type - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolarBase.DeviceButtonUpCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,System.Boolean) - - - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolarBase.DeviceButtonUpCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,System.Boolean) - - - - - - - param - eventType - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolarBase.DeviceButtonUpCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,System.Boolean) - - - - - - - param - bIsOutsideGraphArea - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolarBase.DeviceButtonUpCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,System.Boolean) - - - - - - - param - interactedObjectFirst - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolarBase.DeviceButtonUpCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,System.Boolean) - - - - - - - param - bExit - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolarBase.DeviceButtonUpCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,System.Boolean) - - - - - - - param - front - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolarBase.DeviceButtonUpCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,System.Boolean) - - - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Free DD of the zoom system. Rects etc. - - - - - Get Data Bounds in PX. - - rect defining the rectangle that fully encompasses all of the visible (non clipped) datapoints. Rect is defined in actual pixels. - - - - Getter of the ZoomPadding, supported by Round and 3D Views - ZoomPanOptions. - - Returns empty (default) value if ZoomPanOptions is not set. - - ZoomPadding of the given view, if supported. - - - - Handle user interactive device button down. - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolarBase.HandleDeviceButtonDownAction(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,Arction.Wpf.Charting.UserInteractiveObject) - - - - - - - param - bIsOutsideGraphArea - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolarBase.HandleDeviceButtonDownAction(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,Arction.Wpf.Charting.UserInteractiveObject) - - - - - - - param - item - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolarBase.HandleDeviceButtonDownAction(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,Arction.Wpf.Charting.UserInteractiveObject) - - - - - - - returns - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolarBase.HandleDeviceButtonDownAction(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,Arction.Wpf.Charting.UserInteractiveObject) - - - - - - - Handle user interactive device up event. - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolarBase.HandleDeviceButtonUpAction(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,Arction.Wpf.Charting.UserInteractiveObject) - - - - - - - param - eventType - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolarBase.HandleDeviceButtonUpAction(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,Arction.Wpf.Charting.UserInteractiveObject) - - - - - - - param - bIsOutsideGraphArea - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolarBase.HandleDeviceButtonUpAction(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,Arction.Wpf.Charting.UserInteractiveObject) - - - - - - - param - bMousedObjectFirst - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolarBase.HandleDeviceButtonUpAction(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,Arction.Wpf.Charting.UserInteractiveObject) - - - - - - - param - bExit - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolarBase.HandleDeviceButtonUpAction(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,Arction.Wpf.Charting.UserInteractiveObject) - - - - - - - param - item - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolarBase.HandleDeviceButtonUpAction(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,Arction.Wpf.Charting.UserInteractiveObject) - - - - - - - Occurs when the mouse is moved - - - - - param - type - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolarBase.HandleDeviceMoved(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,Arction.Wpf.Charting.UserInteractiveObject,System.Boolean) - - - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolarBase.HandleDeviceMoved(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,Arction.Wpf.Charting.UserInteractiveObject,System.Boolean) - - - - - - - param - bIsOutsideGraphArea - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolarBase.HandleDeviceMoved(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,Arction.Wpf.Charting.UserInteractiveObject,System.Boolean) - - - - - - - param - mibHandled - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolarBase.HandleDeviceMoved(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,Arction.Wpf.Charting.UserInteractiveObject,System.Boolean) - - - - - - - param - front - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolarBase.HandleDeviceMoved(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,Arction.Wpf.Charting.UserInteractiveObject,System.Boolean) - - - - - - - returns - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolarBase.HandleDeviceMoved(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,Arction.Wpf.Charting.UserInteractiveObject,System.Boolean) - - - - - - - Legend box. Shows description of series. - - - - - ZoomPanOptions, that contains settings for Zooming and panning and - similar operations. - - Controlled through - Can be internally requested at base classes through - - - - Polar markers. - - - - - Polar point line series list. - - - - - Sector list. - - - - - Set zoom pan options for Polar - - - - - param - value - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolarBase.SetZoomPanOptions(Arction.Wpf.Charting.Views.ViewPolar.ZoomPanOptionsPolar) - - - - - - - Convert class description to string - - String - - - - Pan of user interactive device wheel on Axis. - - - - - param - zoomIn - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolarBase.WheelPanOnAxis(System.Boolean,Arction.Wpf.Charting.Axes.AxisPolar) - - - - - - - param - axis - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolarBase.WheelPanOnAxis(System.Boolean,Arction.Wpf.Charting.Axes.AxisPolar) - - - - - - - Zoom on Axis using user interactive device wheel. - - - - - param - zoomIn - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolarBase.WheelZoomOnAxis(System.Boolean,Arction.Wpf.Charting.Axes.AxisPolar,System.Int32,System.Int32) - - - - - - - param - axis - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolarBase.WheelZoomOnAxis(System.Boolean,Arction.Wpf.Charting.Axes.AxisPolar,System.Int32,System.Int32) - - - - - - - param - iCoordX - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolarBase.WheelZoomOnAxis(System.Boolean,Arction.Wpf.Charting.Axes.AxisPolar,System.Int32,System.Int32) - - - - - - - param - iCoordY - M:Arction.Wpf.Charting.Views.ViewPolar.ViewPolarBase.WheelZoomOnAxis(System.Boolean,Arction.Wpf.Charting.Axes.AxisPolar,System.Int32,System.Int32) - - - - - - - Zoom, pan and auto-fit options. - - - - - Zoom, pan and auto-fitting options for Polar view. - - - - - Simple constructor for Form designer's list editor. - - - - - Constructor - - Parent. - - - - Device wheel action on amplitude axis. - Affects the circumference axis line rotation so that if the value is none, the rotation is disabled. - - - - - Device wheel action on circumference. - - - - - Represents a class that provides arguments for the AfterPropChanged event for round view. - - - - - typeparam - T - T:Arction.Wpf.Charting.Views.ViewRound.AfterPropChangeEventArgs`1 - - - - - - - Cancel rendering after the property change event has been handled. - - - - - New value of the property. - - - - - Old value of the property. - - - - - Represents a class that provides arguments for the BeforePanning event for round view. - - - - - - - Arction.Wpf.Charting.Views.ViewRound.BeforePanningRoundEventArgs - - - - - - - Represents a class that provides arguments for the BeforePropChange event for round view. - - - - - typeparam - T - T:Arction.Wpf.Charting.Views.ViewRound.BeforePropChangeEventArgs`1 - - - - - - - Cancel property modification. - - - - - New value. - - - - - Old value. - - - - - Represents a class that provides arguments for the BeforeZooming event for round view. - - - - - - - Arction.Wpf.Charting.Views.ViewRound.BeforeZoomingRoundEventArgs - - - - - - - LegendBox for round views. - - - - - Constructor. - - - - - Constructor. - - Parent. - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Position of the legend box in relation to rest of the chart. - - - - - Occurs when the mouse pointer moves out over the series title. - - - - - Occurs when the mouse pointer moves in over the series title. - - - - - Convert class description to string. - - Class description as a string. - - - - Units text color - - - - - Units text font. - - - - - Series value label color. - - - - - Series value label font. - - - - - The delegate to use for handlers that receive the SeriesTitleMouseMoveOverOff event. - - The object that raised the event. - Provides data for the SeriesTitleMouseMoveOverOff event. - - - - The delegate to use for handlers that receive the SeriesTitleMouseMoveOverOn event. - - The object that raised the event. - Provides data for the SeriesTitleMouseMoveOverOn event. - - - - Represents a class that provides arguments for the Panned event for round view. - - - - - - - Arction.Wpf.Charting.Views.ViewRound.PannedRoundEventArgs - - - - - - - Represents a class that provides arguments for the SeriesTitleDeviceMoved event. - - - - - Creates and initializes a new instance of SeriesTitleDeviceMovedEventArgs class. - - - - - The series over which the user interactive device pointer was moved in or out. - - - - - Base class for all round views. These are Smith -and Polar views. - - - - - Automatically size margins based on LegendBox position and size. - - - - - Panning is about to start. - - - - - Zooming is about to start. - - - - - Border Options for View. - - - - - re-calculates the margin area and drawcenter, marks - all affected to dirty. - - - - - Calculates radius in pixels for given zoom factor. - - - - - Radius in pixels. - - - - Calculates radius in pixels for given zoom factor. - - - - - - - - Radius in pixels. - - - - Virtual construction / initialization method. Called by all constructors. - - - - - Convert absolute screen coordinates to relative unit circle coordinates. - - Coords in screen space. - Use DIPs instead of pixels as parameters. - Given coordinates in relative unit circle space, with origo at the center of the circle. - - - - Convert absolute screen coordinates to relative unit circle coordinates. - The given pointfloat is modified. - - Coordinates in screen space on entry. On exit contains matching unit circle coordinates. - Use DIPs instead of pixels as parameters. - - - - Required method that creates proper legend box and sets the m_LegendBox property - - - - - Create Border - - - - - User interactive device click handler for given object types. - - - - - param - type - M:Arction.Wpf.Charting.Views.ViewRound.ViewRoundBase.DeviceButtonClickCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean) - - - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.ViewRound.ViewRoundBase.DeviceButtonClickCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean) - - - - - - - param - eventType - M:Arction.Wpf.Charting.Views.ViewRound.ViewRoundBase.DeviceButtonClickCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean) - - - - - - - param - bIsOutsideGraphArea - M:Arction.Wpf.Charting.Views.ViewRound.ViewRoundBase.DeviceButtonClickCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean) - - - - - - - param - front - M:Arction.Wpf.Charting.Views.ViewRound.ViewRoundBase.DeviceButtonClickCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean) - - - - - - - returns - M:Arction.Wpf.Charting.Views.ViewRound.ViewRoundBase.DeviceButtonClickCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean) - - - - - - - User interactive device button has been clicked. - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.ViewRound.ViewRoundBase.DeviceButtonClicked(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - param - eventType - M:Arction.Wpf.Charting.Views.ViewRound.ViewRoundBase.DeviceButtonClicked(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - param - chart - M:Arction.Wpf.Charting.Views.ViewRound.ViewRoundBase.DeviceButtonClicked(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - returns - M:Arction.Wpf.Charting.Views.ViewRound.ViewRoundBase.DeviceButtonClicked(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - Mouse button has been clicked down. - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.ViewRound.ViewRoundBase.DeviceButtonDown(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - param - eventType - M:Arction.Wpf.Charting.Views.ViewRound.ViewRoundBase.DeviceButtonDown(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - param - chart - M:Arction.Wpf.Charting.Views.ViewRound.ViewRoundBase.DeviceButtonDown(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - returns - M:Arction.Wpf.Charting.Views.ViewRound.ViewRoundBase.DeviceButtonDown(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - Virtual method to override if the class wants to handle - mouse down event of axis on proper time. - - - - - param - type - M:Arction.Wpf.Charting.Views.ViewRound.ViewRoundBase.DeviceButtonDownCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,System.Boolean) - - - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.ViewRound.ViewRoundBase.DeviceButtonDownCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,System.Boolean) - - - - - - - param - bIsOutsideGraphArea - M:Arction.Wpf.Charting.Views.ViewRound.ViewRoundBase.DeviceButtonDownCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,System.Boolean) - - - - Determines if the object is considered being in front or in back. - Actual meaning differs between ObjectTypes - True if the event was consumed. - - - - Mouse button has been released. - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.ViewRound.ViewRoundBase.DeviceButtonUp(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - param - eventType - M:Arction.Wpf.Charting.Views.ViewRound.ViewRoundBase.DeviceButtonUp(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - param - chart - M:Arction.Wpf.Charting.Views.ViewRound.ViewRoundBase.DeviceButtonUp(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - returns - M:Arction.Wpf.Charting.Views.ViewRound.ViewRoundBase.DeviceButtonUp(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - Checks if the user interactive device up event applies to the given item. - - - - - param - type - M:Arction.Wpf.Charting.Views.ViewRound.ViewRoundBase.DeviceButtonUpCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,System.Boolean) - - - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.ViewRound.ViewRoundBase.DeviceButtonUpCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,System.Boolean) - - - - - - - param - eventType - M:Arction.Wpf.Charting.Views.ViewRound.ViewRoundBase.DeviceButtonUpCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,System.Boolean) - - - - - - - param - bIsOutsideGraphArea - M:Arction.Wpf.Charting.Views.ViewRound.ViewRoundBase.DeviceButtonUpCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,System.Boolean) - - - - - - - param - interactedObjectFirst - M:Arction.Wpf.Charting.Views.ViewRound.ViewRoundBase.DeviceButtonUpCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,System.Boolean) - - - - - - - param - bExit - M:Arction.Wpf.Charting.Views.ViewRound.ViewRoundBase.DeviceButtonUpCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,System.Boolean) - - - - - - - param - front - M:Arction.Wpf.Charting.Views.ViewRound.ViewRoundBase.DeviceButtonUpCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,System.Boolean) - - - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Event launcher for zoom scale changes. Called after the zooming. - Suits like this for polar, override for smith - - Old zoom scale - True if rendering frame should be stopped. - - - - Event launcher for zoom center changes. - Suits like this for polar, override for smith - - New zoom center as UC - True if zoom was successful. False if canceled. - - - - Event launcher for zoom scale changes. Called before the zooming. - Suits like this for polar, override for smith - - New zoom scale - True if value change is ok, false if zoom should not happen. - - - - Event launcher for zoom center changes. Called after the pan. - Suits like this for polar, override for smith - - Old center as UC - True if rendering should be canceled. - - - - Fixes aspect ratio to match the view aspect ratio. - Keeps X,Y coords if Center property is false (default), - negative sizes allowed (suggested in some cases). - Does not reduce the rect size, only increases it. - - If true, keep the rect center in place. - Otherwise the X/Y is kept in place (which is not necessarily - the left/top) - Increases the size same amount on both directions. - - - - Free marker draw data. - - - - - param - creatingDeviceOrDisposing - M:Arction.Wpf.Charting.Views.ViewRound.ViewRoundBase.FreeMarkersDrawData(System.Boolean) - - - - - - - Free DD of the zoom system. Rects etc. - - - - - Get Smith or Polar charts outer diameter and center point in screen coordinates. - - Diameter (2 * radius). - Center point X. - Center point Y. - True if successfully resolved. - - - - Getter of the bounds of the data in screen pixels (zoomed) for - determination of the correct scale and center offset for the zooming - so that all data is fit to view. - - Bounding box of the data in screen coordinates. - - - - Handle user interactive device up event. - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.ViewRound.ViewRoundBase.HandleDeviceButtonUpAction(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,Arction.Wpf.Charting.UserInteractiveObject) - - - - - - - param - eventType - M:Arction.Wpf.Charting.Views.ViewRound.ViewRoundBase.HandleDeviceButtonUpAction(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,Arction.Wpf.Charting.UserInteractiveObject) - - - - - - - param - bIsOutsideGraphArea - M:Arction.Wpf.Charting.Views.ViewRound.ViewRoundBase.HandleDeviceButtonUpAction(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,Arction.Wpf.Charting.UserInteractiveObject) - - - - - - - param - bMousedObjectFirst - M:Arction.Wpf.Charting.Views.ViewRound.ViewRoundBase.HandleDeviceButtonUpAction(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,Arction.Wpf.Charting.UserInteractiveObject) - - - - - - - param - bExit - M:Arction.Wpf.Charting.Views.ViewRound.ViewRoundBase.HandleDeviceButtonUpAction(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,Arction.Wpf.Charting.UserInteractiveObject) - - - - - - - param - item - M:Arction.Wpf.Charting.Views.ViewRound.ViewRoundBase.HandleDeviceButtonUpAction(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,Arction.Wpf.Charting.UserInteractiveObject) - - - - - - - Handles user interactive device move events of the given type. - - - - - param - type - M:Arction.Wpf.Charting.Views.ViewRound.ViewRoundBase.HandleDeviceMoved(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,Arction.Wpf.Charting.UserInteractiveObject,System.Boolean) - - - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.ViewRound.ViewRoundBase.HandleDeviceMoved(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,Arction.Wpf.Charting.UserInteractiveObject,System.Boolean) - - - - - - - param - bIsOutsideGraphArea - M:Arction.Wpf.Charting.Views.ViewRound.ViewRoundBase.HandleDeviceMoved(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,Arction.Wpf.Charting.UserInteractiveObject,System.Boolean) - - - - - - - param - mibHandled - M:Arction.Wpf.Charting.Views.ViewRound.ViewRoundBase.HandleDeviceMoved(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,Arction.Wpf.Charting.UserInteractiveObject,System.Boolean) - - - - - - - param - front - M:Arction.Wpf.Charting.Views.ViewRound.ViewRoundBase.HandleDeviceMoved(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,Arction.Wpf.Charting.UserInteractiveObject,System.Boolean) - - - - - - - returns - M:Arction.Wpf.Charting.Views.ViewRound.ViewRoundBase.HandleDeviceMoved(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,Arction.Wpf.Charting.UserInteractiveObject,System.Boolean) - - - - - - - Virtual method that is called when zoom or panning properties have changed or engine changed or margins changed or ... The Chart update cycle has not - been ended yet. - - - - - Marks if the content mask is dirty. - - - - - Marks if the view contains changed content and if it should be re-rendered. - - - - - (m_OuterDiameter/2)^2 for calculations optimizations - - - - - Unscaled / natural diameter of the view in PX. - Updated on view size changes. - - - - - Center of the view in UnitCircle coordinates in relation to the - circle center. - User controlled property that the user can use to position the view. - - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Panning has ended. - - - - - Check if position is over circular graph area. Meaning if it's inside the radius of the chart. - - Position - - - - returns - M:Arction.Wpf.Charting.Views.ViewRound.ViewRoundBase.PositionOverGraph(Arction.Wpf.Charting.CoordXY) - - - - - - - Set LegendBox - - - - - param - value - M:Arction.Wpf.Charting.Views.ViewRound.ViewRoundBase.SetLegendBox(Arction.Wpf.Charting.Views.ViewRound.LegendBoxRound) - - - - - - - Setter of the Zoom center in UC coords. - Emits corresponding zoom events if allowed. - - New center of the view in UC coords. - If true, emits events that the user can use to cancel rendering or prevent the zoom operation. - True if zoom center changed - - - - Setter of the m_ZoomFactor. - Emits corresponding zoom events if allowed. - - New Zoom scale to be set. - If true, emits events that the user can use to cancel rendering or prevent the zoom operation. - True if Zoom scale changed - - - - Convert class description to string - - String - - - - Convert relative unit circle coordinates to absolute screen coordinates. - - Unit circle coordinates to convert. - Use DIPs instead of pixels as parameters. - Absolute screen coordinates matching the given parameter. - - - - Convert relative unit circle coordinates to absolute screen coordinates. - The given pointfloat is modified. - - Screen coordinates to convert into unit circle coordinates. - Use DIPs instead of pixels as parameters. - - - - Convert relative unit circle coordinates to absolute screen coordinates. - - Unit circle coordinates to convert. - Use DIPs instead of pixels as parameters. - Absolute screen coordinates matching the given parameter. - - - - To be called as beginning of mouse move and mouse click checks / handling to cleanup states. - - - - - User interactive device has been moved. - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.ViewRound.ViewRoundBase.UserInteractiveDeviceMoved(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - param - eventType - M:Arction.Wpf.Charting.Views.ViewRound.ViewRoundBase.UserInteractiveDeviceMoved(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - param - chart - M:Arction.Wpf.Charting.Views.ViewRound.ViewRoundBase.UserInteractiveDeviceMoved(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - returns - M:Arction.Wpf.Charting.Views.ViewRound.ViewRoundBase.UserInteractiveDeviceMoved(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - Mouse wheel has been scrolled. - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.ViewRound.ViewRoundBase.WheelScrolled(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.LightningChart) - - - - - - - param - chart - M:Arction.Wpf.Charting.Views.ViewRound.ViewRoundBase.WheelScrolled(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.LightningChart) - - - - - - - returns - M:Arction.Wpf.Charting.Views.ViewRound.ViewRoundBase.WheelScrolled(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.LightningChart) - - - - - - - Zoom the chart in or out. - If stop point X is greater than start point X, zooms in. - If stop point X is less than start point X action follows RightToLeftZoom property. - - Zoom start point X. - Zoom start point Y. - Zoom stop point X. - Zoom stop point Y. - - - - Zoom by given factor and around given view center as DIP or screen coordinates. - - Screen coordinates of the new center point [default input in DIPs] - Factor to modify the zoom scale by. - Defines if the input value is in DIP or PX - - - - Reacts to changes in ZoomCenter property, updates drawing center - quietly from zoom center. - - - - - Zooming has ended. - - - - - Current zooming scale. - 1 is the default zoom that shows the circle at it's maximum size - so that it just fills the view area reduced by the margins. - - - - - Zooms the view so that the data is visible at maximum possible size. - - Area is either the full drawing area inside - or are further limited by , depending - on case. For more information, see options at . - - - - - param - zoomArea - M:Arction.Wpf.Charting.Views.ViewRound.ViewRoundBase.ZoomToFit(Arction.Wpf.Charting.ZoomAreaRound) - - - - - - - Zooms the round view so that labels area is fitted to area inside - . - - Publicly accessible via method and - . - - - - - The delegate to use for handlers that receive the BeforePanning event. - - - Provides data for the BeforePanning event. - - - - The delegate to use for handlers that receive the BeforeZooming event. - - - Provides data for the BeforeZooming event. - - - - The delegate to use for handlers that receive the Panned event. - - - Provides data for the Panned event. - - - - The delegate to use for handlers that receive the Zoomed event. - - - Provides data for the Zoomed event. - - - - Represents a class that provides arguments for the Zoomed event for round view. - - - - - - - Arction.Wpf.Charting.Views.ViewRound.ZoomedRoundEventArgs - - - - - - - Zoom, pan and auto-fitting options for Smith -and Polar views - - - - - Simple constructor for Form designer's list editor. - - - - - Constructor - - Parent. - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Zooms around zooming rectangle center point. - - - - - Right-to-left zoom action. - - - - - Device wheel zooming is allowed or not. - - - - - Padding affecting zooming operations. The empty space left between the zoom area and the margins. - - - - - Represents a class that provides arguments for the BeforePanning event for round view. - - - - - - - Arction.Wpf.Charting.Views.ViewSmith.BeforePanningSmithEventArgs - - - - - - - LegendBox for smith series. - - - - - Constructor. - - - - - Constructor. - - Parent. - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Convert class description to string. - - Class description as a string. - - - - Represents a class that provides arguments for the Panned event for round view. - - - - - - - Arction.Wpf.Charting.Views.ViewSmith.PannedSmithEventArgs - - - - - - - ViewSmith - - - - - - - Arction.Wpf.Charting.Views.ViewSmith.ViewSmith - - - - - - - - - Arction.Wpf.Charting.Views.ViewSmith.ViewSmith - - - - - - - param - owner - M:Arction.Wpf.Charting.Views.ViewSmith.ViewSmith.#ctor(Arction.Wpf.Charting.LightningChart) - - - - - - - Smith axis. - - - - - Panning is about to start. - - - - - Calculates radius in pixels for given zoom factor. - - - - - Radius in pixels. - - - - One time initialization method, called from all constructors. - - - - - Check if user interactive device button was clicked. - - - - - param - type - M:Arction.Wpf.Charting.Views.ViewSmith.ViewSmith.DeviceButtonClickCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean) - - - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.ViewSmith.ViewSmith.DeviceButtonClickCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean) - - - - - - - param - eventType - M:Arction.Wpf.Charting.Views.ViewSmith.ViewSmith.DeviceButtonClickCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean) - - - - - - - param - bIsOutsideGraphArea - M:Arction.Wpf.Charting.Views.ViewSmith.ViewSmith.DeviceButtonClickCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean) - - - - - - - param - Front - M:Arction.Wpf.Charting.Views.ViewSmith.ViewSmith.DeviceButtonClickCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean) - - - - - - - returns - M:Arction.Wpf.Charting.Views.ViewSmith.ViewSmith.DeviceButtonClickCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean) - - - - - - - Virtual method to override if the class wants to handle - user interactive device button down event of axis on proper time. - - - - - param - type - M:Arction.Wpf.Charting.Views.ViewSmith.ViewSmith.DeviceButtonDownCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,System.Boolean) - - - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.ViewSmith.ViewSmith.DeviceButtonDownCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,System.Boolean) - - - - - - - param - bIsOutsideGraphArea - M:Arction.Wpf.Charting.Views.ViewSmith.ViewSmith.DeviceButtonDownCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,System.Boolean) - - - - - - - param - front - M:Arction.Wpf.Charting.Views.ViewSmith.ViewSmith.DeviceButtonDownCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,System.Boolean) - - - - True if the event was consumed. - - - - Checks if the user interactive device button up event applies to the given item. - - - - - param - type - M:Arction.Wpf.Charting.Views.ViewSmith.ViewSmith.DeviceButtonUpCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,System.Boolean) - - - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.ViewSmith.ViewSmith.DeviceButtonUpCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,System.Boolean) - - - - - - - param - eventType - M:Arction.Wpf.Charting.Views.ViewSmith.ViewSmith.DeviceButtonUpCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,System.Boolean) - - - - - - - param - bIsOutsideGraphArea - M:Arction.Wpf.Charting.Views.ViewSmith.ViewSmith.DeviceButtonUpCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,System.Boolean) - - - - - - - param - bMousedObjectFirst - M:Arction.Wpf.Charting.Views.ViewSmith.ViewSmith.DeviceButtonUpCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,System.Boolean) - - - - - - - param - bExit - M:Arction.Wpf.Charting.Views.ViewSmith.ViewSmith.DeviceButtonUpCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,System.Boolean) - - - - - - - param - front - M:Arction.Wpf.Charting.Views.ViewSmith.ViewSmith.DeviceButtonUpCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,System.Boolean) - - - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Event launcher for zoom events. - - - - - param - newCenter - M:Arction.Wpf.Charting.Views.ViewSmith.ViewSmith.FireBeforePanningEvent(Arction.Wpf.Charting.PointUnitCircle) - - - - - - - returns - M:Arction.Wpf.Charting.Views.ViewSmith.ViewSmith.FireBeforePanningEvent(Arction.Wpf.Charting.PointUnitCircle) - - - - - - - Called after successful panning. Launches the after event. - - - - - param - oldCenter - M:Arction.Wpf.Charting.Views.ViewSmith.ViewSmith.FirePannedEvent(Arction.Wpf.Charting.PointUnitCircle) - - - - - - - returns - M:Arction.Wpf.Charting.Views.ViewSmith.ViewSmith.FirePannedEvent(Arction.Wpf.Charting.PointUnitCircle) - - - - - - - Getter of the bounding box for the series data in PX. - - - - - returns - M:Arction.Wpf.Charting.Views.ViewSmith.ViewSmith.GetDataBounds - - - - - - - Getter of the current views top-left and bottom-right corner axis values. - - Views top-left corner axis values. - Views bottom-right corner axis values. - - - - Getter of the current views top-left, bottom-left, top-right and bottom-right corner axis values. - - Views top-left corner axis values. - Views top-right corner axis values. - Views bottom-right corner axis values. - Views bottom-left corner axis values. - - - - Handler for the user interactive device movements. - - - - - param - type - M:Arction.Wpf.Charting.Views.ViewSmith.ViewSmith.HandleDeviceMoved(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,Arction.Wpf.Charting.UserInteractiveObject,System.Boolean) - - - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.ViewSmith.ViewSmith.HandleDeviceMoved(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,Arction.Wpf.Charting.UserInteractiveObject,System.Boolean) - - - - - - - param - bIsOutsideGraphArea - M:Arction.Wpf.Charting.Views.ViewSmith.ViewSmith.HandleDeviceMoved(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,Arction.Wpf.Charting.UserInteractiveObject,System.Boolean) - - - - - - - param - mibHandled - M:Arction.Wpf.Charting.Views.ViewSmith.ViewSmith.HandleDeviceMoved(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,Arction.Wpf.Charting.UserInteractiveObject,System.Boolean) - - - - - - - param - front - M:Arction.Wpf.Charting.Views.ViewSmith.ViewSmith.HandleDeviceMoved(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,Arction.Wpf.Charting.UserInteractiveObject,System.Boolean) - - - - - - - returns - M:Arction.Wpf.Charting.Views.ViewSmith.ViewSmith.HandleDeviceMoved(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,Arction.Wpf.Charting.UserInteractiveObject,System.Boolean) - - - - - - - Handler gets Graph segment information - - - - - Virtual method that is called when zoom or panning properties have changed. The Chart update cycle has not - been ended yet. - Implement to react to the event. - - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Panning has ended. - - - - - User interactive device has been moved. - - - - - Zooms the view to given rectangle, defined by the axis values of the diagonal corners of the rectangle. - If the rectangle is of wrong aspect ratio, center point of the given rectangle is followed. - - One corner axis values. - One corner axis values. - - - - View center coordinates. - - - - - Reacts to changes in the base ZoomCenter (UC) property, - updates local Smith zoom center. - To be called each time the ZoomCenter is modified or modification - is detected in the base class. - - - - - The delegate to use for handlers that receive the BeforePanning event. - - - Provides data for the BeforePanning event. - - - - The delegate to use for handlers that receive the Panned event. - - - Provides data for the Panned event. - - - - Smith chart view's base class. - - - - - Annotations list. - - - - - re-calculates the margin area and drawcenter, marks - all affected to dirty. - - - - - Constructor calls base constructor - - - - - Create new Legend Box form Smith Chart - - - - - Create new Zoom Pan Options - - - - - Check if user interactive device button was clicked. - - - - - param - type - M:Arction.Wpf.Charting.Views.ViewSmith.ViewSmithBase.DeviceButtonClickCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean) - - - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.ViewSmith.ViewSmithBase.DeviceButtonClickCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean) - - - - - - - param - eventType - M:Arction.Wpf.Charting.Views.ViewSmith.ViewSmithBase.DeviceButtonClickCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean) - - - - - - - param - bIsOutsideGraphArea - M:Arction.Wpf.Charting.Views.ViewSmith.ViewSmithBase.DeviceButtonClickCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean) - - - - - - - param - front - M:Arction.Wpf.Charting.Views.ViewSmith.ViewSmithBase.DeviceButtonClickCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean) - - - - - - - returns - M:Arction.Wpf.Charting.Views.ViewSmith.ViewSmithBase.DeviceButtonClickCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean) - - - - - - - Virtual method to override if the class wants to handle - user interactive device button down event of axis on proper time. - - - - - param - type - M:Arction.Wpf.Charting.Views.ViewSmith.ViewSmithBase.DeviceButtonDownCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,System.Boolean) - - - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.ViewSmith.ViewSmithBase.DeviceButtonDownCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,System.Boolean) - - - - - - - param - bIsOutsideGraphArea - M:Arction.Wpf.Charting.Views.ViewSmith.ViewSmithBase.DeviceButtonDownCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,System.Boolean) - - - - - - - param - front - M:Arction.Wpf.Charting.Views.ViewSmith.ViewSmithBase.DeviceButtonDownCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,System.Boolean) - - - - True if the event was consumed. - - - - Checks if the user interactive device button up event applies to the given item. - - - - - param - type - M:Arction.Wpf.Charting.Views.ViewSmith.ViewSmithBase.DeviceButtonUpCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,System.Boolean) - - - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.ViewSmith.ViewSmithBase.DeviceButtonUpCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,System.Boolean) - - - - - - - param - eventType - M:Arction.Wpf.Charting.Views.ViewSmith.ViewSmithBase.DeviceButtonUpCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,System.Boolean) - - - - - - - param - bIsOutsideGraphArea - M:Arction.Wpf.Charting.Views.ViewSmith.ViewSmithBase.DeviceButtonUpCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,System.Boolean) - - - - - - - param - bMousedObjectFirst - M:Arction.Wpf.Charting.Views.ViewSmith.ViewSmithBase.DeviceButtonUpCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,System.Boolean) - - - - - - - param - bExit - M:Arction.Wpf.Charting.Views.ViewSmith.ViewSmithBase.DeviceButtonUpCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,System.Boolean) - - - - - - - param - front - M:Arction.Wpf.Charting.Views.ViewSmith.ViewSmithBase.DeviceButtonUpCheck(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,System.Boolean) - - - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Free DD of the zoom system. Rects etc. - - - - - Getter of the ZoomPadding, supported by Round and 3D Views - ZoomPanOptions. - - Returns empty (default) value if ZoomPanOptions is not set. - - ZoomPadding of the given view, if supported. - - - - Occurs when the mouse is moved - - - - - param - type - M:Arction.Wpf.Charting.Views.ViewSmith.ViewSmithBase.HandleDeviceMoved(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,Arction.Wpf.Charting.UserInteractiveObject,System.Boolean) - - - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.ViewSmith.ViewSmithBase.HandleDeviceMoved(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,Arction.Wpf.Charting.UserInteractiveObject,System.Boolean) - - - - - - - param - bIsOutsideGraphArea - M:Arction.Wpf.Charting.Views.ViewSmith.ViewSmithBase.HandleDeviceMoved(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,Arction.Wpf.Charting.UserInteractiveObject,System.Boolean) - - - - - - - param - mibHandled - M:Arction.Wpf.Charting.Views.ViewSmith.ViewSmithBase.HandleDeviceMoved(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,Arction.Wpf.Charting.UserInteractiveObject,System.Boolean) - - - - - - - param - front - M:Arction.Wpf.Charting.Views.ViewSmith.ViewSmithBase.HandleDeviceMoved(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,Arction.Wpf.Charting.UserInteractiveObject,System.Boolean) - - - - - - - returns - M:Arction.Wpf.Charting.Views.ViewSmith.ViewSmithBase.HandleDeviceMoved(Arction.Wpf.Charting.Views.View2D.ObjectType,Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,System.Boolean,Arction.Wpf.Charting.UserInteractiveObject,System.Boolean) - - - - - - - Legend box. Shows description of series - - - - - ZoomPanOptions, that contains settings for Zooming and panning and - similar operations. - - Controlled through - Can be internally requested at base classes through - - - - Smith markers - - - - - Smith point line series. - - - - - Set zoom pan options for smith - - - - - param - value - M:Arction.Wpf.Charting.Views.ViewSmith.ViewSmithBase.SetZoomPanOptions(Arction.Wpf.Charting.Views.ViewSmith.ZoomPanOptionsSmith) - - - - - - - Convert class description to string. - - Class description as a string. - - - - Zoom, pan and auto-fit options - - - - - Zoom, pan and auto-fitting options for Smith view - - - - - Zoom Pan Options for Smith - - - - - Zoom Pan Options for Smith - - - - - param - owner - M:Arction.Wpf.Charting.Views.ViewSmith.ZoomPanOptionsSmith.#ctor(Arction.Wpf.Charting.Views.ViewSmith.ViewSmithBase) - - - - - - - Aspect ratio options for ViewXY. - - - - - Constructor. - - - - - Constructor. - - Parent. - - - - Aspect ratio. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Manual aspect ratio, width / height. - - - - - Convert class description to string. - - Class description as a string. - - - - Aspect ratio x-axis index. - - - - - Aspect ratio y-axis index. - - - - - Automatic titles placement. - - - - - Constructor. - - - - - Constructor. - - Parent. - - - - Calculate title locations. - - - - - Enable auto location with maximum distance calculation. If not applied, speeds things up a bit. - - - - - Enable checking of label overlap with series data. Disabling this increases performance, but decreases quality. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Enable automatic series title placement. - - - - - Maximum number of candidate locations for title. Reducing this would result faster location calculation. - - - - - OnDeserialized is called just after the object has been deserialized. - - Context - - - - Reset autolabeling. - - - - - Enable crossing point search. Disabling this increases performance, but decreases quality, if data seems to overlap visually. - - - - - Convert class description to string. - - Class description as a string. - - - - Use series title locations as shown on form. May cause minor overlapping. - - - - - Auto Y scale fit options class. - - - - - Constructor for Form editor. - - - - - Constructor. - - Parent. - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Is automatic Y fitting enabled - - - - - Margin in percents of min...max range. - Using some margin leaves a gap between series and axis minimum and maximum values. - - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - If this is set, auto Y fit is done for all Y axes. - If this is not set, auto Y fit targets only Y axes having AllowAutoYFit true. - - - - - By using thorough detect method, all series point in visible X range are searched, resulting to - accurate fitting, but with cost of extra CPU load. - If the detection is not thorough, fitting is not always accurate in real-time monitoring usage. - - - - - Convert class description to string. - - Class description as a string. - - - - Auto Y scale update interval in milliseconds - - - - - Axis layout. - - - - - Constructor. - - - - - Constructor. - - Parent. - - - - Auto adjust axis gap. - - - - - Calculate margins automatically. - - - - - Automatically shrink segments gap so that all segments can fit in graph. - - - - - Axis grid strip. - - - - - Dispose Layout - - - - - Arction.Wpf.Charting.Views.ViewXY.AxisLayout - - - - - - - Grid visibility order. Note each axis has individual controls for major and minor grid visibility, color, line style etc. - - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Y-axis segment list. Used, when axis layout is segmented. - - - - - When stacked or segmented view is defined and there's more than one Y-axis defined, - this is the gap in pixels between graph segments. - - - - - Converts object to string representation. - - Object as a string. - - - - X-axes auto placement. - - - - - Place X-axis title automatically. If enabled overwrites X-axis' Title and Units two properties: VerticalAlign and DistanceToAxis. - - - - - X-grid strip fill axis index. - - - - - Y-axis mode, when there's several Y-axes defined - - - - - Y-axes auto placement. - - - - - Place Y-axis title automatically. If enabled overwrites Y-axis' Title and Units two properties: HorizontalAlign and DistanceToAxis. - - - - - Y-grid fill strip axis index. - Only applies when YAxesLayout is 'Layered'. In 'Stacked', each axis has an own vertical space and strips applied to that space only. - - - - Bar view options. - - - - - Constructor for Form editor. - - - - - Constructor. - - Parent. - - - - Space between bars in same group, in pixels - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Grouping of the bars - - - - - Distance from bar group to bar group in pixels. - - - - - Distance from bar edge to graph edge in pixels. - It is used on left and right sides. - - - - - Keep base level in axis minimum. - - - - - Gets or sets the orientation of bars (horizontal or vertical). - - - - - Stacking of bars of different series, that have same index or X value. - - - - - Stack sum. The series values amongst different series are stacked - and stretched to make this sum. - - - - - Convert class description to string. - - Class description as a string. - - - - Represents a class that provides arguments for the BeforePanning event for XY view. - - - - - Creates and initializes a new instance of BeforePanningXYEventArgs class. - - - - - Cancel zooming. - - - - - X-axis range change information. - - - - - Y-axis range change information. - - - - - Represents a class that provides arguments for the BeforeZooming event for XY view. - - - - - Creates and initializes a new instance of BeforeZoomingXYEventArgs class. - - - - - Zooming is done by mouse wheel. - - - - - Cancel zooming. - - - - - X-axis range change information. - - - - - Y-axis range change information. - - - - - Error bar settings. - - - - - Constructor. - - - - - Constructor. - - - - - param - owner - M:Arction.Wpf.Charting.Views.ViewXY.ErrorBarSettings.#ctor(Arction.Wpf.Charting.IChartNode) - - - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - End length - - - - - Show X error. - - - - - Show Y error. - - - - - Convert class description to string - - String - - - - X color - - - - - X thickness - - - - - Y color - - - - - Y thickness - - - - - LegendBox shows the series names and line/point styles in a box. - - - - - Constructor for Form editor. - - - - - Constructor. - - Parent. - - - - LegendBox alignment between Segments. - - - - - LegendBox vertical alignment. Align LegendBoxes rendered on top by given edge. - - - - - Items categorization - - - - - Category title color - - - - - Category font - - - - - Create offset. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Intensity scales. - - - - - Position - - - - - LegendBox Segment index. Tells in which Segment the LegendBox should be drawn. - - - - - Occurs when the mouse pointer moves out over the series title. - - - - - Occurs when the mouse pointer moves in over the series title. - - - - - Convert class description to string. - - Class description as a string. - - - - The delegate to use for handlers that receive the SeriesTitleMouseMoveOverOff event. - - The object that raised the event. - Provides data for the SeriesTitleMouseMoveOverOff event. - - - - The delegate to use for handlers that receive the SeriesTitleMouseMoveOverOn event. - - The object that raised the event. - Provides data for the SeriesTitleMouseMoveOverOn event. - - - - Line series cursor allows tracking and evaluating line series values - - - - - Simple constructor for Form designer's list editor. - - - - - Constructor. - - Parent. - x-axis - - - - Index of X-axis assigned to this cursor. - - - - - Is cursor behind series or front. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Full cursor height. If true, the cursor height will be the height of the control. - If false, the cursor is vertically painted in the graph area only. - - - - - Grab padding is used to widen the active area. The area is widened on both sides the specified amount. - - - - - Use cursor and dataseries colors or just cursor color for haircross. - - - - - When Cursor style is set to 'TrackSeries', and multiple series values hit on same - cursor X position, adjusts series tracking horizontal line height to match the minimum - and maximum value on current cursor position. - - - - - Is position over item. - - x-coordinate - y-coordinate - Use DIP instead of pixels as parameters - true if position is over item, false otherwise - - - - Line style. - - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Owner view - - - - - Cursor position on X-axis has changed. - - - - - Set proper cursor. Default for dragging is VSplit. - - - - - When moving the cursor, jumps the cursor to nearest series point. - - - - - Override LineSeriesCursor's Y-value solving/tracking method. Func (predefined generic) delegate type can be used with an anonymous method or lambda expression. - Input parameter is series, which implements ITrackable interface. Output parameter is LineSeriesCoordinateSolveResult struct. - - - - - Cursor style. - - - - - Draw haircross horizontal line as 1px width, otherwise as wide as vertical. - - - - - Convert class description to string. - - Class description as a string. - - - - Predicate to determine if the cursor should draw/resolve TrackPoint for a series implementing ITrackable interface. - - - - - Tracking point style. Applies only when Style is set to PointTrack. - - - - - X-value. - - - - - Is cursor visible or not - - - - - The delegate to use for handlers that receive the PositionChanged event. - - - Provides data for the PositionChanged event. - - - - Miniscale represents a miniature axes equivalent. Miniscales can't be used with logarithmic scales. - - - - - Simple constructor for Form designer's list editor. - - - - - Constructor. - - Parent. - - - - Color - - - - - Y line direction - - - - - Clean up any resources being used. - - True if managed resources should be disposed, otherwise false. - - - - Horizontal alignment - - - - - X dimension label style - - - - - Y dimension label style - - - - - Offset from position set by HorizontalAlign and VerticalAlign - - - - - Preferred size. The control tries to adjust its size near to this, while displaying user friendly dimension values. - - - - - Show X dimension - - - - - Show Y dimension - - - - - Dimension lines thickness - - - - - Convert class description to string. - - Class description as a string. - - - - Vertical alignment - - - - - Is miniscale visible or not - - - - - Represents a class that provides arguments for the Panned event for XY view. - - - - - Creates and initializes a new instance of PannedXYEventArgs class. - - - - - X-axis range information. - - - - - Y-axis range information. - - - - - Persistent series rendering intensity layer. - Like PersistentSeriesRenderingLayer, but with palette coloring by hit count. - - - - - Constructor - - Owner view - X axis, whose series will be used in this layer - - - - Clears the rendering layer and sets all intensity values to 0. - - - - - Create palette. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Current layer data intensity factor. Typically, keep 0.5 to 1.0 - - - - - LegendBox value format. - - - - - Value type: time, numeric or coordinates. Affects legend box value formatting. - - - - - New trace intensity. Follows scale defined in ValueRangePalette - - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Renders list of given series into the layer, in one batch. - - List of series to render - - - - returns - M:Arction.Wpf.Charting.Views.ViewXY.PersistentSeriesRenderingIntensityLayer.RenderSeries(System.Collections.Generic.List{Arction.Wpf.Charting.SeriesXY.PointLineSeriesBase}) - - - - - - - Show text in legend box. - - - - - Layer title. - - - - - Units text. - - - - - Color palette for value information - - - - - Persistent series rendering layer. Series can be rendered in a bitmap layer and the actual series freed. - Saves a lot of memory, CPU and GPU resources, especially when rendering hundreds or thousands of series. - The layer itself is rendered in the chart just before line series objects. - - - - - Constructor - - Owner view - X axis, whose series will be used in this layer - - - - Clears the rendering layer and sets the size to size of the chart control. - Sets all data transparent (ARGB=0,255,255,255). - - - - - Clears the rendering layer. Sets all data to given color. - - Color - - - - Allows decaying or bringing the layer more visible. - - Multiply factor - - - - Renders list of given series into the layer, in one batch. Faster than calling RenderSeries many times. - - List of series to render - - - - returns - M:Arction.Wpf.Charting.Views.ViewXY.PersistentSeriesRenderingLayer.RenderSeries(System.Collections.Generic.List{Arction.Wpf.Charting.SeriesXY.PointLineSeriesBase}) - - - - - - - Base class for persistent series rendering layers. - - - - - Simple constructor for Form designer's list editor. - - - - - Constructor. - - Owner view. - X-axis, whose series will be used in this layer. - - - - Anti-aliasing. Works also if the GPU doesn't support anti-aliasing in hardware. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Clears the rendering layer. Sets all data to given color. - - Color - - - - OnDeserialized is called just after the object has been deserialized - - Context - - - - Renders the given series into the layer. - - Series to render. - - - - returns - M:Arction.Wpf.Charting.Views.ViewXY.PersistentSeriesRenderingLayerBase.RenderSeries(Arction.Wpf.Charting.SeriesXY.PointLineSeriesBase) - - - - - - - Represents a class that provides arguments for the PositionChanged event. - - - - - Creates and initializes a new instance of PositionChangedEventArgs class. - - - - - If you update the chart in the event handler, set to true to prevent flickering. - - - - - Cursor. - - - - - New value on X-axis. - - - - - View rendering options. - - - - - Simple constructor for Form designer's list editor. - - - - - Constructor. - - Parent. - - - - Clean up any resources being used. - - True if managed resources should be disposed, otherwise false. - - - - Compress GDI line series data. - - - - - Line series enhanced anti-aliasing. - - - - - Convert class description to string. - - Class description as a string. - - - - Represents a class that provides arguments for the SeriesTitleDeviceMoved event. - - - - - Creates and initializes a new instance of SeriesTitleDeviceMovedEventArgs class. - - - - - The series over which the mouse pointer was moved in or out. - - - - - Border rendered around graph area - - - - - Constructor for Form editor/xaml - - - - - Constructor - - View owner - - - - Boolean for viewXY if border renders behind axes (true) - - - - - XY graph view. Allows super-fast drawing of lines and bars. - - - - - Constructor. - - - - - Constructor. - - - - - param - owner - M:Arction.Wpf.Charting.Views.ViewXY.ViewXY.#ctor(Arction.Wpf.Charting.LightningChart) - - - - - - - Annotations - - - - - Area series list - - - - - Determine if graph margins or space between Segments is automatically calculated due LegendBoxes. - - - - - Axis layout - - - - - Band list - - - - - Bar series list - - - - - Bar view options for Bar series - - - - - Panning is about to start. - - - - - Zooming is about to start. - - - - - Border Options for ViewXY - - - - - Calculate minimum and maximum cordinates from user interactive device location. - - Zoom start mouse position X coordinate. - Zoom stop mouse position X coordinate. - Zoom start mouse position Y coordinate. - Zoom stop mouse position Y coordinate. - X-minimum coordinate based on zoom mode. - X-maximum coordinate based on zoom mode. - Y-minimum coordinate based on zoom mode. - Y-maximum coordinate based on zoom mode. - - - - returns - M:Arction.Wpf.Charting.Views.ViewXY.ViewXY.CalculateMinMaxCoordinatesFromUserInteractiveDeviceLocation(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32@,System.Int32@,System.Int32@,System.Int32@) - - - - - - - Cancel rectangle zooming. - - - - - Chart event markers - - - - - Clear zoom stack. - - - - - Constant line list - - - - - Create default LegendBox and add to list of LegendBoxes. - - - - - returns - M:Arction.Wpf.Charting.Views.ViewXY.ViewXY.CreateDefaultLegendBoxes - - - - - - - Create default X-Axis and add to list of X-axes. - - - - - returns - M:Arction.Wpf.Charting.Views.ViewXY.ViewXY.CreateDefaultXAxes - - - - - - - Create default Y-Axis and add to list of Y-axes. - - - - - returns - M:Arction.Wpf.Charting.Views.ViewXY.ViewXY.CreateDefaultYAxes - - - - - - - Create new Zoom pan options - - - - - Data cursor shows series data value at or near mouse position. - - - - - Mouse button has been clicked. - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.ViewXY.ViewXY.DeviceButtonClicked(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - param - eventType - M:Arction.Wpf.Charting.Views.ViewXY.ViewXY.DeviceButtonClicked(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - param - chart - M:Arction.Wpf.Charting.Views.ViewXY.ViewXY.DeviceButtonClicked(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - returns - M:Arction.Wpf.Charting.Views.ViewXY.ViewXY.DeviceButtonClicked(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - User interactive device button has been clicked down. - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.ViewXY.ViewXY.DeviceButtonDown(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - param - eventType - M:Arction.Wpf.Charting.Views.ViewXY.ViewXY.DeviceButtonDown(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - param - chart - M:Arction.Wpf.Charting.Views.ViewXY.ViewXY.DeviceButtonDown(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - returns - M:Arction.Wpf.Charting.Views.ViewXY.ViewXY.DeviceButtonDown(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - User interactive device button has been released. - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.ViewXY.ViewXY.DeviceButtonUp(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - param - eventType - M:Arction.Wpf.Charting.Views.ViewXY.ViewXY.DeviceButtonUp(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - param - chart - M:Arction.Wpf.Charting.Views.ViewXY.ViewXY.DeviceButtonUp(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - returns - M:Arction.Wpf.Charting.Views.ViewXY.ViewXY.DeviceButtonUp(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - DigitalLineSeries line series list. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Automatically deletes chart event markers and series event markers, whose x value is - less than X-axis minimum. By setting this true, the performance is much better in real-time monitoring - applications. - - - - - Automatically deletes series data, whose x value is less than X-axis minimum. - By setting this true, the performance is much better in real-time monitoring - applications. - - - - - Enable parallel computation for SampleDataBlockSeries. Performance varies depending on hardware and sample count. Prefer parallelization, when series point count is high and there are multiple series. - - Enable or disable parallelization. - - - - FreeformPointLine series list - - - - - Free all zoom draw data - - - - - Gets list of all series added into SampleDataSeries, PointLineSeries, FreeformPointLineSeries, AreaSeries and HighLowSeries. - - List of series - - - - Get Enumerator of 2D Series. - - - - - returns - M:Arction.Wpf.Charting.Views.ViewXY.ViewXY.Get2DSeriesEnumerator - - - - - - - Gets all series - - List of series - - - - Get list of all highlow series. - - List of highlow series - - - - Get list of all intensity series - - List of series - - - - Gets list of all series added into LineCollection. - - List of series - - - - Gets list of all series added into SampleDataSeries, PointLineSeries and FreeformPointLineSeries - - List of series - - - - Gets list of all triggable series. - - List of series - - - - Gets graph segment info. Useful when multiple Y-axes are defined and you need to know where the graph - segment boundaries are. - - Graph segment info. - - - - Get list of highlow series belonging to given X axis - - - - - param - axisX - M:Arction.Wpf.Charting.Views.ViewXY.ViewXY.GetHighLowSeriesOfAxisX(Arction.Wpf.Charting.Axes.AxisX) - - - - List of highlow series - - - - Get list of all intensity series bound to given axis - - X axis - List of series - - - - Gets list of series added into SampleDataSeries, PointLineSeries and FreeformPointLineSeries, belonging to given X axis. - - - - - param - axisX - M:Arction.Wpf.Charting.Views.ViewXY.ViewXY.GetLineSeriesOfAxisX(Arction.Wpf.Charting.Axes.AxisX) - - - - List of series - - - - Get persistent series rendering layers and its descendant objects list. - - List of persistent series rendering layers. - - - - Get list of series having the given X-axis assigned. - - X-axis. - List of series. - - - - Get list of series having the given Y-axis assigned. - - Y-axis. - List of series. - - - - Determine the direction of zooming. - - - - - returns - M:Arction.Wpf.Charting.Views.ViewXY.ViewXY.GetValidZoomDirection - - - - - - - Get list of Y-axes which are in segment index given. - - Segment index. - List of Y-axes. - - - - Getter of the ZoomPadding, supported by Round and 3D Views - ZoomPanOptions. - - As does not support ZoomPadding, this method - always returns empty (default) padding. - - ZoomPadding of the given view, if supported. - - - - Handler gets Graph segment information - - - - - High-low series list - - - - - List of evenly spaced intensity grid series - - - - - List of intensity mesh series - - - - - Finds out if the given position is over graph area. - - X coordinate - Y coordinate - True if is over - - - - ViewXY LegendBoxes. - - - - - Line segment collection list - - - - - LineSeriesCursors - - - - - LiteFreeformLineSeries line series list. - - - - - LiteLineSeries line series list. - - - - - Maps. - - - - - Measure text with given font. - - Text. - Font. - Dimensions in a point structure. If unable to measure, returns (0,0). - - - - Pan the view. - - Mouse X delta. - Mouse Y delta. - - - - Panning has ended. - - - - - PointLine series list - - - - - Polygon series list - - - - - Check is position over graph. - - Position - - - - returns - M:Arction.Wpf.Charting.Views.ViewXY.ViewXY.PositionOverGraph(Arction.Wpf.Charting.CoordXY) - - - - - - - SampleDataBlockSeries line series list. - - - - - Sampled data point line series list - - - - - Stock data series list - - - - - Automatic title placement settings. - - - - - Convert class description to string. - - Class description as a string. - - - - Use multithreading for block series types. - - - - - User interactive device has been moved. - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.ViewXY.ViewXY.UserInteractiveDeviceMoved(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - param - eventType - M:Arction.Wpf.Charting.Views.ViewXY.ViewXY.UserInteractiveDeviceMoved(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - param - chart - M:Arction.Wpf.Charting.Views.ViewXY.ViewXY.UserInteractiveDeviceMoved(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - returns - M:Arction.Wpf.Charting.Views.ViewXY.ViewXY.UserInteractiveDeviceMoved(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.UserInteractiveDeviceEventType,Arction.Wpf.Charting.LightningChart) - - - - - - - User interactive device wheel has been been scrolled. - - - - - param - eventArguments - M:Arction.Wpf.Charting.Views.ViewXY.ViewXY.WheelScrolled(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.LightningChart) - - - - - - - param - chart - M:Arction.Wpf.Charting.Views.ViewXY.ViewXY.WheelScrolled(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.LightningChart) - - - - - - - returns - M:Arction.Wpf.Charting.Views.ViewXY.ViewXY.WheelScrolled(Arction.Wpf.Charting.UserInteractiveDeviceEventArgs,Arction.Wpf.Charting.LightningChart) - - - - - - - X Axes list - - - - - Y Axes list - - - - - Occurs when the y-axis gap is reduced to zero, if y-axes do not fit with applied gap to graph area. - - - - - Zoom the chart in or out. The input parameters in screen coordinates (pixels). - If stop point X is greater than start point X, zooms in. - If stop point X is less than start point X, fits the view. - - Zoom start point X, in pixels. - Zoom start point Y, in pixels. - Zoom stop point X, in pixels. - Zoom stop point Y, in pixels. - - - - Zooms in by factor. - - Zoom center coordinate, default input in DIPs, zooming is made around it. - Coordinate must hit the graph area (area between graph margins). - Zoom factor over 1 zooms in, factor in range 0...1 zooms out. - Apply zoom in X-dimension. - Apply zoom in Y-dimension. - Use DIPs instead of pixels as parameters. - - - - Zooming has ended. - - - - - Zoom out from stack. - - - - - Zoom, pan and auto-fit options - - - - - View autoscale. Fits all axes so that all series data is shown. - - - - - The delegate to use for handlers that receive the BeforePanning event. - - - Provides data for the BeforePanning event. - - - - The delegate to use for handlers that receive the BeforeZooming event. - - - Provides data for the BeforeZooming event. - - - - The delegate to use for handlers that receive the Panned event. - - - Provides data for the Panned event. - - - - The delegate to use for handlers that receive the YAxisGapChanged event. - - - Provides data for the YAxisGapChanged event. - - - - The delegate to use for handlers that receive the Zoomed event. - - - Provides data for the Zoomed event. - - - - Represents a class that provides arguments for the YAxisGapChangedEventArgs event. - - - - - Creates and initializes a new instance of YAxisGapChangedEventArgs class. - - - - - The averaged height for y-axis when gap is reduced to zero. - - - - - Y-axis segment. - - - - - Constructor. - - - - - Constructor. - - Parent. - - - - Segment relative space. - - - - - Represents a class that provides arguments for the Zoomed event for XY view. - - - - - Creates and initializes a new instance of ZoomedXYEventArgs class. - - - - - Cancel rendering after the Zoomed event has been handled. - - - - - X-axis range information. - - - - - Y-axis range information. - - - - - Zoom, pan and auto-fitting options for ViewXY. - - - - - Simple constructor for Form designer's list editor. - - - - - Constructor. - - Parent. - - - - Alt-key enabled. - - - - - Aspect ratio options. - - - - - Auto Y fit options. - - - - - User interactive device wheel action on axis. - - - - - Ctrl-key enabled. - - - - - Clean up any resources being used. - - true if managed resources should be disposed, otherwise false. - - - - Ignore zero Y-values in auto-fitting, when using logarithmic Y-axis. - - - - - Enable multi-touch panning. - - - - - Gets or sets touch sensitivity. - - - - - Multi-touch zoom direction. - - - - - Enable multi-touch zooming. - - - - - Pan direction. - - - - - Limit rectangle zoom inside graph. - - - - - Zoom mode. - - - - - Link zooming if possible based on Units texts. - - - - - Right-to-left zoom action. - - - - - Shift-key enabled. - - - - - Device wheel zooming. - - - - - View fitting margin in pixels, gap left into top and bottom of Y-axes. - Using some margin leaves a gap between series and axis minimum and maximum values. - - - - \ No newline at end of file diff --git a/BaseModule/bin/Debug/FreeSql.xml b/BaseModule/bin/Debug/FreeSql.xml deleted file mode 100644 index 302c8ee..0000000 --- a/BaseModule/bin/Debug/FreeSql.xml +++ /dev/null @@ -1,6080 +0,0 @@ - - - - FreeSql - - - - - 数据库列名 - - - - - 指定数据库旧的列名,修改实体属性命名时,同时设置此参数为修改之前的值,CodeFirst才可以正确修改数据库字段;否则将视为【新增字段】 - - - - - 数据库类型,如: varchar(255) - 字符串长度,可使用特性 [MaxLength(255)] - - - - - 主键 - - - - - 自增标识 - - - - - 是否可DBNull - - - - - 忽略此列,不迁移、不插入 - - - - - 设置行锁(乐观锁)版本号,每次更新累加版本号,若更新整个实体时会附带当前的版本号判断(修改失败时抛出异常) - - - - - 类型映射,除了可做基本的类型映射外,特别介绍的功能: - 1、将 enum 属性映射成 typeof(string) - 2、将 对象 属性映射成 typeof(string),请安装扩展包 FreeSql.Extensions.JsonMap - - - - - 创建表时字段的位置(场景:实体继承后设置字段顺序),规则如下: - - >0时排前面,1,2,3... - - =0时排中间(默认) - - <0时排后面,...-3,-2,-1 - - - - - 该字段是否可以插入,默认值true,指定为false插入时该字段会被忽略 - - - - - 该字段是否可以更新,默认值true,指定为false更新时该字段会被忽略 - - - - - 标记属性为数据库服务器时间(utc/local),在插入的时候使用类似 getdate() 执行 - - - - - 设置长度,针对 string/byte[] 类型避免 DbType 的繁琐设置 - 提示:也可以使用 [MaxLength(100)] - --- - StringLength = 100 时,对应 DbType: - MySql -> varchar(100) - SqlServer -> nvarchar(100) - PostgreSQL -> varchar(100) - Oracle -> nvarchar2(100) - Sqlite -> nvarchar(100) - --- - StringLength < 0 时,对应 DbType: - MySql -> text (StringLength = -2 时,对应 longtext) - SqlServer -> nvarchar(max) - PostgreSQL -> text - Oracle -> nclob - Sqlite -> text - v1.6.0+ byte[] 支持设置 StringLength - - - - - 执行 Insert 方法时使用此值 - 注意:如果是 getdate() 这种请可考虑使用 ServerTime,因为它对数据库间作了适配 - - - - - decimal/numeric 类型的长度 - - - - - decimal/numeric 类型的小数位长度 - - - - - 重写功能 - 比如:[Column(RewriteSql = "geography::STGeomFromText({0},4236)")] - 插入:INSERT INTO [table]([geo]) VALUES(geography::STGeomFromText('...',4236)) - 提示:更新也生效 - - - - - 重读功能 - 比如:[Column(RereadSql = "{0}.STAsText()")] - 查询:SELECT a.[id], a.[geo].STAsText() FROM [table] a - - - - - 数据库列名 - - - - - 指定数据库旧的列名,修改实体属性命名时,同时设置此参数为修改之前的值,CodeFirst才可以正确修改数据库字段;否则将视为【新增字段】 - - - - - 数据库类型,如: varchar(255) - - - - - 主键 - - - - - 自增标识 - - - - - 是否可DBNull - - - - - 忽略此列,不迁移、不插入 - - - - - 乐观锁 - - - - - 类型映射,比如:可将 enum 属性映射成 typeof(string) - - - - - - - 创建表时字段位置,规则如下: - - >0时排前面 - - =0时排中间(默认) - - <0时排后面 - - - - - - - 该字段是否可以插入,默认值true,指定为false插入时该字段会被忽略 - - - - - - - 该字段是否可以更新,默认值true,指定为false更新时该字段会被忽略 - - - - - - - 标记属性为数据库服务器时间(utc/local),在插入的时候使用类似 getdate() 执行 - - - - - - - 设置长度,针对 string 类型避免 DbType 的繁琐设置 - --- - StringLength = 100 时,对应 DbType: - MySql -> varchar(100) - SqlServer -> nvarchar(100) - PostgreSQL -> varchar(100) - Oracle -> nvarchar2(100) - Sqlite -> nvarchar(100) - --- - StringLength = -1 时,对应 DbType: - MySql -> text - SqlServer -> nvarchar(max) - PostgreSQL -> text - Oracle -> nvarchar2(4000) - Sqlite -> text - - - - - 执行 Insert 方法时使用此值 - 注意:如果是 getdate() 这种请可考虑使用 ServerTime,因为它对数据库间作了适配 - - - - - - - decimal/numeric 类型的长度/小数位长度 - - 总长度 - 小数位长度 - - - - - 重写功能 - 比如:[Column(RewriteSql = "geography::STGeomFromText({0},4236)")] - 插入:INSERT INTO [table]([geo]) VALUES(geography::STGeomFromText('...',4236)) - 提示:更新也生效 - - - - - - - 重读功能 - 比如:[Column(RereadSql = "{0}.STAsText()")] - 查询:SELECT a.[id], a.[geo].STAsText() FROM [table] a - - - - - - - 自定义表达式函数解析 - 注意:请使用静态方法、或者在类上标记 - - - - - 自定义表达式函数解析的时候,指定参数不解析 SQL,而是直接传进来 - - - - - 数据库类型,可用于适配多种数据库环境 - - - - - 已解析的表达式中参数内容 - - - - - 表达式原始值 - - - - - 主对象的参数化对象,可重塑其属性 - - - - - 可附加参数化对象 - 注意:本属性只有 Where 的表达式解析才可用 - - - - - 将 c# 对象转换为 SQL - - - - - 返回表达式函数表示的 SQL 字符串 - - - - - 获取实体元数据 - - - - - - - 解析表达式 - - - - - - - (非公开)内部公共工具类方法 - - - - - 索引设置,如:[Index("{tablename}_idx_01", "name")] - - - - - 索引设置,如:[Index("{tablename}_idx_01", "name")] - - 索引名v1.7.0 增加占位符 {TableName} 表名区分索引名 (解决 AsTable 分表 CodeFirst 导致索引名重复的问题) - 索引字段,为属性名以逗号分隔,如:Create_time ASC, Title ASC - - - - 索引设置,如:[Index("{tablename}_idx_01", "name", true)] - - 索引名v1.7.0 增加占位符 {TableName} 表名区分索引名 (解决 AsTable 分表 CodeFirst 导致索引名重复的问题) - 索引字段,为属性名以逗号分隔,如:Create_time ASC, Title ASC - 是否唯一 - - - - 索引名 - v1.7.0 增加占位符 {TableName} 表名区分索引名 (解决 AsTable 分表 CodeFirst 导致索引名重复的问题) - - - - - 索引字段,为属性名以逗号分隔,如:Create_time ASC, Title ASC - - - - - 是否唯一 - - - - - OneToOne:[Navigate(nameof(Primary))] <-> (缺省)外表.Primary - ManyToOne:Topic.cs 文件 [Navigate(nameof(Topic.CategoryId))] <-> (缺省)Category.Id - _________________public Category Category { get; set; } - OneToMany:Category.cs 文件 (缺省)Category.Id <-> [Navigate(nameof(Topic.CategoryId))] - _________________public List<Topic> Topics { get; set; } - - - - - OneToOne:[Navigate(nameof(Primary))] <-> (缺省)外表.Primary - ManyToOne:Topic.cs 文件 [Navigate(nameof(Topic.CategoryId))] <-> (缺省)Category.Id - _________________public Category Category { get; set; } - OneToMany:Category.cs 文件 (缺省)Category.Id <-> [Navigate(nameof(Topic.CategoryId))] - _________________public List<Topic> Topics { get; set; } - - - - - 手工绑定 ManyToMany 导航关系 - - - - - OneToOne:[Navigate(nameof(Primary))] <-> (缺省)外表.Primary - ManyToOne:Topic.cs 文件 [Navigate(nameof(Topic.CategoryId))] <-> (缺省)Category.Id - _________________public Category Category { get; set; } - OneToMany:Category.cs 文件 (缺省)Category.Id <-> [Navigate(nameof(Topic.CategoryId))] - _________________public List<Topic> Topics { get; set; } - - - - - 主键名 - - - - - 数据库表名 - - - - - 指定数据库旧的表名,修改实体命名时,同时设置此参数为修改之前的值,CodeFirst才可以正确修改数据库表;否则将视为【创建新表】 - - - - - 禁用 CodeFirst 同步结构迁移 - - - - - 格式:属性名=开始时间(递增) - 按年分表:[Table(Name = "log_{yyyy}", AsTable = "create_time=2022-1-1(1 year)")] - 按月分表:[Table(Name = "log_{yyyyMM}", AsTable = "create_time=2022-5-1(1 month)")] - 按日分表:[Table(Name = "log_{yyyyMMdd}", AsTable = "create_time=2022-5-1(5 day)")] - 按时分表:[Table(Name = "log_{yyyyMMddHH}", AsTable = "create_time=2022-5-1(6 hour)")] - - - - - 可以匹配以下条件(支持参数化): - `field` BETWEEN '2022-01-01 00:00:00' AND '2022-03-01 00:00:00' - `field` > '2022-01-01 00:00:00' AND `field` < '2022-03-01 00:00:00' - `field` > '2022-01-01 00:00:00' AND `field` <= '2022-03-01 00:00:00' - `field` >= '2022-01-01 00:00:00' AND `field` < '2022-03-01 00:00:00' - `field` >= '2022-01-01 00:00:00' AND `field` <= '2022-03-01 00:00:00' - `field` > '2022-01-01 00:00:00' - `field` >= '2022-01-01 00:00:00' - `field` < '2022-01-01 00:00:00' - `field` <= '2022-01-01 00:00:00' - - - - - - - 数据库表名 - - - - - 指定数据库旧的表名,修改实体命名时,同时设置此参数为修改之前的值,CodeFirst才可以正确修改数据库表;否则将视为【创建新表】 - - - - - 禁用 CodeFirst 同步结构迁移 - - - - - 导航关系Fluent,与 NavigateAttribute 对应 - - - - 多对多关系的中间实体类型 - - - - - 设置实体的索引 - - 索引名 - 索引字段,为属性名以逗号分隔,如:Create_time ASC, Title ASC - 是否唯一 - - - - - 数据库表名 - - - - - 指定数据库旧的表名,修改实体命名时,同时设置此参数为修改之前的值,CodeFirst才可以正确修改数据库表;否则将视为【创建新表】 - - - - - 禁用 CodeFirst 同步结构迁移 - - - - - 导航关系Fluent,与 NavigateAttribute 对应 - - - - - 多对多关系的中间实体类型 - - - - - 设置实体的索引 - - 索引名 - 索引字段,为属性名以逗号分隔,如:Create_time ASC, Title ASC - 是否唯一 - - - - - 所属表 - - - - - 列名 - - - - - 映射到 C# 类型 - - - - - 数据库枚举类型int值 - - - - - 数据库类型,字符串,varchar - - - - - 数据库类型,字符串,varchar(255) - - - - - 最大长度 - - - - - 主键 - - - - - 自增标识 - - - - - 是否可DBNull - - - - - 备注,早期编码时少按了一个字母,请使用 Comment - - - - - 备注 - - - - - 数据库默认值 - - - - - 字段位置 - - - - - 枚举类型标识 - - - - - 枚举项 - - - - - 唯一标识 - - - - - SqlServer下是Owner、PostgreSQL下是Schema、MySql下是数据库名 - - - - - 表名 - - - - - 表备注,SqlServer下是扩展属性 MS_Description - - - - - 表/视图 - - - - - 列 - - - - - 自增列 - - - - - 主键/组合 - - - - - 唯一键/组合 - - - - - 索引/组合 - - - - - 外键 - - - - - 类型标识 - - - - - 枚举项 - - - - - 通用的 Odbc 实现,只能做基本的 Crud 操作 - 不支持实体结构迁移、不支持分页(只能 Take 查询) - - 通用实现为了让用户自己适配更多的数据库,比如连接 mssql 2000、db2 等数据库 - 默认适配 SqlServer,可以继承后重新适配 FreeSql.Odbc.Default.OdbcAdapter,最好去看下代码 - - 适配新的 OdbcAdapter,请在 FreeSqlBuilder.Build 之后调用 IFreeSql.SetOdbcAdapter 方法设置 - - - - - 武汉达梦数据库有限公司,基于 Odbc 的实现 - - - - - Microsoft Office Access 是由微软发布的关联式数据库管理系统 - - - - - 武汉达梦数据库有限公司,基于 DmProvider.dll 的实现 - - - - - 北京人大金仓信息技术股份有限公司,基于 Odbc 的实现 - - - - - 天津神舟通用数据技术有限公司,基于 System.Data.OscarClient.dll 的实现 - - - - - 北京人大金仓信息技术股份有限公司,基于 Kdbndp.dll 的实现 - - - - - Firebird 是一个跨平台的关系数据库,能作为多用户环境下的数据库服务器运行,也提供嵌入式数据库的实现 - - - - - 自定义适配器,访问任何数据库 - 注意:该类型不提供 DbFirst/CodeFirst 功能 - - - - - 天津南大通用数据技术股份有限公司成立于2004年,是国产数据库、大数据领域的知名企业,基于 Odbc 的实现 - - - - - 获取 IDbConnection 对应的 IFreeSql 实例 - - - - - - - 插入数据 - - - - - - - 插入数据,传入实体 - - - - - - - - - 插入数据,传入实体数组 - - - - - - - - - 插入数据,传入实体集合 - - - - - - - - - 插入数据,传入实体集合 - - - - - - - - - 插入或更新数据,此功能依赖数据库特性(低版本可能不支持),参考如下: - MySql 5.6+: on duplicate key update - PostgreSQL 9.4+: on conflict do update - SqlServer 2008+: merge into - Oracle 11+: merge into - Sqlite: replace into - Firebird: merge into - 达梦: merge into - 人大金仓:on conflict do update - 神通:merge into - MsAccess:不支持 - 注意区别:FreeSql.Repository 仓储也有 InsertOrUpdate 方法(不依赖数据库特性) - - - - - - - - 修改数据 - - - - - - - - 修改数据,传入动态条件,如:主键值 | new[]{主键值1,主键值2} | TEntity1 | new[]{TEntity1,TEntity2} | new{id=1} - - - - 主键值、主键值集合、实体、实体集合、匿名对象、匿名对象集合 - - - - - 查询数据 - - - - - - - - 查询数据,传入动态条件,如:主键值 | new[]{主键值1,主键值2} | TEntity1 | new[]{TEntity1,TEntity2} | new{id=1} - - - - 主键值、主键值集合、实体、实体集合、匿名对象、匿名对象集合 - - - - - 删除数据 - - - - - - - - 删除数据,传入动态条件,如:主键值 | new[]{主键值1,主键值2} | TEntity1 | new[]{TEntity1,TEntity2} | new{id=1} - - - - 主键值、主键值集合、实体、实体集合、匿名对象、匿名对象集合 - - - - - 多表查询 - - - - - - - 多表查询 - - - - - - - 多表查询 - - - - - - - 多表查询 - - - - - - - 多表查询 - - - - - - - 多表查询 - - - - - - - 多表查询 - - - - - - - 多表查询 - - - - - - - 多表查询 - - - - - - - 插入数据 - - - - - - - 插入数据,传入实体 - - - - - - - - - 插入数据,传入实体数组 - - - - - - - - - 插入数据,传入实体集合 - - - - - - - - - 插入数据,传入实体集合 - - - - - - - - - 插入或更新数据,此功能依赖数据库特性(低版本可能不支持),参考如下: - MySql 5.6+: on duplicate key update - PostgreSQL 9.4+: on conflict do update - SqlServer 2008+: merge into - Oracle 11+: merge into - Sqlite: replace into - 达梦: merge into - 人大金仓:on conflict do update - 神通:merge into - MsAccess:不支持 - 注意区别:FreeSql.Repository 仓储也有 InsertOrUpdate 方法(不依赖数据库特性) - - - - - - - - 修改数据 - - - - - - - - 修改数据,传入动态条件,如:主键值 | new[]{主键值1,主键值2} | TEntity1 | new[]{TEntity1,TEntity2} | new{id=1} - - - - 主键值、主键值集合、实体、实体集合、匿名对象、匿名对象集合 - - - - - 查询数据 - - - - - - - - 查询数据,传入动态条件,如:主键值 | new[]{主键值1,主键值2} | TEntity1 | new[]{TEntity1,TEntity2} | new{id=1} - - - - 主键值、主键值集合、实体、实体集合、匿名对象、匿名对象集合 - - - - - 删除数据 - - - - - - - - 删除数据,传入动态条件,如:主键值 | new[]{主键值1,主键值2} | TEntity1 | new[]{TEntity1,TEntity2} | new{id=1} - - - - 主键值、主键值集合、实体、实体集合、匿名对象、匿名对象集合 - - - - - 多表查询 - - - - - - 多表查询 - - - - - - 多表查询 - - - - - - 多表查询 - - - - - - 多表查询 - - - - - - 多表查询 - - - - - - 多表查询 - - - - - - 多表查询 - - - - - - 多表查询 - - - - - - 获取实体的主键值,以 "*|_,[,_|*" 分割,当任意一个主键属性无值时,返回 null - - - - - 当Guid无值时,会生成有序的新值 - - - - - - 获取实体的主键值,多个主键返回数组 - - - - - - - - - 获取实体的属性值 - - - - - - - - - - 获取实体的所有数据,以 (1, 2, xxx) 的形式 - - - - - - - - - 使用新实体的值,复盖旧实体的值 - - - - - 使用新实体的主键值,复盖旧实体的主键值 - - - - - 设置实体中主键内的自增字段值(若存在) - - - - - - - - - 获取实体中主键内的自增字段值(若存在) - - - - - - - - 清除实体的主键值,将自增、Guid类型的主键值清除 - - - - - - - - 清除实体的主键值,将自增、Guid类型的主键值清除 - - - - - - - - 对比两个实体值,返回相同/或不相同的列名 - - - - - - - - - - - 设置实体中某属性的数值增加指定的值 - - - - - - - - - - 设置实体中某属性的值 - - - - - - - - - - 缓存执行 IUpdate.Set - - - - - - - - - SqlExt 是利用自定表达式函数解析功能,解析默认常用的SQL函数,欢迎 PR - - - - - rank() over(order by ...) - - - - - - dense_rank() over(order by ...) - - - - - - count() over(order by ...) - - - - - - sum(..) over(order by ...) - - - - - - - avg(..) over(order by ...) - - - - - - max(..) over(order by ...) - - - - - - - - min(..) over(order by ...) - - - - - - - - SqlServer row_number() over(order by ...) - - - - - - isnull、ifnull、coalesce、nvl - - - - - - - - - count(distinct name) - - - - - - - - 注意:使用者自己承担【注入风险】 - - - - - - - 大于 > - - - - - - 大于或等于 >= - - - - - - 小于 < - - - - - - 小于或等于 <= - - - - - - case when .. then .. end - - - - - - case when .. then .. end - - - - - - - - - - MySql group_concat(distinct .. order by .. separator ..) - - - - - - - MySql find_in_set(str, strlist) - - - - - - - - - PostgreSQL string_agg(.., ..) - - - - - - - - 使用连接串(推荐) - - 数据库类型 - 数据库连接串 - 提供者的类型,一般不需要指定,如果一直提示“缺少 FreeSql 数据库实现包:FreeSql.Provider.MySql.dll,可前往 nuget 下载”的错误,说明反射获取不到类型,此时该参数可排上用场 - - - - - 使用从数据库,支持多个 - - 从数据库连接串 - - - - - 使用自定义数据库连接对象(放弃内置对象连接池技术) - - 数据库类型 - 数据库连接对象创建器 - 提供者的类型,一般不需要指定,如果一直提示“缺少 FreeSql 数据库实现包:FreeSql.Provider.MySql.dll,可前往 nuget 下载”的错误,说明反射获取不到类型,此时该参数可排上用场 - - - - - 【开发环境必备】自动同步实体结构到数据库,程序运行中检查实体表是否存在,然后创建或修改 - 注意:生产环境中谨慎使用 - - true:运行时检查自动同步结构, false:不同步结构(默认) - - - - - 将数据库的主键、自增、索引设置导入,适用 DbFirst 模式,无须在实体类型上设置 [Column(IsPrimary)] 或者 ConfigEntity。此功能目前可用于 mysql/sqlserver/postgresql/oracle。 - 本功能会影响 IFreeSql 首次访问的速度。 - 若使用 CodeFirst 创建索引后,又直接在数据库上建了索引,若无本功能下一次 CodeFirst 迁移时数据库上创建的索引将被删除 - - - - - - - 不使用命令参数化执行,针对 Insert/Update,也可临时使用 IInsert/IUpdate.NoneParameter() - - - - - - - 是否生成命令参数化执行,针对 lambda 表达式解析 - 注意:常量不会参数化,变量才会做参数化 - var id = 100; - fsql.Select<T>().Where(a => a.id == id) 会参数化 - fsql.Select<T>().Where(a => a.id == 100) 不会参数化 - - - - - - - 延时加载导航属性对象,导航属性需要声明 virtual - - - - - - - 监视数据库命令对象 - - 执行前 - 执行后,可监视执行性能 - - - - - 实体类名 -> 数据库表名,命名转换(类名、属性名都生效) - 优先级小于 [Column(Name = "xxx")] - - - - - - - 指定映射优先级 - 例如表名:实体类名 < Aop < FluentApi < Attribute < AsTable - 事件 Aop -------> fsql.Aop.ConfigEntity/fsql.Aop.ConfigEntityProperty - 方法 FluentApi -> fsql.CodeFirst.ConfigEntity/fsql.CodeFirst.Entity - 特性 Attribute -> [Table(Name = xxx, ...)] - ----------------------------------------------------------------------------- - 默认规则:关于映射优先级,Attribute 可以更直观排查问题,即使任何地方使用 FluentApi/Aop 设置 TableName 都不生效。 - 调整规则:UseMappingPriority(Attribute, FluentApi, Aop) - 实体类名 < Attribute < FluentApi < Aop < AsTable - - - - - - - - - - 监听 AppDomain.CurrentDomain.ProcessExit/Console.CancelKeyPress 事件自动释放连接池 - 默认值: true - - - - - - - 转小写同步结构 - - true:转小写, false:不转 - - - - - 转大写同步结构 - - true:转大写, false:不转 - - - - - 自动转换实体属性名称 Entity Property -> Db Filed - - *不会覆盖 [Column] 特性设置的Name - - - - - - - 指定事务对象 - - - - - - - 指定事务对象 - - - - - - - 命令超时设置(秒) - - - - - - - lambda表达式条件,仅支持实体基础成员(不包含导航对象) - 若想使用导航对象,请使用 ISelect.ToDelete() 方法 - - lambda表达式条件 - - - - - lambda表达式条件,仅支持实体基础成员(不包含导航对象) - 若想使用导航对象,请使用 ISelect.ToUpdate() 方法 - - true 时生效 - lambda表达式条件 - - - - - 原生sql语法条件,Where("id = @id", new { id = 1 }) - 提示:parms 参数还可以传 Dictionary<string, object> - - sql语法条件 - 参数 - - - - - 原生sql语法条件,Where("id = @id", new { id = 1 }) - 提示:parms 参数还可以传 Dictionary<string, object> - - true 时生效 - sql语法条件 - 参数 - - - - - 传入实体,将主键作为条件 - - 实体 - - - - - 传入实体集合,将主键作为条件 - - 实体集合 - - - - - 传入动态条件,如:主键值 | new[]{主键值1,主键值2} | TEntity1 | new[]{TEntity1,TEntity2} | new{id=1} - - 主键值、主键值集合、实体、实体集合、匿名对象、匿名对象集合 - 是否标识为NOT - - - - - 禁用全局过滤功能,不传参数时将禁用所有 - - 零个或多个过滤器名字 - - - - - 设置表名规则,可用于分库/分表,参数1:默认表名;返回值:新表名; - - - - - - - 设置表名 - - - - - - - 动态Type,在使用 Delete<object> 后使用本方法,指定实体类型 - - - - - - - 返回即将执行的SQL语句 - - - - - - 执行SQL语句,返回影响的行数 - - - - - - 执行SQL语句,返回被删除的记录 - 注意:此方法只有 Postgresql/SqlServer 有效果 - - - - - - 指定事务对象 - - - - - - - 指定事务对象 - - - - - - - 命令超时设置(秒) - - - - - - - 追加准备插入的实体 - - 实体 - - - - - 追加准备插入的实体 - - 实体 - - - - - 追加准备插入的实体集合 - - 实体集合 - - - - - 只插入的列,InsertColumns(a => a.Name) | InsertColumns(a => new{a.Name,a.Time}) | InsertColumns(a => new[]{"name","time"}) - - lambda选择列 - - - - - 只插入的列 - - 属性名,或者字段名 - - - - - 忽略的列,IgnoreColumns(a => a.Name) | IgnoreColumns(a => new{a.Name,a.Time}) | IgnoreColumns(a => new[]{"name","time"}) - - lambda选择列 - - - - - 忽略的列 - - 属性名,或者字段名 - - - - - 指定可插入自增字段 - - - - - - 不使用参数化,可通过 IFreeSql.CodeFirst.IsNotCommandParameter 全局性设置 - - 是否不使用参数化 - - - - - 批量执行选项设置,一般不需要使用该方法 - 各数据库 values, parameters 限制不一样,默认设置: - MySql 5000 3000 - PostgreSQL 5000 3000 - SqlServer 1000 2100 - Oracle 500 999 - Sqlite 5000 999 - 若没有事务传入,内部(默认)会自动开启新事务,保证拆包执行的完整性。 - - 指定根据 values 上限数量拆分执行 - 指定根据 parameters 上限数量拆分执行 - 是否自动开启事务 - - - - - 批量执行时,分批次执行的进度状态 - - 批量执行时的回调委托 - - - - - 设置表名规则,可用于分库/分表,参数1:默认表名;返回值:新表名; - - - - - - - 设置表名 - - - - - - - 动态Type,在使用 Insert<object> 后使用本方法,指定实体类型 - - - - - - - 返回即将执行的SQL语句 - - - - - - 执行SQL语句,返回影响的行数 - - - - - - 执行SQL语句,返回自增值 - 注意:请检查实体类是否标记了 [Column(IsIdentity = true)] - - - - - - 执行SQL语句,返回插入后的记录 - 注意:此方法只有 Postgresql/SqlServer 有效果 - - - - - - 返回 DataTable 以便做 BulkCopy 数据做准备 - 此方法会处理: - 类型、表名、字段名映射 - IgnoreColumns、InsertColumns - - - - - - 指定事务对象 - - - - - - - 指定事务对象 - - - - - - - 命令超时设置(秒) - - - - - - - 添加或更新,设置实体 - - 实体 - - - - - 添加或更新,设置实体集合 - - 实体集合 - - 根据临时主键插入或更新,a => a.Name | a => new{a.Name,a.Time} | a => new[]{"name","time"} - 注意:不处理自增,因某些数据库依赖主键或唯一键,所以指定临时主键仅对 SqlServer/PostgreSQL/Firebird/达梦/南大通用/金仓/神通 有效 - - - - - - 添加或更新,设置SQL - - 查询SQL - - 根据临时主键插入或更新,a => a.Name | a => new{a.Name,a.Time} | a => new[]{"name","time"} - 注意:不处理自增,因某些数据库依赖主键或唯一键,所以指定临时主键仅对 SqlServer/PostgreSQL/Firebird/达梦/南大通用/金仓/神通 有效 - - - - - - 当记录存在时,什么都不做 - 换句话:只有记录不存在时才插入 - - - - - - 当记录存在时,指定只更新的字段,UpdateColumns(a => a.Name) | UpdateColumns(a => new{a.Name,a.Time}) | UpdateColumns(a => new[]{"name","time"}) - - lambda选择列 - - - - - 当记录存在时,指定只更新的字段 - - 属性名,或者字段名 - - - - - 设置表名规则,可用于分库/分表,参数1:默认表名;返回值:新表名; - - - - - - - 设置表名 - - - - - - - 动态Type,在使用 Update<object> 后使用本方法,指定实体类型 - - - - - - - 返回即将执行的SQL语句 - - - - - - 执行SQL语句,返回影响的行数 - - - - - - 自动产生 as1, as2, as3 .... 字段别名 - 这种方法可以最大程度防止多表,存在相同字段的问题 - - - - - 使用属性名作为字段别名 - - - - - 控制取消本次查询 - * 不会产生额外的异常 - * 取消成功,则不执行 SQL 命令 - * 取消成功,直接返回没有记录时候的返回值 - * 取消成功,如 List<T> 返回 0 元素列表,不是 null,仍然是旧机制 - - 返回 true,则不会执行 SQL 命令 - - - - - 指定事务对象 - - - - - - - 指定连接对象 - - - - - - - 使用自定义参数化,UnionALL 或者 ToSql 可能有需要 - - - - - - - 命令超时设置(秒) - - - - - - - 审核或跟踪 ToList 即将返回的数据 - - - - - - - 执行SQL查询,返回 DataTable - - - - - - 执行SQL查询,返回 properties 指定的实体类属性,并以 DataTable 接收 - - 属性名:Name导航属性:Parent.Name多表:b.Name - - - - - 以字典的形式返回查询结果 - 注意:字典的特点会导致返回的数据无序 - - - - - - - - 执行SQL查询,返回 T1 实体所有字段的记录,记录不存在时返回 Count 为 0 的列表 - 注意: - 1、ToList(a => a) 可以返回 a 所有实体 - 2、ToList(a => new { a }) 这样也可以 - 3、ToList((a, b, c) => new { a, b, c }) 这样也可以 - 4、abc 怎么来的?请试试 fsql.Select<T1, T2, T3>() - - - - - - 执行SQL查询,返回 T1 实体、以及 LeftJoin/InnerJoin/RightJoin 对象 - - false: 返回 2级 LeftJoin/InnerJoin/RightJoin 对象;true: 返回所有 LeftJoin/InnerJoin/RightJoin 的导航数据 - - - - - 执行SQL查询,分块返回数据,可减少内存开销。比如读取10万条数据,每次返回100条处理。 - - 数据块的大小 - 处理数据块 - false: 返回 2级 LeftJoin/InnerJoin/RightJoin 对象;true: 返回所有 LeftJoin/InnerJoin/RightJoin 的导航数据 - - - - 执行SQL查询,返回 field 指定字段的记录,并以元组或基础类型(int,string,long)接收,记录不存在时返回 Count 为 0 的列表 - - - - - - - - 执行SQL查询,返回 T1 实体所有字段的第一条记录,记录不存在时返回 null - - - - - - 执行SQL查询,返回 T1 实体所有字段的第一条记录,记录不存在时返回 null - - - - - - 将查询转为删除对象,以便支持导航对象或其他查询功能删除数据,如下: - fsql.Select<T1>().Where(a => a.Options.xxx == 1).ToDelete().ExecuteAffrows() - 注意:此方法不是将数据查询到内存循环删除,上面的代码产生如下 SQL 执行: - DELETE FROM `T1` WHERE id in (select a.id from T1 a left join Options b on b.t1id = a.id where b.xxx = 1) - 复杂删除使用该方案的好处: - 1、删除前可预览测试数据,防止错误删除操作; - 2、支持更加复杂的删除操作(IDelete 默认只支持简单的操作); - - - - - - 将查询转为更新对象,以便支持导航对象或其他查询功能更新数据,如下: - fsql.Select<T1>().Where(a => a.Options.xxx == 1).ToUpdate().Set(a => a.Title, "111").ExecuteAffrows() - 注意:此方法不是将数据查询到内存循环更新,上面的代码产生如下 SQL 执行: - UPDATE `T1` SET Title = '111' WHERE id in (select a.id from T1 a left join Options b on b.t1id = a.id where b.xxx = 1) - 复杂更新使用该方案的好处: - 1、更新前可预览测试数据,防止错误更新操作; - 2、支持更加复杂的更新操作(IUpdate 默认只支持简单的操作); - - - - - - 设置表名规则,可用于分库/分表,参数1:实体类型;参数2:默认表名;返回值:新表名; - 设置多次,可查询分表后的多个子表记录,以 UNION ALL 形式执行。 - 如:select.AsTable((type, oldname) => "table_1").AsTable((type, oldname) => "table_2").AsTable((type, oldname) => "table_3").ToSql(a => a.Id); - select * from (SELECT a."Id" as1 FROM "table_1" a) ftb - UNION ALL select * from (SELECT a."Id" as1 FROM "table_2" a) ftb - UNION ALL select * from (SELECT a."Id" as1 FROM "table_3" a) ftb - 还可以这样:select.AsTable((a, b) => "(select * from tb_topic where clicks > 10)").Page(1, 10).ToList() - - - - - - - 设置别名规则,可用于拦截表别名,实现类似 sqlserver 的 with(nolock) 需求 - 如:select.AsAlias((_, old) => $"{old} with(lock)") - - - - - - - 动态Type,在使用 Select<object> 后使用本方法,指定实体类型 - - - - - - - 返回即将执行的SQL语句 - - 指定字段 - - - - - 执行SQL查询,是否有记录 - - - - - - 查询的记录数量 - - - - - - 查询的记录数量,以参数out形式返回 - - 返回的变量 - - - - - 指定从主库查询(默认查询从库) - - - - - - 左联查询,使用导航属性自动生成SQL - - 表达式 - - - - - 联接查询,使用导航属性自动生成SQL - - 表达式 - - - - - 右联查询,使用导航属性自动生成SQL - - 表达式 - - - - - 左联查询,指定关联的实体类型 - - 关联的实体类型 - 表达式 - - - - - 联接查询,指定关联的实体类型 - - 关联的实体类型 - 表达式 - - - - - 右联查询,指定关联的实体类型 - - 关联的实体类型 - 表达式 - - - - - 左联查询,使用原生sql语法,LeftJoin("type b on b.id = a.id and b.clicks > @clicks", new { clicks = 1 }) - 提示:parms 参数还可以传 Dictionary<string, object> - - sql语法条件 - 参数 - - - - - 联接查询,使用原生sql语法,InnerJoin("type b on b.id = a.id and b.clicks > @clicks", new { clicks = 1 }) - 提示:parms 参数还可以传 Dictionary<string, object> - - sql语法条件 - 参数 - - - - - 右联查询,使用原生sql语法,RightJoin("type b on b.id = a.id and b.clicks > @clicks", new { clicks = 1 }) - 提示:parms 参数还可以传 Dictionary<string, object> - - sql语法条件 - 参数 - - - - - 在 JOIN 位置插入 SQL 内容 - 如:.RawJoin("OUTER APPLY ( select id from t2 ) b") - - - - - - - 原生sql语法条件,Where("id = @id", new { id = 1 }) - 提示:parms 参数还可以传 Dictionary<string, object> - - sql语法条件 - 参数 - - - - - 原生sql语法条件,WhereIf(true, "id = @id", new { id = 1 }) - 提示:parms 参数还可以传 Dictionary<string, object> - - true 时生效 - sql语法条件 - 参数 - - - - - 动态过滤条件 - - - - - - - 禁用全局过滤功能,不传参数时将禁用所有 - - 零个或多个过滤器名字 - - - - - 排他更新锁 - 注意:务必在开启事务后使用该功能 - MySql: for update - SqlServer: With(UpdLock, RowLock, NoWait) - PostgreSQL: for update nowait - Oracle: for update nowait - Sqlite: 无效果 - 达梦: for update nowait - 人大金仓: for update nowait - 神通: for update - - noawait - - - - - 按原生sql语法分组,GroupBy("concat(name, @cc)", new { cc = 1 }) - 提示:parms 参数还可以传 Dictionary<string, object> - - sql语法 - 参数 - - - - - 按原生sql语法聚合条件过滤,Having("count(name) = @cc", new { cc = 1 }) - 提示:parms 参数还可以传 Dictionary<string, object> - - sql语法条件 - 参数 - - - - - 按原生sql语法排序,OrderBy("count(name) + @cc desc", new { cc = 1 }) - 提示:parms 参数还可以传 Dictionary<string, object> - - sql语法 - 参数 - - - - - 按原生sql语法排序,OrderBy(true, "count(name) + @cc desc", new { cc = 1 }) - 提示:parms 参数还可以传 Dictionary<string, object> - - true 时生效 - sql语法 - 参数 - - - - - 按属性名字符串排序(支持导航属性) - 属性名:Name导航属性:Parent.Name多表:b.Name - - 属性名:Name导航属性:Parent.Name多表:b.Name - 顺序 | 倒序 - - - - - 按属性名字符串排序(支持导航属性) - 属性名:Name导航属性:Parent.Name多表:b.Name - - true 时生效 - 属性名:Name导航属性:Parent.Name多表:b.Name - 顺序 | 倒序 - - - - - 查询向后偏移行数 - - - - - - - 查询向后偏移行数 - - 行数 - - - - - 查询多少条数据 - - - - - - - 查询多少条数据 - - - - - - - 分页 - - 第几页 - 每页多少 - - - - - 分页 - - 分页信息 - - - - - 查询数据前,去重 - - .Distinct().ToList(x => x.GroupName) 对指定字段去重 - - - .Distinct().ToList() 对整个查询去重 - - - - - - - 执行SQL查询,是否有记录 - - lambda表达式 - - - - - 将查询转换为 INSERT INTO tableName SELECT ... FROM t 执行插入 - - - 指定插入的表名,若为 null 则使用 TTargetEntity 实体表名 - 选择列 - 返回影响的行数 - - - - 执行SQL查询,返回 DataTable - - - - - - 执行SQL查询,返回指定字段的记录,记录不存在时返回 Count 为 0 的列表 - - 返回类型 - 选择列 - - - - - 执行SQL查询,返回 TDto 映射的字段,记录不存在时返回 Count 为 0 的列表 - - - - - - - 执行SQL查询,分块返回数据,可减少内存开销。比如读取10万条数据,每次返回100条处理。 - - 返回类型 - 选择列 - 数据块的大小 - 处理数据块 - - - - 执行SQL查询,返回指定字段的记录的第一条记录,记录不存在时返回 TReturn 默认值 - - 返回类型 - 选择列 - - - - - 执行SQL查询,返回 TDto 映射的字段,记录不存在时返回 Dto 默认值 - - - - - - - 执行SQL查询,返回指定字段的记录的第一条记录,记录不存在时返回 TReturn 默认值 - - 返回类型 - 选择列 - - - - - 执行SQL查询,返回 TDto 映射的字段,记录不存在时返回 Dto 默认值 - - - - - - - 返回即将执行的SQL语句 - - 返回类型 - 选择列 - 字段别名 - - - - - 执行SQL查询,返回指定字段的聚合结果 - - - - - - - - 执行SQL查询,返回指定字段的聚合结果给 output 参数 - fsql.Select<T>() - .Aggregate(a => new { count = a.Count, sum = a.Sum(a.Key.Price) }, out var agg) - .Page(1, 10).ToList(); - - - - - - - - - 求和 - - 返回类型 - 列 - - - - - 最小值 - - 返回类型 - 列 - - - - - 最大值 - - 返回类型 - 列 - - - - - 平均值 - - 返回类型 - 列 - - - - - 指定别名 - - 别名 - - - - - 多表查询 - - - - - - - - 查询条件,Where(a => a.Id > 10),支持导航对象查询,Where(a => a.Author.Email == "2881099@qq.com") - - lambda表达式 - - - - - 查询条件,Where(true, a => a.Id > 10),支导航对象查询,Where(true, a => a.Author.Email == "2881099@qq.com") - - true 时生效 - lambda表达式 - - - - - 多表条件查询 - - - lambda表达式 - - - - - 多表条件查询 - - - lambda表达式 - - - - - 多表条件查询 - - - - lambda表达式 - - - - - 多表条件查询 - - - - - lambda表达式 - - - - - 多表条件查询 - - - - - - lambda表达式 - - - - - 传入动态条件,如:主键值 | new[]{主键值1,主键值2} | TEntity1 | new[]{TEntity1,TEntity2} | new{id=1} - - 主键值、主键值集合、实体、实体集合、匿名对象、匿名对象集合 - 是否标识为NOT - - - - - 多表查询时,该方法标记后,表达式条件将对所有表进行附加 - - 例如:软删除、租户,每个表都给条件,挺麻烦的 - - fsql.Select<T1>().LeftJoin<T2>(...).Where<T2>((t1, t2 => t1.IsDeleted == false && t2.IsDeleted == false) - - 修改:fsql.Select<T1>().LeftJoin<T2>(...).WhereCascade(t1 => t1.IsDeleted == false) - - 当其中的实体可附加表达式才会进行,表越多时收益越大 - - - - - - - 按选择的列分组,GroupBy(a => a.Name) | GroupBy(a => new{a.Name,a.Time}) - - - - - - - 按列排序,OrderBy(a => a.Time) - - - - - - - - 按列排序,OrderBy(true, a => a.Time) - - - true 时生效 - - - - - - 按列排序,OrderByIf(true, a => a.Time) - - - true 时生效 - - true: DESC, false: ASC - - - - - 按列倒向排序,OrderByDescending(a => a.Time) - - 列 - - - - - 按列倒向排序,OrderByDescending(true, a => a.Time) - - true 时生效 - 列 - - - - - 贪婪加载导航属性,如果查询中已经使用了 a.Parent.Parent 类似表达式,则可以无需此操作 - - - 选择一个导航属性 - - - - - 贪婪加载导航属性,如果查询中已经使用了 a.Parent.Parent 类似表达式,则可以无需此操作 - - - true 时生效 - 选择一个导航属性 - - - - - 贪婪加载集合的导航属性,其实是分两次查询,ToList 后进行了数据重装 - 文档:https://github.com/dotnetcore/FreeSql/wiki/%E8%B4%AA%E5%A9%AA%E5%8A%A0%E8%BD%BD - - - 选择一个集合的导航属性,如: .IncludeMany(a => a.Tags) - 可以 .Where 设置临时的关系映射,如: .IncludeMany(a => a.Tags.Where(tag => tag.TypeId == a.Id)) - 可以 .Take(5) 每个子集合只取5条,如: .IncludeMany(a => a.Tags.Take(5)) - 可以 .Select 设置只查询部分字段,如: (a => new TNavigate { Title = a.Title }) - - 即能 ThenInclude,还可以二次过滤(这个 EFCore 做不到?) - - - - - 按属性名字符串进行 Include/IncludeMany 操作 - - - - - - - 按属性名字符串进行 Include/IncludeMany 操作 - - true 时生效 - - - - - - 实现 select .. from ( select ... from t ) a 这样的功能 - 使用 AsTable 方法也可以达到效果 - 示例:WithSql("select * from id=@id", new { id = 1 }) - 提示:parms 参数还可以传 Dictionary<string, object> - - SQL语句 - 参数 - - - - - 实现 select .. from ( select .. UNION ALL select .. ) a 这样的功能(基于内存数据) - - 内存数据 - - - - - 嵌套查询 select * from ( select ... from table ... ) a - - - - - - - - 查询条件,Where(a => a.Id > 10),支持导航对象查询,Where(a => a.Author.Email == "2881099@qq.com") - - lambda表达式 - - - - - 查询条件,Where(true, a => a.Id > 10),支导航对象查询,Where(true, a => a.Author.Email == "2881099@qq.com") - - true 时生效 - lambda表达式 - - - - - 按列排序,OrderBy(a => a.Time) - - - - - - - - 按列倒向排序,OrderByDescending(a => a.Time) - - 列 - - - - - 按聚合条件过滤,Having(a => a.Count() > 10) - - lambda表达式 - - - - - 按聚合条件过滤,HavingIf(true, a => a.Count() > 10) - - true 时生效 - lambda表达式 - - - - - 按列排序,OrderBy(a => a.Time) - - - - - - - - 按列倒向排序,OrderByDescending(a => a.Time) - - 列 - - - - - 执行SQL查询,返回指定字段的记录,记录不存在时返回 Count 为 0 的列表 - - 返回类型 - 选择列 - - - - - 【linq to sql】专用方法,不建议直接使用 - - - - - 返回即将执行的SQL语句 - - 返回类型 - 选择列 - - - - - - 返回即将执行的SQL语句 - - 指定字段 - - - - - 嵌套查询 select * from ( select ... from table group by ... ) a - - - - - - - - 查询向后偏移行数 - - - - - - - 查询向后偏移行数 - - 行数 - - - - - 查询多少条数据 - - - - - - - 查询多少条数据 - - - - - - - 分页 - - 第几页 - 每页多少 - - - - - 分页 - - 分页信息 - - - - - 查询的记录数量 - - - - - - 查询的记录数量,以参数out形式返回 - - 返回的变量 - - - - - 分组的数据 - - - - - 记录总数 - - - - - - 求和 - - - - - - - - 平均值 - - - - - - - - 最大值 - - - - - - - - 最小值 - - - - - - - 所有元素 - - - - - 指定事务对象 - - - - - - - 指定事务对象 - - - - - - - 命令超时设置(秒) - - - - - - - 不使用参数化,可通过 IFreeSql.CodeFirst.IsNotCommandParameter 全局性设置 - - 是否不使用参数化 - - - - - 批量执行选项设置,一般不需要使用该方法 - 各数据库 rows, parameters 限制不一样,默认设置: - MySql 500 3000 - PostgreSQL 500 3000 - SqlServer 500 2100 - Oracle 200 999 - Sqlite 200 999 - 若没有事务传入,内部(默认)会自动开启新事务,保证拆包执行的完整性。 - - 指定根据 rows 上限数量拆分执行 - 指定根据 parameters 上限数量拆分执行 - 是否自动开启事务 - - - - - 批量执行时,分批次执行的进度状态 - - 批量执行时的回调委托 - - - - - 更新数据,设置更新的实体 - 注意:实体必须定义主键,并且最终会自动附加条件 where id = source.Id - - 实体 - - - - - 更新数据,设置更新的实体集合 - 注意:实体必须定义主键,并且最终会自动附加条件 where id in (source.Id) - - 实体集合 - 根据临时主键更新,a => a.Name | a => new{a.Name,a.Time} | a => new[]{"name","time"} - 忽略 IsVersion 乐观锁版本号 - - - - - 更新数据,设置更新的实体,同时设置忽略的列 - 忽略 null 属性:fsql.Update<T>().SetSourceAndIgnore(item, colval => colval == null) - 注意:参数 ignore 与 IUpdate.IgnoreColumns/UpdateColumns 不能同时使用 - - 实体 - 属性值忽略判断, true忽略 - - - - - 忽略的列,IgnoreColumns(a => a.Name) | IgnoreColumns(a => new{a.Name,a.Time}) | IgnoreColumns(a => new[]{"name","time"}) - 注意:不能与 UpdateColumns 不能同时使用 - - lambda选择列 - - - - - 忽略的列 - 注意:不能与 UpdateColumns 不能同时使用 - - 属性名,或者字段名 - - - - - 指定的列,UpdateColumns(a => a.Name) | UpdateColumns(a => new{a.Name,a.Time}) | UpdateColumns(a => new[]{"name","time"}) - 注意:不能与 IgnoreColumns 不能同时使用 - - lambda选择列 - - - - - 指定的列 - 注意:不能与 IgnoreColumns 同时使用 - - 属性名,或者字段名 - - - - - 设置列的新值,Set(a => a.Name, "newvalue") - - - lambda选择列 - 新值 - - - - - 设置列的新值,Set(a => a.Name, "newvalue") - - - true 时生效 - lambda选择列 - 新值 - - - - - 设置列的的新值为基础上增加,格式:Set(a => a.Clicks + 1) 相当于 clicks=clicks+1 - - 指定更新,格式:Set(a => new T { Clicks = a.Clicks + 1, Time = DateTime.Now }) 相当于 set clicks=clicks+1,time='2019-06-19....' - - - - - - - - 设置列的的新值为基础上增加,格式:Set(a => a.Clicks + 1) 相当于 clicks=clicks+1 - - 指定更新,格式:Set(a => new T { Clicks = a.Clicks + 1, Time = DateTime.Now }) 相当于 set clicks=clicks+1,time='2019-06-19....' - - - true 时生效 - - - - - - 设置值,自定义SQL语法,SetRaw("title = @title", new { title = "newtitle" }) - 提示:parms 参数还可以传 Dictionary<string, object> - - sql语法 - 参数 - - - - - 设置更新的列 - SetDto(new { title = "xxx", clicks = 2 }) - SetDto(new Dictionary<string, object> { ["title"] = "xxx", ["clicks"] = 2 }) - 注意:标记 [Column(CanUpdate = false)] 的属性不会被更新 - - dto 或 Dictionary<string, object> - - - - - lambda表达式条件,仅支持实体基础成员(不包含导航对象) - 若想使用导航对象,请使用 ISelect.ToUpdate() 方法 - - lambda表达式条件 - - - - - lambda表达式条件,仅支持实体基础成员(不包含导航对象) - 若想使用导航对象,请使用 ISelect.ToUpdate() 方法 - - true 时生效 - lambda表达式条件 - - - - - 原生sql语法条件,Where("id = @id", new { id = 1 }) - 提示:parms 参数还可以传 Dictionary<string, object> - - sql语法条件 - 参数 - - - - - 传入实体,将主键作为条件 - - 实体 - - - - - 传入实体集合,将主键作为条件 - - 实体集合 - - - - - 传入动态条件,如:主键值 | new[]{主键值1,主键值2} | TEntity1 | new[]{TEntity1,TEntity2} | new{id=1} - - 主键值、主键值集合、实体、实体集合、匿名对象、匿名对象集合 - 是否标识为NOT - - - - - 禁用全局过滤功能,不传参数时将禁用所有 - - 零个或多个过滤器名字 - - - - - 设置表名规则,可用于分库/分表,参数1:默认表名;返回值:新表名; - - - - - - - 设置表名 - - - - - - - 动态Type,在使用 Update<object> 后使用本方法,指定实体类型 - - - - - - - 返回即将执行的SQL语句 - - - - - - 执行SQL语句,返回影响的行数 - - - - - - 执行SQL语句,返回更新后的记录 - 注意:此方法只有 Postgresql/SqlServer 有效果 - - - - - - 主库连接池 - - - - - 从库连接池 - - - - - 数据库类型 - - - - - UseConnectionString 时候的值 - - - - - UseSalve 时候的值 - - - - - 唯一标识 - - - - - 开启事务(不支持异步) - - 事务体 () => {} - - - - 开启事务(不支持异步) - - - 事务体 () => {} - - - - 当前线程的事务 - - - - - 将 new { id = 1 } 或者 Dictionary<string, object> 转换为 DbParameter[] - - new { id = 1 } 或者 Dictionary<string, object> - - - - - SQL 命令执行类,fsql.Ado.CommandFluent("select * from user where age > @age", new { age = 25 }) - .WithConnection(connection) - .WithTransaction(transaction) - .WithParameter("age", 25) - .WithParameter("id", 11) - .CommandType(CommandType.Text) - .CommandTimeout(60) - .Query<T>(); 或者 ExecuteNonQuery/ExecuteScalar/ExecuteDataTable/ExecuteDataSet/ExecuteArray - - - - - - - - 测试数据库是否连接正确,本方法执行如下命令: - MySql/SqlServer/PostgreSQL/达梦/人大金仓/神通: SELECT 1 - Oracle: SELECT 1 FROM dual - - 命令超时设置(秒) - true: 成功, false: 失败 - - - - 查询,若使用读写分离,查询【从库】条件cmdText.StartsWith("SELECT "),否则查询【主库】 - - - - - - - - - 查询,ExecuteReader(dr => {}, "select * from user where age > @age", new { age = 25 }) - 提示:parms 参数还可以传 Dictionary<string, object> - - - - - - - - 查询 - - - - - - - - 查询,ExecuteArray("select * from user where age > @age", new { age = 25 }) - 提示:parms 参数还可以传 Dictionary<string, object> - - - - - - - - 查询 - - - - - - - - 查询,ExecuteDataSet("select * from user where age > @age; select 2", new { age = 25 }) - 提示:parms 参数还可以传 Dictionary<string, object> - - - - - - - - 查询 - - - - - - - - 查询,ExecuteDataTable("select * from user where age > @age", new { age = 25 }) - 提示:parms 参数还可以传 Dictionary<string, object> - - - - - - - - 在【主库】执行 - - - - - - - - 在【主库】执行,ExecuteNonQuery("delete from user where age > @age", new { age = 25 }) - 提示:parms 参数还可以传 Dictionary<string, object> - - - - - - - - 在【主库】执行 - - - - - - - - 在【主库】执行,ExecuteScalar("select 1 from user where age > @age", new { age = 25 }) - 提示:parms 参数还可以传 Dictionary<string, object> - - - - - - - - 执行SQL返回对象集合,Query<User>("select * from user where age > @age", new SqlParameter { ParameterName = "age", Value = 25 }) - - - - - - - - - - 执行SQL返回对象集合,Query<User>("select * from user where age > @age", new { age = 25 }) - 提示:parms 参数还可以传 Dictionary<string, object> - - - - - - - - - 执行SQL返回对象集合,Query<User>("select * from user where age > @age; select * from address", new SqlParameter { ParameterName = "age", Value = 25 }) - - - - - - - - - - - 执行SQL返回对象集合,Query<User>("select * from user where age > @age; select * from address", new { age = 25 }) - 提示:parms 参数还可以传 Dictionary<string, object> - - - - - - - - - - 测试数据库是否连接正确,本方法执行如下命令: - MySql/SqlServer/PostgreSQL/达梦/人大金仓/神通: SELECT 1 - Oracle: SELECT 1 FROM dual - - 命令超时设置(秒) - - true: 成功, false: 失败 - - - - 查询,若使用读写分离,查询【从库】条件cmdText.StartsWith("SELECT "),否则查询【主库】 - - - - - - - - - - 查询,ExecuteReaderAsync(dr => {}, "select * from user where age > @age", new { age = 25 }) - 提示:parms 参数还可以传 Dictionary<string, object> - - - - - - - - - 查询 - - - - - - - - - 查询,ExecuteArrayAsync("select * from user where age > @age", new { age = 25 }) - 提示:parms 参数还可以传 Dictionary<string, object> - - - - - - - - - 查询 - - - - - - - - - 查询,ExecuteDataSetAsync("select * from user where age > @age; select 2", new { age = 25 }) - 提示:parms 参数还可以传 Dictionary<string, object> - - - - - - - - - 查询 - - - - - - - - - 查询,ExecuteDataTableAsync("select * from user where age > @age", new { age = 25 }) - 提示:parms 参数还可以传 Dictionary<string, object> - - - - - - - - - 在【主库】执行 - - - - - - - - - 在【主库】执行,ExecuteNonQueryAsync("delete from user where age > @age", new { age = 25 }) - 提示:parms 参数还可以传 Dictionary<string, object> - - - - - - - - - 在【主库】执行 - - - - - - - - - 在【主库】执行,ExecuteScalarAsync("select 1 from user where age > @age", new { age = 25 }) - 提示:parms 参数还可以传 Dictionary<string, object> - - - - - - - - - 执行SQL返回对象集合,QueryAsync<User>("select * from user where age > @age", new SqlParameter { ParameterName = "age", Value = 25 }) - - - - - - - - - - - 执行SQL返回对象集合,QueryAsync<User>("select * from user where age > @age", new { age = 25 }) - 提示:parms 参数还可以传 Dictionary<string, object> - - - - - - - - - - 执行SQL返回对象集合,Query<User>("select * from user where age > @age; select * from address", new SqlParameter { ParameterName = "age", Value = 25 }) - - - - - - - - - - - - 执行SQL返回对象集合,Query<User, Address>("select * from user where age > @age; select * from address", new { age = 25 }) - 提示:parms 参数还可以传 Dictionary<string, object> - - - - - - - - - - - 可自定义解析表达式 - - - - - 自定义实体的配置,方便和多个 ORM 共同使用 - - - - - 自定义实体的属性配置,方便和多个 ORM 共同使用 - - - - - 增删查改,执行命令之前触发 - - - - - 增删查改,执行命令完成后触发 - - - - - CodeFirst迁移,执行之前触发 - - - - - CodeFirst迁移,执行完成触发 - - - - - Insert/Update自动值处理 - - - - - ADO.NET DataReader 拦截 - - - - - 监视数据库命令对象(执行前,调试) - - - - - 监视数据库命令对象(执行后,用于监视执行性能) - - - - - 跟踪开始 - - - - - 跟踪结束 - - - - - 内置解析功能,可辅助您进行解析 - - - - - 需要您解析的表达式 - - - - - 解析后的内容 - - - - - 实体类型 - - - - - 实体配置 - - - - - 索引配置 - - - - - 实体类型 - - - - - 实体的属性 - - - - - 实体的属性配置 - - - - - 标识符,可将 CurdBefore 与 CurdAfter 进行匹配 - - - - - 操作类型 - - - - - 实体类型 - - - - - 实体类型的元数据 - - - - - 执行的 SQL - - - - - 参数化命令 - - - - - 状态数据,可与 CurdAfter 共享 - - - - - 发生的错误 - - - - - 执行SQL命令,返回的结果 - - - - - 耗时(单位:Ticks) - - - - - 耗时(单位:毫秒) - - - - - 标识符,可将 SyncStructureBeforeEventArgs 与 SyncStructureAfterEventArgs 进行匹配 - - - - - 实体类型 - - - - - 状态数据,可与 SyncStructureAfter 共享 - - - - - 执行的 SQL - - - - - 发生的错误 - - - - - 耗时(单位:Ticks) - - - - - 耗时(单位:毫秒) - - - - - 类型 - - - - - 属性列的元数据 - - - - - 反射的属性信息 - - - - - 获取实体的属性值,也可以设置实体的属性新值 - - - - - 实体对象 - - - - - 中断实体对象审计 - false: 每个实体对象的属性都会审计(默认) - true: 每个实体对象只审计一次 - - - - - ADO.NET 数据流读取对象 - - - - - DataReader 对应的 Index 位置 - - - - - 获取 Index 对应的值,也可以设置拦截的新值 - - - - - 标识符,可将 CommandBefore 与 CommandAfter 进行匹配 - - - - - 状态数据,可与 CommandAfter 共享 - - - - - 发生的错误 - - - - - 执行SQL命令,返回的结果 - - - - - 耗时(单位:Ticks) - - - - - 耗时(单位:毫秒) - - - - - 标识符,可将 TraceBeforeEventArgs 与 TraceAfterEventArgs 进行匹配 - - - - - 状态数据,可与 TraceAfter 共享 - - - - - 备注 - - - - - 发生的错误 - - - - - 耗时(单位:Ticks) - - - - - 耗时(单位:毫秒) - - - - - 【开发环境必备】自动同步实体结构到数据库,程序运行中检查实体表是否存在,然后创建或修改 - - - - - 转小写同步结构,适用 PostgreSQL - - - - - 转大写同步结构,适用 Oracle/达梦/人大金仓 - - - - - 将数据库的主键、自增、索引设置导入,适用 DbFirst 模式,无须在实体类型上设置 [Column(IsPrimary)] 或者 ConfigEntity。此功能目前可用于 mysql/sqlserver/postgresql/oracle。 - 本功能会影响 IFreeSql 首次访问的速度。 - 若使用 CodeFirst 创建索引后,又直接在数据库上建了索引,若无本功能下一次 CodeFirst 迁移时数据库上创建的索引将被删除 - - - - - 不使用命令参数化执行,针对 Insert/Update - - - - - 是否生成命令参数化执行,针对 lambda 表达式解析 - 注意:常量不会参数化,变量才会做参数化 - var id = 100; - fsql.Select<T>().Where(a => a.id == id) 会参数化 - fsql.Select<T>().Where(a => a.id == 100) 不会参数化 - - - - - 延时加载导航属性对象,导航属性需要声明 virtual - - - - - 将实体类型与数据库对比,返回DDL语句 - - - - - - - 将实体类型集合与数据库对比,返回DDL语句 - - 实体类型 - - - - - 将实体类型与数据库对比,返回DDL语句(指定表名) - - 实体类型 - 指定表名对比 - - - - - 同步实体类型到数据库 - 注意:生产环境中谨慎使用 - - - - - - 同步实体类型集合到数据库 - 注意:生产环境中谨慎使用 - - - - - - 同步实体类型到数据库(指定表名) - 注意:生产环境中谨慎使用 - - 实体类型 - 指定表名对比 - 强制同步结构,无视缓存每次都同步 - - - - 根据 System.Type 获取数据库信息 - - - - - - - FreeSql FluentApi 配置实体,方法名与特性相同 - - - - - - - - FreeSql FluentApi 配置实体,方法名与特性相同 - - - - - - - - 获取 FreeSql FluentApi 配置实体的元数据 - - - 未使用ConfigEntity配置时,返回null - - - - 获取实体类核心配置 - - - - - - - 获取所有数据库 - - - - - - 获取指定数据库的表信息,包括表、列详情、主键、唯一键、索引、外键、备注 - - - - - - - 获取指定单表信息,包括列详情、主键、唯一键、索引、备注 - - 表名,如:dbo.table1 - 是否忽略大小写 - - - - - 判断表是否存在 - - 表名,如:dbo.table1 - 是否忽略大小写 - - - - - 获取数据库枚举类型int值 - - - - - - - 获取c#转换,(int)、(long) - - - - - - - 获取c#值 - - - - - - - 获取c#类型,int、long - - - - - - - 获取c#类型对象 - - - - - - - 获取ado.net读取方法, GetBoolean、GetInt64 - - - - - - - 序列化 - - - - - - - 反序列化 - - - - - - - 获取数据库枚举类型,适用 PostgreSQL - - - - - - - 临时 LambdaExpression.Parameter - - - - - 如果实体类有自增属性,分成两个 List,有值的Item1 merge,无值的Item2 insert - - - - - - - AsType, Ctor, ClearData 三处地方需要重新加载 - - - - - AsType, Ctor, ClearData 三处地方需要重新加载 - - - - - 动态读取 DescriptionAttribute 注释文本 - - - - - - - 通过属性的注释文本,通过 xml 读取 - - - Dict:key=属性名,value=注释 - - - - 更新实体的元数据 - - - - - 执行更新的 SQL - - - - - 执行更新命令的参数 - - - - - 执行更新命令影响的行 - - - - - 更新的实体数量 - - - - - 更新的实体 - - - - - 映射优先级,默认: Attribute > FluentApi > Aop - - - - - 实体特性 - [Table(Name = "tabname")] - [Column(Name = "table_id")] - - - - - 流式接口 - fsql.CodeFirst.ConfigEntity(a => a.Name("tabname")) - fsql.CodeFirst.ConfigEntity(a => a.Property(b => b.Id).Name("table_id")) - - - - - AOP 特性 https://github.com/dotnetcore/FreeSql/wiki/AOP - fsql.Aop.ConfigEntity += (_, e) => e.ModifyResult.Name = "public.tabname"; - fsql.Aop.ConfigEntityProperty += (_, e) => e.ModifyResult.Name = "table_id"; - - - - - 不进行任何处理 - - - - - 将帕斯卡命名字符串转换为下划线分隔字符串 - - BigApple -> Big_Apple - - - - - 将帕斯卡命名字符串转换为下划线分隔字符串,且转换为全大写 - - BigApple -> BIG_APPLE - - - - - 将帕斯卡命名字符串转换为下划线分隔字符串,且转换为全小写 - - BigApple -> big_apple - - - - - 将字符串转换为大写 - - BigApple -> BIGAPPLE - - - - - 将字符串转换为小写 - - BigApple -> bigapple - - - - - 不进行任何处理 - - - - - 将帕斯卡命名字符串转换为下划线分隔字符串 - - BigApple -> Big_Apple - - - - - 将帕斯卡命名字符串转换为下划线分隔字符串,且转换为全大写 - - BigApple -> BIG_APPLE - - - - - 将帕斯卡命名字符串转换为下划线分隔字符串,且转换为全小写 - - BigApple -> big_apple - - - - - 将字符串转换为大写 - - BigApple -> BIGAPPLE - - - - - 将字符串转换为小写 - - BigApple -> bigapple - - - - - 创建一个过滤器 - 提示:在 Lambda 中判断登陆身份,请参考资料 AsyncLocal - - - 名字 - 表达式 - - - - - 创建一个动态过滤器,当 condition 返回值为 true 时才生效 - 场景:当登陆身份是管理员,则过滤条件不生效 - 提示:在 Lambda 中判断登陆身份,请参考资料 AsyncLocal - - - 名字 - 委托,返回值为 true 时才生效 - 表达式 - - - - - 创建一个过滤器(实体类型 属于指定 TEntity 才会生效) - 提示:在 Lambda 中判断登陆身份,请参考资料 AsyncLocal - - - 名字 - 表达式 - - - - - 创建一个过滤器(实体类型 属于指定 TEntity 才会生效) - 场景:当登陆身份是管理员,则过滤条件不生效 - 提示:在 Lambda 中判断登陆身份,请参考资料 AsyncLocal - - - 名字 - 委托,返回值为 true 时才生效 - 表达式 - - - - - 使用指定 DbConnection 连接执行 - - - - - - - 使用指定 DbTransaction 事务执行 - - - - - - - 增加参数化对象 - - 参数名 - 参数值 - 修改本次创建好的参数化对象,比如将 parameterName 参数修改为 Output 类型 - - - - - 设置执行的命令类型,SQL文本、或存储过程 - - - - - - - 设置命令执行超时(秒) - - - - - - - 分页信息 - - - - - 第几页,从1开始 - - - - - 每页多少 - - - - - 查询的记录数量 - - - - - 当前操作的数据 - - - - - 当前批次 - - - - - 总批次数量 - - - - - 获取 obj.CsName 属性值 MapType 之后的数据库值 - - - - - - - 获取 obj.CsName 属性原始值(不经过 MapType) - - - - - - 设置 obj.CsName 属性值 - - - - - - - 动态过滤条件 - - - - - 属性名:Name - 导航属性:Parent.Name - 多表:b.Name - - - - - 操作符 - - - - - 值 - - - - - Filters 下的逻辑运算符 - - - - - 子过滤条件,它与当前的逻辑关系是 And - 注意:当前 Field 可以留空 - - - - - like - - - - - = - Equal/Equals/Eq 效果相同 - - - - - = - Equal/Equals/Eq 效果相同 - - - - - = - Equal/Equals/Eq 效果相同 - - - - - <> - - - - - > - - - - - >= - - - - - < - - - - - <= - - - - - >= and < - 此时 Value 的值格式为逗号分割:value1,value2 或者数组 - - - - - >= and < - 此时 Value 的值格式为逗号分割:date1,date2 或者数组 - 这是专门为日期范围查询定制的操作符,它会处理 date2 + 1,比如: - 当 date2 选择的是 2020-05-30,那查询的时候是 < 2020-05-31 - 当 date2 选择的是 2020-05,那查询的时候是 < 2020-06 - 当 date2 选择的是 2020,那查询的时候是 < 2021 - 当 date2 选择的是 2020-05-30 12,那查询的时候是 < 2020-05-30 13 - 当 date2 选择的是 2020-05-30 12:30,那查询的时候是 < 2020-05-30 12:31 - 并且 date2 只支持以上 5 种格式 (date1 没有限制) - - - - - in (1,2,3) - 此时 Value 的值格式为逗号分割:value1,value2,value3... 或者数组 - - - - - not in (1,2,3) - 此时 Value 的值格式为逗号分割:value1,value2,value3... 或者数组 - - - - - 自定义解析,此时 Field 为反射信息,Value 为静态方法的参数(string/Expression) - 示范:{ Operator: "Custom", Field: "RawSql webapp1.DynamicFilterCustom,webapp1", Value: "(id,name) in ((1,'k'),(2,'m'))" } - 注意:使用者自己承担【注入风险】 - 静态方法定义示范: - namespace webapp1 - { - public class DynamicFilterCustom - { - [DynamicFilterCustom] - public static string RawSql(object sender, string value) => value; - } - } - - - - - 授权 DynamicFilter 支持 Custom 自定义解析 - - - - - 是否放弃继续读取 - - - - - 中间表,多对多 - - - - - PostgreSQL 数组类型专属功能 - 方式一:select * from Role where Id in (RoleIds) - class User { - ____public int[] RoleIds { get; set; } - ____[Navigate(nameof(RoleIds))] - ____public List<Role> Roles { get; set; } - } - 方式二:select * from User where RoleIds @> Id - class Role { - ____public int Id { get; set; } - ____[Navigate(nameof(User.RoleIds))] - ____public List<User> Users { get; set; } - } - - - - - 是否可用 - - - - - 不可用错误 - - - - - 不可用时间 - - - - - 将对象池设置为不可用,后续 Get/GetAsync 均会报错,同时启动后台定时检查服务恢复可用 - - - - 由【可用】变成【不可用】时返回true,否则返回false - - - - 统计对象池中的对象 - - - - - 统计对象池中的对象(完整) - - - - - 获取资源 - - 超时 - - - - - 获取资源 - - - - - - 使用完毕后,归还资源 - - 对象 - 是否重新创建 - - - - 名称 - - - - - 池容量 - - - - - 默认获取超时设置 - - - - - 空闲时间,获取时若超出,则重新创建 - - - - - 异步获取排队队列大小,小于等于0不生效 - - - - - 获取超时后,是否抛出异常 - - - - - 监听 AppDomain.CurrentDomain.ProcessExit/Console.CancelKeyPress 事件自动释放 - - - - - 后台定时检查可用性间隔秒数 - - - - - 权重 - - - - - 对象池的对象被创建时 - - 返回被创建的对象 - - - - 销毁对象 - - 资源对象 - - - - 从对象池获取对象超时的时候触发,通过该方法统计 - - - - - 从对象池获取对象成功的时候触发,通过该方法统计或初始化对象 - - 资源对象 - - - - 从对象池获取对象成功的时候触发,通过该方法统计或初始化对象 - - 资源对象 - - - - 归还对象给对象池的时候触发 - - 资源对象 - - - - 检查可用性 - - 资源对象 - - - - - 事件:可用时触发 - - - - - 事件:不可用时触发 - - - - - 所属对象池 - - - - - 在对象池中的唯一标识 - - - - - 资源对象 - - - - - 被获取的总次数 - - - - 最后获取时的时间 - - - - 最后归还时的时间 - - - - - 创建时间 - - - - - 最后获取时的线程id - - - - - 最后归还时的线程id - - - - - 重置 Value 值 - - - - - 对象池管理类 - - 对象类型 - - - - 后台定时检查可用性 - - - - - - 创建对象池 - - 池大小 - 池内对象的创建委托 - 获取池内对象成功后,进行使用前操作 - - - - 创建对象池 - - 策略 - - - - 获取可用资源,或创建资源 - - - - - - - String resources used in FreeSql exceptions, etc. - - - These strings are exposed publicly for use by database providers and extensions. - It is unusual for application code to need these strings. - - - - - - 重写当前线程的 CurrentUICulture 属性,对 - 使用此强类型资源类的所有资源查找执行重写。 - - - - - [Table(AsTable = "{asTable}")] 特性值格式错误 - - - - - [Table(AsTable = xx)] 设置的属性名 {atmGroupsValue} 不是 DateTime 类型 - - - - - {name}: Failed to get resource {statistics} - - - - - {name}: An exception needs to be thrown - - - - - 错误的表达式格式 {column} - - - - - Chunk 功能之前不可使用 Select - - - - - 安全起见,请务必在事务开启之后,再使用 ForUpdate - - - - - 不能为 null - - - - - {name} 不能为 null - - - - - 无法匹配 {property} - - - - - {property} 无法解析为表达式树 - - - - - 参数 masterConnectionString 不可为空,请检查 UseConnectionString - - - - - 提交 - - - - - 连接失败,准备切换其他可用服务器 - - - - - 自定义表达式解析错误:类型 {exp3MethodDeclaringType} 需要定义 static ThreadLocal<ExpressionCallContext> 字段、字段、字段(重要三次提醒) - - - - - Custom { 反射信息 }不能为空,格式:{ 静态方法名 }{ 空格 }{ 反射信息 } - - - - - Custom { 静态方法名 }不能为空,格式:{ 静态方法名 }{ 空格 }{ 反射信息 } - - - - - Custom 对应的{{ 静态方法名 }}:{fiValueCustomArray} 未设置 [DynamicFilterCustomAttribute] 特性 - - - - - Custom 要求 Field 应该空格分割,并且长度为 2,格式:{ 静态方法名 }{ 空格 }{ 反射信息 } - - - - - 操作的数据类型({dataDisplayCsharp}) 与 AsType({tableTypeDisplayCsharp}) 不一致,请检查。 - - - - - DateRange 要求 Value 应该逗号分割,并且长度为 2 - - - - - DateRange 要求 Value[1] 格式必须为:yyyy、yyyy-MM、yyyy-MM-dd、yyyy-MM-dd HH、yyyy、yyyy-MM-dd HH:mm - - - - - 记录可能不存在,或者【行级乐观锁】版本过旧,更新数量{sourceCount},影响的行数{affrows}。 - - - - - SlaveConnectionString 数量与 SlaveWeights 不相同 - - - - - ColumnAttribute.Name {colattrName} 重复存在,请检查(注意:不区分大小写) - - - - - 属性名 {pName} 重复存在,请检查(注意:不区分大小写) - - - - - {function} 功能要求实体类 {tableCsName} 必须有主键 - - - - - {tbTypeFullName} 是父子关系,但是 MySql 8.0 以下版本中不支持组合多主键 - - - - - {tbTypeFullName} 不是父子关系,无法使用该功能 - - - - - 这个特别的子查询不能解析 - - - - - 表达式错误,它的顶级对象不是 ParameterExpression:{exp} - - - - - 表达式错误,它不是连续的 MemberAccess 类型:{exp} - - - - - ExpressionTree 转换类型错误,值({value}),类型({valueTypeFullName}),目标类型({typeFullName}),{exMessage} - - - - - 未能解析分表字段值 {sqlWhere} - - - - - AsTable 未实现的功能 {asTable} - - - - - GBase 暂时不支持逗号以外的分割符 - - - - - tableName:{tableName} 生成了相同的分表名 - - - - - GetPrimarys 传递的参数 "{primary}" 不正确,它不属于字典数据的键名 - - - - - 已经指定了 {first},不能再指定 {second} - - - - - {tb2DbName}.{mp2MemberName} 被忽略,请检查 IsIgnore 设置,确认 get/set 为 public - - - - - Include 参数类型错误 - - - - - Include 参数类型错误,集合属性请使用 IncludeMany - - - - - Include 参数类型错误,表达式类型应该为 MemberAccess - - - - - IncludeMany 类型 {tbTypeDisplayCsharp} 的属性 {collMemMemberName} 不是有效的导航属性,提示:IsIgnore = true 不会成为导航属性 - - - - - IncludeMany {navigateSelector} 参数错误,Select 只可以使用一个参数的方法,正确格式:.Select(t =>new TNavigate {{}}) - - - - - IncludeMany {navigateSelector} 参数错误,Select lambda参数返回值必须和 {collMemElementType} 类型一致 - - - - - IncludeMany 参数1 类型错误,表达式类型应该为 MemberAccess - - - - - IncludeMany {navigateSelector} 参数类型错误,正确格式: a.collections.Take(1).Where(c =>c.aid == a.id).Select(a=> new TNavigate{{}}) - - - - - ISelect.InsertInto() 未选择属性: {displayCsharp} - - - - - ISelect.InsertInto() 类型错误: {displayCsharp} - - - - - InsertOrUpdate 功能执行 merge into 要求实体类 {CsName} 必须有主键 - - - - - InsertOrUpdate<>的泛型参数 不支持 {typeofT1},请传递您的实体类 - - - - - 【延时加载】功能需要安装 FreeSql.Extensions.LazyLoading.dll,可前往 nuget 下载 - - - - - 【延时加载】{trytbTypeName} 编译错误:{exMessage}\r\n\r\n{cscode} - - - - - 【延时加载】实体类型 {trytbTypeName} 必须声明为 public - - - - - ManyToMany 导航属性 .AsSelect() 暂时不可用于 Sum/Avg/Max/Min/First/ToOne/ToList 方法 - - - - - 【ManyToMany】导航属性 {trytbTypeName}.{pnvName} 在 {tbmidCsName} 中没有找到对应的字段,如:{midTypePropsTrytbName}{findtrytbPkCsName}、{midTypePropsTrytbName}_{findtrytbPkCsName} - - - - - 【ManyToMany】导航属性 {trytbTypeName}.{pnvName} 解析错误,实体类型 {tbrefTypeName} 缺少主键标识,[Column(IsPrimary = true)] - - - - - 【ManyToMany】导航属性 {trytbTypeName}.{pnvName} 解析错误,实体类型 {tbrefTypeName} 必须存在对应的 [Navigate(ManyToMany = x)] 集合属性 - - - - - 【ManyToMany】导航属性 {trytbTypeName}.{pnvName} 解析错误,{tbmidCsName}.{trycolCsName} 和 {trytbCsName}.{trytbPrimarysCsName} 类型不一致 - - - - - 【ManyToMany】导航属性 {trytbTypeName}.{pnvName} 解析错误,中间类 {tbmidCsName}.{midTypePropsTrytbName} 错误:{exMessage} - - - - - 【ManyToMany】导航属性 {trytbTypeName}.{pnvName} 解析错误,中间类 {tbmidCsName}.{midTypePropsTrytbName} 导航属性不是【ManyToOne】或【OneToOne】 - - - - - 映射异常:{name} 没有一个属性名相同 - - - - - Ado.MasterPool 值为 null,该操作无法自启用事务,请显式传递【事务对象】解决 - - - - - 缺少 FreeSql 数据库实现包:FreeSql.Provider.{Provider}.dll,可前往 nuget 下载 - - - - - 缺少 FreeSql 数据库实现包:{dll},可前往 nuget 下载;如果存在 {dll} 依然报错(原因是环境问题导致反射不到类型),请在 UseConnectionString/UseConnectionFactory 第三个参数手工传入 typeof({providerType}) - - - - - 导航属性 {trytbTypeName}.{pnvName} 特性 [Navigate] Bind 数目({bindColumnsCount}) 与 外部主键数目({tbrefPrimarysLength}) 不相同 - - - - - {tb2DbName}.{mp2MemberName} 导航属性集合忘了 .AsSelect() 吗?如果在 ToList(a => a.{mp2MemberName}) 中使用,请移步参考 IncludeMany 文档。 - - - - - 【导航属性】{trytbTypeDisplayCsharp}.{pName} 缺少 set 属性 - - - - - 导航属性 {trytbTypeName}.{pnvName} 没有找到对应的字段,如:{pnvName}{findtbrefPkCsName}、{pnvName}_{findtbrefPkCsName}。或者使用 [Navigate] 特性指定关系映射。 - - - - - 导航属性 {trytbTypeName}.{pnvName} 解析错误,实体类型 {trytcTypeName} 缺少主键标识,[Column(IsPrimary = true)] - - - - - 导航属性 {trytbTypeName}.{pnvName} 解析错误,{trytbCsName}.{trycolCsName} 和 {tbrefCsName}.{tbrefPrimarysCsName} 类型不一致 - - - - - 导航属性 {trytbTypeName}.{pnvName} 特性 [Navigate] 解析错误,在 {tbrefTypeName} 未找到属性:{bi} - - - - - {tableTypeDisplayCsharp} 没有定义主键,无法使用 SetSource,请尝试 SetDto 或者 SetSource 指定临时主键 - - - - - 没有定义属性 - - - - - 未实现 - - - - - 未实现函数表达式 {exp} 解析 - - - - - 未实现函数表达式 {exp} 解析,参数 {expArguments} 必须为常量 - - - - - 未实现函数表达式 {exp} 解析,如果正在操作导航属性集合,请使用 .AsSelect().{exp3MethodName}({exp3ArgumentsCount}) - - - - - 未实现 MemberAccess 下的 Constant - - - - - 未实现 {name} - - - - - 不支持 - - - - - {dataType} 不支持 OrderByRandom 随机排序 - - - - - {property} 不是有效的导航属性 - - - - - {dbName} 找不到列 {memberName} - - - - - 找不到 {CsName} 对应的列 - - - - - 找不到属性:{memberName} - - - - - 找不到属性名 {proto} - - - - - Custom 找不到对应的{{ 反射信息 }}:{fiValueCustomArray} - - - - - Custom 找不到对应的{{ 静态方法名 }}:{fiValueCustomArray} - - - - - [Table(AsTable = xx)] 设置的属性名 {atmGroupsValue} 不存在 - - - - - 未指定 UseConnectionString 或者 UseConnectionFactory - - - - - 【{policyName}】ObjectPool.{GetName}() timeout {totalSeconds} seconds, see: https://github.com/dotnetcore/FreeSql/discussions/1081 - - - - - 【{policyName}】ObjectPool.GetAsync() The queue is too long. Policy.AsyncGetCapacity = {asyncGetCapacity} - - - - - 【OneToMany】导航属性 {trytbTypeName}.{pnvName} 在 {tbrefCsName} 中没有找到对应的字段,如:{findtrytb}{findtrytbPkCsName}、{findtrytb}_{findtrytbPkCsName} - - - - - 【OneToMany】导航属性 {trytbTypeName}.{pnvName} 解析错误,{trytbCsName}.{trytbPrimarysCsName} 和 {tbrefCsName}.{trycolCsName} 类型不一致 - - - - - 、{refpropName}{findtrytbPkCsName}、{refpropName}_{findtrytbPkCsName}。或者使用 [Navigate] 特性指定关系映射。 - - - - - 参数 field 未指定 - - - - - {property} 参数错误,它不是集合属性,必须为 IList<T> 或者 ICollection<T> - - - - - {property} 参数错误,它不是有效的导航属性 - - - - - {where} 参数错误,{keyval} 不是有效的属性名,在实体类 {reftbTypeDisplayCsharp} 无法找到 - - - - - {property} 参数错误,格式 "TopicId=Id,多组使用逗号连接" - - - - - 解析失败 {callExpMethodName} {message} - - - - - 【{policyName}】The ObjectPool has been disposed, see: https://github.com/dotnetcore/FreeSql/discussions/1079 - - - - - 【{policyName}】状态不可用,等待后台检查程序恢复方可使用。{UnavailableExceptionMessage} - - - - - 属性{trytbVersionColumnCsName} 被标注为行锁(乐观锁)(IsVersion),但其必须为数字类型 或者 byte[] 或者 string,并且不可为 Nullable - - - - - properties 参数不能为空 - - - - - {property} 属性名无法找到 - - - - - Range 要求 Value 应该逗号分割,并且长度为 2 - - - - - 回滚 - - - - - 运行时错误,反射获取 IncludeMany 方法失败 - - - - - 蛋疼的 Access 插入只能一条一条执行,不支持 values(..),(..) 也不支持 select .. UNION ALL select .. - - - - - BaseEntity.Initialization 初始化错误,获取到 IFreeSql 是 null - - - - - 【{thisName}】Block access and wait for recovery: {exMessage} - - - - - 无法将 IQueryable<{typeofName}> 转换为 ISelect<{typeofName}>,因为他的实现不是 FreeSql.Extensions.Linq.QueryableProvider - - - - - 连接字符串错误 - - - - - 【{thisName}】连接字符串错误,请检查。 - - - - - 连接字符串错误,或者检查项目属性 > 生成 > 目标平台:x86 | x64,或者改用 FreeSql.Provider.SqliteCore 访问 arm 平台 - - - - - 【{thisName}】连接字符串错误,请检查。或者检查项目属性 > 生成 > 目标平台:x86 | x64,或者改用 FreeSql.Provider.SqliteCore 访问 arm 平台 - - - - - FreeSql.Provider.CustomAdapter 无法使用 CreateCommand - - - - - FreeSql.Provider.CustomAdapter 仅支持 UseConnectionFactory 方式构建 IFreeSql - - - - - 达梦 CodeFirst 不支持代码创建 tablespace 与 schemas {tbname} - - - - - -DB 参数错误,未提供 ConnectionString - - - - - -DB 参数错误,格式为:MySql,ConnectionString - - - - - -DB 参数错误,不支持的类型:"{dbargs}" - - - - - {method} 是 FreeSql.Provider.{provider} 特有的功能 - - - - - fsql.InsertOrUpdate Sqlite 无法完成 UpdateColumns 操作 - - - - - 主库 - - - - - MygisGeometry.Parse 未实现 "{wkt}" - - - - - -NameOptions 参数错误,格式为:0,0,0,0 - - - - - 未实现该功能 - - - - - 未实现错误,请反馈给作者 - - - - - 找不到 {name} - - - - - FreeSql.Provider.{providerName} 未实现 Skip/Offset 功能,如果需要分页请使用判断上一次 id - - - - - 对象池 - - - - - 旧表(OldName):{tboldname} 存在,数据库已存在 {tbname} 表,无法改名 - - - - - OnConflictDoUpdate 功能要求实体类必须设置 IsPrimary 属性 - - - - - Oracle CodeFirst 不支持代码创建 tablespace 与 schemas {tbname} - - - - - 解析失败 {callExpMethodName} {message},提示:可以使用扩展方法 IQueryable.RestoreToSelect() 还原为 ISelect 再查询 - - - - - fsql.InsertOrUpdate + IfExistsDoNothing + {providerName}要求实体类 {tableCsName} 必须有主键 - - - - - SelectMany 错误的类型:{typeFullName} - - - - - 从库 - - - - - 类型 {objentityTypeFullName} 不可迁移 - - - - - 类型 {objentityTypeFullName} 不可迁移,可迁移属性0个 - - - - - 未实现 {columnDbTypeTextFull} 类型映射 - - - - - 错误的参数设置:{args} - - - - - {qoteSql} is NULL,除非设置特性 [Column(IsNullable = false)] - - - - - 分表字段值 "{dt}" 不能小于 "{beginTime} " - - - - - 分表字段值不能为 null - - - - - 分表字段值 "{columnValue}" 不能转化成 DateTime - - - - - 分表字段值 "{dt}" 未匹配到分表名 - - - - - T2 类型错误 - - - - - tableName 格式错误,示例:“log_{yyyyMMdd}” - - - - - {Type}.AsType 参数错误,请传入正确的实体类型 - - - - - {thatFullName} 类型无法访问构造函数 - - - - - {name} 类型错误 - - - - - {Type}.AsType 参数不支持指定为 object - - - - - 类型 {typeofFullName} 错误,不能使用 IncludeMany - - - - - 无法解析表达式:{exp} - - - - - 无法解析表达式方法 {exp3tmpCallMethodName} - - - - - 请使用 fsql.InsertDict(dict) 方法插入字典数据 - - - - - C#: that >= between && that <= and - SQL: that BETWEEN between AND and - - - - - - - - - 注意:这个方法和 Between 有细微区别 - C#: that >= start && that < end - SQL: that >= start and that < end - - - - - - - - - 获取 Type 的原始 c# 文本表示 - - - - - - - - 测量两个经纬度的距离,返回单位:米 - - 经纬坐标1 - 经纬坐标2 - 返回距离(单位:米) - - - - 将 IEnumable<T> 转成 ISelect<T>,以便使用 FreeSql 的查询功能。此方法用于 Lambda 表达式中,快速进行集合导航的查询。 - - - - - - - - 多表查询 - - - - - - 本方法实现从已知的内存 List 数据,进行和 ISelect.IncludeMany 相同功能的贪婪加载 - 示例:new List<Song>(new[] { song1, song2, song3 }).IncludeMany(fsql, a => a.Tags); - 文档:https://github.com/dotnetcore/FreeSql/wiki/%E8%B4%AA%E5%A9%AA%E5%8A%A0%E8%BD%BD - - - - - - 选择一个集合的导航属性,如: .IncludeMany(a => a.Tags) - 可以 .Where 设置临时的关系映射,如: .IncludeMany(a => a.Tags.Where(tag => tag.TypeId == a.Id)) - 可以 .Take(5) 每个子集合只取5条,如: .IncludeMany(a => a.Tags.Take(5)) - 可以 .Select 设置只查询部分字段,如: (a => new TNavigate { Title = a.Title }) - - 即能 ThenInclude,还可以二次过滤(这个 EFCore 做不到?) - - - - - 本方法实现从已知的内存 List 数据,进行和 ISelect.IncludeMany/Include 相同功能的贪婪加载 - 集合:new List<Song>(new[] { song1, song2, song3 }).IncludeByPropertyName(fsql, "Tags", "ParentId=Id", 5, "Id,Name"); - 普通:new List<Song>(new[] { song1, song2, song3 }).IncludeByPropertyName(fsql, "Catetory"); - ---普通属性 where/take/select 参数将无效 - 文档:https://github.com/dotnetcore/FreeSql/wiki/%E8%B4%AA%E5%A9%AA%E5%8A%A0%E8%BD%BD - - - - - 选择一个集合或普通属性 - 设置临时的子集合关系映射,格式:子类属性=T1属性,多组以逗号分割 - 设置子集合只取条数 - 设置子集合只查询部分字段 - - - - - - 查询数据,加工为树型 List 返回 - 注意:实体需要配置父子导航属性 - - - - - - - - 使用递归 CTE 查询树型的所有子记录,或者所有父记录。 - 通过测试的数据库:MySql8.0、SqlServer、PostgreSQL、Oracle、Sqlite、Firebird、达梦、人大金仓、翰高 - 返回隐藏字段:.ToList(a => new { item = a, level = "a.cte_level", path = "a.cte_path" }) - * v2.0.0 兼容 MySql5.6 向上或向下查询,但不支持 pathSelector/pathSeparator 详细:https://github.com/dotnetcore/FreeSql/issues/536 - - - - false(默认):由父级向子级的递归查询true:由子级向父级的递归查询 - 路径内容选择 - 连接路径内容 - 递归层级 - - - - - 随机排序 - 支持:MySql/SqlServer/PostgreSQL/Oracle/Sqlite/Firebird/达梦/金仓/神通 - 不支持:MsAcess - - - - - - 插入数据字典 Dictionary<string, object> - - - - - - - 插入数据字典,传入 Dictionary<string, object> 集合 - - - - - - - 更新数据字典 Dictionary<string, object> - - - - - - - 更新数据字典,传入 Dictionary<string, object> 集合 - - - - - - - 插入或更新数据字典,此功能依赖数据库特性(低版本可能不支持),参考如下: - MySql 5.6+: on duplicate key update - PostgreSQL 9.4+: on conflict do update - SqlServer 2008+: merge into - Oracle 11+: merge into - Sqlite: replace into - 达梦: merge into - 人大金仓:on conflict do update - 神通:merge into - MsAccess:不支持 - - - - - - - 删除数据字典 Dictionary<string, object> - - - - - - - 删除数据字典,传入 Dictionary<string, object> 集合 - - - - - - - 使用 and 拼接两个 lambda 表达式 - - - - - - 使用 and 拼接两个 lambda 表达式 - - - true 时生效 - - - - - - 使用 or 拼接两个 lambda 表达式 - - - - - - 使用 or 拼接两个 lambda 表达式 - - - true 时生效 - - - - - - 将 lambda 表达式取反 - - - true 时生效 - - - - - 使用 and 拼接两个 lambda 表达式 - - - - - - 使用 and 拼接两个 lambda 表达式 - - - true 时生效 - - - - - - 使用 or 拼接两个 lambda 表达式 - - - - - - 使用 or 拼接两个 lambda 表达式 - - - true 时生效 - - - - - - 将 lambda 表达式取反 - - - true 时生效 - - - - - 使用 and 拼接两个 lambda 表达式 - - - - - - 使用 and 拼接两个 lambda 表达式 - - - true 时生效 - - - - - - 使用 or 拼接两个 lambda 表达式 - - - - - - 使用 or 拼接两个 lambda 表达式 - - - true 时生效 - - - - - - 将 lambda 表达式取反 - - - true 时生效 - - - - - 使用 and 拼接两个 lambda 表达式 - - - - - - 使用 and 拼接两个 lambda 表达式 - - - true 时生效 - - - - - - 使用 or 拼接两个 lambda 表达式 - - - - - - 使用 or 拼接两个 lambda 表达式 - - - true 时生效 - - - - - - 将 lambda 表达式取反 - - - true 时生效 - - - - - 使用 and 拼接两个 lambda 表达式 - - - - - - 使用 and 拼接两个 lambda 表达式 - - - true 时生效 - - - - - - 使用 or 拼接两个 lambda 表达式 - - - - - - 使用 or 拼接两个 lambda 表达式 - - - true 时生效 - - - - - - 将 lambda 表达式取反 - - - true 时生效 - - - - - 生成类似Mongodb的ObjectId有序、不重复Guid - - - - - - 插入数据 - - - - - - - 插入数据,传入实体 - - - - - - - - 插入数据,传入实体数组 - - - - - - - - 插入数据,传入实体集合 - - - - - - - - 插入数据,传入实体集合 - - - - - - - - 插入或更新数据,此功能依赖数据库特性(低版本可能不支持),参考如下: - MySql 5.6+: on duplicate key update - PostgreSQL 9.4+: on conflict do update - SqlServer 2008+: merge into - Oracle 11+: merge into - Sqlite: replace into - 达梦: merge into - 人大金仓:on conflict do update - 神通:merge into - MsAccess:不支持 - 注意区别:FreeSql.Repository 仓储也有 InsertOrUpdate 方法(不依赖数据库特性) - - - - - - - 修改数据 - - - - - - - 修改数据,传入动态条件,如:主键值 | new[]{主键值1,主键值2} | TEntity1 | new[]{TEntity1,TEntity2} | new{id=1} - - - 主键值、主键值集合、实体、实体集合、匿名对象、匿名对象集合 - - - - - 查询数据 - - - - - - - 查询数据,传入动态条件,如:主键值 | new[]{主键值1,主键值2} | TEntity1 | new[]{TEntity1,TEntity2} | new{id=1} - - - 主键值、主键值集合、实体、实体集合、匿名对象、匿名对象集合 - - - - - 删除数据 - - - - - - - 删除数据,传入动态条件,如:主键值 | new[]{主键值1,主键值2} | TEntity1 | new[]{TEntity1,TEntity2} | new{id=1} - - - 主键值、主键值集合、实体、实体集合、匿名对象、匿名对象集合 - - - - - 开启事务(不支持异步) - v1.5.0 关闭了线程事务超时自动提交的机制 - - 事务体 () => {} - - - - 开启事务(不支持异步) - v1.5.0 关闭了线程事务超时自动提交的机制 - - - 事务体 () => {} - - - - 数据库访问对象 - - - - - 所有拦截方法都在这里 - - - - - CodeFirst 模式开发相关方法 - - - - - DbFirst 模式开发相关方法 - - - - - 全局过滤设置,可默认附加为 Select/Update/Delete 条件 - - - - diff --git a/BaseModule/bin/Debug/MaterialDesignThemes.Wpf.xml b/BaseModule/bin/Debug/MaterialDesignThemes.Wpf.xml deleted file mode 100644 index 9caea5c..0000000 --- a/BaseModule/bin/Debug/MaterialDesignThemes.Wpf.xml +++ /dev/null @@ -1,1930 +0,0 @@ - - - - MaterialDesignThemes.Wpf - - - - - Controls the corner radius of the surrounding box. - - - - - Provides culture-specific information about the format of calendar. - - - - - Gets the custom format string for a year and month value. - - - - - Gets the custom format string for a component one value. - - - - - Gets the custom format string for a component two value. - - - - - Gets the custom format string for a component three value. - - - - - Sets the culture-specific custom format string for a year value. - - An array of string that specify the name of culture to set the for. - The custom format string for a year value. If null, culture-specific custom format string for a year value is removed. - is null. - - - - Sets the culture-specific custom format string for a year value. - - A string that specify the name of culture to set the for. - The custom format string for a year value. If null, culture-specific custom format string for a year value is removed. - is null. - - - - Sets the culture-specific day of week style. - - An array of string that specify the name of culture to set the for. - A to be set. - is null. - - - - Sets the culture-specific day of week style. - - A string that specify the name of culture to set the for. - A to be set. - is null. - - - - Resets the culture-specific day of week style to default value. - - An array of string that specify the name of culture to reset. - is null. - - - - Resets the culture-specific day of week style to default value. - - A string that specify the name of culture to reset. - is null. - - - - Creates a from the . - - A that specifies the culture to get the date format. - The object that this method creates. - is null. - - - - Represents a day of week style. - - - - - Gets the custom format string for a day of week value. - - - - - Gets the string that separates MonthDay and DayOfWeek. - - - - - Gets a value indicating whether DayOfWeek is before MonthDay. - - - - - Initializes a new instance of the struct. - - A custom format string for a day of week value. - A string that separates MonthDay and DayOfWeek. - A value indicating whether DayOfWeek is before MonthDay. - - - - Extracts the from the date format string. - - the date format string. - The struct. - is null. - - - - Indicates if the delete button should be visible. - - - - - This override method is called when the control is clicked by mouse or keyboard - - - - - User a colour zone to easily switch the background and foreground colours, from selected Material Design palette or custom ones. - - - - - By default ComboBox uses the wrapper popup. Popup can be switched to classic Windows desktop view by means of this attached property. - - - - - By default the selected item is displayed in the drop down list, as per Material Design specifications. - To change this to a behavior of hiding the selected item from the drop down list, set this attached property to false. - - - - - Gets or sets the maximum number of characters that can be manually entered into the text box.
- - cannot be set for an editable ComboBox. That's why this attached property exists. - -
-
- - - Help us format the content of a header button in a calendar. - - - Expected items, in the following order: - 1) DateTime Calendar.DisplayDate - 2) DateTime? Calendar.SelectedDate - - - - - CircularProgressBar draws two arcs to support a full circle at 100 %. - With one arc at 100 % the start point is identical the end point, so nothing is drawn. - Midpoint at half of current percentage is the endpoint of the first arc - and the start point of the second arc. - - - - - Value converter that uses the Cursor from the bound property if set, otherwise it returns the . - - - - - Converter for control. Can be extended by method. - - - - - Helps coerce the correct item container style for a , according to whether the list is displaying in standard mode, or using a , such as a . - - - - - Item container style to use when is null. - - - - - Item container style to use when is not null, typically when a is applied. - - - - - Returns the item container to use for a . - - Should be a or instance. - - - - - - - - Sets the left padding for the inner picker button to zero - - - - - Adds the width of the inner picker button to the right of inner padding - - - - - 1 - Content presenter render size, - 2 - Clipping border padding (main control padding) - - - - - - - - - - Allows editing of components inside of a data grid cell with a single left click. - - - - - Set the maximum length for the text field. - - Not a dependency property, as is only applied once. - - - - Gets the parameter originally provided to / - - - - - Allows interaction with the current dialog session. - - - - - Cancel the close. - - - - - Indicates if the close has already been cancelled. - - - - - Gets the parameter originally provided to / - - - - - Allows interaction with the current dialog session. - - - - - Defines how a data context is sourced for a dialog if a - is passed as the command parameter when using . - - - - - The data context from the sender element (typically a ) - is applied to the content. - - - - - The data context from the is applied to the content. - - - - - The data context is explicitly set to null. - - - - - Routed command to be used somewhere inside an instance to trigger showing of the dialog. Content can be passed to the dialog via a . - - - - - Routed command to be used inside dialog content to close a dialog. Use a to indicate the result of the parameter. - - - - - Shows a modal dialog. To use, a instance must be in a visual tree (typically this may be specified towards the root of a Window's XAML). - - Content to show (can be a control or view model). - Task result is the parameter used to close the dialog, typically what is passed to the command. - - - - Shows a modal dialog. To use, a instance must be in a visual tree (typically this may be specified towards the root of a Window's XAML). - - Content to show (can be a control or view model). - Allows access to opened event which would otherwise have been subscribed to on a instance. - Task result is the parameter used to close the dialog, typically what is passed to the command. - - - - Shows a modal dialog. To use, a instance must be in a visual tree (typically this may be specified towards the root of a Window's XAML). - - Content to show (can be a control or view model). - Allows access to closing event which would otherwise have been subscribed to on a instance. - Task result is the parameter used to close the dialog, typically what is passed to the command. - - - - Shows a modal dialog. To use, a instance must be in a visual tree (typically this may be specified towards the root of a Window's XAML). - - Content to show (can be a control or view model). - Allows access to opened event which would otherwise have been subscribed to on a instance. - Allows access to closing event which would otherwise have been subscribed to on a instance. - Task result is the parameter used to close the dialog, typically what is passed to the command. - - - - Shows a modal dialog. To use, a instance must be in a visual tree (typically this may be specified towards the root of a Window's XAML). - - Content to show (can be a control or view model). - Allows access to opened event which would otherwise have been subscribed to on a instance. - Allows access to closing event which would otherwise have been subscribed to on a instance. - Allows access to closed event which would otherwise have been subscribed to on a instance. - Task result is the parameter used to close the dialog, typically what is passed to the command. - - - - Shows a modal dialog. To use, a instance must be in a visual tree (typically this may be specified towards the root of a Window's XAML). - - Content to show (can be a control or view model). - of the instance where the dialog should be shown. Typically this will match an identifier set in XAML. null is allowed. - Task result is the parameter used to close the dialog, typically what is passed to the command. - - - - Shows a modal dialog. To use, a instance must be in a visual tree (typically this may be specified towards the root of a Window's XAML). - - Content to show (can be a control or view model). - of the instance where the dialog should be shown. Typically this will match an identifier set in XAML. null is allowed. - Allows access to opened event which would otherwise have been subscribed to on a instance. - Task result is the parameter used to close the dialog, typically what is passed to the command. - - - - Shows a modal dialog. To use, a instance must be in a visual tree (typically this may be specified towards the root of a Window's XAML). - - Content to show (can be a control or view model). - of the instance where the dialog should be shown. Typically this will match an identifier set in XAML. null is allowed. - Allows access to closing event which would otherwise have been subscribed to on a instance. - Task result is the parameter used to close the dialog, typically what is passed to the command. - - - - Shows a modal dialog. To use, a instance must be in a visual tree (typically this may be specified towards the root of a Window's XAML). - - Content to show (can be a control or view model). - of the instance where the dialog should be shown. Typically this will match an identifier set in XAML. null is allowed. - Allows access to opened event which would otherwise have been subscribed to on a instance. - Allows access to closing event which would otherwise have been subscribed to on a instance. - Task result is the parameter used to close the dialog, typically what is passed to the command. - - - - Shows a modal dialog. To use, a instance must be in a visual tree (typically this may be specified towards the root of a Window's XAML). - - Content to show (can be a control or view model). - of the instance where the dialog should be shown. Typically this will match an identifier set in XAML. null is allowed. - Allows access to opened event which would otherwise have been subscribed to on a instance. - Allows access to closing event which would otherwise have been subscribed to on a instance. - Allows access to closed event which would otherwise have been subscribed to on a instance. - Task result is the parameter used to close the dialog, typically what is passed to the command. - - - - Close a modal dialog. - - of the instance where the dialog should be closed. Typically this will match an identifier set in XAML. - - - - Close a modal dialog. - - of the instance where the dialog should be closed. Typically this will match an identifier set in XAML. - to provide to close handler - - - - Retrieve the current dialog session for a DialogHost - - The identifier to use to retrieve the DialogHost - The DialogSession if one is in process, or null - - - - dialog instance exists - - of the instance where the dialog should be closed. Typically this will match an identifier set in XAML. - - - - - Identifier which is used in conjunction with to determine where a dialog should be shown. - - - - - Returns a DialogSession for the currently open dialog for managing it programmatically. If no dialog is open, CurrentSession will return null - - - - - Defines how a data context is sourced for a dialog if a - is passed as the command parameter when using . - - - - - Indicates whether the dialog will close if the user clicks off the dialog, on the obscured background. - - - - - Parameter to provide to close handlers if an close due to click away is instigated. - - - - - Allows association of a snackbar, so that notifications can be paused whilst a dialog is being displayed. - - - - - Set the theme (light/dark) for the dialog. - - - - - Represents the overlay brush that is used to dim the background behind the dialog - - - - - Represents the brush for the Dialog's background - - - - - Raised when a dialog is opened. - - - - - Attached property which can be used on the which instigated the to process the event. - - - - - Callback fired when the event is fired, allowing the event to be processed from a binding/view model. - - - - - Raised just before a dialog is closed. - - - - - Attached property which can be used on the which instigated the to process the closing event. - - - - - Callback fired when the event is fired, allowing the event to be processed from a binding/view model. - - - - - Raised when a dialog is closed. - - - - - Attached property which can be used on the which instigated the to process the closed event. - - - - - Callback fired when the event is fired, allowing the event to be processed from a binding/view model. - - - - - Attempts to focus the content of a popup. - - The popup content. - - - - Helper extensions for showing dialogs. - - - - - Shows a dialog using the first found in a given . - - Window on which the modal dialog should be displayed. Must contain a . - - - Thrown is a is not found when conducting a depth first traversal of visual tree. - - - As a depth first traversal of the window's visual tree is performed, it is not safe to use this method in a situation where a screen has multiple s. - - - - - - Shows a dialog using the first found in a given . - - Window on which the modal dialog should be displayed. Must contain a . - Content to show (can be a control or view model). - Allows access to opened event which would otherwise have been subscribed to on a instance. - - Thrown is a is not found when conducting a depth first traversal of visual tree. - - - As a depth first traversal of the window's visual tree is performed, it is not safe to use this method in a situation where a screen has multiple s. - - - - - - Shows a dialog using the first found in a given . - - Window on which the modal dialog should be displayed. Must contain a . - Content to show (can be a control or view model). - Allows access to closing event which would otherwise have been subscribed to on a instance. - - Thrown is a is not found when conducting a depth first traversal of visual tree. - - - As a depth first traversal of the window's visual tree is performed, it is not safe to use this method in a situation where a screen has multiple s. - - - - - - Shows a dialog using the first found in a given . - - Window on which the modal dialog should be displayed. Must contain a . - Content to show (can be a control or view model). - Allows access to opened event which would otherwise have been subscribed to on a instance. - Allows access to closing event which would otherwise have been subscribed to on a instance. - - Thrown is a is not found when conducting a depth first traversal of visual tree. - - - As a depth first traversal of the window's visual tree is performed, it is not safe to use this method in a situation where a screen has multiple s. - - - - - - Shows a dialog using the first found in a given . - - Window on which the modal dialog should be displayed. Must contain a . - Content to show (can be a control or view model). - Allows access to opened event which would otherwise have been subscribed to on a instance. - Allows access to closing event which would otherwise have been subscribed to on a instance. - Allows access to closed event which would otherwise have been subscribed to on a instance. - - Thrown is a is not found when conducting a depth first traversal of visual tree. - - - As a depth first traversal of the window's visual tree is performed, it is not safe to use this method in a situation where a screen has multiple s. - - - - - - Shows a dialog using the parent/ancestor of the a given . - - Dependency object which should be a visual child of a , where the dialog will be shown. - Content to show (can be a control or view model). - - Thrown is a is not found when conducting a depth first traversal of visual tree. - - - - - - Shows a dialog using the parent/ancestor of the a given . - - Dependency object which should be a visual child of a , where the dialog will be shown. - Content to show (can be a control or view model). - Allows access to opened event which would otherwise have been subscribed to on a instance. - - Thrown is a is not found when conducting a depth first traversal of visual tree. - - - - - - Shows a dialog using the parent/ancestor of the a given . - - Dependency object which should be a visual child of a , where the dialog will be shown. - Content to show (can be a control or view model). - Allows access to closing event which would otherwise have been subscribed to on a instance. - - Thrown is a is not found when conducting a depth first traversal of visual tree. - - - - - - Shows a dialog using the parent/ancestor of the a given . - - Dependency object which should be a visual child of a , where the dialog will be shown. - Content to show (can be a control or view model). - Allows access to opened event which would otherwise have been subscribed to on a instance. - Allows access to closing event which would otherwise have been subscribed to on a instance. - - Thrown is a is not found when conducting a depth first traversal of visual tree. - - - - - - Shows a dialog using the parent/ancestor of the a given . - - Dependency object which should be a visual child of a , where the dialog will be shown. - Content to show (can be a control or view model). - Allows access to opened event which would otherwise have been subscribed to on a instance. - Allows access to closing event which would otherwise have been subscribed to on a instance. - Allows access to closed event which would otherwise have been subscribed to on a instance. - - Thrown is a is not found when conducting a depth first traversal of visual tree. - - - - - - Allows interaction with the current dialog session. - - - - - Allows an open dialog to be managed. Use is only permitted during a single display operation. - - - - - Indicates if the dialog session has ended. Once ended no further method calls will be permitted. - - - Client code cannot set this directly, this is internally managed. To end the dialog session use . - - - - - The parameter passed to the and return by - - - - - Gets the which is currently displayed, so this could be a view model or a UI element. - - - - - Update the current content in the dialog. - - - - - - Closes the dialog. - - Thrown if the dialog session has ended, or a close operation is currently in progress. - - - - Closes the dialog. - - Result parameter which will be returned in or from method. - Thrown if the dialog session has ended, or a close operation is currently in progress. - - - - Cancel the close. - - - - - Indicates if the close has already been cancelled. - - - - - Allows interaction with the current dialog session. - - - - - Raised when a drawer is opened. - - - - - Raised when a drawer is closing. - - - - - Allows interaction with the current dialog session. - - - - - Returns full visual ancestry, starting at the leaf. - If element is not of or the - logical ancestry is used. - - - - - - - Controls the (uniform) corner radius of the contained card - - - - - Controls the style of the contained card - - - - - This interface is the adapter from UiControl (like , and others) to - - You should implement this interface in order to use SmartHint for your own control. - - - - - Checks to see if the targeted control can be deemed as logically - empty, even if not null, affecting the current hint display. - - - - - - Targeted control has keyboard focus - - - - - - Queues a notification message for display in a snackbar. - - Message. - - - - Queues a notification message for display in a snackbar. - - Message. - Content for the action button. - Call back to be executed if user clicks the action button. - - - - Queues a notification message for display in a snackbar. - - Message. - Content for the action button. - Call back to be executed if user clicks the action button. - Argument to pass to . - - - - Queues a notification message for display in a snackbar. - - Message. - Subsequent, duplicate messages queued within a short time span will - be discarded. To override this behaviour and ensure the message always gets displayed set to true. - - - - Queues a notification message for display in a snackbar. - - Message. - Content for the action button. - Call back to be executed if user clicks the action button. - The message will promoted to the front of the queue. - - - - Queues a notification message for display in a snackbar. - - Message. - Content for the action button. - Call back to be executed if user clicks the action button. - Argument to pass to . - The message will be promoted to the front of the queue and never considered to be a duplicate. - - - - Queues a notification message for display in a snackbar. - - Message. - Content for the action button. - Call back to be executed if user clicks the action button. - Argument to pass to . - The message will be promoted to the front of the queue. - The message will never be considered a duplicate. - Message show duration override. - - - - Queues a notification message for display in a snackbar. - - Message. - Content for the action button. - Call back to be executed if user clicks the action button. - Argument to pass to . - The message will promoted to the front of the queue. - The message will never be considered a duplicate. - Message show duration override. - - - - Controls the corner radius of the selection box. - - - - - Provides shorthand to initialise a new for a . - - - - - Controls the corner radius of the selection box. - - - - - Controls the corner radius of the selection box. - - - - - Controls the corner radius of the selection box. - - - - - Floating Content (ex: Button) on navigation rail (optional) - - - - - Gets or sets the icon to display. - - - - - Gets the icon path data for the current . - - - - ****************************************** - This code is auto generated. Do not amend. - ****************************************** - - - ****************************************** - This code is auto generated. Do not amend. - ****************************************** - - List of available icons for use with . - - - All icons sourced from Material Design Icons Font - https://materialdesignicons.com/ - in accordance of - https://github.com/Templarian/MaterialDesign/blob/master/LICENSE. - - - - - Provides full information about a palette. - - - - - View a control on a 3D plane. - - - Taken from http://blogs.msdn.com/greg_schechter/archive/2007/10/26/enter-the-planerator-dead-simple-3d-in-wpf-with-a-stupid-name.aspx , Greg Schechter - Fall 2007 - - - - - Wrap this around a class that we want to catch the measure and arrange - processes occurring on, and propagate to the parent Planerator, if any. - Do this because layout invalidations don't flow up out of a - Viewport2DVisual3D object. - - - - - Defines how the popup is aligned to the toggle part of the control. - - - - - Display the popup below the toggle, and align the left edges.3 - - - - - Display the popup below the toggle, and align the right edges. - - - - - Display the popup below the toggle, and align the center of the popup with the center of the toggle. - - - - - Display the popup above the toggle, and align the left edges. - - - - - Display the popup above the toggle, and align the right edges. - - - - - Display the popup above the toggle, and align the center of the popup with the center of the toggle. - - - - - Display the popup to the left of the toggle, and align the top edges. - - - - - Display the popup to the left of the toggle, and align the bottom edges. - - - - - Display the popup to the left of the toggle, and align the middles. - - - - - Display the popup to the right of the toggle, and align the top edges. - - - - - Display the popup to the right of the toggle, and align the bottom edges. - - - - - Display the popup to the right of the toggle, and align the middles. - - - - - Defines what causes the to open it's popup. - - - - - Open when the toggle button is clicked. - - - - - Open when the mouse goes over the toggle button. - - - - - Open when the mouse goes over the toggle button, or the space in which the popup box would occupy should it be open. - - - - - Popup box, similar to a , but allows more customizable content. - - - - - Routed command to be used inside of a popup content to close it. - - - - - Content to display in the toggle button. - - - - - Template for . - - - - - Content to display in the toggle when it's checked (when the popup is open). Optional; if not provided the is used. - - - - - Template for . - - - - - Command to execute if toggle is checked (popup is open) and is set. - - - - - Command parameter to use in conjunction with . - - - - - Content to display in the content. - - - - - Popup content template. - - - - - Gets or sets whether the popup is currently open. - - - - - Indicates of the popup should stay open if a click occurs inside the popup. - - - - - Gets or sets how the popup is aligned in relation to the toggle. - - - - - Gets or sets what trigger causes the popup to open. - - - - - Get or sets how to unfurl controls when opening the popups. Only child elements of type are animated. - - - - - Gets or sets how to unfurl controls when opening the popups. Only child elements of type are animated. - - - - - Get or sets the popup horizontal offset in relation to the button. - - - - - Get or sets the popup horizontal offset in relation to the button. - - - - - Get or sets the popup vertical offset in relation to the button. - - - - - Get or sets the popup vertical offset in relation to the button. - - - - - Get or sets the corner radius of the popup card. - - - - - Get or sets the corner radius of the popup card. - - - - - Framework use. Provides the method used to position the popup. - - - - - Event raised when the checked toggled content (if set) is clicked. - - - - - Event raised when the checked toggled content (if set) is clicked. - - - - - Raises . - - - - - Raised when the popup is opened. - - - - - Raises . - - - - - Raised when the popup is closed. - - - - - Raises . - - - - - This class was initially based on work done in ControlzEx - https://github.com/ControlzEx/ControlzEx - - This custom popup can be used by validation error templates or something else. - It provides some additional nice features: - - repositioning if host-window size or location changed - - repositioning if host-window gets maximized and vice versa - - it's only topmost if the host-window is activated - - - - - Gets/sets if the popup can be closed by left mouse button down. - - - - - Causes the popup to update it's position according to it's current settings. - - - - - SetWindowPos options - - - - - 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. - - - - - A custom control implementing a rating bar. - The icon aka content may be set as a DataTemplate via the ButtonContentTemplate property. - - - - - Gets or sets the value increments. Set to a value between 0.0 and 1.0 (both exclusive) to enable fractional values. Default value is 1.0 (i.e. fractional values disabled) - - - - - The DependencyProperty for the RecognizesAccessKey property. - Default Value: false - - - - - Determine if Ripple should use AccessText in its style - - - - - Set to true to cause the ripple to originate from the centre of the - content. Otherwise the effect will originate from the mouse down position. - - - - - Set to true to cause the ripple to originate from the centre of the - content. Otherwise the effect will originate from the mouse down position. - - - - - - - Set to true to cause the ripple to originate from the centre of the - content. Otherwise the effect will originate from the mouse down position. - - - - - - Set to True to disable ripple effect - - - - - Set to True to disable ripple effect - - - - - - - Set to True to disable ripple effect - - - - - - Internal use only. - - - - - Represents a display device or multiple display devices on a single system. - Based on http://referencesource.microsoft.com/#System.Windows.Forms/winforms/Managed/System/WinForms/Screen.cs - - - - - Available working area on the screen. This excludes taskbars and other - docked windows. - - - - - Gets an array of all of the displays on the system. - - - - - Gets the bounds of the display. - - - - - Gets the device name associated with a display. - - - - - Gets a value indicating whether a particular display is the primary device. - - - - - Gets the primary display. - - - - - Gets the working area of the screen. - - - - - Screen instances call this property to determine - if their WorkingArea cache needs to be invalidated. - - - - - Specifies a value that indicates whether the specified object is equal to this one. - - - - - Retrieves a for the monitor that contains the specified point. - - - - - Retrieves a for the monitor that contains the largest region of the Rect. - - - - - Retrieves the working area for the monitor that is closest to the specified point. - - - - - Retrieves the working area for the monitor that contains the largest region of the specified Rect. - - - - - Retrieves the bounds of the monitor that is closest to the specified point. - - - - - Retrieves the bounds of the monitor that contains the largest region of the specified Rect. - - - - - Computes and retrieves a hash code for an object. - - - - - Called by the SystemEvents class when our display settings are - changing. We cache screen information and at this point we must - invalidate our cache. - - - - - Called by the SystemEvents class when our display settings have - changed. Here, we increment a static counter that Screen instances - can check against to invalidate their cache. - - - - - Retrieves a string representing this object. - - - - - A control that implement placeholder behavior. Can work as a simple placeholder either as a floating hint, see property. - - To set a target control you should set the HintProxy property. Use the converter which converts a control into the IHintProxy interface. - - - - - Implements a inspired by the Material Design specs (https://material.google.com/components/snackbars-toasts.html). - - - - - Defines the content of a message within a . Primary content should be set via the - standard property. Where an action is allowed, content - can be provided in . Standard button properties are - provided for actions, including . - - - - - Event correspond to left mouse button click on the Action button. - - - - - Add / Remove ActionClickEvent handler - - - - - Maximum total height of snackbar for the action button to be inlined. - - Default value (55) is between single line message (48) and two lined snackbar-message (66) - because tolerance is required (see issue) - - - - - - If set, the active snackbar will be closed. - - - Available only while the snackbar is displayed. - Should be locked by . - - - - - Gets the this is associated with. - - - - - Gets or sets a value that indicates whether this message queue displays messages without discarding duplicates. - False to show every message even if there are duplicates. - - - - - Clear the message queue and close the active snackbar. - This method can be called from any thread. - - - - - The content to be displayed - - - - - Message show duration. - - - - - The content for the action button on the snackbar - - - - - Handler to be invoked when the action button is clicked - - - - - The argument to pass to the delegate. - - - - - Promote the message, pushing it in front of any message that is not promoted. - - - - - Always show this message, even if it's a duplicate - - - - - Automatic ToolTip for TextBlock or TextBoxBase if containing text is trimmed - - - - - Helper properties for working with text fields. - - - - - The text box view margin property - - - - - Sets the text box view margin. - - The element. - The value. - - - - Gets the text box view margin. - - The element. - - The . - - - - - Controls the visibility of the underline decoration. - - - - - Controls the visibility of the underline decoration. - - - - - Controls the visibility of the underline decoration. - - - - - - - The attached WPF property for getting or setting the value for an underline decoration. - - - - - Sets the used for underline decoration. - - - - - - - Gets the used for underline decoration. - - - - - - Controls the visibility of the text field box. - - - - - Controls the visibility of the text field area box. - - - - - Controls the corner radius of the surrounding box. - - - - - Controls the corner radius of the bottom line of the surrounding box. - - - - - Controls the highlighting style of a text box. - - - - - Enables a ripple effect on focusing the text box. - - - - - Automatically inserts spelling suggestions into the text box context menu. - - - - - SuffixText dependency property - - - - - PrefixText dependency property - - - - - Controls the visibility of the clear button. - - - - - Controls visibility of the leading icon - - - - - Controls the leading icon - - - - - Controls the size of the leading icon - - - - - Controls visibility of the trailing icon - - - - - Controls the trailing icon - - - - - Controls the size of the trailing icon - - - - - Applies the text box view margin. - - The text box. - The margin. - - - - The text box view margin property changed callback. - - The dependency object. - The dependency property changed event args. - - - - Get the current Windows theme. - Based on ControlzEx - https://github.com/ControlzEx/ControlzEx/blob/48230bb023c588e1b7eb86ea83f7ddf7d25be735/src/ControlzEx/Theming/WindowsThemeHelper.cs#L19 - - - - - - Called when this element gets focus. - - - - - IsDropDownOpenProperty property changed handler. - - DatePicker that changed its IsDropDownOpen. - DependencyPropertyChangedEventArgs. - - - - Set to true to stop invalid text reverting back to previous valid value. Useful in cases where you - want to display validation messages and allow the user to correct the data without it reverting. - - - - - Set to true to display seconds in the time and allow the user to select seconds. - - - - - Framework use only. - - - - - - - Allows on (IsChecked) content to be provided on supporting styles. - - - - - Allows on (IsChecked) content to be provided on supporting styles. - - - - - - - Allows on (IsChecked) content to be provided on supporting styles. - - - - - Allows an on (IsChecked) template to be provided on supporting styles. - - - - - Allows an on (IsChecked) template to be provided on supporting styles. - - - - - Allows an on (IsChecked) template to be provided on supporting styles. - - - - - Allows transitions to be disabled where supported. - - - - - Allows transitions to be disabled where supported. Note this is an inheritable property. - - - - - Allows transitions to be disabled where supported. Note this is an inheritable property. - - - - - Allows transitions to be disabled where supported. Note this is an inheritable property. - - - - - Duration of the animation - - - - - Multiplies a time span unit by the index of an item in a list. - - - Example usage is for a to have a - time delayed according to position in a list, so cascading animations can occur. - - - - - Direction of the slide wipe - - - - - Duration of the animation - - - - - The transitioner provides an easy way to move between content with a default in-place circular transition. - - - - - Causes the the next slide to be displayed (effectively increments ). - - - - - Causes the the previous slide to be displayed (effectively decrements ). - - - - - Moves to the first slide. - - - - - Moves to the last slide. - - - - - If enabled, transition origins will be applied to wipes, according to where a transition was triggered from. For example, the mouse point where a user clicks a button. - - - - - Content control to host the content of an individual page within a . - - - - - Content control to enable easier transitions. - - - - - Gets or sets the transition to run when the content is loaded and made visible. - - - - - Delay offset to be applied to all opening effect transitions. - - - - - Allows multiple transition effects to be combined and run upon the content loading or being made visible. - - - - - Finds a Child of a given item in the visual tree. - - A direct parent of the queried item. - The type of the queried item. - x:Name or Name of child. - The first parent item that matches the submitted type parameter. - If not matching item can be found, - a null parent is being returned. - - - - Allows additional rendering for each tree node, outside of the rippled part of the node which responds to user selection. - - - The content to be rendered is the same of the ; i.e the Header property, or - some other content such as a view model, typically when using a . - - - - - Sets the additional template. - - The element. - The value. - - - - Gets the additional template. - - The element. - - The . - - - - - Allows additional rendering for each tree node, outside of the rippled part of the node which responds to user selection. - - - The content to be rendered is the same of the ; i.e the Header property, or - some other content such as a view model, typically when using a . - - - - - Sets the additional template selector. - - The element. - The value. - - - - Gets the additional template selector. - - The element. - - The . - - - - - To be used at level, or to be returned by - implementors when the additional template associated with a tree should not be used. - - - - - Allows controlling the visibility of the expander arrow on TreeViewItems that do not have any children. - - - - - This is a simple utility to add and remove a single adorner to an element - since there is no built-in way to do that in xaml. - See here - - - - - - - - - - The hint property - - - - - The hint property - - - - - The hint property - - - - - Framework use only. - - - - - Framework use only. - - - - - - - Framework use only. - - -
-
diff --git a/BaseModule/bin/Debug/Newtonsoft.Json.xml b/BaseModule/bin/Debug/Newtonsoft.Json.xml deleted file mode 100644 index 2c981ab..0000000 --- a/BaseModule/bin/Debug/Newtonsoft.Json.xml +++ /dev/null @@ -1,11363 +0,0 @@ - - - - Newtonsoft.Json - - - - - Represents a BSON Oid (object id). - - - - - Gets or sets the value of the Oid. - - The value of the Oid. - - - - Initializes a new instance of the class. - - The Oid value. - - - - Represents a reader that provides fast, non-cached, forward-only access to serialized BSON data. - - - - - Gets or sets a value indicating whether binary data reading should be compatible with incorrect Json.NET 3.5 written binary. - - - true if binary data reading will be compatible with incorrect Json.NET 3.5 written binary; otherwise, false. - - - - - Gets or sets a value indicating whether the root object will be read as a JSON array. - - - true if the root object will be read as a JSON array; otherwise, false. - - - - - Gets or sets the used when reading values from BSON. - - The used when reading values from BSON. - - - - Initializes a new instance of the class. - - The containing the BSON data to read. - - - - Initializes a new instance of the class. - - The containing the BSON data to read. - - - - Initializes a new instance of the class. - - The containing the BSON data to read. - if set to true the root object will be read as a JSON array. - The used when reading values from BSON. - - - - Initializes a new instance of the class. - - The containing the BSON data to read. - if set to true the root object will be read as a JSON array. - The used when reading values from BSON. - - - - Reads the next JSON token from the underlying . - - - true if the next token was read successfully; false if there are no more tokens to read. - - - - - Changes the reader's state to . - If is set to true, the underlying is also closed. - - - - - Represents a writer that provides a fast, non-cached, forward-only way of generating BSON data. - - - - - Gets or sets the used when writing values to BSON. - When set to no conversion will occur. - - The used when writing values to BSON. - - - - Initializes a new instance of the class. - - The to write to. - - - - Initializes a new instance of the class. - - The to write to. - - - - Flushes whatever is in the buffer to the underlying and also flushes the underlying stream. - - - - - Writes the end. - - The token. - - - - Writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - - - - Writes the start of a constructor with the given name. - - The name of the constructor. - - - - Writes raw JSON. - - The raw JSON to write. - - - - Writes raw JSON where a value is expected and updates the writer's state. - - The raw JSON to write. - - - - Writes the beginning of a JSON array. - - - - - Writes the beginning of a JSON object. - - - - - Writes the property name of a name/value pair on a JSON object. - - The name of the property. - - - - Closes this writer. - If is set to true, the underlying is also closed. - If is set to true, the JSON is auto-completed. - - - - - Writes a value. - An error will raised if the value cannot be written as a single JSON token. - - The value to write. - - - - Writes a null value. - - - - - Writes an undefined value. - - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a [] value. - - The [] value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a [] value that represents a BSON object id. - - The Object ID value to write. - - - - Writes a BSON regex. - - The regex pattern. - The regex options. - - - - Specifies how constructors are used when initializing objects during deserialization by the . - - - - - First attempt to use the public default constructor, then fall back to a single parameterized constructor, then to the non-public default constructor. - - - - - Json.NET will use a non-public default constructor before falling back to a parameterized constructor. - - - - - Converts a binary value to and from a base 64 string value. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts a to and from JSON and BSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Creates a custom object. - - The object type to convert. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Creates an object which will then be populated by the serializer. - - Type of the object. - The created object. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Gets a value indicating whether this can write JSON. - - - true if this can write JSON; otherwise, false. - - - - - Converts a to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified value type. - - Type of the value. - - true if this instance can convert the specified value type; otherwise, false. - - - - - Converts a to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified value type. - - Type of the value. - - true if this instance can convert the specified value type; otherwise, false. - - - - - Provides a base class for converting a to and from JSON. - - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts a F# discriminated union type to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts an Entity Framework to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts an to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Gets a value indicating whether this can write JSON. - - - true if this can write JSON; otherwise, false. - - - - - Converts a to and from the ISO 8601 date format (e.g. "2008-04-12T12:53Z"). - - - - - Gets or sets the date time styles used when converting a date to and from JSON. - - The date time styles used when converting a date to and from JSON. - - - - Gets or sets the date time format used when converting a date to and from JSON. - - The date time format used when converting a date to and from JSON. - - - - Gets or sets the culture used when converting a date to and from JSON. - - The culture used when converting a date to and from JSON. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Converts a to and from a JavaScript Date constructor (e.g. new Date(52231943)). - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing property value of the JSON that is being converted. - The calling serializer. - The object value. - - - - Converts a to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts a to and from JSON and BSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts an to and from its name string value. - - - - - Gets or sets a value indicating whether the written enum text should be camel case. - The default value is false. - - true if the written enum text will be camel case; otherwise, false. - - - - Gets or sets the naming strategy used to resolve how enum text is written. - - The naming strategy used to resolve how enum text is written. - - - - Gets or sets a value indicating whether integer values are allowed when serializing and deserializing. - The default value is true. - - true if integers are allowed when serializing and deserializing; otherwise, false. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - true if the written enum text will be camel case; otherwise, false. - - - - Initializes a new instance of the class. - - The naming strategy used to resolve how enum text is written. - true if integers are allowed when serializing and deserializing; otherwise, false. - - - - Initializes a new instance of the class. - - The of the used to write enum text. - - - - Initializes a new instance of the class. - - The of the used to write enum text. - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - - Initializes a new instance of the class. - - The of the used to write enum text. - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - true if integers are allowed when serializing and deserializing; otherwise, false. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts a to and from Unix epoch time - - - - - Gets or sets a value indicating whether the dates before Unix epoch - should converted to and from JSON. - - - true to allow converting dates before Unix epoch to and from JSON; - false to throw an exception when a date being converted to or from JSON - occurred before Unix epoch. The default value is false. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - true to allow converting dates before Unix epoch to and from JSON; - false to throw an exception when a date being converted to or from JSON - occurred before Unix epoch. The default value is false. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing property value of the JSON that is being converted. - The calling serializer. - The object value. - - - - Converts a to and from a string (e.g. "1.2.3.4"). - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing property value of the JSON that is being converted. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts XML to and from JSON. - - - - - Gets or sets the name of the root element to insert when deserializing to XML if the JSON structure has produced multiple root elements. - - The name of the deserialized root element. - - - - Gets or sets a value to indicate whether to write the Json.NET array attribute. - This attribute helps preserve arrays when converting the written XML back to JSON. - - true if the array attribute is written to the XML; otherwise, false. - - - - Gets or sets a value indicating whether to write the root JSON object. - - true if the JSON root object is omitted; otherwise, false. - - - - Gets or sets a value indicating whether to encode special characters when converting JSON to XML. - If true, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify - XML namespaces, attributes or processing directives. Instead special characters are encoded and written - as part of the XML element name. - - true if special characters are encoded; otherwise, false. - - - - Writes the JSON representation of the object. - - The to write to. - The calling serializer. - The value. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Checks if the is a namespace attribute. - - Attribute name to test. - The attribute name prefix if it has one, otherwise an empty string. - true if attribute name is for a namespace attribute, otherwise false. - - - - Determines whether this instance can convert the specified value type. - - Type of the value. - - true if this instance can convert the specified value type; otherwise, false. - - - - - Specifies how dates are formatted when writing JSON text. - - - - - Dates are written in the ISO 8601 format, e.g. "2012-03-21T05:40Z". - - - - - Dates are written in the Microsoft JSON format, e.g. "\/Date(1198908717056)\/". - - - - - Specifies how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON text. - - - - - Date formatted strings are not parsed to a date type and are read as strings. - - - - - Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to . - - - - - Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to . - - - - - Specifies how to treat the time value when converting between string and . - - - - - Treat as local time. If the object represents a Coordinated Universal Time (UTC), it is converted to the local time. - - - - - Treat as a UTC. If the object represents a local time, it is converted to a UTC. - - - - - Treat as a local time if a is being converted to a string. - If a string is being converted to , convert to a local time if a time zone is specified. - - - - - Time zone information should be preserved when converting. - - - - - The default JSON name table implementation. - - - - - Initializes a new instance of the class. - - - - - Gets a string containing the same characters as the specified range of characters in the given array. - - The character array containing the name to find. - The zero-based index into the array specifying the first character of the name. - The number of characters in the name. - A string containing the same characters as the specified range of characters in the given array. - - - - Adds the specified string into name table. - - The string to add. - This method is not thread-safe. - The resolved string. - - - - Specifies default value handling options for the . - - - - - - - - - Include members where the member value is the same as the member's default value when serializing objects. - Included members are written to JSON. Has no effect when deserializing. - - - - - Ignore members where the member value is the same as the member's default value when serializing objects - so that it is not written to JSON. - This option will ignore all default values (e.g. null for objects and nullable types; 0 for integers, - decimals and floating point numbers; and false for booleans). The default value ignored can be changed by - placing the on the property. - - - - - Members with a default value but no JSON will be set to their default value when deserializing. - - - - - Ignore members where the member value is the same as the member's default value when serializing objects - and set members to their default value when deserializing. - - - - - Specifies float format handling options when writing special floating point numbers, e.g. , - and with . - - - - - Write special floating point values as strings in JSON, e.g. "NaN", "Infinity", "-Infinity". - - - - - Write special floating point values as symbols in JSON, e.g. NaN, Infinity, -Infinity. - Note that this will produce non-valid JSON. - - - - - Write special floating point values as the property's default value in JSON, e.g. 0.0 for a property, null for a of property. - - - - - Specifies how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. - - - - - Floating point numbers are parsed to . - - - - - Floating point numbers are parsed to . - - - - - Specifies formatting options for the . - - - - - No special formatting is applied. This is the default. - - - - - Causes child objects to be indented according to the and settings. - - - - - Provides an interface for using pooled arrays. - - The array type content. - - - - Rent an array from the pool. This array must be returned when it is no longer needed. - - The minimum required length of the array. The returned array may be longer. - The rented array from the pool. This array must be returned when it is no longer needed. - - - - Return an array to the pool. - - The array that is being returned. - - - - Provides an interface to enable a class to return line and position information. - - - - - Gets a value indicating whether the class can return line information. - - - true if and can be provided; otherwise, false. - - - - - Gets the current line number. - - The current line number or 0 if no line information is available (for example, when returns false). - - - - Gets the current line position. - - The current line position or 0 if no line information is available (for example, when returns false). - - - - Instructs the how to serialize the collection. - - - - - Gets or sets a value indicating whether null items are allowed in the collection. - - true if null items are allowed in the collection; otherwise, false. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with a flag indicating whether the array can contain null items. - - A flag indicating whether the array can contain null items. - - - - Initializes a new instance of the class with the specified container Id. - - The container Id. - - - - Instructs the to use the specified constructor when deserializing that object. - - - - - Instructs the how to serialize the object. - - - - - Gets or sets the id. - - The id. - - - - Gets or sets the title. - - The title. - - - - Gets or sets the description. - - The description. - - - - Gets or sets the collection's items converter. - - The collection's items converter. - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - [JsonContainer(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] - - - - - - Gets or sets the of the . - - The of the . - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - [JsonContainer(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })] - - - - - - Gets or sets a value that indicates whether to preserve object references. - - - true to keep object reference; otherwise, false. The default is false. - - - - - Gets or sets a value that indicates whether to preserve collection's items references. - - - true to keep collection's items object references; otherwise, false. The default is false. - - - - - Gets or sets the reference loop handling used when serializing the collection's items. - - The reference loop handling. - - - - Gets or sets the type name handling used when serializing the collection's items. - - The type name handling. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with the specified container Id. - - The container Id. - - - - Provides methods for converting between .NET types and JSON types. - - - - - - - - Gets or sets a function that creates default . - Default settings are automatically used by serialization methods on , - and and on . - To serialize without using any default settings create a with - . - - - - - Represents JavaScript's boolean value true as a string. This field is read-only. - - - - - Represents JavaScript's boolean value false as a string. This field is read-only. - - - - - Represents JavaScript's null as a string. This field is read-only. - - - - - Represents JavaScript's undefined as a string. This field is read-only. - - - - - Represents JavaScript's positive infinity as a string. This field is read-only. - - - - - Represents JavaScript's negative infinity as a string. This field is read-only. - - - - - Represents JavaScript's NaN as a string. This field is read-only. - - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation using the specified. - - The value to convert. - The format the date will be converted to. - The time zone handling when the date is converted to a string. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation using the specified. - - The value to convert. - The format the date will be converted to. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - The string delimiter character. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - The string delimiter character. - The string escape handling. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Serializes the specified object to a JSON string. - - The object to serialize. - A JSON string representation of the object. - - - - Serializes the specified object to a JSON string using formatting. - - The object to serialize. - Indicates how the output should be formatted. - - A JSON string representation of the object. - - - - - Serializes the specified object to a JSON string using a collection of . - - The object to serialize. - A collection of converters used while serializing. - A JSON string representation of the object. - - - - Serializes the specified object to a JSON string using formatting and a collection of . - - The object to serialize. - Indicates how the output should be formatted. - A collection of converters used while serializing. - A JSON string representation of the object. - - - - Serializes the specified object to a JSON string using . - - The object to serialize. - The used to serialize the object. - If this is null, default serialization settings will be used. - - A JSON string representation of the object. - - - - - Serializes the specified object to a JSON string using a type, formatting and . - - The object to serialize. - The used to serialize the object. - If this is null, default serialization settings will be used. - - The type of the value being serialized. - This parameter is used when is to write out the type name if the type of the value does not match. - Specifying the type is optional. - - - A JSON string representation of the object. - - - - - Serializes the specified object to a JSON string using formatting and . - - The object to serialize. - Indicates how the output should be formatted. - The used to serialize the object. - If this is null, default serialization settings will be used. - - A JSON string representation of the object. - - - - - Serializes the specified object to a JSON string using a type, formatting and . - - The object to serialize. - Indicates how the output should be formatted. - The used to serialize the object. - If this is null, default serialization settings will be used. - - The type of the value being serialized. - This parameter is used when is to write out the type name if the type of the value does not match. - Specifying the type is optional. - - - A JSON string representation of the object. - - - - - Deserializes the JSON to a .NET object. - - The JSON to deserialize. - The deserialized object from the JSON string. - - - - Deserializes the JSON to a .NET object using . - - The JSON to deserialize. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type. - - The JSON to deserialize. - The of object being deserialized. - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type. - - The type of the object to deserialize to. - The JSON to deserialize. - The deserialized object from the JSON string. - - - - Deserializes the JSON to the given anonymous type. - - - The anonymous type to deserialize to. This can't be specified - traditionally and must be inferred from the anonymous type passed - as a parameter. - - The JSON to deserialize. - The anonymous type object. - The deserialized anonymous type from the JSON string. - - - - Deserializes the JSON to the given anonymous type using . - - - The anonymous type to deserialize to. This can't be specified - traditionally and must be inferred from the anonymous type passed - as a parameter. - - The JSON to deserialize. - The anonymous type object. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized anonymous type from the JSON string. - - - - Deserializes the JSON to the specified .NET type using a collection of . - - The type of the object to deserialize to. - The JSON to deserialize. - Converters to use while deserializing. - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type using . - - The type of the object to deserialize to. - The object to deserialize. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type using a collection of . - - The JSON to deserialize. - The type of the object to deserialize. - Converters to use while deserializing. - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type using . - - The JSON to deserialize. - The type of the object to deserialize to. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized object from the JSON string. - - - - Populates the object with values from the JSON string. - - The JSON to populate values from. - The target object to populate values onto. - - - - Populates the object with values from the JSON string using . - - The JSON to populate values from. - The target object to populate values onto. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - - - - Serializes the to a JSON string. - - The node to serialize. - A JSON string of the . - - - - Serializes the to a JSON string using formatting. - - The node to serialize. - Indicates how the output should be formatted. - A JSON string of the . - - - - Serializes the to a JSON string using formatting and omits the root object if is true. - - The node to serialize. - Indicates how the output should be formatted. - Omits writing the root object. - A JSON string of the . - - - - Deserializes the from a JSON string. - - The JSON string. - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by . - - The JSON string. - The name of the root element to append when deserializing. - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by - and writes a Json.NET array attribute for collections. - - The JSON string. - The name of the root element to append when deserializing. - - A value to indicate whether to write the Json.NET array attribute. - This attribute helps preserve arrays when converting the written XML back to JSON. - - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by , - writes a Json.NET array attribute for collections, and encodes special characters. - - The JSON string. - The name of the root element to append when deserializing. - - A value to indicate whether to write the Json.NET array attribute. - This attribute helps preserve arrays when converting the written XML back to JSON. - - - A value to indicate whether to encode special characters when converting JSON to XML. - If true, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify - XML namespaces, attributes or processing directives. Instead special characters are encoded and written - as part of the XML element name. - - The deserialized . - - - - Serializes the to a JSON string. - - The node to convert to JSON. - A JSON string of the . - - - - Serializes the to a JSON string using formatting. - - The node to convert to JSON. - Indicates how the output should be formatted. - A JSON string of the . - - - - Serializes the to a JSON string using formatting and omits the root object if is true. - - The node to serialize. - Indicates how the output should be formatted. - Omits writing the root object. - A JSON string of the . - - - - Deserializes the from a JSON string. - - The JSON string. - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by . - - The JSON string. - The name of the root element to append when deserializing. - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by - and writes a Json.NET array attribute for collections. - - The JSON string. - The name of the root element to append when deserializing. - - A value to indicate whether to write the Json.NET array attribute. - This attribute helps preserve arrays when converting the written XML back to JSON. - - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by , - writes a Json.NET array attribute for collections, and encodes special characters. - - The JSON string. - The name of the root element to append when deserializing. - - A value to indicate whether to write the Json.NET array attribute. - This attribute helps preserve arrays when converting the written XML back to JSON. - - - A value to indicate whether to encode special characters when converting JSON to XML. - If true, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify - XML namespaces, attributes or processing directives. Instead special characters are encoded and written - as part of the XML element name. - - The deserialized . - - - - Converts an object to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Gets a value indicating whether this can read JSON. - - true if this can read JSON; otherwise, false. - - - - Gets a value indicating whether this can write JSON. - - true if this can write JSON; otherwise, false. - - - - Converts an object to and from JSON. - - The object type to convert. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. If there is no existing value then null will be used. - The existing value has a value. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Instructs the to use the specified when serializing the member or class. - - - - - Gets the of the . - - The of the . - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - - - - - Initializes a new instance of the class. - - Type of the . - - - - Initializes a new instance of the class. - - Type of the . - Parameter list to use when constructing the . Can be null. - - - - Represents a collection of . - - - - - Instructs the how to serialize the collection. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with the specified container Id. - - The container Id. - - - - The exception thrown when an error occurs during JSON serialization or deserialization. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Instructs the to deserialize properties with no matching class member into the specified collection - and write values during serialization. - - - - - Gets or sets a value that indicates whether to write extension data when serializing the object. - - - true to write extension data when serializing the object; otherwise, false. The default is true. - - - - - Gets or sets a value that indicates whether to read extension data when deserializing the object. - - - true to read extension data when deserializing the object; otherwise, false. The default is true. - - - - - Initializes a new instance of the class. - - - - - Instructs the not to serialize the public field or public read/write property value. - - - - - Base class for a table of atomized string objects. - - - - - Gets a string containing the same characters as the specified range of characters in the given array. - - The character array containing the name to find. - The zero-based index into the array specifying the first character of the name. - The number of characters in the name. - A string containing the same characters as the specified range of characters in the given array. - - - - Instructs the how to serialize the object. - - - - - Gets or sets the member serialization. - - The member serialization. - - - - Gets or sets the missing member handling used when deserializing this object. - - The missing member handling. - - - - Gets or sets how the object's properties with null values are handled during serialization and deserialization. - - How the object's properties with null values are handled during serialization and deserialization. - - - - Gets or sets a value that indicates whether the object's properties are required. - - - A value indicating whether the object's properties are required. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with the specified member serialization. - - The member serialization. - - - - Initializes a new instance of the class with the specified container Id. - - The container Id. - - - - Instructs the to always serialize the member with the specified name. - - - - - Gets or sets the type used when serializing the property's collection items. - - The collection's items type. - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - [JsonProperty(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] - - - - - - Gets or sets the of the . - - The of the . - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - [JsonProperty(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })] - - - - - - Gets or sets the null value handling used when serializing this property. - - The null value handling. - - - - Gets or sets the default value handling used when serializing this property. - - The default value handling. - - - - Gets or sets the reference loop handling used when serializing this property. - - The reference loop handling. - - - - Gets or sets the object creation handling used when deserializing this property. - - The object creation handling. - - - - Gets or sets the type name handling used when serializing this property. - - The type name handling. - - - - Gets or sets whether this property's value is serialized as a reference. - - Whether this property's value is serialized as a reference. - - - - Gets or sets the order of serialization of a member. - - The numeric order of serialization. - - - - Gets or sets a value indicating whether this property is required. - - - A value indicating whether this property is required. - - - - - Gets or sets the name of the property. - - The name of the property. - - - - Gets or sets the reference loop handling used when serializing the property's collection items. - - The collection's items reference loop handling. - - - - Gets or sets the type name handling used when serializing the property's collection items. - - The collection's items type name handling. - - - - Gets or sets whether this property's collection items are serialized as a reference. - - Whether this property's collection items are serialized as a reference. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with the specified name. - - Name of the property. - - - - Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. - - - - - Asynchronously reads the next JSON token from the source. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns true if the next token was read successfully; false if there are no more tokens to read. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously skips the children of the current token. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a []. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the []. This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Specifies the state of the reader. - - - - - A read method has not been called. - - - - - The end of the file has been reached successfully. - - - - - Reader is at a property. - - - - - Reader is at the start of an object. - - - - - Reader is in an object. - - - - - Reader is at the start of an array. - - - - - Reader is in an array. - - - - - The method has been called. - - - - - Reader has just read a value. - - - - - Reader is at the start of a constructor. - - - - - Reader is in a constructor. - - - - - An error occurred that prevents the read operation from continuing. - - - - - The end of the file has been reached successfully. - - - - - Gets the current reader state. - - The current reader state. - - - - Gets or sets a value indicating whether the source should be closed when this reader is closed. - - - true to close the source when this reader is closed; otherwise false. The default is true. - - - - - Gets or sets a value indicating whether multiple pieces of JSON content can - be read from a continuous stream without erroring. - - - true to support reading multiple pieces of JSON content; otherwise false. - The default is false. - - - - - Gets the quotation mark character used to enclose the value of a string. - - - - - Gets or sets how time zones are handled when reading JSON. - - - - - Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. - - - - - Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. - - - - - Gets or sets how custom date formatted strings are parsed when reading JSON. - - - - - Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . - A null value means there is no maximum. - The default value is 64. - - - - - Gets the type of the current JSON token. - - - - - Gets the text value of the current JSON token. - - - - - Gets the .NET type for the current JSON token. - - - - - Gets the depth of the current token in the JSON document. - - The depth of the current token in the JSON document. - - - - Gets the path of the current JSON token. - - - - - Gets or sets the culture used when reading JSON. Defaults to . - - - - - Initializes a new instance of the class. - - - - - Reads the next JSON token from the source. - - true if the next token was read successfully; false if there are no more tokens to read. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a . - - A . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a []. - - A [] or null if the next JSON token is null. This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Skips the children of the current token. - - - - - Sets the current token. - - The new token. - - - - Sets the current token and value. - - The new token. - The value. - - - - Sets the current token and value. - - The new token. - The value. - A flag indicating whether the position index inside an array should be updated. - - - - Sets the state based on current token type. - - - - - Releases unmanaged and - optionally - managed resources. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Changes the reader's state to . - If is set to true, the source is also closed. - - - - - The exception thrown when an error occurs while reading JSON text. - - - - - Gets the line number indicating where the error occurred. - - The line number indicating where the error occurred. - - - - Gets the line position indicating where the error occurred. - - The line position indicating where the error occurred. - - - - Gets the path to the JSON where the error occurred. - - The path to the JSON where the error occurred. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Initializes a new instance of the class - with a specified error message, JSON path, line number, line position, and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The path to the JSON where the error occurred. - The line number indicating where the error occurred. - The line position indicating where the error occurred. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Instructs the to always serialize the member, and to require that the member has a value. - - - - - The exception thrown when an error occurs during JSON serialization or deserialization. - - - - - Gets the line number indicating where the error occurred. - - The line number indicating where the error occurred. - - - - Gets the line position indicating where the error occurred. - - The line position indicating where the error occurred. - - - - Gets the path to the JSON where the error occurred. - - The path to the JSON where the error occurred. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Initializes a new instance of the class - with a specified error message, JSON path, line number, line position, and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The path to the JSON where the error occurred. - The line number indicating where the error occurred. - The line position indicating where the error occurred. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Serializes and deserializes objects into and from the JSON format. - The enables you to control how objects are encoded into JSON. - - - - - Occurs when the errors during serialization and deserialization. - - - - - Gets or sets the used by the serializer when resolving references. - - - - - Gets or sets the used by the serializer when resolving type names. - - - - - Gets or sets the used by the serializer when resolving type names. - - - - - Gets or sets the used by the serializer when writing trace messages. - - The trace writer. - - - - Gets or sets the equality comparer used by the serializer when comparing references. - - The equality comparer. - - - - Gets or sets how type name writing and reading is handled by the serializer. - The default value is . - - - should be used with caution when your application deserializes JSON from an external source. - Incoming types should be validated with a custom - when deserializing with a value other than . - - - - - Gets or sets how a type name assembly is written and resolved by the serializer. - The default value is . - - The type name assembly format. - - - - Gets or sets how a type name assembly is written and resolved by the serializer. - The default value is . - - The type name assembly format. - - - - Gets or sets how object references are preserved by the serializer. - The default value is . - - - - - Gets or sets how reference loops (e.g. a class referencing itself) is handled. - The default value is . - - - - - Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. - The default value is . - - - - - Gets or sets how null values are handled during serialization and deserialization. - The default value is . - - - - - Gets or sets how default values are handled during serialization and deserialization. - The default value is . - - - - - Gets or sets how objects are created during deserialization. - The default value is . - - The object creation handling. - - - - Gets or sets how constructors are used during deserialization. - The default value is . - - The constructor handling. - - - - Gets or sets how metadata properties are used during deserialization. - The default value is . - - The metadata properties handling. - - - - Gets a collection that will be used during serialization. - - Collection that will be used during serialization. - - - - Gets or sets the contract resolver used by the serializer when - serializing .NET objects to JSON and vice versa. - - - - - Gets or sets the used by the serializer when invoking serialization callback methods. - - The context. - - - - Indicates how JSON text output is formatted. - The default value is . - - - - - Gets or sets how dates are written to JSON text. - The default value is . - - - - - Gets or sets how time zones are handled during serialization and deserialization. - The default value is . - - - - - Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. - The default value is . - - - - - Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. - The default value is . - - - - - Gets or sets how special floating point numbers, e.g. , - and , - are written as JSON text. - The default value is . - - - - - Gets or sets how strings are escaped when writing JSON text. - The default value is . - - - - - Gets or sets how and values are formatted when writing JSON text, - and the expected date format when reading JSON text. - The default value is "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK". - - - - - Gets or sets the culture used when reading JSON. - The default value is . - - - - - Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . - A null value means there is no maximum. - The default value is 64. - - - - - Gets a value indicating whether there will be a check for additional JSON content after deserializing an object. - The default value is false. - - - true if there will be a check for additional JSON content after deserializing an object; otherwise, false. - - - - - Initializes a new instance of the class. - - - - - Creates a new instance. - The will not use default settings - from . - - - A new instance. - The will not use default settings - from . - - - - - Creates a new instance using the specified . - The will not use default settings - from . - - The settings to be applied to the . - - A new instance using the specified . - The will not use default settings - from . - - - - - Creates a new instance. - The will use default settings - from . - - - A new instance. - The will use default settings - from . - - - - - Creates a new instance using the specified . - The will use default settings - from as well as the specified . - - The settings to be applied to the . - - A new instance using the specified . - The will use default settings - from as well as the specified . - - - - - Populates the JSON values onto the target object. - - The that contains the JSON structure to read values from. - The target object to populate values onto. - - - - Populates the JSON values onto the target object. - - The that contains the JSON structure to read values from. - The target object to populate values onto. - - - - Deserializes the JSON structure contained by the specified . - - The that contains the JSON structure to deserialize. - The being deserialized. - - - - Deserializes the JSON structure contained by the specified - into an instance of the specified type. - - The containing the object. - The of object being deserialized. - The instance of being deserialized. - - - - Deserializes the JSON structure contained by the specified - into an instance of the specified type. - - The containing the object. - The type of the object to deserialize. - The instance of being deserialized. - - - - Deserializes the JSON structure contained by the specified - into an instance of the specified type. - - The containing the object. - The of object being deserialized. - The instance of being deserialized. - - - - Serializes the specified and writes the JSON structure - using the specified . - - The used to write the JSON structure. - The to serialize. - - - - Serializes the specified and writes the JSON structure - using the specified . - - The used to write the JSON structure. - The to serialize. - - The type of the value being serialized. - This parameter is used when is to write out the type name if the type of the value does not match. - Specifying the type is optional. - - - - - Serializes the specified and writes the JSON structure - using the specified . - - The used to write the JSON structure. - The to serialize. - - The type of the value being serialized. - This parameter is used when is Auto to write out the type name if the type of the value does not match. - Specifying the type is optional. - - - - - Serializes the specified and writes the JSON structure - using the specified . - - The used to write the JSON structure. - The to serialize. - - - - Specifies the settings on a object. - - - - - Gets or sets how reference loops (e.g. a class referencing itself) are handled. - The default value is . - - Reference loop handling. - - - - Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. - The default value is . - - Missing member handling. - - - - Gets or sets how objects are created during deserialization. - The default value is . - - The object creation handling. - - - - Gets or sets how null values are handled during serialization and deserialization. - The default value is . - - Null value handling. - - - - Gets or sets how default values are handled during serialization and deserialization. - The default value is . - - The default value handling. - - - - Gets or sets a collection that will be used during serialization. - - The converters. - - - - Gets or sets how object references are preserved by the serializer. - The default value is . - - The preserve references handling. - - - - Gets or sets how type name writing and reading is handled by the serializer. - The default value is . - - - should be used with caution when your application deserializes JSON from an external source. - Incoming types should be validated with a custom - when deserializing with a value other than . - - The type name handling. - - - - Gets or sets how metadata properties are used during deserialization. - The default value is . - - The metadata properties handling. - - - - Gets or sets how a type name assembly is written and resolved by the serializer. - The default value is . - - The type name assembly format. - - - - Gets or sets how a type name assembly is written and resolved by the serializer. - The default value is . - - The type name assembly format. - - - - Gets or sets how constructors are used during deserialization. - The default value is . - - The constructor handling. - - - - Gets or sets the contract resolver used by the serializer when - serializing .NET objects to JSON and vice versa. - - The contract resolver. - - - - Gets or sets the equality comparer used by the serializer when comparing references. - - The equality comparer. - - - - Gets or sets the used by the serializer when resolving references. - - The reference resolver. - - - - Gets or sets a function that creates the used by the serializer when resolving references. - - A function that creates the used by the serializer when resolving references. - - - - Gets or sets the used by the serializer when writing trace messages. - - The trace writer. - - - - Gets or sets the used by the serializer when resolving type names. - - The binder. - - - - Gets or sets the used by the serializer when resolving type names. - - The binder. - - - - Gets or sets the error handler called during serialization and deserialization. - - The error handler called during serialization and deserialization. - - - - Gets or sets the used by the serializer when invoking serialization callback methods. - - The context. - - - - Gets or sets how and values are formatted when writing JSON text, - and the expected date format when reading JSON text. - The default value is "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK". - - - - - Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . - A null value means there is no maximum. - The default value is 64. - - - - - Indicates how JSON text output is formatted. - The default value is . - - - - - Gets or sets how dates are written to JSON text. - The default value is . - - - - - Gets or sets how time zones are handled during serialization and deserialization. - The default value is . - - - - - Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. - The default value is . - - - - - Gets or sets how special floating point numbers, e.g. , - and , - are written as JSON. - The default value is . - - - - - Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. - The default value is . - - - - - Gets or sets how strings are escaped when writing JSON text. - The default value is . - - - - - Gets or sets the culture used when reading JSON. - The default value is . - - - - - Gets a value indicating whether there will be a check for additional content after deserializing an object. - The default value is false. - - - true if there will be a check for additional content after deserializing an object; otherwise, false. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - using values copied from the passed in . - - - - - Represents a reader that provides fast, non-cached, forward-only access to JSON text data. - - - - - Asynchronously reads the next JSON token from the source. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns true if the next token was read successfully; false if there are no more tokens to read. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a []. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the []. This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Initializes a new instance of the class with the specified . - - The containing the JSON data to read. - - - - Gets or sets the reader's property name table. - - - - - Gets or sets the reader's character buffer pool. - - - - - Reads the next JSON token from the underlying . - - - true if the next token was read successfully; false if there are no more tokens to read. - - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a . - - A . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a []. - - A [] or null if the next JSON token is null. This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Changes the reader's state to . - If is set to true, the underlying is also closed. - - - - - Gets a value indicating whether the class can return line information. - - - true if and can be provided; otherwise, false. - - - - - Gets the current line number. - - - The current line number or 0 if no line information is available (for example, returns false). - - - - - Gets the current line position. - - - The current line position or 0 if no line information is available (for example, returns false). - - - - - Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. - - - - - Asynchronously flushes whatever is in the buffer to the destination and also flushes the destination. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the JSON value delimiter. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the specified end token. - - The end token to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously closes this writer. - If is set to true, the destination is also closed. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the end of the current JSON object or array. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes indent characters. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes an indent space. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes raw JSON without changing the writer's state. - - The raw JSON to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a null value. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the property name of a name/value pair of a JSON object. - - The name of the property. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the property name of a name/value pair of a JSON object. - - The name of the property. - A flag to indicate whether the text should be escaped when it is written as a JSON property name. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the beginning of a JSON array. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the beginning of a JSON object. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the start of a constructor with the given name. - - The name of the constructor. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes an undefined value. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the given white space. - - The string of white space characters. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a [] value. - - The [] value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the end of an array. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the end of a constructor. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the end of a JSON object. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes raw JSON where a value is expected and updates the writer's state. - - The raw JSON to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Gets or sets the writer's character array pool. - - - - - Gets or sets how many s to write for each level in the hierarchy when is set to . - - - - - Gets or sets which character to use to quote attribute values. - - - - - Gets or sets which character to use for indenting when is set to . - - - - - Gets or sets a value indicating whether object names will be surrounded with quotes. - - - - - Initializes a new instance of the class using the specified . - - The to write to. - - - - Flushes whatever is in the buffer to the underlying and also flushes the underlying . - - - - - Closes this writer. - If is set to true, the underlying is also closed. - If is set to true, the JSON is auto-completed. - - - - - Writes the beginning of a JSON object. - - - - - Writes the beginning of a JSON array. - - - - - Writes the start of a constructor with the given name. - - The name of the constructor. - - - - Writes the specified end token. - - The end token to write. - - - - Writes the property name of a name/value pair on a JSON object. - - The name of the property. - - - - Writes the property name of a name/value pair on a JSON object. - - The name of the property. - A flag to indicate whether the text should be escaped when it is written as a JSON property name. - - - - Writes indent characters. - - - - - Writes the JSON value delimiter. - - - - - Writes an indent space. - - - - - Writes a value. - An error will raised if the value cannot be written as a single JSON token. - - The value to write. - - - - Writes a null value. - - - - - Writes an undefined value. - - - - - Writes raw JSON. - - The raw JSON to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a value. - - The value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a [] value. - - The [] value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - - - - Writes the given white space. - - The string of white space characters. - - - - Specifies the type of JSON token. - - - - - This is returned by the if a read method has not been called. - - - - - An object start token. - - - - - An array start token. - - - - - A constructor start token. - - - - - An object property name. - - - - - A comment. - - - - - Raw JSON. - - - - - An integer. - - - - - A float. - - - - - A string. - - - - - A boolean. - - - - - A null token. - - - - - An undefined token. - - - - - An object end token. - - - - - An array end token. - - - - - A constructor end token. - - - - - A Date. - - - - - Byte data. - - - - - - Represents a reader that provides validation. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Sets an event handler for receiving schema validation errors. - - - - - Gets the text value of the current JSON token. - - - - - - Gets the depth of the current token in the JSON document. - - The depth of the current token in the JSON document. - - - - Gets the path of the current JSON token. - - - - - Gets the quotation mark character used to enclose the value of a string. - - - - - - Gets the type of the current JSON token. - - - - - - Gets the .NET type for the current JSON token. - - - - - - Initializes a new instance of the class that - validates the content returned from the given . - - The to read from while validating. - - - - Gets or sets the schema. - - The schema. - - - - Gets the used to construct this . - - The specified in the constructor. - - - - Changes the reader's state to . - If is set to true, the underlying is also closed. - - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying as a []. - - - A [] or null if the next JSON token is null. - - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying as a . - - A . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying . - - - true if the next token was read successfully; false if there are no more tokens to read. - - - - - Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. - - - - - Asynchronously closes this writer. - If is set to true, the destination is also closed. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously flushes whatever is in the buffer to the destination and also flushes the destination. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the specified end token. - - The end token to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes indent characters. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the JSON value delimiter. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes an indent space. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes raw JSON without changing the writer's state. - - The raw JSON to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the end of the current JSON object or array. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the end of an array. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the end of a constructor. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the end of a JSON object. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a null value. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the property name of a name/value pair of a JSON object. - - The name of the property. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the property name of a name/value pair of a JSON object. - - The name of the property. - A flag to indicate whether the text should be escaped when it is written as a JSON property name. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the beginning of a JSON array. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes raw JSON where a value is expected and updates the writer's state. - - The raw JSON to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the start of a constructor with the given name. - - The name of the constructor. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the beginning of a JSON object. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the current token. - - The to read the token from. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the current token. - - The to read the token from. - A flag indicating whether the current token's children should be written. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the token and its value. - - The to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the token and its value. - - The to write. - - The value to write. - A value is only required for tokens that have an associated value, e.g. the property name for . - null can be passed to the method for tokens that don't have a value, e.g. . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a [] value. - - The [] value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes an undefined value. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the given white space. - - The string of white space characters. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously ets the state of the . - - The being written. - The value being written. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Gets or sets a value indicating whether the destination should be closed when this writer is closed. - - - true to close the destination when this writer is closed; otherwise false. The default is true. - - - - - Gets or sets a value indicating whether the JSON should be auto-completed when this writer is closed. - - - true to auto-complete the JSON when this writer is closed; otherwise false. The default is true. - - - - - Gets the top. - - The top. - - - - Gets the state of the writer. - - - - - Gets the path of the writer. - - - - - Gets or sets a value indicating how JSON text output should be formatted. - - - - - Gets or sets how dates are written to JSON text. - - - - - Gets or sets how time zones are handled when writing JSON text. - - - - - Gets or sets how strings are escaped when writing JSON text. - - - - - Gets or sets how special floating point numbers, e.g. , - and , - are written to JSON text. - - - - - Gets or sets how and values are formatted when writing JSON text. - - - - - Gets or sets the culture used when writing JSON. Defaults to . - - - - - Initializes a new instance of the class. - - - - - Flushes whatever is in the buffer to the destination and also flushes the destination. - - - - - Closes this writer. - If is set to true, the destination is also closed. - If is set to true, the JSON is auto-completed. - - - - - Writes the beginning of a JSON object. - - - - - Writes the end of a JSON object. - - - - - Writes the beginning of a JSON array. - - - - - Writes the end of an array. - - - - - Writes the start of a constructor with the given name. - - The name of the constructor. - - - - Writes the end constructor. - - - - - Writes the property name of a name/value pair of a JSON object. - - The name of the property. - - - - Writes the property name of a name/value pair of a JSON object. - - The name of the property. - A flag to indicate whether the text should be escaped when it is written as a JSON property name. - - - - Writes the end of the current JSON object or array. - - - - - Writes the current token and its children. - - The to read the token from. - - - - Writes the current token. - - The to read the token from. - A flag indicating whether the current token's children should be written. - - - - Writes the token and its value. - - The to write. - - The value to write. - A value is only required for tokens that have an associated value, e.g. the property name for . - null can be passed to the method for tokens that don't have a value, e.g. . - - - - - Writes the token. - - The to write. - - - - Writes the specified end token. - - The end token to write. - - - - Writes indent characters. - - - - - Writes the JSON value delimiter. - - - - - Writes an indent space. - - - - - Writes a null value. - - - - - Writes an undefined value. - - - - - Writes raw JSON without changing the writer's state. - - The raw JSON to write. - - - - Writes raw JSON where a value is expected and updates the writer's state. - - The raw JSON to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a [] value. - - The [] value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - An error will raised if the value cannot be written as a single JSON token. - - The value to write. - - - - Writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - - - - Writes the given white space. - - The string of white space characters. - - - - Releases unmanaged and - optionally - managed resources. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Sets the state of the . - - The being written. - The value being written. - - - - The exception thrown when an error occurs while writing JSON text. - - - - - Gets the path to the JSON where the error occurred. - - The path to the JSON where the error occurred. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Initializes a new instance of the class - with a specified error message, JSON path and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The path to the JSON where the error occurred. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Specifies how JSON comments are handled when loading JSON. - - - - - Ignore comments. - - - - - Load comments as a with type . - - - - - Specifies how duplicate property names are handled when loading JSON. - - - - - Replace the existing value when there is a duplicate property. The value of the last property in the JSON object will be used. - - - - - Ignore the new value when there is a duplicate property. The value of the first property in the JSON object will be used. - - - - - Throw a when a duplicate property is encountered. - - - - - Contains the LINQ to JSON extension methods. - - - - - Returns a collection of tokens that contains the ancestors of every token in the source collection. - - The type of the objects in source, constrained to . - An of that contains the source collection. - An of that contains the ancestors of every token in the source collection. - - - - Returns a collection of tokens that contains every token in the source collection, and the ancestors of every token in the source collection. - - The type of the objects in source, constrained to . - An of that contains the source collection. - An of that contains every token in the source collection, the ancestors of every token in the source collection. - - - - Returns a collection of tokens that contains the descendants of every token in the source collection. - - The type of the objects in source, constrained to . - An of that contains the source collection. - An of that contains the descendants of every token in the source collection. - - - - Returns a collection of tokens that contains every token in the source collection, and the descendants of every token in the source collection. - - The type of the objects in source, constrained to . - An of that contains the source collection. - An of that contains every token in the source collection, and the descendants of every token in the source collection. - - - - Returns a collection of child properties of every object in the source collection. - - An of that contains the source collection. - An of that contains the properties of every object in the source collection. - - - - Returns a collection of child values of every object in the source collection with the given key. - - An of that contains the source collection. - The token key. - An of that contains the values of every token in the source collection with the given key. - - - - Returns a collection of child values of every object in the source collection. - - An of that contains the source collection. - An of that contains the values of every token in the source collection. - - - - Returns a collection of converted child values of every object in the source collection with the given key. - - The type to convert the values to. - An of that contains the source collection. - The token key. - An that contains the converted values of every token in the source collection with the given key. - - - - Returns a collection of converted child values of every object in the source collection. - - The type to convert the values to. - An of that contains the source collection. - An that contains the converted values of every token in the source collection. - - - - Converts the value. - - The type to convert the value to. - A cast as a of . - A converted value. - - - - Converts the value. - - The source collection type. - The type to convert the value to. - A cast as a of . - A converted value. - - - - Returns a collection of child tokens of every array in the source collection. - - The source collection type. - An of that contains the source collection. - An of that contains the values of every token in the source collection. - - - - Returns a collection of converted child tokens of every array in the source collection. - - An of that contains the source collection. - The type to convert the values to. - The source collection type. - An that contains the converted values of every token in the source collection. - - - - Returns the input typed as . - - An of that contains the source collection. - The input typed as . - - - - Returns the input typed as . - - The source collection type. - An of that contains the source collection. - The input typed as . - - - - Represents a collection of objects. - - The type of token. - - - - Gets the of with the specified key. - - - - - - Represents a JSON array. - - - - - - - - Writes this token to a asynchronously. - - A into which this method will write. - The token to monitor for cancellation requests. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - A representing the asynchronous load. The property contains the JSON that was read from the specified . - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - A representing the asynchronous load. The property contains the JSON that was read from the specified . - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Gets the node type for this . - - The type. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class with the specified content. - - The contents of the array. - - - - Initializes a new instance of the class with the specified content. - - The contents of the array. - - - - Loads an from a . - - A that will be read for the content of the . - A that contains the JSON that was read from the specified . - - - - Loads an from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - A that contains the JSON that was read from the specified . - - - - Load a from a string that contains JSON. - - A that contains JSON. - A populated from the string that contains JSON. - - - - - - - Load a from a string that contains JSON. - - A that contains JSON. - The used to load the JSON. - If this is null, default load settings will be used. - A populated from the string that contains JSON. - - - - - - - Creates a from an object. - - The object that will be used to create . - A with the values of the specified object. - - - - Creates a from an object. - - The object that will be used to create . - The that will be used to read the object. - A with the values of the specified object. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Gets the with the specified key. - - The with the specified key. - - - - Gets or sets the at the specified index. - - - - - - Determines the index of a specific item in the . - - The object to locate in the . - - The index of if found in the list; otherwise, -1. - - - - - Inserts an item to the at the specified index. - - The zero-based index at which should be inserted. - The object to insert into the . - - is not a valid index in the . - - - - - Removes the item at the specified index. - - The zero-based index of the item to remove. - - is not a valid index in the . - - - - - Returns an enumerator that iterates through the collection. - - - A of that can be used to iterate through the collection. - - - - - Adds an item to the . - - The object to add to the . - - - - Removes all items from the . - - - - - Determines whether the contains a specific value. - - The object to locate in the . - - true if is found in the ; otherwise, false. - - - - - Copies the elements of the to an array, starting at a particular array index. - - The array. - Index of the array. - - - - Gets a value indicating whether the is read-only. - - true if the is read-only; otherwise, false. - - - - Removes the first occurrence of a specific object from the . - - The object to remove from the . - - true if was successfully removed from the ; otherwise, false. This method also returns false if is not found in the original . - - - - - Represents a JSON constructor. - - - - - Writes this token to a asynchronously. - - A into which this method will write. - The token to monitor for cancellation requests. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous load. The - property returns a that contains the JSON that was read from the specified . - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous load. The - property returns a that contains the JSON that was read from the specified . - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Gets or sets the name of this constructor. - - The constructor name. - - - - Gets the node type for this . - - The type. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class with the specified name and content. - - The constructor name. - The contents of the constructor. - - - - Initializes a new instance of the class with the specified name and content. - - The constructor name. - The contents of the constructor. - - - - Initializes a new instance of the class with the specified name. - - The constructor name. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Gets the with the specified key. - - The with the specified key. - - - - Loads a from a . - - A that will be read for the content of the . - A that contains the JSON that was read from the specified . - - - - Loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - A that contains the JSON that was read from the specified . - - - - Represents a token that can contain other tokens. - - - - - Occurs when the list changes or an item in the list changes. - - - - - Occurs before an item is added to the collection. - - - - - Occurs when the items list of the collection has changed, or the collection is reset. - - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Raises the event. - - The instance containing the event data. - - - - Raises the event. - - The instance containing the event data. - - - - Raises the event. - - The instance containing the event data. - - - - Gets a value indicating whether this token has child tokens. - - - true if this token has child values; otherwise, false. - - - - - Get the first child token of this token. - - - A containing the first child token of the . - - - - - Get the last child token of this token. - - - A containing the last child token of the . - - - - - Returns a collection of the child tokens of this token, in document order. - - - An of containing the child tokens of this , in document order. - - - - - Returns a collection of the child values of this token, in document order. - - The type to convert the values to. - - A containing the child values of this , in document order. - - - - - Returns a collection of the descendant tokens for this token in document order. - - An of containing the descendant tokens of the . - - - - Returns a collection of the tokens that contain this token, and all descendant tokens of this token, in document order. - - An of containing this token, and all the descendant tokens of the . - - - - Adds the specified content as children of this . - - The content to be added. - - - - Adds the specified content as the first children of this . - - The content to be added. - - - - Creates a that can be used to add tokens to the . - - A that is ready to have content written to it. - - - - Replaces the child nodes of this token with the specified content. - - The content. - - - - Removes the child nodes from this token. - - - - - Merge the specified content into this . - - The content to be merged. - - - - Merge the specified content into this using . - - The content to be merged. - The used to merge the content. - - - - Gets the count of child JSON tokens. - - The count of child JSON tokens. - - - - Represents a collection of objects. - - The type of token. - - - - An empty collection of objects. - - - - - Initializes a new instance of the struct. - - The enumerable. - - - - Returns an enumerator that can be used to iterate through the collection. - - - A that can be used to iterate through the collection. - - - - - Gets the of with the specified key. - - - - - - Determines whether the specified is equal to this instance. - - The to compare with this instance. - - true if the specified is equal to this instance; otherwise, false. - - - - - Determines whether the specified is equal to this instance. - - The to compare with this instance. - - true if the specified is equal to this instance; otherwise, false. - - - - - Returns a hash code for this instance. - - - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - - - Represents a JSON object. - - - - - - - - Writes this token to a asynchronously. - - A into which this method will write. - The token to monitor for cancellation requests. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous load. The - property returns a that contains the JSON that was read from the specified . - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous load. The - property returns a that contains the JSON that was read from the specified . - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Occurs when a property value changes. - - - - - Occurs when a property value is changing. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class with the specified content. - - The contents of the object. - - - - Initializes a new instance of the class with the specified content. - - The contents of the object. - - - - Gets the node type for this . - - The type. - - - - Gets an of of this object's properties. - - An of of this object's properties. - - - - Gets a with the specified name. - - The property name. - A with the specified name or null. - - - - Gets the with the specified name. - The exact name will be searched for first and if no matching property is found then - the will be used to match a property. - - The property name. - One of the enumeration values that specifies how the strings will be compared. - A matched with the specified name or null. - - - - Gets a of of this object's property values. - - A of of this object's property values. - - - - Gets the with the specified key. - - The with the specified key. - - - - Gets or sets the with the specified property name. - - - - - - Loads a from a . - - A that will be read for the content of the . - A that contains the JSON that was read from the specified . - - is not valid JSON. - - - - - Loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - A that contains the JSON that was read from the specified . - - is not valid JSON. - - - - - Load a from a string that contains JSON. - - A that contains JSON. - A populated from the string that contains JSON. - - is not valid JSON. - - - - - - - - Load a from a string that contains JSON. - - A that contains JSON. - The used to load the JSON. - If this is null, default load settings will be used. - A populated from the string that contains JSON. - - is not valid JSON. - - - - - - - - Creates a from an object. - - The object that will be used to create . - A with the values of the specified object. - - - - Creates a from an object. - - The object that will be used to create . - The that will be used to read the object. - A with the values of the specified object. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Gets the with the specified property name. - - Name of the property. - The with the specified property name. - - - - Gets the with the specified property name. - The exact property name will be searched for first and if no matching property is found then - the will be used to match a property. - - Name of the property. - One of the enumeration values that specifies how the strings will be compared. - The with the specified property name. - - - - Tries to get the with the specified property name. - The exact property name will be searched for first and if no matching property is found then - the will be used to match a property. - - Name of the property. - The value. - One of the enumeration values that specifies how the strings will be compared. - true if a value was successfully retrieved; otherwise, false. - - - - Adds the specified property name. - - Name of the property. - The value. - - - - Determines whether the JSON object has the specified property name. - - Name of the property. - true if the JSON object has the specified property name; otherwise, false. - - - - Removes the property with the specified name. - - Name of the property. - true if item was successfully removed; otherwise, false. - - - - Tries to get the with the specified property name. - - Name of the property. - The value. - true if a value was successfully retrieved; otherwise, false. - - - - Returns an enumerator that can be used to iterate through the collection. - - - A that can be used to iterate through the collection. - - - - - Raises the event with the provided arguments. - - Name of the property. - - - - Raises the event with the provided arguments. - - Name of the property. - - - - Returns the responsible for binding operations performed on this object. - - The expression tree representation of the runtime value. - - The to bind this object. - - - - - Represents a JSON property. - - - - - Writes this token to a asynchronously. - - A into which this method will write. - The token to monitor for cancellation requests. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The token to monitor for cancellation requests. The default value is . - A representing the asynchronous creation. The - property returns a that contains the JSON that was read from the specified . - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - A representing the asynchronous creation. The - property returns a that contains the JSON that was read from the specified . - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Gets the property name. - - The property name. - - - - Gets or sets the property value. - - The property value. - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Gets the node type for this . - - The type. - - - - Initializes a new instance of the class. - - The property name. - The property content. - - - - Initializes a new instance of the class. - - The property name. - The property content. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Loads a from a . - - A that will be read for the content of the . - A that contains the JSON that was read from the specified . - - - - Loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - A that contains the JSON that was read from the specified . - - - - Represents a view of a . - - - - - Initializes a new instance of the class. - - The name. - - - - When overridden in a derived class, returns whether resetting an object changes its value. - - - true if resetting the component changes its value; otherwise, false. - - The component to test for reset capability. - - - - When overridden in a derived class, gets the current value of the property on a component. - - - The value of a property for a given component. - - The component with the property for which to retrieve the value. - - - - When overridden in a derived class, resets the value for this property of the component to the default value. - - The component with the property value that is to be reset to the default value. - - - - When overridden in a derived class, sets the value of the component to a different value. - - The component with the property value that is to be set. - The new value. - - - - When overridden in a derived class, determines a value indicating whether the value of this property needs to be persisted. - - - true if the property should be persisted; otherwise, false. - - The component with the property to be examined for persistence. - - - - When overridden in a derived class, gets the type of the component this property is bound to. - - - A that represents the type of component this property is bound to. - When the or - - methods are invoked, the object specified might be an instance of this type. - - - - - When overridden in a derived class, gets a value indicating whether this property is read-only. - - - true if the property is read-only; otherwise, false. - - - - - When overridden in a derived class, gets the type of the property. - - - A that represents the type of the property. - - - - - Gets the hash code for the name of the member. - - - - The hash code for the name of the member. - - - - - Represents a raw JSON string. - - - - - Asynchronously creates an instance of with the content of the reader's current token. - - The reader. - The token to monitor for cancellation requests. The default value is . - A representing the asynchronous creation. The - property returns an instance of with the content of the reader's current token. - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class. - - The raw json. - - - - Creates an instance of with the content of the reader's current token. - - The reader. - An instance of with the content of the reader's current token. - - - - Specifies the settings used when cloning JSON. - - - - - Initializes a new instance of the class. - - - - - Gets or sets a flag that indicates whether to copy annotations when cloning a . - The default value is true. - - - A flag that indicates whether to copy annotations when cloning a . - - - - - Specifies the settings used when loading JSON. - - - - - Initializes a new instance of the class. - - - - - Gets or sets how JSON comments are handled when loading JSON. - The default value is . - - The JSON comment handling. - - - - Gets or sets how JSON line info is handled when loading JSON. - The default value is . - - The JSON line info handling. - - - - Gets or sets how duplicate property names in JSON objects are handled when loading JSON. - The default value is . - - The JSON duplicate property name handling. - - - - Specifies the settings used when merging JSON. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the method used when merging JSON arrays. - - The method used when merging JSON arrays. - - - - Gets or sets how null value properties are merged. - - How null value properties are merged. - - - - Gets or sets the comparison used to match property names while merging. - The exact property name will be searched for first and if no matching property is found then - the will be used to match a property. - - The comparison used to match property names while merging. - - - - Specifies the settings used when selecting JSON. - - - - - Gets or sets a timeout that will be used when executing regular expressions. - - The timeout that will be used when executing regular expressions. - - - - Gets or sets a flag that indicates whether an error should be thrown if - no tokens are found when evaluating part of the expression. - - - A flag that indicates whether an error should be thrown if - no tokens are found when evaluating part of the expression. - - - - - Represents an abstract JSON token. - - - - - Writes this token to a asynchronously. - - A into which this method will write. - The token to monitor for cancellation requests. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Writes this token to a asynchronously. - - A into which this method will write. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Asynchronously creates a from a . - - An positioned at the token to read into this . - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous creation. The - property returns a that contains - the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Asynchronously creates a from a . - - An positioned at the token to read into this . - The used to load the JSON. - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous creation. The - property returns a that contains - the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Asynchronously creates a from a . - - A positioned at the token to read into this . - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous creation. The - property returns a that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Asynchronously creates a from a . - - A positioned at the token to read into this . - The used to load the JSON. - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous creation. The - property returns a that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Gets a comparer that can compare two tokens for value equality. - - A that can compare two nodes for value equality. - - - - Gets or sets the parent. - - The parent. - - - - Gets the root of this . - - The root of this . - - - - Gets the node type for this . - - The type. - - - - Gets a value indicating whether this token has child tokens. - - - true if this token has child values; otherwise, false. - - - - - Compares the values of two tokens, including the values of all descendant tokens. - - The first to compare. - The second to compare. - true if the tokens are equal; otherwise false. - - - - Gets the next sibling token of this node. - - The that contains the next sibling token. - - - - Gets the previous sibling token of this node. - - The that contains the previous sibling token. - - - - Gets the path of the JSON token. - - - - - Adds the specified content immediately after this token. - - A content object that contains simple content or a collection of content objects to be added after this token. - - - - Adds the specified content immediately before this token. - - A content object that contains simple content or a collection of content objects to be added before this token. - - - - Returns a collection of the ancestor tokens of this token. - - A collection of the ancestor tokens of this token. - - - - Returns a collection of tokens that contain this token, and the ancestors of this token. - - A collection of tokens that contain this token, and the ancestors of this token. - - - - Returns a collection of the sibling tokens after this token, in document order. - - A collection of the sibling tokens after this tokens, in document order. - - - - Returns a collection of the sibling tokens before this token, in document order. - - A collection of the sibling tokens before this token, in document order. - - - - Gets the with the specified key. - - The with the specified key. - - - - Gets the with the specified key converted to the specified type. - - The type to convert the token to. - The token key. - The converted token value. - - - - Get the first child token of this token. - - A containing the first child token of the . - - - - Get the last child token of this token. - - A containing the last child token of the . - - - - Returns a collection of the child tokens of this token, in document order. - - An of containing the child tokens of this , in document order. - - - - Returns a collection of the child tokens of this token, in document order, filtered by the specified type. - - The type to filter the child tokens on. - A containing the child tokens of this , in document order. - - - - Returns a collection of the child values of this token, in document order. - - The type to convert the values to. - A containing the child values of this , in document order. - - - - Removes this token from its parent. - - - - - Replaces this token with the specified token. - - The value. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Returns the indented JSON for this token. - - - ToString() returns a non-JSON string value for tokens with a type of . - If you want the JSON for all token types then you should use . - - - The indented JSON for this token. - - - - - Returns the JSON for this token using the given formatting and converters. - - Indicates how the output should be formatted. - A collection of s which will be used when writing the token. - The JSON for this token using the given formatting and converters. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to []. - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from [] to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Creates a for this token. - - A that can be used to read this token and its descendants. - - - - Creates a from an object. - - The object that will be used to create . - A with the value of the specified object. - - - - Creates a from an object using the specified . - - The object that will be used to create . - The that will be used when reading the object. - A with the value of the specified object. - - - - Creates an instance of the specified .NET type from the . - - The object type that the token will be deserialized to. - The new object created from the JSON value. - - - - Creates an instance of the specified .NET type from the . - - The object type that the token will be deserialized to. - The new object created from the JSON value. - - - - Creates an instance of the specified .NET type from the using the specified . - - The object type that the token will be deserialized to. - The that will be used when creating the object. - The new object created from the JSON value. - - - - Creates an instance of the specified .NET type from the using the specified . - - The object type that the token will be deserialized to. - The that will be used when creating the object. - The new object created from the JSON value. - - - - Creates a from a . - - A positioned at the token to read into this . - - A that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Creates a from a . - - An positioned at the token to read into this . - The used to load the JSON. - If this is null, default load settings will be used. - - A that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Load a from a string that contains JSON. - - A that contains JSON. - A populated from the string that contains JSON. - - - - Load a from a string that contains JSON. - - A that contains JSON. - The used to load the JSON. - If this is null, default load settings will be used. - A populated from the string that contains JSON. - - - - Creates a from a . - - A positioned at the token to read into this . - The used to load the JSON. - If this is null, default load settings will be used. - - A that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Creates a from a . - - A positioned at the token to read into this . - - A that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Selects a using a JSONPath expression. Selects the token that matches the object path. - - - A that contains a JSONPath expression. - - A , or null. - - - - Selects a using a JSONPath expression. Selects the token that matches the object path. - - - A that contains a JSONPath expression. - - A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression. - A . - - - - Selects a using a JSONPath expression. Selects the token that matches the object path. - - - A that contains a JSONPath expression. - - The used to select tokens. - A . - - - - Selects a collection of elements using a JSONPath expression. - - - A that contains a JSONPath expression. - - An of that contains the selected elements. - - - - Selects a collection of elements using a JSONPath expression. - - - A that contains a JSONPath expression. - - A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression. - An of that contains the selected elements. - - - - Selects a collection of elements using a JSONPath expression. - - - A that contains a JSONPath expression. - - The used to select tokens. - An of that contains the selected elements. - - - - Returns the responsible for binding operations performed on this object. - - The expression tree representation of the runtime value. - - The to bind this object. - - - - - Returns the responsible for binding operations performed on this object. - - The expression tree representation of the runtime value. - - The to bind this object. - - - - - Creates a new instance of the . All child tokens are recursively cloned. - - A new instance of the . - - - - Creates a new instance of the . All child tokens are recursively cloned. - - A object to configure cloning settings. - A new instance of the . - - - - Adds an object to the annotation list of this . - - The annotation to add. - - - - Get the first annotation object of the specified type from this . - - The type of the annotation to retrieve. - The first annotation object that matches the specified type, or null if no annotation is of the specified type. - - - - Gets the first annotation object of the specified type from this . - - The of the annotation to retrieve. - The first annotation object that matches the specified type, or null if no annotation is of the specified type. - - - - Gets a collection of annotations of the specified type for this . - - The type of the annotations to retrieve. - An that contains the annotations for this . - - - - Gets a collection of annotations of the specified type for this . - - The of the annotations to retrieve. - An of that contains the annotations that match the specified type for this . - - - - Removes the annotations of the specified type from this . - - The type of annotations to remove. - - - - Removes the annotations of the specified type from this . - - The of annotations to remove. - - - - Compares tokens to determine whether they are equal. - - - - - Determines whether the specified objects are equal. - - The first object of type to compare. - The second object of type to compare. - - true if the specified objects are equal; otherwise, false. - - - - - Returns a hash code for the specified object. - - The for which a hash code is to be returned. - A hash code for the specified object. - The type of is a reference type and is null. - - - - Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. - - - - - Gets the at the reader's current position. - - - - - Initializes a new instance of the class. - - The token to read from. - - - - Initializes a new instance of the class. - - The token to read from. - The initial path of the token. It is prepended to the returned . - - - - Reads the next JSON token from the underlying . - - - true if the next token was read successfully; false if there are no more tokens to read. - - - - - Gets the path of the current JSON token. - - - - - Specifies the type of token. - - - - - No token type has been set. - - - - - A JSON object. - - - - - A JSON array. - - - - - A JSON constructor. - - - - - A JSON object property. - - - - - A comment. - - - - - An integer value. - - - - - A float value. - - - - - A string value. - - - - - A boolean value. - - - - - A null value. - - - - - An undefined value. - - - - - A date value. - - - - - A raw JSON value. - - - - - A collection of bytes value. - - - - - A Guid value. - - - - - A Uri value. - - - - - A TimeSpan value. - - - - - Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. - - - - - Gets the at the writer's current position. - - - - - Gets the token being written. - - The token being written. - - - - Initializes a new instance of the class writing to the given . - - The container being written to. - - - - Initializes a new instance of the class. - - - - - Flushes whatever is in the buffer to the underlying . - - - - - Closes this writer. - If is set to true, the JSON is auto-completed. - - - Setting to true has no additional effect, since the underlying is a type that cannot be closed. - - - - - Writes the beginning of a JSON object. - - - - - Writes the beginning of a JSON array. - - - - - Writes the start of a constructor with the given name. - - The name of the constructor. - - - - Writes the end. - - The token. - - - - Writes the property name of a name/value pair on a JSON object. - - The name of the property. - - - - Writes a value. - An error will be raised if the value cannot be written as a single JSON token. - - The value to write. - - - - Writes a null value. - - - - - Writes an undefined value. - - - - - Writes raw JSON. - - The raw JSON to write. - - - - Writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a [] value. - - The [] value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Represents a value in JSON (string, integer, date, etc). - - - - - Writes this token to a asynchronously. - - A into which this method will write. - The token to monitor for cancellation requests. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Gets a value indicating whether this token has child tokens. - - - true if this token has child values; otherwise, false. - - - - - Creates a comment with the given value. - - The value. - A comment with the given value. - - - - Creates a string with the given value. - - The value. - A string with the given value. - - - - Creates a null value. - - A null value. - - - - Creates a undefined value. - - A undefined value. - - - - Gets the node type for this . - - The type. - - - - Gets or sets the underlying token value. - - The underlying token value. - - - - Writes this token to a . - - A into which this method will write. - A collection of s which will be used when writing the token. - - - - Indicates whether the current object is equal to another object of the same type. - - - true if the current object is equal to the parameter; otherwise, false. - - An object to compare with this object. - - - - Determines whether the specified is equal to the current . - - The to compare with the current . - - true if the specified is equal to the current ; otherwise, false. - - - - - Serves as a hash function for a particular type. - - - A hash code for the current . - - - - - Returns a that represents this instance. - - - ToString() returns a non-JSON string value for tokens with a type of . - If you want the JSON for all token types then you should use . - - - A that represents this instance. - - - - - Returns a that represents this instance. - - The format. - - A that represents this instance. - - - - - Returns a that represents this instance. - - The format provider. - - A that represents this instance. - - - - - Returns a that represents this instance. - - The format. - The format provider. - - A that represents this instance. - - - - - Returns the responsible for binding operations performed on this object. - - The expression tree representation of the runtime value. - - The to bind this object. - - - - - Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. - - An object to compare with this instance. - - A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has these meanings: - Value - Meaning - Less than zero - This instance is less than . - Zero - This instance is equal to . - Greater than zero - This instance is greater than . - - - is not of the same type as this instance. - - - - - Specifies how line information is handled when loading JSON. - - - - - Ignore line information. - - - - - Load line information. - - - - - Specifies how JSON arrays are merged together. - - - - Concatenate arrays. - - - Union arrays, skipping items that already exist. - - - Replace all array items. - - - Merge array items together, matched by index. - - - - Specifies how null value properties are merged. - - - - - The content's null value properties will be ignored during merging. - - - - - The content's null value properties will be merged. - - - - - Specifies the member serialization options for the . - - - - - All public members are serialized by default. Members can be excluded using or . - This is the default member serialization mode. - - - - - Only members marked with or are serialized. - This member serialization mode can also be set by marking the class with . - - - - - All public and private fields are serialized. Members can be excluded using or . - This member serialization mode can also be set by marking the class with - and setting IgnoreSerializableAttribute on to false. - - - - - Specifies metadata property handling options for the . - - - - - Read metadata properties located at the start of a JSON object. - - - - - Read metadata properties located anywhere in a JSON object. Note that this setting will impact performance. - - - - - Do not try to read metadata properties. - - - - - Specifies missing member handling options for the . - - - - - Ignore a missing member and do not attempt to deserialize it. - - - - - Throw a when a missing member is encountered during deserialization. - - - - - Specifies null value handling options for the . - - - - - - - - - Include null values when serializing and deserializing objects. - - - - - Ignore null values when serializing and deserializing objects. - - - - - Specifies how object creation is handled by the . - - - - - Reuse existing objects, create new objects when needed. - - - - - Only reuse existing objects. - - - - - Always create new objects. - - - - - Specifies reference handling options for the . - Note that references cannot be preserved when a value is set via a non-default constructor such as types that implement . - - - - - - - - Do not preserve references when serializing types. - - - - - Preserve references when serializing into a JSON object structure. - - - - - Preserve references when serializing into a JSON array structure. - - - - - Preserve references when serializing. - - - - - Specifies reference loop handling options for the . - - - - - Throw a when a loop is encountered. - - - - - Ignore loop references and do not serialize. - - - - - Serialize loop references. - - - - - Indicating whether a property is required. - - - - - The property is not required. The default state. - - - - - The property must be defined in JSON but can be a null value. - - - - - The property must be defined in JSON and cannot be a null value. - - - - - The property is not required but it cannot be a null value. - - - - - - Contains the JSON schema extension methods. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - - Determines whether the is valid. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - The source to test. - The schema to test with. - - true if the specified is valid; otherwise, false. - - - - - - Determines whether the is valid. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - The source to test. - The schema to test with. - When this method returns, contains any error messages generated while validating. - - true if the specified is valid; otherwise, false. - - - - - - Validates the specified . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - The source to test. - The schema to test with. - - - - - Validates the specified . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - The source to test. - The schema to test with. - The validation event handler. - - - - - An in-memory representation of a JSON Schema. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets or sets the id. - - - - - Gets or sets the title. - - - - - Gets or sets whether the object is required. - - - - - Gets or sets whether the object is read-only. - - - - - Gets or sets whether the object is visible to users. - - - - - Gets or sets whether the object is transient. - - - - - Gets or sets the description of the object. - - - - - Gets or sets the types of values allowed by the object. - - The type. - - - - Gets or sets the pattern. - - The pattern. - - - - Gets or sets the minimum length. - - The minimum length. - - - - Gets or sets the maximum length. - - The maximum length. - - - - Gets or sets a number that the value should be divisible by. - - A number that the value should be divisible by. - - - - Gets or sets the minimum. - - The minimum. - - - - Gets or sets the maximum. - - The maximum. - - - - Gets or sets a flag indicating whether the value can not equal the number defined by the minimum attribute (). - - A flag indicating whether the value can not equal the number defined by the minimum attribute (). - - - - Gets or sets a flag indicating whether the value can not equal the number defined by the maximum attribute (). - - A flag indicating whether the value can not equal the number defined by the maximum attribute (). - - - - Gets or sets the minimum number of items. - - The minimum number of items. - - - - Gets or sets the maximum number of items. - - The maximum number of items. - - - - Gets or sets the of items. - - The of items. - - - - Gets or sets a value indicating whether items in an array are validated using the instance at their array position from . - - - true if items are validated using their array position; otherwise, false. - - - - - Gets or sets the of additional items. - - The of additional items. - - - - Gets or sets a value indicating whether additional items are allowed. - - - true if additional items are allowed; otherwise, false. - - - - - Gets or sets whether the array items must be unique. - - - - - Gets or sets the of properties. - - The of properties. - - - - Gets or sets the of additional properties. - - The of additional properties. - - - - Gets or sets the pattern properties. - - The pattern properties. - - - - Gets or sets a value indicating whether additional properties are allowed. - - - true if additional properties are allowed; otherwise, false. - - - - - Gets or sets the required property if this property is present. - - The required property if this property is present. - - - - Gets or sets the a collection of valid enum values allowed. - - A collection of valid enum values allowed. - - - - Gets or sets disallowed types. - - The disallowed types. - - - - Gets or sets the default value. - - The default value. - - - - Gets or sets the collection of that this schema extends. - - The collection of that this schema extends. - - - - Gets or sets the format. - - The format. - - - - Initializes a new instance of the class. - - - - - Reads a from the specified . - - The containing the JSON Schema to read. - The object representing the JSON Schema. - - - - Reads a from the specified . - - The containing the JSON Schema to read. - The to use when resolving schema references. - The object representing the JSON Schema. - - - - Load a from a string that contains JSON Schema. - - A that contains JSON Schema. - A populated from the string that contains JSON Schema. - - - - Load a from a string that contains JSON Schema using the specified . - - A that contains JSON Schema. - The resolver. - A populated from the string that contains JSON Schema. - - - - Writes this schema to a . - - A into which this method will write. - - - - Writes this schema to a using the specified . - - A into which this method will write. - The resolver used. - - - - Returns a that represents the current . - - - A that represents the current . - - - - - - Returns detailed information about the schema exception. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets the line number indicating where the error occurred. - - The line number indicating where the error occurred. - - - - Gets the line position indicating where the error occurred. - - The line position indicating where the error occurred. - - - - Gets the path to the JSON where the error occurred. - - The path to the JSON where the error occurred. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - - Generates a from a specified . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets or sets how undefined schemas are handled by the serializer. - - - - - Gets or sets the contract resolver. - - The contract resolver. - - - - Generate a from the specified type. - - The type to generate a from. - A generated from the specified type. - - - - Generate a from the specified type. - - The type to generate a from. - The used to resolve schema references. - A generated from the specified type. - - - - Generate a from the specified type. - - The type to generate a from. - Specify whether the generated root will be nullable. - A generated from the specified type. - - - - Generate a from the specified type. - - The type to generate a from. - The used to resolve schema references. - Specify whether the generated root will be nullable. - A generated from the specified type. - - - - - Resolves from an id. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets or sets the loaded schemas. - - The loaded schemas. - - - - Initializes a new instance of the class. - - - - - Gets a for the specified reference. - - The id. - A for the specified reference. - - - - - The value types allowed by the . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - No type specified. - - - - - String type. - - - - - Float type. - - - - - Integer type. - - - - - Boolean type. - - - - - Object type. - - - - - Array type. - - - - - Null type. - - - - - Any type. - - - - - - Specifies undefined schema Id handling options for the . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Do not infer a schema Id. - - - - - Use the .NET type name as the schema Id. - - - - - Use the assembly qualified .NET type name as the schema Id. - - - - - - Returns detailed information related to the . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets the associated with the validation error. - - The JsonSchemaException associated with the validation error. - - - - Gets the path of the JSON location where the validation error occurred. - - The path of the JSON location where the validation error occurred. - - - - Gets the text description corresponding to the validation error. - - The text description. - - - - - Represents the callback method that will handle JSON schema validation events and the . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - A camel case naming strategy. - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - A flag indicating whether extension data names should be processed. - - - - - Initializes a new instance of the class. - - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - Resolves member mappings for a type, camel casing property names. - - - - - Initializes a new instance of the class. - - - - - Resolves the contract for a given type. - - The type to resolve a contract for. - The contract for a given type. - - - - Used by to resolve a for a given . - - - - - Gets a value indicating whether members are being get and set using dynamic code generation. - This value is determined by the runtime permissions available. - - - true if using dynamic code generation; otherwise, false. - - - - - Gets or sets the default members search flags. - - The default members search flags. - - - - Gets or sets a value indicating whether compiler generated members should be serialized. - - - true if serialized compiler generated members; otherwise, false. - - - - - Gets or sets a value indicating whether to ignore the interface when serializing and deserializing types. - - - true if the interface will be ignored when serializing and deserializing types; otherwise, false. - - - - - Gets or sets a value indicating whether to ignore the attribute when serializing and deserializing types. - - - true if the attribute will be ignored when serializing and deserializing types; otherwise, false. - - - - - Gets or sets a value indicating whether to ignore IsSpecified members when serializing and deserializing types. - - - true if the IsSpecified members will be ignored when serializing and deserializing types; otherwise, false. - - - - - Gets or sets a value indicating whether to ignore ShouldSerialize members when serializing and deserializing types. - - - true if the ShouldSerialize members will be ignored when serializing and deserializing types; otherwise, false. - - - - - Gets or sets the naming strategy used to resolve how property names and dictionary keys are serialized. - - The naming strategy used to resolve how property names and dictionary keys are serialized. - - - - Initializes a new instance of the class. - - - - - Resolves the contract for a given type. - - The type to resolve a contract for. - The contract for a given type. - - - - Gets the serializable members for the type. - - The type to get serializable members for. - The serializable members for the type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates the constructor parameters. - - The constructor to create properties for. - The type's member properties. - Properties for the given . - - - - Creates a for the given . - - The matching member property. - The constructor parameter. - A created for the given . - - - - Resolves the default for the contract. - - Type of the object. - The contract's default . - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Determines which contract type is created for the given type. - - Type of the object. - A for the given type. - - - - Creates properties for the given . - - The type to create properties for. - /// The member serialization mode for the type. - Properties for the given . - - - - Creates the used by the serializer to get and set values from a member. - - The member. - The used by the serializer to get and set values from a member. - - - - Creates a for the given . - - The member's parent . - The member to create a for. - A created for the given . - - - - Resolves the name of the property. - - Name of the property. - Resolved name of the property. - - - - Resolves the name of the extension data. By default no changes are made to extension data names. - - Name of the extension data. - Resolved name of the extension data. - - - - Resolves the key of the dictionary. By default is used to resolve dictionary keys. - - Key of the dictionary. - Resolved key of the dictionary. - - - - Gets the resolved name of the property. - - Name of the property. - Name of the property. - - - - The default naming strategy. Property names and dictionary keys are unchanged. - - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - The default serialization binder used when resolving and loading classes from type names. - - - - - Initializes a new instance of the class. - - - - - When overridden in a derived class, controls the binding of a serialized object to a type. - - Specifies the name of the serialized object. - Specifies the name of the serialized object. - - The type of the object the formatter creates a new instance of. - - - - - When overridden in a derived class, controls the binding of a serialized object to a type. - - The type of the object the formatter creates a new instance of. - Specifies the name of the serialized object. - Specifies the name of the serialized object. - - - - Represents a trace writer that writes to the application's instances. - - - - - Gets the that will be used to filter the trace messages passed to the writer. - For example a filter level of will exclude messages and include , - and messages. - - - The that will be used to filter the trace messages passed to the writer. - - - - - Writes the specified trace level, message and optional exception. - - The at which to write this trace. - The trace message. - The trace exception. This parameter is optional. - - - - Get and set values for a using dynamic methods. - - - - - Initializes a new instance of the class. - - The member info. - - - - Sets the value. - - The target to set the value on. - The value to set on the target. - - - - Gets the value. - - The target to get the value from. - The value. - - - - Provides information surrounding an error. - - - - - Gets the error. - - The error. - - - - Gets the original object that caused the error. - - The original object that caused the error. - - - - Gets the member that caused the error. - - The member that caused the error. - - - - Gets the path of the JSON location where the error occurred. - - The path of the JSON location where the error occurred. - - - - Gets or sets a value indicating whether this is handled. - - true if handled; otherwise, false. - - - - Provides data for the Error event. - - - - - Gets the current object the error event is being raised against. - - The current object the error event is being raised against. - - - - Gets the error context. - - The error context. - - - - Initializes a new instance of the class. - - The current object. - The error context. - - - - Get and set values for a using dynamic methods. - - - - - Initializes a new instance of the class. - - The member info. - - - - Sets the value. - - The target to set the value on. - The value to set on the target. - - - - Gets the value. - - The target to get the value from. - The value. - - - - Provides methods to get attributes. - - - - - Returns a collection of all of the attributes, or an empty collection if there are no attributes. - - When true, look up the hierarchy chain for the inherited custom attribute. - A collection of s, or an empty collection. - - - - Returns a collection of attributes, identified by type, or an empty collection if there are no attributes. - - The type of the attributes. - When true, look up the hierarchy chain for the inherited custom attribute. - A collection of s, or an empty collection. - - - - Used by to resolve a for a given . - - - - - - - - - Resolves the contract for a given type. - - The type to resolve a contract for. - The contract for a given type. - - - - Used to resolve references when serializing and deserializing JSON by the . - - - - - Resolves a reference to its object. - - The serialization context. - The reference to resolve. - The object that was resolved from the reference. - - - - Gets the reference for the specified object. - - The serialization context. - The object to get a reference for. - The reference to the object. - - - - Determines whether the specified object is referenced. - - The serialization context. - The object to test for a reference. - - true if the specified object is referenced; otherwise, false. - - - - - Adds a reference to the specified object. - - The serialization context. - The reference. - The object to reference. - - - - Allows users to control class loading and mandate what class to load. - - - - - When implemented, controls the binding of a serialized object to a type. - - Specifies the name of the serialized object. - Specifies the name of the serialized object - The type of the object the formatter creates a new instance of. - - - - When implemented, controls the binding of a serialized object to a type. - - The type of the object the formatter creates a new instance of. - Specifies the name of the serialized object. - Specifies the name of the serialized object. - - - - Represents a trace writer. - - - - - Gets the that will be used to filter the trace messages passed to the writer. - For example a filter level of will exclude messages and include , - and messages. - - The that will be used to filter the trace messages passed to the writer. - - - - Writes the specified trace level, message and optional exception. - - The at which to write this trace. - The trace message. - The trace exception. This parameter is optional. - - - - Provides methods to get and set values. - - - - - Sets the value. - - The target to set the value on. - The value to set on the target. - - - - Gets the value. - - The target to get the value from. - The value. - - - - Contract details for a used by the . - - - - - Gets the of the collection items. - - The of the collection items. - - - - Gets a value indicating whether the collection type is a multidimensional array. - - true if the collection type is a multidimensional array; otherwise, false. - - - - Gets or sets the function used to create the object. When set this function will override . - - The function used to create the object. - - - - Gets a value indicating whether the creator has a parameter with the collection values. - - true if the creator has a parameter with the collection values; otherwise, false. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Gets or sets the default collection items . - - The converter. - - - - Gets or sets a value indicating whether the collection items preserve object references. - - true if collection items preserve object references; otherwise, false. - - - - Gets or sets the collection item reference loop handling. - - The reference loop handling. - - - - Gets or sets the collection item type name handling. - - The type name handling. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Handles serialization callback events. - - The object that raised the callback event. - The streaming context. - - - - Handles serialization error callback events. - - The object that raised the callback event. - The streaming context. - The error context. - - - - Sets extension data for an object during deserialization. - - The object to set extension data on. - The extension data key. - The extension data value. - - - - Gets extension data for an object during serialization. - - The object to set extension data on. - - - - Contract details for a used by the . - - - - - Gets the underlying type for the contract. - - The underlying type for the contract. - - - - Gets or sets the type created during deserialization. - - The type created during deserialization. - - - - Gets or sets whether this type contract is serialized as a reference. - - Whether this type contract is serialized as a reference. - - - - Gets or sets the default for this contract. - - The converter. - - - - Gets the internally resolved for the contract's type. - This converter is used as a fallback converter when no other converter is resolved. - Setting will always override this converter. - - - - - Gets or sets all methods called immediately after deserialization of the object. - - The methods called immediately after deserialization of the object. - - - - Gets or sets all methods called during deserialization of the object. - - The methods called during deserialization of the object. - - - - Gets or sets all methods called after serialization of the object graph. - - The methods called after serialization of the object graph. - - - - Gets or sets all methods called before serialization of the object. - - The methods called before serialization of the object. - - - - Gets or sets all method called when an error is thrown during the serialization of the object. - - The methods called when an error is thrown during the serialization of the object. - - - - Gets or sets the default creator method used to create the object. - - The default creator method used to create the object. - - - - Gets or sets a value indicating whether the default creator is non-public. - - true if the default object creator is non-public; otherwise, false. - - - - Contract details for a used by the . - - - - - Gets or sets the dictionary key resolver. - - The dictionary key resolver. - - - - Gets the of the dictionary keys. - - The of the dictionary keys. - - - - Gets the of the dictionary values. - - The of the dictionary values. - - - - Gets or sets the function used to create the object. When set this function will override . - - The function used to create the object. - - - - Gets a value indicating whether the creator has a parameter with the dictionary values. - - true if the creator has a parameter with the dictionary values; otherwise, false. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Gets the object's properties. - - The object's properties. - - - - Gets or sets the property name resolver. - - The property name resolver. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Gets or sets the object constructor. - - The object constructor. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Gets or sets the object member serialization. - - The member object serialization. - - - - Gets or sets the missing member handling used when deserializing this object. - - The missing member handling. - - - - Gets or sets a value that indicates whether the object's properties are required. - - - A value indicating whether the object's properties are required. - - - - - Gets or sets how the object's properties with null values are handled during serialization and deserialization. - - How the object's properties with null values are handled during serialization and deserialization. - - - - Gets the object's properties. - - The object's properties. - - - - Gets a collection of instances that define the parameters used with . - - - - - Gets or sets the function used to create the object. When set this function will override . - This function is called with a collection of arguments which are defined by the collection. - - The function used to create the object. - - - - Gets or sets the extension data setter. - - - - - Gets or sets the extension data getter. - - - - - Gets or sets the extension data value type. - - - - - Gets or sets the extension data name resolver. - - The extension data name resolver. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Maps a JSON property to a .NET member or constructor parameter. - - - - - Gets or sets the name of the property. - - The name of the property. - - - - Gets or sets the type that declared this property. - - The type that declared this property. - - - - Gets or sets the order of serialization of a member. - - The numeric order of serialization. - - - - Gets or sets the name of the underlying member or parameter. - - The name of the underlying member or parameter. - - - - Gets the that will get and set the during serialization. - - The that will get and set the during serialization. - - - - Gets or sets the for this property. - - The for this property. - - - - Gets or sets the type of the property. - - The type of the property. - - - - Gets or sets the for the property. - If set this converter takes precedence over the contract converter for the property type. - - The converter. - - - - Gets or sets the member converter. - - The member converter. - - - - Gets or sets a value indicating whether this is ignored. - - true if ignored; otherwise, false. - - - - Gets or sets a value indicating whether this is readable. - - true if readable; otherwise, false. - - - - Gets or sets a value indicating whether this is writable. - - true if writable; otherwise, false. - - - - Gets or sets a value indicating whether this has a member attribute. - - true if has a member attribute; otherwise, false. - - - - Gets the default value. - - The default value. - - - - Gets or sets a value indicating whether this is required. - - A value indicating whether this is required. - - - - Gets a value indicating whether has a value specified. - - - - - Gets or sets a value indicating whether this property preserves object references. - - - true if this instance is reference; otherwise, false. - - - - - Gets or sets the property null value handling. - - The null value handling. - - - - Gets or sets the property default value handling. - - The default value handling. - - - - Gets or sets the property reference loop handling. - - The reference loop handling. - - - - Gets or sets the property object creation handling. - - The object creation handling. - - - - Gets or sets or sets the type name handling. - - The type name handling. - - - - Gets or sets a predicate used to determine whether the property should be serialized. - - A predicate used to determine whether the property should be serialized. - - - - Gets or sets a predicate used to determine whether the property should be deserialized. - - A predicate used to determine whether the property should be deserialized. - - - - Gets or sets a predicate used to determine whether the property should be serialized. - - A predicate used to determine whether the property should be serialized. - - - - Gets or sets an action used to set whether the property has been deserialized. - - An action used to set whether the property has been deserialized. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Gets or sets the converter used when serializing the property's collection items. - - The collection's items converter. - - - - Gets or sets whether this property's collection items are serialized as a reference. - - Whether this property's collection items are serialized as a reference. - - - - Gets or sets the type name handling used when serializing the property's collection items. - - The collection's items type name handling. - - - - Gets or sets the reference loop handling used when serializing the property's collection items. - - The collection's items reference loop handling. - - - - A collection of objects. - - - - - Initializes a new instance of the class. - - The type. - - - - When implemented in a derived class, extracts the key from the specified element. - - The element from which to extract the key. - The key for the specified element. - - - - Adds a object. - - The property to add to the collection. - - - - Gets the closest matching object. - First attempts to get an exact case match of and then - a case insensitive match. - - Name of the property. - A matching property if found. - - - - Gets a property by property name. - - The name of the property to get. - Type property name string comparison. - A matching property if found. - - - - Contract details for a used by the . - - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Lookup and create an instance of the type described by the argument. - - The type to create. - Optional arguments to pass to an initializing constructor of the JsonConverter. - If null, the default constructor is used. - - - - A kebab case naming strategy. - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - A flag indicating whether extension data names should be processed. - - - - - Initializes a new instance of the class. - - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - Represents a trace writer that writes to memory. When the trace message limit is - reached then old trace messages will be removed as new messages are added. - - - - - Gets the that will be used to filter the trace messages passed to the writer. - For example a filter level of will exclude messages and include , - and messages. - - - The that will be used to filter the trace messages passed to the writer. - - - - - Initializes a new instance of the class. - - - - - Writes the specified trace level, message and optional exception. - - The at which to write this trace. - The trace message. - The trace exception. This parameter is optional. - - - - Returns an enumeration of the most recent trace messages. - - An enumeration of the most recent trace messages. - - - - Returns a of the most recent trace messages. - - - A of the most recent trace messages. - - - - - A base class for resolving how property names and dictionary keys are serialized. - - - - - A flag indicating whether dictionary keys should be processed. - Defaults to false. - - - - - A flag indicating whether extension data names should be processed. - Defaults to false. - - - - - A flag indicating whether explicitly specified property names, - e.g. a property name customized with a , should be processed. - Defaults to false. - - - - - Gets the serialized name for a given property name. - - The initial property name. - A flag indicating whether the property has had a name explicitly specified. - The serialized property name. - - - - Gets the serialized name for a given extension data name. - - The initial extension data name. - The serialized extension data name. - - - - Gets the serialized key for a given dictionary key. - - The initial dictionary key. - The serialized dictionary key. - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - Hash code calculation - - - - - - Object equality implementation - - - - - - - Compare to another NamingStrategy - - - - - - - Represents a method that constructs an object. - - The object type to create. - - - - When applied to a method, specifies that the method is called when an error occurs serializing an object. - - - - - Provides methods to get attributes from a , , or . - - - - - Initializes a new instance of the class. - - The instance to get attributes for. This parameter should be a , , or . - - - - Returns a collection of all of the attributes, or an empty collection if there are no attributes. - - When true, look up the hierarchy chain for the inherited custom attribute. - A collection of s, or an empty collection. - - - - Returns a collection of attributes, identified by type, or an empty collection if there are no attributes. - - The type of the attributes. - When true, look up the hierarchy chain for the inherited custom attribute. - A collection of s, or an empty collection. - - - - Get and set values for a using reflection. - - - - - Initializes a new instance of the class. - - The member info. - - - - Sets the value. - - The target to set the value on. - The value to set on the target. - - - - Gets the value. - - The target to get the value from. - The value. - - - - A snake case naming strategy. - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - A flag indicating whether extension data names should be processed. - - - - - Initializes a new instance of the class. - - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - Specifies how strings are escaped when writing JSON text. - - - - - Only control characters (e.g. newline) are escaped. - - - - - All non-ASCII and control characters (e.g. newline) are escaped. - - - - - HTML (<, >, &, ', ") and control characters (e.g. newline) are escaped. - - - - - Indicates the method that will be used during deserialization for locating and loading assemblies. - - - - - In simple mode, the assembly used during deserialization need not match exactly the assembly used during serialization. Specifically, the version numbers need not match as the LoadWithPartialName method of the class is used to load the assembly. - - - - - In full mode, the assembly used during deserialization must match exactly the assembly used during serialization. The Load method of the class is used to load the assembly. - - - - - Specifies type name handling options for the . - - - should be used with caution when your application deserializes JSON from an external source. - Incoming types should be validated with a custom - when deserializing with a value other than . - - - - - Do not include the .NET type name when serializing types. - - - - - Include the .NET type name when serializing into a JSON object structure. - - - - - Include the .NET type name when serializing into a JSON array structure. - - - - - Always include the .NET type name when serializing. - - - - - Include the .NET type name when the type of the object being serialized is not the same as its declared type. - Note that this doesn't include the root serialized object by default. To include the root object's type name in JSON - you must specify a root type object with - or . - - - - - Determines whether the collection is null or empty. - - The collection. - - true if the collection is null or empty; otherwise, false. - - - - - Adds the elements of the specified collection to the specified generic . - - The list to add to. - The collection of elements to add. - - - - Converts the value to the specified type. If the value is unable to be converted, the - value is checked whether it assignable to the specified type. - - The value to convert. - The culture to use when converting. - The type to convert or cast the value to. - - The converted type. If conversion was unsuccessful, the initial value - is returned if assignable to the target type. - - - - - Helper method for generating a MetaObject which calls a - specific method on Dynamic that returns a result - - - - - Helper method for generating a MetaObject which calls a - specific method on Dynamic, but uses one of the arguments for - the result. - - - - - Helper method for generating a MetaObject which calls a - specific method on Dynamic, but uses one of the arguments for - the result. - - - - - Returns a Restrictions object which includes our current restrictions merged - with a restriction limiting our type - - - - - Helper class for serializing immutable collections. - Note that this is used by all builds, even those that don't support immutable collections, in case the DLL is GACed - https://github.com/JamesNK/Newtonsoft.Json/issues/652 - - - - - Gets the type of the typed collection's items. - - The type. - The type of the typed collection's items. - - - - Gets the member's underlying type. - - The member. - The underlying type of the member. - - - - Determines whether the property is an indexed property. - - The property. - - true if the property is an indexed property; otherwise, false. - - - - - Gets the member's value on the object. - - The member. - The target object. - The member's value on the object. - - - - Sets the member's value on the target object. - - The member. - The target. - The value. - - - - Determines whether the specified MemberInfo can be read. - - The MemberInfo to determine whether can be read. - /// if set to true then allow the member to be gotten non-publicly. - - true if the specified MemberInfo can be read; otherwise, false. - - - - - Determines whether the specified MemberInfo can be set. - - The MemberInfo to determine whether can be set. - if set to true then allow the member to be set non-publicly. - if set to true then allow the member to be set if read-only. - - true if the specified MemberInfo can be set; otherwise, false. - - - - - Builds a string. Unlike this class lets you reuse its internal buffer. - - - - - Determines whether the string is all white space. Empty string will return false. - - The string to test whether it is all white space. - - true if the string is all white space; otherwise, false. - - - - - Specifies the state of the . - - - - - An exception has been thrown, which has left the in an invalid state. - You may call the method to put the in the Closed state. - Any other method calls result in an being thrown. - - - - - The method has been called. - - - - - An object is being written. - - - - - An array is being written. - - - - - A constructor is being written. - - - - - A property is being written. - - - - - A write method has not been called. - - - - Specifies that an output will not be null even if the corresponding type allows it. - - - Specifies that when a method returns , the parameter will not be null even if the corresponding type allows it. - - - Initializes the attribute with the specified return value condition. - - The return value condition. If the method returns this value, the associated parameter will not be null. - - - - Gets the return value condition. - - - Specifies that an output may be null even if the corresponding type disallows it. - - - Specifies that null is allowed as an input even if the corresponding type disallows it. - - - - Specifies that the method will not return if the associated Boolean parameter is passed the specified value. - - - - - Initializes a new instance of the class. - - - The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to - the associated parameter matches this value. - - - - Gets the condition parameter value. - - - diff --git a/BaseModule/bin/Debug/OxyPlot.Wpf.Shared.xml b/BaseModule/bin/Debug/OxyPlot.Wpf.Shared.xml deleted file mode 100644 index 1a4be4d..0000000 --- a/BaseModule/bin/Debug/OxyPlot.Wpf.Shared.xml +++ /dev/null @@ -1,933 +0,0 @@ - - - - OxyPlot.Wpf.Shared - - - - - Converts between and . - - - - - Converts a value. - - The value produced by the binding source. - The type of the binding target property. - The converter parameter to use. - The culture to use in the converter. - A converted value. If the method returns null, the valid null value is used. - - - - Converts a value. - - The value that is produced by the binding target. - The type to convert to. - The converter parameter to use. - The culture to use in the converter. - A converted value. If the method returns null, the valid null value is used. - - - - Converts from to the maximum thicknesses. - - This is used in the to convert BorderThickness properties to Path.StrokeThickness (double). - The maximum thickness value is used. - - - - Converts a value. - - The value produced by the binding source. - The type of the binding target property. - The converter parameter to use. - The culture to use in the converter. - A converted value. If the method returns null, the valid null value is used. - - - - Converts a value. - - The value that is produced by the binding target. - The type to convert to. - The converter parameter to use. - The culture to use in the converter. - A converted value. If the method returns null, the valid null value is used. - - - - Provides extension methods for exporters. - - - - - Exports the specified to a file. - - The exporter. - The model to export. - The path to the file. - - - - Defines additional . - - - - - The undefined color. - - - - - The automatic color. - - - - - Provides a standard set of commands for the control. - - - - - Gets the value that represents the "Reset all axes" command. - - - - - Base class for WPF PlotView implementations. - - - Base class for WPF PlotView implementations. - - - Base class for WPF PlotView implementations. - - - - - The Grid PART constant. - - - - - The grid. - - - - - The plot presenter. - - - - - The render context - - - - - The model lock. - - - - - The current tracker. - - - - - The current tracker template. - - - - - The default plot controller. - - - - - Indicates whether the was in the visual tree the last time was called. - - - - - The mouse down point. - - - - - The overlays. - - - - - The zoom control. - - - - - Initializes static members of the class. - - - - - Initializes a new instance of the class. - - - - - Gets the actual PlotView controller. - - The actual PlotView controller. - - - - - - - Gets the actual model. - - The actual model. - - - - - - - Gets the coordinates of the client area of the view. - - - - - Gets the tracker definitions. - - The tracker definitions. - - - - Hides the tracker. - - - - - Hides the zoom rectangle. - - - - - Invalidate the PlotView (not blocking the UI thread) - - The update Data. - - - - - - - Pans all axes. - - The delta. - - - - Resets all axes. - - - - - Stores text on the clipboard. - - The text. - - - - Sets the cursor type. - - The cursor type. - - - - Shows the tracker. - - The tracker data. - - - - Shows the zoom rectangle. - - The rectangle. - - - - Zooms all axes. - - The zoom factor. - - - - Clears the background of the plot presenter. - - - - - Creates the plot presenter. - - The plot presenter. - - - - Creates the render context. - - The render context. - - - - Called when the model is changed. - - - - - Renders the plot model to the plot presenter. - - - - - Renders the plot model to the plot presenter. - - - - - Updates the DPI scale of the render context. - - The DPI scale. - - - - Called when the model is changed. - - The sender. - The instance containing the event data. - - - - Invokes the specified action on the dispatcher, if necessary. - - The action. - - - - Gets a value indicating whether the is connected to the visual tree. - - true if the PlotViewBase is connected to the visual tree; false otherwise. - - - - This event fires every time Layout updates the layout of the trees associated with current Dispatcher. - - The sender. - The event args. - - - - Called before the event occurs. - - The data for the event. - - - - Called when the event occurs. - - The data for the event. - - - - Called when the event occurs. - - The data for the event. - - - - Called when the event occurs. - - The data for the event. - - - - Called before the event occurs to provide handling for the event in a derived class without attaching a delegate. - - A that contains the event data. - - - - Invoked when an unhandled MouseDown attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. - - The that contains the event data. This event data reports details about the mouse button that was pressed and the handled state. - - - - Invoked when an unhandled MouseMove attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. - - The that contains the event data. - - - - Invoked when an unhandled MouseUp routed event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. - - The that contains the event data. The event data reports that the mouse button was released. - - - - Invoked when an unhandled  attached event is raised on this element. Implement this method to add class handling for this event. - - The that contains the event data. - - - - Invoked when an unhandled  attached event is raised on this element. Implement this method to add class handling for this event. - - The that contains the event data. - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Gets or sets the Plot controller. - - The Plot controller. - - - - Gets or sets the default tracker template. - - - - - Gets or sets a value indicating whether IsMouseWheelEnabled. - - - - - Gets or sets the model. - - The model. - - - - Gets or sets the pan cursor. - - The pan cursor. - - - - Gets or sets the horizontal zoom cursor. - - The zoom horizontal cursor. - - - - Gets or sets the rectangle zoom cursor. - - The zoom rectangle cursor. - - - - Gets or sets the zoom rectangle template. - - The zoom rectangle template. - - - - Gets or sets the vertical zoom cursor. - - The zoom vertical cursor. - - - - The tracker control. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - The path part string. - - - - - The content part string. - - - - - The content container part string. - - - - - The horizontal line part string. - - - - - The vertical line part string. - - - - - The content. - - - - - The horizontal line. - - - - - The path. - - - - - The content container. - - - - - The vertical line. - - - - - Initializes static members of the class. - - - - - Gets or sets BorderEdgeMode. - - - - - Gets or sets HorizontalLineVisibility. - - - - - Gets or sets VerticalLineVisibility. - - - - - Gets or sets LineThickness. - - - - - Gets or sets LineStroke. - - - - - Gets or sets LineExtents. - - - - - Gets or sets LineDashArray. - - - - - Gets or sets a value indicating whether to show a 'pointer' on the border. - - - - - Gets or sets the corner radius (only used when ShowPoint=false). - - - - - Gets or sets the distance of the content container from the trackers Position. - - - - - Gets or sets a value indicating whether the tracker can center its content box horizontally. - - - - - Gets or sets a value indicating whether the tracker can center its content box vertically. - - - - - Gets or sets Position of the tracker. - - - - - When overridden in a derived class, is invoked whenever application code or internal processes call . - - - - - Called when the position is changed. - - The sender. - The instance containing the event data. - - - - Called when the position is changed. - - The dependency property changed event args. - - - - Update the position and border of the tracker. - - - - - Create the border geometry. - - The horizontal alignment. - The vertical alignment. - The width. - The height. - The margin. - The border geometry. - - - - Create a border geometry with a 'pointer'. - - The horizontal alignment. - The vertical alignment. - The width. - The height. - The margin. - The border geometry. - - - - Represents a tracker definition. - - The tracker definitions make it possible to show different trackers for different series. - The property is matched with the - in the TrackerDefinitions collection in the control. - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Gets or sets the tracker key. - - The Plot will use this property to find the TrackerDefinition that matches the TrackerKey of the current series. - - - - Gets or sets the tracker template. - - The tracker control will be added/removed from the Tracker overlay as necessary. - The DataContext of the tracker will be set to a TrackerHitResult with the current tracker data. - - - - Extension method used to convert to/from Windows/Windows.Media classes. - - - - - Calculate the distance between two points. - - The first point. - The second point. - The distance. - - - - Converts an to a . - - The color. - A . - - - - Converts an to a . - - The color. - A Color. - - - - Converts an OxyThickness to a Thickness. - - The thickness. - A instance. - - - - Converts a ScreenVector to a Vector. - - The c. - A instance. - - - - Converts a HorizontalAlignment to a HorizontalAlignment. - - The alignment. - A HorizontalAlignment. - - - - Converts a HorizontalAlignment to a VerticalAlignment. - - The alignment. - A VerticalAlignment. - - - - Converts a Color to an OxyColor. - - The color. - An OxyColor. - - - - Converts a to an . - - The brush. - An . - - - - Converts a Thickness to an . - - The thickness. - An . - - - - Converts a to a . - - The point. - A . - - - - Converts a Point array to a ScreenPoint array. - - The points. - A ScreenPoint array. - - - - Converts the specified vector to a ScreenVector. - - The vector. - A . - - - - Converts the specified key. - - The key to convert. - The converted key. - - - - Converts the specified button. - - The button to convert. - The converted mouse button. - - - - Converts to for a mouse wheel event. - - The instance containing the event data. - The that the event is relative to. - A containing the converted event arguments. - - - - Converts to for a mouse down event. - - The instance containing the event data. - The that the event is relative to. - A containing the converted event arguments. - - - - Converts to for a mouse up event. - - The instance containing the event data. - The that the event is relative to. - A containing the converted event arguments. - - - - Converts to for a mouse event. - - The instance containing the event data. - The that the event is relative to. - A containing the converted event arguments. - - - - Converts to for a touch started event. - - The instance containing the event data. - The that the event is relative to. - A containing the converted event arguments. - - - - Converts to for a touch delta event. - - The instance containing the event data. - The that the event is relative to. - A containing the converted event arguments. - - - - Converts to for a touch completed event. - - The instance containing the event data. - The that the event is relative to. - A containing the converted event arguments. - - - - Provides utility methods related to the keyboard. - - - - - Gets the current modifier keys. - - A value. - - - diff --git a/BaseModule/bin/Debug/OxyPlot.Wpf.xml b/BaseModule/bin/Debug/OxyPlot.Wpf.xml deleted file mode 100644 index 73d3861..0000000 --- a/BaseModule/bin/Debug/OxyPlot.Wpf.xml +++ /dev/null @@ -1,637 +0,0 @@ - - - - OxyPlot.Wpf - - - - - Implements for . - - - - - The images in use - - - - - The image cache - - - - - The brush cache. - - - - - The font family cache - - - - - The canvas. - - - - - The clip rectangle. - - - - - The current tool tip - - - - - The dpi scale. - - - - - The visual offset relative to visual root. - - - - - Initializes a new instance of the class. - - The canvas. - - - - Gets or sets the text measurement method. - - The text measurement method. - - - - Gets or sets the text formatting mode. - - The text formatting mode. The default value is . - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Measures the size of the specified text by a faster method (using GlyphTypefaces). - - The text. - The font family. - The font size. - The font weight. - The size of the text. - - - - Gets the font weight. - - The font weight value. - The font weight. - - - - Fast text size calculation - - The glyph typeface. - The size. - The text. - The text size. - - - - Creates an element of the specified type and adds it to the canvas. - - Type of element to create. - The clip offset executable. - The clip offset asynchronous. - The element. - - - - Applies the current tool tip to the specified element. - - The element. - - - - Gets the cached brush. - - The color. - The brush. - - - - Gets the cached font family. - - Name of the family. - The FontFamily. - - - - Sets the stroke properties of the specified shape object. - - The shape. - The stroke color. - The thickness. - The edge rendering mode. - The line join. - The dash array. Use null to get a solid line. - The dash offset. - - - - Gets the bitmap source. - - The image. - The bitmap source. - - - - Converts an to a . - - The rectangle. - A . - - - - Snaps points to pixels if required by the edge rendering mode. - - The points. - The stroke thickness. - The edge rendering mode. - The processed points. - - - - Snaps a rectangle to device pixels if required by the edge rendering mode. - - The rectangle. - The stroke thickness. - The edge rendering mode. - The processed rectangle. - - - - Snaps a stroke thickness to device pixels if required by the edge rendering mode. - - The stroke thickness. - The edge rendering mode. - The processed stroke thickness. - - - - Represents a control that displays a . This is based on . - - - Represents a control that displays a . - - - - - Identifies the dependency property. - - - - - Initializes a new instance of the class. - - - - - Gets or sets a value indicating whether to disconnect the canvas while updating. - - true if canvas should be disconnected while updating; otherwise, false. - - - - Gets or sets the vertical zoom cursor. - - The zoom vertical cursor. - - - - Gets the Canvas. - - - - - Gets the CanvasRenderContext. - - - - - - - - - - - - - - - - - - - - - - - Performs the copy operation. - - The sender. - The instance containing the event data. - - - - Returns a reference to the visual object that hosts the dependency object in the visual tree. - - The host window from the visual tree. - - - - Saves the PlotView as a bitmap. - - Name of the file. - - - - Saves the PlotView as a bitmap. - - Name of the file. - The width. - The height. - - - - Saves the PlotView as xaml. - - Name of the file. - - - - Renders the PlotView to xaml. - - The xaml. - - - - Renders the PlotView to a bitmap. - - A bitmap. - - - - Provides functionality to export plots to png. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the width of the output image. - - - - - Gets or sets the height of the output image. - - - - - Gets or sets the resolution of the output image. - - The resolution in dots per inch (dpi). - - - - Exports the specified plot model to a file. - - The model to export. - The file name. - The width of the output bitmap. - The height of the output bitmap. - The resolution (resolution). The default value is 96. - - - - Exports the specified to the specified . - - The model. - The output stream. - - - - Exports the specified plot model to a bitmap. - - The model to export. - A bitmap. - - - - Provides functionality to export plots to scalable vector graphics using text measuring in WPF. - - - - - Initializes a new instance of the class. - - - - - The text measurement methods. - - - - - Measurement by TextBlock. This gives a more accurate result than as it takes into account text shaping. - - - - - Measurement by glyph typeface. This is faster than , but does not take into account text shaping. - - - - - Provides functionality to support non-default dpi scaling - - - - - Snaps a screen point to a pixel grid. - - - Depending on the stroke thickness, the point is snapped either to the middle or the border of a pixel. - - The x coordinate of the point. - The y coordinate of the point. - The stroke thickness. - A point structure which represents X and Y visual offsets relative to visual root - The DPI scale. - Snapped point - - - - Snaps a rectangle structure to a pixel grid. - - - Depending on the stroke thickness, the rectangle bounds are snapped either to the middle or the border of pixels. - - Rectangle structure - The stroke thickness. - A point structure which represents X and Y visual offsets relative to visual root - The DPI scale. - Snapped rectangle structure - - - - Snaps a stroke thickness to an integer multiple of device pixels. - - The stroke thickness. - The DPI scale. - The snapped stroke thickness. - - - - Snaps a screen coordinate to a pixel grid - - Screen coordinate - Pixel grid offset - Pixel grid scale - Snapped coordinate - - - - Gets the pixel offset for the given scale and stroke thickness. - - - This takes into account that lines with even width should be rendered on the border between two pixels, while lines with odd width should be rendered - in the middle of a pixel. - - The stroke thickness. - Pixel grid scale - The pixel offset. - - - - Provides functionality to export plots to XAML. - - - - - Export the specified plot model to an xaml string. - - The model. - The width. - The height. - A xaml string. - - - - Exports the specified plot model to a xaml file. - - The model. - Name of the file. - The width. - The height. - - - - Exports the specified plot model to a xml writer. - - The model. - The xml writer. - The width. - The height. - - - - Implements for . This does not use and therefore the output can be serialized to XAML. - - - - - The maximum number of figures per geometry. - - - - - The maximum number of polylines per line. - - - - - The minimum number of points per polyline. - - - - - Initializes a new instance of the class. - - The canvas. - - - - Gets or sets the thickness limit for "balanced" line drawing. - - - - - - - - - - - - - - - - - - - - Draws the line using the MaxPolylinesPerLine and MinPointsPerPolyline properties. - - The points. - The stroke color. - The thickness. - The edge rendering mode. - The dash array. Use null to get a solid line. - The line join. - - - - Creates a point collection from the specified points. The points are snapped to pixels if required by the edge rendering mode, - - The points to convert. - The stroke thickness. - The edge rendering mode. - The point collection. - - - - Provides functionality to export plots to xps. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the width of the output document. - - - - - Gets or sets the height of the output document. - - - - - Gets or sets the text formatting mode. - - The text formatting mode. - - - - Exports the specified plot model to an xps file. - - The model. - The file name. - The width. - The height. - - - - Exports the specified to the specified . - - The model. - The stream. - The width. - The height. - - - - Prints the specified plot model. - - The model. - The width (using the actual media width if set to NaN). - The height (using the actual media height if set to NaN). - - - - Exports the specified to the specified . - - The model. - The stream. - - - - Prints the specified plot model. - - The model. - - - - Write the specified to the specified . - - The model. - The document writer. - - - diff --git a/BaseModule/bin/Debug/OxyPlot.xml b/BaseModule/bin/Debug/OxyPlot.xml deleted file mode 100644 index 4d48911..0000000 --- a/BaseModule/bin/Debug/OxyPlot.xml +++ /dev/null @@ -1,20943 +0,0 @@ - - - - OxyPlot - - - - - Provides an abstract base class for annotations. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the rendering layer of the annotation. The default value is . - - - - - Gets the X axis. - - The X axis. - - - - Gets or sets the X axis key. - - The X axis key. - - - - Gets the Y axis. - - The Y axis. - - - - Gets or sets a value indicating whether to clip the annotation by the X axis range. - - true if clipping by the X axis is enabled; otherwise, false. - - - - Gets or sets a value indicating whether to clip the annotation by the Y axis range. - - true if clipping by the Y axis is enabled; otherwise, false. - - - - Gets or sets the Y axis key. - - The Y axis key. - - - - Ensures that the annotation axes are set. - - - - - Renders the annotation on the specified context. - - The render context. - - - - - - - - - - - - - Specifies the layer for an . - - - - - Render the annotation below the gridlines of the axes. - - - - - Render the annotation below the series. - - - - - Render the annotation above the series. - - - - - Specifies the orientation of the text in an annotation. - - - - - Horizontal text. - - - - - Vertical text. - - - - - Oriented along the line. - - - - - Represents an annotation that shows an arrow. - - - - - The end point in screen coordinates. - - - - - The start point in screen coordinates. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the arrow direction. - - Setting this property overrides the property. - - - - Gets or sets the color of the arrow. - - - - - Gets or sets the end point of the arrow. - - - - - Gets or sets the length of the head (relative to the stroke thickness) (the default value is 10). - - The length of the head. - - - - Gets or sets the width of the head (relative to the stroke thickness) (the default value is 3). - - The width of the head. - - - - Gets or sets the line join type. - - The line join type. - - - - Gets or sets the line style. - - The line style. - - - - Gets or sets the start point of the arrow. - - This property is overridden by the ArrowDirection property, if set. - - - - Gets or sets the stroke thickness (the default value is 2). - - The stroke thickness. - - - - Gets or sets the 'veeness' of the arrow head (relative to thickness) (the default value is 0). - - The 'veeness'. - - - - - - - When overridden in a derived class, tests if the plot element is hit by the specified point. - - The hit test arguments. - - The result of the hit test. - - - - - Represents an annotation that shows an ellipse. - - - - - The rectangle transformed to screen coordinates. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the x-coordinate of the center. - - - - - Gets or sets the y-coordinate of the center. - - - - - Gets or sets the width of the ellipse. - - - - - Gets or sets the height of the ellipse. - - - - - - - - When overridden in a derived class, tests if the plot element is hit by the specified point. - - The hit test arguments. - - The result of the hit test. - - - - - Represents an annotation that shows a function rendered as a path. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the type of function. Can be either f(x) or f(y). - - The type of the function. - - - - Gets or sets the y=f(x) equation when Type is Equation. - - - - - Gets or sets the resolution. - - The resolution. - - - - Gets the screen points. - - The list of screen points defined by this function annotation. - - - - Defines the definition of function in a . - - - - - Curve equation x=f(y) given by the Equation property - - - - - Curve equation y=f(x) given by the Equation property - - - - - Represents an annotation that shows an image. - - - - - The actual bounds of the rendered image. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the image source. - - The image source. - - - - Gets or sets the horizontal alignment. - - The horizontal alignment. - - - - Gets or sets the X position of the image. - - The X. - - - - Gets or sets the Y position of the image. - - The Y. - - - - Gets or sets the X offset. - - The offset X. - - - - Gets or sets the Y offset. - - The offset Y. - - - - Gets or sets the width. - - The width. - - - - Gets or sets the height. - - The height. - - - - Gets or sets the opacity (0-1). - - The opacity value. - - - - Gets or sets a value indicating whether to apply smooth interpolation to the image. - - true if the image should be interpolated (using a high-quality bi-cubic interpolation); false if the nearest neighbor should be used. - - - - Gets or sets the vertical alignment. - - The vertical alignment. - - - - - - - When overridden in a derived class, tests if the plot element is hit by the specified point. - - The hit test arguments. - - The result of the hit test. - - - - - Gets the point. - - The x. - The y. - The model. - The point in screen coordinates. - - - - Gets the vector. - - The x component. - The y component. - The model. - The vector in screen coordinates. - - - - - - - Represents an annotation that shows a straight line. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the y-intercept when Type is LinearEquation. - - The intercept value. - Linear equation y-intercept (the b in y=mx+b). - http://en.wikipedia.org/wiki/Linear_equation - - - - Gets or sets the slope when Type is LinearEquation. - - The slope value. - Linear equation slope (the m in y=mx+b) - http://en.wikipedia.org/wiki/Linear_equation - - - - Gets or sets the type of line equation. - - - - - Gets or sets the X position for vertical lines (only for Type==Vertical). - - - - - Gets or sets the Y position for horizontal lines (only for Type==Horizontal) - - - - - Gets the screen points. - - The list of points to display on screen for this path. - - - - Specifies the definition of the line in a . - - - - - Horizontal line given by the Y property - - - - - Vertical line given by the X property - - - - - Linear equation y=mx+b given by the Slope and Intercept properties - - - - - Provides an abstract base class for all annotations that contain paths (lines, functions or polylines). - - - - - The points of the line, transformed to screen coordinates. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the color of the line. - - - - - Gets or sets the line join. - - The line join. - - - - Gets or sets the line style. - - The line style. - - - - Gets or sets the maximum X coordinate for the line. - - - - - Gets or sets the maximum Y coordinate for the line. - - - - - Gets or sets the minimum X coordinate for the line. - - - - - Gets or sets the minimum Y coordinate for the line. - - - - - Gets or sets the stroke thickness. - - The stroke thickness. - - - - Gets or sets the text margin (along the line). - - The text margin. - - - - Gets or sets the text padding (in the direction of the text). - - The text padding. - - - - Gets or sets the text orientation. - - The text orientation. - - - - Gets or sets the text position relative to the line. - - The text position in the interval [0,1]. - Positions smaller than 0.25 are left aligned at the start of the line - Positions larger than 0.75 are right aligned at the end of the line - Other positions are center aligned at the specified position - - - - Gets or sets the minimum length of the segment. - Increasing this number will increase performance, - but make curves less accurate. The default is 2. - - The minimum length of the segment. - - - - Gets or sets the actual minimum value on the x axis. - - The actual minimum value on the x axis. - - - - Gets or sets the actual minimum value on the y axis. - - The actual minimum value on the y axis. - - - - Gets or sets the actual maximum value on the x axis. - - The actual maximum value on the x axis. - - - - Gets or sets the actual maximum value on the y axis. - - The actual maximum value on the y axis. - - - - - - - When overridden in a derived class, tests if the plot element is hit by the specified point. - - The hit test arguments. - - The result of the hit test. - - - - - Gets the screen points. - - The list of points to display on screen for this path. - - - - Calculates the actual minimums and maximums. - - - - - Gets the point on a curve at the specified relative distance along the curve. - - The curve points. - The relative distance along the curve. - The margins. - The position. - The angle. - True if a position was found. - - - - Represents an annotation that shows a point. - - - - - The position transformed to screen coordinates. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the x-coordinate of the center. - - - - - Gets or sets the y-coordinate of the center. - - - - - Gets or sets the size of the rendered point. - - - - - Gets or sets the distance between the rendered point and the text. - - - - - Gets or sets the shape of the rendered point. - - The shape. - - - - Gets or sets a custom polygon outline for the point marker. Set to to use this property. - - A polyline. The default is null. - - - - - - - When overridden in a derived class, tests if the plot element is hit by the specified point. - - The hit test arguments. - - The result of the hit test. - - - - - Represents an annotation that shows a polygon. - - - - - The polygon points transformed to screen coordinates. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the line join. - - The line join. - - - - Gets or sets the line style. - - The line style. - - - - Gets or sets the minimum length of the segment. - Increasing this number will increase performance, - but make the polygon less accurate. The default is 2. - - The minimum length of the segment. - - - - Gets the points. - - The points. - - - - - - - When overridden in a derived class, tests if the plot element is hit by the specified point. - - The hit test arguments. - - The result of the hit test. - - - - - Represents an annotation that shows a polyline. - - - - - The points. - - - - - Gets the points. - - The points. - - - - Gets or sets the interpolation algorithm. - - An interpolation algorithm. - - - - Gets the screen points. - - The list of points to display on screen for this path. - - - - Represents an annotation that shows a rectangle. - - - - - The rectangle transformed to screen coordinates. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the minimum X. - - The minimum X. - - - - Gets or sets the maximum X. - - The maximum X. - - - - Gets or sets the minimum Y. - - The minimum Y. - - - - Gets or sets the maximum Y. - - The maximum Y. - - - - - - - When overridden in a derived class, tests if the plot element is hit by the specified point. - - The hit test arguments. - - The result of the hit test. - - - - - Provides an abstract base class for shape annotations, such as , , and . - - - - - Initializes a new instance of the class. - - - - - Gets or sets the fill color. - - The fill color. - - - - Gets or sets the stroke color. - - - - - Gets or sets the stroke thickness. - - - - - Represents an annotation that shows text. - - - - - The actual bounds of the text. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the fill color of the background rectangle. - - The background. - - - - Gets or sets the position offset (screen coordinates). - - The offset. - - - - Gets or sets the padding of the background rectangle. - - The padding. - - - - Gets or sets the stroke color of the background rectangle. - - The stroke color. - - - - Gets or sets the stroke thickness of the background rectangle. - - The stroke thickness. - - - - - - - When overridden in a derived class, tests if the plot element is hit by the specified point. - - The hit test arguments. - - The result of the hit test. - - - - - Gets the coordinates of the (rotated) background rectangle. - - The position. - The size. - The padding. - The rotation. - The horizontal alignment. - The vertical alignment. - The background rectangle coordinates. - - - - Provides an abstract base class for annotations that contains text. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the annotation text. - - The text. - - - - Gets or sets the position of the text. - - If the value is DataPoint.Undefined, the default position of the text will be used. - - - - Gets or sets the horizontal alignment of the text. - - - - - Gets or sets the vertical alignment of the text. - - - - - Gets or sets the rotation of the text. - - The text rotation in degrees. - - - - Gets the actual position of the text. - - A function that returns the default position. This is used if is undefined. - The actual position of the text, in screen space. - - - - Gets the actual text alignment. - - The horizontal alignment. - The vertical alignment. - - - - Provides an abstract base class for transposable annotations. - - - - - - - - - - - - - - Represents an angular axis for polar plots. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the start angle (degrees). - - - - - Gets or sets the end angle (degrees). - - - - - Gets the coordinates used to draw ticks and tick labels (numbers or category names). - - The major label values. - The major tick values. - The minor tick values. - - - - Inverse transforms the specified screen point. - - The x coordinate. - The y coordinate. - The y-axis. - The data point. - Angle axis should always be the y-axis. - - - - Determines whether the axis is used for X/Y values. - - true if it is an XY axis; otherwise, false . - - - - Renders the axis on the specified render context. - - The render context. - The pass. - - - - Transforms the specified point to screen coordinates. - - The x value (for the current axis). - The y value. - The y axis. - The transformed point. - - - - Updates the scale and offset properties of the transform from the specified boundary rectangle. - - The bounds. - - - - Represents an angular axis that covers the whole plot area. - - - - - Renders the axis on the specified render context. - - The render context. - The pass. - - - - Provides an abstract base class for axes. - - - - - Exponent function. - - - - - Mantissa function. - - - - - Rounds a value if the difference between the rounded value and the original value is less than 1e-6. - - - - - The offset. - - - - - The scale. - - - - - The position of the axis. - - - - - Initializes a new instance of the class. - - - - - Occurs when the axis has been changed (by zooming, panning or resetting). - - - - - Occurs when the transform changed (size or axis range was changed). - - - - - Gets or sets the absolute maximum. This is only used for the UI control. It will not be possible to zoom/pan beyond this limit. The default value is double.MaxValue. - - - - - Gets or sets the absolute minimum. This is only used for the UI control. It will not be possible to zoom/pan beyond this limit. The default value is double.MinValue. - - - - - Gets or sets the actual major step. - - - - - Gets or sets the actual maximum value of the axis. - - If is not NaN, this value will be defined by . - Otherwise, if is not NaN, this value will be defined by . - Otherwise, this value will be defined by the maximum (+padding) of the data. - - - - Gets or sets the actual minimum value of the axis. - - If is not NaN, this value will be defined by . - Otherwise, if is not NaN, this value will be defined by . - Otherwise this value will be defined by the minimum (+padding) of the data. - - - - Gets or sets the maximum displayed value on the axis, as determined by the and . - - - The value is refreshed by , which is called before any plot elements are rendered. - - - - - Gets or sets the minimum displayed value on the axis, as determined by the and . - - - The value is refreshed by , which is called before any plot elements are rendered. - - - - - Gets or sets the actual minor step. - - - - - Gets or sets the actual string format being used. - - - - - Gets the actual title of the axis. - - If the property is set, the property is used to format the actual title. - - - - Gets or sets the orientation angle (degrees) for the axis labels. The default value is 0. - - - - - Gets or sets the distance from the end of the tick lines to the labels. The default value is 4. - - - - - Gets or sets the minimum distance from the axis labels to the axis title. The default value is 4. - - - - - Gets or sets the distance between the plot area and the axis. The default value is 0. - - - - - Gets or sets the color of the axis line. The default value is . - - - - - Gets or sets the line style of the axis line. The default value is . - - - - - Gets or sets the thickness of the axis line. The default value is 1. - - - - - Gets or sets a value indicating whether to clip the axis title. The default value is true. - - - - - Gets or sets a value indicating whether to crop gridlines with perpendicular axes Start/EndPositions. The default value is false. - - - - - Gets or sets the maximum value of the data displayed on this axis. - - - - - Gets or sets the minimum value of the data displayed on this axis. - - - - - Gets or sets the end position of the axis on the plot area. The default value is 1. - - The position is defined by a fraction in the range from 0 to 1, where 0 is at the bottom/left - and 1 is at the top/right. - - - - Gets or sets the color of the extra gridlines. The default value is . - - - - - Gets or sets the line style of the extra gridlines. The default value is . - - - - - Gets or sets the thickness of the extra gridlines. The default value is 1. - - - - - Gets or sets the values for the extra gridlines. The default value is null. - - - - - Gets or sets the filter function. The default value is null. - - - - - Gets or sets the maximum value that can be shown using this axis. Values greater or equal to this value will not be shown. The default value is double.MaxValue. - - - - - Gets or sets the minimum value that can be shown using this axis. Values smaller or equal to this value will not be shown. The default value is double.MinValue. - - - - - Gets or sets the maximum length (screen space) of the intervals. The available length of the axis will be divided by this length to get the approximate number of major intervals on the axis. The default value is 60. - - - - - Gets or sets a value indicating whether this axis is visible. The default value is true. - - - - - Gets or sets a value indicating whether panning is enabled. The default value is true. - - - - - Gets a value indicating whether this axis is reversed. It is reversed if > . - - - - - Gets or sets a value indicating whether zooming is enabled. The default value is true. - - - - - Gets or sets the key of the axis. This can be used to specify an axis if you have defined multiple axes in a plot. The default value is null. - - - - - Gets or sets the formatting function for the labels. The default value is null. - - This function can be used instead of overriding the method. - - - - Gets or sets the layer of the axis. The default value is . - - - - - Gets or sets the color of the major gridlines. The default value is #40000000. - - - - - Gets or sets the line style of the major gridlines. The default value is . - - - - - Gets or sets the thickness of the major gridlines. The default value is 1. - - - - - Gets or sets the interval between major ticks. The default value is double.NaN. - - - - - Gets or sets the size of the major ticks. The default value is 7. - - - - - Gets or sets the maximum value of the axis. The default value is double.NaN. - - - - - Gets or sets the 'padding' fraction of the maximum value. The default value is 0.01. - - A value of 0.01 gives 1% more space on the maximum end of the axis. This property is not used if the property is set. - - - - Gets or sets the screen-space data margin at the maximum. The default value is 0. - - The number of device independent units to included between the and . - - - - Gets or sets the screen-space margin at the maximum. The default value is 0. - - The number of device independent units to be left empty between the axis and the . - - - - Gets or sets the maximum range of the axis. Setting this property ensures that ActualMaximum-ActualMinimum < MaximumRange. The default value is double.PositiveInfinity. - - - - - Gets or sets the minimum value of the axis. The default value is double.NaN. - - - - - Gets or sets the minimum value for the interval between major ticks. The default value is 0. - - - - - Gets or sets the minimum value for the interval between minor ticks. The default value is 0. - - - - - Gets or sets the 'padding' fraction of the minimum value. The default value is 0.01. - - A value of 0.01 gives 1% more space on the minimum end of the axis. This property is not used if the property is set. - - - - Gets or sets the screen-space data margin at the minimum. The default value is 0. - - The number of device independent units to included between the and . - - - - Gets or sets the screen-space margin at the minimum. The default value is 0. - - The number of device independent units to be left empty between the axis the . - - - - Gets or sets the minimum range of the axis. Setting this property ensures that ActualMaximum-ActualMinimum > MinimumRange. The default value is 0. - - - - - Gets or sets the color of the minor gridlines. The default value is #20000000. - - - - - Gets or sets the line style of the minor gridlines. The default value is . - - - - - Gets or sets the thickness of the minor gridlines. The default value is 1. - - - - - Gets or sets the interval between minor ticks. The default value is double.NaN. - - - - - Gets or sets the color of the minor ticks. The default value is . - - If the value is , the value of - will be used. - - - - Gets or sets the size of the minor ticks. The default value is 4. - - - - - Gets the offset. This is used to transform between data and screen coordinates. - - - - - Gets or sets the position of the axis. The default value is . - - - - - Gets or sets a value indicating whether the axis should be positioned at the zero-crossing of the related axis. The default value is false. - - - - - Gets or sets the position tier which defines in which tier the axis is displayed. The default value is 0. - - The bigger the value the further afar is the axis from the graph. - - - - Gets the scaling factor of the axis. This is used to transform between data and screen coordinates. - - - - - Gets or sets the screen coordinate of the maximum end of the axis. - - - - - Gets or sets the screen coordinate of the minimum end of the axis. - - - - - Gets or sets the start position of the axis on the plot area. The default value is 0. - - The position is defined by a fraction in the range from 0 to 1, where 0 is at the bottom/left - and 1 is at the top/right. - - - - Gets or sets the string format used for formatting the axis values. The default value is null. - - - - - Gets or sets the tick style for major and minor ticks. The default value is . - - - - - Gets or sets the color of the major and minor ticks. The default value is . - - - - - Gets or sets the title of the axis. The default value is null. - - - - - Gets or sets the length of the title clipping rectangle (fraction of the available length of the axis). The default value is 0.9. - - - - - Gets or sets the color of the title. The default value is . - - If the value is null, the will be used. - - - - Gets or sets the title font. The default value is null. - - - - - Gets or sets the size of the title font. The default value is double.NaN. - - - - - Gets or sets the weight of the title font. The default value is . - - - - - Gets or sets the format string used for formatting the title and unit when is defined. - The default value is "{0} [{1}]", where {0} refers to the and {1} refers to the . - - If is null, the actual title is defined by only. - - - - Gets or sets the position of the title. The default value is 0.5. - - The position is defined by a fraction in the range 0 to 1. - - - - Gets or sets the unit of the axis. The default value is null. - - The is used to format the title including this unit. - - - - Gets or sets a value indicating whether to use superscript exponential format. The default value is false. - - - This format will convert 1.5E+03 to 1.5·10^{3} and render the superscript properly. - If is null, 1.0E+03 will be converted to 10^{3}, otherwise it will use the format string for the mantissa. - - - - - Gets or sets the desired margins such that the axis text ticks will not be clipped. - The actual margins may be smaller or larger than the desired margins if they are set manually. - - - - - Gets or sets the position tier max shift. - - - - - Gets or sets the position tier min shift. - - - - - Gets or sets the size of the position tier. - - - - - Gets the actual color of the title. - - - - - Gets the actual title font. - - - - - Gets the actual size of the title font. - - - - - Gets the actual title font weight. - - - - - Gets or sets the current view's maximum. This value is used when the user zooms or pans. - - The view maximum. - - - - Gets or sets the current view's minimum. This value is used when the user zooms or pans. - - The view minimum. - - - - Converts the value of the specified object to a double precision floating point number. DateTime objects are converted using DateTimeAxis.ToDouble and TimeSpan objects are converted using TimeSpanAxis.ToDouble. - - The value. - The floating point number value. - - - - Transforms the specified point from screen space to data space. - - The point. - The x axis. - The y axis. - The data point. - - - - Formats the value to be used on the axis. - - The value. - The formatted value. - - - - Gets the coordinates used to draw ticks and tick labels (numbers or category names). - - The major label values. - The major tick values. - The minor tick values. - - - - Gets the value from an axis coordinate, converts from a coordinate value to the actual data type. - - The coordinate. - The converted value. - Examples: The returns the and returns category strings. - - - - Inverse transform the specified screen point. - - The x coordinate. - The y coordinate. - The y-axis. - The data point. - - - - Inverse transforms the specified screen coordinate. This method can only be used with non-polar coordinate systems. - - The screen coordinate. - The value. - - - - Determines whether the axis is horizontal. - - true if the axis is horizontal; otherwise, false . - - - - Determines whether the specified value is valid. - - The value. - true if the specified value is valid; otherwise, false . - - - - Determines whether the axis is vertical. - - true if the axis is vertical; otherwise, false . - - - - Determines whether the axis is used for X/Y values. - - true if it is an XY axis; otherwise, false . - - - - Determines whether the axis is logarithmic. - - true if it is a logarithmic axis; otherwise, false . - - - - Measures the size of the axis and updates accordingly. This takes into account the axis title as well as tick labels - potentially exceeding the axis range. - - The render context. - - - - Pans the specified axis. - - The previous point (screen coordinates). - The current point (screen coordinates). - - - - Pans the specified axis. - - The delta. - - - - Renders the axis on the specified render context. - - The render context. - The pass. - - - - Resets the user's modification (zooming/panning) to minimum and maximum of this axis. - - - - - Returns a that represents this instance. - - A that represents this instance. - - - - Transforms the specified point to screen coordinates. - - The x value (for the current axis). - The y value. - The y axis. - The transformed point. - - - - Transforms the specified coordinate to screen coordinates. This method can only be used with non-polar coordinate systems. - - The value. - The transformed value (screen coordinate). - - - - Zoom to the specified scale. - - The new scale. - - - - Zooms the axis to the range [x0,x1]. - - The new minimum. - The new maximum. - - - - Zooms the axis at the specified coordinate. - - The zoom factor. - The coordinate to zoom at. - - - - Zooms the axis with the specified zoom factor at the center of the axis. - - The zoom factor. - - - - Modifies the data range of the axis [DataMinimum,DataMaximum] to includes the specified value. - - The value. - - - - Resets the and values. - - - - - Updates the and values. - - If the user has zoomed/panned the axis, the internal ViewMaximum/ViewMinimum - values will be used. If Maximum or Minimum have been set, these values will be used. Otherwise the maximum and minimum values - of the series will be used, including the 'padding'. - - - - Updates the actual minor and major step intervals. - - The plot area rectangle. - - - - Updates the scale and offset properties of the transform from the specified boundary rectangle. - - The bounds. - - - - Invoked when , , , and are changed. - - - - - Gets the default format string. - - A format string. - This format string is used if the StringFormat is not set. - - - - Applies a transformation after the inverse transform of the value. - - The value to transform. - The transformed value. - If this method is overridden, the method must also be overridden. - See for examples on how to implement this. - - - - Applies a transformation before the transform the value. - - The value to transform. - The transformed value. - If this method is overridden, the method must also be overridden. - See for examples on how to implement this. - - - - Calculates the minor interval. - - The major interval. - The minor interval. - - - - Creates tick values at the specified interval. - - The start value. - The end value. - The interval. - The maximum number of ticks (optional). The default value is 1000. - A sequence of values. - Step cannot be zero or negative. - - - - Coerces the actual maximum and minimum values. - - - - - Formats the value to be used on the axis. - - The value to format. - The formatted value. - - - - Calculates the actual maximum value of the axis, including the . - - The new actual maximum value of the axis. - - Must be called before - - - - - Calculates the actual minimum value of the axis, including the . - - The new actual minimum value of the axis. - - Must be called after - - - - - Sets the transform. - - The new scale. - The new offset. - - - - Calculates the actual interval. - - Size of the available area. - Maximum length of the intervals. - The calculate actual interval. - - - - Returns the actual interval to use to determine which values are displayed in the axis. - - The available size. - The maximum interval size. - The range. - Actual interval to use to determine which values are displayed in the axis. - - - - Raises the event. - - The instance containing the event data. - - - - Raises the event. - - The instance containing the event data. - - - - Provides additional data for the event. - - - - - Initializes a new instance of the class. - - Type of the change. - The delta minimum. - The delta maximum. - - - - Gets the type of the change. - - The type of the change. - - - - Gets the delta for the minimum. - - The delta. - - - - Gets the delta for the maximum. - - The delta. - - - - Defines change types for the event. - - - - - The axis was zoomed by the user. - - - - - The axis was panned by the user. - - - - - The axis zoom/pan was reset by the user. - - - - - Specifies the layer of an . - - - - - Below all series. - - - - - Above all series. - - - - - Specifies the position of an . - - - - - No position. - - - - - Left of the plot area. - - - - - Right of the plot area. - - - - - Top of the plot area. - - - - - Bottom of the plot area. - - - - - All positions. - - - - - Static utility methods for the classes. - - - - - Calculates the minor interval. - - The major interval. - The minor interval. - - - - Creates tick values at the specified interval. - - The start value. - The end value. - The interval. - The maximum number of ticks (optional). The default value is 1000. - A sequence of values. - Step cannot be zero or negative.;step - - - - Analyses two lists of major and minor ticks and creates a new containing the subset of the minor ticks which are not too close to any of the major ticks. - - The major ticks. Must be monotonically ascending or descending. - The minor ticks. Must be monotonically ascending or descending (same direction as major ticks). - A new list containing a subset of the original minor ticks such that there are no minor ticks too close to a major tick. - - - - Represents a category axis. - - The category axis is using the index of the label collection items as coordinates. - If you have 5 categories in the Labels collection, the categories will be placed at coordinates 0 to 4. - The range of the axis will be from -0.5 to 4.5 (excluding padding). - - - - The auto-generated labels. - - - - - The labels from the . - - - - - Initializes a new instance of the class. - - - - - Gets the actual category labels. - - - - - Gets or sets the gap width. - - The default value is 1.0 (100%). The gap width is given as a fraction of the total width/height of the items in a category. - - - - Gets or sets a value indicating whether the ticks are centered. If this is false, ticks will be drawn between each category. If this is true, ticks will be drawn in the middle of each category. - - - - - Gets or sets the items source (used to update the Labels collection). - - The items source. - - - - Gets or sets the data field for the labels. - - - - - Gets the list of category labels. - - - - - - - - - - - - - - Updates the category labels. - - The number of categories. - - - - - - - Represents a categorized color axis. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the invalid category color. - - The color. - - - - Gets or sets the palette. - - The palette. - - - - Gets the color of the specified index in the color palette. - - The color map index (less than NumberOfEntries). - The color. - - - - Gets the palette index of the specified value. - - The value. - The palette index. - If the value is less than minimum, 0 is returned. If the value is greater than maximum, Palette.Colors.Count+1 is returned. - - - - Renders the axis on the specified render context. - - The render context. - The pass. - - - - Gets the high value of the specified palette index. - - Index of the palette. - The value. - - - - Gets the high value. - - Index of the palette. - The major label values. - The value. - - - - Gets the low value. - - Index of the palette. - The major label values. - The value. - - - - Provides extension methods for . - - - - - Gets the color for the specified value. - - The axis. - The value. - The color. - - - - Represents an axis presenting values. - - The actual numeric values on the axis are days since 1900/01/01. - Use the static ToDouble and ToDateTime to convert numeric values to and from DateTimes. - The StringFormat value can be used to force formatting of the axis values - "yyyy-MM-dd" shows date - "w" or "ww" shows week number - "h:mm" shows hours and minutes - - - - The time origin. - - This gives the same numeric date values as Excel - - - - The maximum day value - - - - - The minimum day value - - - - - The actual interval type. - - - - - The actual minor interval type. - - - - - Initializes a new instance of the class. - - - - - Gets or sets CalendarWeekRule. - - - - - Gets or sets FirstDayOfWeek. - - - - - Gets or sets IntervalType. - - - - - Gets or sets MinorIntervalType. - - - - - Gets or sets the time zone (used when formatting date/time values). - - The time zone info. - No date/time conversion will be performed if this property is null. - - - - Creates a data point. - - The x value. - The y value. - A data point. - - - - Creates a data point. - - The x value. - The y value. - A data point. - - - - Creates a data point. - - The x value. - The y value. - A data point. - - - - Converts a numeric representation of the date (number of days after the time origin) to a DateTime structure. - - The number of days after the time origin. - A structure. Ticks = 0 if the value is invalid. - - - - Converts a DateTime to days after the time origin. - - The date/time structure. - The number of days after the time origin. - - - - Gets the tick values. - - The major label values. - The major tick values. - The minor tick values. - - - - Gets the value from an axis coordinate, converts from double to the correct data type if necessary. - e.g. DateTimeAxis returns the DateTime and CategoryAxis returns category strings. - - The coordinate. - The value. - - - - Updates the intervals. - - The plot area. - - - - Gets the default string format. - - - The format string. - - - - - Formats the value to be used on the axis. - - The value to format. - The formatted value. - - - - Calculates the actual interval. - - Size of the available area. - Maximum length of the intervals. - The calculate actual interval. - - - - Creates the date tick values. - - The min. - The max. - The step. - Type of the interval. - Date tick values. - - - - Creates tick values. - - The min. - The max. - The interval. - The interval type. - A list of tick values. - - - - Gets the week number for the specified date. - - The date. - The week number for the current culture. - - - - Specifies the interval for a . - - - - - Automatically determine interval. - - - - - Manual definition of intervals. - - - - - Interval type is milliseconds. - - - - - Interval type is seconds. - - - - - Interval type is minutes. - - - - - Interval type is hours. - - - - - Interval type is days. - - - - - Interval type is weeks. - - - - - Interval type is months. - - - - - Interval type is years. - - - - - Specifies functionality for color axes. - - - - - Gets the color of the specified index in the color palette. - - The color map index (less than NumberOfEntries). - The color. - - - - Gets the palette index of the specified value. - - The value. - The palette index. - If the value is less than minimum, 0 is returned. If the value is greater than maximum, Palette.Colors.Count+1 is returned. - - - - Represents an axis with linear scale. - - - - - Initializes a new instance of the class. - - - - - Gets or sets a value indicating whether to format numbers as fractions. - - - - - Gets or sets the fraction unit. Remember to set FormatAsFractions to true. - - The fraction unit. - - - - Gets or sets the fraction unit symbol. Use FractionUnit = Math.PI and FractionUnitSymbol = "π" if you want the axis to show "π/2,π,3π/2,2π" etc. Use FractionUnit = 1 and FractionUnitSymbol = "L" if you want the axis to show "0,L/2,L" etc. Remember to set FormatAsFractions to true. - - The fraction unit symbol. - - - - Determines whether the axis is used for X/Y values. - - true if it is an XY axis; otherwise, false . - - - - Determines whether the axis is logarithmic. - - true if it is a logarithmic axis; otherwise, false . - - - - Formats the value to be used on the axis. - - The value to format. - The formatted value. - - - - Represents a linear color axis. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the color used to represent NaN values. - - A that defines the color. The default value is OxyColors.Gray. - - - - Gets or sets the color of values above the maximum value. - - The color of the high values. - - - - Gets or sets the color of values below the minimum value. - - The color of the low values. - - - - Gets or sets the palette. - - The palette. - - - - Gets or sets a value indicating whether to render the colors as an image. - - true if the rendering should use an image; otherwise, false. - - - - Determines whether the axis is used for X/Y values. - - true if it is an XY axis; otherwise, false . - - - - Gets the color. - - The color map index (less than NumberOfEntries). - The color. - - - - Gets the colors. - - The colors. - - - - Gets the palette index of the specified value. - - The value. - The palette index. - If the value is less than minimum, 0 is returned. If the value is greater than maximum, Palette.Colors.Count+1 is returned. - - - - Renders the axis on the specified render context. - - The render context. - The render pass. - - - - Gets the high value of the specified palette index. - - Index of the palette. - The value. - - - - Gets the low value of the specified palette index. - - Index of the palette. - The value. - - - - Generates the image used to render the color axis. - - Reverse the colors if set to true. - An used to render the color axis. - - - - Represents an axis with logarithmic scale. - - - - - - Initializes a new instance of the class. - - - - - Gets or sets the logarithmic base (normally 10). - - The logarithmic base. - - - - - Gets or sets a value indicating whether the ActualMaximum and ActualMinimum values should be padded to the nearest power of the Base. - - - - - Gets or sets the logarithmic actual maximum value of the axis. - - - - - Gets or sets the logarithmic actual minimum value of the axis. - - - - - Gets or sets the logarithmic clip maximum value of the axis. - - - - - Gets or sets the logarithmic clip minimum value of the axis. - - - - - Gets the coordinates used to draw ticks and tick labels (numbers or category names). - - The major label values. - The major tick values. - The minor tick values. - - - - Determines whether the axis is used for X/Y values. - - true if it is an XY axis; otherwise, false . - - - - Determines whether the axis is logarithmic. - - true if it is a logarithmic axis; otherwise, false . - - - - Pans the specified axis. - - The previous point (screen coordinates). - The current point (screen coordinates). - - - - Inverse transforms the specified screen coordinate. This method can only be used with non-polar coordinate systems. - - The screen coordinate. - The value. - - - - Transforms the specified coordinate to screen coordinates. - - The value. - The transformed value (screen coordinate). - - - - Zooms the axis at the specified coordinate. - - The zoom factor. - The coordinate to zoom at. - - - - Raises all elements of a List to the power of this.Base. - - The input values. - If true, discards all values that are not in the axis range. - A new IList containing the resulting values. - - - - Applies the logarithm with this.Base to all elements of a List. - - The input values. - If true, discards all values that are not in the axis range. - A new IList containing the resulting values. - - - - Calculates ticks of the decades in the axis range with a specified step size. - - The step size. - A new IList containing the decade ticks. - - - - Calculates logarithmic ticks of the decades in the axis range with a specified step size. - - The step size. - A new IList containing the logarithmic decade ticks. - - - - Calculates logarithmic ticks of all decades in the axis range and their subdivisions. - - If true (default), the lowest and highest decade are clipped to the axis range. - A new IList containing the logarithmic decade ticks. - - - - Calculates ticks of all decades in the axis range and their subdivisions. - - If true (default), the lowest and highest decade are clipped to the axis range. - A new IList containing the decade ticks. - - - - Chooses from a list of candidates so that the resulting List matches the as far as possible. - - The candidates. - The desired logarithmic step size. - A new IList containing the chosen candidates. - - - - Chooses from a list of candidates so that the resulting List matches the as far as possible. - - The candidates. - The desired logarithmic step size. - A new IList containing the chosen logarithmic candidates. - - - - Calculates minor tick candidates for a given set of major candidates. - - The major candidates. - The desired major step size. - A new IList containing the minor candidates. - - - - Subdivides a logarithmic range into multiple, evenly-spaced (in linear scale!) ticks. The number of ticks and the tick intervals are adapted so - that the resulting steps are "nice" numbers. - - The IList the computed steps will be added to. - The minimum number of steps. - The start of the range. - The end of the range. - - - - Updates the and values. - - - If the user has zoomed/panned the axis, the internal ViewMaximum/ViewMinimum - values will be used. If Maximum or Minimum have been set, these values will be used. Otherwise the maximum and minimum values - of the series will be used, including the 'padding'. - - - - - - - - Applies a transformation after the inverse transform of the value. This is used in logarithmic axis. - - The value to transform. - The transformed value. - - - - Applies a transformation before the transform the value. This is used in logarithmic axis. - - The value to transform. - The transformed value. - - - - Coerces the actual maximum and minimum values. - - - - - Represents a magnitude axis for polar plots. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the midpoint (screen coordinates) of the plot area. This is used by polar coordinate systems. - - - - - Inverse transform the specified screen point. - - The x coordinate. - The y coordinate. - The y-axis. - The data point. - - - - Determines whether the axis is used for X/Y values. - - true if it is an XY axis; otherwise, false . - - - - Renders the axis on the specified render context. - - The render context. - The rendering pass. - - - - Transforms the specified point to screen coordinates. - - The x value (for the current axis). - The y value. - The y axis. - The transformed point. - - - - Updates the scale and offset properties of the transform from the specified boundary rectangle. - - The bounds. - - - - Represents a magnitude axis that covers the whole plot area. - - - - - Portion to shift the center in horizontal direction relative to the plot area size (from -0.5 to +0.5 meaning +-50% of the width) - - - - - Portion to shift the center in vertical direction relative to the plot area size (from -0.5 to +0.5 meaning +-50% of the height) - - - - - Initializes a new instance of the class. - - - - - Renders the axis on the specified render context. - - The render context. - The rendering pass. - - - - - - - Updates the scale and offset properties of the transform from the specified boundary rectangle. - - The bounds. - - - - Pans the specified axis. - - The previous point (screen coordinates). - The current point (screen coordinates). - - - - Zooms the axis at the specified coordinate. - - The zoom factor. - The coordinate to zoom at. - - - - Represents a color axis that contains colors for specified ranges. - - - - - The ranges - - - - - Initializes a new instance of the class. - - - - - Gets or sets the color used to represent NaN values. - - A that defines the color. The default value is OxyColors.Gray. - - - - Gets or sets the color of values above the maximum value. - - The color of the high values. - - - - Gets or sets the color of values below the minimum value. - - The color of the low values. - - - - Adds a range. - - The lower bound. - The upper bound. - The color. - - - - Clears the ranges. - - - - - Gets the palette index of the specified value. - - The value. - The palette index. - If the value is less than minimum, 0 is returned. If the value is greater than maximum, Palette.Colors.Count+1 is returned. - - - - Gets the color. - - The color map index. - The color. - - - - Renders the axis on the specified render context. - - The render context. - The render pass. - - - - Defines a range. - - - - - Gets or sets the color. - - The color. - - - - Gets or sets the lower bound. - - The lower bound. - - - - Gets or sets the upper bound. - - The upper bound. - - - - Provides functionality to render using the full plot area. - - - - - Initializes a new instance of the class. - - The render context. - The plot. - - - - Renders the specified axis. - - The axis. - The render pass. - Magnitude axis not defined. - - - - Transforms the specified point to screen coordinates. - - - - - - - - - - - Provides functionality to render . - - - - - Initializes a new instance of the class. - - The render context. - The plot. - - - - Renders the specified axis. - - The axis. - The render pass. - Magnitude axis not defined. - - - - Provides an abstract base class for axis renderers. - - - - - The plot. - - - - - The render context. - - - - - The major label values - - - - - The major tick values - - - - - The minor tick values - - - - - Initializes a new instance of the class. - - The render context. - The plot. - - - - Gets the plot. - - The plot. - - - - Gets the render context. - - The render context. - - - - Gets or sets the axis lines pen. - - - - - Gets or sets the extra grid lines pen. - - - - - Gets or sets the major label values. - - - - - Gets or sets the major grid lines pen. - - - - - Gets or sets the major tick pen. - - - - - Gets or sets the major tick values. - - - - - Gets or sets the minor grid lines pen. - - - - - Gets or sets the minor tick pen. - - - - - Gets or sets the minor tick values. - - - - - Gets or sets the zero grid line pen. - - - - - Renders the specified axis. - - The axis. - The pass. - - - - Creates the pens. - - The axis. - - - - Gets the tick positions. - - The axis. - The tick style. - The tick size. - The position. - The x 0. - The x 1. - - - - Determines whether the specified value is within the specified range. - - The value to check. - The minimum value of the range. - The maximum value of the range. - true if the specified value is within the range; otherwise, false. - - - - Provides functionality to render horizontal and vertical axes. - - - - - Initializes a new instance of the class. - - The render context. - The plot. - - - - Renders the specified axis. - - The axis. - The pass. - - - - Interpolates linearly between two values. - - The x0. - The x1. - The interpolation factor. - The interpolated value. - - - - Snaps v to value if it is within the specified distance. - - The target value. - The value to snap. - The distance tolerance. - - - - Gets the axis title position, rotation and alignment. - - The axis. - The title position. - The angle. - The horizontal alignment. - The vertical alignment. - The . - - - - Renders the axis title. - - The axis. - The title position. - - - - Renders the major items. - - The axis. - The axis position. - The title position. - Draw the axis line if set to true. - - - - Renders the minor items. - - The axis. - The axis position. - - - - Adds segments to array. - If is true, then lines will be cropped with lists axes. - - The target segments. - Perpendicular axes list. - True, if current axis is horizontal. - True, if gridlines should be cropped. - Starting point position. - Plot area left position. - Plot area right position. - Plot area top position. - Plot area bottom position. - - - - Gets the alignments given the specified rotation angle. - - The angle of a box to rotate (usually it is label angle). - - The axis angle, the original angle belongs to. The Top axis should have 0, next angles are computed clockwise. - The angle should be in [-180, 180). (T, R, B, L) is (0, 90, -180, -90). - - Horizontal alignment. - Vertical alignment. - - This method is supposed to compute the alignment of the labels that are put near axis. - Because such labels can have different angles, and the axis can have different angles as well, - computing the alignment is not straightforward. - - - - - Provides functionality to render using the full plot area. - - - - - constants to simplify angular calculations - - - - - this constant limit the number of segments to draw a tick arc - - - - - Initializes a new instance of the class. - - The render context. - The plot. - - - - Renders the specified axis. - - The axis. - The pass. - Angle axis should not be null. - - - - Returns the angle (in radian) of the axis line in screen coordinate - - The axis. - The angle axis. - The angle (in radians). - - - - Choose the most appropriate alignment for tick text - - The actual angle. - The horizontal alignment. - The vertical alignment. - - - - Renders a tick by drawing an lot of segments - - The axis. - The angle axis. - The x-value. - The pen. - The start angle. - The end angle. - - - - Renders major tick text - - The axis. - The x-value. - The angle axis. - - - - Provides functionality to render . - - - - - Initializes a new instance of the class. - - The render context. - The plot. - - - - Renders the specified axis. - - The axis. - The pass. - Angle axis should not be null. - - - - Returns the angle (in radian) of the axis line in screen coordinate - - The axis. - The angle axis. - The angle (in radians). - - - - Choose the most appropriate alignment for tick text - - The actual angle. - The horizontal alignment. - The vertical alignment. - - - - Renders a tick, chooses the best implementation - - The axis. - The angle axis. - The x-value. - The pen. - - - - Renders a tick by drawing an ellipse - - The axis. - The angle axis. - The x-value. - The pen. - - - - Renders a tick by drawing an lot of segments - - The axis. - The angle axis. - The x-value. - The pen. - - - - Renders major tick text - - The axis. - The x-value. - The angle axis. - - - - Defines the style of axis ticks. - - - - - The ticks are rendered crossing the axis line. - - - - - The ticks are rendered inside of the plot area. - - - - - The ticks are rendered Outside the plot area. - - - - - The ticks are not rendered. - - - - - Represents an axis presenting values. - - The values should be in seconds. - The StringFormat value can be used to force formatting of the axis values - "h:mm" shows hours and minutes - "m:ss" shows minutes and seconds - - - - Converts a time span to a double. - - The time span. - A double value. - - - - Converts a double to a time span. - - The value. - A time span. - - - - Gets the value from an axis coordinate, converts from double to the correct data type if necessary. e.g. DateTimeAxis returns the DateTime and CategoryAxis returns category strings. - - The coordinate. - The value. - - - - Gets the default format string. - - - The default format string. - - - - - Formats the value to be used on the axis. - - The value to format. - The formatted value. - - - - Calculates the actual interval. - - Size of the available area. - Maximum length of the intervals. - The calculate actual interval. - - - - Specifies whether code should be generated for the property. - - - - - Initializes a new instance of the class. - - The generate code. - - - - Gets or sets a value indicating whether GenerateCode. - - - - - Provides functionality to generate C# code for the specified . - - This is useful for creating examples or unit tests. Press Ctrl+Alt+C in a plot to copy code to the clipboard. - Usage: - - var cg = new CodeGenerator(myPlotModel); - Clipboard.SetText(cg.ToCode()); - - - - - The string builder. - - - - - The variables. - - - - - The indent string. - - - - - The current number of indents. - - - - - Initializes a new instance of the class. - - The model. - - - - Gets or sets the number of indents. - - - - - Formats the code. - - The format. - The values. - The format code. - - - - Formats a constructor. - - The type. - The format of the constructor arguments. - The argument values. - The format constructor. - - - - Returns the c# code for this model. - - C# code. - - - - Adds the specified object to the generated code. - - The object. - The variable name. - - - - Adds the children. - - The name. - Name of the collection. - The children. - - - - Adds the items. - - The name. - The list. - - - - Creates and sets the elements of an array. - - The name. - The array. - - - - Appends the line. - - The format string. - The args. - - - - Determines if the two specified lists are equal. - - The first list. - The second list. - True if all items are equal. - - - - Get the first attribute of the specified type. - - The type. - The property info. - The attribute, or null if no attribute was found. - - - - Gets a new variable name of the specified type. - - The type. - The variable name. - - - - Makes a valid variable name of a string. Invalid characters will simply be removed. - - The title. - A valid variable name. - - - - The set properties. - - The instance. - The variable name. - The default values. - - - - Sets the property. - - The property name. - The value. - - - - Provides extension methods for code generation. - - - - - Converts the value of this instance to c# code. - - The instance. - C# code. - - - - Converts the value of this instance to c# code. - - The value. - C# code. - - - - Converts the value of this instance to c# code. - - The instance. - C# code. - - - - Converts the value of this instance to c# code. - - The instance. - C# code. - - - - Converts the value of this instance to c# code. - - The instance. - C# code. - - - - Converts the value of this instance to c# code. - - The instance. - C# code. - - - - Provides functionality to generate C# code of an object. - - - - - Returns C# code that generates this instance. - - The C# code. - - - - Represents a point in the data space. - - s are transformed to s. - - - - The undefined. - - - - - The x-coordinate. - - - - - The y-coordinate. - - - - - Initializes a new instance of the struct. - - The x. - The y. - - - - Gets the X-coordinate of the point. - - The X-coordinate. - - - - Gets the Y-coordinate of the point. - - The Y-coordinate. - - - - Returns C# code that generates this instance. - - The to code. - - - - Determines whether this instance and another specified object have the same value. - - The point to compare to this instance. - true if the value of the parameter is the same as the value of this instance; otherwise, false. - - - - Returns a that represents this instance. - - A that represents this instance. - - - - Determines whether this point is defined. - - true if this point is defined; otherwise, false. - - - - Specifies functionality to provide a . - - - - - Gets the that represents the element. - - A . - - - - Defines functionality to export a . - - - - - Exports the specified to a . - - The model to export. - The target stream. - - - - Defines the marker type. - - - - - Do not render markers. - - - - - Render markers as circles. - - - - - Render markers as squares. - - - - - Render markers as diamonds. - - - - - Render markers as triangles. - - - - - Render markers as crosses (note: this marker type requires the stroke color to be set). - - This marker type requires the stroke color to be set. - - - - Renders markers as plus signs (note: this marker type requires the stroke color to be set). - - This marker type requires the stroke color to be set. - - - - Renders markers as stars (note: this marker type requires the stroke color to be set). - - This marker type requires the stroke color to be set. - - - - Render markers by a custom shape (defined by outline). - - - - - Represents absolute or relative lengths in data or screen space. - - - - - The unit type - - - - - The value - - - - - Initializes a new instance of the struct. - - The value. - The unit. - - - - Gets the value. - - The value. - - - - Gets the type of the unit. - - The type of the unit. - - - - Determines whether this instance and another specified object have the same value. - - The length to compare to this instance. - true if the value of the parameter is the same as the value of this instance; otherwise, false. - - - - Defines the kind of value that a object is holding. - - - - - The value is in data space (transformed by x/y axis) - - - - - The value is in screen units - - - - - The value is relative to the plot viewport (0-1) - - - - - The value is relative to the plot area (0-1) - - - - - Provides functionality to handle input events. - - - - - A synchronization object that is used when the actual model in the current view is null. - - - - - Initializes a new instance of the class. - - - - - Gets the input bindings. - - This collection is used to specify the customized input gestures (both key, mouse and touch). - - - - Gets the manipulators that are created by mouse down events. These manipulators are removed when the mouse button is released. - - - - - Gets the manipulators that are created by mouse enter events. These manipulators are removed when the mouse leaves the control. - - - - - Gets the manipulators that are created by touch events. These manipulators are removed when the touch gesture is completed. - - - - - Handles the specified gesture. - - The plot view. - The gesture. - The instance containing the event data. - true if the event was handled. - - - - Handles mouse down events. - - The plot view. - The instance containing the event data. - true if the event was handled. - - - - Handles mouse enter events. - - The plot view. - The instance containing the event data. - true if the event was handled. - - - - Handles mouse leave events. - - The plot view. - The instance containing the event data. - true if the event was handled. - - - - Handles mouse move events. - - The plot view. - The instance containing the event data. - true if the event was handled. - - - - Handles mouse up events. - - The plot view. - The instance containing the event data. - true if the event was handled. - - - - Handles mouse wheel events. - - The plot view. - The instance containing the event data. - true if the event was handled. - - - - Handles touch started events. - - The plot view. - The instance containing the event data. - true if the event was handled. - - - - Handles touch delta events. - - The plot view. - The instance containing the event data. - true if the event was handled. - - - - Handles touch completed events. - - The plot view. - The instance containing the event data. - true if the event was handled. - - - - Handles key down events. - - The plot view. - The instance containing the event data. - true if the event was handled. - - - - Adds the specified mouse manipulator and invokes the method with the specified mouse down event arguments. - - The plot view. - The manipulator to add. - The instance containing the event data. - - - - Adds the specified mouse hover manipulator and invokes the method with the specified mouse event arguments. - - The plot view. - The manipulator. - The instance containing the event data. - - - - Adds the specified mouse hover manipulator and invokes the method with the specified mouse event arguments. - - The plot view. - The manipulator. - The instance containing the event data. - - - - Binds the specified command to the specified mouse gesture. Removes old bindings to the gesture. - - The gesture. - The command. If null, the binding will be removed. - - - - Binds the specified command to the specified mouse enter gesture. Removes old bindings to the gesture. - - The gesture. - The command. If null, the binding will be removed. - - - - Binds the specified command to the specified mouse wheel gesture. Removes old bindings to the gesture. - - The gesture. - The command. If null, the binding will be removed. - - - - Binds the specified command to the specified touch gesture. Removes old bindings to the gesture. - - The gesture. - The command. If null, the binding will be removed. - - - - Binds the specified command to the specified key gesture. Removes old bindings to the gesture. - - The gesture. - The command. If null, the binding will be removed. - - - - Unbinds the specified gesture. - - The gesture to unbind. - - - - Unbinds the specified command from all gestures. - - The command to unbind. - - - - Unbinds all commands. - - - - - Binds the specified command to the specified gesture. Removes old bindings to the gesture. - - The gesture. - The command. If null, the binding will be removed. - This method was created to avoid calling a virtual method in the constructor. - - - - Gets the command for the specified . - - The input gesture. - A command. - - - - Handles a command triggered by an input gesture. - - The command. - The plot view. - The instance containing the event data. - true if the command was handled. - - - - Gets the synchronization object for the specified view. - - The view. - An object that can be used to synchronize access to the actual model of the view. - This object is used to ensure that events are not handled when the model is being updated. - - - - Provides extension methods for the . - - - - - Binds the specified key to the specified command. - - The plot controller. - The key. - A plot controller command that takes key event arguments. - - - - Binds the specified modifier+key to the specified command. - - The plot controller. - The key. - The key modifiers. - A plot controller command that takes key event arguments. - - - - Binds the specified mouse button to the specified command. - - The plot controller. - The mouse button. - A plot controller command that takes mouse event arguments. - - - - Binds the specified modifier+mouse button gesture to the specified command. - - The plot controller. - The mouse button. - The modifiers. - A plot controller command that takes mouse event arguments. - - - - Binds the specified modifiers+mouse button+click count gesture to the specified command. - - The plot controller. - The mouse button. - The modifiers. - The click count. - A plot controller command that takes mouse event arguments. - - - - Binds the touch down event to the specified command. - - The plot controller. - A plot controller command that takes touch event arguments. - - - - Binds the mouse enter event to the specified command. - - The plot controller. - A plot controller command that takes mouse event arguments. - - - - Binds the mouse wheel event to the specified command. - - The plot controller. - A plot controller command that takes mouse wheel event arguments. - - - - Binds the modifier+mouse wheel event to the specified command. - - The plot controller. - The modifier key(s). - A plot controller command that takes mouse wheel event arguments. - - - - Unbinds the specified mouse down gesture. - - The controller. - The mouse button. - The modifier keys. - The click count. - - - - Unbinds the specified key down gesture. - - The controller. - The key. - The modifier keys. - - - - Unbinds the mouse enter gesture. - - The controller. - - - - Unbinds the touch down gesture. - - The controller. - - - - Unbinds the mouse wheel gesture. - - The controller. - - - - Defines the cursor type. - - - - - The default cursor - - - - - The pan cursor - - - - - The zoom rectangle cursor - - - - - The horizontal zoom cursor - - - - - The vertical zoom cursor - - - - - Provides a implemented by a delegate. - - The type of the event arguments. - - - - The handler - - - - - Initializes a new instance of the class. - - The handler. - - - - Executes the command on the specified plot. - - The plot view. - The plot controller. - The instance containing the event data. - - - - Executes the command on the specified plot. - - The plot view. - The plot controller. - The instance containing the event data. - - - - Provides an abstract base class for graphics elements. - - - Provides an abstract base class for graphics elements. - - - Provides an abstract base class for graphics elements. - - - - - Gets the parent model of the element. - - - The that is the parent of the element. - - - - - Tests if the plot element is hit by the specified point. - - The hit test arguments. - - A hit test result. - - - - - When overridden in a derived class, tests if the plot element is hit by the specified point. - - The hit test arguments. - - The result of the hit test. - - - - - Occurs when a key is pressed down when the plot view is in focus. - - - - - Occurs when a mouse button is pressed down on the model. - - - - - Occurs when the mouse is moved on the plot element (only occurs after MouseDown). - - - - - Occurs when the mouse button is released on the plot element. - - - - - Occurs when a touch gesture starts. - - - - - Occurs when a touch gesture is changed. - - - - - Occurs when the touch gesture is completed. - - - - - Raises the event. - - The instance containing the event data. - - - - Raises the event. - - The instance containing the event data. - - - - Raises the event. - - The instance containing the event data. - - - - Raises the event. - - The instance containing the event data. - - - - Raises the event. - - The instance containing the event data. - - - - Raises the event. - - The instance containing the event data. - - - - Raises the event. - - The instance containing the event data. - - - - The selection - - - - - Occurs when the selected items is changed. - - - - - Gets or sets a value indicating whether this element can be selected. The default is true. - - - - - Gets or sets the selection mode of items in this element. The default is SelectionMode.All. - - The selection mode. - This is only used by the select/unselect functionality, not by the rendering. - - - - Gets the actual selection color. - - The actual selection color. - - - - Determines whether any part of this element is selected. - - true if this element is selected; otherwise, false. - - - - Gets the indices of the selected items in this element. - - Enumerator of item indices. - - - - Clears the selection. - - - - - Unselects all items in this element. - - - - - Determines whether the specified item is selected. - - The index of the item. - true if the item is selected; otherwise, false. - - - - Selects all items in this element. - - - - - Selects the specified item. - - The index. - - - - Unselects the specified item. - - The index. - - - - Gets the selection color if the item is selected, or the specified color if it is not. - - The unselected color of the element. - The index of the item to check (use -1 for all items). - A color. - - - - Gets the selection fill color it the element is selected, or the specified fill color if it is not. - - The unselected fill color of the element. - The index of the item to check (use -1 for all items). - A fill color. - - - - Ensures that the selection field is not null. - - - - - Raises the event. - - The instance containing the event data. - - - - The element collection changed event args. - - The type. - - - - Initializes a new instance of the class. - - The added items. - The removed items. - - - - Gets the added items. - - The added items. - - - - Gets the removed items. - - The removed items. - - - - Represents a collection of objects. - - The type of the elements. - - - - The parent . - - - - - The internal list. - - - - - Initializes a new instance of the class. - - The parent . - - - - Raised when the collection changes. - - - - - Gets the number of elements contained in the collection. - - The number of elements contained in the collection. - - - - Gets a value indicating whether the collection is read-only. - - true if the collection is read-only; otherwise, false. - - - - Gets or sets the element at the specified index. - - The index. - The element. - - - - Returns an enumerator that iterates through the collection. - - A that can be used to iterate through the collection. - - - - Returns an enumerator that iterates through a collection. - - An object that can be used to iterate through the collection. - - - - Adds an item to the collection. - - The object to add to the collection. - The element cannot be added, it already belongs to a PlotModel. - - - - Removes all items from the collection. - - - - - Determines whether the contains a specific value. - - The object to locate in the . - true if is found in the ; otherwise, false. - - - - Copies to. - - The array. - Index of the array. - - - - Removes the first occurrence of a specific object from the . - - The object to remove from the . - true if was successfully removed from the ; otherwise, false. This method also returns false if is not found in the original . - - - - Determines the index of a specific item in the collection. - - The object to locate in the collection. - The index of if found in the list; otherwise, -1. - - - - Inserts an item to the collection at the specified index. - - The zero-based index at which should be inserted. - The object to insert into the collection. - The element cannot be inserted, it already belongs to a PlotModel. - - - - Removes the collection item at the specified index. - - The zero-based index of the item to remove. - - - - Raises the collection changed event. - - The added items. - The removed items. - - - - Represents arguments for the hit test. - - - - - Initializes a new instance of the class. - - The point. - The tolerance. - - - - Gets the point to hit test. - - - - - Gets the hit test tolerance. - - - - - Represents a hit test result. - - - - - Initializes a new instance of the class. - - The element that was hit. - The nearest hit point. - The item. - The index. - - - - Gets the index of the hit (if available). - - The index. - If the hit was in the middle between point 1 and 2, index = 1.5. - - - - Gets the item of the hit (if available). - - The item. - - - - Gets the element that was hit. - - - The element. - - - - - Gets the position of the nearest hit point. - - The nearest hit point. - - - - Specifies functionality to interact with a graphics view. - - - - - Handles mouse down events. - - The plot view. - The instance containing the event data. - true if the event was handled. - - - - Handles mouse move events. - - The plot view. - The instance containing the event data. - true if the event was handled. - - - - Handles mouse up events. - - The plot view. - The instance containing the event data. - true if the event was handled. - - - - Handles mouse enter events. - - The plot view. - The instance containing the event data. - true if the event was handled. - - - - Handles mouse leave events. - - The plot view. - The instance containing the event data. - true if the event was handled. - - - - Handles mouse wheel events. - - The plot view. - The instance containing the event data. - true if the event was handled. - - - - Handles touch started events. - - The plot view. - The instance containing the event data. - true if the event was handled. - - - - Handles touch delta events. - - The plot view. - The instance containing the event data. - true if the event was handled. - - - - Handles touch completed events. - - The plot view. - The instance containing the event data. - true if the event was handled. - - - - Handles key down events. - - The plot view. - The instance containing the event data. - true if the event was handled. - - - - Handles the specified gesture. - - The plot view. - The gesture. - The instance containing the event data. - true if the event was handled. - - - - Adds the specified mouse manipulator and invokes the method with the specified mouse event arguments. - - The plot view. - The manipulator to add. - The instance containing the event data. - - - - Adds the specified mouse hover manipulator and invokes the method with the specified mouse event arguments. - - The view. - The manipulator. - The instance containing the event data. - - - - Adds the specified touch manipulator and invokes the method with the specified mouse event arguments. - - The view. - The manipulator. - The instance containing the event data. - - - - Binds the specified command to the specified mouse down gesture. Removes old bindings to the gesture. - - The mouse down gesture. - The command. If null, the binding will be removed. - - - - Binds the specified command to the specified mouse enter gesture. Removes old bindings to the gesture. - - The mouse enter gesture. - The command. If null, the binding will be removed. - - - - Binds the specified command to the specified mouse wheel gesture. Removes old bindings to the gesture. - - The mouse wheel gesture. - The command. If null, the binding will be removed. - - - - Binds the specified command to the specified touch gesture. Removes old bindings to the gesture. - - The touch gesture. - The command. If null, the binding will be removed. - - - - Binds the specified command to the specified key gesture. Removes old bindings to the gesture. - - The key gesture. - The command. If null, the binding will be removed. - - - - Unbinds the specified gesture. - - The gesture to unbind. - - - - Unbinds the specified command from all gestures. - - The command to unbind. - - - - Unbinds all commands. - - - - - Represents an binding by an input gesture and a command binding. - - - - - Initializes a new instance of the class by a gesture. - - The gesture. - The command. - - - - Initializes a new instance of the class by a key gesture. - - The key. - The modifiers. - The command. - - - - Initializes a new instance of the class by a mouse gesture. - - The mouse button. - The modifiers. - The command. - - - - Gets the gesture. - - - - - Gets the command. - - - - - Specifies common functionality for the views. - - - - - Gets the actual model in the view. - - - The actual . - - - - - Gets the actual controller. - - - The actual . - - - - - Gets the coordinates of the client area of the view. - - - The client area rectangle. - - - - - Sets the cursor type. - - The cursor type. - - - - Hides the zoom rectangle. - - - - - Shows the zoom rectangle. - - The rectangle. - - - - Specifies functionality to execute a command on a view. - - - - - Executes the command on the specified plot. - - The view. - The controller. - The instance containing the event data. - - - - Specifies functionality to execute a command on a view. - - The type of the event arguments. - - - - Executes the command on the specified plot. - - The view. - The controller. - The instance containing the event data. - - - - Provides an abstract base class for controller manipulators. - - The type of the event arguments. - - - - Initializes a new instance of the class. - - The view. - - - - Gets the plot view where the event was raised. - - The plot view. - - - - Occurs when a manipulation is complete. - - The instance containing the event data. - - - - Occurs when the input device changes position during a manipulation. - - The instance containing the event data. - - - - Occurs when an input device begins a manipulation on the plot. - - The instance containing the event data. - - - - Provides an abstract base class for graphics models. - - - Provides an abstract base class for graphics models. - - - - - The default selection color. - - - - - The synchronization root object. - - - - - Initializes a new instance of the class. - - - - - Gets an object that can be used to synchronize access to the . - - A synchronization object. - This property can be used when modifying the on a separate thread (not the thread updating or rendering the model). - - - - Gets or sets the color of the selection. - - The color of the selection. - - - - Returns the elements that are hit at the specified position. - - The hit test arguments. - - A sequence of hit results. - - - - - Gets all elements of the model, top-level elements first. - - An enumerator of the elements. - - - - The mouse hit tolerance. - - - - - The element that receives mouse move events. - - - - - The element that receives touch delta events. - - - - - Occurs when a key is pressed down when the plot view is focused. - - - - - Occurs when a mouse button is pressed down on the model. - - - - - Occurs when the mouse is moved on the plot element (only occurs after MouseDown). - - - - - Occurs when the mouse button is released on the plot element. - - - - - Occurs when the mouse cursor enters the plot area. - - - - - Occurs when the mouse cursor leaves the plot area. - - - - - Occurs when a touch gesture is started. - - - - - Occurs when a touch gesture is changed. - - - - - Occurs when a touch gesture is completed. - - - - - Handles the mouse down event. - - The sender. - The instance containing the event data. - - - - Handles the mouse move event. - - The sender. - The instance containing the event data. - - - - Handles the mouse up event. - - The sender. - The instance containing the event data. - - - - Handles the mouse enter event. - - The sender. - The instance containing the event data. - - - - Handles the mouse leave event. - - The sender. - The instance containing the event data. - - - - Handles the touch started event. - - The sender. - A instance containing the event data. - - - - Handles the touch delta event. - - The sender. - A instance containing the event data. - - - - Handles the touch completed event. - - The sender. - A instance containing the event data. - - - - Handles key down events. - - The sender. - The instance containing the event data. - - - - Raises the event. - - The sender. - The instance containing the event data. - - - - Raises the event. - - The sender. - The instance containing the event data. - - - - Raises the event. - - The sender. - The instance containing the event data. - - - - Raises the event. - - The sender. - The instance containing the event data. - - - - Raises the event. - - The sender. - The instance containing the event data. - - - - Raises the event. - - The sender. - The instance containing the event data. - - - - Raises the event. - - The sender. - The instance containing the event data. - - - - Raises the event. - - The sender. - The instance containing the event data. - - - - Raises the event. - - The sender. - The instance containing the event data. - - - - Represents a selection of items (by index) and features (by enumeration type). - - - - - Static instance representing everything (all items and all features) selected. - - - - - The selection (cannot use HashSet{T} in PCL) - - - - - Gets the everything selected. - - The everything. - - - - Determines whether everything is selected. - - true if everything is selected; otherwise, false. - - - - Gets the indices of the selected items in this selection. - - Enumerator of indices. - - - - Gets the selected items by the specified feature. - - The feature. - Enumerator of indices. - - - - Clears the selected items. - - - - - Determines whether the specified item and feature is selected. - - The index of the item. - The feature. - true if the item is selected; otherwise, false. - - - - Selects the specified item/feature. - - The index. - The feature. - - - - Unselects the specified item. - - The index of the item. - The feature. - - - - Represents an item in a . - - - - - The index - - - - - The feature - - - - - Initializes a new instance of the struct. - - The index. - The feature. - - - - Gets the index. - - The index. - - - - Gets the feature. - - The feature. - - - - Indicates whether the current object is equal to another object of the same type. - - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - - Returns a hash code for this instance. - - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - - Defines the mode of selection used by . - - - - - All the elements will be selected - - - - - A single element will be selected - - - - - Multiple elements can be selected - - - - - Implements support for decoding bmp images. - - - - - Gets information about the image in the specified byte array. - - The image data. - - An structure. - - - - - Decodes an image from the specified byte array. - - The image data. - - The 32-bit pixel data. - - - - - Implements support for encoding bmp images. - - - - - The options - - - - - Initializes a new instance of the class. - - The options. - - - - Encodes the specified image data to png. - - The pixel data (bottom line first). - The png image data. - - - - Encodes the specified 8-bit indexed pixels. - - The pixels. - The palette. - The image data. - - - - Writes the bitmap info header. - - The writer. - The width. - The height. - The number of bits per pixel. - The length of the pixel data. - The horizontal resolution (dpi). - The vertical resolution (dpi). - The number of colors. - - - - Writes the bitmap V4 header. - - The writer. - The width. - The height. - The number of bits per pixel. - The length. - The resolution. - The number of colors. - - - - Represents options for the . - - - - - Provides utilities for s. - - - - - Copies a range of the specified . - - The type of the array items. - The source array. - The start index. - The end index. - An containing the items from index to index . - - - - Copies the first items of the specified . - - The type of the array items. - The source array. - The number of items to copy. - An containing the items from index 0 to index . - - - - Fills the specified array with values in the specified range. - - The type of the array items. - The source array. - The start index. - The end index. - The value to fill. - - - - Implements a binary reader that can read bits. - - - - - Reads a byte from the stream. - - The byte. - - - - Reads a bit from the stream. - - Returns 0 or 1 if a bit is available, or throws an EOFException if the end of stream is reached. - - - - Closes this stream and the underlying InputStream. - - - - - Returns the current bit position, which is between 0 and 7 inclusive. The number of bits remaining in the current byte is 8 minus this number. - - The bit position. - - - - Discards the remainder of the current byte and reads the next byte from the stream. - - The byte. - - - - Reads the specified number of bits. - - The number of bits. - The bits. - Reading past EOF. - - - - The byte bit reader. - - - - - The input. - - - - - The bit position. - - Either in the range 0x00 to 0xFF, or -1 if the end of stream is reached - - - - The disposed flag. - - - - - The is end of stream. - - Always between 1 and 8, inclusive - - - - The next bits. - - Underlying byte stream to read from - - - - Initializes a new instance of the class. - - The arguments. - Argument is null - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Reads a bit from the stream. Returns 0 or 1 if a bit is available, or -1 if the end of stream is reached. The end of stream always occurs on a byte boundary. - - The . - - - - Reads a bit from the stream. Returns 0 or 1 if a bit is available, or throws an EOFException if the end of stream is reached. - - The . - - - - Gets the bit position. - - The . - - - - Discards the remainder of the current byte and reads the next byte from the stream. - - The . - - - - Closes this stream and the underlying InputStream. - - - - - Releases unmanaged and - optionally - managed resources - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - A canonical Huffman code. Immutable. Code length 0 means no code. - -

- The code is a c# port of the DEFLATE project by Nayuki Minase at github. - Original source code: CircularDictionary.java. -

-

- A canonical Huffman code only describes the code length of each symbol. The codes can be reconstructed from this information. In this implementation, symbols with lower code lengths, breaking ties by lower symbols, are assigned lexicographically lower codes. - Example: - Code lengths (canonical code): - Symbol A: 1 - Symbol B: 3 - Symbol C: 0 (no code) - Symbol D: 2 - Symbol E: 3 - Huffman codes (generated from canonical code): - Symbol A: 0 - Symbol B: 110 - Symbol C: None - Symbol D: 10 - Symbol E: 111 -

-
- - - The code lengths - - - - - Initializes a new instance of the class. - - The code lengths. - The constructor does not check that the array of code lengths results in a complete Huffman tree, being neither underfilled nor overfilled. - - - - Initializes a new instance of the class based on the given code tree. - - The tree. - The symbol limit. - - - - Gets the symbol limit. - - The limit. - - - - Gets the length of the code. - - The symbol. - The length. - Symbol out of range - - - - Converts the canonical code to a code tree. - - The code tree. - This canonical code does not represent a Huffman code tree - or - This canonical code does not represent a Huffman code tree - - - - Builds the code lengths. - - The node. - The depth. - Symbol has more than one code - or - Symbol exceeds symbol limit - or - Illegal node type - - - - Provides a circular dictionary. - - The code is a c# port of the DEFLATE project by Nayuki Minase at github. - Original source code: CircularDictionary.java. - - - - The data - - - - - The mask - - - - - The index - - - - - Initializes a new instance of the class. - - The size of the dictionary. - - - - Appends the specified byte. - - The byte. - - - - Copies the specified bytes to the output writer. - - The distance? - The length. - The writer. - - - - The code tree. - - The code is a c# port of Nayuki Minase's DEFLATE project at GitHub. - Original source code: CodeTree.java. - - - - Stores the code for each symbol, or null if the symbol has no code. - For example, if symbol 5 has code 10011, then codes.get(5) is the list [1, 0, 0, 1, 1]. - - - - - Initializes a new instance of the class. Every symbol in the tree 'root' must be strictly less than 'symbolLimit'. - - The root. - The symbol limit. - - - - Gets the root. - - - - - Gets the code for the specified symbol. - - The symbol. - A of codes. - - - - Returns a string showing all the codes in this tree. The format is subject to change. Useful for debugging. - - The . - - - - Appends the code of the specified node to the specified . - - The prefix. - The node. - The string builder. - Illegal node type - - - - Builds the code list. - - The node. - The prefix. - - - - Implements DEFLATE decompression. - - The code is a c# port of the DEFLATE project by Nayuki Minase at github. - Original source code: Decompressor.java. - - - - The fixed literal length code. - - - - - The fixed distance code. - - - - - The dictionary. - - - - - The input. - - - - - The output. - - - - - The output stream. - - - - - The disposed flag. - - - - - Initializes static members of the class. - - - - - Initializes a new instance of the class. - - The reader. - - - - Decompresses the data from the specified . - - The input. - An array of . - - - - Decompresses the data from the specified . - - The input. - An array of . - - - - Decompresses the specified data. - - The input. - An array of . - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - For handling dynamic Huffman codes. - - A sequence of items. - - - - Decompress an uncompressed block. - - - - - Decompresses a Huffman block. - - The litLen code. - The distance code. - - - - Decodes the specified symbol. - - The code. - The . - - - - Decodes the run length. - - The symbol. - The . - - - - Decodes distance. - - The symbol. - The . - - - - Releases unmanaged and - optionally - managed resources - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Reads the specified number of bits. - - The number of bits to read. - The . - - - - Represents an internal node. - - - - - Initializes a new instance of the class. - - The left child. - The right child. - - - - Gets the left child. - - - - - Gets the right child. - - - - - Represents a leaf. - - - - - Initializes a new instance of the class. - - The symbol. - Illegal symbol value;symbol - - - - Gets the symbol. - - The symbol. - - - - Defines the node abstract class. - - Package-private (internal) to prevent accidental sub-classing outside of this package - - - - Specifies functionality to decode an image. - - - - - Gets information about the image in the specified byte array. - - The image data. - An structure. - - - - Decodes an image from the specified byte array. - - The image data. - The 32-bit pixel data. The indexing is [x,y] where [0,0] is top-left. - - - - Specifies functionality to encode an image. - - - - - Encodes the specified pixels. - - The pixel data. The indexing is [x,y] where [0,0] is top-left. - The image data. - - - - Encodes the specified 8-bit indexed pixels. - - The indexed pixel data. The indexing is [x,y] where [0,0] is top-left. - The palette. - The image data. - - - - Provides an abstract base class for image encoder options. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the horizontal resolution (in dots per inch). - - The resolution. The default value is 96 dpi. - - - - Gets or sets the vertical resolution (in dots per inch). - - The resolution. The default value is 96 dpi. - - - - Defines the image format. - - - - - The image is a PNG image. - - - - - The image is a bitmap image. - - - - - The image is a JPEG image. - - - - - The image format is unknown. - - - - - Implements support for decoding jpeg images. - - - - - Defines the EXIF tags. - - - - - Gets information about the image in the specified byte array. - - The image data. - An structure. - Invalid SOI - or - Invalid APP0 marker - or - Invalid marker - or - Invalid Exif identifier - or - Invalid TIFF identifier - - - - Decodes an image from the specified stream. - - The data to decode. - The 32-bit pixel data. - - - - Represents an image. - - - - - The image data. - - - - - The pixels - - - - - Initializes a new instance of the class from the specified stream. - - A stream that provides the image data. - - - - Initializes a new instance of the class from a byte array. - - The image bytes. - - - - Gets the image format. - - The format. - - - - Gets the width of the image. - - The width. - - - - Gets the height of the image. - - The height. - - - - Gets the number of bits per pixel. - - The bits per pixel. - - - - Gets the horizontal resolution of the image. - - The resolution in dots per inch (dpi). - - - - Gets the vertical resolution of the image. - - The resolution in dots per inch (dpi). - - - - Creates an image from 8-bit indexed pixels. - - The pixels indexed as [x,y]. [0,0] is top-left. - The palette. - The image format. - The encoder options. - An - - - - Creates an image from 32-bit true-color pixels. - - The pixels indexed as [x,y]. [0,0] is top-left. - The image format. - The encoder options. - An - - - - Gets the image data. - - The image data as a byte array. - - - - Gets the pixels of the image. - - The pixels in an array [width,height]. [0,0] is top-left. - - - - Gets the for the specified format. - - The image format. - The . - - - - Gets the for the specified format. - - The image format. - The image encoder options. - The . - - - - Gets the image format. - - The image bytes. - The - - - - Gets the byte array from the specified stream. - - The stream. - A byte array. - - - - Updates the image information. - - - - - Provides information about an . - - - - - Gets or sets the width in pixels. - - The width. - - - - Gets or sets the height in pixels. - - The height. - - - - Gets or sets the bits per pixel. - - The bits per pixel. - - - - Gets or sets the horizontal resolution of the image. - - The resolution in dots per inch (dpi). - - - - Gets or sets the vertical resolution of the image. - - The resolution in dots per inch (dpi). - - - - Implements support for decoding png images. - - - - - Gets information about the image in the specified byte array. - - The image data. - An structure. - Wrong length of pHYs chunk. - - - - Decodes an image from the specified byte array. - - The image data. - The 32-bit pixel data, indexed as [x,y]. - - - - Deflates the specified bytes. - - The bytes. - The deflated bytes. - - - - Defines the color type - - - - - Gray scale - - - - - True color - - - - - Indexed color - - - - - Gray scale with alpha - - - - - True color with alpha - - - - - Defines the compression method. - - - - - DEFLATE compression - - - - - Defines the filter method. - - - - - No filter. - - - - - Sub filter - - - - - Up filter - - - - - Average filter - - - - - Paeth filter - - - - - Defines interlace methods (chapter 8.2) - - - - - The null method, pixels are extracted sequentially from left to right, and scan lines sequentially from top to bottom. - - - - - Adam7, defines seven distinct passes over the image. Each pass transmits a subset of the pixels in the reference image. - The pass in which each pixel is transmitted (numbered from 1 to 7) is defined by replicating a 8-by-8 pattern over the - entire image, starting at the upper left corner. - - - - - Implements support for encoding png images. - - - - - The CRC table - - - - - The options - - - - - Initializes static members of the class. - - - - - Initializes a new instance of the class. - - The options. - - - - Encodes the specified image data to png. - - The pixel data indexed as [x,y] (bottom line first). - The png image data. - - - - Encodes the specified 8-bit indexed pixels. - - The pixels. - The palette. - The image data. - - - - Calculates the Adler-32 check sum. - - The data. - The check sum. - - - - Creates the header data. - - The width. - The height. - The header. - - - - Creates the physical dimensions data. - - The horizontal resolution. - The vertical resolution. - The data. - - - - Creates the uncompressed blocks. - - The data. - The output data. - - - - Updates the CRC check sum. - - The input CRC. - The data. - The updated CRC. - - - - Writes the integer value with big endian byte order. - - The writer. - The value. - - - - Writes the unsigned integer value with big endian byte order. - - The writer. - The value. - - - - Writes a png chunk. - - The writer. - The chunk type. - The chunk data. - - - - Provides a binary writer that writes to memory. - - - - - Initializes a new instance of the class. - - - - - Gets the content as a byte array. - - The byte array. - - - - Represents options for the . - - - - - Provides an abstract base class for input device gestures. - - The input gesture can be bound to a command in a . - - - - Indicates whether the current object is equal to another object of the same type. - - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - - Represents a keyboard input gesture. - - The input gesture can be bound to a command in a . - - - - Initializes a new instance of the class. - - The key. - The modifier keys. - - - - Gets or sets the modifier keys. - - - - - Gets or sets the key. - - - - - Indicates whether the current object is equal to another object of the same type. - - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - - Represents a mouse down input gesture. - - The input gesture can be bound to a command in a . - - - - Initializes a new instance of the class. - - The mouse button. - The modifiers. - The click count. - - - - Gets the modifier keys. - - - - - Gets the mouse button. - - - - - Gets the click count. - - - - - Indicates whether the current object is equal to another object of the same type. - - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - - Represents a mouse enter gesture. - - The input gesture can be bound to a command in a . - - - - Initializes a new instance of the class. - - The modifiers. - - - - Gets the modifier keys. - - - - - Indicates whether the current object is equal to another object of the same type. - - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - - Represents a mouse wheel gesture. - - The input gesture can be bound to a command in a . - - - - Initializes a new instance of the class. - - The modifiers. - - - - Gets the modifier keys. - - - - - Indicates whether the current object is equal to another object of the same type. - - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - - Represents a shake input gesture. - - The input gesture can be bound to a command in a . The shake gesture applies primarily to mobile devices. - - - - Indicates whether the current object is equal to another object of the same type. - - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - - Represents a touch input gesture. - - The input gesture can be bound to a command in a . - - - - Indicates whether the current object is equal to another object of the same type. - - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - - Defines the possible key values on a keyboard. - - - - - The Space key. - - - - - The Enter key. - - - - - The Esc key. - - - - - The Tab key. - - - - - The Backspace key. - - - - - The Insert key. - - - - - The Delete key. - - - - - The Home key. - - - - - The End key. - - - - - The Up arrow key. - - - - - The Down arrow key. - - - - - The Left arrow key. - - - - - The Right arrow key. - - - - - The Page up key. - - - - - The Page down key. - - - - - The A key. - - - - - The B key. - - - - - The C key. - - - - - The D key. - - - - - The E key. - - - - - The F key. - - - - - The G key. - - - - - The H key. - - - - - The I key. - - - - - The J key. - - - - - The K key. - - - - - The L key. - - - - - The M key. - - - - - The N key. - - - - - The O key. - - - - - The P key. - - - - - The Q key. - - - - - The R key. - - - - - The S key. - - - - - The T key. - - - - - The U key. - - - - - The V key. - - - - - The W key. - - - - - The X key. - - - - - The Y key. - - - - - The Z key. - - - - - The 0 key. - - - - - The 1 key. - - - - - The 2 key. - - - - - The 3 key. - - - - - The 4 key. - - - - - The 5 key. - - - - - The 6 key. - - - - - The 7 key. - - - - - The 8 key. - - - - - The 9 key. - - - - - The 0 key on the numeric keypad. - - - - - The 1 key on the numeric keypad. - - - - - The 2 key on the numeric keypad. - - - - - The 3 key on the numeric keypad. - - - - - The 4 key on the numeric keypad. - - - - - The 5 key on the numeric keypad. - - - - - The 6 key on the numeric keypad. - - - - - The 7 key on the numeric keypad. - - - - - The 8 key on the numeric keypad. - - - - - The 9 key on the numeric keypad. - - - - - The add key. - - - - - The subtract key. - - - - - The multiply key. - - - - - The divide key. - - - - - The decimal key. - - - - - The F1 key. - - - - - The F2 key. - - - - - The F3 key. - - - - - The F4 key. - - - - - The F5 key. - - - - - The F6 key. - - - - - The F7 key. - - - - - The F8 key. - - - - - The F9 key. - - - - - The F10 key. - - - - - The F11 key. - - - - - The F12 key. - - - - - Unknown/not supported key. - - - - - Defines the set of modifier keys. - - - - - No modifiers are pressed. - - - - - The Control key. - - - - - The Alt/Menu key. - - - - - The Shift key. - - - - - The Windows key. - - - - - Defines values that specify the buttons on a mouse device. - - - - - No mouse button. - - - - - The left mouse button. - - - - - The middle mouse button. - - - - - The right mouse button. - - - - - The first extended mouse button. - - - - - The second extended mouse button. - - - - - Represents a Legend. - - - - - Initializes a new insance of the Legend class. - - - - - Override for legend hit test. - - Arguments passe to the hit test - The hit test results. - - - - Gets or sets the group name font. - - - - - Gets or sets the group name font size. - - - - - Gets or sets the group name font weight. - - - - - Gets or sets the textcolor of invisible series. - - - - - Checks if a screen point is within the legend boundaries. - - A screen point. - A value indicating whether the point is inside legend boundaries or not. - - - - Makes the LegendOrientation property safe. - - If Legend is positioned left or right, force it to vertical orientation - - - - Renders or measures the legends. - - The render context. - - - - Measures the legend area and gets the legend size. - - The rendering context. - The area available to legend. - - - - Gets the rectangle of the legend box. - - Size of the legend box. - A rectangle. - - - - Renders the legend for the specified series. - - The render context. - The series. - The position and size of the legend. - - - - Measures the legends. - - The render context. - The available size for the legend box. - The size of the legend box. - - - - Renders or measures the legends. - - The render context. - Provides the available size if measuring, otherwise it provides the position and size of the legend. - Specify if the size of the legend box should be measured only (not rendered). - The size of the legend box. - - - - Specifies the placement of the legend box. - - - - - Place the legends inside the plot area. - - - - - Place the legends outside the plot area. - - - - - Specifies the position of the legend box. - - - - - Place the legend box in the top-left corner. - - - - - Place the legend box centered at the top. - - - - - Place the legend box in the top-right corner. - - - - - Place the legend box in the bottom-left corner. - - - - - Place the legend box centered at the bottom. - - - - - Place the legend box in the bottom-right corner. - - - - - Place the legend box in the left-top corner. - - - - - Place the legend box centered at the left. - - - - - Place the legend box in the left-bottom corner. - - - - - Place the legend box in the right-top corner. - - - - - Place the legend box centered at the right. - - - - - Place the legend box in the right-bottom corner. - - - - - Specifies the orientation of the items in the legend box. - - - - - Orient the items horizontally. - - - - - Orient the items vertically. - - - - - Specifies the item order of the legends. - - - - - Render the items in the normal order. - - - - - Render the items in the reverse order. - - - - - Specifies the placement of the legend symbols. - - - - - Render symbols to the left of the labels. - - - - - Render symbols to the right of the labels. - - - - - The abstract Legend class. - - - - - Override for legend hit test. - - Arguments passe to the hit test - The hit test results. - - - - Defines the legend hit test behaviour. - - The hit test arguments. - The hit test result. - - - - Gets or sets a key to identify this legend. The default is null. - - The key is used to identify which series to show in the legends by comparing with the Series.LegendKey property. - - - - Gets or sets a value indicating whether the legend is visible. The titles of the series must be set to use the legend. - - - - - Gets or sets the legend orientation. - - The legend orientation. - Horizontal orientation is reverted to Vertical if Legend is positioned Left or Right of the plot. - - - - Gets or sets the legend padding. - - The legend padding. - - - - Gets or sets the length of the legend symbols (the default value is 16). - - - - - Gets or sets the legend symbol margins (distance between the symbol and the text). - - The legend symbol margin. - - - - Gets or sets the legend symbol placement. - - The legend symbol placement. - - - - Gets or sets the legend title. - - The legend title. - - - - Gets or sets the color of the legend title. - - The color of the legend title. - If this value is null, the TextColor will be used. - - - - Gets or sets the legend title font. - - The legend title font. - - - - Gets or sets the size of the legend title font. - - The size of the legend title font. - - - - Gets or sets the legend title font weight. - - The legend title font weight. - - - - Gets the legend area. - - The legend area. - - - - Gets or sets the size of the legend. - - - - - Gets or sets the background color of the legend. Use null for no background. - - The legend background. - - - - Gets or sets the border color of the legend. - - The legend border. - - - - Gets or sets the thickness of the legend border. Use 0 for no border. - - The legend border thickness. - - - - Gets or sets the spacing between columns of legend items (only for vertical orientation). - - The spacing in device independent units. - - - - Gets or sets the legend font. - - The legend font. - - - - Gets or sets the size of the legend font. - - The size of the legend font. - - - - Gets or sets the color of the legend text. - - The color of the legend text. - If this value is null, the TextColor will be used. - - - - Gets or sets the legend font weight. - - The legend font weight. - - - - Gets or sets the legend item alignment. - - The legend item alignment. - - - - Gets or sets the legend item order. - - The legend item order. - - - - Gets or sets the horizontal spacing between legend items when the orientation is horizontal. - - The horizontal distance between items in device independent units. - - - - Gets or sets the vertical spacing between legend items. - - The spacing in device independent units. - - - - Gets or sets the legend margin. - - The legend margin. - - - - Gets or sets the max width of the legend. - - The max width of the legend. - - - - Gets or sets the max height of the legend. - - The max height of the legend. - - - - Gets or sets the legend placement. - - The legend placement. - - - - Gets or sets the legend position. - - The legend position. - - - - Gets or sets a value indicating whether the legend should use the full extend of the plot when equals LegendPlacement.Outside. - - Whether the legends is allowed to use the full extent of the plot. - - - - Gets or sets a value indicating whether the legend should show invisible series. The default is true. - - Whether the legends should show invisible series. - Invisible series will appear in the listening, but will be grayed out. - - - - Makes the LegendOrientation property safe. - - If Legend is positioned left or right, force it to vertical orientation - - - - Measures the legend area and gets the legend size. - - The rendering context. - The area available to legend. - - - - Gets the rectangle of the legend box. - - Size of the legend box. - The legend area rectangle. - - - - Renders or measures the legends. - - The render context. - - - - Provides extension methods facilitating compatibility with .NET 4.0. - - - - - Returns a corresponding to the specified . - - The type of the list. - The list. - - On .NET4.0, this returns a wrapper around the which implements and . - On .NET4.5 and later, this directly returns the . - - - - - Returns a corresponding to the specified array. - - The type of the array. - The array. - - On .NET4.0, this returns a wrapper around the which implements and . - On .NET4.5 and later, this directly returns the . - - - - - Defines the page size. - - - - - ISO A4 size (595pt x 842pt). - - - - - ISO A3 size (842pt x 1190pt). - - - - - American letter size (612pt x 792pt). - - - - - Defines the page orientation. - - - - - Portrait orientation (where the height is greater than the width). - - - - - Landscape orientation (where the width is greater than the height). - - - - - Defines the line cap type. - - - - - Butt cap. The stroke is squared off at the endpoint of the path. There is no projection beyond the end of the path. - - - - - Round cap. A semicircular arc with a diameter equal to the line width is drawn around the endpoint and filled in. - - - - - Projecting square cap. The stroke continues beyond the endpoint of the path for a distance equal to half the line width and is squared off. - - - - - Defines the color space. - - - - - The colors are defined by intensities of red, green and blue light, the three additive primary colors used in displays. - - - - - Defines the font encoding. - - - - - Windows Code Page 1252, often called the “Windows ANSI” encoding. This is the standard Windows encoding for Latin text in - Western writing systems. PDF has a predefined encoding named WinAnsiEncoding that can be used with both Type 1 and TrueType fonts. - - - - - Defines the font subtype - - - - - Adobe type 1 font. - - - - - TrueType font. - - - - - Provides functionality to export plots to pdf. - - - - - Gets or sets the width (in points, 1/72 inch) of the output document. - - - - - Gets or sets the height (in points, 1/72 inch) of the output document. - - - - - Exports the specified model to a stream. - - The model. - The output stream. - The width (points). - The height (points). - - - - Exports the specified to the specified . - - The model. - The stream. - - - - Implements an producing PDF documents by . - - - - - The current document. - - - - - The image cache. - - - - - Initializes a new instance of the class. - - The width. - The height. - The background. - - - - Saves the output to the specified stream. - - The stream. - - - - Draws an ellipse. - - The rectangle. - The fill color. - The stroke color. - The thickness. - The edge rendering mode. This is not supported and will be ignored. - - - - Draws a polyline. - - The points. - The stroke color. - The stroke thickness. - The edge rendering mode. This is not supported and will be ignored. - The dash array. - The line join type. - - - - Draws a polygon. The polygon can have stroke and/or fill. - - The points. - The fill color. - The stroke color. - The stroke thickness. - The edge rendering mode. This is not supported and will be ignored. - The dash array. - The line join type. - - - - Draws a rectangle. - - The rectangle. - The fill color. - The stroke color. - The stroke thickness. - The edge rendering mode. This is not supported and will be ignored. - - - - Draws the text. - - The position of the text. - The text. - The fill color. - The font family. - Size of the font. - The font weight. - The rotation angle. - The horizontal alignment. - The vertical alignment. - The maximum size of the text. - - - - Measures the text. - - The text. - The font family. - Size of the font. - The font weight. - The text size. - - - - Draws the specified portion of the specified at the specified location and with the specified size. - - The source. - The x-coordinate of the upper-left corner of the portion of the source image to draw. - The y-coordinate of the upper-left corner of the portion of the source image to draw. - Width of the portion of the source image to draw. - Height of the portion of the source image to draw. - The x-coordinate of the upper-left corner of drawn image. - The y-coordinate of the upper-left corner of drawn image. - The width of the drawn image. - The height of the drawn image. - The opacity. - Interpolate if set to true. - - - - - - - - - - Converts the specified to a . - - The value to convert. - The converted value. - - - - Sets the width of the line. - - The thickness (in 1/96 inch units). - - - - Sets the line dash pattern. - - The dash array (in 1/96 inch units). - The dash phase (in 1/96 inch units). - - - - Provides a low-level PDF writer. - - - - - The output writer. - - - - - Initializes a new instance of the class. - - The s. - - - - Specifies the object type. - - - - - The Catalog type. - - - - - The Pages type. - - - - - The Page type. - - - - - The Font type. - - - - - The XObject type. - - - - - The ExtGState type. - - - - - The FontDescriptor type. - - - - - Specifies a document object. - - - - - Gets the object number. - - - - - Gets the position in the stream. - - - - - Writes a formatted string. - - The format string. - The arguments. - - - - Writes a formatted line. - - The format string. - The arguments. - - - - Writes a dictionary. - - The dictionary. - - - - Writes a byte array. - - The byte array. - - - - Writes an empty line. - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Writes an object. - - The object to write. - - - - Writes a list. - - The list. - - - - Represents a document that can be output to PDF. - - - - - The objects. - - - - - The stroke alpha cache. - - - - - The fill alpha cache. - - - - - The font cache. - - - - - The image cache. - - - - - The catalog object. - - - - - The pages object. - - - - - The metadata object. - - - - - The resources object. - - - - - The fonts dictionary. - - - - - The x objects dictionary. - - - - - The ext g state dictionary. - - - - - The page reference objects. - - - - - The current page contents - - - - - The current font - - - - - The current font size - - - - - Initializes a new instance of the class. - - - - - Gets the width of the current page. - - The width measured in points (1/72 inch). - - - - Gets the height of the current page. - - The height measured in points (1/72 inch). - - - - Sets the title property. - - - - - Sets the author property. - - - - - Sets the subject property. - - - - - Sets the keywords property. - - - - - Sets the creator property. - - - - - Sets the producer property. - - - - - Sets the current line width. - - The line width in points. - - - - Sets the line cap type. - - The cap type. - - - - Sets the line join type. - - The line join. - - - - Sets the miter limit. - - The limit. - - - - Sets the line dash pattern. - - The dash array specifies the lengths of alternating dashes and gaps; the numbers must be nonnegative and not all zero. - The dash phase specifies the distance into dash pattern at which to start the dash. - Before beginning to stroke a path, the dash array is cycled through, adding up the lengths of - dashes and gaps. When the accumulated length equals the value specified by the dash phase, stroking - of the path begins, and the dash array is used cyclically from that point onward. - Table 4.6 shows examples of line dash patterns. As can be seen from the table, an empty dash array - and zero phase can be used to restore the dash pattern to a solid line. - - - - Resets the line dash pattern. - - - - - Moves to the specified coordinate. - - The x1. - The y1. - Begin a new subpath by moving the current point to coordinates (x, y), omitting any connecting line segment. - If the previous path construction operator in the current path was also m, the new m overrides it; - no vestige of the previous m operation remains in the path. - - - - Appends a straight line segment to the current path. - - The x1. - The y1. - Append a straight line segment from the current point to the point (x, y). The new current point is (x, y). - - - - Appends a cubic Bézier curve to the current path. - - The x1. - The y1. - The x2. - The y2. - The x3. - The y3. - The curve extends from the current point to the point (x3 , y3 ), using (x1 , y1 ) and (x2 , y2 ) - as the Bézier control points (see “Cubic Bézier Curves,” below). The new current point is (x3 , y3 ). - - - - Saves the current graphics state. - - - - - Restores the graphics state. - - - - - Translates the current transformation matrix. - - The x-translation. - The y-translation. - - - - Scales the current transformation matrix. - - The x-scale. - The y-scale. - - - - Modifies the current transformation matrix (CTM). - - The a. - The b. - The c. - The d. - The e. - The f. - Modify the current transformation matrix (CTM) by concatenating the specified matrix - (see Section 4.2.1, “Coordinate Spaces”). Although the operands specify a matrix, they - are written as six separate numbers, not as an array. - - - - Sets the vertical text scaling. - - A number specifying the percentage of the normal height. - - - - Rotates by the specified angle around the specified point. - - The x-coordinate of the rotation centre. - The y-coordinate of the rotation centre. - The rotation angle in degrees. - - - - Rotates by the specified angle. - - The rotation angle in degrees. - - - - Sets the stroke alpha. - - The alpha value [0,1]. - - - - Sets the fill alpha. - - The alpha value [0,1]. - - - - Strokes the path. - - Closes the path if set to true. - - - - Fills the path. - - Use the even-odd fill rule if set to true. Use the nonzero winding number rule if set to false. - - - - Fills and strokes the path. - - Closes the path if set to true. - Use the even-odd fill rule if set to true. Use the nonzero winding number rule if set to false. - - - - Sets the clipping path. - - Use the even-odd fill rule if set to true. Use the nonzero winding number rule if set to false. - - - - Ends the path. - - End the path object without filling or stroking it. This operator is a path-painting no-op, - used primarily for the side effect of changing the current clipping path (see Section 4.4.3, “Clipping Path Operators”). - - - - Closes the subpath. - - Close the current subpath by appending a straight line segment from the current point - to the starting point of the subpath. If the current subpath is already closed, h does nothing. - This operator terminates the current subpath. Appending another segment to the current - path begins a new subpath, even if the new segment begins at the endpoint reached by the h operation. - - - - Appends a rectangle to the current path. - - The x-coordinate of the lower-left corner. - The y-coordinate of the lower-left corner. - The width. - The height. - Append a rectangle to the current path as a complete subpath, - with lower-left corner (x, y) and dimensions width and height in user space. - - - - Draws a line connecting the two points specified by the coordinate pairs. - - The x-coordinate of the first point. - The y-coordinate of the first point. - The x-coordinate of the second point. - The y-coordinate of the second point. - - - - Draws a rectangle. - - The x-coordinate of the lower-left corner. - The y-coordinate of the lower-left corner. - The width. - The height. - Fill the rectangle if set to true. - - - - Sets the clipping rectangle. - - The x-coordinate of the lower-left corner. - The y-coordinate of the lower-left corner. - The width. - The height. - Use the even-odd region rule if set to true. - - - - Fills a rectangle. - - The x-coordinate of the lower-left corner. - The y-coordinate of the lower-left corner. - The width. - The height. - - - - Draws a circle. - - The x-coordinate of the center. - The y-coordinate of the center. - The radius. - Fill the circle if set to true. - - - - Fills a circle. - - The x-coordinate of the center. - The y-coordinate of the center. - The radius. - - - - Draws an ellipse. - - The x-coordinate of the lower-left corner. - The y-coordinate of the lower-left corner. - The width. - The height. - Fill the ellipse if set to true. - - - - Fills an ellipse. - - The x-coordinate of the lower-left corner. - The y-coordinate of the lower-left corner. - The width. - The height. - - - - Appends an ellipse to the current path. - - The x-coordinate of the lower-left corner. - The y-coordinate of the lower-left corner. - The width. - The height. - - - - Sets the current font. - - The font name. - The font size in points. - Use bold font weight if set to true. - Use italic style if set to true. - - - - Draws the text at the specified coordinate. - - The left x-coordinate. - The bottom (!) y-coordinate. - The text. - - - - Measures the size of the specified text. - - The text. - The width. - The height. - - - - Draws an image. - - The image to draw. - - - - Sets the color in Device RGB color space. - - The red value. - The green value. - The blue value. - - - - Sets the color in CMYK color space. - - The cyan value. - The magenta value. - The yellow value. - The black value. - - - - Sets the fill color in Device RGB color space. - - The red value. - The green value. - The blue value. - - - - Adds a page. - - The page size. - The page orientation. - - - - Adds a page specified by width and height. - - The page width in points. - The page height in points. - - - - Saves the document to the specified stream. - - The output stream. - - - - Encodes the specified string. - - The text to encode. - The target encoding. - The encoded text - - - - Escapes the specified string. - - The text. - The encoded string. - - - - Encodes binary bits into a plaintext ASCII85 format string - - binary bits to encode - ASCII85 encoded string - - - - Gets the font. - - Name of the font. - Use bold if set to true. - Use italic if set to true. - The font. - - - - Gets a cached value. - - The type of the key. - The type of the value. - The key. - The cache dictionary. - The create value function. - The cached or created value. - - - - Adds an object to the document. - - The added object. - - - - Adds an object of the specified type. - - The object type. - The added object. - - - - Adds an ExtGState object. - - The key. - The value. - The added object. - - - - Adds an image. - - The image. - The added object. - - - - Adds a font. - - The font. - The added object. - - - - Appends a line to the current page contents. - - The format string. - The arguments. - Cannot add content before a page has been added. - - - - Appends text to the current page contents. - - The format string. - The arguments. - Cannot add content before a page has been added. - - - - Represents an object in the . - - The object contains a dictionary and text content. - - - - The dictionary - - - - - The object number - - - - - The contents - - - - - Initializes a new instance of the class. - - The object number. - - - - Gets the object number. - - The object number. - - - - Sets the dictionary value for the specified key. - - The . - The key. - The object. - - - - Appends text to the content of the object. - - The format string. - The arguments. - - - - Appends a line to the content of the object. - - The format string. - The arguments. - - - - Writes the object to the specified . - - The writer. - - - - Provides OxyPlot extension methods for . - - - - - Sets the stroke color. - - The document. - The color. - - - - Sets the fill color. - - The document. - The color. - - - - Represents a font that can be used in a . - - - - - Initializes a new instance of the class. - - - - - Gets or sets the font subtype. - - - - - Gets or sets the base font. - - - - - Gets or sets the encoding. - - - - - Gets or sets the first character in the Widths array. - - - - - Gets or sets the character Widths array. - - - - - Gets or sets the font ascent. - - - - - Gets or sets the font cap height. - - - - - Gets or sets the font descent. - - - - - Gets or sets the font flags. - - - - - Gets or sets the font bounding box. - - - - - Gets or sets the italic angle. - - - - - Gets or sets the stem v. - - - - - Gets or sets the x height. - - - - - Gets or sets the font name. - - - - - Measures the specified text. - - The text. - The font size - The width of the text. - The height of the text. - - - - Represents a font family that can be used in a . - - - - - Gets or sets the regular font. - - - - - Gets or sets the bold font. - - - - - Gets or sets the italic font. - - - - - Gets or sets the bold and italic font. - - - - - Gets the font with the specified weight and style. - - bold font weight. - italic/oblique font style. - The font. - - - - Represents an image that can be included in a . - - - - - Initializes a new instance of the class. - - The width. - The height. - The number of bits per component. - The bits. - The bits of the mask. - Interpolate if set to true. - The color space. - - - - Gets the width. - - The width. - - - - Gets the height. - - The height. - - - - Gets the bits per component. - - The bits per component. - - - - Gets the color space. - - The color space. - - - - Gets the bits. - - The bits. - - - - Gets the mask bits. - - The mask bits. - - - - Gets a value indicating whether the image is interpolated. - - true if interpolated; otherwise, false. - - - - Provides utility methods related to . - - - - - Converts the specified to a . - - The source image. - interpolate if set to true. - The converted image. - - - - Defines the standard fonts that can be used in a . - - - - - Initializes static members of the class. - - - - - Gets the Arial font family. - - - - - Gets the Times font family. - - - - - Gets the Courier font family. - - - - - Provides a controller command for the implemented by a delegate. - - The type of the event arguments. - - - - Initializes a new instance of the class. - - The handler. - - - - Provides an abstract base class for classes that contain event data for input events. - - - - - Gets or sets a value indicating whether the event was handled. - - - - - Gets or sets the modifier keys. - - - - - Gets a value indicating whether the alt key was pressed when the event was raised. - - - - - Gets a value indicating whether the control key was pressed when the event was raised. - - - - - Gets a value indicating whether the shift key was pressed when the event was raised. - - - - - Provides data for key events. - - - - - Gets or sets the key. - - - - - Provides data for the mouse down events. - - - - - Gets or sets the mouse button that has changed. - - - - - Gets or sets the number of times the button was clicked. - - The number of times the mouse button was clicked. - - - - Gets or sets the hit test result. - - - - - Provides data for the mouse events. - - - - - Gets or sets the position of the mouse cursor. - - - - - Provides data for mouse wheel events. - - - - - Gets or sets the change. - - - - - Provides data for touch events. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The current touches. - The previous touches. - - - - Gets or sets the position of the touch. - - The position. - - - - Gets or sets the relative change in scale. - - The scale change. - - - - Gets or sets the change in x and y direction. - - The translation. - - - - Specifies functionality to interact with a plot view. - - - - - Specifies which axis a manipulator will prefer to operate on. - - - - - Manipulation will not prefer a particular axis. - - - - - Manipulation will prefer to operate on the X axis. - - - - - Manipulation will prefer to operate on the Y axis. - - - - - Provides an abstract base class for manipulators that handles mouse events. - - - - - Initializes a new instance of the class. - - The plot view. - - - - Gets or sets the first position of the manipulation. - - - - - Occurs when an input device begins a manipulation on the plot. - - The instance containing the event data. - - - - Provides a manipulator for panning functionality. - - - - - Initializes a new instance of the class. - - The plot view. - - - - Gets or sets the previous position. - - - - - Gets or sets a value indicating whether panning is enabled. - - - - - Occurs when a manipulation is complete. - - The instance containing the event data. - - - - Occurs when the input device changes position during a manipulation. - - The instance containing the event data. - - - - Occurs when an input device begins a manipulation on the plot. - - The instance containing the event data. - - - - Provides an abstract base class for plot manipulators. - - The type of the event arguments. - - - - Initializes a new instance of the class. - - The plot view. - - - - Gets the plot view where the event was raised. - - The plot view. - - - - Gets or sets the axis that the manipulator will prefer to operate on. The default is - . - - The axis preference. - - - - Gets or sets the X axis. - - The X axis. - - - - Gets or sets the Y axis. - - The Y axis. - - - - Transforms a point from screen coordinates to data coordinates. - - The x coordinate. - The y coordinate. - A data point. - - - - Assigns the axes to this manipulator by the specified position. - - The position. - - - - Provides a manipulator for panning and scaling by touch events. - - - - - Initializes a new instance of the class. - - The plot view. - - - - Gets or sets a value indicating whether e.Handled should be set to true - in case pan or zoom is enabled. - - - - - Gets or sets a value indicating whether panning is enabled. - - - - - Gets or sets a value indicating whether zooming is enabled. - - - - - Occurs when a manipulation is complete. - - The instance containing the event data. - - - - Occurs when a touch delta event is handled. - - The instance containing the event data. - - - - Occurs when an input device begins a manipulation on the plot. - - The instance containing the event data. - - - - Provides a plot manipulator for tracker functionality. - - - - - The current series. - - - - - Initializes a new instance of the class. - - The plot view. - - - - Gets or sets a value indicating whether to show tracker on points only (not interpolating). - - - - - Gets or sets a value indicating whether to snap to the nearest point. - - - - - Gets or sets a value indicating whether to lock the tracker to the initial series. - - true if the tracker should be locked; otherwise, false. - - - - Gets or sets the distance from the series at which the tracker fires. - - - - - Gets or sets a value indicating whether to check distance when showing tracker between data points. - - This parameter is ignored if is equal to False. - - - - Occurs when a manipulation is complete. - - The instance containing the event data. - - - - Occurs when a touch delta event is handled. - - The instance containing the event data. - - - - Occurs when an input device begins a manipulation on the plot. - - The instance containing the event data. - - - - Updates the tracker to the specified position. - - The position. - - - - Provides data for a tracker hit result. - - This is used as DataContext for the TrackerControl. - The TrackerControl is visible when the user use the left mouse button to "track" points on the series. - - - - Gets or sets the nearest or interpolated data point. - - - - - Gets or sets the source item of the point. - If the current point is from an ItemsSource and is not interpolated, this property will contain the item. - - - - - Gets or sets the index for the Item. - - - - - Gets or sets the horizontal/vertical line extents. - - - - - Gets or sets the plot model. - - - - - Gets or sets the position in screen coordinates. - - - - - Gets or sets the series that is being tracked. - - - - - Gets or sets the text shown in the tracker. - - - - - Gets the X axis. - - - - - Gets the Y axis. - - - - - Returns a that represents this instance. - - A that represents this instance. - - - - Provides a plot manipulator for tracker functionality. - - - - - The current series. - - - - - Initializes a new instance of the class. - - The plot view. - - - - Gets or sets a value indicating whether to show tracker on points only (not interpolating). - - - - - Gets or sets a value indicating whether to snap to the nearest point. - - - - - Gets or sets a value indicating whether to lock the tracker to the initial series. - - true if the tracker should be locked; otherwise, false. - - - - Gets or sets the distance from the series at which the tracker fires. - - - - - Gets or sets a value indicating whether to check distance when showing tracker between data points. - - This parameter is ignored if is equal to False. - - - - Occurs when a manipulation is complete. - - The instance containing the event data. - - - - Occurs when the input device changes position during a manipulation. - - The instance containing the event data. - - - - Occurs when an input device begins a manipulation on the plot. - - The instance containing the event data. - - - - Provides a manipulator for rectangle zooming functionality. - - - - - The zoom rectangle. - - - - - Initializes a new instance of the class. - - The plot view. - - - - Gets or sets a value indicating whether zooming is enabled. - - - - - Occurs when a manipulation is complete. - - The instance containing the event data. - - - - Occurs when the input device changes position during a manipulation. - - The instance containing the event data. - - - - Occurs when an input device begins a manipulation on the plot. - - The instance containing the event data. - - - - Gets the cursor for the manipulation. - - The cursor. - - - - Provides a plot view manipulator for stepwise zoom functionality. - - - - - Initializes a new instance of the class. - - The plot view. - - - - Gets or sets a value indicating whether FineControl. - - - - - Gets or sets Step. - - - - - Occurs when an input device begins a manipulation on the plot. - - The instance containing the event data. - - - - Defines common commands for the plots. - - - - - Initializes static members of the class. - - - - - Gets the reset axes command. - - - - - Gets the reset axes command (for mouse events). - - - - - Gets the copy code command. - - - - - Gets the pan/zoom touch command. - - - - - Gets the pan command. - - - - - Gets the zoom rectangle command. - - - - - Gets the zoom by mouse wheel command. - - - - - Gets the fine-control zoom by mouse wheel command. - - - - - Gets the tracker command. - - - - - Gets the snap tracker command. - - - - - Gets the snap tracker command. - - - - - Gets the points only tracker command. - - - - - Gets the points only tracker command. - - - - - Gets the mouse hover tracker. - - - - - Gets the mouse hover snap tracker. - - - - - Gets the mouse hover points only tracker. - - - - - Gets the pan left command. - - - - - Gets the pan right command. - - - - - Gets the pan up command. - - - - - Gets the pan down command. - - - - - Gets the fine control pan left command. - - - - - Gets the fine control pan right command. - - - - - Gets the fine control pan up command. - - - - - Gets the fine control pan down command. - - - - - Gets the zoom in command. - - - - - Gets the zoom out command. - - - - - Gets the zoom in command. - - - - - Gets the zoom out command. - - - - - Gets the fine control zoom in command. - - - - - Gets the fine control zoom out command. - - - - - Handles the reset event. - - The view to reset. - The instance containing the event data. - - - - Handles the copy code event. - - The view. - The instance containing the event data. - - - - Zooms the view by the specified factor at the position specified in the . - - The view. - The instance containing the event data. - The zoom factor. - - - - Zooms the view by the mouse wheel delta in the specified . - - The view. - The instance containing the event data. - The zoom speed factor. Default value is 1. - - - - Zooms the view by the key in the specified factor. - - The view. - The instance containing the event data. - The zoom factor (positive zoom in, negative zoom out). - - - - Pans the view by the key in the specified vector. - - The view. - The instance containing the event data. - The horizontal delta (percentage of plot area width). - The vertical delta (percentage of plot area height). - - - - Provides an with a default set of plot bindings. - - - - - Initializes a new instance of the class. - - - - - Specifies functionality for an element of a plot. - - - - - Returns a hash code for this element. - - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - This method creates the hash code by reflecting the value of all public properties. - - - - Gets the clipping rectangle. - - The clipping rectangle. - - - - Specifies functionality for the plot model. - - - - - Gets the color of the background of the plot. - - The color. - If the background color is set to or is otherwise invisible then the background will be determined by the plot view or exporter. - - - - Updates the model. - - if set to true , all data collections will be updated. - - - - Renders the plot with the specified rendering context within the given rectangle. - - The rendering context. - The plot bounds. - - - - Attaches this model to the specified plot view. - - The plot view. - Only one plot view can be attached to the plot model. - The plot model contains data (e.g. axis scaling) that is only relevant to the current plot view. - - - - The TransposablePlotElement interface. - - - - - Defines a plot element that uses an X and a Y axis. - - - - - Gets the X axis. - - - - - Gets the Y axis. - - - - - Transforms the specified data point to a screen point by the axes of the plot element. - - The data point. - A screen point. - - - - Transforms from a screen point to a data point by the axes of this series. - - The screen point. - A data point. - - - - Provides an abstract base class for elements of a . - - - - - Initializes a new instance of the class. - - - - - Gets or sets the font. The default is null (use . - - The font. - If the value is null, the DefaultFont of the parent PlotModel will be used. - - - - Gets or sets the size of the font. The default is double.NaN (use ). - - The size of the font. - If the value is NaN, the DefaultFontSize of the parent PlotModel will be used. - - - - Gets or sets the font weight. The default is FontWeights.Normal. - - The font weight. - - - - Gets the parent . - - - - - Gets or sets an arbitrary object value that can be used to store custom information about this plot element. The default is null. - - The intended value. - This property is analogous to Tag properties in other Microsoft programming models. Tag is intended to provide a pre-existing property location where you can store some basic custom information about any PlotElement without requiring you to subclass an element. - - - - Gets or sets the color of the text. The default is OxyColors.Automatic (use ). - - The color of the text. - If the value is OxyColors.Automatic, the TextColor of the parent PlotModel will be used. - - - - Gets or sets the edge rendering mode that is used for rendering the plot element. - - The edge rendering mode. The default is . - - - - Gets or sets the tool tip. The default is null. - - - The tool tip string. - - - - - Gets the actual font. - - - - - Gets the actual size of the font. - - The actual size of the font. - - - - Gets the actual font weight. - - - - - Gets the actual color of the text. - - The actual color of the text. - - - - Gets the actual culture. - - The culture is defined in the parent PlotModel. - - - - - - - Returns a hash code for this element. - - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - This method creates the hash code by reflecting the value of all public properties. - - - - The transposable plot element extensions. - - - - - Transforms from a screen point to a data point by the axes of this series. - - The . - The x coordinate of the screen point. - The y coordinate of the screen point. - A data point. - - - - Checks if the series is transposed. - - True if the series is transposed, False otherwise. - The . - - - - Transposes the ScreenPoint if the series is transposed. - - The . - The to orientate. - The oriented point. - - - - Transposes the ScreenVector if the series is transposed. Reverses the respective direction if X or Y axis are reversed. - - The . - The to orientate. - The oriented vector. - - - - Orientates a HorizontalAlignment and a VerticalAlignment according to whether the Series is transposed or the Axes are reversed. - - The . - The to orientate. - The to orientate. - - - - Transforms the specified data point to a screen point by the axes of this series. - - The . - The x coordinate of the data point. - The y coordinate of the data point. - A screen point. - - - - Provides utility functions for plot elements. - - - - - Gets the clipping rectangle defined by the Axis the uses. - - The . - The clipping rectangle. - - - - Transforms from a screen point to a data point by the axes of this series. - - The . - The screen point. - A data point. - - - - Transforms from a screen point to a data point by the axes of this series while being aware of the orientation. - - The . - The screen point. - A data point. - - - - Transforms the specified coordinates to a screen point by the axes of the plot element. - - The plot element. - The data point. - A screen point. - - - - Transforms the specified coordinates to a screen point by the axes of the plot element while being aware of the orientation. - - The plot element. - The data point. - A screen point. - - - - Specifies the coordinate system type. - - - - - XY coordinate system - two perpendicular axes - - - - - Cartesian coordinate system - perpendicular axes with the same scaling. - - See http://en.wikipedia.org/wiki/Cartesian_coordinate_system - - - - Polar coordinate system - with radial and angular axes - - See http://en.wikipedia.org/wiki/Polar_coordinate_system - - - - Specifies the horizontal alignment of the titles. - - - - - Centered within the plot area. - - - - - Centered within the client view (excluding padding defined in ). - - - - - Represents a plot. - - - Represents a plot. - - - - - The bar series managers. - - - - - The plot view that renders this plot. - - - - - The current color index. - - - - - Flags if the data has been updated. - - - - - The last update exception. - - The exception or null if there was no exceptions during the last update. - - - - Initializes a new instance of the class. - - - - - Occurs when the tracker has been changed. - - - - - Occurs when the plot has been updated. - - - - - Occurs when the plot is about to be updated. - - - - - Gets or sets the default font. - - The default font. - This font is used for text on axes, series, legends and plot titles unless other fonts are specified. - - - - Gets or sets the default size of the fonts. - - The default size of the font. - - - - Gets the actual culture. - - - - - Gets the actual plot margins. - - The actual plot margins. - - - - Gets the plot view that renders this plot. - - The plot view. - Only one view can render the plot at the same time. - - - - Gets the annotations. - - The annotations. - - - - Gets the axes. - - The axes. - - - - Gets or sets the legends. - - The legends. - - - - Gets or sets the color of the background of the plot. - - The color. The default is . - If the background color is set to or is otherwise invisible then the background will be determined by the plot view or exporter. - - - - Gets or sets the culture. - - The culture. - - - - Gets or sets the default colors. - - The default colors. - - - - Gets or sets the edge rendering mode that is used for rendering the plot bounds and backgrounds. - - The edge rendering mode. The default is . - - - - Gets or sets a value indicating whether invisible series should be assigned automatic colors. - - - - - Gets or sets a value indicating whether the legend is visible. The titles of the series must be set to use the legend. - - - - - Gets or sets the padding around the plot. - - The padding. - - - - Gets the PlotBounds of the plot (in device units). - - - - - Gets the total width of the plot (in device units). - - - - - Gets the total height of the plot (in device units). - - - - - Gets the area including both the plot and the axes. Outside legends are rendered outside this rectangle. - - The plot and axis area. - - - - Gets the plot area. This area is used to draw the series (not including axes or legends). - - The plot area. - - - - Gets or sets the distance between two neighborhood tiers of the same AxisPosition. - - - - - Gets or sets the color of the background of the plot area. - - - - - Gets or sets the color of the border around the plot area. - - The color of the box. - - - - Gets or sets the thickness of the border around the plot area. - - The box thickness. - - - - Gets or sets the margins around the plot (this should be large enough to fit the axes). - If any of the values is set to double.NaN, the margin is adjusted to the value required by the axes. - - - - - Gets or sets the type of the coordinate system. - - The type of the plot. - - - - Gets the series. - - The series. - - - - Gets or sets the rendering decorator. - - - The rendering decorator. - - - - - Gets or sets the subtitle. - - The subtitle. - - - - Gets or sets the subtitle font. If this property is null, the Title font will be used. - - The subtitle font. - - - - Gets or sets the size of the subtitle font. - - The size of the subtitle font. - - - - Gets or sets the subtitle font weight. - - The subtitle font weight. - - - - Gets or sets the default color of the text in the plot (titles, legends, annotations, axes). - - The color of the text. - - - - Gets or sets the title. - - The title. - - - - Gets or sets the title tool tip. - - The title tool tip. - - - - Gets or sets the color of the title. - - The color of the title. - If the value is null, the TextColor will be used. - - - - Gets or sets a value indicating whether to clip the title. The default value is true. - - - - - Gets or sets the length of the title clipping rectangle (fraction of the available length of the title area). The default value is 0.9. - - - - - Gets or sets the color of the subtitle. - - The color of the subtitle. - - - - Gets or sets the horizontal alignment of the title and subtitle. - - - The alignment. - - - - - Gets the title area. - - The title area. - - - - Gets or sets the title font. - - The title font. - - - - Gets or sets the size of the title font. - - The size of the title font. - - - - Gets or sets the title font weight. - - The title font weight. - - - - Gets or sets the padding around the title. - - The title padding. - - - - Gets the default angle axis. - - The default angle axis. - - - - Gets the default magnitude axis. - - The default magnitude axis. - - - - Gets the default X axis. - - The default X axis. - - - - Gets the default Y axis. - - The default Y axis. - - - - Gets the default color axis. - - The default color axis. - - - - Gets the actual title font. - - - - - Gets the actual subtitle font. - - - - - Attaches this model to the specified plot view. - - The plot view. - Only one plot view can be attached to the plot model. - The plot model contains data (e.g. axis scaling) that is only relevant to the current plot view. - - - - Invalidates the plot. - - Updates all data sources if set to true. - - - - Gets the first axes that covers the area of the specified point. - - The point. - The x-axis. - The y-axis. - - - - Gets the default color from the DefaultColors palette. - - The next default color. - - - - Gets the default line style. - - The next default line style. - - - - Gets a series from the specified point. - - The point. - The limit. - The nearest series. - - - - Generates C# code of the model. - - C# code. - - - - Returns a that represents this instance. - - A that represents this instance. - - - - Gets the legend for the specified key. - - The legend key. - The legend that corresponds with the key. - Cannot find legend with the specified key. - - - - Gets any exception thrown during the last call. - - The exception or null if there was no exception. - - - - Updates all axes and series. - 0. Updates the owner PlotModel of all plot items (axes, series and annotations) - 1. Updates the data of each Series (only if updateData==true). - 2. Ensure that all series have axes assigned. - 3. Updates the max and min of the axes. - - if set to true , all data collections will be updated. - - - - Gets the axis for the specified key. - - The axis key. - The axis that corresponds with the key. - Cannot find axis with the specified key. - - - - Gets the axis for the specified key, or returns a default value. - - The axis key. - The default axis. - defaultAxis if key is empty or does not exist; otherwise, the axis that corresponds with the key. - - - - Resets all axes in the model. - - - - - Pans all axes. - - The horizontal distance to pan (screen coordinates). - The vertical distance to pan (screen coordinates). - - - - Zooms all axes. - - The zoom factor. - - - - Raises the TrackerChanged event. - - The result. - - This method is public so custom implementations of tracker manipulators can invoke this method. - - - - - Raises the TrackerChanged event. - - The result. - - - - Gets all elements of the model, top-level elements first. - - - An enumerator of the elements. - - - - - Raises the Updated event. - - - - - Raises the Updating event. - - - - - Updates the axis transforms. - - - - - Enforces the same scale on all axes. - - - - - Updates the intervals (major and minor step values). - - - - - Finds and sets the default horizontal and vertical axes (the first horizontal/vertical axes in the Axes collection). - - - - - Resets the default color index. - - - - - Updates maximum and minimum values of the axes from values of all data series. - - if set to true , the data has been updated. - - - - Updates the bar series managers. - - - - - Renders the plot with the specified rendering context within the given rectangle. - - The rendering context. - The plot bounds. - - - - Renders the plot with the specified rendering context. - - The rendering context. - The plot bounds. - - - - Renders the specified error message. - - The rendering context. - The title. - The error message. - The font size. The default value is 12. - - - - Adjusts the plot margins. - - The render context. - true if the margins were adjusted. - - - - Adjust the positions of parallel axes, returns total size - - The parallel axes. - The maximum value of the position tier?? - - - - Measures the size of the title and subtitle. - - The rendering context. - Size of the titles. - - - - Renders the annotations. - - The render context. - The layer. - - - - Renders the axes. - - The render context. - The layer. - - - - Renders the series backgrounds. - - The render context. - - - - Renders the border around the plot area. - - The render context. - The border will only by rendered if there are axes in the plot. - - - - Renders the series. - - The render context. - - - - Renders the title and subtitle. - - The render context. - - - - Calculates the plot area (subtract padding, title size and outside legends) - - The rendering context. - - - - Provides data for the tracker event. - - - - - Gets or sets the hit result. - - The hit result. - - - - Specifies functionality for the plot views. - - - - - Gets the actual of the control. - - - - - Hides the tracker. - - - - - Invalidates the plot (not blocking the UI thread) - - if set to true, all data bindings will be updated. - - - - Shows the tracker. - - The tracker data. - - - - Stores text on the clipboard. - - The text. - - - - Defines standard font weight values. - - - - - Specifies a bold font weight. - - - - - Specifies a normal font weight. - - - - - Defines horizontal alignment. - - - - - Aligned to the left. - - - - - Aligned in the center. - - - - - Aligned to the right. - - - - - Defines an interpolation algorithm. - - - - - Creates a spline from data points. - - Data points. - True if the spline is closed. - The tolerance. - Spline. - - - - Creates a spline from points in screen space. - - Resampled points. - True if the spline is closed. - The tolerance. - Spline. - - - - Implements a set of predefined interpolation algorithms. - - - - - Canonical spline, also known as Cardinal spline. - - - - - Centripetal Catmull–Rom spline. - - - - - Uniform Catmull–Rom spline. - - - - - Chordal Catmull–Rom spline. - - - - - Defines how to join line segments. - - - - - Line joins use regular angular vertices. - - - - - Line joins use rounded vertices. - - - - - Line joins use beveled vertices. - - - - - Defines the style of a line. - - - - - The solid line style. - - - - - The dash line style. - - - - - The dot line style. - - - - - The dash dot line style. - - - - - The dash dash dot line style. - - - - - The dash dot dot line style. - - - - - The dash dash dot dot line style. - - - - - The long dash line style. - - - - - The long dash dot line style. - - - - - The long dash dot dot line style. - - - - - The hidden line style. - - - - - The automatic line style. - - - - - Provides functionality to convert from to a stroke dash array. - - - - - Gets the stroke dash array for a given . - - The line style. - A dash array. - - - - Describes a color in terms of alpha, red, green, and blue channels. - - - - - The red component. - - - - - The green component. - - - - - The blue component. - - - - - The alpha component. - - - - - Initializes a new instance of the struct. - - The alpha value. - The red value. - The green value. - The blue value. - - - - Gets the alpha value. - - The alpha value. - - - - Gets the blue value. - - The blue value. - - - - Gets the green value. - - The green value. - - - - Gets the red value. - - The red value. - - - - Parse a string. - - The string in the format "#FFFFFF00" or "255,200,180,50". - The parsed color. - Invalid format. - - - - Calculates the difference between two s - - The first color. - The second color. - L2-norm in ARGB space - - - - Convert an to a . - - The unsigned integer color value. - The . - - - - Creates a OxyColor from the specified HSV array. - - The HSV value array. - A OxyColor. - - - - Converts from HSV to - - The hue value [0,1] - The saturation value [0,1] - The intensity value [0,1] - The . - See Wikipedia. - - - - Calculate the difference in hue between two s. - - The first color. - The second color. - The hue difference. - - - - Creates a color defined by an alpha value and another color. - - Alpha value. - The original color. - A color. - - - - Creates a color from the specified ARGB values. - - The alpha value. - The red value. - The green value. - The blue value. - A color. - - - - Creates a new structure from the specified RGB values. - - The red value. - The green value. - The blue value. - A structure with the specified values and an alpha channel value of 1. - - - - Interpolates the specified colors. - - The color1. - The color2. - The t. - The interpolated color - - - - Determines whether the specified colors are equal to each other. - - The first color. - The second color. - true if the two colors are equal; otherwise, false . - - - - Determines whether the specified colors are not equal to each other. - - The first color. - The second color. - true if the two colors are not equal; otherwise, false . - - - - Determines whether the specified is equal to this instance. - - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false . - - - - Determines whether the specified is equal to this instance. - - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false . - - - - Returns a hash code for this instance. - - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - - Returns a that represents this instance. - - A that represents this instance. - - - - Determines whether this color is invisible. - - True if the alpha value is 0. - - - - Determines whether this color is visible. - - True if the alpha value is greater than 0. - - - - Determines whether this color is undefined. - - True if the color equals . - - - - Determines whether this color is automatic. - - True if the color equals . - - - - Gets the actual color. - - The default color. - The default color if the current color equals OxyColors.Automatic, otherwise the color itself. - - - - Returns C# code that generates this instance. - - The C# code. - - - - Provides extension methods for . - - These are pure methods. They could also be placed in the type with a PureAttribute. - - - - Changes the intensity. - - The color. - The factor. - A color with the new intensity. - - - - Changes the intensity. - - The color. - The factor. - A color with the new intensity. - - - - Calculates the complementary color. - - The color to convert. - The complementary color. - - - - Converts from a to HSV values (double) - - The color. - Array of [Hue,Saturation,Value] in the range [0,1] - - - - Converts to an unsigned integer. - - The color. - The color as an unsigned integer. - - - - Converts an to a string containing the ARGB byte values. - - The color. - A string that contains byte values of the alpha, red, green and blue components separated by comma. - - - - Returns C# code that generates this instance. - - The color. - The code. - - - - Gets the name of the color if it is defined in the class. - - The color. - The color name or null if the color is not found. - - - - Implements a set of predefined colors. - - - - - The undefined color. - - - - - The automatic color. - - - - - The alice blue. - - - - - The antique white. - - - - - The aqua. - - - - - The aquamarine. - - - - - The azure. - - - - - The beige. - - - - - The bisque. - - - - - The black. - - - - - The blanched almond. - - - - - The blue. - - - - - The blue violet. - - - - - The brown. - - - - - The burly wood. - - - - - The cadet blue. - - - - - The chartreuse. - - - - - The chocolate. - - - - - The coral. - - - - - The cornflower blue. - - - - - The cornsilk. - - - - - The crimson. - - - - - The cyan. - - - - - The dark blue. - - - - - The dark cyan. - - - - - The dark goldenrod. - - - - - The dark gray. - - - - - The dark green. - - - - - The dark khaki. - - - - - The dark magenta. - - - - - The dark olive green. - - - - - The dark orange. - - - - - The dark orchid. - - - - - The dark red. - - - - - The dark salmon. - - - - - The dark sea green. - - - - - The dark slate blue. - - - - - The dark slate gray. - - - - - The dark turquoise. - - - - - The dark violet. - - - - - The deep pink. - - - - - The deep sky blue. - - - - - The dim gray. - - - - - The dodger blue. - - - - - The firebrick. - - - - - The floral white. - - - - - The forest green. - - - - - The fuchsia. - - - - - The gainsboro. - - - - - The ghost white. - - - - - The gold. - - - - - The goldenrod. - - - - - The gray. - - - - - The green. - - - - - The green yellow. - - - - - The honeydew. - - - - - The hot pink. - - - - - The indian red. - - - - - The indigo. - - - - - The ivory. - - - - - The khaki. - - - - - The lavender. - - - - - The lavender blush. - - - - - The lawn green. - - - - - The lemon chiffon. - - - - - The light blue. - - - - - The light coral. - - - - - The light cyan. - - - - - The light goldenrod yellow. - - - - - The light gray. - - - - - The light green. - - - - - The light pink. - - - - - The light salmon. - - - - - The light sea green. - - - - - The light sky blue. - - - - - The light slate gray. - - - - - The light steel blue. - - - - - The light yellow. - - - - - The lime. - - - - - The lime green. - - - - - The linen. - - - - - The magenta. - - - - - The maroon. - - - - - The medium aquamarine. - - - - - The medium blue. - - - - - The medium orchid. - - - - - The medium purple. - - - - - The medium sea green. - - - - - The medium slate blue. - - - - - The medium spring green. - - - - - The medium turquoise. - - - - - The medium violet red. - - - - - The midnight blue. - - - - - The mint cream. - - - - - The misty rose. - - - - - The moccasin. - - - - - The navajo white. - - - - - The navy. - - - - - The old lace. - - - - - The olive. - - - - - The olive drab. - - - - - The orange. - - - - - The orange red. - - - - - The orchid. - - - - - The pale goldenrod. - - - - - The pale green. - - - - - The pale turquoise. - - - - - The pale violet red. - - - - - The papaya whip. - - - - - The peach puff. - - - - - The peru. - - - - - The pink. - - - - - The plum. - - - - - The powder blue. - - - - - The purple. - - - - - The red. - - - - - The rosy brown. - - - - - The royal blue. - - - - - The saddle brown. - - - - - The salmon. - - - - - The sandy brown. - - - - - The sea green. - - - - - The sea shell. - - - - - The sienna. - - - - - The silver. - - - - - The sky blue. - - - - - The slate blue. - - - - - The slate gray. - - - - - The snow. - - - - - The spring green. - - - - - The steel blue. - - - - - The tan. - - - - - The teal. - - - - - The thistle. - - - - - The tomato. - - - - - The transparent. - - - - - The turquoise. - - - - - The violet. - - - - - The wheat. - - - - - The white. - - - - - The white smoke. - - - - - The yellow. - - - - - The yellow green. - - - - - Represents a palette of colors. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The colors. - - - - Initializes a new instance of the class. - - The colors. - - - - Gets or sets the colors. - - The colors. - - - - Interpolates the specified colors to a palette of the specified size. - - The size of the palette. - The colors. - A palette. - - - - Creates a palette with reversed color order. - - The reversed . - - - - Provides predefined palettes. - - - Provides predefined palettes. - - - - - Initializes static members of the class. - - - - - Gets the blue-white-red palette with 31 colors. - - - - - Gets the hot palette with 64 colors. - - - - - Gets the hue palette with 64 colors. - - - - - Creates a black/white/red palette with the specified number of colors. - - The number of colors to create for the palette. - A palette. - - - - Creates a blue/white/red palette with the specified number of colors. - - The number of colors to create for the palette. - A palette. - - - - Creates a 'cool' palette with the specified number of colors. - - The number of colors to create for the palette. - A palette. - - - - Creates a gray-scale palette with the specified number of colors. - - The number of colors to create for the palette. - A palette. - - - - Creates a 'hot' palette with the specified number of colors. - - The number of colors to create for the palette. - A palette. - - - - Creates a palette from the hue component of the HSV color model. - - The number of colors. - The palette. - This palette is particularly appropriate for displaying periodic functions. - - - - Creates a hue-based palette from magenta to red. - - The number of colors. - The palette. - This palette contains only distinct colors and with the cool colors (blues) first. - - - - Creates a 'jet' palette with the specified number of colors. - - The number of colors to create for the palette. - A palette. - - - - Creates a rainbow palette with the specified number of colors. - - The number of colors to create for the palette. - A palette. - - - - The color sequence of the cividis palette. - - - - - The color sequence of the inferno palette. - - - - - The color sequence of the magma palette. - - - - - The color sequence of the plasma palette. - - - - - The color sequence of the viridis palette. - - - - - Gets the cividis palette. - - - - - Gets the inferno palette. - - - - - Gets the magma palette. - - - - - Gets the plasma palette. - - - - - Gets the viridis palette. - - - - - Describes a pen in terms of color, thickness, line style and line join type. - - - - - Initializes a new instance of the class. - - The color. - The thickness. - The line style. - The line join. - - - - Gets or sets the color of the pen. - - The color. - - - - Gets or sets the dash array (overrides ). - - The dash array. - - - - Gets or sets the line join type. - - The line join type. - - - - Gets or sets the line style (overridden by ). - - The line style. - - - - Gets or sets the line thickness. - - The line thickness. - - - - Gets the actual dash array. - - The actual dash array. - - - - Creates the specified pen. - - The color. - The thickness. - The line style. - The line join. - A pen. - - - - Returns a hash code for this instance. - - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - - Describes the width, height, and point origin of a rectangle. - - - - - Gets an infinitely large starting at (0,0). - - - - - The height of the rectangle. - - - - - The x-coordinate location of the left side of the rectangle. - - - - - The y-coordinate location of the top side of the rectangle. - - - - - The width of the rectangle. - - - - - Initializes a new instance of the structure that has the specified x-coordinate, y-coordinate, width, and height. - - The x-coordinate location of the left side of the rectangle. - The y-coordinate location of the top side of the rectangle. - The width of the rectangle. - The height of the rectangle. - width;The width should not be negative. - or - height;The height should not be negative. - - - - Initializes a new instance of the struct that is exactly large enough to contain the two specified points. - - The first point that the new rectangle must contain. - The second point that the new rectangle must contain. - - - - Initializes a new instance of the struct by location and size. - - The location. - The size. - - - - Gets the y-axis value of the bottom of the rectangle. - - The bottom. - - - - Gets the height of the rectangle. - - The height. - - - - Gets the x-axis value of the left side of the rectangle. - - The left. - - - - Gets the x-axis value of the right side of the rectangle. - - The right. - - - - Gets the y-axis position of the top of the rectangle. - - The top. - - - - Gets the width of the rectangle. - - The width. - - - - Gets the center point of the rectangle. - - The center. - - - - Gets the top left corner of the rectangle. - - The top left corner. - - - - Gets the top right corner of the rectangle. - - The top right corner. - - - - Gets the bottom left corner of the rectangle. - - The bottom left corner. - - - - Gets the bottom right corner of the rectangle. - - The bottom right corner. - - - - Creates a rectangle from the specified corner coordinates. - - The x0. - The y0. - The x1. - The y1. - A rectangle. - - - - Determines whether the specified point is inside the rectangle. - - The x coordinate. - The y coordinate. - true if the rectangle contains the specified point; otherwise, false. - - - - Determines whether the specified point is inside the rectangle. - - The point. - true if the rectangle contains the specified point; otherwise, false. - - - - Returns a that represents this instance. - - A that represents this instance. - - - - Returns a that represents this instance. - - The format. - The format provider. - - A that represents this instance. - - - - - Determines whether this instance and another specified object have the same value. - - The rectangle to compare to this instance. - true if the value of the parameter is the same as the value of this instance; otherwise, false. - - - - Returns a rectangle that is expanded or shrunk by the specified width and height amounts, in all directions. - - The amount by which to expand or shrink the left and right sides of the rectangle. - The amount by which to expand or shrink the top and bottom sides of the rectangle. - The expanded/shrunk . - - - - Returns a rectangle that is expanded by the specified thickness, in all directions. - - The thickness to apply to the rectangle. - The inflated . - - - - Intersects this with another . - - The other . - The intersection between this and the other . - If the two rectangles don't intersect, this returns an empty . - - - - Returns a rectangle that is shrunk by the specified thickness, in all directions. - - The thickness to apply to the rectangle. - The deflated . - - - - Returns a rectangle that is moved by the specified horizontal and vertical amounts. - - The amount to move the rectangle horizontally. - The amount to move the rectangle vertically. - The moved . - - - - Returns a rectangle that is clipped to the outer bounds of the specified rectangle. - - The rectangle that defines the outermost allowed coordinates for the clipped rectangle. - The clipped rectangle. - - - - Describes the size of an object. - - - - - Empty Size. - - - - - The height - - - - - The width - - - - - Initializes a new instance of the struct. - - The width. - The height. - - - - Gets the height. - - The height. - - - - Gets the width. - - The width. - - - - Returns a that represents this instance. - - A that represents this instance. - - - - Returns a that represents this instance. - - The format. - The format provider. - - A that represents this instance. - - - - - Determines whether this instance and another specified object have the same value. - - The size to compare to this instance. - true if the value of the parameter is the same as the value of this instance; otherwise, false. - - - - Creates a new with the maximum dimensions of this instance and the specified other instance. - - The other instance. - A new . - - - - Provides extension methods for - - These are pure methods. They could also be placed in the type with a PureAttribute. - - - - Calculates the bounds with respect to rotation angle and horizontal/vertical alignment. - - The size of the object to calculate bounds for. - The rotation angle (degrees). - The horizontal alignment. - The vertical alignment. - A minimum bounding rectangle. - - - - Gets the polygon outline of the specified rotated and aligned box. - - The size of the box. - The origin of the box. - The rotation angle of the box. - The horizontal alignment of the box. - The vertical alignment of the box. - A sequence of points defining the polygon outline of the box. - - - - Describes the thickness of a frame around a rectangle. Four values describe the left, top, right, and bottom sides of the rectangle, respectively. - - - - - The bottom. - - - - - The left. - - - - - The right. - - - - - The top. - - - - - Initializes a new instance of the struct. - - The thickness. - - - - Initializes a new instance of the struct. - - The left. - The top. - The right. - The bottom. - - - - Gets the bottom thickness. - - The bottom thickness. - - - - Gets the left thickness. - - The left thickness. - - - - Gets the right thickness. - - The right thickness. - - - - Gets the top thickness. - - The top thickness. - - - - Returns C# code that generates this instance. - - The to code. - - - - Returns a that represents this instance. - - A that represents this instance. - - - - Determines whether this instance and another specified object have the same value. - - The thickness to compare to this instance. - true if the value of the parameter is the same as the value of this instance; otherwise, false. - - - - Creates a new with the maximum dimensions of this instance and the specified other instance. - - The other instance. - A new . - - - - Provides an abstract base class for rendering contexts that implements a clipping stack. - - - - - - - - - - - - - - Resets the clipping area. - - - - - Sets the clipping area to the specified rectangle. - - The rectangle. - - Calls to this method must always be balanced by a call to before calling again. - - - - - Enumerates the available edge rendering modes. This gives an indication to the renderer which tradoffs to make between sharpness, speed and geomitric accuracy - when rendering shapes like lines, polygons, ellipses etc. - - - - - Indicates that a rendering mode should be chosen automatically by the . The renderer will treat this equivalently to . - - - - - The renderer will try to find the best rendering mode depending on the rendered shape. - - - - - The renderer will try to maximise the sharpness of edges. To that end, it may disable Anti-Aliasing for some lines or snap the position and stroke thickness - of rendered elements to device pixels. - - - - - The renderer will try to maximise the rendering speed. To that end, it may disable Anti-Aliasing. - - - - - The renderer will try to maximise geometric accuracy. To that end, it may enable Anti-Aliasing even for straight lines. - - - - - Specifies functionality to render 2D graphics. - - - - - Gets a value indicating whether the context renders to screen. - - true if the context renders to screen; otherwise, false. - - - - Draws an ellipse. - - The rectangle defining the extents of the ellipse. - The fill color. If set to OxyColors.Undefined, the extents will not be filled. - The stroke color. If set to OxyColors.Undefined, the extents will not be stroked. - The thickness (in device independent units, 1/96 inch). - The edge rendering mode. - - - - Draws a collection of ellipses, where all have the same stroke and fill. - - The rectangles defining the extents of the ellipses. - The fill color. If set to OxyColors.Undefined, the ellipses will not be filled. - The stroke color. If set to OxyColors.Undefined, the ellipses will not be stroked. - The stroke thickness (in device independent units, 1/96 inch). - The edge rendering mode. - - This should have better performance than calling multiple times. - - - - - Draws a polyline. - - The points defining the polyline. The polyline is drawn from point 0, to point 1, to point 2 and so on. - The stroke color. - The stroke thickness (in device independent units, 1/96 inch). - The edge rendering mode. - The dash array (in device independent units, 1/96 inch). Use null to get a solid line. - The line join type. - - - - Draws line segments. - - The points defining the line segments. Lines are drawn from point 0 to 1, point 2 to 3 and so on. - The stroke color. - The stroke thickness (in device independent units, 1/96 inch). - The edge rendering mode. - The dash array (in device independent units, 1/96 inch). - The line join type. - - This should have better performance than calling for each segment. - - - - - Draws a polygon. - - The points defining the polygon. - The fill color. If set to OxyColors.Undefined, the polygon will not be filled. - The stroke color. If set to OxyColors.Undefined, the polygon will not be stroked. - The stroke thickness (in device independent units, 1/96 inch). - The edge rendering mode. - The dash array (in device independent units, 1/96 inch). - The line join type. - - - - Draws a collection of polygons, where all polygons have the same stroke and fill. - - The polygons to draw. - The fill color. If set to OxyColors.Undefined, the polygons will not be filled. - The stroke color. If set to OxyColors.Undefined, the polygons will not be stroked. - The stroke thickness (in device independent units, 1/96 inch). - The edge rendering mode. - The dash array (in device independent units, 1/96 inch). - The line join type. - - This performs better than calling multiple times. - - - - - Draws a rectangle. - - The rectangle to draw. - The fill color. If set to OxyColors.Undefined, the rectangle will not be filled. - The stroke color. If set to OxyColors.Undefined, the rectangle will not be stroked. - The stroke thickness (in device independent units, 1/96 inch). - The edge rendering mode. - - - - Draws a collection of extents, where all have the same stroke and fill. - - The extents to draw. - The fill color. If set to OxyColors.Undefined, the extents will not be filled. - The stroke color. If set to OxyColors.Undefined, the extents will not be stroked. - The stroke thickness (in device independent units, 1/96 inch). - The edge rendering mode. - - This should have better performance than calling multiple times. - - - - - Draws text. - - The position. - The text. - The text color. - The font family. - Size of the font (in device independent units, 1/96 inch). - The font weight. - The rotation angle. - The horizontal alignment. - The vertical alignment. - The maximum size of the text (in device independent units, 1/96 inch). If set to null, the text will not be clipped. - - Multi-line text is not supported. - - - - - Measures the size of the specified text. - - The text to measure. - The font family. - Size of the font (in device independent units, 1/96 inch). - The font weight. - The size of the text (in device independent units, 1/96 inch). - - - - Sets the tool tip for the following items. - - The text in the tool tip, or null if no tool tip should be shown. - - - - Cleans up resources not in use. - - This method is called at the end of each rendering. - - - - Draws a portion of the specified . - - The source. - The x-coordinate of the upper-left corner of the portion of the source image to draw. - The y-coordinate of the upper-left corner of the portion of the source image to draw. - Width of the portion of the source image to draw. - Height of the portion of the source image to draw. - The x-coordinate of the upper-left corner of drawn image. - The y-coordinate of the upper-left corner of drawn image. - The width of the drawn image. - The height of the drawn image. - The opacity. - interpolate if set to true. - - - - Pushes the clipping rectangle onto the clipping stack. - - The clipping rectangle. - - If there is already a clipping rectangle on the clipping stack, the new clipping rectangle will be intersected with the existing clipping rectangle. - Calls to this method must be balanced by a call to . - It is recommended to use in combination with a using statement instead of and if possible. - However if and are used directly, it is recommended to wrap them in a try...finally block. - - - - - Pops the most recently pushed clipping rectangle from the clipping stack. - - - - - Gets the number of clipping rectangles on the clipping stack. - - - - - Provides functionality to render mathematical expressions. - - - - - Initializes static members of the class. - - - - - Gets or sets the subscript alignment. - - - - - Gets or sets the subscript size. - - - - - Gets or sets the superscript alignment. - - - - - Gets or sets the superscript size. - - - - - Draws or measures text containing sub- and superscript. - - The render context. - The point. - The text. - Color of the text. - The font family. - The font size. - The font weight. - The angle. - The horizontal alignment. - The vertical alignment. - The maximum size of the text. - Measure the size of the text if set to true. - The size of the text. - Subscript: H_{2}O - Superscript: E=mc^{2} - Both: A^{2}_{i,j} - - - - Draws text containing sub- and superscript. - - The render context. - The point. - The text. - Color of the text. - The font family. - The font size. - The font weight. - The angle. - The horizontal alignment. - The vertical alignment. - The maximum size of the text. - Subscript: H_{2}O - Superscript: E=mc^{2} - Both: A^{2}_{i,j} - - - - The measure math text. - - The render context. - The text. - The font family. - The font size. - The font weight. - The size of the text. - - - - Draws text with sub- and superscript items. - - The render context. - The x. - The y. - The x offset (in rotated coordinates). - The y offset (in rotated coordinates). - The s. - The text color. - The font family. - The font size. - The font weight. - Only measure if set to true. - The angle of the text (degrees). - The size of the text. - - - - Provides an abstract base class for rendering contexts. - - - - - Initializes a new instance of the class. - - - - - Gets a value indicating whether the specified points form a straight line (i.e. parallel to the pixel raster). - - - To determine whether a line is straight, the coordinates of and are compared. If either the X or the Y - coordinates (or both) of both points are very close together, the line is considered straight. The threshold of what is considered 'very close' - is fixed at 1e-5. - - The first point. - The second point. - true if the points form a straight line; false otherwise. - - - - Gets a value indicating whether the specified points form a straight line (i.e. parallel to the pixel raster). - - The points. - true if the points form a straight line; false otherwise. - - - - Gets or sets a value indicating whether the context renders to screen. - - true if the context renders to screen; otherwise, false. - - - - - - - - - - - - - - - - - - - - - - - - - - - - Draws the text. - - The position of the text. - The text. - The fill color. - The font family. - Size of the font. - The font weight. - The rotation angle. - The horizontal alignment. - The vertical alignment. - The maximum size of the text. - - - - Measures the text. - - The text. - The font family. - Size of the font. - The font weight. - The text size. - - - - Sets the tool tip for the following items. - - The text in the tooltip. - - - - Cleans up resources not in use. - - This method is called at the end of each rendering. - - - - Draws the specified portion of the specified at the specified location and with the specified size. - - The source. - The x-coordinate of the upper-left corner of the portion of the source image to draw. - The y-coordinate of the upper-left corner of the portion of the source image to draw. - Width of the portion of the source image to draw. - Height of the portion of the source image to draw. - The x-coordinate of the upper-left corner of drawn image. - The y-coordinate of the upper-left corner of drawn image. - The width of the drawn image. - The height of the drawn image. - The opacity. - Interpolate if set to true. - - - - - - - - - - - - - Creates an ellipse polygon. - - The bounding rectangle. - The number of points. - The points defining the ellipse. - Note that this is very slow, not optimized in any way. - - - - Creates a rectangle polygon. - - The rectangle. - The points defining the rectangle. - - - - Returns a value indicating whether anti-aliasing should be used for the given edge rendering mode. - - The edge rendering mode. - true if anti-aliasing should be used; false otherwise. - - - - Returns a value indicating whether anti-aliasing should be used for the given edge rendering mode. - - The edge rendering mode. - true if anti-aliasing should be used; false otherwise. - - - - Returns a value indicating whether anti-aliasing should be used for the given edge rendering mode. - - The edge rendering mode. - The points. - true if anti-aliasing should be used; false otherwise. - - - - Provides extension methods for . - - - - - The vertical distance to the bottom points of the triangles. - - - - - The vertical distance to the top points of the triangles . - - - - - The horizontal/vertical distance to the end points of the stars. - - - - - Gets the actual edge rendering mode. - - The edge rendering mode. - The default value that is used if edgeRenderingMode is . - The value of edgeRenderingMode if it is not ; the otherwise. - - - - Draws a clipped polyline through the specified points. - - The render context. - The points. - The minimum line segment length (squared). - The stroke color. - The stroke thickness. - The edge rendering mode. - The dash array (in device independent units, 1/96 inch). - The line join. - The output buffer. - The points rendered callback. - - - - Draws the polygon within the specified clipping rectangle. - - The render context. - The points. - The squared minimum distance between points. - The fill color. - The stroke color. - The stroke thickness. - The edge rendering mode. - The line style. - The line join. - - - - Draws the specified image. - - The render context. - The image. - The destination X position. - The destination Y position. - The width. - The height. - The opacity. - Interpolate the image if set to true. - - - - Draws multi-line text at the specified point. - - The render context. - The point. - The text. - The text color. - The font family. - The font size. - The font weight. - The line spacing. - - - - Draws a line specified by coordinates. - - The render context. - The x0. - The y0. - The x1. - The y1. - The pen. - The edge rendering mode. - - - - Draws the line segments. - - The render context. - The points. - The pen. - The edge rendering mode. - - - - Renders the marker. - - The render context. - The center point of the marker. - The marker type. - The outline. - The size of the marker. - The fill color. - The stroke color. - The stroke thickness. - The edge rendering mode. - - - - Draws a list of markers. - - The render context. - The marker points. - Type of the marker. - The marker outline. - Size of the marker. - The marker fill. - The marker stroke. - The marker stroke thickness. - The edge rendering mode. - The resolution. - The bin Offset. - - - - Draws a list of markers. - - The render context. - The marker points. - Type of the marker. - The marker outline. - Size of the markers. - The marker fill. - The marker stroke. - The marker stroke thickness. - The edge rendering mode. - The resolution. - The bin Offset. - - - - Draws a circle at the specified position. - - The render context. - The center x-coordinate. - The center y-coordinate. - The radius. - The fill color. - The stroke color. - The thickness. - The edge rendering mode. - - - - Draws a circle at the specified position. - - The render context. - The center. - The radius. - The fill color. - The stroke color. - The thickness. - The edge rendering mode. - - - - Fills a circle at the specified position. - - The render context. - The center. - The radius. - The fill color. - The edge rendering mode. - - - - Fills a rectangle at the specified position. - - The render context. - The rectangle. - The fill color. - The edge rendering mode. - - - - Draws the outline of a rectangle with individual stroke thickness for each side. - - The render context. - The rectangle. - The stroke color. - The thickness. - The edge rendering mode. - - - - Measures the size of the specified text. - - The render context. - The text. - The font family. - Size of the font (in device independent units, 1/96 inch). - The font weight. - The angle of measured text (degrees). - The size of the text (in device independent units, 1/96 inch). - - - - Applies the specified clipping rectangle the the render context and returns a reset token. The clipping is reset once this token is disposed. - - The render context. - The clipping rectangle. - The reset token. Clipping is reset once this is disposed. - - - - Adds a marker geometry to the specified collections. - - The position of the marker. - The marker type. - The custom outline, if is . - The size of the marker. - The output ellipse collection. - The output rectangle collection. - The output polygon collection. - The output line collection. - - - - Calculates the bounds with respect to rotation angle and horizontal/vertical alignment. - - The size of the object to calculate bounds for. - The rotation angle (degrees). - A minimum bounding rectangle. - - - - Reduces the specified list of points by the specified minimum squared distance. - - The points that should be evaluated. - The minimum line segment length (squared). - The output buffer. Cannot be null. - Points that are closer than the specified distance will not be included in the output buffer. - - - - Represents the token that is used to automatically reset the clipping in the method. - - - - - Provides a decorator that distorts the rendered output. - - - - - The decorated . This is the one that does the actual rendering. - - - - - The random number generator. - - - - - Initializes a new instance of the class. - - The decorated render context. - - - - Gets or sets the distortion factor. - - - - - Gets or sets the interpolation distance. - - - - - Gets or sets the font family. - - - The font family. - - - - - Gets or sets the thickness scale. - - - The thickness scale. - - - - - - - - - - - - - - Draws the text. - - The position of the text. - The text. - The fill color. - The font family. - Size of the font. - The font weight. - The rotation angle. - The horizontal alignment. - The vertical alignment. - The maximum size of the text. - - - - Measures the text. - - The text. - The font family. - Size of the font. - The font weight. - - The text size. - - - - - Sets the tool tip for the following items. - - The text in the tool tip. - - - - Cleans up resources not in use. - - - This method is called at the end of each rendering. - - - - - Draws the specified portion of the specified at the specified location and with the specified size. - - The source. - The x-coordinate of the upper-left corner of the portion of the source image to draw. - The y-coordinate of the upper-left corner of the portion of the source image to draw. - Width of the portion of the source image to draw. - Height of the portion of the source image to draw. - The x-coordinate of the upper-left corner of drawn image. - The y-coordinate of the upper-left corner of drawn image. - The width of the drawn image. - The height of the drawn image. - The opacity. - Interpolate if set to true. - - - - - - - - - - Gets the transformed font family name. - - The original font family. - The actual font family. - - - - Distorts the specified points. - - The input points. - - The distorted points. - - - - - Generates an array of random numbers. - - The number of numbers to generate. - The random numbers. - - - - Applies a moving average filter to the input values. - - The input values. - The number of values to average. - The filtered values. - - - - Interpolates the input points. - - The input points. - The interpolation distance. - The interpolated points. - - - - Represents a point defined in screen space. - - The rendering methods transforms s to s. - - - - The undefined point. - - - - - The x-coordinate. - - - - - The y-coordinate. - - - - - Initializes a new instance of the struct. - - The x-coordinate. - The y-coordinate. - - - - Gets the x-coordinate. - - The x-coordinate. - - - - Gets the y-coordinate. - - The y-coordinate. - - - - Determines whether the specified point is undefined. - - The point. - true if the specified point is undefined; otherwise, false . - - - - Translates a by a . - - The point. - The vector. - The translated point. - - - - Subtracts a from a - and returns the result as a . - - The point on which to perform the subtraction. - The point to subtract from p1. - A structure that represents the difference between p1 and p2. - - - - Subtracts a from a - and returns the result as a . - - The point on which to perform the subtraction. - The vector to subtract from p1. - A that represents point translated by the negative vector. - - - - Gets the distance to the specified point. - - The point. - The distance. - - - - Gets the squared distance to the specified point. - - The point. - The squared distance. - - - - Returns a that represents this instance. - - A that represents this instance. - - - - Determines whether this instance and another specified object have the same value. - - The point to compare to this instance. - true if the value of the parameter is the same as the value of this instance; otherwise, false. - - - - Provides algorithms for polygons and lines of . - - - - - Finds the nearest point on the specified polyline. - - The point. - The points. - The nearest point. - The is null. - - - - Finds the point on line. - - The point. - The first point on the line. - The second point on the line. - The nearest point on the line. - See Bourke. - - - - Finds the nearest point on line. - - The point. - The start point on the line. - The end point on the line. - The relative position of the nearest point. - See Bourke. - - - - Determines whether the specified point is in the specified polygon. - - The point. - The polygon points. - true if the point is in the polygon; otherwise, false. - - - - Resamples the points with the specified point distance limit. - - All points. - The minimum squared distance. - List of resampled points. - - - - Gets the centroid of the specified polygon. - - The points. - The centroid. - - - - Represents a vector defined in screen space. - - - - - The x-coordinate. - - - - - The y-coordinate. - - - - - Initializes a new instance of the structure. - - The x-coordinate. - The y-coordinate. - - - - Gets the length. - - - - - Gets the length squared. - - - - - Gets the x-coordinate. - - The x-coordinate. - - - - Gets the y-coordinate. - - The y-coordinate. - - - - Implements the operator *. - - The vector. - The multiplication factor. - The result of the operator. - - - - Adds a vector to another vector. - - The vector to add to. - The vector to be added. - The result of the operation. - - - - Subtracts one specified vector from another. - - The vector to subtract from. - The vector to be subtracted. - The result of operation. - - - - Negates the specified vector. - - The vector to negate. - The result of operation. - - - - Normalizes this vector. - - - - - Returns a that represents this instance. - - A that represents this instance. - - - - Determines whether this instance and another specified object have the same value. - - The point to compare to this instance. - true if the value of the parameter is the same as the value of this instance; otherwise, false. - - - - Provides functionality to interpolate a list of points by a canonical spline. - - CanonicalSplineHelper.cs (c) 2009 by Charles Petzold (WPF and Silverlight) - See also blog post. - - - - The tension. - - - - - Initializes a new instance of the class. - - The tension. - - - - Creates a spline of data points. - - The points. - True if the spline is closed. - The tolerance. - A list of data points. - - - - Creates a spline of screen points. - - The points. - True if the spline is closed. - The tolerance. - A list of screen points. - - - - Creates a spline of data points. - - The points. - The tension. - The tensions. - True if the spline is closed. - The tolerance. - A list of data points. - - - - Creates a spline of screen points. - - The points. - The tension. - The tensions. - True if the spline is closed. - The tolerance. - A list of screen points. - - - - The segment. - - The points. - The pt 0. - The pt 1. - The pt 2. - The pt 3. - The t 1. - The t 2. - The tolerance. - The maximum number of segments. Default is 1000. - - - - Provides functionality to interpolate a list of points by a Centripetal Catmull–Rom spline. - - Based on CanonicalSplineHelper.cs (c) 2009 by Charles Petzold (WPF and Silverlight) - See also blog post. - - - - Gets the alpha value. - - - - - Gets or sets the maximum number of segments. - - - - - Initializes a new instance of the class. - - The alpha. - - - - Creates a spline of data points. - - The points. - True if the spline is closed. - The tolerance. - A list of data points. - - - - Creates a spline of screen points. - - The points. - True if the spline is closed. - The tolerance. - A list of screen points. - - - - Creates a spline of data points. - - The points. - The alpha. - True if the spline is closed. - The tolerance. - The maximum number of segments. - A list of data points. - - - - Creates a spline of screen points. - - The points. - The alpha. - True if the spline is closed. - The tolerance. - The maximum number of segments. - A list of screen points. - - - - The segment. - - The points. - The pt 0. - The pt 1. - The pt 2. - The pt 3. - The alpha. - The tolerance. - The maximum number of segments. - - - - Provides functionality to decimate lines. - - - - - Decimates lines by reducing all points that have the same integer x value to a maximum of 4 points (first, min, max, last). - - The input points. - The decimated points. - - - - Adds vertical points to the list. - - The result. - The x coordinate. - The first y. - The last y. - The minimum y. - The maximum y. - - - - Specifies vertical alignment. - - - - - Aligned at the top. - - - - - Aligned in the middle. - - - - - Aligned at the bottom. - - - - - Represents an area series that fills the polygon defined by two sets of points or one set of points and a constant. - - - - - The second list of points. - - - - - The secondary data points from the collection. - - - - - The secondary data points from the list. - - - - - Initializes a new instance of the class. - - - - - Gets or sets a constant value for the area definition. - This is used if DataFieldBase and BaselineValues are null. - - The baseline. - is used if is set - and or are null, - or if is null and is empty. - - - - Gets or sets the data field to use for the X-coordinates of the second data set. - - This property is used if is set. - - - - Gets or sets the data field to use for the Y-coordinates of the second data set. - - This property is used if is set. - - - - Gets or sets the color of the line for the second data set. - - The color. - - - - Gets the actual color of the line for the second data set. - - The actual color. - - - - Gets or sets the fill color of the area. - - The fill color. - - - - Gets the actual fill color of the area. - - The actual fill color. - - - - Gets the second list of points. - - The second list of points. - This property is not used if is set. - - - - Gets or sets a value indicating whether the second data collection should be reversed. - - true if the second data set should be reversed; otherwise, false. - The first dataset is not reversed, and normally - the second dataset should be reversed to get a - closed polygon. - - - - Gets the actual points of the second data set. - - A list of data points. - - - - Gets or sets the last visible window start position in second data points collection. - - - - - Gets a value indicating whether Points2 collection was defined by user. - - - - - Gets the nearest point. - - The point. - interpolate if set to true . - A TrackerHitResult for the current hit. - - - - Renders the series on the specified rendering context. - - The rendering context. - - - - Renders the legend symbol for the line series on the - specified rendering context. - - The rendering context. - The bounding rectangle of the legend box. - - - - The update data. - - - - - Updates the maximum and minimum values of the series. - - - - - Renders data points skipping NaN values. - - Area rendering context. - The list of chunks. - - - - Renders a chunk of points on the screen. - - Render context. - Screen points. - The list of resampled points. - - - - Gets the x coordinate of a DataPoint. - - Data point. - X coordinate. - - - - Gets the points when is used. - - A sequence of . - - - - Holds parameters for point rendering. - - - - - Gets or sets source data points. - - - - - Gets or sets start index of a visible window. - - - - - Gets or sets maximum visible X coordinate. - - - - - Gets or sets render context. - - - - - Gets or sets minimum squared distance between points. - - - - - Gets or sets a value indicating whether to reverse the points. - - - - - Gets or sets line color. - - - - - Gets or sets line dash array. - - - - - Represents an item used in the BarSeries. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The value. - Index of the category. - - - - Gets or sets the color of the item. - - If the color is not specified (default), the color of the series will be used. - - - - Gets or sets the value of the item. - - - - - Returns c# code that generates this instance. - - C# code. - - - - Represents an item in a bar series. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the index of the category. - - The index of the category. - - - - Gets the index of the category. - - The default index. - The index. - - - - Represents a series for clustered or stacked bar charts. - - - - - The default tracker format string - - - - - The default fill color. - - - - - Initializes a new instance of the class. - - - - - Gets the actual fill color. - - The actual color. - - - - Gets or sets the base value. - - The base value. - - - - Gets or sets the color field. - - - - - Gets or sets the color of the interior of the bars. - - The color. - - - - - - - - - - Gets or sets the label format string. - - The label format string. - - - - Gets or sets the label margins. - - - - - Gets or sets label placements. - - - - - Gets or sets the color of the interior of the bars when the value is negative. - - The color. - - - - - - - Gets or sets the value field. - - - - - Gets or sets the actual rectangles for the bars. - - - - - - - - - - - - - - - - - - - - - - - Renders the bar/column item. - - The render context. - The end value of the bar. - The category value. - The actual width of the bar. - The item. - The rectangle of the bar. - - - - Renders the item label. - - The render context - The item. - The bar item base value. - The bar item top value. - The bar item category value. - The bar item category end value. - - - - - - - - - - Base class for bar series. - - - - - The default category axis title - - - - - The default value axis title - - - - - Specifies if the ItemsSourceItems list can be modified. - - - - - Initializes a new instance of the class. - - - - - Gets the list of items that should be rendered. - - - - - - - - Gets or sets the width of the bars. The default value is 1. - - - - - - - - Gets the items list. - - A list of . - - - - - - - Gets or sets the items from the items source. - - - - - - - - Gets or sets the color of the border around the bars. - - The color of the stroke. - - - - Gets or sets the thickness of the bar border strokes. - - The stroke thickness. - - - - Gets or sets the manager of this . - - - - - Gets the valid items. - - - - - Gets or sets the dictionary which stores the index-inversion for the valid items - - - - - Gets the actual width of the items of this series. - - The width. - The actual width is also influenced by the GapWidth of the CategoryAxis used by this series. - - - - Gets the category axis. - - The category axis. - - - - - - - Gets a value indicating whether the specified item is valid. - - The items. - true if the item is valid; false otherwise. - - - - Updates the from the and data fields. - - - - - Clears or creates the list. - - - - - - - - - - - - - - - - - Updates the list with the valid items. - - - - - Represents a manager for bar series. - - - This handles all operations that need information about all bar series in the plot that share the same axes. This includes: - - determine and keep track of bar width and offset - - determine and keep track of stacked bar offsets - - - - - The current offset of the bars (not used for stacked bar series). - - These offsets are modified during rendering. - - - - The current max value per StackIndex and Label. - - These values are modified during rendering. - - - - The current min value per StackIndex and Label. - - These values are modified during rendering. - - - - The base value per StackIndex and Label for negative values of stacked bar series. - - These values are modified during rendering. - - - - The base value per StackIndex and Label for positive values of stacked bar series. - - These values are modified during rendering. - - - - The maximal width of all labels. - - - - - Initializes a new instance of the class. - - The category axis the belong to. - The value axis the belong to. - The bar series this instance should manage. - - - - Gets the whose bar series this instance manages. - - - - - Gets all bar series that are managed by this instance. - - - - - Gets the whose bar series this instance manages. - - - - - Gets the value whose bar series this instance manages. - - - - - Gets the string representation of the categories. - - - - - Gets or set the offset of the bars. - - - - - Gets or sets the offset of the bars per StackIndex and Label (only used for stacked bar series). - - - - - Gets or sets the stack index mapping. The mapping indicates to which rank a specific stack index belongs. - - - - - Gets the category value. - - Index of the category. - Index of the stack. - Actual width of the bar. - The get category value. - - - - Gets the current bar offset for the specified category index. - - The category index. - The offset. - - - - Gets the current base value for the specified stack and category index. - - The stack index. - The category index. - if set to true get the base value for negative values. - The current base value. - - - - Gets the current maximum value for the specified stack and category index. - - The stack index. - The category index. - The current value. - - - - Gets the current minimum value for the specified stack and category index. - - The stack index. - The category index. - The current value. - - - - Gets the maximum width of all category labels. - - The maximum width. - - - - Gets the stack index for the specified stack group. - - The stack group. - The stack index. - - - - Increases the current bar offset for the specified category index. - - The category index. - The offset increase. - - - - Initializes the manager for rendering. This should be called before any of the managed series are rendered. - - - - - Sets the current base value for the specified stack and category index. - - Index of the stack. - Index of the category. - if set to true set the base value for negative values. - The new value. - - - - Sets the current maximum value for the specified stack and category index. - - The stack index. - The category index. - The new value. - - - - Sets the current minimum value for the specified stack and category index. - - The stack index. - The category index. - The new value. - - - - Bar series should call this after they updated their data. - - - - - Gets a value indicating whether the bar series has an item at the specified category index. - - The bar series. - The category index. - true of the bar series has an item at the specified category index; false otherwise. - - - - Resets the current values. - - The current values may be modified during update of max/min and rendering. - - - - Updates the bar offsets. - - - - - Updates the valid data of all managed series. - - - - - Represents an item used in the ErrorColumnSeries. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The value. - The error. - Index of the category. - - - - Gets or sets the error of the item. - - - - - Returns c# code that generates this instance. - - C# code. - - - - Represents a series for clustered or stacked column charts with an error value. - - - - - The default tracker format string - - - - - Initializes a new instance of the class. - - - - - Gets or sets the stroke thickness of the error line. - - The stroke thickness of the error line. - - - - Gets or sets the width of the error end lines. - - The width of the error end lines. - - - - Updates the maximum and minimum values of the series. - - - - - - - - Defines the functionality of a bar series. - - - - - Gets the bar width. - - - - - Gets the the bar series uses. - - - - - Gets a value indicating whether the bar series is visible. - - - - - Gets or sets the manager of the bar series. - - - - - Gets the the bar series belongs to. - - - - - Gets the the bar series uses. - - - - - Updates the valid data. - - - - - Gets the actual bar items. - - - - - Represents an item in an IntervalBarSeries. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The start. - The end. - The title. - - - - Gets or sets the color. - - - - - Gets or sets the end value. - - - - - Gets or sets the start value. - - - - - Gets or sets the title. - - - - - Returns c# code that generates this instance. - - C# code. - - - - Represents a series for bar charts defined by to/from values. - - - - - The default tracker format string - - - - - The default fill color. - - - - - Initializes a new instance of the class. - - - - - Gets the actual fill color. - - The actual color. - - - - Gets or sets the color field. - - - - - Gets or sets the color field. - - - - - Gets or sets the default color of the interior of the Maximum bars. - - The color. - - - - - - - - - - Gets or sets the label color. - - - - - Gets or sets the format string for the maximum labels. - - - - - Gets or sets the label margins. - - - - - - - - Gets or sets the color field. - - - - - Gets or sets the actual rectangles for the maximum bars. - - - - - - - - - - - - - - - - - - - - - - - - - - Defines properties for stacked series. - - - - - Gets a value indicating whether this series is stacked. - - - - - Gets a value indicating whether this series should overlap its stack when is true. - - - - - Gets the stack group. - - The stack group. - - - - Placement of the labels. - - - - - Placed outside the bar. - - - - - Placed inside the bar. - - - - - Placed inside in the middle/center of the bar. - - - - - Placed inside at the base of the bar. - - - - - Represents a series to display bars in a linear axis - - - - - The rendered rectangles. - - - - - The indexes matching rendered rectangles. - - - - - The default color. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the color of the interior of the bars. - - The color. - - - - Gets or sets the width of the bars. - - The width of the bars. - - - - Gets or sets the thickness of the curve. - - The stroke thickness. - - - - Gets or sets the color of the border around the bars. - - The color of the stroke. - - - - Gets or sets the color of the interior of the bars when the value is negative. - - The color. - - - - Gets or sets the color of the border around the bars when the value is negative. - - The color of the stroke. - - - - Gets the actual color. - - The actual color. - - - - Gets the nearest point. - - The point. - interpolate if set to true . - A TrackerHitResult for the current hit. - - - - - - - Renders the legend symbol for the line series on the - specified rendering context. - - The rendering context. - The bounding rectangle of the legend box. - - - - Sets default values from the plot model. - - - - - Updates the axes to include the max and min of this series. - - - - - Find the index of a rectangle that contains the specified point. - - the target point - the rectangle index - - - - Renders the series bars. - - The rendering context. - The list of points that should be rendered. - - - - Computes the bars width. - - The list of points. - The bars width. - - - - Gets the colors used to draw a bar. - - The point y value - The bar colors - - - - Stores the colors used to draw a bar. - - - - - Initializes a new instance of the struct. - - The fill color - The stroke color - - - - Gets the fill color. - - - - - Gets the stroke color. - - - - - Represents a rectangle item in a RectangleBarSeries. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The x0. - The y0. - The x1. - The y1. - - - - Gets or sets the color. - - If set to Automatic, the FillColor of the RectangleBarSeries will be used. - - - - Gets or sets the title. - - - - - Gets or sets the x0 coordinate. - - - - - Gets or sets the x1 coordinate. - - - - - Gets or sets the y0 coordinate. - - - - - Gets or sets the y1 coordinate. - - - - - Returns c# code that generates this instance. - - C# code. - - - - Represents a series for bar charts where the bars are defined by rectangles. - - - - - The default tracker format string - - - - - The default fill color. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the default color of the interior of the rectangles. - - The color. - - - - Gets the actual fill color. - - The actual color. - - - - Gets the rectangle bar items. - - - - - Gets or sets the label color. - - - - - Gets or sets the format string for the labels. - - - - - Gets or sets the color of the border around the rectangles. - - The color of the stroke. - - - - Gets or sets the thickness of the border around the rectangles. - - The stroke thickness. - - - - Gets or sets the actual rectangles for the rectangles. - - - - - Gets or sets the actual rectangle bar items. - - - - - Gets the point in the dataset that is nearest the specified point. - - The point. - Specifies whether to interpolate or not. - A for the current hit. - - - - - - - Renders the legend symbol on the specified rendering context. - - The rendering context. - The legend rectangle. - - - - Sets the default values. - - - - - Updates the data. - - - - - Updates the maximum and minimum values of the series. - - - - - Checks if the specified value is valid. - - The value. - True if the value is valid. - - - - Represents an item for the TornadoBarSeries. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the base value. - - - - - Gets or sets the maximum value. - - - - - Gets or sets the color for the maximum bar. - - - - - Gets or sets the minimum value. - - - - - Gets or sets the color for the minimum bar. - - - - - Returns c# code that generates this instance. - - C# code. - - - - Represents a series that can be used to create tornado plots. - - See http://en.wikipedia.org/wiki/Tornado_diagram. - - - - The default tracker format string - - - - - The default fill color. - - - - - The default minimum fill color. - - - - - Initializes a new instance of the class. - - - - - Gets the actual fill color. - - The actual color. - - - - Gets the actual minimum fill color. - - The actual color. - - - - Gets or sets the color field. - - - - - Gets or sets the base value. - - The base value. - - - - Gets or sets the label color. - - - - - Gets or sets the label margins. - - - - - Gets or sets the color field. - - - - - Gets or sets the color field. - - - - - Gets or sets the color of the interior of the Maximum bars. - - The color. - - - - Gets or sets the format string for the maximum labels. - - - - - Gets or sets the color field. - - - - - Gets or sets the color field. - - - - - Gets or sets the default color of the interior of the Minimum bars. - - The color. - - - - Gets or sets the format string for the minimum labels. - - - - - Gets or sets the actual rectangles for the maximum bars. - - - - - Gets or sets the actual rectangles for the minimum bars. - - - - - - - - - - - - - - - - - - - - - - - - - - Represents an item in a . - - - - - Initializes a new instance of the class. - - The x. - The lower whisker. - The box bottom. - The median. - The box top. - The upper whisker. - - - - Gets or sets the box bottom value (usually the 25th percentile, Q1). - - The lower quartile value. - - - - Gets or sets the box top value (usually the 75th percentile, Q3)). - - The box top value. - - - - Gets or sets the lower whisker value. - - The lower whisker value. - - - - Gets or sets the median. - - The median. - - - - Gets or sets the mean. - - The mean. - - - - Gets or sets the outliers. - - The outliers. - - - - Gets or sets the tag. - - The tag. - - - - Gets or sets the upper whisker value. - - The upper whisker value. - - - - Gets a list of all the values in the item. - - - - - Gets or sets the X value. - - The X value. - - - - Returns a that represents this instance. - - A that represents this instance. - - - - Represents a series for box plots. - - - - - The default tracker format string - - - - - The items from the items source. - - - - - Specifies if the ownsItemsSourceItems list can be modified. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the width of the boxes (specified in x-axis units). - - The width of the boxes. - - - - Gets or sets the fill color. If null, this color will be automatically set. - - The fill color. - - - - Gets or sets the box plot items. - - The items. - - - - Gets or sets the line style. - - The line style. - - - - Gets or sets the size of the median point. - - This property is only used when ShowMedianAsDot = true. - - - - Gets or sets the median thickness, relative to the StrokeThickness. - - The median thickness. - - - - Gets or sets the size of the mean point. - - This property is only used when ShowMeanAsDot = true. - - - - Gets or sets the mean thickness, relative to the StrokeThickness. - - The mean thickness. - - - - Gets or sets the diameter of the outlier circles (specified in points). - - The size of the outlier. - - - - Gets or sets the tracker format string for the outliers. - - The tracker format string for the outliers. - Use {0} for series title, {1} for x- and {2} for y-value. - - - - Gets or sets the type of the outliers. - - The type of the outliers. - MarkerType.Custom is currently not supported. - - - - Gets or sets the a custom polygon outline for the outlier markers. Set to to use this property. - - A polyline. The default is null. - - - - Gets or sets a value indicating whether to show the boxes. - - - - - Gets or sets a value indicating whether to show the median as a dot. - - - - - Gets or sets a value indicating whether to show the mean as a dot. - - - - - Gets or sets the stroke color. - - The stroke color. - - - - Gets or sets the stroke thickness. - - The stroke thickness. - - - - Gets or sets the width of the whiskers (relative to the BoxWidth). - - The width of the whiskers. - - - - Gets the list of items that should be rendered. - - - - - Gets the nearest point. - - The point. - interpolate if set to true . - A TrackerHitResult for the current hit. - - - - Determines whether the specified item contains a valid point. - - The item. - The x axis. - The y axis. - true if the point is valid; otherwise, false . - - - - Renders the series on the specified render context. - - The rendering context. - - - - Renders the legend symbol on the specified rendering context. - - The rendering context. - The legend rectangle. - - - - Updates the data. - - - - - Updates the maximum and minimum values of the series. - - - - - Updates the max and min of the series. - - The items. - - - - Gets the item at the specified index. - - The index of the item. - The item of the index. - - - - Gets the screen rectangle for the box. - - The box item. - A rectangle. - - - - Clears or creates the list. - - - - - Represents a series that renders contours. - - See wikipedia and link. - - - - The default tracker format string - - - - - The contour collection. - - - - - The temporary segment collection. - - - - - The default color. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the color. - - The color. - - - - Gets the actual color. - - The actual color. - - - - Gets or sets the column coordinates. - - The column coordinates. - - - - Gets or sets the contour level step size. - This property is not used if the vector is set. - - The contour level step size. - - - - Gets or sets the contour levels. - - The contour levels. - - - - Gets or sets the contour colors. - - The contour colors. - These colors will override the Color of the series. - If there are less colors than the number of contour levels, the colors will cycle. - - - - Gets or sets the data. - - The data. - - - - Gets or sets the text background color. - - The text background color. - - - - Gets or sets the format string for contour values. - - The format string. - - - - Gets or sets the label spacing, which is the space between labels on the same contour. Not used if == - - The label spacing. - - - - Gets or sets a value indicating whether multiple labels should be displayed per Contour. The default value is false - - - - - Gets or sets the interval between labeled contours. LabelStep = 1 is default and it means that all contours have a label - - The label step. - - - - Gets or sets the line style. - - The line style. - - - - Gets or sets the row coordinates. - - The row coordinates. - - - - Gets or sets the stroke thickness. - - The stroke thickness. - - - - Gets or sets the minimum length of the segment. - Increasing this number will increase performance, - but make the curve less accurate. The default is 2. - - The minimum length of the segment. - - - - Calculates the contours. - - - - - Gets the point in the dataset that is nearest the specified point. - - The point. - The interpolate. - A hit result object. - - - - Renders the series on the specified rendering context. - - The rendering context. - - - - Sets default values from the plot model. - - - - - Updates the maximum and minimum values of the series. - - - - - Gets the index of item that is closest to the specified value. - - A list of values. - A value. - An index. - - - - The add contour labels. - - The contour. - The points of the contour. - The contour labels. - The index of the point in the list of points, where the label should get added. - - - - Joins the contour segments. - - The tolerance for segment ends to connect (maximum allowed [length of distance vector] / [length of position vector]). - - - - Renders the contour label. - - The render context. - The contour label. - - - - Renders the contour label background. - - The render context. - The contour label. - - - - Represents one of the two points of a segment. - - - - - Initializes a new instance of the class. - - The segment point. - - - - Gets or sets a value indicating whether this already was added to a . - - - - - Gets or sets the partner point. This point and its partner together define a segment. - - - - - Gets or sets the join point. This is a point from another segment with the same coordinates as this point (within eps). - - - - - Gets the data point. - - - - - Represents a contour. - - - - - Gets or sets the contour level. - - The contour level. - - - - Gets or sets the points. - - The points. - - - - Initializes a new instance of the class. - - The points. - The contour level. - - - - Gets or sets the color of the contour. - - - - - Represents a contour label. - - - - - Gets or sets the angle. - - The angle. - - - - Gets or sets the position. - - The position. - - - - Gets or sets the text. - - The text. - - - - Represents a contour segment. - - - - - The contour level. - - - - - The end point. - - - - - The start point. - - - - - Initializes a new instance of the class. - - The start point. - The end point. - The contour level. - - - - Provides an abstract base class for series that contain a collection of s. - - - - - The list of data points. - - - - - The data points from the items source. - - - - - Specifies if the itemsSourcePoints list can be modified. - - - - - Gets or sets a value indicating whether the tracker can interpolate points. - - - - - Gets or sets the data field X. The default is null. - - The data field X. - - - - Gets or sets the data field Y. The default is null. - - The data field Y. - - - - Gets or sets the delegate used to map from to the . The default is null. - - The mapping. - Example: series1.Mapping = item => new DataPoint(((MyType)item).Time,((MyType)item).Value); - - - - Gets the list of points. - - A list of . - - - - Gets the list of points that should be rendered. - - A list of . - - - - Gets the point on the series that is nearest the specified point. - - The point. - Interpolate the series if this flag is set to true. - A TrackerHitResult for the current hit. - - - - Updates the data. - - - - - Updates the maximum and minimum values of the series. - - - - - Gets the item at the specified index. - - The index of the item. - The item of the index. - - - - Clears or creates the list. - - - - - Updates the points from the . - - - - - Represents an interval defined by two doubles. - - - - - The undefined data range. - - - - - Initializes a new instance of the struct. - - The inclusive lower bound. - The inclusive upper bound. - - - - Gets the lower bound of the data range. - - - - - Gets the upper bound of the data range. - - - - - Gets the difference between maximum and minimum. - - - - - Determines whether this data range is defined. - - true if this instance is defined, otherwise false. - - - - Determines whether the specified value lies - within the closed interval of the data range. - - The value to be checked. - true if value in range, otherwise false. - - - - Determines whether the specified data range - intersects with this instance. - - the other interval to be checked. - true if intersects, otherwise false. - - - - Returns C# code that generates this instance. - - The to code. - - - - Returns a that represents this instance. - - A that represents this instance. - - - - Represents a series where the line can be rendered using a different style - or color in defined intervals of X. The style specified in the LineStyle - property determines how the line is rendered in these intervals. Outside - the intervals the style is always solid. - - - - - Default color for the extrapolated parts of the curve. Currently hard-coded. - - - - - Default line style for the extrapolated parts of the curve. Currently hard-coded. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the color for the part of the line that is inside an interval. - - - - - Gets the actual extrapolation color. - - The actual color. - - - - Gets or sets the dash array for the extrapolated intervals of the rendered line - (overrides ). The default is null. - - The dash array for extrapolated intervals. - If this is not null it overrides the property. - - - - Gets or sets the style for the extrapolated parts of the line. - - - - - Gets the actual extrapolation line style. - - - - - Gets or sets a value indicating whether the extrapolated regions of the series will - be taken into account when calculating the minima and maxima of the dataset. - These regions will hence also be ignored when auto-scaling the axes. - - - - - Gets the list of X intervals within which the line is rendered using the second color and style. - - - - - Gets the actual dash array for the extrapolated parts of the line. - - - - - Renders the legend symbol for the extrapolation line series on the - specified rendering context. Both lines (normal and extrapolated) - are displayed. - - The rendering context. - The bounding rectangle of the legend box. - - - - Updates the data and sorts the intervals. - - - - - Updates the maximum and minimum values of the series. - - - - - Renders a continuous line. - - The render context. - The points to render. - - - - Creates clipping rectangles for the parts of the line which are either - rendered in normal style or in extrapolation style. - - - - - Returns a flat sequence of doubles containing alternating minima - and maxima of the original data range intervals. - - - - - Renders the part of the line which is given by the provided list of screen points. - - - - - Sorts the intervals by their minimum and merges those intervals which overlap, i.e. - replaces them by their union. - - - - - Checks whether the given x-value is within any of the - ordered intervals using binary search. - - The value to be checked for. - true if x is inside any interval. - - - - Checks whether the given x-value is within the provided interval. - - The interval to check against. - The value to be checked. - 0 if x is within inclusive interval, -1 if x smaller interval's min, 1 if x larger interval's max. - - - - Represents a dual view (candlestick + volume) series for OHLCV bars - - Note that to use this series, one *must* define two y-axes, one named "Bars" and the other named - "Volume". Typically would set up the volume on StartPosition =0, EndPosition = fraction and for - the bar axis StartPosition = fraction + delta, EndPosition = 1.0. - - See link - - - - The default tracker format string - - - - - The data series - - - - - The minimum X gap between successive data items - - - - - The index of the data item at the start of visible window - - - - - Initializes a new instance of the class. - - - - - Gets or sets the items of the series. - - The items. - - - - Gets the portion of the Y axis associated with bars - - - - - Gets the portion of the Y axis associated with volume - - - - - Gets or sets the volume axis key (defaults to "Volume") - - - - - Gets or sets the bar axis key (defaults to null, as is the primary axis). - - - - - Gets or sets the style of volume rendering (defaults to Combined) - - - - - Gets or sets the thickness of the bar lines - - The stroke thickness. - - - - Gets or sets the stroke intensity scale (used to generate stroke color from positive or negative color). - For example, 1.0 = same color and 0.5 is 1/2 of the intensity of the source fill color. - - - - - Gets or sets the thickness of the volume / bar separator - - The stroke thickness. - - - - Gets or sets the line style for the volume / bar separator - - - - - Gets or sets the color used when the closing value is greater than opening value or - for buying volume. - - - - - Gets or sets the fill color used when the closing value is less than opening value or - for selling volume - - - - - Gets or sets the color of the separator line - - - - - Gets or sets a value indicating whether positive bars are shown as filled (false) or hollow (true) candlesticks - - - - - Gets or sets a value indicating whether negative bars are shown as filled (false) or hollow (true) candlesticks - - - - - Gets or sets the bar width in data units (for example if the X axis is date-time based, then should - use the difference of DateTimeAxis.ToDouble(date) to indicate the width). By default candlestick - series will use 0.80 x the minimum difference in data points. - - - - - Gets or sets the minimum volume seen in the data series. - - - - - Gets or sets the maximum volume seen in the data series. - - - - - Gets or sets the average volume seen in the data series. - - - - - Append a bar to the series (must be in X order) - - Bar object. - - - - Fast index of bar where max(bar[i].X) <= x - - The index of the bar closest to X, where max(bar[i].X) <= x. - The x coordinate. - starting index - - - - - - - Renders the legend symbol for the series on the specified rendering context. - - The rendering context. - The bounding rectangle of the legend box. - - - - Gets the point on the series that is nearest the specified point. - - The point. - Interpolate the series if this flag is set to true. - A TrackerHitResult for the current hit. - - - - Updates the data. - - - - - Ensures that the axes of the series is defined. - - - - - Updates the axes to include the max and min of this series. - - - - - Updates the maximum and minimum values of the series. - - - - - Gets the clipping rectangle for the given combination of existing X-Axis and specific Y-Axis - - The clipping rectangle. - Y axis. - - - - Gets the clipping rectangle between plots - - The clipping rectangle. - - - - Represents a "higher performance" ordered OHLC series for candlestick charts - - Does the following: - - automatically calculates the appropriate bar width based on available screen + # of bars - - can render and pan within millions of bars, using a fast approach to indexing in series - - convenience methods - - This implementation is associated with issue 369. - - See also Wikipedia and - Matlab documentation. - - - - The minimum X gap between successive data items - - - - - Initializes a new instance of the class. - - - - - Gets or sets the color used when the closing value is greater than opening value. - - - - - Gets or sets the fill color used when the closing value is less than opening value. - - - - - Gets or sets the bar width in data units (for example if the X axis is date/time based, then should - use the difference of DateTimeAxis.ToDouble(date) to indicate the width). By default candlestick - series will use 0.80 x the minimum difference in data points. - - - - - Fast index of bar where max(bar[i].X) <= x - - The index of the bar closest to X, where max(bar[i].X) <= x. - The x coordinate. - starting index - - - - - - - Renders the legend symbol for the series on the specified rendering context. - - The rendering context. - The bounding rectangle of the legend box. - - - - Gets the point on the series that is nearest the specified point. - - The point. - Interpolate the series if this flag is set to true. - A TrackerHitResult for the current hit. - - - - Updates the data. - - - - - Represents an item in a . - - - - - The undefined. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - The x value. - - - The high value. - - - The low value. - - - The open value. - - - The close value. - - - - - Gets or sets the close value. - - The close value. - - - - Gets or sets the high value. - - The high value. - - - - Gets or sets the low value. - - The low value. - - - - Gets or sets the open value. - - The open value. - - - - Gets or sets the X value (time). - - The X value. - - - - Returns C# code that generates this instance. - - The C# code. - - - - Represents a series for high-low plots. - - See link - - - - The default tracker format string - - - - - High/low items - - - - - The default color. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the color of the item. - - The color. - - - - Gets the actual color of the item. - - The actual color. - - - - Gets or sets the dashes array. - If this is not null it overrides the LineStyle property. - - The dashes. - - - - Gets or sets the data field for the Close value. - - - - - Gets or sets the data field for the High value. - - - - - Gets or sets the data field for the Low value. - - - - - Gets or sets the data field for the Open value. - - - - - Gets or sets the x data field (time). - - - - - Gets the items of the series. - - The items. - - - - Gets or sets the line join. - - The line join. - - - - Gets or sets the line style. - - The line style. - - - - Gets or sets the mapping delegate. - - The mapping. - Example: series1.Mapping = item => new HighLowItem(((MyType)item).Time,((MyType)item).Value); - - - - Gets or sets the thickness of the curve. - - The stroke thickness. - - - - Gets or sets the length of the open/close ticks (screen coordinates). - - The length of the open/close ticks. - - - - Gets the point on the series that is nearest the specified point. - - The point. - Interpolate the series if this flag is set to true. - A TrackerHitResult for the current hit. - - - - Determines whether the point is valid. - - The point. - The x axis. - The y axis. - true if the specified point is valid; otherwise, false. - - - - - - - Renders the legend symbol for the series on the specified rendering context. - - The rendering context. - The bounding rectangle of the legend box. - - - - Sets the default values. - - - - - Updates the data. - - - - - Updates the maximum and minimum values of the series. - - - - - Represents an item in a . - - - - - The undefined. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The x coordinate / time. - Open value. - High value. - Low value. - Close value. - Buy volume. - Sell volume. - - - - Gets or sets the X value (time). - - The X value. - - - - Gets or sets the open value. - - The open value. - - - - Gets or sets the high value. - - The high value. - - - - Gets or sets the low value. - - The low value. - - - - Gets or sets the close value. - - The close value. - - - - Gets or sets the buy volume. - - - - - Gets or sets the sell volume. - - - - - Find index of max(x) <= target x in a list of OHLCV items - - - vector of bars - - - target x. - - - initial guess. - - - index of x with max(x) <= target x or -1 if cannot find - - - - - Indicate whether is valid for rendering or not - - true if this instance is valid; otherwise, false. - - - - Represents a series for candlestick charts. - - See also Wikipedia and - Matlab documentation. - - - - Initializes a new instance of the class. - - - - - Gets or sets the width of the candle (in screen space units). - - - - - Gets or sets the color used when the closing value is greater than opening value. - - - - - Gets or sets the fill color used when the closing value is less than opening value. - - - - - Gets or sets the end color of the shadow. - - The end color of the shadow. - - - - Gets or sets the lengths of the shadow ends. - - The length relative to the width of the candle. - - - - Gets the actual increasing fill color. - - - - - - - - Renders the legend symbol for the series on the specified rendering context. - - The rendering context. - The bounding rectangle of the legend box. - - - - Represents a dual view (candlestick + volume) series for OHLCV bars - - See link - - - - The default tracker format string - - - - - The data series - - - - - The minimum X gap between successive data items - - - - - The index of the data item at the start of visible window - - - - - Initializes a new instance of the class. - - - - - Gets or sets the items of the series. - - The items. - - - - Gets or sets the style of volume rendering (defaults to Combined) - - - - - Gets or sets the thickness of the bar lines - - The stroke thickness. - - - - Gets or sets the stroke intensity scale (used to generate stroke color from positive or negative color). - For example, 1.0 = same color and 0.5 is 1/2 of the intensity of the source fill color. - - - - - Gets or sets the color used when the closing value is greater than opening value or - for buying volume. - - - - - Gets or sets the fill color used when the closing value is less than opening value or - for selling volume - - - - - Gets or sets the stroke color of the Y=0 intercept - - - - - Gets or sets the thickness of the Y=0 intercept - - - - - Gets or sets the line style of the Y=0 intercept - - - - - Gets or sets a value indicating whether positive bars are shown as filled (false) or hollow (true) candlesticks - - - - - Gets or sets a value indicating whether negative bars are shown as filled (false) or hollow (true) candlesticks - - - - - Gets or sets the bar width in data units (for example if the X axis is date/time based, then should - use the difference of DateTimeAxis.ToDouble(date) to indicate the width). By default candlestick - series will use 0.80 x the minimum difference in data points. - - - - - Gets or sets the minimum volume seen in the data series. - - - - - Gets or sets the maximum volume seen in the data series. - - - - - Gets or sets the average volume seen in the data series. - - - - - Append a bar to the series (must be in X order) - - The Bar. - - - - Fast index of bar where max(bar[i].X) <= x - - The index of the bar closest to X, where max(bar[i].X) <= x. - The x coordinate. - starting index - - - - - - - Renders the legend symbol for the series on the specified rendering context. - - The rendering context. - The bounding rectangle of the legend box. - - - - Gets the point on the series that is nearest the specified point. - - The point. - Interpolate the series if this flag is set to true. - A TrackerHitResult for the current hit. - - - - Updates the data. - - - - - Updates the axes to include the max and min of this series. - - - - - Updates the maximum and minimum values of the series. - - - - - Represents rendering style for volume in either or . - - - - - Volume is not displayed - - - - - Buy + Sell volume summed to produce net positive or negative volume - - - - - Buy and Sell volume is stacked, one on top of the other, with the dominant on top - - - - - Buy volume above y=0 axis and Sell volume below y=0 axis - - - - - Represents a line series that generates its dataset from a function. - - Define f(x) and make a plot on the range [x0,x1] or define x(t) and y(t) and make a plot on the range [t0,t1]. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class using a function f(x). - - The function f(x). - The start x value. - The end x value. - The increment in x. - The title (optional). - - - - Initializes a new instance of the class using a function f(x). - - The function f(x). - The start x value. - The end x value. - The number of points. - The title (optional). - - - - Initializes a new instance of the class using functions x(t) and y(t). - - The function x(t). - The function y(t). - The start t parameter. - The end t parameter. - The increment in t. - The title. - - - - Initializes a new instance of the class using functions x(t) and y(t). - - The function x(t). - The function y(t). - The start t parameter. - The end t parameter. - The number of points. - The title. - - - - Specifies how the heat map coordinates are defined. - - - - - The coordinates defines the center of the cells - - - - - The coordinates defines the edge of the cells - - - - - Specifies how the heat map coordinates are defined. - - - - - The heat map is rendered as a bitmap - - - - - The heat map is rendered as a collection of discrete rectangles - - - - - Represents a heat map. - - - - - The default tracker format string - - - - - The default color-axis title - - - - - The hash code of the data when the image was updated. - - - - - The hash code of the color axis when the image was updated. - - - - - The image - - - - - Initializes a new instance of the class. - - - - - Gets or sets the x-coordinate of the elements at index [0,*] in the data set. - - - If equals , the value defines the mid point of the element at index [0,*] in the data set. - If equals , the value defines the coordinate of the left edge of the element at index [0,*] in the data set. - - - - - Gets or sets the x-coordinate of the mid point for the elements at index [m-1,*] in the data set. - - - If equals , the value defines the mid point of the element at index [m-1,*] in the data set. - If equals , the value defines the coordinate of the right edge of the element at index [m-1,*] in the data set. - - - - - Gets or sets the y-coordinate of the mid point for the elements at index [*,0] in the data set. - - - If equals , the value defines the mid point of the element at index [*,0] in the data set. - If equals , the value defines the coordinate of the bottom edge of the element at index [*,0] in the data set. - - - - - Gets or sets the y-coordinate of the mid point for the elements at index [*,n-1] in the data set. - - - If equals , the value defines the mid point of the element at index [*,n-1] in the data set. - If equals , the value defines the coordinate of the top edge of the element at index [*,n-1] in the data set. - - - - - Gets or sets the data array. - - Note that the indices of the data array refer to [x,y]. - The first dimension is along the x-axis. - The second dimension is along the y-axis. - Remember to call the method if the contents of the array is changed. - - - - Gets or sets a value indicating whether to interpolate when rendering. The default value is true. - - This property is not supported on all platforms. Ignored (off) if is . - - - - Gets the minimum value of the dataset. - - - - - Gets the maximum value of the dataset. - - - - - Gets or sets the color axis. - - The color axis. - - - - Gets or sets the color axis key. - - The color axis key. - - - - Gets or sets the coordinate definition. The default value is . - - The coordinate definition. - - - - Gets or sets the render method. The default value is . - - The render method. - - - - Gets or sets the format string for the cell labels. The default value is 0.00. - - The format string. - The label format string is only used when is greater than 0. - - - - Gets or sets the font size of the labels. The default value is 0 (labels not visible). - - The font size relative to the cell height. - - - - Invalidates the image that renders the heat map. The image will be regenerated the next time the is rendered. - - Call to refresh the view. - - - - Renders the series on the specified render context. - - The rendering context. - - - - Gets the point on the series that is nearest the specified point. - - The point. - Interpolate the series if this flag is set to true. - A TrackerHitResult for the current hit. - - - - Ensures that the axes of the series is defined. - - - - - Updates the maximum and minimum values of the series for the x and y dimensions only. - - - - - Updates the maximum and minimum values of the series. - - - - - Updates the axes to include the max and min of this series. - - - - - Renders the labels. - - The - The bounding rectangle for the data. - - - - Gets the label for the specified cell. - - The value of the cell. - The first index. - The second index. - The label string. - - - - Gets the interpolated value at the specified position in the data array (by bilinear interpolation). - Where interpolation is impossible, return NaN, rather than a calculated nonsense value. - - The data. - The first index. - The second index. - The interpolated value. - - - - Tests if a is inside the heat map - - The to test. - True if the point is inside the heat map. - - - - Updates the image. - - - - - Represents an item in a , a bin (range) and its area. - - - - - Initializes a new instance of the class. - - The range start. - The range end. - The area. - The count. - - - - Initializes a new instance of the class. - - The range start. - The range end. - The area. - The count. - The color. - - - - Gets or sets the range start. - - The range start. - - - - Gets or sets the range end. - - The range end. - - - - Gets or sets the area. - - The area. - - - - Gets the center of the item. - - - - - Gets or sets the count. - - The count. - - - - Gets or sets the color. - - The color. - If set to Automatic, the FillColor of the RectangleBarSeries will be used. - - - - Gets the computed width of the item. - - - - - Gets the computed height of the item. - - The computed height of the item. - - - - Gets the value of the item. Equivalent to the Height. - - The value of the item. - - - - Determines whether the specified point lies within the boundary of the . - - The DataPoint to determine whether or not lies within the boundary of the . - true if the value of the p parameter is inside the bounds of this instance. - - - - Returns C# code that generates this instance. - - The to code. - - - - Returns a that represents this instance. - - A that represents this instance. - - - - Represents a series that can be bound to a collection of . - - - - - The default tracker format string. - - - - - The default fill color. - - - - - The items originating from the items source. - - - - - Specifies if the list can be modified. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the color of the interior of the bars. - - The color. - - - - Gets the actual fill color. - - The actual color. - - - - Gets or sets the color of the border around the bars. - - The color of the stroke. - - - - Gets or sets the thickness of the bar border strokes. - - The stroke thickness. - - - - Gets the minimum value of the dataset. - - - - - Gets the maximum value of the dataset. - - - - - Gets or sets the format string for the cell labels. The default value is 0.00. - - The format string. - - - - Gets or sets the label margins. - - - - - Gets or sets label placements. - - - - - Gets or sets the delegate used to map from histogram item to color. - - - - - Gets or sets the delegate used to map from to . The default is null. - - The mapping. - Example: series1.Mapping = item => new HistogramItem((double)item.BinStart, (double)item.BinStart + item.BinWidth, (double)item.Count / totalCount, item.Count). - - - - Gets the list of . - - A list of . This list is used if is not set. - - - - Gets the list of that should be rendered. - - A list of . - - - - Renders the series on the specified rendering context. - - The rendering context. - - - - Gets the point on the series that is nearest the specified point. - - The point. - Interpolate the series if this flag is set to true. - A TrackerHitResult for the current hit. - - - - Renders the legend symbol on the specified rendering context. - - The rendering context. - The legend rectangle. - - - - Updates the data. - - - - - Sets the default values. - - - - - Updates the maximum and minimum values of the series for the x and y dimensions only. - - - - - Updates the maximum and minimum values of the series. - - - - - Gets the item at the specified index. - - The index of the item. - The item of the index. - - - - Renders the points as line, broken line and markers. - - The rendering context. - The Items to render. - - - - Gets the fill color of the given . - - The item. - The fill color of the item. - - - - Draws the label. - - The render context. - The column rectangle. - The item. - - - - Tests if a is inside the histogram. - - The to test. - True if the point is inside the heat map. - - - - Clears or creates the list. - - - - - Gets the default color for a HistogramItem. - - The default color. - - - - Updates the points from the . - - - - - Defines functionality to provide a . - - - - - Gets the that represents the element. - - A . - - - - Abstract base class for series that can contain items. - - - - - Gets or sets the items source. The default is null. - - The items source. - - - - Gets the item for the specified index. - - The items source. - The index. - The get item. - Returns null if ItemsSource is not set, or the index is outside the boundaries. - - - - Gets the item at the specified index. - - The index of the item. - The item of the index. - - - - Specifies the position of legends rendered on a . - - - - - Do not render legend on the line. - - - - - Render legend at the start of the line. - - - - - Render legend at the end of the line. - - - - - Represents a line series. - - - - - The divisor value used to calculate tolerance for line smoothing. - - - - - The output buffer. - - - - - The buffer for contiguous screen points. - - - - - The buffer for decimated points. - - - - - The default color. - - - - - The default marker fill color. - - - - - The default line style. - - - - - The smoothed points. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the color of the curve. - - The color. - - - - Gets or sets the color of the broken line segments. The default is . Set it to if it should follow the . - - Add DataPoint.Undefined in the Points collection to create breaks in the line. - - - - Gets or sets the broken line style. The default is . - - - - - Gets or sets the broken line thickness. The default is 0 (no line). - - - - - Gets or sets the dash array for the rendered line (overrides ). The default is null. - - The dash array. - If this is not null it overrides the property. - - - - Gets or sets the decimator. - - - The decimator action. - - The decimator can be used to improve the performance of the rendering. See the example. - - - - Gets or sets the label format string. The default is null (no labels). - - The label format string. - - - - Gets or sets the label margins. The default is 6. - - - - - Gets or sets the line join. The default is . - - The line join. - - - - Gets or sets the line style. The default is . - - The line style. - - - - Gets or sets a value specifying the position of a legend rendered on the line. The default is LineLegendPosition.None. - - A value specifying the position of the legend. - - - - Gets or sets the marker fill color. The default is . - - The marker fill. - - - - Gets or sets the a custom polygon outline for the markers. Set to to use this property. The default is null. - - A polyline. - - - - Gets or sets the marker resolution. The default is 0. - - The marker resolution. - - - - Gets or sets the size of the marker. The default is 3. - - The size of the marker. - - - - Gets or sets the marker stroke. The default is OxyColors.Automatic. - - The marker stroke. - - - - Gets or sets the marker stroke thickness. The default is 2. - - The marker stroke thickness. - - - - Gets or sets the type of the marker. The default is MarkerType.None. - - The type of the marker. - If MarkerType.Custom is used, the MarkerOutline property must be specified. - - - - Gets or sets the minimum length of the segment. - Increasing this number will increase performance, - but make the curve less accurate. The default is 2. - - The minimum length of the segment. - - - - Gets or sets a type of interpolation algorithm used for smoothing this . - - Type of interpolation algorithm. - - - - Gets or sets the thickness of the curve. - - The stroke thickness. - - - - Gets the actual color. - - The actual color. - - - - Gets the actual marker fill color. - - The actual color. - - - - Gets the actual line style. - - The actual line style. - - - - Gets the actual dash array for the line. - - - - - Gets the smoothed points. - - The smoothed points. - - - - Gets the point on the series that is nearest the specified point. - - The point. - Interpolate the series if this flag is set to true. - A TrackerHitResult for the current hit. - - - - Renders the series on the specified rendering context. - - The rendering context. - - - - Renders the legend symbol for the line series on the - specified rendering context. - - The rendering context. - The bounding rectangle of the legend box. - - - - Sets default values from the plot model. - - - - - Updates the maximum and minimum values of the series. - - - - - Renders the points as line, broken line and markers. - - The rendering context. - The points to render. - - - - Extracts a single contiguous line segment beginning with the element at the position of the enumerator when the method - is called. Initial invalid data points are ignored. - - Current point index - Initially set to null, but I will update I won't give a broken line if this is null - Maximum visible X value - place to put broken segment - place to put contiguous segment - Points collection - - true if line segments are extracted, false if reached end. - - - - - Renders the point labels. - - The render context. - - - - Renders a legend on the line. - - The render context. - - - - Renders the transformed points as a line (smoothed if isn’t null) and markers (if is not None). - - The render context. - The points to render. - - - - Renders a continuous line. - - The render context. - The points to render. - - - - Force the smoothed points to be re-evaluated. - - - - - Represents a line segment. - - - - - Initializes a new instance of the class. - - The first point of the segment. - The second point of the segment. - - - - Gets the first point1 of the segment. - - - - - Gets the second point of the segment. - - - - - Represents a series for pie/circle/doughnut charts. - - The arc length/central angle/area of each slice is proportional to the quantity it represents. - See Pie charts. - - - - The default tracker format string - - - - - The slices. - - - - - The actual points of the slices. - - - - - The total value of all the pie slices. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the angle increment. - - - - - Gets or sets the angle span. - - - - - Gets or sets a value indicating whether inside labels are angled. - - - - - Gets or sets the name of the property containing the color. - - The color field. - - - - Gets or sets the diameter. - - The diameter. - - - - Gets or sets the exploded distance. - - The exploded distance. - - - - Gets or sets the inner diameter. - - The inner diameter. - - - - Gets or sets the color of the inside labels. - - If the value is OxyColors.Automatic, the will be used. - - - - Gets or sets the inside label format. - - The inside label format. - The formatting arguments are: value {0}, label {1} and percentage {2}. - - - - Gets or sets the inside label position. - - The inside label position. - - - - Gets or sets the is exploded field. - - The is exploded field. - - - - Gets or sets the label field. - - The label field. - - - - Gets or sets the legend format. - - The legend format. - - - - Gets or sets the outside label format. - - The outside label format. - - - - Gets or sets the slices. - - The slices. - - - - Gets or sets the start angle. - - The start angle. - - - - Gets or sets the stroke color. - - The stroke color. - - - - Gets or sets the stroke thickness. - - The stroke thickness. - - - - Gets or sets the distance from the edge of the pie slice to the tick line. - - The distance. - - - - Gets or sets the length of the horizontal part of the tick. - - The length. - - - - Gets or sets the distance from the tick line to the outside label. - - The distance. - - - - Gets or sets the length of the radial part of the tick line. - - The length. - - - - Gets or sets the name of the property containing the value. - - The value field. - - - - Gets the point on the series that is nearest the specified point. - - The point. - Interpolate the series if this flag is set to true . - A TrackerHitResult for the current hit. - - - - Renders the series on the specified render context. - - The rendering context. - - - - Renders the legend symbol on the specified render context. - - The rendering context. - The legend rectangle. - - - - Checks if this data series requires X/Y axes. (e.g. PieSeries does not require axes) - - True if no axes are required. - - - - Ensures that the axes of the series is defined. - - - - - Check if the data series is using the specified axis. - - An axis. - True if the axis is in use. - - - - Sets the default values. - - - - - Updates the maximum and minimum values of the axes used by this series. - - - - - Updates the data. - - - - - Updates the maximum and minimum values of the series. - - - - - Represent a slice of a . - - - - - Initializes a new instance of the class. - - The label. - The value. - - - - Gets or sets the fill color. - - - - - Gets the actual fill color. - - The actual color. - - - - Gets or sets a value indicating whether the slice is exploded. - - - - - Gets the label. - - - - - Gets the value. - - - - - Gets or sets the default fill color. - - The default fill color. - - - - Returns C# code that generates this instance. - - C# code. - - - - Represents an item in a . - - s are transformed to s. - - - - The undefined rectangle item. - - - - - Initializes a new instance of the class. - - The x coordinate of the first corner. - The x coordinate of the diagonally-opposite corner. - The y coordinate of the first corner. - The y coordinate of the diagonally-opposite corner. - The value of the data rect. - - - - Initializes a new instance of the class. - - The first corner. - The diagonally-opposite corner. - The value of the data rect. - - - - Gets the first data point. - - The first data point. - - - - Gets the diagonally-opposite data point. - - The diagonally-opposite data point. - - - - Gets the value of the item. - - The value can be used to color-code the rectangle. - - - - Determines whether the specified point lies within the boundary of the rectangle. - - true if the value of the parameter is inside the bounds of this instance. - - - - Returns C# code that generates this instance. - - The to code. - - - - Determines whether this instance and another specified object have the same value. - - The point to compare to this instance. - true if the value of the parameter is the same as the value of this instance; otherwise, false. - - - - Returns a that represents this instance. - - A that represents this instance. - - - - Determines whether this rectangle item is defined. - - true if this point is defined; otherwise, false. - - - - Represents a series that can be bound to a collection of . - - - - - The items originating from the items source. - - - - - Specifies if the list can be modified. - - - - - The default tracker format string - - - - - The default color-axis title - - - - - Initializes a new instance of the class. - - - - - Gets the minimum value of the dataset. - - - - - Gets the maximum value of the dataset. - - - - - Gets or sets the color axis. - - The color axis. - - - - Gets or sets the color axis key. - - The color axis key. - - - - Gets or sets the format string for the cell labels. The default value is 0.00. - - The format string. - The label format string is only used when is greater than 0. - - - - Gets or sets the font size of the labels. The default value is 0 (labels not visible). - - The font size relative to the cell height. - - - - Gets or sets a value indicating whether the tracker can interpolate points. - - - - - Gets or sets the delegate used to map from to . The default is null. - - The mapping. - Example: series1.Mapping = item => new RectangleItem(new DataPoint((MyType)item).Time1, ((MyType)item).Value1), new DataPoint((MyType)item).Time2, ((MyType)item).Value2)); - - - - Gets the list of rectangles. - - A list of . This list is used if is not set. - - - - Gets the list of rectangles that should be rendered. - - A list of . - - - - Renders the series on the specified rendering context. - - The rendering context. - - - - Updates the data. - - - - - Gets the item at the specified index. - - The index of the item. - The item of the index. - - - - Clears or creates the list. - - - - - Updates the points from the . - - - - - Renders the points as line, broken line and markers. - - The rendering context. - The Items to render. - - - - Gets the point on the series that is nearest the specified point. - - The point. - Interpolate the series if this flag is set to true. - A TrackerHitResult for the current hit. - - - - Ensures that the axes of the series is defined. - - - - - Updates the maximum and minimum values of the series for the x and y dimensions only. - - - - - Updates the maximum and minimum values of the series. - - - - - Updates the axes to include the max and min of this series. - - - - - Tests if a is inside the heat map - - The to test. - True if the point is inside the heat map. - - - - Represents a point in a . - - - - - Initializes a new instance of the class. - - The x. - The y. - The X error. - The Y error. - The size. - The value. - The tag. - - - - Gets the error in X. - - - The error. - - - - - Gets the error in Y. - - - The error. - - - - - Returns C# code that generates this instance. - - C# code. - - - - Represents a series for scatter plots with the possibility to display error bars. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the data field for the X error property. - - - The data field. - - - - - Gets or sets the data field for the Y error property. - - - The data field. - - - - - Gets or sets the color of the error bar. - - - The color of the error bar. - - - - - Gets or sets the width of the error bar stop. - - - The width of the error bar stop. - - - - - Gets or sets the error bar stroke thickness. - - - The error bar stroke thickness. - - - - - Gets or sets the minimum size (relative to ) of the error bars to be shown. - - - The minimum size of the error. - - - - - Renders the series on the specified rendering context. - - - The rendering context. - - - - - Selects all points for which the passed function returns true. - - - The function. - - - - - Updates from data fields. - - - - - Represents a point in a . - - - - - Initializes a new instance of the class. - - The x. - The y. - The size. - The value. - The tag. - - - - Gets the X. - - The X. - - - - Gets the Y. - - The Y. - - - - Gets or sets the size. - - The size. - - - - Gets or sets the value. - - The value. - - - - Gets or sets the tag. - - The tag. - - - - Returns C# code that generates this instance. - - C# code. - - - - Returns a that represents this instance. - - A that represents this instance. - - - - Represents a series for scatter plots. - - See http://en.wikipedia.org/wiki/Scatter_plot - - - - Updates the from the and data fields. - - - - - Provides a base class for scatter series. - - The type of the data points. - - - - The default color-axis title - - - - - The list of data points. - - - - - The default fill color. - - - - - Initializes a new instance of the class. - - - - - Gets the list of points. - - A list of . - If the is specified, this list will not be used. - - - - Gets or sets the label format string. The default is null (no labels). - - The label format string. - - - - Gets or sets the label margins. The default is 6. - - - - - Gets or sets a function that maps from elements in the to points to be rendered. - - The mapping function. The default is null. - Example: series1.Mapping = item => new DataPoint(((MyType)item).Time,((MyType)item).Value); - - - - - Gets or sets the size of the 'binning' feature. - If this number is greater than 1, bins of the specified is created for both x and y directions. Only one point will be drawn in each bin. - - - The size of the bins. The default is 0 - no binning. - - - - - Gets the actual color axis. - - A . - This is used to map scatter point values to colors. Use the to specify a color axis. - If the is not specified, the first of the will be used. - - - - Gets or sets the color axis key. - - The color axis key. The default is null. - If set to null, the first of the will be used. - Make sure that the points contains values. - If your contains a , but you don't want to use a color axis, set the value to string.Empty or some other key that is not in use. - - - - Gets or sets the name of the property that specifies X coordinates in the elements. - - The name of the property. The default is null. - - - - Gets or sets the name of the property that specifies Y coordinates in the elements. - - The name of the property. The default is null. - - - - Gets or sets the name of the property that specifies the size in the elements. - - The name of the property. The default is null. - - - - Gets or sets the name of the property that specifies the tag in the elements. - - The name of the property. The default is null. - - - - Gets or sets the name of the property that specifies the color value in the elements. - - The name of the property. The default is null. - - - - Gets or sets the marker fill color. If null, this color will be automatically set. - - The fill color of the markers. The default is . - - - - Gets the actual fill color. - - The actual color. - - - - Gets or sets the custom marker outline polygon. Set to to use this. - - A polyline. The default is null. - - - - Gets or sets the size of the marker (same size for all items). - - The size of the markers. The default is 5. - - - - Gets or sets the marker stroke. - - The marker stroke. The default is . - - - - Gets or sets thickness of the the marker strokes. - - The thickness. The default is 1. - - - - Gets or sets the type of the marker. - - The type of the marker. The default is . - If is used, the property must be specified. - - - - Gets the maximum value of the points. - - - - - Gets the minimum value of the points. - - - - - Gets the actual points. - - - A read-only list of points. - - - - - Gets the list of points that should be rendered. - - A list of . - - - - Gets or sets the data points from the items source. - - - - - Gets or sets a value indicating whether the list can be modified. - - - - - Gets the nearest point. - - The point. - interpolate if set to true . - A TrackerHitResult for the current hit. - - - - - - - Renders the legend symbol for the line series on the specified rendering context. - - The rendering context. - The bounding rectangle of the legend box. - - - - Ensures that the axes of the series is defined. - - - - - Sets the default values. - - - - - Updates the data. - - - - - Updates the maximum and minimum values of the series. - - - - - Renders the point labels. - - The render context. - The clipping rectangle. - - - - Updates the Max/Min limits from the values in the specified point list. - - The points. - - - - Updates the Max/Min limits from the values in the specified point list. - - The points. - - - - Clears or creates the list. - - - - - Updates the from the and data fields. - - - - - Updates the points from the . - - - - - Provides an abstract base class for plot series. - - This class contains internal methods that should be called only from the PlotModel. - - - - Initializes a new instance of the class. - - - - - Gets or sets the background color of the series. The default is OxyColors.Undefined. - - This property defines the background color in the area defined by the x and y axes used by this series. - - - - Gets or sets a value indicating whether this series is visible. The default is true. - - - - - Gets or sets the title of the series. The default is null. - - The title that is shown in the legend of the plot. The default value is null. - - - - Gets or sets the key for the Legend to use on this series. The default is null. - - - This key may be used by the plot model to show a custom Legend for the series. - - - - - Gets or sets the groupname for the Series. The default is null. - - - This groupname may for e.g. be used by the Legend class to group series into separated blocks. - - - - - Gets or sets a value indicating whether the series should be rendered in the legend. The default is true. - - - - - Gets or sets a format string used for the tracker. The default depends on the series. - - - The arguments for the format string may be different for each type of series. See the documentation. - - - - - Gets or sets the key for the tracker to use on this series. The default is null. - - - This key may be used by the plot view to show a custom tracker for the series. - - - - - Gets the point on the series that is nearest the specified point. - - The point. - Interpolate the series if this flag is set to true. - A TrackerHitResult for the current hit. - - - - Renders the series on the specified render context. - - The rendering context. - - - - Renders the legend symbol on the specified render context. - - The rendering context. - The legend rectangle. - - - - Checks if this data series requires X/Y axes. (e.g. Pie series do not require axes) - - true if axes are required. - - - - Ensures that the axes of the series are defined. - - - - - Checks if the data series is using the specified axis. - - The axis that should be checked. - true if the axis is in use. - - - - Sets the default values (colors, line style etc.) from the plot model. - - - - - Updates the maximum and minimum values of the axes used by this series. - - - - - Updates the data of the series. - - - - - Updates the maximum and minimum values of the series. - - This method is called when the is updated with the updateData parameter set to true. - - - - When overridden in a derived class, tests if the plot element is hit by the specified point. - - The hit test arguments. - - The result of the hit test. - - - - - Represents a series for stair step graphs. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the stroke thickness of the vertical line segments. - - The vertical stroke thickness. - Set the value to NaN to use the StrokeThickness property for both horizontal and vertical segments. - Using the VerticalStrokeThickness property will have a small performance hit. - - - - Gets or sets the line style of the vertical line segments. - - The vertical line style. - - - - Gets the nearest point. - - The point. - interpolate if set to true . - A TrackerHitResult for the current hit. - - - - Renders the LineSeries on the specified rendering context. - - The rendering context. - - - - Represents a series that plots discrete data in a stem plot. - - See Stem plot and - stem. - - - - Initializes a new instance of the class. - - - - - Gets or sets Base. - - - - - Gets the point on the series that is nearest the specified point. - - The point. - Interpolate the series if this flag is set to true. - A TrackerHitResult for the current hit. - - - - Renders the LineSeries on the specified rendering context. - - The rendering context. - - - - Represents a two-color line series. - - - - - The default low color. - - - - - The default hi color. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the color for the part of the line that is below the limit. - - - - - Gets or sets the color for the part of the line that is above the limit. - - - - - Gets the actual hi color. - - The actual color. - - - - Gets the actual low color. - - The actual color. - - - - Gets or sets the high limit. - - The parts of the line that is below this limit will be rendered with ColorHi. - The parts of the line that is above the limit will be rendered with Color. - - - - Gets or sets the low limit. - - The parts of the line that is below this limit will be rendered with ColorLo. - The parts of the line that is above the limit will be rendered with Color. - - - - Gets or sets the dash array for the rendered line that is above the limit (overrides ). - - The dash array. - If this is not null it overrides the property. - - - - Gets or sets the dash array for the rendered line that is below the limit (overrides ). - - The dash array. - If this is not null it overrides the property. - - - - Gets or sets the line style for the part of the line that is above the limit. - - The line style. - - - - Gets or sets the line style for the part of the line that is below the limit. - - The line style. - - - - Gets the actual line style for the part of the line that is above the limit. - - The line style. - - - - Gets the actual line style for the part of the line that is below the limit. - - The line style. - - - - Gets the actual dash array for the line that is above the limit. - - - - - Gets the actual dash array for the line that is below the limit. - - - - - Sets the default values. - - - - - - - - Represents a two-color area series. - - - - - The default second color. - - - - - The collection of points above the limit. - - - - - The collection of points below the limit. - - - - - Start index of a visible rendering window for markers. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the area fill color below the limit line. - - The fill below the limit line. - - - - Gets the actual fill color below the limit line. - - The actual fill below the limit line. - - - - Gets the actual second color. - - The actual color. - - - - Gets or sets the dash array for the rendered line that is below the limit (overrides ). - - The dash array. - If this is not null it overrides the property. - - - - Gets or sets the line style for the part of the line that is below the limit. - - The line style. - - - - Gets the actual line style for the part of the line that is below the limit. - - The line style. - - - - Gets the actual dash array for the line that is below the limit. - - - - - Gets or sets the marker fill color which is below the limit line. The default is . - - The marker fill. - - - - Gets or sets the marker stroke which is below the limit line. The default is OxyColors.Automatic. - - The marker stroke. - - - - Gets or sets a baseline for the series. - - - - - Gets the nearest point. - - The point. - Interpolate if set to true . - A TrackerHitResult for the current hit. - - - - - - - Sets the default values. - - - - - The update data. - - - - - Renders a chunk of points on the screen. - - Render context. - Screen points. - The list of resampled points. - - - - Splits a collection of points into two collections based on their Y value. - - A collection of points to split. - - - - Gets the screen points when baseline is used. - - The list of polygon screen points. - Baseline Y value for the polygon. - A sequence of . - - - - Gets interpolated X coordinate for given Y on a straight line - between two points. - - First point. - Second point. - Y coordinate. - Corresponding X coordinate. - - - - Render context for two color area plot. - - - - - Gets or sets area baseline value. - - - - - Gets or sets polygon fill color. - - - - - Gets or sets marker fill color. - - - - - Gets or sets marker stroke color. - - - - - Represents a two-color line series. - - - - - The default second color. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the color for the part of the line that is below the limit. - - - - - Gets the actual second color. - - The actual color. - - - - Gets or sets the limit. - - The parts of the line that is below this limit will be rendered with Color2. - The parts of the line that is above the limit will be rendered with Color. - - - - Gets or sets the dash array for the rendered line that is below the limit (overrides ). - - The dash array. - If this is not null it overrides the property. - - - - Gets or sets the line style for the part of the line that is below the limit. - - The line style. - - - - Gets the actual line style for the part of the line that is below the limit. - - The line style. - - - - Gets the actual dash array for the line that is below the limit. - - - - - Sets the default values. - - - - - - - - Provides an abstract base class for series that are related to an X-axis and a Y-axis. - - - - - The default tracker format string - - - - - The default x-axis title - - - - - The default y-axis title - - - - - Initializes a new instance of the class. - - - - - Gets or sets the maximum x-coordinate of the dataset. - - The maximum x-coordinate. - - - - Gets or sets the maximum y-coordinate of the dataset. - - The maximum y-coordinate. - - - - Gets or sets the minimum x-coordinate of the dataset. - - The minimum x-coordinate. - - - - Gets or sets the minimum y-coordinate of the dataset. - - The minimum y-coordinate. - - - - Gets the x-axis. - - The x-axis. - - - - Gets or sets the x-axis key. The default is null. - - The x-axis key. - - - - Gets the y-axis. - - The y-axis. - - - - Gets or sets the y-axis key. The default is null. - - The y-axis key. - - - - Gets or sets a value indicating whether the X coordinate of all data point increases monotonically. - - - - - Gets or sets the last visible window start position in the data points collection. - - - - - - - - Gets the rectangle the series uses on the screen (screen coordinates). - - The rectangle. - - - - - - - Renders the legend symbol on the specified rendering context. - - The rendering context. - The legend rectangle. - - - - - - - Check if this data series requires X/Y axes. (e.g. Pie series do not require axes) - - The are axes required. - - - - Ensures that the axes of the series is defined. - - - - - Check if the data series is using the specified axis. - - An axis. - True if the axis is in use. - - - - Sets default values from the plot model. - - - - - Updates the axes to include the max and min of this series. - - - - - Updates the data. - - - - - Updates the maximum and minimum values of the series. - - - - - Gets the point on the curve that is nearest the specified point. - - The point list. - The point. - A tracker hit result if a point was found. - The Text property of the result will not be set, since the formatting depends on the various series. - - - - Gets the point on the curve that is nearest the specified point. - - The point list. - The index to start from. - The point. - A tracker hit result if a point was found. - The Text property of the result will not be set, since the formatting depends on the various series. - - - - Gets the nearest point. - - The points (data coordinates). - The point (screen coordinates). - A if a point was found, null otherwise. - The Text property of the result will not be set, since the formatting depends on the various series. - - - - Gets the nearest point. - - The points (data coordinates). - The index to start from. - The point (screen coordinates). - A if a point was found, null otherwise. - The Text property of the result will not be set, since the formatting depends on the various series. - - - - Determines whether the specified point is valid. - - The point. - true if the point is valid; otherwise, false . - - - - Determines whether the specified point is valid. - - The x coordinate. - The y coordinate. - true if the point is valid; otherwise, false . - - - - Updates the Max/Min limits from the specified list. - - The list of points. - - - - Updates the Max/Min limits from the specified list. - - The type of the elements in the list. - The items. - A function that provides the x value for each item. - A function that provides the y value for each item. - The items argument cannot be null. - - - - Updates the Max/Min limits from the specified collection. - - The type of the items in the collection. - The items. - A function that provides the x minimum for each item. - A function that provides the x maximum for each item. - A function that provides the y minimum for each item. - A function that provides the y maximum for each item. - The items argument cannot be null. - - - - Verifies that both axes are defined. - - - - - Updates visible window start index. - - The type of the list items. - Data points. - Function that gets data point X coordinate. - X coordinate of visible window start. - Last window index. - The new window start index. - - - - Finds the index of max(x) <= target x in a list of data points - - The type of the list items. - vector of data points - Function that gets data point X coordinate. - target x. - initial guess index. - - index of x with max(x) <= target x or 0 if cannot find - - - - - Provides functionality to export plots to scalable vector graphics. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the width (in user units) of the output area. - - - - - Gets or sets the height (in user units) of the output area. - - - - - Gets or sets a value indicating whether the xml headers should be included. - - - - - Gets or sets a value indicating whether to use a workaround for vertical text alignment to support renderers with limited support for the dominate-baseline attribute. - - - - - Gets or sets the text measurer. - - - - - Exports the specified model to a stream. - - The model. - The output stream. - The width (points). - The height (points). - if set to true, the xml headers will be included (?xml and !DOCTYPE). - The text measurer. - Whether to use the workaround for vertical text alignment - - - - Exports to string. - - The model. - The width (points). - The height (points). - if set to true, the xml headers will be included (?xml and !DOCTYPE). - The text measurer. - The plot as an SVG string. - Whether to use the workaround for vertical text alignment - - - - Exports the specified to a . - - The model to export. - The target stream. - - - - Exports the specified to a string. - - The model. - the SVG content as a string. - - - - Provides a render context for scalable vector graphics output. - - - - - The writer. - - - - - The disposed flag. - - - - - Initializes a new instance of the class. - - The stream. - The width. - The height. - Create an SVG document if set to true. - The text measurer. - The background. - Whether to use the workaround for vertical text alignment. - - - - Gets or sets the text measurer. - - The text measurer. - - - - Gets or sets a value indicating whether to use a workaround for vertical text alignment to support renderers with limited support for the dominate-baseline attribute. - - - - - Closes the svg writer. - - - - - Completes the svg element. - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - - - - - - - - - - - - - Draws the text. - - The p. - The text. - The c. - The font family. - Size of the font. - The font weight. - The rotate. - The horizontal alignment. - The vertical alignment. - Size of the max. - - - - Flushes this instance. - - - - - Measures the text. - - The text. - The font family. - Size of the font. - The font weight. - The text size. - - - - Draws the specified portion of the specified at the specified location and with the specified size. - - The source. - The x-coordinate of the upper-left corner of the portion of the source image to draw. - The y-coordinate of the upper-left corner of the portion of the source image to draw. - Width of the portion of the source image to draw. - Height of the portion of the source image to draw. - The x-coordinate of the upper-left corner of drawn image. - The y-coordinate of the upper-left corner of drawn image. - The width of the drawn image. - The height of the drawn image. - The opacity. - Interpolate if set to true. - - - - Releases unmanaged and - optionally - managed resources - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - - - - - - - Represents a writer that provides easy generation of Scalable Vector Graphics files. - - - - - The end is written. - - - - - The clip path number - - - - - Initializes a new instance of the class. - - The stream. - The width (in user units). - The height (in user units). - if set to true, the writer will write the xml headers (?xml and !DOCTYPE). - - - - Gets or sets a value indicating whether this writer should produce a stand-alone document. - - - - - Gets or sets the number format. - - The number format. - - - - Closes the svg document. - - - - - Writes the end of the document. - - - - - Creates a style. - - The fill color. - The stroke color. - The stroke thickness (in user units). - The line dash array. - The line join type. - A style string. - - - - Writes an ellipse. - - The x-coordinate of the center. - The y-coordinate of the center. - The width. - The height. - The style. - The edge rendering mode. - - - - Sets a clipping rectangle. - - The x coordinate of the clipping rectangle. - The y coordinate of the clipping rectangle. - The width of the clipping rectangle. - The height of the clipping rectangle. - - - - Resets the clipping rectangle. - - - - - Writes a portion of the specified image. - - The x-coordinate of the upper-left corner of the portion of the source image to draw. - The y-coordinate of the upper-left corner of the portion of the source image to draw. - Width of the portion of the source image to draw. - Height of the portion of the source image to draw. - The destination x-coordinate. - The destination y-coordinate. - Width of the destination rectangle. - Height of the destination rectangle. - The image. - - - - Writes the specified image. - - The x-coordinate. - The y-coordinate. - The width of the image. - The height of the image. - The image. - - - - Writes a line. - - The first point. - The second point. - The style. - The edge rendering mode. - - - - Writes a polygon. - - The points. - The style. - The edge rendering mode. - - - - Writes a polyline. - - The points. - The style. - The edge rendering mode. - - - - Writes a rectangle. - - The x coordinate. - The y coordinate. - The width. - The height. - The style. - The edge rendering mode. - - - - Writes text. - - The position. - The text. - The text color. - The font family. - The font size (in user units). - The font weight. - The rotation angle. - The horizontal alignment. - The vertical alignment. - - - - Converts a color to a svg color string. - - The color. - The color string. - - - - Writes an double attribute. - - The name. - The value. - - - - Writes the edge rendering mode attribute if necessary. - - The edge rendering mode. - - - - Converts a value to a string or to the specified "auto" string if the value is NaN. - - The value. - The string to return if value is NaN. - A string. - - - - Converts a list of points to a string. - - The points. - A string. - - - - Writes the header. - - The width. - The height. - - - - Provides functionality to build arrays. - - - - - Creates a vector. - - The first value. - The last value. - The number of steps. - A vector. - - - - Creates a vector. - - The first value. - The last value. - The step size. - A vector. - - - - Evaluates the specified function. - - The function. - The x values. - The y values. - Array of evaluations. The value of f(x_i,y_j) will be placed at index [i, j]. - - - - Fills the array with the specified value. - - The array to fill. - The value. - - - - Fills the two-dimensional array with the specified value. - - The two-dimensional array. - The value. - - - - Provides useful extension methods for arrays. - - - - - Finds the maximum value in the sequence, or returns a default value if the sequence is empty. - - The sequence. - The default value. - The maximum value of the sequence, or the default value if the sequency is empty. - - - - Finds the minimum value in the sequence, or returns a default value if the sequence is empty. - - The sequence. - The default value. - The minimum value of the sequence, or the default value if the sequency is empty. - - - - Finds the maximum value in the specified 2D array (NaN values not included). - - The array. - The maximum value. - - - - Finds the minimum value in the specified 2D array. - - The array. - Exclude NaN values if set to true. - The minimum value. - - - - Provides extension methods to the . - - - - - Reads a string of the specified length (in bytes). - - The reader. - The length. - The encoding. - The string. - - - - Reads an unsigned 32-bit integer. - - The reader. - Read as little endian (Intel convention) if set to true. - The unsigned integer. - - - - Reads a signed 32-bit integer. - - The reader. - Read as little endian (Intel convention) if set to true. - The signed integer. - - - - Reads an unsigned 16-bit integer. - - The reader. - Read as little endian (Intel convention) if set to true. - The unsigned integer. - - - - Reads an 64-bit floating point value. - - The reader. - Read as little endian (Intel convention) if set to true. - The floating point number. - - - - Reads an array of unsigned 32-bit integers. - - The reader. - The number of values to read. - Read as little endian (Intel convention) if set to true. - The unsigned integer array. - - - - Reads an array of unsigned 16-bit integers. - - The reader. - The number of values to read. - Read as little endian (Intel convention) if set to true. - The unsigned integer array. - - - - Reads a big endian (Motorola convention) unsigned 32-bit integer. - - The reader. - The unsigned integer. - - - - Reads a big endian (Motorola convention) signed 32-bit integer. - - The reader. - The signed integer. - - - - Reads a big endian (Motorola convention) unsigned 16-bit integer. - - The reader. - The unsigned integer. - - - - Reads a big endian (Motorola convention) 64-bit floating point number. - - The reader. - A . - - - - Specifies the behaviour for handling elements which cannot be assigned to any bin. - - - - - Throws an if any element cannot be assigned to any bin. - - - - - Counts outliers when computing statistics. - - - - - Ignores outliers when computing statistics. - - - - - Specifies the type of bounds used for binning. - - - - - Bins have an incusive lower bound. - - - - - Bins have an incusive upper bound. - - - - - Specifies the behaviour for handing extreme values which would be excluded by an exclusive bound. - - - - - Extreme values should be excluded if they do not fall on an inclusive bound. - - - - - Extreme values should always be included. - - - - - Represents options for methods that perform binning. - - - - - Initializes a new instance of the class. - - Specifies the behaviour for handling elements which cannot be assigned to any bin. - The type of interval that each bin represents. - Specifies whether extreme values should be assigned to the corresponding extreme bin. - - - - Gets a value specififying the behaviour for handling elements which cannot be assigned to any bin. - - - - - Gets a value specififying the type of interval that each bin represents. - - - - - Gets a value specififying the behaviour for handing extreme values which would be excluded by an exclusive bound. - - - - - Provides functionality to create custom comparers. - - - - - Creates a based on the specified comparison. - - The type of the elements to compare. - The delegate used to compare elements. - The created comparer. - - - - A comparer that uses a delegate to compare elements. - - The type of the elements to compare. - - - - The delegate used to compare elements. - - - - - Initializes a new instance of the class. - - The delegate used to compare elements. - - - - Compares two elements. - - The first element to compare. - The second element to compare. - A value indicating whether is less than, equal to, or greater than . - - - - Provides functionality to create contours from a triangular mesh. - - - Ported from C / Fortran code by Paul Bourke. - See Conrec for - full description of code and the original source. - - - Contouring aids in visualizing three dimensional surfaces on a two dimensional - medium (on paper or in this case a computer graphics screen). Two most common - applications are displaying topological features of an area on a map or the air - pressure on a weather map. In all cases some parameter is plotted as a function - of two variables, the longitude and latitude or x and y axis. One problem with - computer contouring is the process is usually CPU intensive and the algorithms - often use advanced mathematical techniques making them susceptible to error. - - - - - Renderer delegate - - Start point x-coordinate - Start point y-coordinate - End point x-coordinate - End point y-coordinate - Contour level - - - - Contour is a contouring subroutine for rectangularily spaced data - It emits calls to a line drawing subroutine supplied by the user - which draws a contour map corresponding to data on a randomly - spaced rectangular grid. The coordinates emitted are in the same - units given in the x() and y() arrays. - Any number of contour levels may be specified but they must be - in order of increasing value. - - Matrix of data to contour. - Data matrix column coordinates. - Data matrix row coordinates. - Contour levels in increasing order. - The renderer. - - - - Provides functionality to generate fraction strings from double values. - - Examples: "3/4", "PI/2" - - - - Converts a double to a fraction string. - - The value. - The unit. - The unit symbol. - The tolerance. - The format Provider. - The format string. - The convert to fraction string. - - - - Provides functionality to calculate hash codes. - - - - - Calculates a hash code for the specified sequence of items. - - A sequence of items. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - - Provides general helper functions. - - - - - Switches the values of two specified variables. - - The type of the variables. - The first value. - The second value. - - - - Gets the nearest tracker hit. - - The series. - The point. - Snap to points. - Check points only (no interpolation). - The distance from the series at which the tracker fires - The value indicating whether to check distance - when showing tracker between data points. - - is ignored if is equal to False. - - A tracker hit result. - - - - Provides methods to collect data samples into bins for use with a . - - - - - Generates a list of bin breaks, uniformly distributed between and . - - The inclusive lower-bound of the first bin. - The exclusive upper-bound of the last bin, which must be strictly greater than . - The number of bins to create. - An containing the breaks between bins of uniform size. - - - - Collects samples into tightly packed bins () defined by . - - The samples to collect into bins. - The start and end values for the bins. - The binning options to use. - A list of corresponding to the generated bins with areas computed from the proportion of samples placed within. - - - - Provides functionality to build a list by reflecting specified properties on a sequence. - - The target list item type. - This class uses reflection. - - - - The properties. - - - - - The default values - - - - - Initializes a new instance of the class. - - - - - Adds a property. - - The type of the property. - Name of the property. - The default value. - - - - Fills the specified target list. - - The target. - The source. - The instance creator. - - - - Fills the specified target list. - - The target. - The source list. - The instance creator. - - - - Provides functionality to reflect a path of properties. - - - - - The path items. - - - - - The property metadata. - - - - - The reflected types. - - - - - Initializes a new instance of the class. - - The reflection path. - - - - Gets the value for the specified instance. - - The instance. - - The value. - - Could not find property. - - - - Tries to get the value for the specified instance. - - The instance. - The result. - - true if the value was found. - - - - - Provides useful extension methods for streams. - - - - - Copies to the specified stream. - - The input stream. - The output stream. - - - - Provides extended string formatting functionality. - - - - - The formatting expression. - - - - - Replaces the format items in the specified string. - - The culture specific format provider. - The format string. - The item. - The values. - The formatted string. - The format string and values works as in String.Format. - In addition, you can format properties of the item object by using the syntax - {PropertyName:Formatstring}. - E.g. if you have a "Value" property in your item's class, use "{Value:0.00}" to output the value with two digits. - Note that this formatting is using reflection and does not have the same performance as string.Format. - - - - Creates a valid format string on the form "{0:###}". - - The input format string. - The corrected format string. - - - - Formats each item in a sequence by the specified format string and property. - - The source target. - The property name. - The format string. The format argument {0} can be used for the value of the property in each element of the sequence. - The format provider. - Could not find property. - - - - Splits the given text into separate lines. - - The text to split. - An array of the individual lines. - - - - Provides extension methods for types. - - - - - Retrieves an object that represents a specified property. - - The type that contains the property. - The name of the property. - An object that represents the specified property, or null if the property is not found. - - - - Provides an abstract base class for exporters that write xml. - - - - - The xml writer. - - - - - The disposed flag. - - - - - Initializes a new instance of the class. - - The stream. - - - - Closes this instance. - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Flushes this instance. - - - - - Writes an attribute string. - - The name. - The value. - - - - Writes an attribute string with a prefix. - - The prefix. - The name. - The constant. - The value. - - - - Writes the doc type. - - The name of the DOCTYPE. This must be non-empty. - If non-null it also writes PUBLIC "pubid" "sysid" where pubid and sysid are replaced with the value of the given arguments. - If pubid is null and sysid is non-null it writes SYSTEM "sysid" where sysid is replaced with the value of this argument. - If non-null it writes [subset] where subset is replaced with the value of this argument. - - - - Writes an element string. - - The name. - The text. - - - - Writes the end document. - - - - - Writes an element end tag. - - - - - Writes raw text. - - The text. - - - - Writes the start document. - - The standalone. - - - - Writes an element start tag. - - The name. - - - - Writes an element tag with the specified name and namespace. - - The name. - The ns. - - - - Writes a string. - - The text. - - - - Releases unmanaged and - optionally - managed resources - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - -
-
diff --git a/BaseModule/bin/Debug/log4net.xml b/BaseModule/bin/Debug/log4net.xml deleted file mode 100644 index dee43d6..0000000 --- a/BaseModule/bin/Debug/log4net.xml +++ /dev/null @@ -1,32450 +0,0 @@ - - - - log4net - - - - - Appender that logs to a database. - - - - appends logging events to a table within a - database. The appender can be configured to specify the connection - string by setting the property. - The connection type (provider) can be specified by setting the - property. For more information on database connection strings for - your specific database see http://www.connectionstrings.com/. - - - Records are written into the database either using a prepared - statement or a stored procedure. The property - is set to (System.Data.CommandType.Text) to specify a prepared statement - or to (System.Data.CommandType.StoredProcedure) to specify a stored - procedure. - - - The prepared statement text or the name of the stored procedure - must be set in the property. - - - The prepared statement or stored procedure can take a number - of parameters. Parameters are added using the - method. This adds a single to the - ordered list of parameters. The - type may be subclassed if required to provide database specific - functionality. The specifies - the parameter name, database type, size, and how the value should - be generated using a . - - - - An example of a SQL Server table that could be logged to: - - 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] - - - - An example configuration to log to the above table: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Julian Biddle - Nicko Cadell - Gert Driesen - Lance Nehring - - - - Initializes a new instance of the class. - - - Public default constructor to initialize a new instance of this class. - - - - - Gets or sets the database connection string that is used to connect to - the database. - - - The database connection string used to connect to the database. - - - - The connections string is specific to the connection type. - See for more information. - - - Connection string for MS Access via ODBC: - "DSN=MS Access Database;UID=admin;PWD=;SystemDB=C:\data\System.mdw;SafeTransactions = 0;FIL=MS Access;DriverID = 25;DBQ=C:\data\train33.mdb" - - Another connection string for MS Access via ODBC: - "Driver={Microsoft Access Driver (*.mdb)};DBQ=C:\Work\cvs_root\log4net-1.2\access.mdb;UID=;PWD=;" - - Connection string for MS Access via OLE DB: - "Provider=Microsoft.Jet.OLEDB.4.0;Data Source=C:\Work\cvs_root\log4net-1.2\access.mdb;User Id=;Password=;" - - - - - The appSettings key from App.Config that contains the connection string. - - - - - The connectionStrings key from App.Config that contains the connection string. - - - This property requires at least .NET 2.0. - - - - - Gets or sets the type name of the connection - that should be created. - - - The type name of the connection. - - - - The type name of the ADO.NET provider to use. - - - The default is to use the OLE DB provider. - - - Use the OLE DB Provider. This is the default value. - System.Data.OleDb.OleDbConnection, System.Data, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 - - Use the MS SQL Server Provider. - System.Data.SqlClient.SqlConnection, System.Data, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 - - Use the ODBC Provider. - Microsoft.Data.Odbc.OdbcConnection,Microsoft.Data.Odbc,version=1.0.3300.0,publicKeyToken=b77a5c561934e089,culture=neutral - This is an optional package that you can download from - http://msdn.microsoft.com/downloads - search for ODBC .NET Data Provider. - - Use the Oracle Provider. - System.Data.OracleClient.OracleConnection, System.Data.OracleClient, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 - This is an optional package that you can download from - http://msdn.microsoft.com/downloads - search for .NET Managed Provider for Oracle. - - - - - Gets or sets the command text that is used to insert logging events - into the database. - - - The command text used to insert logging events into the database. - - - - Either the text of the prepared statement or the - name of the stored procedure to execute to write into - the database. - - - The property determines if - this text is a prepared statement or a stored procedure. - - - If this property is not set, the command text is retrieved by invoking - . - - - - - - Gets or sets the command type to execute. - - - The command type to execute. - - - - This value may be either (System.Data.CommandType.Text) to specify - that the is a prepared statement to execute, - or (System.Data.CommandType.StoredProcedure) to specify that the - property is the name of a stored procedure - to execute. - - - The default value is (System.Data.CommandType.Text). - - - - - - Should transactions be used to insert logging events in the database. - - - true if transactions should be used to insert logging events in - the database, otherwise false. The default value is true. - - - - Gets or sets a value that indicates whether transactions should be used - to insert logging events in the database. - - - 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. - - - - - - Gets or sets the used to call the NetSend method. - - - The used to call the NetSend method. - - - - Unless a specified here for this appender - the is queried for the - security context to use. The default behavior is to use the security context - of the current thread. - - - - - - Should this appender try to reconnect to the database on error. - - - true if the appender should try to reconnect to the database after an - error has occurred, otherwise false. The default value is false, - i.e. not to try to reconnect. - - - - The default behaviour is for the appender not to try to reconnect to the - database if an error occurs. Subsequent logging events are discarded. - - - To force the appender to attempt to reconnect to the database set this - property to true. - - - 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. - - - - - - Gets or sets the underlying . - - - The underlying . - - - creates a to insert - logging events into a database. Classes deriving from - can use this property to get or set this . Use the - underlying returned from if - you require access beyond that which provides. - - - - - Initialize the appender based on the options set - - - - This is part of the delayed object - activation scheme. The method must - be called on this object after the configuration properties have - been set. Until is called this - object is in an undefined state and must not be used. - - - If any of the configuration properties are modified then - must be called again. - - - - - - Override the parent method to close the database - - - - Closes the database command and database connection. - - - - - - Inserts the events into the database. - - The events to insert into the database. - - - Insert all the events specified in the - array into the database. - - - - - - Adds a parameter to the command. - - The parameter to add to the command. - - - Adds a parameter to the ordered list of command parameters. - - - - - - Writes the events to the database using the transaction specified. - - The transaction that the events will be executed under. - The array of events to insert into the database. - - - The transaction argument can be null if the appender has been - configured not to use transactions. See - property for more information. - - - - - - Prepare entire database command object to be executed. - - The command to prepare. - - - - Formats the log message into database statement text. - - The event being logged. - - This method can be overridden by subclasses to provide - more control over the format of the database statement. - - - Text that can be passed to a . - - - - - Creates an instance used to connect to the database. - - - This method is called whenever a new IDbConnection is needed (i.e. when a reconnect is necessary). - - The of the object. - The connectionString output from the ResolveConnectionString method. - An instance with a valid connection string. - - - - Resolves the connection string from the ConnectionString, ConnectionStringName, or AppSettingsKey - property. - - - ConnectiongStringName is only supported on .NET 2.0 and higher. - - Additional information describing the connection string. - A connection string used to connect to the database. - - - - Retrieves the class type of the ADO.NET provider. - - - - Gets the Type of the ADO.NET provider to use to connect to the - database. This method resolves the type specified in the - property. - - - Subclasses can override this method to return a different type - if necessary. - - - The of the ADO.NET provider - - - - Connects to the database. - - - - - Cleanup the existing connection. - - - Calls the IDbConnection's method. - - - - - The list of objects. - - - - The list of objects. - - - - - - The security context to use for privileged calls - - - - - The that will be used - to insert logging events into a database. - - - - - Database connection string. - - - - - The appSettings key from App.Config that contains the connection string. - - - - - The connectionStrings key from App.Config that contains the connection string. - - - - - String type name of the type name. - - - - - The text of the command. - - - - - The command type. - - - - - Indicates whether to use transactions when writing to the database. - - - - - Indicates whether to reconnect when a connection is lost. - - - - - The fully qualified type of the AdoNetAppender class. - - - Used by the internal logger to record the Type of the - log message. - - - - - Parameter type used by the . - - - - This class provides the basic database parameter properties - as defined by the interface. - - This type can be subclassed to provide database specific - functionality. The two methods that are called externally are - and . - - - - - - Initializes a new instance of the class. - - - Default constructor for the AdoNetAppenderParameter class. - - - - - Gets or sets the name of this parameter. - - - The name of this parameter. - - - - The name of this parameter. The parameter name - must match up to a named parameter to the SQL stored procedure - or prepared statement. - - - - - - Gets or sets the database type for this parameter. - - - The database type for this parameter. - - - - The database type for this parameter. This property should - be set to the database type from the - enumeration. See . - - - This property is optional. If not specified the ADO.NET provider - will attempt to infer the type from the value. - - - - - - - Gets or sets the precision for this parameter. - - - The precision for this parameter. - - - - The maximum number of digits used to represent the Value. - - - This property is optional. If not specified the ADO.NET provider - will attempt to infer the precision from the value. - - - - - - - Gets or sets the scale for this parameter. - - - The scale for this parameter. - - - - The number of decimal places to which Value is resolved. - - - This property is optional. If not specified the ADO.NET provider - will attempt to infer the scale from the value. - - - - - - - Gets or sets the size for this parameter. - - - The size for this parameter. - - - - The maximum size, in bytes, of the data within the column. - - - This property is optional. If not specified the ADO.NET provider - will attempt to infer the size from the value. - - - For BLOB data types like VARCHAR(max) it may be impossible to infer the value automatically, use -1 as the size in this case. - - - - - - - Gets or sets the to use to - render the logging event into an object for this - parameter. - - - The used to render the - logging event into an object for this parameter. - - - - The that renders the value for this - parameter. - - - The can be used to adapt - any into a - for use in the property. - - - - - - Prepare the specified database command object. - - The command to prepare. - - - Prepares the database command object by adding - this parameter to its collection of parameters. - - - - - - Renders the logging event and set the parameter value in the command. - - The command containing the parameter. - The event to be rendered. - - - Renders the logging event using this parameters layout - object. Sets the value of the parameter on the command object. - - - - - - The name of this parameter. - - - - - The database type for this parameter. - - - - - Flag to infer type rather than use the DbType - - - - - The precision for this parameter. - - - - - The scale for this parameter. - - - - - The size for this parameter. - - - - - The to use to render the - logging event into an object for this parameter. - - - - - Appends logging events to the terminal using ANSI color escape sequences. - - - - 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. - - - 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. - - - By default, all output is written to the console's standard output stream. - The property can be set to direct the output to the - error stream. - - - NOTE: This appender writes each message to the System.Console.Out or - System.Console.Error 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. - - - When configuring the ANSI colored terminal appender, a mapping should be - specified to map a logging level to a color. For example: - - - - - - - - - - - - - - - The Level is the standard log4net logging level and ForeColor and BackColor can be any - of the following values: - - Blue - Green - Red - White - Yellow - Purple - Cyan - - These color values cannot be combined together to make new colors. - - - The attributes can be any combination of the following: - - Brightforeground is brighter - Dimforeground is dimmer - Underscoremessage is underlined - Blinkforeground is blinking (does not work on all terminals) - Reverseforeground and background are reversed - Hiddenoutput is hidden - Strikethroughmessage has a line through it - - While any of these attributes may be combined together not all combinations - work well together, for example setting both Bright and Dim attributes makes - no sense. - - - Patrick Wagstrom - Nicko Cadell - - - - The enum of possible display attributes - - - - The following flags can be combined together to - form the ANSI color attributes. - - - - - - - text is bright - - - - - text is dim - - - - - text is underlined - - - - - text is blinking - - - Not all terminals support this attribute - - - - - text and background colors are reversed - - - - - text is hidden - - - - - text is displayed with a strikethrough - - - - - text color is light - - - - - The enum of possible foreground or background color values for - use with the color mapping method - - - - The output can be in one for the following ANSI colors. - - - - - - - color is black - - - - - color is red - - - - - color is green - - - - - color is yellow - - - - - color is blue - - - - - color is magenta - - - - - color is cyan - - - - - color is white - - - - - Initializes a new instance of the class. - - - The instance of the class is set up to write - to the standard output stream. - - - - - Target is the value of the console output stream. - - - Target is the value of the console output stream. - This is either "Console.Out" or "Console.Error". - - - - Target is the value of the console output stream. - This is either "Console.Out" or "Console.Error". - - - - - - Add a mapping of level to color - - The mapping to add - - - Add a mapping to this appender. - Each mapping defines the foreground and background colours - for a level. - - - - - - This method is called by the method. - - The event to log. - - - Writes the event to the console. - - - The format of the output will depend on the appender's layout. - - - - - - This appender requires a to be set. - - true - - - This appender requires a to be set. - - - - - - Initialize the options for this appender - - - - Initialize the level to color mappings set on this appender. - - - - - - The to use when writing to the Console - standard output stream. - - - - The to use when writing to the Console - standard output stream. - - - - - - The to use when writing to the Console - standard error output stream. - - - - The to use when writing to the Console - standard error output stream. - - - - - - Flag to write output to the error stream rather than the standard output stream - - - - - Mapping from level object to color value - - - - - Ansi code to reset terminal - - - - - 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. - - - - Defines the mapping between a level and the color it should be displayed in. - - - - - - The mapped foreground color for the specified level - - - - Required property. - The mapped foreground color for the specified level - - - - - - The mapped background color for the specified level - - - - Required property. - The mapped background color for the specified level - - - - - - The color attributes for the specified level - - - - Required property. - The color attributes for the specified level - - - - - - Initialize the options for the object - - - - Combine the and together - and append the attributes. - - - - - - The combined , and - suitable for setting the ansi terminal color. - - - - - A strongly-typed collection of objects. - - Nicko Cadell - - - - Supports type-safe iteration over a . - - - - - - Gets the current element in the collection. - - - - - Advances the enumerator to the next element in the collection. - - - true if the enumerator was successfully advanced to the next element; - false if the enumerator has passed the end of the collection. - - - The collection was modified after the enumerator was created. - - - - - Sets the enumerator to its initial position, before the first element in the collection. - - - - - Creates a read-only wrapper for a AppenderCollection instance. - - list to create a readonly wrapper arround - - An AppenderCollection wrapper that is read-only. - - - - - An empty readonly static AppenderCollection - - - - - Initializes a new instance of the AppenderCollection class - that is empty and has the default initial capacity. - - - - - Initializes a new instance of the AppenderCollection class - that has the specified initial capacity. - - - The number of elements that the new AppenderCollection is initially capable of storing. - - - - - Initializes a new instance of the AppenderCollection class - that contains elements copied from the specified AppenderCollection. - - The AppenderCollection whose elements are copied to the new collection. - - - - Initializes a new instance of the AppenderCollection class - that contains elements copied from the specified array. - - The array whose elements are copied to the new list. - - - - Initializes a new instance of the AppenderCollection class - that contains elements copied from the specified collection. - - The collection whose elements are copied to the new list. - - - - Type visible only to our subclasses - Used to access protected constructor - - - - - - A value - - - - - Allow subclasses to avoid our default constructors - - - - - - - Gets the number of elements actually contained in the AppenderCollection. - - - - - Copies the entire AppenderCollection to a one-dimensional - array. - - The one-dimensional array to copy to. - - - - Copies the entire AppenderCollection to a one-dimensional - array, starting at the specified index of the target array. - - The one-dimensional array to copy to. - The zero-based index in at which copying begins. - - - - Gets a value indicating whether access to the collection is synchronized (thread-safe). - - false, because the backing type is an array, which is never thread-safe. - - - - Gets an object that can be used to synchronize access to the collection. - - - - - Gets or sets the at the specified index. - - The zero-based index of the element to get or set. - - is less than zero - -or- - is equal to or greater than . - - - - - Adds a to the end of the AppenderCollection. - - The to be added to the end of the AppenderCollection. - The index at which the value has been added. - - - - Removes all elements from the AppenderCollection. - - - - - Creates a shallow copy of the . - - A new with a shallow copy of the collection data. - - - - Determines whether a given is in the AppenderCollection. - - The to check for. - true if is found in the AppenderCollection; otherwise, false. - - - - Returns the zero-based index of the first occurrence of a - in the AppenderCollection. - - The to locate in the AppenderCollection. - - The zero-based index of the first occurrence of - in the entire AppenderCollection, if found; otherwise, -1. - - - - - Inserts an element into the AppenderCollection at the specified index. - - The zero-based index at which should be inserted. - The to insert. - - is less than zero - -or- - is equal to or greater than . - - - - - Removes the first occurrence of a specific from the AppenderCollection. - - The to remove from the AppenderCollection. - - The specified was not found in the AppenderCollection. - - - - - Removes the element at the specified index of the AppenderCollection. - - The zero-based index of the element to remove. - - is less than zero - -or- - is equal to or greater than . - - - - - Gets a value indicating whether the collection has a fixed size. - - true if the collection has a fixed size; otherwise, false. The default is false - - - - Gets a value indicating whether the IList is read-only. - - true if the collection is read-only; otherwise, false. The default is false - - - - Returns an enumerator that can iterate through the AppenderCollection. - - An for the entire AppenderCollection. - - - - Gets or sets the number of elements the AppenderCollection can contain. - - - - - Adds the elements of another AppenderCollection to the current AppenderCollection. - - The AppenderCollection whose elements should be added to the end of the current AppenderCollection. - The new of the AppenderCollection. - - - - Adds the elements of a array to the current AppenderCollection. - - The array whose elements should be added to the end of the AppenderCollection. - The new of the AppenderCollection. - - - - Adds the elements of a collection to the current AppenderCollection. - - The collection whose elements should be added to the end of the AppenderCollection. - The new of the AppenderCollection. - - - - Sets the capacity to the actual number of elements. - - - - - Return the collection elements as an array - - the array - - - - is less than zero - -or- - is equal to or greater than . - - - - - is less than zero - -or- - is equal to or greater than . - - - - - Supports simple iteration over a . - - - - - - Initializes a new instance of the Enumerator class. - - - - - - Gets the current element in the collection. - - - - - Advances the enumerator to the next element in the collection. - - - true if the enumerator was successfully advanced to the next element; - false if the enumerator has passed the end of the collection. - - - The collection was modified after the enumerator was created. - - - - - Sets the enumerator to its initial position, before the first element in the collection. - - - - - - - - Abstract base class implementation of . - - - - This class provides the code for common functionality, such - as support for threshold filtering and support for general filters. - - - Appenders can also implement the interface. Therefore - they would require that the method - be called after the appenders properties have been configured. - - - Nicko Cadell - Gert Driesen - - - - Default constructor - - - Empty default constructor - - - - - Finalizes this appender by calling the implementation's - method. - - - - If this appender has not been closed then the Finalize method - will call . - - - - - - Gets or sets the threshold of this appender. - - - The threshold of the appender. - - - - All log events with lower level than the threshold level are ignored - by the appender. - - - In configuration files this option is specified by setting the - value of the option to a level - string, such as "DEBUG", "INFO" and so on. - - - - - - Gets or sets the for this appender. - - The of the appender - - - The provides a default - implementation for the property. - - - - - - The filter chain. - - The head of the filter chain filter chain. - - - Returns the head Filter. The Filters are organized in a linked list - and so all Filters on this Appender are available through the result. - - - - - - Gets or sets the for this appender. - - The layout of the appender. - - - See for more information. - - - - - - - Initialize the appender based on the options set - - - - This is part of the delayed object - activation scheme. The method must - be called on this object after the configuration properties have - been set. Until is called this - object is in an undefined state and must not be used. - - - If any of the configuration properties are modified then - must be called again. - - - - - - Gets or sets the name of this appender. - - The name of the appender. - - - The name uniquely identifies the appender. - - - - - - Closes the appender and release resources. - - - - Release any resources allocated within the appender such as file handles, - network connections, etc. - - - It is a programming error to append to a closed appender. - - - This method cannot be overridden by subclasses. This method - delegates the closing of the appender to the - method which must be overridden in the subclass. - - - - - - Performs threshold checks and invokes filters before - delegating actual logging to the subclasses specific - method. - - The event to log. - - - This method cannot be overridden by derived classes. A - derived class should override the method - which is called by this method. - - - The implementation of this method is as follows: - - - - - - Checks that the severity of the - is greater than or equal to the of this - appender. - - - - Checks that the chain accepts the - . - - - - - Calls and checks that - it returns true. - - - - - If all of the above steps succeed then the - will be passed to the abstract method. - - - - - - Performs threshold checks and invokes filters before - delegating actual logging to the subclasses specific - method. - - The array of events to log. - - - This method cannot be overridden by derived classes. A - derived class should override the method - which is called by this method. - - - The implementation of this method is as follows: - - - - - - Checks that the severity of the - is greater than or equal to the of this - appender. - - - - Checks that the chain accepts the - . - - - - - Calls and checks that - it returns true. - - - - - If all of the above steps succeed then the - will be passed to the method. - - - - - - Test if the logging event should we output by this appender - - the event to test - true if the event should be output, false if the event should be ignored - - - This method checks the logging event against the threshold level set - on this appender and also against the filters specified on this - appender. - - - The implementation of this method is as follows: - - - - - - Checks that the severity of the - is greater than or equal to the of this - appender. - - - - Checks that the chain accepts the - . - - - - - - - - - Adds a filter to the end of the filter chain. - - the filter to add to this appender - - - The Filters are organized in a linked list. - - - Setting this property causes the new filter to be pushed onto the - back of the filter chain. - - - - - - Clears the filter list for this appender. - - - - Clears the filter list for this appender. - - - - - - Checks if the message level is below this appender's threshold. - - to test against. - - - If there is no threshold set, then the return value is always true. - - - - true if the meets the - requirements of this appender. - - - - - Is called when the appender is closed. Derived classes should override - this method if resources need to be released. - - - - Releases any resources allocated within the appender such as file handles, - network connections, etc. - - - It is a programming error to append to a closed appender. - - - - - - Subclasses of should implement this method - to perform actual logging. - - The event to append. - - - A subclass must implement this method to perform - logging of the . - - This method will be called by - if all the conditions listed for that method are met. - - - To restrict the logging of events in the appender - override the method. - - - - - - Append a bulk array of logging events. - - the array of logging events - - - This base class implementation calls the - method for each element in the bulk array. - - - A sub class that can better process a bulk array of events should - override this method in addition to . - - - - - - Called before as a precondition. - - - - This method is called by - before the call to the abstract method. - - - This method can be overridden in a subclass to extend the checks - made before the event is passed to the method. - - - A subclass should ensure that they delegate this call to - this base class if it is overridden. - - - true if the call to should proceed. - - - - Renders the to a string. - - The event to render. - The event rendered as a string. - - - Helper method to render a to - a string. This appender must have a - set to render the to - a string. - - 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. - - - Where possible use the alternative version of this method - . - That method streams the rendering onto an existing Writer - which can give better performance if the caller already has - a open and ready for writing. - - - - - - Renders the to a string. - - The event to render. - The TextWriter to write the formatted event to - - - Helper method to render a to - a string. This appender must have a - set to render the to - a string. - - 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. - - - Use this method in preference to - where possible. If, however, the caller needs to render the event - to a string then does - provide an efficient mechanism for doing so. - - - - - - Tests if this appender requires a to be set. - - - - In the rather exceptional case, where the appender - implementation admits a layout but can also work without it, - then the appender should return true. - - - This default implementation always returns false. - - - - true if the appender requires a layout object, otherwise false. - - - - - Flushes any buffered log data. - - - This implementation doesn't flush anything and always returns true - - True if all logging events were flushed successfully, else false. - - - - The layout of this appender. - - - See for more information. - - - - - The name of this appender. - - - See for more information. - - - - - The level threshold of this appender. - - - - There is no level threshold filtering by default. - - - See for more information. - - - - - - It is assumed and enforced that errorHandler is never null. - - - - It is assumed and enforced that errorHandler is never null. - - - See for more information. - - - - - - The first filter in the filter chain. - - - - Set to null initially. - - - See for more information. - - - - - - The last filter in the filter chain. - - - See for more information. - - - - - Flag indicating if this appender is closed. - - - See for more information. - - - - - The guard prevents an appender from repeatedly calling its own DoAppend method - - - - - StringWriter used to render events - - - - - Initial buffer size - - - - - Maximum buffer size before it is recycled - - - - - The fully qualified type of the AppenderSkeleton class. - - - Used by the internal logger to record the Type of the - log message. - - - - - - Appends log events to the ASP.NET system. - - - - - 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. - - - 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. - - - The logging event is passed to the or - 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. - - - Nicko Cadell - Gert Driesen - Ron Grabowski - - - - Initializes a new instance of the class. - - - - Default constructor. - - - - - - Write the logging event to the ASP.NET trace - - the event to log - - - Write the logging event to the ASP.NET trace - HttpContext.Current.Trace - (). - - - - - - This appender requires a to be set. - - true - - - This appender requires a to be set. - - - - - - The category parameter sent to the Trace method. - - - - Defaults to %logger which will use the logger name of the current - as the category parameter. - - - - - - - - Defaults to %logger - - - - - Abstract base class implementation of that - buffers events in a fixed size buffer. - - - - This base class should be used by appenders that need to buffer a - number of events before logging them. - For example the - buffers events and then submits the entire contents of the buffer to - the underlying database in one go. - - - Subclasses should override the - method to deliver the buffered events. - - The BufferingAppenderSkeleton maintains a fixed size cyclic - buffer of events. The size of the buffer is set using - the property. - - A is used to inspect - each event as it arrives in the appender. If the - triggers, then the current buffer is sent immediately - (see ). 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. - - - The buffering appender can be configured in a mode. - By default the appender is NOT lossy. When the buffer is full all - the buffered events are sent with . - If the property is set to true 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 - 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. - - - Nicko Cadell - Gert Driesen - - - - Initializes a new instance of the class. - - - - Protected default constructor to allow subclassing. - - - - - - Initializes a new instance of the class. - - the events passed through this appender must be - fixed by the time that they arrive in the derived class' SendBuffer method. - - - Protected constructor to allow subclassing. - - - The should be set if the subclass - expects the events delivered to be fixed even if the - is set to zero, i.e. when no buffering occurs. - - - - - - Gets or sets a value that indicates whether the appender is lossy. - - - true if the appender is lossy, otherwise false. The default is false. - - - - 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 - to false to prevent logging events - from being lost. - - If is set to true then an - must be specified. - - - - - Gets or sets the size of the cyclic buffer used to hold the - logging events. - - - The size of the cyclic buffer used to hold the logging events. - - - - The option takes a positive integer - representing the maximum number of logging events to collect in - a cyclic buffer. When the 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. - - - If the 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 - and properties). Otherwise the event will - be buffered. - - - - - - Gets or sets the that causes the - buffer to be sent immediately. - - - The that causes the buffer to be - sent immediately. - - - - 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 ). - - If is set to true then an - must be specified. - - - - - Gets or sets the value of the to use. - - - The value of the to use. - - - - 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 ). - - - - - - Gets or sets a value indicating if only part of the logging event data - should be fixed. - - - true if the appender should only fix part of the logging event - data, otherwise false. The default is false. - - - - Setting this property to true will cause only part of the - event data to be fixed and serialized. This will improve performance. - - - See for more information. - - - - - - Gets or sets a the fields that will be fixed in the event - - - The event fields that will be fixed before the event is buffered - - - - The logging event needs to have certain thread specific values - captured before it can be buffered. See - for details. - - - - - - - Flushes any buffered log data. - - The maximum time to wait for logging events to be flushed. - True if all logging events were flushed successfully, else false. - - - - Flush the currently buffered events - - - - Flushes any events that have been buffered. - - - If the appender is buffering in mode then the contents - of the buffer will NOT be flushed to the appender. - - - - - - Flush the currently buffered events - - set to true to flush the buffer of lossy events - - - Flushes events that have been buffered. If is - false then events will only be flushed if this buffer is non-lossy mode. - - - If the appender is buffering in mode then the contents - of the buffer will only be flushed if is true. - In this case the contents of the buffer will be tested against the - and if triggering will be output. All other buffered - events will be discarded. - - - If is true then the buffer will always - be emptied by calling this method. - - - - - - Initialize the appender based on the options set - - - - This is part of the delayed object - activation scheme. The method must - be called on this object after the configuration properties have - been set. Until is called this - object is in an undefined state and must not be used. - - - If any of the configuration properties are modified then - must be called again. - - - - - - Close this appender instance. - - - - Close this appender instance. If this appender is marked - as not then the remaining events in - the buffer must be sent when the appender is closed. - - - - - - This method is called by the method. - - the event to log - - - Stores the in the cyclic buffer. - - - The buffer will be sent (i.e. passed to the - method) if one of the following conditions is met: - - - - The cyclic buffer is full and this appender is - marked as not lossy (see ) - - - An is set and - it is triggered for the - specified. - - - - Before the event is stored in the buffer it is fixed - (see ) to ensure that - any data referenced by the event will be valid when the buffer - is processed. - - - - - - Sends the contents of the buffer. - - The first logging event. - The buffer containing the events that need to be send. - - - The subclass must override . - - - - - - Sends the events. - - The events that need to be send. - - - The subclass must override this method to process the buffered events. - - - - - - The default buffer size. - - - The default size of the cyclic buffer used to store events. - This is set to 512 by default. - - - - - The size of the cyclic buffer used to hold the logging events. - - - Set to by default. - - - - - The cyclic buffer used to store the logging events. - - - - - The triggering event evaluator that causes the buffer to be sent immediately. - - - The object that is used to determine if an event causes the entire - buffer to be sent immediately. This field can be null, which - indicates that event triggering is not to be done. The evaluator - can be set using the property. If this appender - has the ( property) set to - true then an must be set. - - - - - 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. - - - If this field is set to true then an must - be set. - - - - - The triggering event evaluator filters discarded events. - - - 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 null, which indicates that all discarded events will - be discarded. - - - - - Value indicating which fields in the event should be fixed - - - By default all fields are fixed - - - - - The events delivered to the subclass must be fixed. - - - - - Buffers events and then forwards them to attached appenders. - - - - The events are buffered in this appender until conditions are - met to allow the appender to deliver the events to the attached - appenders. See for the - conditions that cause the buffer to be sent. - - The forwarding appender can be used to specify different - thresholds and filters for the same appender at different locations - within the hierarchy. - - - Nicko Cadell - Gert Driesen - - - - Initializes a new instance of the class. - - - - Default constructor. - - - - - - Closes the appender and releases resources. - - - - Releases any resources allocated within the appender such as file handles, - network connections, etc. - - - It is a programming error to append to a closed appender. - - - - - - Send the events. - - The events that need to be send. - - - Forwards the events to the attached appenders. - - - - - - Adds an to the list of appenders of this - instance. - - The to add to this appender. - - - If the specified is already in the list of - appenders, then it won't be added again. - - - - - - Gets the appenders contained in this appender as an - . - - - If no appenders can be found, then an - is returned. - - - A collection of the appenders in this appender. - - - - - Looks for the appender with the specified name. - - The name of the appender to lookup. - - The appender with the specified name, or null. - - - - Get the named appender attached to this buffering appender. - - - - - - Removes all previously added appenders from this appender. - - - - This is useful when re-reading configuration information. - - - - - - Removes the specified appender from the list of appenders. - - The appender to remove. - The appender removed from the list - - The appender removed is not closed. - If you are discarding the appender you must call - on the appender removed. - - - - - Removes the appender with the specified name from the list of appenders. - - The name of the appender to remove. - The appender removed from the list - - The appender removed is not closed. - If you are discarding the appender you must call - on the appender removed. - - - - - Implementation of the interface - - - - - Appends logging events to the console. - - - - 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. - - - By default, all output is written to the console's standard output stream. - The property can be set to direct the output to the - error stream. - - - NOTE: This appender writes directly to the application's attached console - not to the System.Console.Out or System.Console.Error TextWriter. - The System.Console.Out and System.Console.Error 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 - must be used. - - - When configuring the colored console appender, mapping should be - specified to map a logging level to a color. For example: - - - - - - - - - - - - - - The Level is the standard log4net logging level and ForeColor and BackColor can be any - combination of the following values: - - Blue - Green - Red - White - Yellow - Purple - Cyan - HighIntensity - - - - Rick Hobbs - Nicko Cadell - - - - The enum of possible color values for use with the color mapping method - - - - The following flags can be combined together to - form the colors. - - - - - - - color is blue - - - - - color is green - - - - - color is red - - - - - color is white - - - - - color is yellow - - - - - color is purple - - - - - color is cyan - - - - - color is intensified - - - - - Initializes a new instance of the class. - - - The instance of the class is set up to write - to the standard output stream. - - - - - Initializes a new instance of the class - with the specified layout. - - the layout to use for this appender - - The instance of the class is set up to write - to the standard output stream. - - - - - Initializes a new instance of the class - with the specified layout. - - the layout to use for this appender - flag set to true to write to the console error stream - - When is set to true, output is written to - the standard error output stream. Otherwise, output is written to the standard - output stream. - - - - - Target is the value of the console output stream. - This is either "Console.Out" or "Console.Error". - - - Target is the value of the console output stream. - This is either "Console.Out" or "Console.Error". - - - - Target is the value of the console output stream. - This is either "Console.Out" or "Console.Error". - - - - - - Add a mapping of level to color - done by the config file - - The mapping to add - - - Add a mapping to this appender. - Each mapping defines the foreground and background colors - for a level. - - - - - - This method is called by the method. - - The event to log. - - - Writes the event to the console. - - - The format of the output will depend on the appender's layout. - - - - - - This appender requires a to be set. - - true - - - This appender requires a to be set. - - - - - - Initialize the options for this appender - - - - Initialize the level to color mappings set on this appender. - - - - - - The to use when writing to the Console - standard output stream. - - - - The to use when writing to the Console - standard output stream. - - - - - - The to use when writing to the Console - standard error output stream. - - - - The to use when writing to the Console - standard error output stream. - - - - - - Flag to write output to the error stream rather than the standard output stream - - - - - Mapping from level object to color value - - - - - The console output stream writer to write to - - - - This writer is not thread safe. - - - - - - 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. - - - - Defines the mapping between a level and the color it should be displayed in. - - - - - - The mapped foreground color for the specified level - - - - Required property. - The mapped foreground color for the specified level. - - - - - - The mapped background color for the specified level - - - - Required property. - The mapped background color for the specified level. - - - - - - Initialize the options for the object - - - - Combine the and together. - - - - - - The combined and suitable for - setting the console color. - - - - - Appends logging events to the console. - - - - ConsoleAppender appends log events to the standard output stream - or the error output stream using a layout specified by the - user. - - - By default, all output is written to the console's standard output stream. - The property can be set to direct the output to the - error stream. - - - NOTE: This appender writes each message to the System.Console.Out or - System.Console.Error 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. - - - Nicko Cadell - Gert Driesen - - - - Initializes a new instance of the class. - - - The instance of the class is set up to write - to the standard output stream. - - - - - Initializes a new instance of the class - with the specified layout. - - the layout to use for this appender - - The instance of the class is set up to write - to the standard output stream. - - - - - Initializes a new instance of the class - with the specified layout. - - the layout to use for this appender - flag set to true to write to the console error stream - - When is set to true, output is written to - the standard error output stream. Otherwise, output is written to the standard - output stream. - - - - - Target is the value of the console output stream. - This is either "Console.Out" or "Console.Error". - - - Target is the value of the console output stream. - This is either "Console.Out" or "Console.Error". - - - - Target is the value of the console output stream. - This is either "Console.Out" or "Console.Error". - - - - - - This method is called by the method. - - The event to log. - - - Writes the event to the console. - - - The format of the output will depend on the appender's layout. - - - - - - This appender requires a to be set. - - true - - - This appender requires a to be set. - - - - - - The to use when writing to the Console - standard output stream. - - - - The to use when writing to the Console - standard output stream. - - - - - - The to use when writing to the Console - standard error output stream. - - - - The to use when writing to the Console - standard error output stream. - - - - - - Appends log events to the system. - - - - The application configuration file can be used to control what listeners - are actually used. See the MSDN documentation for the - class for details on configuring the - debug system. - - - Events are written using the - method. The event's logger name is passed as the value for the category name to the Write method. - - - Nicko Cadell - - - - Initializes a new instance of the . - - - - Default constructor. - - - - - - Initializes a new instance of the - with a specified layout. - - The layout to use with this appender. - - - Obsolete constructor. - - - - - - Gets or sets a value that indicates whether the appender will - flush at the end of each write. - - - The default behavior is to flush at the end of each - write. If the option is set tofalse, then the underlying - stream can defer writing to physical medium to a later time. - - - 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. - - - - - - Formats the category parameter sent to the Debug method. - - - - Defaults to a with %logger as the pattern which will use the logger name of the current - as the category parameter. - - - - - - - - Flushes any buffered log data. - - The maximum time to wait for logging events to be flushed. - True if all logging events were flushed successfully, else false. - - - - Writes the logging event to the system. - - The event to log. - - - Writes the logging event to the system. - If is true then the - is called. - - - - - - This appender requires a to be set. - - true - - - This appender requires a to be set. - - - - - - Immediate flush means that the underlying writer or output stream - will be flushed at the end of each append operation. - - - - Immediate flush is slower but ensures that each append request is - actually written. If is set to - false, 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. - - - The default value is true. - - - - - Defaults to a with %logger as the pattern. - - - - - Writes events to the system event log. - - - - 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 - - - The EventID of the event log entry can be - set using the EventID property () - on the . - - - The Category of the event log entry can be - set using the Category property () - on the . - - - There is a limit of 32K characters for an event log message - - - When configuring the EventLogAppender a mapping can be - specified to map a logging level to an event log entry type. For example: - - - <mapping> - <level value="ERROR" /> - <eventLogEntryType value="Error" /> - </mapping> - <mapping> - <level value="DEBUG" /> - <eventLogEntryType value="Information" /> - </mapping> - - - The Level is the standard log4net logging level and eventLogEntryType can be any value - from the enum, i.e.: - - Erroran error event - Warninga warning event - Informationan informational event - - - - Aspi Havewala - Douglas de la Torre - Nicko Cadell - Gert Driesen - Thomas Voss - - - - Initializes a new instance of the class. - - - - Default constructor. - - - - - - Initializes a new instance of the class - with the specified . - - The to use with this appender. - - - Obsolete constructor. - - - - - - The name of the log where messages will be stored. - - - The string name of the log where messages will be stored. - - - This is the name of the log as it appears in the Event Viewer - tree. The default value is to log into the Application - 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 appropriately. - This should not be used to distinguish your event log messages - from those of other applications, the - property should be used to distinguish events. This property should be - used to group together events into a single log. - - - - - - Property used to set the Application name. This appears in the - event logs when logging. - - - The string used to distinguish events from different sources. - - - Sets the event log source property. - - - - - 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 "." - - - The string name of the machine holding the event log that - will be logged into. - - - This property cannot be changed. It is currently set to '.' - i.e. the local machine. This may be changed in future. - - - - - Add a mapping of level to - done by the config file - - The mapping to add - - - Add a mapping to this appender. - Each mapping defines the event log entry type for a level. - - - - - - Gets or sets the used to write to the EventLog. - - - The used to write to the EventLog. - - - - The system security context used to write to the EventLog. - - - Unless a specified here for this appender - the is queried for the - security context to use. The default behavior is to use the security context - of the current thread. - - - - - - Gets or sets the EventId to use unless one is explicitly specified via the LoggingEvent's properties. - - - - The EventID of the event log entry will normally be - set using the EventID property () - on the . - This property provides the fallback value which defaults to 0. - - - - - - Gets or sets the Category to use unless one is explicitly specified via the LoggingEvent's properties. - - - - The Category of the event log entry will normally be - set using the Category property () - on the . - This property provides the fallback value which defaults to 0. - - - - - - Initialize the appender based on the options set - - - - This is part of the delayed object - activation scheme. The method must - be called on this object after the configuration properties have - been set. Until is called this - object is in an undefined state and must not be used. - - - If any of the configuration properties are modified then - must be called again. - - - - - - Create an event log source - - - Uses different API calls under NET_2_0 - - - - - This method is called by the - method. - - the event to log - - Writes the event to the system event log using the - . - - If the event has an EventID property (see ) - set then this integer will be used as the event log event id. - - - There is a limit of 32K characters for an event log message - - - - - - This appender requires a to be set. - - true - - - This appender requires a to be set. - - - - - - Get the equivalent for a - - the Level to convert to an EventLogEntryType - The equivalent for a - - Because there are fewer applicable - values to use in logging levels than there are in the - this is a one way mapping. There is - a loss of information during the conversion. - - - - - The log name is the section in the event logs where the messages - are stored. - - - - - Name of the application to use when logging. This appears in the - application column of the event log named by . - - - - - The name of the machine which holds the event log. This is - currently only allowed to be '.' i.e. the current machine. - - - - - Mapping from level object to EventLogEntryType - - - - - The security context to use for privileged calls - - - - - The event ID to use unless one is explicitly specified via the LoggingEvent's properties. - - - - - The event category to use unless one is explicitly specified via the LoggingEvent's properties. - - - - - 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. - - - - Defines the mapping between a level and its event log entry type. - - - - - - The for this entry - - - - Required property. - The for this entry - - - - - - The fully qualified type of the EventLogAppender class. - - - Used by the internal logger to record the Type of the - log message. - - - - - The maximum size supported by default. - - - 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. - - - - - The maximum size supported by a windows operating system that is vista - or newer. - - - 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). - - - - - The maximum size that the operating system supports for - a event log message. - - - 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. - - - - - This method determines the maximum event log message size allowed for - the current environment. - - - - - - Appends logging events to a file. - - - - Logging events are sent to the file specified by - the property. - - - The file can be opened in either append or overwrite mode - by specifying the 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 property. - - - The layout's and - values will be written each time the file is opened and closed - respectively. If the property is - then the file may contain multiple copies of the header and footer. - - - This appender will first try to open the file for writing when - 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. - - - The supports pluggable file locking models via - the property. - The default behavior, implemented by - 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 () - or synchronize by using a named system wide Mutex (). - - - All locking strategies have issues and you should seriously consider using a different strategy that - avoids having multiple processes logging to the same file. - - - Nicko Cadell - Gert Driesen - Rodrigo B. de Oliveira - Douglas de la Torre - Niall Daley - - - - Write only that uses the - to manage access to an underlying resource. - - - - - True asynchronous writes are not supported, the implementation forces a synchronous write. - - - - - Locking model base class - - - - Base class for the locking models available to the derived loggers. - - - - - - Open the output file - - The filename to use - Whether to append to the file, or overwrite - The encoding to use - - - Open the file specified and prepare for logging. - No writes will be made until is called. - Must be called before any calls to , - and . - - - - - - Close the file - - - - Close the file. No further writes will be made. - - - - - - Initializes all resources used by this locking model. - - - - - Disposes all resources that were initialized by this locking model. - - - - - Acquire the lock on the file - - A stream that is ready to be written to. - - - Acquire the lock on the file in preparation for writing to it. - Return a stream pointing to the file. - must be called to release the lock on the output file. - - - - - - Release the lock on the file - - - - Release the lock on the file. No further writes will be made to the - stream until is called again. - - - - - - Gets or sets the for this LockingModel - - - The for this LockingModel - - - - The file appender this locking model is attached to and working on - behalf of. - - - The file appender is used to locate the security context and the error handler to use. - - - The value of this property will be set before is - called. - - - - - - Helper method that creates a FileStream under CurrentAppender's SecurityContext. - - - - Typically called during OpenFile or AcquireLock. - - - If the directory portion of the does not exist, it is created - via Directory.CreateDirecctory. - - - - - - - - - - Helper method to close under CurrentAppender's SecurityContext. - - - Does not set to null. - - - - - - Hold an exclusive lock on the output file - - - - Open the file once for writing and hold it open until is called. - Maintains an exclusive lock on the file during this time. - - - - - - Open the file specified and prepare for logging. - - The filename to use - Whether to append to the file, or overwrite - The encoding to use - - - Open the file specified and prepare for logging. - No writes will be made until is called. - Must be called before any calls to , - and . - - - - - - Close the file - - - - Close the file. No further writes will be made. - - - - - - Acquire the lock on the file - - A stream that is ready to be written to. - - - Does nothing. The lock is already taken - - - - - - Release the lock on the file - - - - Does nothing. The lock will be released when the file is closed. - - - - - - Initializes all resources used by this locking model. - - - - - Disposes all resources that were initialized by this locking model. - - - - - Acquires the file lock for each write - - - - Opens the file once for each / cycle, - thus holding the lock for the minimal amount of time. This method of locking - is considerably slower than but allows - other processes to move/delete the log file whilst logging continues. - - - - - - Prepares to open the file when the first message is logged. - - The filename to use - Whether to append to the file, or overwrite - The encoding to use - - - Open the file specified and prepare for logging. - No writes will be made until is called. - Must be called before any calls to , - and . - - - - - - Close the file - - - - Close the file. No further writes will be made. - - - - - - Acquire the lock on the file - - A stream that is ready to be written to. - - - Acquire the lock on the file in preparation for writing to it. - Return a stream pointing to the file. - must be called to release the lock on the output file. - - - - - - Release the lock on the file - - - - Release the lock on the file. No further writes will be made to the - stream until is called again. - - - - - - Initializes all resources used by this locking model. - - - - - Disposes all resources that were initialized by this locking model. - - - - - Provides cross-process file locking. - - Ron Grabowski - Steve Wranovsky - - - - Open the file specified and prepare for logging. - - The filename to use - Whether to append to the file, or overwrite - The encoding to use - - - Open the file specified and prepare for logging. - No writes will be made until is called. - Must be called before any calls to , - - and . - - - - - - Close the file - - - - Close the file. No further writes will be made. - - - - - - Acquire the lock on the file - - A stream that is ready to be written to. - - - Does nothing. The lock is already taken - - - - - - Releases the lock and allows others to acquire a lock. - - - - - Initializes all resources used by this locking model. - - - - - Disposes all resources that were initialized by this locking model. - - - - - Default constructor - - - - Default constructor - - - - - - Construct a new appender using the layout, file and append mode. - - the layout to use with this appender - the full path to the file to write to - flag to indicate if the file should be appended to - - - Obsolete constructor. - - - - - - Construct a new appender using the layout and file specified. - The file will be appended to. - - the layout to use with this appender - the full path to the file to write to - - - Obsolete constructor. - - - - - - Gets or sets the path to the file that logging will be written to. - - - The path to the file that logging will be written to. - - - - If the path is relative it is taken as relative from - the application base directory. - - - - - - Gets or sets a flag that indicates whether the file should be - appended to or overwritten. - - - Indicates whether the file should be appended to or overwritten. - - - - 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. - - The default value is true. - - - - - Gets or sets used to write to the file. - - - The used to write to the file. - - - - The default encoding set is - which is the encoding for the system's current ANSI code page. - - - - - - Gets or sets the used to write to the file. - - - The used to write to the file. - - - - Unless a specified here for this appender - the is queried for the - security context to use. The default behavior is to use the security context - of the current thread. - - - - - - Gets or sets the used to handle locking of the file. - - - The used to lock the file. - - - - Gets or sets the used to handle locking of the file. - - - There are three built in locking models, , and . - 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. - - - The default locking model is the . - - - - - - Activate the options on the file appender. - - - - This is part of the delayed object - activation scheme. The method must - be called on this object after the configuration properties have - been set. Until is called this - object is in an undefined state and must not be used. - - - If any of the configuration properties are modified then - must be called again. - - - This will cause the file to be opened. - - - - - - Closes any previously opened file and calls the parent's . - - - - Resets the filename and the file stream. - - - - - - Close this appender instance. The underlying stream or writer is also closed. - - - - - Called to initialize the file writer - - - - Will be called for each logged message until the file is - successfully opened. - - - - - - This method is called by the - method. - - The event to log. - - - Writes a log statement to the output stream if the output stream exists - and is writable. - - - The format of the output will depend on the appender's layout. - - - - - - This method is called by the - method. - - The array of events to log. - - - Acquires the output file locks once before writing all the events to - the stream. - - - - - - Writes a footer as produced by the embedded layout's property. - - - - Writes a footer as produced by the embedded layout's property. - - - - - - Writes a header produced by the embedded layout's property. - - - - Writes a header produced by the embedded layout's property. - - - - - - Closes the underlying . - - - - Closes the underlying . - - - - - - Closes the previously opened file. - - - - Writes the to the file and then - closes the file. - - - - - - Sets and opens the file where the log output will go. The specified file must be writable. - - The path to the log file. Must be a fully qualified path. - If true will append to fileName. Otherwise will truncate fileName - - - Calls but guarantees not to throw an exception. - Errors are passed to the . - - - - - - Sets and opens the file where the log output will go. The specified file must be writable. - - The path to the log file. Must be a fully qualified path. - If true will append to fileName. Otherwise will truncate fileName - - - If there was already an opened file, then the previous file - is closed first. - - - This method will ensure that the directory structure - for the specified exists. - - - - - - Sets the quiet writer used for file output - - the file stream that has been opened for writing - - - This implementation of creates a - over the and passes it to the - method. - - - This method can be overridden by sub classes that want to wrap the - in some way, for example to encrypt the output - data using a System.Security.Cryptography.CryptoStream. - - - - - - Sets the quiet writer being used. - - the writer over the file stream that has been opened for writing - - - This method can be overridden by sub classes that want to - wrap the in some way. - - - - - - Convert a path into a fully qualified path. - - The path to convert. - The fully qualified path. - - - Converts the path specified to a fully - qualified path. If the path is relative it is - taken as relative from the application base - directory. - - - - - - Flag to indicate if we should append to the file - or overwrite the file. The default is to append. - - - - - The name of the log file. - - - - - The encoding to use for the file stream. - - - - - The security context to use for privileged calls - - - - - The stream to log to. Has added locking semantics - - - - - The locking model to use - - - - - The fully qualified type of the FileAppender class. - - - Used by the internal logger to record the Type of the - log message. - - - - - This appender forwards logging events to attached appenders. - - - - The forwarding appender can be used to specify different thresholds - and filters for the same appender at different locations within the hierarchy. - - - Nicko Cadell - Gert Driesen - - - - Initializes a new instance of the class. - - - - Default constructor. - - - - - - Closes the appender and releases resources. - - - - Releases any resources allocated within the appender such as file handles, - network connections, etc. - - - It is a programming error to append to a closed appender. - - - - - - Forward the logging event to the attached appenders - - The event to log. - - - Delivers the logging event to all the attached appenders. - - - - - - Forward the logging events to the attached appenders - - The array of events to log. - - - Delivers the logging events to all the attached appenders. - - - - - - Adds an to the list of appenders of this - instance. - - The to add to this appender. - - - If the specified is already in the list of - appenders, then it won't be added again. - - - - - - Gets the appenders contained in this appender as an - . - - - If no appenders can be found, then an - is returned. - - - A collection of the appenders in this appender. - - - - - Looks for the appender with the specified name. - - The name of the appender to lookup. - - The appender with the specified name, or null. - - - - Get the named appender attached to this appender. - - - - - - Removes all previously added appenders from this appender. - - - - This is useful when re-reading configuration information. - - - - - - Removes the specified appender from the list of appenders. - - The appender to remove. - The appender removed from the list - - The appender removed is not closed. - If you are discarding the appender you must call - on the appender removed. - - - - - Removes the appender with the specified name from the list of appenders. - - The name of the appender to remove. - The appender removed from the list - - The appender removed is not closed. - If you are discarding the appender you must call - on the appender removed. - - - - - Implementation of the interface - - - - - Implement this interface for your own strategies for printing log statements. - - - - Implementors should consider extending the - class which provides a default implementation of this interface. - - - Appenders can also implement the interface. Therefore - they would require that the method - be called after the appenders properties have been configured. - - - Nicko Cadell - Gert Driesen - - - - Closes the appender and releases resources. - - - - Releases any resources allocated within the appender such as file handles, - network connections, etc. - - - It is a programming error to append to a closed appender. - - - - - - Log the logging event in Appender specific way. - - The event to log - - - This method is called to log a message into this appender. - - - - - - Gets or sets the name of this appender. - - The name of the appender. - - The name uniquely identifies the appender. - - - - - Interface for appenders that support bulk logging. - - - - This interface extends the interface to - support bulk logging of objects. Appenders - should only implement this interface if they can bulk log efficiently. - - - Nicko Cadell - - - - Log the array of logging events in Appender specific way. - - The events to log - - - This method is called to log an array of events into this appender. - - - - - - Interface that can be implemented by Appenders that buffer logging data and expose a method. - - - - - Flushes any buffered log data. - - - Appenders that implement the method must do so in a thread-safe manner: it can be called concurrently with - the method. - - Typically this is done by locking on the Appender instance, e.g.: - - - - - - The parameter is only relevant for appenders that process logging events asynchronously, - such as . - - - The maximum time to wait for logging events to be flushed. - True if all logging events were flushed successfully, else false. - - - - Logs events to a local syslog service. - - - - This appender uses the POSIX libc library functions openlog, syslog, and closelog. - If these functions are not available on the local system then this appender will not work! - - - The functions openlog, syslog, and closelog are specified in SUSv2 and - POSIX 1003.1-2001 standards. These are used to log messages to the local syslog service. - - - 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 to log via UDP. - - - 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 - values. The facilities list is predefined - and cannot be extended. - - - An identifier is specified with each log message. This can be specified - by setting the property. The identity (also know - as the tag) must not contain white space. The default value for the - identity is the application name (from ). - - - Rob Lyon - Nicko Cadell - - - - syslog severities - - - - The log4net Level maps to a syslog severity using the - method and the - class. The severity is set on . - - - - - - system is unusable - - - - - action must be taken immediately - - - - - critical conditions - - - - - error conditions - - - - - warning conditions - - - - - normal but significant condition - - - - - informational - - - - - debug-level messages - - - - - syslog facilities - - - - The syslog facility defines which subsystem the logging comes from. - This is set on the property. - - - - - - kernel messages - - - - - random user-level messages - - - - - mail system - - - - - system daemons - - - - - security/authorization messages - - - - - messages generated internally by syslogd - - - - - line printer subsystem - - - - - network news subsystem - - - - - UUCP subsystem - - - - - clock (cron/at) daemon - - - - - security/authorization messages (private) - - - - - ftp daemon - - - - - NTP subsystem - - - - - log audit - - - - - log alert - - - - - clock daemon - - - - - reserved for local use - - - - - reserved for local use - - - - - reserved for local use - - - - - reserved for local use - - - - - reserved for local use - - - - - reserved for local use - - - - - reserved for local use - - - - - reserved for local use - - - - - Initializes a new instance of the class. - - - This instance of the class is set up to write - to a local syslog service. - - - - - Message identity - - - - An identifier is specified with each log message. This can be specified - by setting the property. The identity (also know - as the tag) must not contain white space. The default value for the - identity is the application name (from ). - - - - - - Syslog facility - - - Set to one of the values. The list of - facilities is predefined and cannot be extended. The default value - is . - - - - - Add a mapping of level to severity - - The mapping to add - - - Adds a to this appender. - - - - - - Initialize the appender based on the options set. - - - - This is part of the delayed object - activation scheme. The method must - be called on this object after the configuration properties have - been set. Until is called this - object is in an undefined state and must not be used. - - - If any of the configuration properties are modified then - must be called again. - - - - - - This method is called by the method. - - The event to log. - - - Writes the event to a remote syslog daemon. - - - The format of the output will depend on the appender's layout. - - - - - - Close the syslog when the appender is closed - - - - Close the syslog when the appender is closed - - - - - - This appender requires a to be set. - - true - - - This appender requires a to be set. - - - - - - Translates a log4net level to a syslog severity. - - A log4net level. - A syslog severity. - - - Translates a log4net level to a syslog severity. - - - - - - Generate a syslog priority. - - The syslog facility. - The syslog severity. - A syslog priority. - - - - The facility. The default facility is . - - - - - The message identity - - - - - Marshaled handle to the identity string. We have to hold on to the - string as the openlog and syslog APIs just hold the - pointer to the ident and dereference it for each log message. - - - - - Mapping from level object to syslog severity - - - - - Open connection to system logger. - - - - - Generate a log message. - - - - 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 "%s". - - - - - - Close descriptor used to write to system logger. - - - - - 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. - - - - 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. - - - - - - The mapped syslog severity for the specified level - - - - Required property. - The mapped syslog severity for the specified level - - - - - - Appends colorful logging events to the console, using the .NET 2 - built-in capabilities. - - - - 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. - - - By default, all output is written to the console's standard output stream. - The property can be set to direct the output to the - error stream. - - - When configuring the colored console appender, mappings should be - specified to map logging levels to colors. For example: - - - - - - - - - - - - - - - - - - - - - - The Level is the standard log4net logging level while - ForeColor and BackColor are the values of - enumeration. - - - Based on the ColoredConsoleAppender - - - Rick Hobbs - Nicko Cadell - Pavlos Touboulidis - - - - Initializes a new instance of the class. - - - The instance of the class is set up to write - to the standard output stream. - - - - - Target is the value of the console output stream. - This is either "Console.Out" or "Console.Error". - - - Target is the value of the console output stream. - This is either "Console.Out" or "Console.Error". - - - - Target is the value of the console output stream. - This is either "Console.Out" or "Console.Error". - - - - - - Add a mapping of level to color - done by the config file - - The mapping to add - - - Add a mapping to this appender. - Each mapping defines the foreground and background colors - for a level. - - - - - - This method is called by the method. - - The event to log. - - - Writes the event to the console. - - - The format of the output will depend on the appender's layout. - - - - - - This appender requires a to be set. - - true - - - This appender requires a to be set. - - - - - - Initialize the options for this appender - - - - Initialize the level to color mappings set on this appender. - - - - - - The to use when writing to the Console - standard output stream. - - - - The to use when writing to the Console - standard output stream. - - - - - - The to use when writing to the Console - standard error output stream. - - - - The to use when writing to the Console - standard error output stream. - - - - - - Flag to write output to the error stream rather than the standard output stream - - - - - Mapping from level object to color value - - - - - 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. - - - - Defines the mapping between a level and the color it should be displayed in. - - - - - - The mapped foreground color for the specified level - - - - Required property. - The mapped foreground color for the specified level. - - - - - - The mapped background color for the specified level - - - - Required property. - The mapped background color for the specified level. - - - - - - Stores logging events in an array. - - - - The memory appender stores all the logging events - that are appended in an in-memory array. - - - Use the method to get - and clear the current list of events that have been appended. - - - Use the method to get the current - list of events that have been appended. Note there is a - race-condition when calling and - in pairs, you better use in that case. - - - Use the method to clear the - current list of events. Note there is a - race-condition when calling and - in pairs, you better use in that case. - - - Julian Biddle - Nicko Cadell - Gert Driesen - - - - Initializes a new instance of the class. - - - - Default constructor. - - - - - - Gets the events that have been logged. - - The events that have been logged - - - Gets the events that have been logged. - - - - - - Gets or sets a value indicating whether only part of the logging event - data should be fixed. - - - true if the appender should only fix part of the logging event - data, otherwise false. The default is false. - - - - Setting this property to true will cause only part of the event - data to be fixed and stored in the appender, hereby improving performance. - - - See for more information. - - - - - - Gets or sets the fields that will be fixed in the event - - - - The logging event needs to have certain thread specific values - captured before it can be buffered. See - for details. - - - - - - This method is called by the method. - - the event to log - - Stores the in the events list. - - - - - Clear the list of events - - - Clear the list of events - - - - - Gets the events that have been logged and clears the list of events. - - The events that have been logged - - - Gets the events that have been logged and clears the list of events. - - - - - - The list of events that have been appended. - - - - - Value indicating which fields in the event should be fixed - - - By default all fields are fixed - - - - - Logs entries by sending network messages using the - native function. - - - - 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. - - - 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. - - - The following table lists some possible uses for this appender : - - - - - Action - Property Value(s) - - - Send a message to a user account on the local machine - - - = <name of the local machine> - - - = <user name> - - - - - Send a message to a user account on a remote machine - - - = <name of the remote machine> - - - = <user name> - - - - - Send a message to a domain user account - - - = <name of a domain controller | uninitialized> - - - = <user name> - - - - - Send a message to all the names in a workgroup or domain - - - = <workgroup name | domain name>* - - - - - Send a message from the local machine to a remote machine - - - = <name of the local machine | uninitialized> - - - = <name of the remote machine> - - - - - - - Note : security restrictions apply for sending - network messages, see - for more information. - - - - - An example configuration section to log information - using this appender from the local machine, named - LOCAL_PC, to machine OPERATOR_PC : - - - - - - - - - - Nicko Cadell - Gert Driesen - - - - The DNS or NetBIOS name of the server on which the function is to execute. - - - - - The sender of the network message. - - - - - The message alias to which the message should be sent. - - - - - The security context to use for privileged calls - - - - - Initializes the appender. - - - The default constructor initializes all fields to their default values. - - - - - Gets or sets the sender of the message. - - - The sender of the message. - - - If this property is not specified, the message is sent from the local computer. - - - - - Gets or sets the message alias to which the message should be sent. - - - The recipient of the message. - - - This property should always be specified in order to send a message. - - - - - Gets or sets the DNS or NetBIOS name of the remote server on which the function is to execute. - - - DNS or NetBIOS name of the remote server on which the function is to execute. - - - - For Windows NT 4.0 and earlier, the string should begin with \\. - - - If this property is not specified, the local computer is used. - - - - - - Gets or sets the used to call the NetSend method. - - - The used to call the NetSend method. - - - - Unless a specified here for this appender - the is queried for the - security context to use. The default behavior is to use the security context - of the current thread. - - - - - - Initialize the appender based on the options set. - - - - This is part of the delayed object - activation scheme. The method must - be called on this object after the configuration properties have - been set. Until is called this - object is in an undefined state and must not be used. - - - If any of the configuration properties are modified then - must be called again. - - - The appender will be ignored if no was specified. - - - The required property was not specified. - - - - This method is called by the method. - - The event to log. - - - Sends the event using a network message. - - - - - - This appender requires a to be set. - - true - - - This appender requires a to be set. - - - - - - Sends a buffer of information to a registered message alias. - - The DNS or NetBIOS name of the server on which the function is to execute. - The message alias to which the message buffer should be sent - The originator of the message. - The message text. - The length, in bytes, of the message text. - - - The following restrictions apply for sending network messages: - - - - - Platform - Requirements - - - Windows NT - - - No special group membership is required to send a network message. - - - Admin, Accounts, Print, or Server Operator group membership is required to - successfully send a network message on a remote server. - - - - - Windows 2000 or later - - - 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. - - - On a member server or workstation, only Administrators and Server Operators can send a network message. - - - - - - - For more information see Security Requirements for the Network Management Functions. - - - - - If the function succeeds, the return value is zero. - - - - - - Appends log events to the OutputDebugString system. - - - - OutputDebugStringAppender appends log events to the - OutputDebugString system. - - - The string is passed to the native OutputDebugString - function. - - - Nicko Cadell - Gert Driesen - - - - Initializes a new instance of the class. - - - - Default constructor. - - - - - - Write the logging event to the output debug string API - - the event to log - - - Write the logging event to the output debug string API - - - - - - This appender requires a to be set. - - true - - - This appender requires a to be set. - - - - - - Stub for OutputDebugString native method - - the string to output - - - Stub for OutputDebugString native method - - - - - - Logs events to a remote syslog daemon. - - - - The BSD syslog protocol is used to remotely log to - a syslog daemon. The syslogd listens for for messages - on UDP port 514. - - - 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. - - - 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. - - - 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 - values. The facilities list is predefined - and cannot be extended. - - - An identifier is specified with each log message. This can be specified - by setting the property. The identity (also know - as the tag) must not contain white space. The default value for the - identity is the application name (from ). - - - Rob Lyon - Nicko Cadell - - - - Syslog port 514 - - - - - syslog severities - - - - The syslog severities. - - - - - - system is unusable - - - - - action must be taken immediately - - - - - critical conditions - - - - - error conditions - - - - - warning conditions - - - - - normal but significant condition - - - - - informational - - - - - debug-level messages - - - - - syslog facilities - - - - The syslog facilities - - - - - - kernel messages - - - - - random user-level messages - - - - - mail system - - - - - system daemons - - - - - security/authorization messages - - - - - messages generated internally by syslogd - - - - - line printer subsystem - - - - - network news subsystem - - - - - UUCP subsystem - - - - - clock (cron/at) daemon - - - - - security/authorization messages (private) - - - - - ftp daemon - - - - - NTP subsystem - - - - - log audit - - - - - log alert - - - - - clock daemon - - - - - reserved for local use - - - - - reserved for local use - - - - - reserved for local use - - - - - reserved for local use - - - - - reserved for local use - - - - - reserved for local use - - - - - reserved for local use - - - - - reserved for local use - - - - - Initializes a new instance of the class. - - - This instance of the class is set up to write - to a remote syslog daemon. - - - - - Message identity - - - - An identifier is specified with each log message. This can be specified - by setting the property. The identity (also know - as the tag) must not contain white space. The default value for the - identity is the application name (from ). - - - - - - Syslog facility - - - Set to one of the values. The list of - facilities is predefined and cannot be extended. The default value - is . - - - - - Add a mapping of level to severity - - The mapping to add - - - Add a mapping to this appender. - - - - - - This method is called by the method. - - The event to log. - - - Writes the event to a remote syslog daemon. - - - The format of the output will depend on the appender's layout. - - - - - - Initialize the options for this appender - - - - Initialize the level to syslog severity mappings set on this appender. - - - - - - Translates a log4net level to a syslog severity. - - A log4net level. - A syslog severity. - - - Translates a log4net level to a syslog severity. - - - - - - Generate a syslog priority. - - The syslog facility. - The syslog severity. - A syslog priority. - - - Generate a syslog priority. - - - - - - The facility. The default facility is . - - - - - The message identity - - - - - Mapping from level object to syslog severity - - - - - Initial buffer size - - - - - Maximum buffer size before it is recycled - - - - - 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. - - - - 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. - - - - - - The mapped syslog severity for the specified level - - - - Required property. - The mapped syslog severity for the specified level - - - - - - Delivers logging events to a remote logging sink. - - - - This Appender is designed to deliver events to a remote sink. - That is any object that implements the - interface. It delivers the events using .NET remoting. The - object to deliver events to is specified by setting the - appenders property. - - The RemotingAppender buffers events before sending them. This allows it to - make more efficient use of the remoting infrastructure. - - 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 ), - if they are marked as , across the - remoting boundary. If the server is not contactable then - the remoting infrastructure will clear the - objects from the . 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 - thread is used for this. If no thread is available then - the events will block in the thread pool manager until a thread is available. - - 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. - - If this appender is being closed because the - event has fired it may not be possible to send all the queued events. During process - exit the runtime limits the time that a - 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 - for details on how to shutdown - log4net programmatically. - - - Nicko Cadell - Gert Driesen - Daniel Cazzulino - - - - Initializes a new instance of the class. - - - - Default constructor. - - - - - - Gets or sets the URL of the well-known object that will accept - the logging events. - - - The well-known URL of the remote sink. - - - - The URL of the remoting sink that will accept logging events. - The sink must implement the - interface. - - - - - - Initialize the appender based on the options set - - - - This is part of the delayed object - activation scheme. The method must - be called on this object after the configuration properties have - been set. Until is called this - object is in an undefined state and must not be used. - - - If any of the configuration properties are modified then - must be called again. - - - - - - Send the contents of the buffer to the remote sink. - - - 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 ), - if they are marked as , across the - remoting boundary. If the server is not contactable then - the remoting infrastructure will clear the - objects from the . 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 - thread is used for this. If no thread is available then - the events will block in the thread pool manager until a thread is available. - - The events to send. - - - - Override base class close. - - - - This method waits while there are queued work items. The events are - sent asynchronously using 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. - - This method attempts to wait until all the queued events have been sent, but this - method will timeout after 30 seconds regardless. - - If the appender is being closed because the - event has fired it may not be possible to send all the queued events. During process - exit the runtime limits the time that a - event handler is allowed to run for. - - - - - Flushes any buffered log data. - - The maximum time to wait for logging events to be flushed. - True if all logging events were flushed successfully, else false. - - - - A work item is being queued into the thread pool - - - - - A work item from the thread pool has completed - - - - - Send the contents of the buffer to the remote sink. - - - This method is designed to be used with the . - This method expects to be passed an array of - objects in the state param. - - the logging events to send - - - - The URL of the remote sink. - - - - - The local proxy (.NET remoting) for the remote logging sink. - - - - - The number of queued callbacks currently waiting or executing - - - - - Event used to signal when there are no queued work items - - - This event is set when there are no queued work items. In this - state it is safe to close the appender. - - - - - Interface used to deliver objects to a remote sink. - - - This interface must be implemented by a remoting sink - if the is to be used - to deliver logging events to the sink. - - - - - Delivers logging events to the remote sink - - Array of events to log. - - - Delivers logging events to the remote sink - - - - - - Appender that rolls log files based on size or date or both. - - - - RollingFileAppender can roll log files based on size or date or both - depending on the setting of the property. - When set to the log file will be rolled - once its size exceeds the . - When set to the log file will be rolled - once the date boundary specified in the property - is crossed. - When set to the log file will be - rolled once the date boundary specified in the property - is crossed, but within a date boundary the file will also be rolled - once its size exceeds the . - When set to 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. - - - A of few additional optional features have been added: - - Attach date pattern for current log file - Backup number increments for newer files - Infinite number of backups by file size - - - - - - For large or infinite numbers of backup files a - greater than zero is highly recommended, otherwise all the backup files need - to be renamed each time a new backup is created. - - - When Date/Time based rolling is used setting - to will reduce the number of file renamings to few or none. - - - - - - Changing or without clearing - the log file directory of backup files will cause unexpected and unwanted side effects. - - - - - 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. - - - - The extends the and - has the same behavior when opening the log file. - The appender will first try to open the file for writing when - 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. - - - 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. - - - - - A maximum number of backup files when rolling on date/time boundaries is not supported. - - - - Nicko Cadell - Gert Driesen - Aspi Havewala - Douglas de la Torre - Edward Smit - - - - Style of rolling to use - - - - Style of rolling to use - - - - - - Roll files once per program execution - - - - Roll files once per program execution. - Well really once each time this appender is - configured. - - - Setting this option also sets AppendToFile to - false on the RollingFileAppender, otherwise - this appender would just be a normal file appender. - - - - - - Roll files based only on the size of the file - - - - - Roll files based only on the date - - - - - Roll files based on both the size and date of the file - - - - - The code assumes that the following 'time' constants are in a increasing sequence. - - - - The code assumes that the following 'time' constants are in a increasing sequence. - - - - - - Roll the log not based on the date - - - - - Roll the log for each minute - - - - - Roll the log for each hour - - - - - Roll the log twice a day (midday and midnight) - - - - - Roll the log each day (midnight) - - - - - Roll the log each week - - - - - Roll the log each month - - - - - Initializes a new instance of the class. - - - - Default constructor. - - - - - - Cleans up all resources used by this appender. - - - - - 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 - . - - - An implementation of the interface which returns the current date and time. - - - - Gets or sets the used to return the current date and time. - - - There are two built strategies for determining the current date and time, - - and . - - - The default strategy is . - - - - - - Gets or sets the date pattern to be used for generating file names - when rolling over on date. - - - The date pattern to be used for generating file names when rolling - over on date. - - - - Takes a string in the same format as expected by - . - - - This property determines the rollover schedule when rolling over - on date. - - - - - - Gets or sets the maximum number of backup files that are kept before - the oldest is erased. - - - The maximum number of backup files that are kept before the oldest is - erased. - - - - If set to zero, then there will be no backup files and the log file - will be truncated when it reaches . - - - 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 is used. - - - The maximum applies to each time based group of files and - not the total. - - - - - - Gets or sets the maximum size that the output file is allowed to reach - before being rolled over to backup files. - - - The maximum size in bytes that the output file is allowed to reach before being - rolled over to backup files. - - - - This property is equivalent to except - that it is required for differentiating the setter taking a - argument from the setter taking a - argument. - - - The default maximum file size is 10MB (10*1024*1024). - - - - - - Gets or sets the maximum size that the output file is allowed to reach - before being rolled over to backup files. - - - The maximum size that the output file is allowed to reach before being - rolled over to backup files. - - - - 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. - - - For example, the value "10KB" will be interpreted as 10240 bytes. - - - The default maximum file size is 10MB. - - - If you have the option to set the maximum file size programmatically - consider using the property instead as this - allows you to set the size in bytes as a . - - - - - - Gets or sets the rolling file count direction. - - - The rolling file count direction. - - - - Indicates if the current file is the lowest numbered file or the - highest numbered file. - - - By default newer files have lower numbers ( < 0), - i.e. log.1 is most recent, log.5 is the 5th backup, etc... - - - >= 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 >= 0 to reduce - rollover costs. - - The default file count direction is -1. - - - - - Gets or sets the rolling style. - - The rolling style. - - - The default rolling style is . - - - When set to this appender's - property is set to false, otherwise - the appender would append to a single file rather than rolling - the file each time it is opened. - - - - - - Gets or sets a value indicating whether to preserve the file name extension when rolling. - - - true if the file name extension should be preserved. - - - - 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. - - - - - - Gets or sets a value indicating whether to always log to - the same file. - - - true if always should be logged to the same file, otherwise false. - - - - 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). - - - 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! - - - - - - The fully qualified type of the RollingFileAppender class. - - - Used by the internal logger to record the Type of the - log message. - - - - - Sets the quiet writer being used. - - - This method can be overridden by sub classes. - - the writer to set - - - - Write out a logging event. - - the event to write to file. - - - 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. - - - - - - Write out an array of logging events. - - the events to write to file. - - - 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. - - - - - - Performs any required rolling before outputting the next event - - - - 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. - - - - - - Creates and opens the file for logging. If - is false then the fully qualified name is determined and used. - - the name of the file to open - true to append to existing file - - This method will ensure that the directory structure - for the specified exists. - - - - - Get the current output file name - - the base file name - the output file name - - The output file name is based on the base fileName specified. - If 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. - - - - - Determines curSizeRollBackups (only within the current roll point) - - - - - Generates a wildcard pattern that can be used to find all files - that are similar to the base file name. - - - - - - - Builds a list of filenames for all files matching the base filename plus a file - pattern. - - - - - - - Initiates a roll over if needed for crossing a date boundary since the last run. - - - - - Initializes based on existing conditions at time of . - - - - Initializes based on existing conditions at time of . - The following is done - - determine curSizeRollBackups (only within the current roll point) - initiates a roll over if needed for crossing a date boundary since the last run. - - - - - - - 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. - - - - - - - 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. - - - Certain date pattern extensions like yyyyMMdd will be parsed as valid backup indexes. - - - - - - - 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. - - - - - - - Calculates the RollPoint for the datePattern supplied. - - the date pattern to calculate the check period for - The RollPoint that is most accurate for the date pattern supplied - - 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. - - - - - Initialize the appender based on the options set - - - - This is part of the delayed object - activation scheme. The method must - be called on this object after the configuration properties have - been set. Until is called this - object is in an undefined state and must not be used. - - - If any of the configuration properties are modified then - must be called again. - - - Sets initial conditions including date/time roll over information, first check, - scheduledFilename, and calls to initialize - the current number of backups. - - - - - - - - - .1, .2, .3, etc. - - - - - Rollover the file(s) to date/time tagged file(s). - - set to true if the file to be rolled is currently open - - - Rollover the file(s) to date/time tagged file(s). - Resets curSizeRollBackups. - If fileIsOpen is set then the new file is opened (through SafeOpenFile). - - - - - - Renames file to file . - - Name of existing file to roll. - New name for file. - - - Renames file to file . It - also checks for existence of target file and deletes if it does. - - - - - - Test if a file exists at a specified path - - the path to the file - true if the file exists - - - Test if a file exists at a specified path - - - - - - Deletes the specified file if it exists. - - The file to delete. - - - 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. - - - - - - Implements file roll base on file size. - - - - If the maximum number of size based backups is reached - (curSizeRollBackups == maxSizeRollBackups) then the oldest - file is deleted -- its index determined by the sign of countDirection. - If countDirection < 0, then files - {File.1, ..., File.curSizeRollBackups -1} - are renamed to {File.2, ..., - File.curSizeRollBackups}. Moreover, File is - renamed File.1 and closed. - - - A new file is created to receive further log output. - - - If maxSizeRollBackups is equal to zero, then the - File is truncated with no backup files created. - - - If maxSizeRollBackups < 0, then File is - renamed if needed and no files are deleted. - - - - - - Implements file roll. - - the base name to rename - - - If the maximum number of size based backups is reached - (curSizeRollBackups == maxSizeRollBackups) then the oldest - file is deleted -- its index determined by the sign of countDirection. - If countDirection < 0, then files - {File.1, ..., File.curSizeRollBackups -1} - are renamed to {File.2, ..., - File.curSizeRollBackups}. - - - If maxSizeRollBackups is equal to zero, then the - File is truncated with no backup files created. - - - If maxSizeRollBackups < 0, then File is - renamed if needed and no files are deleted. - - - This is called by to rename the files. - - - - - - Get the start time of the next window for the current rollpoint - - the current date - the type of roll point we are working with - the start time for the next roll point an interval after the currentDateTime date - - - Returns the date of the next roll point after the currentDateTime date passed to the method. - - - 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. - - - - - - 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. - - - - - The date pattern. By default, the pattern is set to ".yyyy-MM-dd" - meaning daily rollover. - - - - - The actual formatted filename that is currently being written to - or will be the file transferred to on roll over - (based on staticLogFileName). - - - - - The timestamp when we shall next recompute the filename. - - - - - Holds date of last roll over - - - - - The type of rolling done - - - - - The default maximum file size is 10MB - - - - - There is zero backup files by default - - - - - How many sized based backups have been made so far - - - - - The rolling file count direction. - - - - - The rolling mode used in this appender. - - - - - Cache flag set if we are rolling by date. - - - - - Cache flag set if we are rolling by size. - - - - - Value indicating whether to always log to the same file. - - - - - Value indicating whether to preserve the file name extension when rolling. - - - - - FileName provided in configuration. Used for rolling properly - - - - - A mutex that is used to lock rolling of files. - - - - - The 1st of January 1970 in UTC - - - - - This interface is used to supply Date/Time information to the . - - - This interface is used to supply Date/Time information to the . - Used primarily to allow test classes to plug themselves in so they can - supply test date/times. - - - - - Gets the current time. - - The current time. - - - Gets the current time. - - - - - - Default implementation of that returns the current time. - - - - - Gets the current time. - - The current time. - - - Gets the current time. - - - - - - Implementation of that returns the current time as the coordinated universal time (UTC). - - - - - Gets the current time. - - The current time. - - - Gets the current time. - - - - - - Send an e-mail when a specific logging event occurs, typically on errors - or fatal errors. - - - - The number of logging events delivered in this e-mail depend on - the value of option. The - keeps only the last - logging events in its - cyclic buffer. This keeps memory requirements at a reasonable level while - still delivering useful application context. - - - 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. - - - Authentication is supported by setting the property to - either or . - If using authentication then the - and properties must also be set. - - - To set the SMTP server port use the property. The default port is 25. - - - Nicko Cadell - Gert Driesen - - - - Default constructor - - - - Default constructor - - - - - - 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). - - - - For .NET 1.1 (System.Web.Mail): A semicolon-delimited list of e-mail addresses. - - - For .NET 2.0 (System.Net.Mail): A comma-delimited list of e-mail addresses. - - - - - For .NET 1.1 (System.Web.Mail): A semicolon-delimited list of e-mail addresses. - - - For .NET 2.0 (System.Net.Mail): A comma-delimited list of e-mail addresses. - - - - - - 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). - - - - For .NET 1.1 (System.Web.Mail): A semicolon-delimited list of e-mail addresses. - - - For .NET 2.0 (System.Net.Mail): A comma-delimited list of e-mail addresses. - - - - - For .NET 1.1 (System.Web.Mail): A semicolon-delimited list of e-mail addresses. - - - For .NET 2.0 (System.Net.Mail): A comma-delimited list of e-mail addresses. - - - - - - Gets or sets a semicolon-delimited list of recipient e-mail addresses - that will be blind carbon copied. - - - A semicolon-delimited list of e-mail addresses. - - - - A semicolon-delimited list of recipient e-mail addresses. - - - - - - Gets or sets the e-mail address of the sender. - - - The e-mail address of the sender. - - - - The e-mail address of the sender. - - - - - - Gets or sets the subject line of the e-mail message. - - - The subject line of the e-mail message. - - - - The subject line of the e-mail message. - - - - - - Gets or sets the name of the SMTP relay mail server to use to send - the e-mail messages. - - - The name of the e-mail relay server. If SmtpServer is not set, the - name of the local SMTP server is used. - - - - The name of the e-mail relay server. If SmtpServer is not set, the - name of the local SMTP server is used. - - - - - - Obsolete - - - Use the BufferingAppenderSkeleton Fix methods instead - - - - Obsolete property. - - - - - - The mode to use to authentication with the SMTP server - - - Authentication is only available on the MS .NET 1.1 runtime. - - Valid Authentication mode values are: , - , and . - The default value is . When using - you must specify the - and to use to authenticate. - When using the Windows credentials for the current - thread, if impersonating, or the process will be used to authenticate. - - - - - - The username to use to authenticate with the SMTP server - - - Authentication is only available on the MS .NET 1.1 runtime. - - A and must be specified when - is set to , - otherwise the username will be ignored. - - - - - - The password to use to authenticate with the SMTP server - - - Authentication is only available on the MS .NET 1.1 runtime. - - A and must be specified when - is set to , - otherwise the password will be ignored. - - - - - - The port on which the SMTP server is listening - - - Server Port is only available on the MS .NET 1.1 runtime. - - The port on which the SMTP server is listening. The default - port is 25. The Port can only be changed when running on - the MS .NET 1.1 runtime. - - - - - - Gets or sets the priority of the e-mail message - - - One of the values. - - - - Sets the priority of the e-mails generated by this - appender. The default priority is . - - - If you are using this appender to report errors then - you may want to set the priority to . - - - - - - Enable or disable use of SSL when sending e-mail message - - - This is available on MS .NET 2.0 runtime and higher - - - - - Gets or sets the reply-to e-mail address. - - - This is available on MS .NET 2.0 runtime and higher - - - - - Gets or sets the subject encoding to be used. - - - The default encoding is the operating system's current ANSI codepage. - - - - - Gets or sets the body encoding to be used. - - - The default encoding is the operating system's current ANSI codepage. - - - - - Sends the contents of the cyclic buffer as an e-mail message. - - The logging events to send. - - - - This appender requires a to be set. - - true - - - This appender requires a to be set. - - - - - - Send the email message - - the body text to include in the mail - - - - Values for the property. - - - - SMTP authentication modes. - - - - - - No authentication - - - - - Basic authentication. - - - Requires a username and password to be supplied - - - - - Integrated authentication - - - Uses the Windows credentials from the current thread or process to authenticate. - - - - - trims leading and trailing commas or semicolons - - - - - 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 . This allows services such - as the IIS SMTP agent to manage sending the messages. - - - - The configuration for this appender is identical to that of the SMTPAppender, - except that instead of specifying the SMTPAppender.SMTPHost you specify - . - - - The number of logging events delivered in this e-mail depend on - the value of option. The - keeps only the last - logging events in its - cyclic buffer. This keeps memory requirements at a reasonable level while - still delivering useful application context. - - - Niall Daley - Nicko Cadell - - - - Default constructor - - - - Default constructor - - - - - - Gets or sets a semicolon-delimited list of recipient e-mail addresses. - - - A semicolon-delimited list of e-mail addresses. - - - - A semicolon-delimited list of e-mail addresses. - - - - - - Gets or sets the e-mail address of the sender. - - - The e-mail address of the sender. - - - - The e-mail address of the sender. - - - - - - Gets or sets the subject line of the e-mail message. - - - The subject line of the e-mail message. - - - - The subject line of the e-mail message. - - - - - - Gets or sets the path to write the messages to. - - - - Gets or sets the path to write the messages to. This should be the same - as that used by the agent sending the messages. - - - - - - Gets or sets the file extension for the generated files - - - The file extension for the generated files - - - - The file extension for the generated files - - - - - - Gets or sets the used to write to the pickup directory. - - - The used to write to the pickup directory. - - - - Unless a specified here for this appender - the is queried for the - security context to use. The default behavior is to use the security context - of the current thread. - - - - - - Sends the contents of the cyclic buffer as an e-mail message. - - The logging events to send. - - - Sends the contents of the cyclic buffer as an e-mail message. - - - - - - Activate the options on this appender. - - - - This is part of the delayed object - activation scheme. The method must - be called on this object after the configuration properties have - been set. Until is called this - object is in an undefined state and must not be used. - - - If any of the configuration properties are modified then - must be called again. - - - - - - This appender requires a to be set. - - true - - - This appender requires a to be set. - - - - - - Convert a path into a fully qualified path. - - The path to convert. - The fully qualified path. - - - Converts the path specified to a fully - qualified path. If the path is relative it is - taken as relative from the application base - directory. - - - - - - The security context to use for privileged calls - - - - - Appender that allows clients to connect via Telnet to receive log messages - - - - 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. - - - The default is 23 (the telnet port). - - - Keith Long - Nicko Cadell - - - - Default constructor - - - - Default constructor - - - - - - The fully qualified type of the TelnetAppender class. - - - Used by the internal logger to record the Type of the - log message. - - - - - Gets or sets the TCP port number on which this will listen for connections. - - - An integer value in the range to - indicating the TCP port number on which this will listen for connections. - - - - The default value is 23 (the telnet port). - - - The value specified is less than - or greater than . - - - - Overrides the parent method to close the socket handler - - - - Closes all the outstanding connections. - - - - - - This appender requires a to be set. - - true - - - This appender requires a to be set. - - - - - - Initialize the appender based on the options set. - - - - This is part of the delayed object - activation scheme. The method must - be called on this object after the configuration properties have - been set. Until is called this - object is in an undefined state and must not be used. - - - If any of the configuration properties are modified then - must be called again. - - - Create the socket handler and wait for connections - - - - - - Writes the logging event to each connected client. - - The event to log. - - - Writes the logging event to each connected client. - - - - - - Helper class to manage connected clients - - - - The SocketHandler class is used to accept connections from - clients. It is threaded so that clients can connect/disconnect - asynchronously. - - - - - - Class that represents a client connected to this handler - - - - Class that represents a client connected to this handler - - - - - - Create this for the specified - - the client's socket - - - Opens a stream writer on the socket. - - - - - - Write a string to the client - - string to send - - - Write a string to the client - - - - - - Cleanup the clients connection - - - - Close the socket connection. - - - - - - Opens a new server port on - - the local port to listen on for connections - - - Creates a socket handler on the specified local server port. - - - - - - Sends a string message to each of the connected clients - - the text to send - - - Sends a string message to each of the connected clients - - - - - - Add a client to the internal clients list - - client to add - - - - Remove a client from the internal clients list - - client to remove - - - - Test if this handler has active connections - - - true if this handler has active connections - - - - This property will be true while this handler has - active connections, that is at least one connection that - the handler will attempt to send a message to. - - - - - - Callback used to accept a connection on the server socket - - The result of the asynchronous operation - - - On connection adds to the list of connections - if there are two many open connections you will be disconnected - - - - - - Close all network connections - - - - Make sure we close all network connections - - - - - - Sends logging events to a . - - - - An Appender that writes to a . - - - 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 to write to. - - - Nicko Cadell - Gert Driesen - Douglas de la Torre - - - - Initializes a new instance of the class. - - - - Default constructor. - - - - - - Initializes a new instance of the class and - sets the output destination to a new initialized - with the specified . - - The layout to use with this appender. - The to output to. - - - Obsolete constructor. - - - - - - Initializes a new instance of the class and sets - the output destination to the specified . - - The layout to use with this appender - The to output to - - The must have been previously opened. - - - - Obsolete constructor. - - - - - - Gets or set whether the appender will flush at the end - of each append operation. - - - - The default behavior is to flush at the end of each - append operation. - - - If this option is set to false, then the underlying - stream can defer persisting the logging event to a later - time. - - - - 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. - - - - - Sets the where the log output will go. - - - - The specified must be open and writable. - - - The will be closed when the appender - instance is closed. - - - Note: Logging to an unopened will fail. - - - - - - This method determines if there is a sense in attempting to append. - - - - This method checks if an output target has been set and if a - layout has been set. - - - false if any of the preconditions fail. - - - - This method is called by the - method. - - The event to log. - - - Writes a log statement to the output stream if the output stream exists - and is writable. - - - The format of the output will depend on the appender's layout. - - - - - - This method is called by the - method. - - The array of events to log. - - - This method writes all the bulk logged events to the output writer - before flushing the stream. - - - - - - Close this appender instance. The underlying stream or writer is also closed. - - - Closed appenders cannot be reused. - - - - - Gets or set the and the underlying - , if any, for this appender. - - - The for this appender. - - - - - This appender requires a to be set. - - true - - - This appender requires a to be set. - - - - - - Writes the footer and closes the underlying . - - - - Writes the footer and closes the underlying . - - - - - - Closes the underlying . - - - - Closes the underlying . - - - - - - Clears internal references to the underlying - and other variables. - - - - Subclasses can override this method for an alternate closing behavior. - - - - - - Writes a footer as produced by the embedded layout's property. - - - - Writes a footer as produced by the embedded layout's property. - - - - - - Writes a header produced by the embedded layout's property. - - - - Writes a header produced by the embedded layout's property. - - - - - - Called to allow a subclass to lazily initialize the writer - - - - This method is called when an event is logged and the or - have not been set. This allows a subclass to - attempt to initialize the writer multiple times. - - - - - - Gets or sets the where logging events - will be written to. - - - The where logging events are written. - - - - This is the where logging events - will be written to. - - - - - - This is the where logging events - will be written to. - - - - - Immediate flush means that the underlying - or output stream will be flushed at the end of each append operation. - - - - Immediate flush is slower but ensures that each append request is - actually written. If is set to - false, then there is a good chance that the last few - logging events are not actually persisted if and when the application - crashes. - - - The default value is true. - - - - - - The fully qualified type of the TextWriterAppender class. - - - Used by the internal logger to record the Type of the - log message. - - - - - Flushes any buffered log data. - - The maximum time to wait for logging events to be flushed. - True if all logging events were flushed successfully, else false. - - - - Appends log events to the system. - - - - The application configuration file can be used to control what listeners - are actually used. See the MSDN documentation for the - class for details on configuring the - trace system. - - - Events are written using the System.Diagnostics.Trace.Write(string,string) - method. The event's logger name is the default value for the category parameter - of the Write method. - - - Compact Framework
- The Compact Framework does not support the - class for any operation except Assert. When using the Compact Framework this - appender will write to the system rather than - the Trace system. This appender will therefore behave like the . -
-
- Douglas de la Torre - Nicko Cadell - Gert Driesen - Ron Grabowski -
- - - Initializes a new instance of the . - - - - Default constructor. - - - - - - Initializes a new instance of the - with a specified layout. - - The layout to use with this appender. - - - Obsolete constructor. - - - - - - Gets or sets a value that indicates whether the appender will - flush at the end of each write. - - - The default behavior is to flush at the end of each - write. If the option is set tofalse, then the underlying - stream can defer writing to physical medium to a later time. - - - 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. - - - - - - The category parameter sent to the Trace method. - - - - Defaults to %logger which will use the logger name of the current - as the category parameter. - - - - - - - - Writes the logging event to the system. - - The event to log. - - - Writes the logging event to the system. - - - - - - This appender requires a to be set. - - true - - - This appender requires a to be set. - - - - - - Immediate flush means that the underlying writer or output stream - will be flushed at the end of each append operation. - - - - Immediate flush is slower but ensures that each append request is - actually written. If is set to - false, 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. - - - The default value is true. - - - - - Defaults to %logger - - - - - Flushes any buffered log data. - - The maximum time to wait for logging events to be flushed. - True if all logging events were flushed successfully, else false. - - - - Sends logging events as connectionless UDP datagrams to a remote host or a - multicast group using an . - - - - UDP guarantees neither that messages arrive, nor that they arrive in the correct order. - - - To view the logging results, a custom application can be developed that listens for logging - events. - - - 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 - property to specify the encoding to use. - - - - 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. - - 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()); - } - - - 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 - - - An example configuration section to log information using this appender to the - IP 224.0.0.1 on port 8080: - - - - - - - - - - Gert Driesen - Nicko Cadell - - - - Initializes a new instance of the class. - - - The default constructor initializes all fields to their default values. - - - - - Gets or sets the IP address of the remote host or multicast group to which - the underlying should sent the logging event. - - - The IP address of the remote host or multicast group to which the logging event - will be sent. - - - - Multicast addresses are identified by IP class D 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. - - - 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 D 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. - - - Static multicast addresses that are needed globally are assigned by IANA. A few examples are listed in the table below: - - - - - IP Address - Description - - - 224.0.0.1 - - - Sends a message to all system on the subnet. - - - - - 224.0.0.2 - - - Sends a message to all routers on the subnet. - - - - - 224.0.0.12 - - - The DHCP server answers messages on the IP address 224.0.0.12, but only on a subnet. - - - - - - - A complete list of actually reserved multicast addresses and their owners in the ranges - defined by RFC 3171 can be found at the IANA web site. - - - 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. - - - - - - Gets or sets the TCP port number of the remote host or multicast group to which - the underlying should sent the logging event. - - - An integer value in the range to - indicating the TCP port number of the remote host or multicast group to which the logging event - will be sent. - - - The underlying will send messages to this TCP port number - on the remote host or multicast group. - - The value specified is less than or greater than . - - - - Gets or sets the TCP port number from which the underlying will communicate. - - - An integer value in the range to - indicating the TCP port number from which the underlying will communicate. - - - - The underlying will bind to this port for sending messages. - - - Setting the value to 0 (the default) will cause the udp client not to bind to - a local port. - - - The value specified is less than or greater than . - - - - Gets or sets used to write the packets. - - - The used to write the packets. - - - - The used to write the packets. - - - - - - Gets or sets the underlying . - - - The underlying . - - - creates a to send logging events - over a network. Classes deriving from can use this - property to get or set this . Use the underlying - returned from if you require access beyond that which - provides. - - - - - Gets or sets the cached remote endpoint to which the logging events should be sent. - - - The cached remote endpoint to which the logging events will be sent. - - - The method will initialize the remote endpoint - with the values of the and - properties. - - - - - Initialize the appender based on the options set. - - - - This is part of the delayed object - activation scheme. The method must - be called on this object after the configuration properties have - been set. Until is called this - object is in an undefined state and must not be used. - - - If any of the configuration properties are modified then - must be called again. - - - The appender will be ignored if no was specified or - an invalid remote or local TCP port number was specified. - - - The required property was not specified. - The TCP port number assigned to or is less than or greater than . - - - - This method is called by the method. - - The event to log. - - - Sends the event using an UDP datagram. - - - Exceptions are passed to the . - - - - - - This appender requires a to be set. - - true - - - This appender requires a to be set. - - - - - - Closes the UDP connection and releases all resources associated with - this instance. - - - - Disables the underlying and releases all managed - and unmanaged resources associated with the . - - - - - - Initializes the underlying connection. - - - - The underlying is initialized and binds to the - port number from which you intend to communicate. - - - Exceptions are passed to the . - - - - - - The IP address of the remote host or multicast group to which - the logging event will be sent. - - - - - The TCP port number of the remote host or multicast group to - which the logging event will be sent. - - - - - The cached remote endpoint to which the logging events will be sent. - - - - - The TCP port number from which the will communicate. - - - - - The instance that will be used for sending the - logging events. - - - - - The encoding to use for the packet. - - - - - Assembly level attribute that specifies a domain to alias to this assembly's repository. - - - - AliasDomainAttribute is obsolete. Use AliasRepositoryAttribute instead of AliasDomainAttribute. - - - An assembly's logger repository is defined by its , - however this can be overridden by an assembly loaded before the target assembly. - - - An assembly can alias another assembly's domain to its repository by - specifying this attribute with the name of the target domain. - - - This attribute can only be specified on the assembly and may be used - as many times as necessary to alias all the required domains. - - - Nicko Cadell - Gert Driesen - - - - Initializes a new instance of the class with - the specified domain to alias to this assembly's repository. - - The domain to alias to this assemby's repository. - - - Obsolete. Use instead of . - - - - - - Assembly level attribute that specifies a repository to alias to this assembly's repository. - - - - An assembly's logger repository is defined by its , - however this can be overridden by an assembly loaded before the target assembly. - - - An assembly can alias another assembly's repository to its repository by - specifying this attribute with the name of the target repository. - - - This attribute can only be specified on the assembly and may be used - as many times as necessary to alias all the required repositories. - - - Nicko Cadell - Gert Driesen - - - - Initializes a new instance of the class with - the specified repository to alias to this assembly's repository. - - The repository to alias to this assemby's repository. - - - Initializes a new instance of the class with - the specified repository to alias to this assembly's repository. - - - - - - Gets or sets the repository to alias to this assemby's repository. - - - The repository to alias to this assemby's repository. - - - - The name of the repository to alias to this assemby's repository. - - - - - - Use this class to quickly configure a . - - - - Allows very simple programmatic configuration of log4net. - - - 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. - - - Appenders can also implement the interface. Therefore - they would require that the method - be called after the appenders properties have been configured. - - - Nicko Cadell - Gert Driesen - - - - The fully qualified type of the BasicConfigurator class. - - - Used by the internal logger to record the Type of the - log message. - - - - - Initializes a new instance of the class. - - - - Uses a private access modifier to prevent instantiation of this class. - - - - - - Initializes the log4net system with a default configuration. - - - - Initializes the log4net logging system using a - that will write to Console.Out. The log messages are - formatted using the layout object - with the - layout style. - - - - - - Initializes the log4net system using the specified appenders. - - The appenders to use to log all logging events. - - - Initializes the log4net system using the specified appenders. - - - - - - Initializes the log4net system using the specified appender. - - The appender to use to log all logging events. - - - Initializes the log4net system using the specified appender. - - - - - - Initializes the with a default configuration. - - The repository to configure. - - - Initializes the specified repository using a - that will write to Console.Out. The log messages are - formatted using the layout object - with the - layout style. - - - - - - Initializes the using the specified appender. - - The repository to configure. - The appender to use to log all logging events. - - - Initializes the using the specified appender. - - - - - - Initializes the using the specified appenders. - - The repository to configure. - The appenders to use to log all logging events. - - - Initializes the using the specified appender. - - - - - - Base class for all log4net configuration attributes. - - - 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. - - Nicko Cadell - Gert Driesen - - - - Constructor used by subclasses. - - the ordering priority for this configurator - - - The is used to order the configurator - attributes before they are invoked. Higher priority configurators are executed - before lower priority ones. - - - - - - Configures the for the specified assembly. - - The assembly that this attribute was defined on. - The repository to configure. - - - Abstract method implemented by a subclass. When this method is called - the subclass should configure the . - - - - - - Compare this instance to another ConfiguratorAttribute - - the object to compare to - see - - - Compares the priorities of the two instances. - Sorts by priority in descending order. Objects with the same priority are - randomly ordered. - - - - - - Assembly level attribute that specifies the logging domain for the assembly. - - - - DomainAttribute is obsolete. Use RepositoryAttribute instead of DomainAttribute. - - - 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 property specifies the name - of the domain that this assembly is a part of. The - specifies the type of the repository objects to create for the domain. If - this attribute is not specified and a is not specified - then the assembly will be part of the default shared logging domain. - - - This attribute can only be specified on the assembly and may only be used - once per assembly. - - - Nicko Cadell - Gert Driesen - - - - Initializes a new instance of the class. - - - - Obsolete. Use RepositoryAttribute instead of DomainAttribute. - - - - - - Initialize a new instance of the class - with the name of the domain. - - The name of the domain. - - - Obsolete. Use RepositoryAttribute instead of DomainAttribute. - - - - - - Use this class to initialize the log4net environment using an Xml tree. - - - - DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator. - - - Configures a using an Xml tree. - - - Nicko Cadell - Gert Driesen - - - - Private constructor - - - - - Automatically configures the log4net system based on the - application's configuration settings. - - - - DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator. - - 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 - log4net that contains the configuration data. - - - - - Automatically configures the using settings - stored in the application's configuration file. - - - - DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator. - - 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 - log4net that contains the configuration data. - - The repository to configure. - - - - Configures log4net using a log4net element - - - - DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator. - - Loads the log4net configuration from the XML element - supplied as . - - The element to parse. - - - - Configures the using the specified XML - element. - - - - DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator. - - Loads the log4net configuration from the XML element - supplied as . - - The repository to configure. - The element to parse. - - - - Configures log4net using the specified configuration file. - - The XML file to load the configuration from. - - - DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator. - - - The configuration file must be valid XML. It must contain - at least one element called log4net that holds - the log4net configuration data. - - - The log4net configuration file can possible be specified in the application's - configuration file (either MyAppName.exe.config for a - normal application on Web.config for an ASP.NET application). - - - The following example configures log4net using a configuration file, of which the - location is stored in the application's configuration file : - - - using log4net.Config; - using System.IO; - using System.Configuration; - - ... - - DOMConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"])); - - - In the .config file, the path to the log4net can be specified like this : - - - - - - - - - - - - - Configures log4net using the specified configuration file. - - A stream to load the XML configuration from. - - - DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator. - - - The configuration data must be valid XML. It must contain - at least one element called log4net that holds - the log4net configuration data. - - - Note that this method will NOT close the stream parameter. - - - - - - Configures the using the specified configuration - file. - - The repository to configure. - The XML file to load the configuration from. - - - DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator. - - - The configuration file must be valid XML. It must contain - at least one element called log4net that holds - the configuration data. - - - The log4net configuration file can possible be specified in the application's - configuration file (either MyAppName.exe.config for a - normal application on Web.config for an ASP.NET application). - - - The following example configures log4net using a configuration file, of which the - location is stored in the application's configuration file : - - - using log4net.Config; - using System.IO; - using System.Configuration; - - ... - - DOMConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"])); - - - In the .config file, the path to the log4net can be specified like this : - - - - - - - - - - - - - Configures the using the specified configuration - file. - - The repository to configure. - The stream to load the XML configuration from. - - - DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator. - - - The configuration data must be valid XML. It must contain - at least one element called log4net that holds - the configuration data. - - - Note that this method will NOT close the stream parameter. - - - - - - Configures log4net using the file specified, monitors the file for changes - and reloads the configuration if a change is detected. - - The XML file to load the configuration from. - - - DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator. - - - The configuration file must be valid XML. It must contain - at least one element called log4net that holds - the configuration data. - - - The configuration file will be monitored using a - and depends on the behavior of that class. - - - For more information on how to configure log4net using - a separate configuration file, see . - - - - - - - Configures the using the file specified, - monitors the file for changes and reloads the configuration if a change - is detected. - - The repository to configure. - The XML file to load the configuration from. - - - DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator. - - - The configuration file must be valid XML. It must contain - at least one element called log4net that holds - the configuration data. - - - The configuration file will be monitored using a - and depends on the behavior of that class. - - - For more information on how to configure log4net using - a separate configuration file, see . - - - - - - - Assembly level attribute to configure the . - - - - AliasDomainAttribute is obsolete. Use AliasRepositoryAttribute instead of AliasDomainAttribute. - - - This attribute may only be used at the assembly scope and can only - be used once per assembly. - - - Use this attribute to configure the - without calling one of the - methods. - - - Nicko Cadell - Gert Driesen - - - - Class to register for the log4net section of the configuration file - - - 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. - - - Example of registering the log4net section handler : - - - -
- - - log4net configuration XML goes here - - - - - Nicko Cadell - Gert Driesen - - - - Initializes a new instance of the class. - - - - Default constructor. - - - - - - Parses the configuration section. - - The configuration settings in a corresponding parent configuration section. - The configuration context when called from the ASP.NET configuration system. Otherwise, this parameter is reserved and is a null reference. - The for the log4net section. - The for the log4net section. - - - Returns the containing the configuration data, - - - - - - Assembly level attribute that specifies a plugin to attach to - the repository. - - - - Specifies the type of a plugin to create and attach to the - assembly's repository. The plugin type must implement the - interface. - - - Nicko Cadell - Gert Driesen - - - - Initializes a new instance of the class - with the specified type. - - The type name of plugin to create. - - - Create the attribute with the plugin type specified. - - - Where possible use the constructor that takes a . - - - - - - Initializes a new instance of the class - with the specified type. - - The type of plugin to create. - - - Create the attribute with the plugin type specified. - - - - - - Gets or sets the type for the plugin. - - - The type for the plugin. - - - - The type for the plugin. - - - - - - Gets or sets the type name for the plugin. - - - The type name for the plugin. - - - - The type name for the plugin. - - - Where possible use the property instead. - - - - - - Creates the plugin object defined by this attribute. - - - - Creates the instance of the object as - specified by this attribute. - - - The plugin object. - - - - Returns a representation of the properties of this object. - - - - Overrides base class method to - return a representation of the properties of this object. - - - A representation of the properties of this object - - - - Assembly level attribute that specifies the logging repository for the assembly. - - - - Assemblies are mapped to logging repository. This attribute specified - on the assembly controls - the configuration of the repository. The property specifies the name - of the repository that this assembly is a part of. The - specifies the type of the object - to create for the assembly. If this attribute is not specified or a - is not specified then the assembly will be part of the default shared logging repository. - - - This attribute can only be specified on the assembly and may only be used - once per assembly. - - - Nicko Cadell - Gert Driesen - - - - Initializes a new instance of the class. - - - - Default constructor. - - - - - - Initialize a new instance of the class - with the name of the repository. - - The name of the repository. - - - Initialize the attribute with the name for the assembly's repository. - - - - - - Gets or sets the name of the logging repository. - - - The string name to use as the name of the repository associated with this - assembly. - - - - This value does not have to be unique. Several assemblies can share the - same repository. They will share the logging configuration of the repository. - - - - - - Gets or sets the type of repository to create for this assembly. - - - The type of repository to create for this assembly. - - - - The type of the repository to create for the assembly. - The type must implement the - interface. - - - 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 - of the first assembly to call into the - repository. - - - - - - Assembly level attribute to configure the . - - - - This attribute may only be used at the assembly scope and can only - be used once per assembly. - - - Use this attribute to configure the - without calling one of the - methods. - - - Nicko Cadell - - - - Construct provider attribute with type specified - - the type of the provider to use - - - The provider specified must subclass the - class. - - - - - - Gets or sets the type of the provider to use. - - - the type of the provider to use. - - - - The provider specified must subclass the - class. - - - - - - Configures the SecurityContextProvider - - The assembly that this attribute was defined on. - The repository to configure. - - - Creates a provider instance from the specified. - Sets this as the default security context provider . - - - - - - The fully qualified type of the SecurityContextProviderAttribute class. - - - Used by the internal logger to record the Type of the - log message. - - - - - Use this class to initialize the log4net environment using an Xml tree. - - - - Configures a using an Xml tree. - - - Nicko Cadell - Gert Driesen - - - - Private constructor - - - - - Automatically configures the using settings - stored in the application's configuration file. - - - - 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 - log4net that contains the configuration data. - - - To use this method to configure log4net you must specify - the section - handler for the log4net configuration section. See the - for an example. - - - The repository to configure. - - - - Automatically configures the log4net system based on the - application's configuration settings. - - - - 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 - log4net that contains the configuration data. - - - To use this method to configure log4net you must specify - the section - handler for the log4net configuration section. See the - for an example. - - - - - - - Configures log4net using a log4net element - - - - Loads the log4net configuration from the XML element - supplied as . - - - The element to parse. - - - - Configures log4net using the specified configuration file. - - The XML file to load the configuration from. - - - The configuration file must be valid XML. It must contain - at least one element called log4net that holds - the log4net configuration data. - - - The log4net configuration file can possible be specified in the application's - configuration file (either MyAppName.exe.config for a - normal application on Web.config for an ASP.NET application). - - - The first element matching <configuration> will be read as the - configuration. If this file is also a .NET .config file then you must specify - a configuration section for the log4net element otherwise .NET will - complain. Set the type for the section handler to , for example: - - -
- - - - - The following example configures log4net using a configuration file, of which the - location is stored in the application's configuration file : - - - using log4net.Config; - using System.IO; - using System.Configuration; - - ... - - XmlConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"])); - - - In the .config file, the path to the log4net can be specified like this : - - - - - - - - - - - - - Configures log4net using the specified configuration URI. - - A URI to load the XML configuration from. - - - The configuration data must be valid XML. It must contain - at least one element called log4net that holds - the log4net configuration data. - - - The must support the URI scheme specified. - - - - - - Configures log4net using the specified configuration data stream. - - A stream to load the XML configuration from. - - - The configuration data must be valid XML. It must contain - at least one element called log4net that holds - the log4net configuration data. - - - Note that this method will NOT close the stream parameter. - - - - - - Configures the using the specified XML - element. - - - Loads the log4net configuration from the XML element - supplied as . - - The repository to configure. - The element to parse. - - - - Configures the using the specified configuration - file. - - The repository to configure. - The XML file to load the configuration from. - - - The configuration file must be valid XML. It must contain - at least one element called log4net that holds - the configuration data. - - - The log4net configuration file can possible be specified in the application's - configuration file (either MyAppName.exe.config for a - normal application on Web.config for an ASP.NET application). - - - The first element matching <configuration> will be read as the - configuration. If this file is also a .NET .config file then you must specify - a configuration section for the log4net element otherwise .NET will - complain. Set the type for the section handler to , for example: - - -
- - - - - The following example configures log4net using a configuration file, of which the - location is stored in the application's configuration file : - - - using log4net.Config; - using System.IO; - using System.Configuration; - - ... - - XmlConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"])); - - - In the .config file, the path to the log4net can be specified like this : - - - - - - - - - - - - - Configures the using the specified configuration - URI. - - The repository to configure. - A URI to load the XML configuration from. - - - The configuration data must be valid XML. It must contain - at least one element called log4net that holds - the configuration data. - - - The must support the URI scheme specified. - - - - - - Configures the using the specified configuration - file. - - The repository to configure. - The stream to load the XML configuration from. - - - The configuration data must be valid XML. It must contain - at least one element called log4net that holds - the configuration data. - - - Note that this method will NOT close the stream parameter. - - - - - - Configures log4net using the file specified, monitors the file for changes - and reloads the configuration if a change is detected. - - The XML file to load the configuration from. - - - The configuration file must be valid XML. It must contain - at least one element called log4net that holds - the configuration data. - - - The configuration file will be monitored using a - and depends on the behavior of that class. - - - For more information on how to configure log4net using - a separate configuration file, see . - - - - - - - Configures the using the file specified, - monitors the file for changes and reloads the configuration if a change - is detected. - - The repository to configure. - The XML file to load the configuration from. - - - The configuration file must be valid XML. It must contain - at least one element called log4net that holds - the configuration data. - - - The configuration file will be monitored using a - and depends on the behavior of that class. - - - For more information on how to configure log4net using - a separate configuration file, see . - - - - - - - Class used to watch config files. - - - - Uses the 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 time before delivering - the event notification. If any further - change notifications arrive while the timer is waiting it - is reset and waits again for to - elapse. - - - - - - Holds the FileInfo used to configure the XmlConfigurator - - - - - Holds the repository being configured. - - - - - The timer used to compress the notification events. - - - - - The default amount of time to wait after receiving notification - before reloading the config file. - - - - - Watches file for changes. This object should be disposed when no longer - needed to free system handles on the watched resources. - - - - - Initializes a new instance of the class to - watch a specified config file used to configure a repository. - - The repository to configure. - The configuration file to watch. - - - Initializes a new instance of the class. - - - - - - Event handler used by . - - The firing the event. - The argument indicates the file that caused the event to be fired. - - - This handler reloads the configuration from the file when the event is fired. - - - - - - Event handler used by . - - The firing the event. - The argument indicates the file that caused the event to be fired. - - - This handler reloads the configuration from the file when the event is fired. - - - - - - Called by the timer when the configuration has been updated. - - null - - - - Release the handles held by the watcher and timer. - - - - - Configures the specified repository using a log4net element. - - The hierarchy to configure. - The element to parse. - - - Loads the log4net configuration from the XML element - supplied as . - - - This method is ultimately called by one of the Configure methods - to load the configuration from an . - - - - - - Maps repository names to ConfigAndWatchHandler instances to allow a particular - ConfigAndWatchHandler to dispose of its FileSystemWatcher when a repository is - reconfigured. - - - - - The fully qualified type of the XmlConfigurator class. - - - Used by the internal logger to record the Type of the - log message. - - - - - Assembly level attribute to configure the . - - - - This attribute may only be used at the assembly scope and can only - be used once per assembly. - - - Use this attribute to configure the - without calling one of the - methods. - - - If neither of the or - properties are set the configuration is loaded from the application's .config file. - If set the property takes priority over the - property. The property - specifies a path to a file to load the config from. The path is relative to the - application's base directory; . - The property is used as a postfix to the assembly file name. - The config file must be located in the application's base directory; . - For example in a console application setting the to - config has the same effect as not specifying the or - properties. - - - The property can be set to cause the - to watch the configuration file for changes. - - - - 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 - methods is made from the assembly with the configuration - attributes. - - - 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 method directly. - - - - Nicko Cadell - Gert Driesen - - - - Default constructor - - - - Default constructor - - - - - - Gets or sets the filename of the configuration file. - - - The filename of the configuration file. - - - - If specified, this is the name of the configuration file to use with - the . This file path is relative to the - application base directory (). - - - The takes priority over the . - - - - - - Gets or sets the extension of the configuration file. - - - The extension of the configuration file. - - - - If specified this is the extension for the configuration file. - The path to the config file is built by using the application - base directory (), - the assembly file name and the config file extension. - - - If the is set to MyExt then - possible config file names would be: MyConsoleApp.exe.MyExt or - MyClassLibrary.dll.MyExt. - - - The takes priority over the . - - - - - - Gets or sets a value indicating whether to watch the configuration file. - - - true if the configuration should be watched, false otherwise. - - - - If this flag is specified and set to true then the framework - will watch the configuration file and will reload the config each time - the file is modified. - - - 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. - - - Watching configuration is not supported on the SSCLI. - - - - - - Configures the for the specified assembly. - - The assembly that this attribute was defined on. - The repository to configure. - - - Configure the repository using the . - The specified must extend the - class otherwise the will not be able to - configure it. - - - The does not extend . - - - - Attempt to load configuration from the local file system - - The assembly that this attribute was defined on. - The repository to configure. - - - - Configure the specified repository using a - - The repository to configure. - the FileInfo pointing to the config file - - - - Attempt to load configuration from a URI - - The assembly that this attribute was defined on. - The repository to configure. - - - - The fully qualified type of the XmlConfiguratorAttribute class. - - - Used by the internal logger to record the Type of the - log message. - - - - - The implementation of the interface suitable - for use with the compact framework - - - - This implementation is a simple - mapping between repository name and - object. - - - The .NET Compact Framework 1.0 does not support retrieving assembly - level attributes therefore unlike the DefaultRepositorySelector - this selector does not examine the calling assembly for attributes. - - - Nicko Cadell - - - - Create a new repository selector - - the type of the repositories to create, must implement - - - Create an new compact repository selector. - The default type for repositories must be specified, - an appropriate value would be . - - - throw if is null - throw if does not implement - - - - Get the for the specified assembly - - not used - The default - - - The argument is not used. This selector does not create a - separate repository for each assembly. - - - As a named repository is not specified the default repository is - returned. The default repository is named log4net-default-repository. - - - - - - Get the named - - the name of the repository to lookup - The named - - - Get the named . The default - repository is log4net-default-repository. Other repositories - must be created using the . - If the named repository does not exist an exception is thrown. - - - throw if is null - throw if the does not exist - - - - Create a new repository for the assembly specified - - not used - the type of repository to create, must implement - the repository created - - - The argument is not used. This selector does not create a - separate repository for each assembly. - - - If the is null then the - default repository type specified to the constructor is used. - - - As a named repository is not specified the default repository is - returned. The default repository is named log4net-default-repository. - - - - - - Create a new repository for the repository specified - - the repository to associate with the - the type of repository to create, must implement . - If this param is null then the default repository type is used. - the repository created - - - The created will be associated with the repository - specified such that a call to with the - same repository specified will return the same repository instance. - - - If the named repository already exists an exception will be thrown. - - - If is null then the default - repository type specified to the constructor is used. - - - throw if is null - throw if the already exists - - - - Test if a named repository exists - - the named repository to check - true if the repository exists - - - Test if a named repository exists. Use - to create a new repository and to retrieve - a repository. - - - - - - Gets a list of objects - - an array of all known objects - - - Gets an array of all of the repositories created by this selector. - - - - - - The fully qualified type of the CompactRepositorySelector class. - - - Used by the internal logger to record the Type of the - log message. - - - - - Event to notify that a logger repository has been created. - - - Event to notify that a logger repository has been created. - - - - Event raised when a new repository is created. - The event source will be this selector. The event args will - be a which - holds the newly created . - - - - - - Notify the registered listeners that the repository has been created - - The repository that has been created - - - Raises the LoggerRepositoryCreatedEvent - event. - - - - - - The default implementation of the interface. - - - - Uses attributes defined on the calling assembly to determine how to - configure the hierarchy for the repository. - - - Nicko Cadell - Gert Driesen - - - - Event to notify that a logger repository has been created. - - - Event to notify that a logger repository has been created. - - - - Event raised when a new repository is created. - The event source will be this selector. The event args will - be a which - holds the newly created . - - - - - - Creates a new repository selector. - - The type of the repositories to create, must implement - - - Create an new repository selector. - The default type for repositories must be specified, - an appropriate value would be . - - - is . - does not implement . - - - - Gets the for the specified assembly. - - The assembly use to lookup the . - - - The type of the created and the repository - to create can be overridden by specifying the - attribute on the . - - - The default values are to use the - implementation of the interface and to use the - as the name of the repository. - - - The created will be automatically configured using - any attributes defined on - the . - - - The for the assembly - is . - - - - Gets the for the specified repository. - - The repository to use to lookup the . - The for the specified repository. - - - Returns the named repository. If is null - a is thrown. If the repository - does not exist a is thrown. - - - Use to create a repository. - - - is . - does not exist. - - - - Create a new repository for the assembly specified - - the assembly to use to create the repository to associate with the . - The type of repository to create, must implement . - The repository created. - - - The created will be associated with the repository - specified such that a call to with the - same assembly specified will return the same repository instance. - - - The type of the created and - the repository to create can be overridden by specifying the - attribute on the - . The default values are to use the - implementation of the - interface and to use the - as the name of the repository. - - - The created will be automatically - configured using any - attributes defined on the . - - - If a repository for the 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 . - Also the attribute on the - assembly may be used to override the repository type specified in - . - - - is . - - - - Creates a new repository for the assembly specified. - - the assembly to use to create the repository to associate with the . - The type of repository to create, must implement . - The name to assign to the created repository - Set to true to read and apply the assembly attributes - The repository created. - - - The created will be associated with the repository - specified such that a call to with the - same assembly specified will return the same repository instance. - - - The type of the created and - the repository to create can be overridden by specifying the - attribute on the - . The default values are to use the - implementation of the - interface and to use the - as the name of the repository. - - - The created will be automatically - configured using any - attributes defined on the . - - - If a repository for the 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 . - Also the attribute on the - assembly may be used to override the repository type specified in - . - - - is . - - - - Creates a new repository for the specified repository. - - The repository to associate with the . - The type of repository to create, must implement . - If this param is then the default repository type is used. - The new repository. - - - The created will be associated with the repository - specified such that a call to with the - same repository specified will return the same repository instance. - - - is . - already exists. - - - - Test if a named repository exists - - the named repository to check - true if the repository exists - - - Test if a named repository exists. Use - to create a new repository and to retrieve - a repository. - - - - - - Gets a list of objects - - an array of all known objects - - - Gets an array of all of the repositories created by this selector. - - - - - - Aliases a repository to an existing repository. - - The repository to alias. - The repository that the repository is aliased to. - - - The repository specified will be aliased to the repository when created. - The repository must not already exist. - - - When the repository is created it must utilize the same repository type as - the repository it is aliased to, otherwise the aliasing will fail. - - - - is . - -or- - is . - - - - - Notifies the registered listeners that the repository has been created. - - The repository that has been created. - - - Raises the event. - - - - - - Gets the repository name and repository type for the specified assembly. - - The assembly that has a . - in/out param to hold the repository name to use for the assembly, caller should set this to the default value before calling. - 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. - is . - - - - Configures the repository using information from the assembly. - - The assembly containing - attributes which define the configuration for the repository. - The repository to configure. - - is . - -or- - is . - - - - - Loads the attribute defined plugins on the assembly. - - The assembly that contains the attributes. - The repository to add the plugins to. - - is . - -or- - is . - - - - - Loads the attribute defined aliases on the assembly. - - The assembly that contains the attributes. - The repository to alias to. - - is . - -or- - is . - - - - - The fully qualified type of the DefaultRepositorySelector class. - - - Used by the internal logger to record the Type of the - log message. - - - - - Defined error codes that can be passed to the method. - - - - Values passed to the method. - - - Nicko Cadell - - - - A general error - - - - - Error while writing output - - - - - Failed to flush file - - - - - Failed to close file - - - - - Unable to open output file - - - - - No layout specified - - - - - Failed to parse address - - - - - An evaluator that triggers on an Exception type - - - - This evaluator will trigger if the type of the Exception - passed to - is equal to a Type in . /// - - - Drew Schaeffer - - - - The type that causes the trigger to fire. - - - - - Causes subclasses of to cause the trigger to fire. - - - - - Default ctor to allow dynamic creation through a configurator. - - - - - Constructs an evaluator and initializes to trigger on - - the type that triggers this evaluator. - If true, this evaluator will trigger on subclasses of . - - - - The type that triggers this evaluator. - - - - - If true, this evaluator will trigger on subclasses of . - - - - - Is this the triggering event? - - The event to check - This method returns true, if the logging event Exception - Type is . - Otherwise it returns false - - - This evaluator will trigger if the Exception Type of the event - passed to - is . - - - - - - Flags passed to the property - - - - Flags passed to the property - - - Nicko Cadell - - - - Fix the MDC - - - - - Fix the NDC - - - - - Fix the rendered message - - - - - Fix the thread name - - - - - Fix the callers location information - - - CAUTION: Very slow to generate - - - - - Fix the callers windows user name - - - CAUTION: Slow to generate - - - - - Fix the domain friendly name - - - - - Fix the callers principal name - - - CAUTION: May be slow to generate - - - - - Fix the exception text - - - - - Fix the event properties. Active properties must implement in order to be eligible for fixing. - - - - - No fields fixed - - - - - All fields fixed - - - - - Partial fields fixed - - - - This set of partial fields gives good performance. The following fields are fixed: - - - - - - - - - - - - - Interface for attaching appenders to objects. - - - - Interface for attaching, removing and retrieving appenders. - - - Nicko Cadell - Gert Driesen - - - - Attaches an appender. - - The appender to add. - - - Add the specified appender. The implementation may - choose to allow or deny duplicate appenders. - - - - - - Gets all attached appenders. - - - A collection of attached appenders. - - - - Gets a collection of attached appenders. - If there are no attached appenders the - implementation should return an empty - collection rather than null. - - - - - - Gets an attached appender with the specified name. - - The name of the appender to get. - - The appender with the name specified, or null if no appender with the - specified name is found. - - - - Returns an attached appender with the specified. - If no appender with the specified name is found null will be - returned. - - - - - - Removes all attached appenders. - - - - Removes and closes all attached appenders - - - - - - Removes the specified appender from the list of attached appenders. - - The appender to remove. - The appender removed from the list - - - The appender removed is not closed. - If you are discarding the appender you must call - on the appender removed. - - - - - - Removes the appender with the specified name from the list of appenders. - - The name of the appender to remove. - The appender removed from the list - - - The appender removed is not closed. - If you are discarding the appender you must call - on the appender removed. - - - - - - Appenders may delegate their error handling to an . - - - - Error handling is a particularly tedious to get right because by - definition errors are hard to predict and to reproduce. - - - Nicko Cadell - Gert Driesen - - - - Handles the error and information about the error condition is passed as - a parameter. - - The message associated with the error. - The that was thrown when the error occurred. - The error code associated with the error. - - - Handles the error and information about the error condition is passed as - a parameter. - - - - - - Prints the error message passed as a parameter. - - The message associated with the error. - The that was thrown when the error occurred. - - - See . - - - - - - Prints the error message passed as a parameter. - - The message associated with the error. - - - See . - - - - - - Interface for objects that require fixing. - - - - Interface that indicates that the object requires fixing before it - can be taken outside the context of the appender's - method. - - - When objects that implement this interface are stored - in the context properties maps - and - are fixed - (see ) the - method will be called. - - - Nicko Cadell - - - - Get a portable version of this object - - the portable instance of this object - - - 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. - - - - - - Interface that all loggers implement - - - - This interface supports logging events and testing if a level - is enabled for logging. - - - 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. - - - Nicko Cadell - Gert Driesen - - - - Gets the name of the logger. - - - The name of the logger. - - - - The name of this logger - - - - - - This generic form is intended to be used by wrappers. - - The declaring type of the method that is - the stack boundary into the logging system for this call. - The level of the message to be logged. - The message object to log. - the exception to log, including its stack trace. Pass null to not log an exception. - - - Generates a logging event for the specified using - the and . - - - - - - This is the most generic printing method that is intended to be used - by wrappers. - - The event being logged. - - - Logs the specified logging event through this logger. - - - - - - Checks if this logger is enabled for a given passed as parameter. - - The level to check. - - true if this logger is enabled for level, otherwise false. - - - - Test if this logger is going to log events of the specified . - - - - - - Gets the where this - Logger instance is attached to. - - - The that this logger belongs to. - - - - Gets the where this - Logger instance is attached to. - - - - - - Base interface for all wrappers - - - - Base interface for all wrappers. - - - All wrappers must implement this interface. - - - Nicko Cadell - - - - Get the implementation behind this wrapper object. - - - The object that in implementing this object. - - - - The object that in implementing this - object. The Logger 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. - - - - - - Interface used to delay activate a configured object. - - - - 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. - - - If a component implements this interface then the method - must be called by the container after its all the configured properties have been set - and before the component can be used. - - - Nicko Cadell - - - - Activate the options that were previously set with calls to properties. - - - - 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. - - - If a component implements this interface then this method must be called - after its properties have been set before the component can be used. - - - - - - Delegate used to handle logger repository creation event notifications - - The which created the repository. - The event args - that holds the instance that has been created. - - - Delegate used to handle logger repository creation event notifications. - - - - - - Provides data for the event. - - - - A - event is raised every time a is created. - - - - - - The created - - - - - Construct instance using specified - - the that has been created - - - Construct instance using specified - - - - - - The that has been created - - - The that has been created - - - - The that has been created - - - - - - Interface used by the to select the . - - - - The uses a - to specify the policy for selecting the correct - to return to the caller. - - - Nicko Cadell - Gert Driesen - - - - Gets the for the specified assembly. - - The assembly to use to lookup to the - The for the assembly. - - - Gets the for the specified assembly. - - - How the association between and - 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. - - - - - - Gets the named . - - The name to use to lookup to the . - The named - - Lookup a named . This is the repository created by - calling . - - - - - Creates a new repository for the assembly specified. - - The assembly to use to create the domain to associate with the . - The type of repository to create, must implement . - The repository created. - - - The created will be associated with the domain - specified such that a call to with the - same assembly specified will return the same repository instance. - - - How the association between and - is made is not defined. The implementation may choose any method for - this association. - - - - - - Creates a new repository with the name specified. - - The name to associate with the . - The type of repository to create, must implement . - The repository created. - - - The created will be associated with the name - specified such that a call to with the - same name will return the same repository instance. - - - - - - Test if a named repository exists - - the named repository to check - true if the repository exists - - - Test if a named repository exists. Use - to create a new repository and to retrieve - a repository. - - - - - - Gets an array of all currently defined repositories. - - - An array of the instances created by - this . - - - Gets an array of all of the repositories created by this selector. - - - - - - Event to notify that a logger repository has been created. - - - Event to notify that a logger repository has been created. - - - - Event raised when a new repository is created. - The event source will be this selector. The event args will - be a which - holds the newly created . - - - - - - Test if an triggers an action - - - - Implementations of this interface allow certain appenders to decide - when to perform an appender specific action. - - - The action or behavior triggered is defined by the implementation. - - - Nicko Cadell - - - - Test if this event triggers the action - - The event to check - true if this event triggers the action, otherwise false - - - Return true if this event triggers the action - - - - - - Defines the default set of levels recognized by the system. - - - - Each has an associated . - - - Levels have a numeric that defines the relative - ordering between levels. Two Levels with the same - are deemed to be equivalent. - - - The levels that are recognized by log4net are set for each - and each repository can have different levels defined. The levels are stored - in the on the repository. Levels are - looked up by name from the . - - - When logging at level INFO the actual level used is not but - the value of LoggerRepository.LevelMap["INFO"]. The default value for this is - , but this can be changed by reconfiguring the level map. - - - Each level has a in addition to its . The - 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. - - - Some of the predefined levels recognized by the system are: - - - - . - - - . - - - . - - - . - - - . - - - . - - - . - - - - Nicko Cadell - Gert Driesen - - - - Constructor - - Integer value for this level, higher values represent more severe levels. - The string name of this level. - The display name for this level. This may be localized or otherwise different from the name - - - Initializes a new instance of the class with - the specified level name and value. - - - - - - Constructor - - Integer value for this level, higher values represent more severe levels. - The string name of this level. - - - Initializes a new instance of the class with - the specified level name and value. - - - - - - Gets the name of this level. - - - The name of this level. - - - - Gets the name of this level. - - - - - - Gets the value of this level. - - - The value of this level. - - - - Gets the value of this level. - - - - - - Gets the display name of this level. - - - The display name of this level. - - - - Gets the display name of this level. - - - - - - Returns the representation of the current - . - - - A representation of the current . - - - - Returns the level . - - - - - - Compares levels. - - The object to compare against. - true if the objects are equal. - - - Compares the levels of instances, and - defers to base class if the target object is not a - instance. - - - - - - Returns a hash code - - A hash code for the current . - - - Returns a hash code suitable for use in hashing algorithms and data - structures like a hash table. - - - Returns the hash code of the level . - - - - - - Compares this instance to a specified object and returns an - indication of their relative values. - - A instance or to compare with this instance. - - A 32-bit signed integer that indicates the relative order of the - values compared. The return value has these meanings: - - - Value - Meaning - - - Less than zero - This instance is less than . - - - Zero - This instance is equal to . - - - Greater than zero - - This instance is greater than . - -or- - is . - - - - - - - must be an instance of - or ; otherwise, an exception is thrown. - - - is not a . - - - - Returns a value indicating whether a specified - is greater than another specified . - - A - A - - true if is greater than - ; otherwise, false. - - - - Compares two levels. - - - - - - Returns a value indicating whether a specified - is less than another specified . - - A - A - - true if is less than - ; otherwise, false. - - - - Compares two levels. - - - - - - Returns a value indicating whether a specified - is greater than or equal to another specified . - - A - A - - true if is greater than or equal to - ; otherwise, false. - - - - Compares two levels. - - - - - - Returns a value indicating whether a specified - is less than or equal to another specified . - - A - A - - true if is less than or equal to - ; otherwise, false. - - - - Compares two levels. - - - - - - Returns a value indicating whether two specified - objects have the same value. - - A or . - A or . - - true if the value of is the same as the - value of ; otherwise, false. - - - - Compares two levels. - - - - - - Returns a value indicating whether two specified - objects have different values. - - A or . - A or . - - true if the value of is different from - the value of ; otherwise, false. - - - - Compares two levels. - - - - - - Compares two specified instances. - - The first to compare. - The second to compare. - - A 32-bit signed integer that indicates the relative order of the - two values compared. The return value has these meanings: - - - Value - Meaning - - - Less than zero - is less than . - - - Zero - is equal to . - - - Greater than zero - is greater than . - - - - - - Compares two levels. - - - - - - The level designates a higher level than all the rest. - - - - - The level designates very severe error events. - System unusable, emergencies. - - - - - The level designates very severe error events. - System unusable, emergencies. - - - - - The level designates very severe error events - that will presumably lead the application to abort. - - - - - The level designates very severe error events. - Take immediate action, alerts. - - - - - The level designates very severe error events. - Critical condition, critical. - - - - - The level designates very severe error events. - - - - - The level designates error events that might - still allow the application to continue running. - - - - - The level designates potentially harmful - situations. - - - - - The level designates informational messages - that highlight the progress of the application at the highest level. - - - - - The level designates informational messages that - highlight the progress of the application at coarse-grained level. - - - - - The level designates fine-grained informational - events that are most useful to debug an application. - - - - - The level designates fine-grained informational - events that are most useful to debug an application. - - - - - The level designates fine-grained informational - events that are most useful to debug an application. - - - - - The level designates fine-grained informational - events that are most useful to debug an application. - - - - - The level designates fine-grained informational - events that are most useful to debug an application. - - - - - The level designates fine-grained informational - events that are most useful to debug an application. - - - - - The level designates the lowest level possible. - - - - - A strongly-typed collection of objects. - - Nicko Cadell - - - - Supports type-safe iteration over a . - - - - - Gets the current element in the collection. - - - - - Advances the enumerator to the next element in the collection. - - - true if the enumerator was successfully advanced to the next element; - false if the enumerator has passed the end of the collection. - - - The collection was modified after the enumerator was created. - - - - - Sets the enumerator to its initial position, before the first element in the collection. - - - - - Creates a read-only wrapper for a LevelCollection instance. - - list to create a readonly wrapper arround - - A LevelCollection wrapper that is read-only. - - - - - Initializes a new instance of the LevelCollection class - that is empty and has the default initial capacity. - - - - - Initializes a new instance of the LevelCollection class - that has the specified initial capacity. - - - The number of elements that the new LevelCollection is initially capable of storing. - - - - - Initializes a new instance of the LevelCollection class - that contains elements copied from the specified LevelCollection. - - The LevelCollection whose elements are copied to the new collection. - - - - Initializes a new instance of the LevelCollection class - that contains elements copied from the specified array. - - The array whose elements are copied to the new list. - - - - Initializes a new instance of the LevelCollection class - that contains elements copied from the specified collection. - - The collection whose elements are copied to the new list. - - - - Type visible only to our subclasses - Used to access protected constructor - - - - - A value - - - - - Allow subclasses to avoid our default constructors - - - - - - Gets the number of elements actually contained in the LevelCollection. - - - - - Copies the entire LevelCollection to a one-dimensional - array. - - The one-dimensional array to copy to. - - - - Copies the entire LevelCollection to a one-dimensional - array, starting at the specified index of the target array. - - The one-dimensional array to copy to. - The zero-based index in at which copying begins. - - - - Gets a value indicating whether access to the collection is synchronized (thread-safe). - - false, because the backing type is an array, which is never thread-safe. - - - - Gets an object that can be used to synchronize access to the collection. - - - - - Gets or sets the at the specified index. - - The zero-based index of the element to get or set. - - is less than zero - -or- - is equal to or greater than . - - - - - Adds a to the end of the LevelCollection. - - The to be added to the end of the LevelCollection. - The index at which the value has been added. - - - - Removes all elements from the LevelCollection. - - - - - Creates a shallow copy of the . - - A new with a shallow copy of the collection data. - - - - Determines whether a given is in the LevelCollection. - - The to check for. - true if is found in the LevelCollection; otherwise, false. - - - - Returns the zero-based index of the first occurrence of a - in the LevelCollection. - - The to locate in the LevelCollection. - - The zero-based index of the first occurrence of - in the entire LevelCollection, if found; otherwise, -1. - - - - - Inserts an element into the LevelCollection at the specified index. - - The zero-based index at which should be inserted. - The to insert. - - is less than zero - -or- - is equal to or greater than . - - - - - Removes the first occurrence of a specific from the LevelCollection. - - The to remove from the LevelCollection. - - The specified was not found in the LevelCollection. - - - - - Removes the element at the specified index of the LevelCollection. - - The zero-based index of the element to remove. - - is less than zero - -or- - is equal to or greater than . - - - - - Gets a value indicating whether the collection has a fixed size. - - true if the collection has a fixed size; otherwise, false. The default is false - - - - Gets a value indicating whether the IList is read-only. - - true if the collection is read-only; otherwise, false. The default is false - - - - Returns an enumerator that can iterate through the LevelCollection. - - An for the entire LevelCollection. - - - - Gets or sets the number of elements the LevelCollection can contain. - - - - - Adds the elements of another LevelCollection to the current LevelCollection. - - The LevelCollection whose elements should be added to the end of the current LevelCollection. - The new of the LevelCollection. - - - - Adds the elements of a array to the current LevelCollection. - - The array whose elements should be added to the end of the LevelCollection. - The new of the LevelCollection. - - - - Adds the elements of a collection to the current LevelCollection. - - The collection whose elements should be added to the end of the LevelCollection. - The new of the LevelCollection. - - - - Sets the capacity to the actual number of elements. - - - - - is less than zero - -or- - is equal to or greater than . - - - - - is less than zero - -or- - is equal to or greater than . - - - - - Supports simple iteration over a . - - - - - Initializes a new instance of the Enumerator class. - - - - - - Gets the current element in the collection. - - - - - Advances the enumerator to the next element in the collection. - - - true if the enumerator was successfully advanced to the next element; - false if the enumerator has passed the end of the collection. - - - The collection was modified after the enumerator was created. - - - - - Sets the enumerator to its initial position, before the first element in the collection. - - - - - An evaluator that triggers at a threshold level - - - - This evaluator will trigger if the level of the event - passed to - is equal to or greater than the - level. - - - Nicko Cadell - - - - The threshold for triggering - - - - - Create a new evaluator using the threshold. - - - - Create a new evaluator using the threshold. - - - This evaluator will trigger if the level of the event - passed to - is equal to or greater than the - level. - - - - - - Create a new evaluator using the specified threshold. - - the threshold to trigger at - - - Create a new evaluator using the specified threshold. - - - This evaluator will trigger if the level of the event - passed to - is equal to or greater than the - level. - - - - - - the threshold to trigger at - - - The that will cause this evaluator to trigger - - - - This evaluator will trigger if the level of the event - passed to - is equal to or greater than the - level. - - - - - - Is this the triggering event? - - The event to check - This method returns true, if the event level - is equal or higher than the . - Otherwise it returns false - - - This evaluator will trigger if the level of the event - passed to - is equal to or greater than the - level. - - - - - - Mapping between string name and Level object - - - - Mapping between string name and object. - This mapping is held separately for each . - The level name is case insensitive. - - - Nicko Cadell - - - - Mapping from level name to Level object. The - level name is case insensitive - - - - - Construct the level map - - - - Construct the level map. - - - - - - Clear the internal maps of all levels - - - - Clear the internal maps of all levels - - - - - - Lookup a by name - - The name of the Level to lookup - a Level from the map with the name specified - - - Returns the from the - map with the name specified. If the no level is - found then null is returned. - - - - - - Create a new Level and add it to the map - - the string to display for the Level - the level value to give to the Level - - - Create a new Level and add it to the map - - - - - - - Create a new Level and add it to the map - - the string to display for the Level - the level value to give to the Level - the display name to give to the Level - - - Create a new Level and add it to the map - - - - - - Add a Level to the map - - the Level to add - - - Add a Level to the map - - - - - - Return all possible levels as a list of Level objects. - - all possible levels as a list of Level objects - - - Return all possible levels as a list of Level objects. - - - - - - Lookup a named level from the map - - 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 - the level in the map with the name specified - - - Lookup a named level from the map. The name of the level to lookup is taken - from the property of the - argument. - - - If no level with the specified name is found then the - argument is added to the level map - and returned. - - - - - - The internal representation of caller location information. - - - - This class uses the System.Diagnostics.StackTrace class to generate - a call stack. The caller's information is then extracted from this stack. - - - The System.Diagnostics.StackTrace class is not supported on the - .NET Compact Framework 1.0 therefore caller location information is not - available on that framework. - - - The System.Diagnostics.StackTrace class has this to say about Release builds: - - - "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." - - - 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. - - - Nicko Cadell - Gert Driesen - - - - Constructor - - The declaring type of the method that is - the stack boundary into the logging system for this call. - - - Initializes a new instance of the - class based on the current thread. - - - - - - Constructor - - The fully qualified class name. - The method name. - The file name. - The line number of the method within the file. - - - Initializes a new instance of the - class with the specified data. - - - - - - Gets the fully qualified class name of the caller making the logging - request. - - - The fully qualified class name of the caller making the logging - request. - - - - Gets the fully qualified class name of the caller making the logging - request. - - - - - - Gets the file name of the caller. - - - The file name of the caller. - - - - Gets the file name of the caller. - - - - - - Gets the line number of the caller. - - - The line number of the caller. - - - - Gets the line number of the caller. - - - - - - Gets the method name of the caller. - - - The method name of the caller. - - - - Gets the method name of the caller. - - - - - - Gets all available caller information - - - All available caller information, in the format - fully.qualified.classname.of.caller.methodName(Filename:line) - - - - Gets all available caller information, in the format - fully.qualified.classname.of.caller.methodName(Filename:line) - - - - - - Gets the stack frames from the stack trace of the caller making the log request - - - - - The fully qualified type of the LocationInfo class. - - - Used by the internal logger to record the Type of the - log message. - - - - - When location information is not available the constant - NA is returned. Current value of this string - constant is ?. - - - - - Exception base type for log4net. - - - - This type extends . It - does not add any new functionality but does differentiate the - type of exception being thrown. - - - Nicko Cadell - Gert Driesen - - - - Constructor - - - - Initializes a new instance of the class. - - - - - - Constructor - - A message to include with the exception. - - - Initializes a new instance of the class with - the specified message. - - - - - - Constructor - - A message to include with the exception. - A nested exception to include. - - - Initializes a new instance of the class - with the specified message and inner exception. - - - - - - Serialization constructor - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - - - Initializes a new instance of the class - with serialized data. - - - - - - Static manager that controls the creation of repositories - - - - Static manager that controls the creation of repositories - - - This class is used by the wrapper managers (e.g. ) - to provide access to the objects. - - - This manager also holds the that is used to - lookup and create repositories. The selector can be set either programmatically using - the property, or by setting the log4net.RepositorySelector - AppSetting in the applications config file to the fully qualified type name of the - selector to use. - - - Nicko Cadell - Gert Driesen - - - - Private constructor to prevent instances. Only static methods should be used. - - - - Private constructor to prevent instances. Only static methods should be used. - - - - - - Hook the shutdown event - - - - On the full .NET runtime, the static constructor hooks up the - AppDomain.ProcessExit and AppDomain.DomainUnload> events. - These are used to shutdown the log4net system as the application exits. - - - - - - Register for ProcessExit and DomainUnload events on the AppDomain - - - - 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. - - - - - - Return the default instance. - - the repository to lookup in - Return the default instance - - - Gets the for the repository specified - by the argument. - - - - - - Returns the default instance. - - The assembly to use to lookup the repository. - The default instance. - - - - Return the default instance. - - the repository to lookup in - Return the default instance - - - Gets the for the repository specified - by the argument. - - - - - - Returns the default instance. - - The assembly to use to lookup the repository. - The default instance. - - - Returns the default instance. - - - - - - Returns the named logger if it exists. - - The repository to lookup in. - The fully qualified logger name to look for. - - The logger found, or null if the named logger does not exist in the - specified repository. - - - - If the named logger exists (in the specified repository) then it - returns a reference to the logger, otherwise it returns - null. - - - - - - Returns the named logger if it exists. - - The assembly to use to lookup the repository. - The fully qualified logger name to look for. - - The logger found, or null if the named logger does not exist in the - specified assembly's repository. - - - - If the named logger exists (in the specified assembly's repository) then it - returns a reference to the logger, otherwise it returns - null. - - - - - - Returns all the currently defined loggers in the specified repository. - - The repository to lookup in. - All the defined loggers. - - - The root logger is not included in the returned array. - - - - - - Returns all the currently defined loggers in the specified assembly's repository. - - The assembly to use to lookup the repository. - All the defined loggers. - - - The root logger is not included in the returned array. - - - - - - Retrieves or creates a named logger. - - The repository to lookup in. - The name of the logger to retrieve. - The logger with the name specified. - - - Retrieves a logger named as the - parameter. If the named logger already exists, then the - existing instance will be returned. Otherwise, a new instance is - created. - - - By default, loggers do not have a set level but inherit - it from the hierarchy. This is one of the central features of - log4net. - - - - - - Retrieves or creates a named logger. - - The assembly to use to lookup the repository. - The name of the logger to retrieve. - The logger with the name specified. - - - Retrieves a logger named as the - parameter. If the named logger already exists, then the - existing instance will be returned. Otherwise, a new instance is - created. - - - By default, loggers do not have a set level but inherit - it from the hierarchy. This is one of the central features of - log4net. - - - - - - Shorthand for . - - The repository to lookup in. - The of which the fullname will be used as the name of the logger to retrieve. - The logger with the name specified. - - - Gets the logger for the fully qualified name of the type specified. - - - - - - Shorthand for . - - the assembly to use to lookup the repository - The of which the fullname will be used as the name of the logger to retrieve. - The logger with the name specified. - - - Gets the logger for the fully qualified name of the type specified. - - - - - - Shuts down the log4net system. - - - - Calling this method will safely close and remove all - appenders in all the loggers including root contained in all the - default repositories. - - - Some appenders need to be closed before the application exists. - Otherwise, pending logging events might be lost. - - - The 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. - - - - - - Shuts down the repository for the repository specified. - - The repository to shutdown. - - - Calling this method will safely close and remove all - appenders in all the loggers including root contained in the - repository for the specified. - - - Some appenders need to be closed before the application exists. - Otherwise, pending logging events might be lost. - - - The 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. - - - - - - Shuts down the repository for the repository specified. - - The assembly to use to lookup the repository. - - - Calling this method will safely 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 specified. - - - Some appenders need to be closed before the application exists. - Otherwise, pending logging events might be lost. - - - The 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. - - - - - - Resets all values contained in this repository instance to their defaults. - - The repository to reset. - - - 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 null, - sets their additivity flag to true and sets the level - of the root logger to . Moreover, - message disabling is set its default "off" value. - - - - - - Resets all values contained in this repository instance to their defaults. - - The assembly to use to lookup the repository to reset. - - - 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 null, - sets their additivity flag to true and sets the level - of the root logger to . Moreover, - message disabling is set its default "off" value. - - - - - - Creates a repository with the specified name. - - The name of the repository, this must be unique amongst repositories. - The created for the repository. - - - CreateDomain is obsolete. Use CreateRepository instead of CreateDomain. - - - Creates the default type of which is a - object. - - - The name must be unique. Repositories cannot be redefined. - An will be thrown if the repository already exists. - - - The specified repository already exists. - - - - Creates a repository with the specified name. - - The name of the repository, this must be unique amongst repositories. - The created for the repository. - - - Creates the default type of which is a - object. - - - The name must be unique. Repositories cannot be redefined. - An will be thrown if the repository already exists. - - - The specified repository already exists. - - - - Creates a repository with the specified name and repository type. - - The name of the repository, this must be unique to the repository. - A that implements - and has a no arg constructor. An instance of this type will be created to act - as the for the repository specified. - The created for the repository. - - - CreateDomain is obsolete. Use CreateRepository instead of CreateDomain. - - - The name must be unique. Repositories cannot be redefined. - An Exception will be thrown if the repository already exists. - - - The specified repository already exists. - - - - Creates a repository with the specified name and repository type. - - The name of the repository, this must be unique to the repository. - A that implements - and has a no arg constructor. An instance of this type will be created to act - as the for the repository specified. - The created for the repository. - - - The name must be unique. Repositories cannot be redefined. - An Exception will be thrown if the repository already exists. - - - The specified repository already exists. - - - - Creates a repository for the specified assembly and repository type. - - The assembly to use to get the name of the repository. - A that implements - and has a no arg constructor. An instance of this type will be created to act - as the for the repository specified. - The created for the repository. - - - CreateDomain is obsolete. Use CreateRepository instead of CreateDomain. - - - The created will be associated with the repository - specified such that a call to with the - same assembly specified will return the same repository instance. - - - - - - Creates a repository for the specified assembly and repository type. - - The assembly to use to get the name of the repository. - A that implements - and has a no arg constructor. An instance of this type will be created to act - as the for the repository specified. - The created for the repository. - - - The created will be associated with the repository - specified such that a call to with the - same assembly specified will return the same repository instance. - - - - - - Gets an array of all currently defined repositories. - - An array of all the known objects. - - - Gets an array of all currently defined repositories. - - - - - - Gets or sets the repository selector used by the . - - - The repository selector used by the . - - - - The repository selector () is used by - the to create and select repositories - (). - - - The caller to supplies either a string name - or an assembly (if not supplied the assembly is inferred using - ). - - - This context is used by the selector to lookup a specific repository. - - - For the full .NET Framework, the default repository is DefaultRepositorySelector; - for the .NET Compact Framework CompactRepositorySelector is the default - repository. - - - - - - Internal method to get pertinent version info. - - A string of version info. - - - - Called when the event fires - - the that is exiting - null - - - Called when the event fires. - - - When the event is triggered the log4net system is . - - - - - - Called when the event fires - - the that is exiting - null - - - Called when the event fires. - - - When the event is triggered the log4net system is . - - - - - - The fully qualified type of the LoggerManager class. - - - Used by the internal logger to record the Type of the - log message. - - - - - Initialize the default repository selector - - - - - Implementation of the interface. - - - - This class should be used as the base for all wrapper implementations. - - - Nicko Cadell - Gert Driesen - - - - Constructs a new wrapper for the specified logger. - - The logger to wrap. - - - Constructs a new wrapper for the specified logger. - - - - - - Gets the implementation behind this wrapper object. - - - The object that this object is implementing. - - - - The Logger 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. - - - - - - The logger that this object is wrapping - - - - - Portable data structure used by - - - - Portable data structure used by - - - Nicko Cadell - - - - The logger name. - - - - The logger name. - - - - - - Level of logging event. - - - - Level of logging event. Level cannot be Serializable - because it is a flyweight. Due to its special serialization it - cannot be declared final either. - - - - - - The application supplied message. - - - - The application supplied message of logging event. - - - - - - The name of thread - - - - The name of thread in which this logging event was generated - - - - - - Gets or sets the local time the event was logged - - - - Prefer using the setter, since local time can be ambiguous. - - - - - - Gets or sets the UTC time the event was logged - - - - The TimeStamp is stored in the UTC time zone. - - - - - - Location information for the caller. - - - - Location information for the caller. - - - - - - String representation of the user - - - - String representation of the user's windows name, - like DOMAIN\username - - - - - - String representation of the identity. - - - - String representation of the current thread's principal identity. - - - - - - The string representation of the exception - - - - The string representation of the exception - - - - - - String representation of the AppDomain. - - - - String representation of the AppDomain. - - - - - - Additional event specific properties - - - - A logger or an appender may attach additional - properties to specific events. These properties - have a string key and an object value. - - - - - - The internal representation of logging events. - - - - When an affirmative decision is made to log then a - instance is created. This instance - is passed around to the different log4net components. - - - This class is of concern to those wishing to extend log4net. - - - Some of the values in instances of - 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 - . There is a performance penalty - for incurred by calling but it - is essential to maintaining data consistency. - - - Nicko Cadell - Gert Driesen - Douglas de la Torre - Daniel Cazzulino - - - - Initializes a new instance of the class - from the supplied parameters. - - The declaring type of the method that is - the stack boundary into the logging system for this call. - The repository this event is logged in. - The name of the logger of this event. - The level of this event. - The message of this event. - The exception for this event. - - - Except , and , - all fields of LoggingEvent are filled when actually needed. Call - to cache all data locally - to prevent inconsistencies. - - This method is called by the log4net framework - to create a logging event. - - - - - - Initializes a new instance of the class - using specific data. - - The declaring type of the method that is - the stack boundary into the logging system for this call. - The repository this event is logged in. - Data used to initialize the logging event. - The fields in the struct that have already been fixed. - - - This constructor is provided to allow a - to be created independently of the log4net framework. This can - be useful if you require a custom serialization scheme. - - - Use the method to obtain an - instance of the class. - - - The parameter should be used to specify which fields in the - struct have been preset. Fields not specified in the - will be captured from the environment if requested or fixed. - - - - - - Initializes a new instance of the class - using specific data. - - The declaring type of the method that is - the stack boundary into the logging system for this call. - The repository this event is logged in. - Data used to initialize the logging event. - - - This constructor is provided to allow a - to be created independently of the log4net framework. This can - be useful if you require a custom serialization scheme. - - - Use the method to obtain an - instance of the class. - - - This constructor sets this objects flags to , - this assumes that all the data relating to this event is passed in via the - parameter and no other data should be captured from the environment. - - - - - - Initializes a new instance of the class - using specific data. - - Data used to initialize the logging event. - - - This constructor is provided to allow a - to be created independently of the log4net framework. This can - be useful if you require a custom serialization scheme. - - - Use the method to obtain an - instance of the class. - - - This constructor sets this objects flags to , - this assumes that all the data relating to this event is passed in via the - parameter and no other data should be captured from the environment. - - - - - - Serialization constructor - - The that holds the serialized object data. - The that contains contextual information about the source or destination. - - - Initializes a new instance of the class - with serialized data. - - - - - - Gets the time when the current process started. - - - This is the time when this process started. - - - - The TimeStamp is stored internally in UTC and converted to the local time zone for this computer. - - - Tries to get the start time for the current process. - Failing that it returns the time of the first call to - this property. - - - 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. - - - - - - Gets the UTC time when the current process started. - - - This is the UTC time when this process started. - - - - Tries to get the start time for the current process. - Failing that it returns the time of the first call to - this property. - - - 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. - - - - - - Gets the of the logging event. - - - The of the logging event. - - - - Gets the of the logging event. - - - - - - Gets the time of the logging event. - - - The time of the logging event. - - - - The TimeStamp is stored in UTC and converted to the local time zone for this computer. - - - - - - Gets UTC the time of the logging event. - - - The UTC time of the logging event. - - - - - Gets the name of the logger that logged the event. - - - The name of the logger that logged the event. - - - - Gets the name of the logger that logged the event. - - - - - - Gets the location information for this logging event. - - - The location information for this logging event. - - - - The collected information is cached for future use. - - - See the class for more information on - supported frameworks and the different behavior in Debug and - Release builds. - - - - - - Gets the message object used to initialize this event. - - - The message object used to initialize this event. - - - - 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 - property must be used - not this property. - - - If there is no defined message object for this event then - null will be returned. - - - - - - Gets the exception object used to initialize this event. - - - The exception object used to initialize this event. - - - - 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 - method must be used - not this property. - - - If there is no defined exception object for this event then - null will be returned. - - - - - - The that this event was created in. - - - - The that this event was created in. - - - - - - Ensure that the repository is set. - - the value for the repository - - - - Gets the message, rendered through the . - - - The message rendered through the . - - - - The collected information is cached for future use. - - - - - - Write the rendered message to a TextWriter - - the writer to write the message to - - - Unlike the property this method - does store the message data in the internal cache. Therefore - if called only once this method should be faster than the - property, however if the message is - to be accessed multiple times then the property will be more efficient. - - - - - - Gets the name of the current thread. - - - The name of the current thread, or the thread ID when - the name is not available. - - - - The collected information is cached for future use. - - - - - - Gets the name of the current user. - - - The name of the current user, or NOT AVAILABLE when the - underlying runtime has no support for retrieving the name of the - current user. - - - - Calls WindowsIdentity.GetCurrent().Name to get the name of - the current windows user. - - - 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. - - - However, the WindowsIdentity.GetCurrent() call seems to - return different objects every time, so the current implementation - doesn't do this type of caching. - - - Timing for these operations: - - - - Method - Results - - - WindowsIdentity.GetCurrent() - 10000 loops, 00:00:00.2031250 seconds - - - WindowsIdentity.GetCurrent().Name - 10000 loops, 00:00:08.0468750 seconds - - - - This means we could speed things up almost 40 times by caching the - value of the WindowsIdentity.GetCurrent().Name property, since - this takes (8.04-0.20) = 7.84375 seconds. - - - - - - Gets the identity of the current thread principal. - - - The string name of the identity of the current thread principal. - - - - Calls System.Threading.Thread.CurrentPrincipal.Identity.Name to get - the name of the current thread principal. - - - - - - Gets the AppDomain friendly name. - - - The AppDomain friendly name. - - - - Gets the AppDomain friendly name. - - - - - - Additional event specific properties. - - - Additional event specific properties. - - - - A logger or an appender may attach additional - properties to specific events. These properties - have a string key and an object value. - - - 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 - and . - - - Once the properties have been fixed 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. - - - - - - The fixed fields in this event - - - The set of fields that are fixed in this event - - - - Fields will not be fixed if they have previously been fixed. - It is not possible to 'unfix' a field. - - - - - - Serializes this object into the provided. - - The to populate with data. - The destination for this serialization. - - - The data in this event must be fixed before it can be serialized. - - - The method must be called during the - method call if this event - is to be used outside that method. - - - - - - Gets the portable data for this . - - The for this event. - - - A new can be constructed using a - instance. - - - Does a fix of the data - in the logging event before returning the event data. - - - - - - Gets the portable data for this . - - The set of data to ensure is fixed in the LoggingEventData - The for this event. - - - A new can be constructed using a - instance. - - - - - - Returns this event's exception's rendered using the - . - - - This event's exception's rendered using the . - - - - Obsolete. Use instead. - - - - - - Returns this event's exception's rendered using the - . - - - This event's exception's rendered using the . - - - - Returns this event's exception's rendered using the - . - - - - - - Fix instance fields that hold volatile data. - - - - Some of the values in instances of - 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 - . There is a performance penalty - incurred by calling but it - is essential to maintaining data consistency. - - - Calling is equivalent to - calling passing the parameter - false. - - - See for more - information. - - - - - - Fixes instance fields that hold volatile data. - - Set to true to not fix data that takes a long time to fix. - - - Some of the values in instances of - 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 - . There is a performance penalty - for incurred by calling but it - is essential to maintaining data consistency. - - - The 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 param - to true. This setting will ignore the - and settings. - - - Set to false to ensure that all - settings are fixed. - - - - - - Fix the fields specified by the parameter - - the fields to fix - - - Only fields specified in the will be fixed. - Fields will not be fixed if they have previously been fixed. - It is not possible to 'unfix' a field. - - - - - - Lookup a composite property in this event - - the key for the property to lookup - the value for the property - - - This event has composite properties that combine together properties from - several different contexts in the following order: - - - this events properties - - This event has that can be set. These - properties are specific to this event only. - - - - the thread properties - - The that are set on the current - thread. These properties are shared by all events logged on this thread. - - - - the global properties - - The that are set globally. These - properties are shared by all the threads in the AppDomain. - - - - - - - - - Get all the composite properties in this event - - the containing all the properties - - - See for details of the composite properties - stored by the event. - - - This method returns a single containing all the - properties defined for this event. - - - - - - The internal logging event data. - - - - - The internal logging event data. - - - - - The internal logging event data. - - - - - The fully qualified Type of the calling - logger class in the stack frame (i.e. the declaring type of the method). - - - - - The application supplied message of logging event. - - - - - The exception that was thrown. - - - This is not serialized. The string representation - is serialized instead. - - - - - The repository that generated the logging event - - - This is not serialized. - - - - - The fix state for this event - - - These flags indicate which fields have been fixed. - Not serialized. - - - - - Indicated that the internal cache is updateable (ie not fixed) - - - This is a seperate flag to m_fixFlags as it allows incrementel fixing and simpler - changes in the caching strategy. - - - - - The key into the Properties map for the host name value. - - - - - The key into the Properties map for the thread identity value. - - - - - The key into the Properties map for the user name value. - - - - - Implementation of wrapper interface. - - - - This implementation of the interface - forwards to the held by the base class. - - - This logger has methods to allow the caller to log at the following - levels: - - - - DEBUG - - The and methods log messages - at the DEBUG level. That is the level with that name defined in the - repositories . The default value - for this level is . The - property tests if this level is enabled for logging. - - - - INFO - - The and methods log messages - at the INFO level. That is the level with that name defined in the - repositories . The default value - for this level is . The - property tests if this level is enabled for logging. - - - - WARN - - The and methods log messages - at the WARN level. That is the level with that name defined in the - repositories . The default value - for this level is . The - property tests if this level is enabled for logging. - - - - ERROR - - The and methods log messages - at the ERROR level. That is the level with that name defined in the - repositories . The default value - for this level is . The - property tests if this level is enabled for logging. - - - - FATAL - - The and methods log messages - at the FATAL level. That is the level with that name defined in the - repositories . The default value - for this level is . The - property tests if this level is enabled for logging. - - - - - The values for these levels and their semantic meanings can be changed by - configuring the for the repository. - - - Nicko Cadell - Gert Driesen - - - - Construct a new wrapper for the specified logger. - - The logger to wrap. - - - Construct a new wrapper for the specified logger. - - - - - - Virtual method called when the configuration of the repository changes - - the repository holding the levels - - - Virtual method called when the configuration of the repository changes - - - - - - Logs a message object with the DEBUG level. - - The message object to log. - - - This method first checks if this logger is DEBUG - enabled by comparing the level of this logger with the - DEBUG level. If this logger is - DEBUG enabled, then it converts the message object - (passed as parameter) to a string by invoking the appropriate - . 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. - - - WARNING Note that passing an - to this method will print the name of the - but no stack trace. To print a stack trace use the - form instead. - - - - - - Logs a message object with the DEBUG level - - The message object to log. - The exception to log, including its stack trace. - - - Logs a message object with the DEBUG level including - the stack trace of the passed - as a parameter. - - - See the form for more detailed information. - - - - - - - Logs a formatted message string with the DEBUG level. - - A String containing zero or more format items - An Object array containing zero or more objects to format - - - The message is formatted using the method. See - String.Format for details of the syntax of the format string and the behavior - of the formatting. - - - The string is formatted using the - format provider. To specify a localized provider use the - method. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - Logs a formatted message string with the DEBUG level. - - A String containing zero or more format items - An Object to format - - - The message is formatted using the method. See - String.Format for details of the syntax of the format string and the behavior - of the formatting. - - - The string is formatted using the - format provider. To specify a localized provider use the - method. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - Logs a formatted message string with the DEBUG level. - - A String containing zero or more format items - An Object to format - An Object to format - - - The message is formatted using the method. See - String.Format for details of the syntax of the format string and the behavior - of the formatting. - - - The string is formatted using the - format provider. To specify a localized provider use the - method. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - Logs a formatted message string with the DEBUG level. - - A String containing zero or more format items - An Object to format - An Object to format - An Object to format - - - The message is formatted using the method. See - String.Format for details of the syntax of the format string and the behavior - of the formatting. - - - The string is formatted using the - format provider. To specify a localized provider use the - method. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - Logs a formatted message string with the DEBUG level. - - An that supplies culture-specific formatting information - A String containing zero or more format items - An Object array containing zero or more objects to format - - - The message is formatted using the method. See - String.Format for details of the syntax of the format string and the behavior - of the formatting. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - Logs a message object with the INFO level. - - The message object to log. - - - This method first checks if this logger is INFO - enabled by comparing the level of this logger with the - INFO level. If this logger is - INFO enabled, then it converts the message object - (passed as parameter) to a string by invoking the appropriate - . 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. - - - WARNING Note that passing an - to this method will print the name of the - but no stack trace. To print a stack trace use the - form instead. - - - - - - Logs a message object with the INFO level. - - The message object to log. - The exception to log, including its stack trace. - - - Logs a message object with the INFO level including - the stack trace of the - passed as a parameter. - - - See the form for more detailed information. - - - - - - - Logs a formatted message string with the INFO level. - - A String containing zero or more format items - An Object array containing zero or more objects to format - - - The message is formatted using the method. See - String.Format for details of the syntax of the format string and the behavior - of the formatting. - - - The string is formatted using the - format provider. To specify a localized provider use the - method. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - Logs a formatted message string with the INFO level. - - A String containing zero or more format items - An Object to format - - - The message is formatted using the method. See - String.Format for details of the syntax of the format string and the behavior - of the formatting. - - - The string is formatted using the - format provider. To specify a localized provider use the - method. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - Logs a formatted message string with the INFO level. - - A String containing zero or more format items - An Object to format - An Object to format - - - The message is formatted using the method. See - String.Format for details of the syntax of the format string and the behavior - of the formatting. - - - The string is formatted using the - format provider. To specify a localized provider use the - method. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - Logs a formatted message string with the INFO level. - - A String containing zero or more format items - An Object to format - An Object to format - An Object to format - - - The message is formatted using the method. See - String.Format for details of the syntax of the format string and the behavior - of the formatting. - - - The string is formatted using the - format provider. To specify a localized provider use the - method. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - Logs a formatted message string with the INFO level. - - An that supplies culture-specific formatting information - A String containing zero or more format items - An Object array containing zero or more objects to format - - - The message is formatted using the method. See - String.Format for details of the syntax of the format string and the behavior - of the formatting. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - Logs a message object with the WARN level. - - the message object to log - - - This method first checks if this logger is WARN - enabled by comparing the level of this logger with the - WARN level. If this logger is - WARN enabled, then it converts the message object - (passed as parameter) to a string by invoking the appropriate - . 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. - - - WARNING Note that passing an to this - method will print the name of the but no - stack trace. To print a stack trace use the - form instead. - - - - - - Logs a message object with the WARN level - - The message object to log. - The exception to log, including its stack trace. - - - Logs a message object with the WARN level including - the stack trace of the - passed as a parameter. - - - See the form for more detailed information. - - - - - - - Logs a formatted message string with the WARN level. - - A String containing zero or more format items - An Object array containing zero or more objects to format - - - The message is formatted using the method. See - String.Format for details of the syntax of the format string and the behavior - of the formatting. - - - The string is formatted using the - format provider. To specify a localized provider use the - method. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - Logs a formatted message string with the WARN level. - - A String containing zero or more format items - An Object to format - - - The message is formatted using the method. See - String.Format for details of the syntax of the format string and the behavior - of the formatting. - - - The string is formatted using the - format provider. To specify a localized provider use the - method. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - Logs a formatted message string with the WARN level. - - A String containing zero or more format items - An Object to format - An Object to format - - - The message is formatted using the method. See - String.Format for details of the syntax of the format string and the behavior - of the formatting. - - - The string is formatted using the - format provider. To specify a localized provider use the - method. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - Logs a formatted message string with the WARN level. - - A String containing zero or more format items - An Object to format - An Object to format - An Object to format - - - The message is formatted using the method. See - String.Format for details of the syntax of the format string and the behavior - of the formatting. - - - The string is formatted using the - format provider. To specify a localized provider use the - method. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - Logs a formatted message string with the WARN level. - - An that supplies culture-specific formatting information - A String containing zero or more format items - An Object array containing zero or more objects to format - - - The message is formatted using the method. See - String.Format for details of the syntax of the format string and the behavior - of the formatting. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - Logs a message object with the ERROR level. - - The message object to log. - - - This method first checks if this logger is ERROR - enabled by comparing the level of this logger with the - ERROR level. If this logger is - ERROR enabled, then it converts the message object - (passed as parameter) to a string by invoking the appropriate - . 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. - - - WARNING Note that passing an to this - method will print the name of the but no - stack trace. To print a stack trace use the - form instead. - - - - - - Logs a message object with the ERROR level - - The message object to log. - The exception to log, including its stack trace. - - - Logs a message object with the ERROR level including - the stack trace of the - passed as a parameter. - - - See the form for more detailed information. - - - - - - - Logs a formatted message string with the ERROR level. - - A String containing zero or more format items - An Object array containing zero or more objects to format - - - The message is formatted using the method. See - String.Format for details of the syntax of the format string and the behavior - of the formatting. - - - The string is formatted using the - format provider. To specify a localized provider use the - method. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - Logs a formatted message string with the ERROR level. - - A String containing zero or more format items - An Object to format - - - The message is formatted using the method. See - String.Format for details of the syntax of the format string and the behavior - of the formatting. - - - The string is formatted using the - format provider. To specify a localized provider use the - method. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - Logs a formatted message string with the ERROR level. - - A String containing zero or more format items - An Object to format - An Object to format - - - The message is formatted using the method. See - String.Format for details of the syntax of the format string and the behavior - of the formatting. - - - The string is formatted using the - format provider. To specify a localized provider use the - method. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - Logs a formatted message string with the ERROR level. - - A String containing zero or more format items - An Object to format - An Object to format - An Object to format - - - The message is formatted using the method. See - String.Format for details of the syntax of the format string and the behavior - of the formatting. - - - The string is formatted using the - format provider. To specify a localized provider use the - method. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - Logs a formatted message string with the ERROR level. - - An that supplies culture-specific formatting information - A String containing zero or more format items - An Object array containing zero or more objects to format - - - The message is formatted using the method. See - String.Format for details of the syntax of the format string and the behavior - of the formatting. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - Logs a message object with the FATAL level. - - The message object to log. - - - This method first checks if this logger is FATAL - enabled by comparing the level of this logger with the - FATAL level. If this logger is - FATAL enabled, then it converts the message object - (passed as parameter) to a string by invoking the appropriate - . 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. - - - WARNING Note that passing an to this - method will print the name of the but no - stack trace. To print a stack trace use the - form instead. - - - - - - Logs a message object with the FATAL level - - The message object to log. - The exception to log, including its stack trace. - - - Logs a message object with the FATAL level including - the stack trace of the - passed as a parameter. - - - See the form for more detailed information. - - - - - - - Logs a formatted message string with the FATAL level. - - A String containing zero or more format items - An Object array containing zero or more objects to format - - - The message is formatted using the method. See - String.Format for details of the syntax of the format string and the behavior - of the formatting. - - - The string is formatted using the - format provider. To specify a localized provider use the - method. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - Logs a formatted message string with the FATAL level. - - A String containing zero or more format items - An Object to format - - - The message is formatted using the method. See - String.Format for details of the syntax of the format string and the behavior - of the formatting. - - - The string is formatted using the - format provider. To specify a localized provider use the - method. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - Logs a formatted message string with the FATAL level. - - A String containing zero or more format items - An Object to format - An Object to format - - - The message is formatted using the method. See - String.Format for details of the syntax of the format string and the behavior - of the formatting. - - - The string is formatted using the - format provider. To specify a localized provider use the - method. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - Logs a formatted message string with the FATAL level. - - A String containing zero or more format items - An Object to format - An Object to format - An Object to format - - - The message is formatted using the method. See - String.Format for details of the syntax of the format string and the behavior - of the formatting. - - - The string is formatted using the - format provider. To specify a localized provider use the - method. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - Logs a formatted message string with the FATAL level. - - An that supplies culture-specific formatting information - A String containing zero or more format items - An Object array containing zero or more objects to format - - - The message is formatted using the method. See - String.Format for details of the syntax of the format string and the behavior - of the formatting. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - Checks if this logger is enabled for the DEBUG - level. - - - true if this logger is enabled for DEBUG events, - false otherwise. - - - - This function is intended to lessen the computational cost of - disabled log debug statements. - - - For some log Logger object, when you write: - - - log.Debug("This is entry number: " + i ); - - - You incur the cost constructing the message, concatenation in - this case, regardless of whether the message is logged or not. - - - If you are worried about speed, then you should write: - - - if (log.IsDebugEnabled()) - { - log.Debug("This is entry number: " + i ); - } - - - This way you will not incur the cost of parameter - construction if debugging is disabled for log. On - the other hand, if the log is debug enabled, you - will incur the cost of evaluating whether the logger is debug - enabled twice. Once in IsDebugEnabled and once in - the Debug. This is an insignificant overhead - since evaluating a logger takes about 1% of the time it - takes to actually log. - - - - - - Checks if this logger is enabled for the INFO level. - - - true if this logger is enabled for INFO events, - false otherwise. - - - - See for more information and examples - of using this method. - - - - - - - Checks if this logger is enabled for the WARN level. - - - true if this logger is enabled for WARN events, - false otherwise. - - - - See for more information and examples - of using this method. - - - - - - - Checks if this logger is enabled for the ERROR level. - - - true if this logger is enabled for ERROR events, - false otherwise. - - - - See for more information and examples of using this method. - - - - - - - Checks if this logger is enabled for the FATAL level. - - - true if this logger is enabled for FATAL events, - false otherwise. - - - - See for more information and examples of using this method. - - - - - - - Event handler for the event - - the repository - Empty - - - - The fully qualified name of this declaring type not the type of any subclass. - - - - - provides method information without actually referencing a System.Reflection.MethodBase - as that would require that the containing assembly is loaded. - - - - - - constructs a method item for an unknown method. - - - - - constructs a method item from the name of the method. - - - - - - constructs a method item from the name of the method and its parameters. - - - - - - - constructs a method item from a method base by determining the method name and its parameters. - - - - - - Gets the method name of the caller making the logging - request. - - - The method name of the caller making the logging - request. - - - - Gets the method name of the caller making the logging - request. - - - - - - Gets the method parameters of the caller making - the logging request. - - - The method parameters of the caller making - the logging request - - - - Gets the method parameters of the caller making - the logging request. - - - - - - The fully qualified type of the StackFrameItem class. - - - Used by the internal logger to record the Type of the - log message. - - - - - When location information is not available the constant - NA is returned. Current value of this string - constant is ?. - - - - - A SecurityContext used by log4net when interacting with protected resources - - - - 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. - - - Nicko Cadell - - - - Impersonate this SecurityContext - - State supplied by the caller - An instance that will - revoke the impersonation of this SecurityContext, or null - - - Impersonate this security context. Further calls on the current - thread should now be made in the security context provided - by this object. When the result - method is called the security - context of the thread should be reverted to the state it was in - before was called. - - - - - - The providers default instances. - - - - A configured component that interacts with potentially protected system - resources uses a to provide the elevated - privileges required. If the object has - been not been explicitly provided to the component then the component - will request one from this . - - - By default the is - an instance of which returns only - objects. This is a reasonable default - where the privileges required are not know by the system. - - - This default behavior can be overridden by subclassing the - and overriding the method to return - the desired objects. The default provider - can be replaced by programmatically setting the value of the - property. - - - An alternative is to use the log4net.Config.SecurityContextProviderAttribute - This attribute can be applied to an assembly in the same way as the - log4net.Config.XmlConfiguratorAttribute". The attribute takes - the type to use as the as an argument. - - - Nicko Cadell - - - - The default provider - - - - - Gets or sets the default SecurityContextProvider - - - The default SecurityContextProvider - - - - The default provider is used by configured components that - require a and have not had one - given to them. - - - By default this is an instance of - that returns objects. - - - The default provider can be set programmatically by setting - the value of this property to a sub class of - that has the desired behavior. - - - - - - Protected default constructor to allow subclassing - - - - Protected default constructor to allow subclassing - - - - - - Create a SecurityContext for a consumer - - The consumer requesting the SecurityContext - An impersonation context - - - The default implementation is to return a . - - - Subclasses should override this method to provide their own - behavior. - - - - - - provides stack frame information without actually referencing a System.Diagnostics.StackFrame - as that would require that the containing assembly is loaded. - - - - - - returns a stack frame item from a stack frame. This - - - - - - - Gets the fully qualified class name of the caller making the logging - request. - - - The fully qualified class name of the caller making the logging - request. - - - - Gets the fully qualified class name of the caller making the logging - request. - - - - - - Gets the file name of the caller. - - - The file name of the caller. - - - - Gets the file name of the caller. - - - - - - Gets the line number of the caller. - - - The line number of the caller. - - - - Gets the line number of the caller. - - - - - - Gets the method name of the caller. - - - The method name of the caller. - - - - Gets the method name of the caller. - - - - - - Gets all available caller information - - - All available caller information, in the format - fully.qualified.classname.of.caller.methodName(Filename:line) - - - - Gets all available caller information, in the format - fully.qualified.classname.of.caller.methodName(Filename:line) - - - - - - The fully qualified type of the StackFrameItem class. - - - Used by the internal logger to record the Type of the - log message. - - - - - When location information is not available the constant - NA is returned. Current value of this string - constant is ?. - - - - - An evaluator that triggers after specified number of seconds. - - - - This evaluator will trigger if the specified time period - has passed since last check. - - - Robert Sevcik - - - - The time threshold for triggering in seconds. Zero means it won't trigger at all. - - - - - The UTC time of last check. This gets updated when the object is created and when the evaluator triggers. - - - - - The default time threshold for triggering in seconds. Zero means it won't trigger at all. - - - - - Create a new evaluator using the time threshold in seconds. - - - - Create a new evaluator using the time threshold in seconds. - - - This evaluator will trigger if the specified time period - has passed since last check. - - - - - - Create a new evaluator using the specified time threshold in seconds. - - - The time threshold in seconds to trigger after. - Zero means it won't trigger at all. - - - - Create a new evaluator using the specified time threshold in seconds. - - - This evaluator will trigger if the specified time period - has passed since last check. - - - - - - The time threshold in seconds to trigger after - - - The time threshold in seconds to trigger after. - Zero means it won't trigger at all. - - - - This evaluator will trigger if the specified time period - has passed since last check. - - - - - - Is this the triggering event? - - The event to check - This method returns true, if the specified time period - has passed since last check.. - Otherwise it returns false - - - This evaluator will trigger if the specified time period - has passed since last check. - - - - - - Delegate used to handle creation of new wrappers. - - The logger to wrap in a wrapper. - - - Delegate used to handle creation of new wrappers. This delegate - is called from the - method to construct the wrapper for the specified logger. - - - The delegate to use is supplied to the - constructor. - - - - - - Maps between logger objects and wrapper objects. - - - - This class maintains a mapping between objects and - objects. Use the method to - lookup the for the specified . - - - New wrapper instances are created by the - method. The default behavior is for this method to delegate construction - of the wrapper to the delegate supplied - to the constructor. This allows specialization of the behavior without - requiring subclassing of this type. - - - Nicko Cadell - Gert Driesen - - - - Initializes a new instance of the - - The handler to use to create the wrapper objects. - - - Initializes a new instance of the class with - the specified handler to create the wrapper objects. - - - - - - Gets the wrapper object for the specified logger. - - The wrapper object for the specified logger - - - If the logger is null then the corresponding wrapper is null. - - - Looks up the wrapper it it has previously been requested and - returns it. If the wrapper has never been requested before then - the virtual method is - called. - - - - - - Gets the map of logger repositories. - - - Map of logger repositories. - - - - Gets the hashtable that is keyed on . The - values are hashtables keyed on with the - value being the corresponding . - - - - - - Creates the wrapper object for the specified logger. - - The logger to wrap in a wrapper. - The wrapper object for the logger. - - - This implementation uses the - passed to the constructor to create the wrapper. This method - can be overridden in a subclass. - - - - - - Called when a monitored repository shutdown event is received. - - The that is shutting down - - - This method is called when a that this - is holding loggers for has signaled its shutdown - event . The default - behavior of this method is to release the references to the loggers - and their wrappers generated for this repository. - - - - - - Event handler for repository shutdown event. - - The sender of the event. - The event args. - - - - Map of logger repositories to hashtables of ILogger to ILoggerWrapper mappings - - - - - The handler to use to create the extension wrapper objects. - - - - - Internal reference to the delegate used to register for repository shutdown events. - - - - - Formats a as "HH:mm:ss,fff". - - - - Formats a in the format "HH:mm:ss,fff" for example, "15:49:37,459". - - - Nicko Cadell - Gert Driesen - - - - Renders the date into a string. Format is "HH:mm:ss". - - The date to render into a string. - The string builder to write to. - - - 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. - - - - - - Renders the date into a string. Format is "HH:mm:ss,fff". - - The date to render into a string. - The writer to write to. - - - Uses the method to generate the - time string up to the seconds and then appends the current - milliseconds. The results from are - cached and is called at most once - per second. - - - Sub classes should override - rather than . - - - - - - String constant used to specify AbsoluteTimeDateFormat in layouts. Current value is ABSOLUTE. - - - - - String constant used to specify DateTimeDateFormat in layouts. Current value is DATE. - - - - - String constant used to specify ISO8601DateFormat in layouts. Current value is ISO8601. - - - - - Last stored time with precision up to the second. - - - - - Last stored time with precision up to the second, formatted - as a string. - - - - - Last stored time with precision up to the second, formatted - as a string. - - - - - Formats a as "dd MMM yyyy HH:mm:ss,fff" - - - - Formats a in the format - "dd MMM yyyy HH:mm:ss,fff" for example, - "06 Nov 1994 15:49:37,459". - - - Nicko Cadell - Gert Driesen - Angelika Schnagl - - - - Default constructor. - - - - Initializes a new instance of the class. - - - - - - Formats the date without the milliseconds part - - The date to format. - The string builder to write to. - - - Formats a DateTime in the format "dd MMM yyyy HH:mm:ss" - for example, "06 Nov 1994 15:49:37". - - - The base class will append the ",fff" milliseconds section. - This method will only be called at most once per second. - - - - - - The format info for the invariant culture. - - - - - Render a as a string. - - - - Interface to abstract the rendering of a - instance into a string. - - - The method is used to render the - date to a text writer. - - - Nicko Cadell - Gert Driesen - - - - Formats the specified date as a string. - - The date to format. - The writer to write to. - - - Format the as a string and write it - to the provided. - - - - - - Formats the as "yyyy-MM-dd HH:mm:ss,fff". - - - - Formats the specified as a string: "yyyy-MM-dd HH:mm:ss,fff". - - - Nicko Cadell - Gert Driesen - - - - Default constructor - - - - Initializes a new instance of the class. - - - - - - Formats the date without the milliseconds part - - The date to format. - The string builder to write to. - - - Formats the date specified as a string: "yyyy-MM-dd HH:mm:ss". - - - The base class will append the ",fff" milliseconds section. - This method will only be called at most once per second. - - - - - - Formats the using the method. - - - - Formats the using the method. - - - Nicko Cadell - Gert Driesen - - - - Constructor - - The format string. - - - Initializes a new instance of the class - with the specified format string. - - - The format string must be compatible with the options - that can be supplied to . - - - - - - Formats the date using . - - The date to convert to a string. - The writer to write to. - - - Uses the date format string supplied to the constructor to call - the method to format the date. - - - - - - The format string used to format the . - - - - The format string must be compatible with the options - that can be supplied to . - - - - - - This filter drops all . - - - - 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. - - - Nicko Cadell - Gert Driesen - - - - Default constructor - - - - - Always returns the integer constant - - the LoggingEvent to filter - Always returns - - - Ignores the event being logged and just returns - . This can be used to change the default filter - chain behavior from to . This filter - should only be used as the last filter in the chain - as any further filters will be ignored! - - - - - - The return result from - - - - The return result from - - - - - - The log event must be dropped immediately without - consulting with the remaining filters, if any, in the chain. - - - - - This filter is neutral with respect to the log event. - The remaining filters, if any, should be consulted for a final decision. - - - - - The log event must be logged immediately without - consulting with the remaining filters, if any, in the chain. - - - - - Subclass this type to implement customized logging event filtering - - - - Users should extend this class to implement customized logging - event filtering. Note that and - , 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. - - - This abstract class assumes and also imposes that filters be - organized in a linear chain. The - method of each filter is called sequentially, in the order of their - addition to the chain. - - - The method must return one - of the integer constants , - or . - - - If the value is returned, then the log event is dropped - immediately without consulting with the remaining filters. - - - If the value 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. - - - If the value is returned, then the log - event is logged without consulting the remaining filters. - - - The philosophy of log4net filters is largely inspired from the - Linux ipchains. - - - Nicko Cadell - Gert Driesen - - - - Points to the next filter in the filter chain. - - - - See for more information. - - - - - - Initialize the filter with the options set - - - - This is part of the delayed object - activation scheme. The method must - be called on this object after the configuration properties have - been set. Until is called this - object is in an undefined state and must not be used. - - - If any of the configuration properties are modified then - must be called again. - - - Typically filter's options become active immediately on set, - however this method must still be called. - - - - - - Decide if the should be logged through an appender. - - The to decide upon - The decision of the filter - - - If the decision is , then the event will be - dropped. If the decision is , then the next - filter, if any, will be invoked. If the decision is then - the event will be logged without consulting with other filters in - the chain. - - - This method is marked abstract and must be implemented - in a subclass. - - - - - - Property to get and set the next filter - - - The next filter in the chain - - - - Filters are typically composed into chains. This property allows the next filter in - the chain to be accessed. - - - - - - Implement this interface to provide customized logging event filtering - - - - Users should implement this interface to implement customized logging - event filtering. Note that and - , 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. - - - This abstract class assumes and also imposes that filters be - organized in a linear chain. The - method of each filter is called sequentially, in the order of their - addition to the chain. - - - The method must return one - of the integer constants , - or . - - - If the value is returned, then the log event is dropped - immediately without consulting with the remaining filters. - - - If the value 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. - - - If the value is returned, then the log - event is logged without consulting the remaining filters. - - - The philosophy of log4net filters is largely inspired from the - Linux ipchains. - - - Nicko Cadell - Gert Driesen - - - - Decide if the logging event should be logged through an appender. - - The LoggingEvent to decide upon - The decision of the filter - - - If the decision is , then the event will be - dropped. If the decision is , then the next - filter, if any, will be invoked. If the decision is then - the event will be logged without consulting with other filters in - the chain. - - - - - - Property to get and set the next filter - - - The next filter in the chain - - - - Filters are typically composed into chains. This property allows the next filter in - the chain to be accessed. - - - - - - This is a very simple filter based on matching. - - - - The filter admits two options and - . If there is an exact match between the value - of the option and the of the - , then the method returns in - case the option value is set - to true, if it is false then - is returned. If the does not match then - the result will be . - - - Nicko Cadell - Gert Driesen - - - - flag to indicate if the filter should on a match - - - - - the to match against - - - - - Default constructor - - - - - when matching - - - - The property is a flag that determines - the behavior when a matching is found. If the - flag is set to true then the filter will the - logging event, otherwise it will the event. - - - The default is true i.e. to the event. - - - - - - The that the filter will match - - - - The level that this filter will attempt to match against the - level. If a match is found then - the result depends on the value of . - - - - - - Tests if the of the logging event matches that of the filter - - the event to filter - see remarks - - - If the of the event matches the level of the - filter then the result of the function depends on the - value of . If it is true then - the function will return , it it is false then it - will return . If the does not match then - the result will be . - - - - - - This is a simple filter based on matching. - - - - The filter admits three options and - that determine the range of priorities that are matched, and - . If there is a match between the range - of priorities and the of the , then the - method returns in case the - option value is set to true, if it is false - then is returned. If there is no match, is returned. - - - Nicko Cadell - Gert Driesen - - - - Flag to indicate the behavior when matching a - - - - - the minimum value to match - - - - - the maximum value to match - - - - - Default constructor - - - - - when matching and - - - - The property is a flag that determines - the behavior when a matching is found. If the - flag is set to true then the filter will the - logging event, otherwise it will the event. - - - The default is true i.e. to the event. - - - - - - Set the minimum matched - - - - The minimum level that this filter will attempt to match against the - level. If a match is found then - the result depends on the value of . - - - - - - Sets the maximum matched - - - - The maximum level that this filter will attempt to match against the - level. If a match is found then - the result depends on the value of . - - - - - - Check if the event should be logged. - - the logging event to check - see remarks - - - If the of the logging event is outside the range - matched by this filter then - is returned. If the is matched then the value of - is checked. If it is true then - is returned, otherwise - is returned. - - - - - - Simple filter to match a string in the event's logger name. - - - - The works very similar to the . It admits two - options and . If the - of the starts - with the value of the option, then the - method returns in - case the option value is set to true, - if it is false then is returned. - - - Daniel Cazzulino - - - - Flag to indicate the behavior when we have a match - - - - - The logger name string to substring match against the event - - - - - Default constructor - - - - - when matching - - - - The property is a flag that determines - the behavior when a matching is found. If the - flag is set to true then the filter will the - logging event, otherwise it will the event. - - - The default is true i.e. to the event. - - - - - - The that the filter will match - - - - 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 ). The match is - case sensitive. If a match is found then - the result depends on the value of . - - - - - - Check if this filter should allow the event to be logged - - the event being logged - see remarks - - - The rendered message is matched against the . - If the equals the beginning of - the incoming () - then a match will have occurred. If no match occurs - this function will return - allowing other filters to check the event. If a match occurs then - the value of is checked. If it is - true then is returned otherwise - is returned. - - - - - - Simple filter to match a keyed string in the - - - - Simple filter to match a keyed string in the - - - As the MDC has been replaced with layered properties the - should be used instead. - - - Nicko Cadell - Gert Driesen - - - - Simple filter to match a string in the - - - - Simple filter to match a string in the - - - As the MDC has been replaced with named stacks stored in the - properties collections the should - be used instead. - - - Nicko Cadell - Gert Driesen - - - - Default constructor - - - - Sets the to "NDC". - - - - - - Simple filter to match a string an event property - - - - Simple filter to match a string in the value for a - specific event property - - - Nicko Cadell - - - - The key to use to lookup the string from the event properties - - - - - Default constructor - - - - - The key to lookup in the event properties and then match against. - - - - The key name to use to lookup in the properties map of the - . The match will be performed against - the value of this property if it exists. - - - - - - Check if this filter should allow the event to be logged - - the event being logged - see remarks - - - The event property for the is matched against - the . - If the occurs as a substring within - the property value then a match will have occurred. If no match occurs - this function will return - allowing other filters to check the event. If a match occurs then - the value of is checked. If it is - true then is returned otherwise - is returned. - - - - - - Simple filter to match a string in the rendered message - - - - Simple filter to match a string in the rendered message - - - Nicko Cadell - Gert Driesen - - - - Flag to indicate the behavior when we have a match - - - - - The string to substring match against the message - - - - - A string regex to match - - - - - A regex object to match (generated from m_stringRegexToMatch) - - - - - Default constructor - - - - - Initialize and precompile the Regex if required - - - - This is part of the delayed object - activation scheme. The method must - be called on this object after the configuration properties have - been set. Until is called this - object is in an undefined state and must not be used. - - - If any of the configuration properties are modified then - must be called again. - - - - - - when matching or - - - - The property is a flag that determines - the behavior when a matching is found. If the - flag is set to true then the filter will the - logging event, otherwise it will the event. - - - The default is true i.e. to the event. - - - - - - Sets the static string to match - - - - 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 . - - - One of or - must be specified. - - - - - - Sets the regular expression to match - - - - 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 . - - - One of or - must be specified. - - - - - - Check if this filter should allow the event to be logged - - the event being logged - see remarks - - - The rendered message is matched against the . - If the occurs as a substring within - the message then a match will have occurred. If no match occurs - this function will return - allowing other filters to check the event. If a match occurs then - the value of is checked. If it is - true then is returned otherwise - is returned. - - - - - - The log4net Global Context. - - - - The GlobalContext provides a location for global debugging - information to be stored. - - - The global context has a properties map and these properties can - be included in the output of log messages. The - supports selecting and outputing these properties. - - - By default the log4net:HostName property is set to the name of - the current machine. - - - - - GlobalContext.Properties["hostname"] = Environment.MachineName; - - - - Nicko Cadell - - - - Private Constructor. - - - Uses a private access modifier to prevent instantiation of this class. - - - - - The global properties map. - - - The global properties map. - - - - The global properties map. - - - - - - The global context properties instance - - - - - The ILog interface is use by application to log messages into - the log4net framework. - - - - Use the to obtain logger instances - that implement this interface. The - static method is used to get logger instances. - - - 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. - - - 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. - - - Simple example of logging messages - - 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"); - } - - - - - Nicko Cadell - Gert Driesen - - - Log a message object with the level. - - Log a message object with the level. - - The message object to log. - - - This method first checks if this logger is DEBUG - enabled by comparing the level of this logger with the - level. If this logger is - DEBUG enabled, then it converts the message object - (passed as parameter) to a string by invoking the appropriate - . 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. - - WARNING Note that passing an - to this method will print the name of the - but no stack trace. To print a stack trace use the - form instead. - - - - - - - - Log a message object with the level including - the stack trace of the passed - as a parameter. - - The message object to log. - The exception to log, including its stack trace. - - - See the form for more detailed information. - - - - - - - Log a formatted string with the level. - - Logs a formatted message string with the level. - - A String containing zero or more format items - An Object array containing zero or more objects to format - - - The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior - of the formatting. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - - - Logs a formatted message string with the level. - - A String containing zero or more format items - An Object to format - - - The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior - of the formatting. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - - - Logs a formatted message string with the level. - - A String containing zero or more format items - An Object to format - An Object to format - - - The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior - of the formatting. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - - - Logs a formatted message string with the level. - - A String containing zero or more format items - An Object to format - An Object to format - An Object to format - - - The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior - of the formatting. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - - - Logs a formatted message string with the level. - - An that supplies culture-specific formatting information - A String containing zero or more format items - An Object array containing zero or more objects to format - - - The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior - of the formatting. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - - Log a message object with the level. - - Logs a message object with the level. - - - - This method first checks if this logger is INFO - enabled by comparing the level of this logger with the - level. If this logger is - INFO enabled, then it converts the message object - (passed as parameter) to a string by invoking the appropriate - . 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. - - WARNING Note that passing an - to this method will print the name of the - but no stack trace. To print a stack trace use the - form instead. - - - The message object to log. - - - - - - Logs a message object with the INFO level including - the stack trace of the passed - as a parameter. - - The message object to log. - The exception to log, including its stack trace. - - - See the form for more detailed information. - - - - - - - Log a formatted message string with the level. - - Logs a formatted message string with the level. - - A String containing zero or more format items - An Object array containing zero or more objects to format - - - The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior - of the formatting. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - - - Logs a formatted message string with the level. - - A String containing zero or more format items - An Object to format - - - The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior - of the formatting. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - - - Logs a formatted message string with the level. - - A String containing zero or more format items - An Object to format - An Object to format - - - The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior - of the formatting. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - - - Logs a formatted message string with the level. - - A String containing zero or more format items - An Object to format - An Object to format - An Object to format - - - The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior - of the formatting. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - - - Logs a formatted message string with the level. - - An that supplies culture-specific formatting information - A String containing zero or more format items - An Object array containing zero or more objects to format - - - The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior - of the formatting. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - - Log a message object with the level. - - Log a message object with the level. - - - - This method first checks if this logger is WARN - enabled by comparing the level of this logger with the - level. If this logger is - WARN enabled, then it converts the message object - (passed as parameter) to a string by invoking the appropriate - . 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. - - WARNING Note that passing an - to this method will print the name of the - but no stack trace. To print a stack trace use the - form instead. - - - The message object to log. - - - - - - Log a message object with the level including - the stack trace of the passed - as a parameter. - - The message object to log. - The exception to log, including its stack trace. - - - See the form for more detailed information. - - - - - - - Log a formatted message string with the level. - - Logs a formatted message string with the level. - - A String containing zero or more format items - An Object array containing zero or more objects to format - - - The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior - of the formatting. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - - - Logs a formatted message string with the level. - - A String containing zero or more format items - An Object to format - - - The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior - of the formatting. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - - - Logs a formatted message string with the level. - - A String containing zero or more format items - An Object to format - An Object to format - - - The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior - of the formatting. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - - - Logs a formatted message string with the level. - - A String containing zero or more format items - An Object to format - An Object to format - An Object to format - - - The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior - of the formatting. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - - - Logs a formatted message string with the level. - - An that supplies culture-specific formatting information - A String containing zero or more format items - An Object array containing zero or more objects to format - - - The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior - of the formatting. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - - Log a message object with the level. - - Logs a message object with the level. - - The message object to log. - - - This method first checks if this logger is ERROR - enabled by comparing the level of this logger with the - level. If this logger is - ERROR enabled, then it converts the message object - (passed as parameter) to a string by invoking the appropriate - . 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. - - WARNING Note that passing an - to this method will print the name of the - but no stack trace. To print a stack trace use the - form instead. - - - - - - - - Log a message object with the level including - the stack trace of the passed - as a parameter. - - The message object to log. - The exception to log, including its stack trace. - - - See the form for more detailed information. - - - - - - - Log a formatted message string with the level. - - Logs a formatted message string with the level. - - A String containing zero or more format items - An Object array containing zero or more objects to format - - - The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior - of the formatting. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - - - Logs a formatted message string with the level. - - A String containing zero or more format items - An Object to format - - - The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior - of the formatting. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - - - Logs a formatted message string with the level. - - A String containing zero or more format items - An Object to format - An Object to format - - - The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior - of the formatting. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - - - Logs a formatted message string with the level. - - A String containing zero or more format items - An Object to format - An Object to format - An Object to format - - - The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior - of the formatting. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - - - Logs a formatted message string with the level. - - An that supplies culture-specific formatting information - A String containing zero or more format items - An Object array containing zero or more objects to format - - - The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior - of the formatting. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - - Log a message object with the level. - - Log a message object with the level. - - - - This method first checks if this logger is FATAL - enabled by comparing the level of this logger with the - level. If this logger is - FATAL enabled, then it converts the message object - (passed as parameter) to a string by invoking the appropriate - . 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. - - WARNING Note that passing an - to this method will print the name of the - but no stack trace. To print a stack trace use the - form instead. - - - The message object to log. - - - - - - Log a message object with the level including - the stack trace of the passed - as a parameter. - - The message object to log. - The exception to log, including its stack trace. - - - See the form for more detailed information. - - - - - - - Log a formatted message string with the level. - - Logs a formatted message string with the level. - - A String containing zero or more format items - An Object array containing zero or more objects to format - - - The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior - of the formatting. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - - - Logs a formatted message string with the level. - - A String containing zero or more format items - An Object to format - - - The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior - of the formatting. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - - - Logs a formatted message string with the level. - - A String containing zero or more format items - An Object to format - An Object to format - - - The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior - of the formatting. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - - - Logs a formatted message string with the level. - - A String containing zero or more format items - An Object to format - An Object to format - An Object to format - - - The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior - of the formatting. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - - - Logs a formatted message string with the level. - - An that supplies culture-specific formatting information - A String containing zero or more format items - An Object array containing zero or more objects to format - - - The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior - of the formatting. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - - - Checks if this logger is enabled for the level. - - - true if this logger is enabled for events, false otherwise. - - - - This function is intended to lessen the computational cost of - disabled log debug statements. - - For some ILog interface log, when you write: - - log.Debug("This is entry number: " + i ); - - - You incur the cost constructing the message, string construction and concatenation in - this case, regardless of whether the message is logged or not. - - - If you are worried about speed (who isn't), then you should write: - - - if (log.IsDebugEnabled) - { - log.Debug("This is entry number: " + i ); - } - - - This way you will not incur the cost of parameter - construction if debugging is disabled for log. On - the other hand, if the log is debug enabled, you - will incur the cost of evaluating whether the logger is debug - enabled twice. Once in and once in - the . 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. - - Alternatively if your logger is available statically then the is debug - enabled state can be stored in a static variable like this: - - - private static readonly bool isDebugEnabled = log.IsDebugEnabled; - - - Then when you come to log you can write: - - - if (isDebugEnabled) - { - log.Debug("This is entry number: " + i ); - } - - - This way the debug enabled state is only queried once - when the class is loaded. Using a private static readonly - variable is the most efficient because it is a run time constant - and can be heavily optimized by the JIT compiler. - - - 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. - - - - - - - - Checks if this logger is enabled for the level. - - - true if this logger is enabled for events, false otherwise. - - - For more information see . - - - - - - - - Checks if this logger is enabled for the level. - - - true if this logger is enabled for events, false otherwise. - - - For more information see . - - - - - - - - Checks if this logger is enabled for the level. - - - true if this logger is enabled for events, false otherwise. - - - For more information see . - - - - - - - - Checks if this logger is enabled for the level. - - - true if this logger is enabled for events, false otherwise. - - - For more information see . - - - - - - - - A flexible layout configurable with pattern string that re-evaluates on each call. - - - This class is built on 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. - 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. - Please see for complete documentation. - - <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> - - - - - - The header PatternString - - - - - The footer PatternString - - - - - Constructs a DynamicPatternLayout using the DefaultConversionPattern - - - - The default pattern just produces the application supplied message. - - - - - - Constructs a DynamicPatternLayout using the supplied conversion pattern - - the pattern to use - - - - - - The header for the layout format. - - the layout header - - - The Header text will be appended before any logging events - are formatted and appended. - - The pattern will be formatted on each get operation. - - - - - The footer for the layout format. - - the layout footer - - - The Footer text will be appended after all the logging events - have been formatted and appended. - - The pattern will be formatted on each get operation. - - - - - A Layout that renders only the Exception text from the logging event - - - - A Layout that renders only the Exception text from the logging event. - - - This Layout should only be used with appenders that utilize multiple - layouts (e.g. ). - - - Nicko Cadell - Gert Driesen - - - - Default constructor - - - - Constructs a ExceptionLayout - - - - - - Activate component options - - - - Part of the component activation - framework. - - - This method does nothing as options become effective immediately. - - - - - - Gets the exception text from the logging event - - The TextWriter to write the formatted event to - the event being logged - - - Write the exception string to the . - The exception string is retrieved from . - - - - - - Interface implemented by layout objects - - - - An object is used to format a - as text. The method is called by an - appender to transform the into a string. - - - The layout can also supply and - text that is appender before any events and after all the events respectively. - - - Nicko Cadell - Gert Driesen - - - - Implement this method to create your own layout format. - - The TextWriter to write the formatted event to - The event to format - - - This method is called by an appender to format - the as text and output to a writer. - - - If the caller does not have a and prefers the - event to be formatted as a then the following - code can be used to format the event into a . - - - StringWriter writer = new StringWriter(); - Layout.Format(writer, loggingEvent); - string formattedEvent = writer.ToString(); - - - - - - The content type output by this layout. - - The content type - - - The content type output by this layout. - - - This is a MIME type e.g. "text/plain". - - - - - - The header for the layout format. - - the layout header - - - The Header text will be appended before any logging events - are formatted and appended. - - - - - - The footer for the layout format. - - the layout footer - - - The Footer text will be appended after all the logging events - have been formatted and appended. - - - - - - Flag indicating if this layout handle exceptions - - false if this layout handles exceptions - - - If this layout handles the exception object contained within - , then the layout should return - false. Otherwise, if the layout ignores the exception - object, then the layout should return true. - - - - - - Interface for raw layout objects - - - - Interface used to format a - to an object. - - - This interface should not be confused with the - interface. This interface is used in - only certain specialized situations where a raw object is - required rather than a formatted string. The - is not generally useful than this interface. - - - Nicko Cadell - Gert Driesen - - - - Implement this method to create your own layout format. - - The event to format - returns the formatted event - - - Implement this method to create your own layout format. - - - - - - Adapts any to a - - - - Where an is required this adapter - allows a to be specified. - - - Nicko Cadell - Gert Driesen - - - - The layout to adapt - - - - - Construct a new adapter - - the layout to adapt - - - Create the adapter for the specified . - - - - - - Format the logging event as an object. - - The event to format - returns the formatted event - - - Format the logging event as an object. - - - Uses the object supplied to - the constructor to perform the formatting. - - - - - - Extend this abstract class to create your own log layout format. - - - - This is the base implementation of the - interface. Most layout objects should extend this class. - - - - - - Subclasses must implement the - method. - - - Subclasses should set the in their default - constructor. - - - - Nicko Cadell - Gert Driesen - - - - The header text - - - - See for more information. - - - - - - The footer text - - - - See for more information. - - - - - - Flag indicating if this layout handles exceptions - - - - false if this layout handles exceptions - - - - - - Empty default constructor - - - - Empty default constructor - - - - - - Activate component options - - - - This is part of the delayed object - activation scheme. The method must - be called on this object after the configuration properties have - been set. Until is called this - object is in an undefined state and must not be used. - - - If any of the configuration properties are modified then - must be called again. - - - This method must be implemented by the subclass. - - - - - - Implement this method to create your own layout format. - - The TextWriter to write the formatted event to - The event to format - - - This method is called by an appender to format - the as text. - - - - - - Convenience method for easily formatting the logging event into a string variable. - - - - Creates a new StringWriter instance to store the formatted logging event. - - - - - The content type output by this layout. - - The content type is "text/plain" - - - The content type output by this layout. - - - This base class uses the value "text/plain". - To change this value a subclass must override this - property. - - - - - - The header for the layout format. - - the layout header - - - The Header text will be appended before any logging events - are formatted and appended. - - - - - - The footer for the layout format. - - the layout footer - - - The Footer text will be appended after all the logging events - have been formatted and appended. - - - - - - Flag indicating if this layout handles exceptions - - false if this layout handles exceptions - - - If this layout handles the exception object contained within - , then the layout should return - false. Otherwise, if the layout ignores the exception - object, then the layout should return true. - - - Set this value to override a this default setting. The default - value is true, this layout does not handle the exception. - - - - - - A flexible layout configurable with pattern string. - - - - The goal of this class is to a - as a string. The results - depend on the conversion pattern. - - - 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 - conversion specifiers. - - - You are free to insert any literal text within the conversion - pattern. - - - Each conversion specifier starts with a percent sign (%) and is - followed by optional format modifiers and a conversion - pattern name. 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. - - - Let the conversion pattern be "%-5level [%thread]: %message%newline" and assume - that the log4net environment was set to use a PatternLayout. Then the - statements - - - ILog log = LogManager.GetLogger(typeof(TestApp)); - log.Debug("Message 1"); - log.Warn("Message 2"); - - would yield the output - - DEBUG [main]: Message 1 - WARN [main]: Message 2 - - - 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 - %-5level means the level of the logging event should be left - justified to a width of five characters. - - - The recognized conversion pattern names are: - - - - Conversion Pattern Name - Effect - - - a - Equivalent to appdomain - - - appdomain - - Used to output the friendly name of the AppDomain where the - logging event was generated. - - - - aspnet-cache - - - Used to output all cache items in the case of %aspnet-cache or just one named item if used as %aspnet-cache{key} - - - This pattern is not available for Compact Framework or Client Profile assemblies. - - - - - aspnet-context - - - Used to output all context items in the case of %aspnet-context or just one named item if used as %aspnet-context{key} - - - This pattern is not available for Compact Framework or Client Profile assemblies. - - - - - aspnet-request - - - Used to output all request parameters in the case of %aspnet-request or just one named param if used as %aspnet-request{key} - - - This pattern is not available for Compact Framework or Client Profile assemblies. - - - - - aspnet-session - - - Used to output all session items in the case of %aspnet-session or just one named item if used as %aspnet-session{key} - - - This pattern is not available for Compact Framework or Client Profile assemblies. - - - - - c - Equivalent to logger - - - C - Equivalent to type - - - class - Equivalent to type - - - d - Equivalent to date - - - date - - - Used to output the date of the logging event in the local time zone. - To output the date in universal time use the %utcdate pattern. - The date conversion - specifier may be followed by a date format specifier enclosed - between braces. For example, %date{HH:mm:ss,fff} or - %date{dd MMM yyyy HH:mm:ss,fff}. If no date format specifier is - given then ISO8601 format is - assumed (). - - - The date format specifier admits the same syntax as the - time pattern string of the . - - - 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 - , - and respectively - . For example, - %date{ISO8601} or %date{ABSOLUTE}. - - - These dedicated date formatters perform significantly - better than . - - - - - exception - - - Used to output the exception passed in with the log message. - - - 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. - - - - - F - Equivalent to file - - - file - - - Used to output the file name where the logging request was - issued. - - - WARNING Generating caller location information is - extremely slow. Its use should be avoided unless execution speed - is not an issue. - - - See the note below on the availability of caller location information. - - - - - identity - - - Used to output the user name for the currently active user - (Principal.Identity.Name). - - - WARNING Generating caller information is - extremely slow. Its use should be avoided unless execution speed - is not an issue. - - - - - l - Equivalent to location - - - L - Equivalent to line - - - location - - - Used to output location information of the caller which generated - the logging event. - - - 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. - - - The location information can be very useful. However, its - generation is extremely slow. Its use should be avoided - unless execution speed is not an issue. - - - See the note below on the availability of caller location information. - - - - - level - - - Used to output the level of the logging event. - - - - - line - - - Used to output the line number from where the logging request - was issued. - - - WARNING Generating caller location information is - extremely slow. Its use should be avoided unless execution speed - is not an issue. - - - See the note below on the availability of caller location information. - - - - - logger - - - Used to output the logger of the logging event. The - logger conversion specifier can be optionally followed by - precision specifier, that is a decimal constant in - brackets. - - - 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. - - - For example, for the logger name "a.b.c" the pattern - %logger{2} will output "b.c". - - - - - m - Equivalent to message - - - M - Equivalent to method - - - message - - - Used to output the application supplied message associated with - the logging event. - - - - - mdc - - - 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 property. - - - - - method - - - Used to output the method name where the logging request was - issued. - - - WARNING Generating caller location information is - extremely slow. Its use should be avoided unless execution speed - is not an issue. - - - See the note below on the availability of caller location information. - - - - - n - Equivalent to newline - - - newline - - - Outputs the platform dependent line separator character or - characters. - - - 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. - - - - - ndc - - - Used to output the NDC (nested diagnostic context) associated - with the thread that generated the logging event. - - - - - p - Equivalent to level - - - P - Equivalent to property - - - properties - Equivalent to property - - - property - - - 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. %property{user} 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 log4net:HostName property is set to the name of machine on - which the event was originally logged. - - - If no key is specified, e.g. %property then all the keys and their - values are printed in a comma separated list. - - - 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. - - - - the event properties - - The event has that can be set. These - properties are specific to this event only. - - - - the thread properties - - The that are set on the current - thread. These properties are shared by all events logged on this thread. - - - - the global properties - - The that are set globally. These - properties are shared by all the threads in the AppDomain. - - - - - - - - r - Equivalent to timestamp - - - stacktrace - - - Used to output the stack trace of the logging event - The stack trace level specifier may be enclosed - between braces. For example, %stacktrace{level}. - If no stack trace level specifier is given then 1 is assumed - - - Output uses the format: - type3.MethodCall3 > type2.MethodCall2 > type1.MethodCall1 - - - This pattern is not available for Compact Framework assemblies. - - - - - stacktracedetail - - - Used to output the stack trace of the logging event - The stack trace level specifier may be enclosed - between braces. For example, %stacktracedetail{level}. - If no stack trace level specifier is given then 1 is assumed - - - Output uses the format: - type3.MethodCall3(type param,...) > type2.MethodCall2(type param,...) > type1.MethodCall1(type param,...) - - - This pattern is not available for Compact Framework assemblies. - - - - - t - Equivalent to thread - - - timestamp - - - Used to output the number of milliseconds elapsed since the start - of the application until the creation of the logging event. - - - - - thread - - - Used to output the name of the thread that generated the - logging event. Uses the thread number if no name is available. - - - - - type - - - Used to output the fully qualified type name of the caller - issuing the logging request. This conversion specifier - can be optionally followed by precision specifier, that - is a decimal constant in brackets. - - - 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. - - - For example, for the class name "log4net.Layout.PatternLayout", the - pattern %type{1} will output "PatternLayout". - - - WARNING Generating the caller class information is - slow. Thus, its use should be avoided unless execution speed is - not an issue. - - - See the note below on the availability of caller location information. - - - - - u - Equivalent to identity - - - username - - - Used to output the WindowsIdentity for the currently - active user. - - - WARNING Generating caller WindowsIdentity information is - extremely slow. Its use should be avoided unless execution speed - is not an issue. - - - - - utcdate - - - Used to output the date of the logging event in universal time. - The date conversion - specifier may be followed by a date format specifier enclosed - between braces. For example, %utcdate{HH:mm:ss,fff} or - %utcdate{dd MMM yyyy HH:mm:ss,fff}. If no date format specifier is - given then ISO8601 format is - assumed (). - - - The date format specifier admits the same syntax as the - time pattern string of the . - - - 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 - , - and respectively - . For example, - %utcdate{ISO8601} or %utcdate{ABSOLUTE}. - - - These dedicated date formatters perform significantly - better than . - - - - - w - Equivalent to username - - - x - Equivalent to ndc - - - X - Equivalent to mdc - - - % - - - The sequence %% outputs a single percent sign. - - - - - - The single letter patterns are deprecated in favor of the - longer more descriptive pattern names. - - - 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. - - - The optional format modifier is placed between the percent sign - and the conversion pattern name. - - - The first optional format modifier is the left justification - flag which is just the minus (-) character. Then comes the - optional minimum field width 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. - - - This behavior can be changed using the maximum field - width 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 - beginning 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. - - - Below are various format modifier examples for the logger - conversion specifier. - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Format modifierleft justifyminimum widthmaximum widthcomment
%20loggerfalse20none - - Left pad with spaces if the logger name is less than 20 - characters long. - -
%-20loggertrue20none - - Right pad with spaces if the logger - name is less than 20 characters long. - -
%.30loggerNAnone30 - - Truncate from the beginning if the logger - name is longer than 30 characters. - -
%20.30loggerfalse2030 - - 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. - -
%-20.30loggertrue2030 - - 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. - -
-
- - Note about caller location information.
- The following patterns %type %file %line %method %location %class %C %F %L %l %M - all generate caller location information. - Location information uses the System.Diagnostics.StackTrace class to generate - a call stack. The caller's information is then extracted from this stack. -
- - - The System.Diagnostics.StackTrace class is not supported on the - .NET Compact Framework 1.0 therefore caller location information is not - available on that framework. - - - - - The System.Diagnostics.StackTrace class has this to say about Release builds: - - - "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." - - - 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. - - - - Additional pattern converters may be registered with a specific - instance using the method. - -
- - This is a more detailed pattern. - %timestamp [%thread] %level %logger %ndc - %message%newline - - - 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. - %-6timestamp [%15.15thread] %-5level %30.30logger %ndc - %message%newline - - Nicko Cadell - Gert Driesen - Douglas de la Torre - Daniel Cazzulino -
- - - Default pattern string for log output. - - - - Default pattern string for log output. - Currently set to the string "%message%newline" - which just prints the application supplied message. - - - - - - A detailed conversion pattern - - - - A conversion pattern which includes Time, Thread, Logger, and Nested Context. - Current value is %timestamp [%thread] %level %logger %ndc - %message%newline. - - - - - - Internal map of converter identifiers to converter types. - - - - This static map is overridden by the m_converterRegistry instance map - - - - - - the pattern - - - - - the head of the pattern converter chain - - - - - patterns defined on this PatternLayout only - - - - - Initialize the global registry - - - - Defines the builtin global rules. - - - - - - Constructs a PatternLayout using the DefaultConversionPattern - - - - The default pattern just produces the application supplied message. - - - Note to Inheritors: This constructor calls the virtual method - . If you override this method be - aware that it will be called before your is called constructor. - - - As per the contract the - method must be called after the properties on this object have been - configured. - - - - - - Constructs a PatternLayout using the supplied conversion pattern - - the pattern to use - - - Note to Inheritors: This constructor calls the virtual method - . If you override this method be - aware that it will be called before your is called constructor. - - - When using this constructor the method - need not be called. This may not be the case when using a subclass. - - - - - - The pattern formatting string - - - - The ConversionPattern option. This is the string which - controls formatting and consists of a mix of literal content and - conversion specifiers. - - - - - - Create the pattern parser instance - - the pattern to parse - The that will format the event - - - Creates the used to parse the conversion string. Sets the - global and instance rules on the . - - - - - - Initialize layout options - - - - This is part of the delayed object - activation scheme. The method must - be called on this object after the configuration properties have - been set. Until is called this - object is in an undefined state and must not be used. - - - If any of the configuration properties are modified then - must be called again. - - - - - - Produces a formatted string as specified by the conversion pattern. - - the event being logged - The TextWriter to write the formatted event to - - - Parse the using the patter format - specified in the property. - - - - - - Add a converter to this PatternLayout - - the converter info - - - This version of the method is used by the configurator. - Programmatic users should use the alternative method. - - - - - - Add a converter to this PatternLayout - - the name of the conversion pattern for this converter - the type of the converter - - - 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 . - - - The specified must extend the - type. - - - - - - Write the event appdomain name to the output - - - - Writes the to the output writer. - - - Daniel Cazzulino - Nicko Cadell - - - - Write the event appdomain name to the output - - that will receive the formatted result. - the event being logged - - - Writes the to the output . - - - - - - Converter for items in the ASP.Net Cache. - - - - Outputs an item from the . - - - Ron Grabowski - - - - Write the ASP.Net Cache item to the output - - that will receive the formatted result. - The on which the pattern converter should be executed. - The under which the ASP.Net request is running. - - - Writes out the value of a named property. The property name - should be set in the - property. If no property has been set, all key value pairs from the Cache will - be written to the output. - - - - - - Converter for items in the . - - - - Outputs an item from the . - - - Ron Grabowski - - - - Write the ASP.Net HttpContext item to the output - - that will receive the formatted result. - The on which the pattern converter should be executed. - The under which the ASP.Net request is running. - - - Writes out the value of a named property. The property name - should be set in the - property. - - - - - - Abstract class that provides access to the current HttpContext () that - derived classes need. - - - This class handles the case when HttpContext.Current is null by writing - to the writer. - - Ron Grabowski - - - - Derived pattern converters must override this method in order to - convert conversion specifiers in the correct way. - - that will receive the formatted result. - The on which the pattern converter should be executed. - The under which the ASP.Net request is running. - - - - Converter for items in the ASP.Net Cache. - - - - Outputs an item from the . - - - Ron Grabowski - - - - Write the ASP.Net Cache item to the output - - that will receive the formatted result. - The on which the pattern converter should be executed. - The under which the ASP.Net request is running. - - - Writes out the value of a named property. The property name - should be set in the - property. - - - - - - Converter for items in the ASP.Net Cache. - - - - Outputs an item from the . - - - Ron Grabowski - - - - Write the ASP.Net Cache item to the output - - that will receive the formatted result. - The on which the pattern converter should be executed. - The under which the ASP.Net request is running. - - - Writes out the value of a named property. The property name - should be set in the - property. If no property has been set, all key value pairs from the Session will - be written to the output. - - - - - - Date pattern converter, uses a to format - the date of a . - - - - Render the to the writer as a string. - - - The value of the determines - the formatting of the date. The following values are allowed: - - - Option value - Output - - - ISO8601 - - Uses the formatter. - Formats using the "yyyy-MM-dd HH:mm:ss,fff" pattern. - - - - DATE - - Uses the formatter. - Formats using the "dd MMM yyyy HH:mm:ss,fff" for example, "06 Nov 1994 15:49:37,459". - - - - ABSOLUTE - - Uses the formatter. - Formats using the "HH:mm:ss,yyyy" for example, "15:49:37,459". - - - - other - - Any other pattern string uses the formatter. - This formatter passes the pattern string to the - method. - For details on valid patterns see - DateTimeFormatInfo Class. - - - - - - The is in the local time zone and is rendered in that zone. - To output the time in Universal time see . - - - Nicko Cadell - - - - The used to render the date to a string - - - - The used to render the date to a string - - - - - - Initialize the converter pattern based on the property. - - - - This is part of the delayed object - activation scheme. The method must - be called on this object after the configuration properties have - been set. Until is called this - object is in an undefined state and must not be used. - - - If any of the configuration properties are modified then - must be called again. - - - - - - Convert the pattern into the rendered message - - that will receive the formatted result. - the event being logged - - - Pass the to the - for it to render it to the writer. - - - The passed is in the local time zone. - - - - - - The fully qualified type of the DatePatternConverter class. - - - Used by the internal logger to record the Type of the - log message. - - - - - Write the exception text to the output - - - - 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. - - - Nicko Cadell - - - - Default constructor - - - - - Write the exception text to the output - - that will receive the formatted result. - the event being logged - - - 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 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. - - - Recognized values for the Option parameter are: - - - - Message - - - Source - - - StackTrace - - - TargetSite - - - HelpLink - - - - - - - Writes the caller location file name to the output - - - - Writes the value of the for - the event to the output writer. - - - Nicko Cadell - - - - Write the caller location file name to the output - - that will receive the formatted result. - the event being logged - - - Writes the value of the for - the to the output . - - - - - - Write the caller location info to the output - - - - Writes the to the output writer. - - - Nicko Cadell - - - - Write the caller location info to the output - - that will receive the formatted result. - the event being logged - - - Writes the to the output writer. - - - - - - Writes the event identity to the output - - - - Writes the value of the to - the output writer. - - - Daniel Cazzulino - Nicko Cadell - - - - Writes the event identity to the output - - that will receive the formatted result. - the event being logged - - - Writes the value of the - to - the output . - - - - - - Write the event level to the output - - - - Writes the display name of the event - to the writer. - - - Nicko Cadell - - - - Write the event level to the output - - that will receive the formatted result. - the event being logged - - - Writes the of the - to the . - - - - - - Write the caller location line number to the output - - - - Writes the value of the for - the event to the output writer. - - - Nicko Cadell - - - - Write the caller location line number to the output - - that will receive the formatted result. - the event being logged - - - Writes the value of the for - the to the output . - - - - - - Converter for logger name - - - - Outputs the of the event. - - - Nicko Cadell - - - - Gets the fully qualified name of the logger - - the event being logged - The fully qualified logger name - - - Returns the of the . - - - - - - Writes the event message to the output - - - - Uses the method - to write out the event message. - - - Nicko Cadell - - - - Writes the event message to the output - - that will receive the formatted result. - the event being logged - - - Uses the method - to write out the event message. - - - - - - Write the method name to the output - - - - Writes the caller location to - the output. - - - Nicko Cadell - - - - Write the method name to the output - - that will receive the formatted result. - the event being logged - - - Writes the caller location to - the output. - - - - - - Converter to output and truncate '.' separated strings - - - - This abstract class supports truncating a '.' 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. - - - Subclasses should override the method to - return the fully qualified string. - - - Nicko Cadell - - - - Initialize the converter - - - - This is part of the delayed object - activation scheme. The method must - be called on this object after the configuration properties have - been set. Until is called this - object is in an undefined state and must not be used. - - - If any of the configuration properties are modified then - must be called again. - - - - - - Get the fully qualified string data - - the event being logged - the fully qualified name - - - Overridden by subclasses to get the fully qualified name before the - precision is applied to it. - - - Return the fully qualified '.' (dot/period) separated string. - - - - - - Convert the pattern to the rendered message - - that will receive the formatted result. - the event being logged - - Render the to the precision - specified by the property. - - - - - The fully qualified type of the NamedPatternConverter class. - - - Used by the internal logger to record the Type of the - log message. - - - - - Converter to include event NDC - - - - Outputs the value of the event property named NDC. - - - The should be used instead. - - - Nicko Cadell - - - - Write the event NDC to the output - - that will receive the formatted result. - the event being logged - - - As the thread context stacks are now stored in named event properties - this converter simply looks up the value of the NDC property. - - - The should be used instead. - - - - - - Abstract class that provides the formatting functionality that - derived classes need. - - - 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. - - Nicko Cadell - - - - Initializes a new instance of the class. - - - - - Flag indicating if this converter handles the logging event exception - - false if this converter handles the logging event exception - - - If this converter handles the exception object contained within - , then this property should be set to - false. Otherwise, if the layout ignores the exception - object, then the property should be set to true. - - - Set this value to override a this default setting. The default - value is true, this converter does not handle the exception. - - - - - - Derived pattern converters must override this method in order to - convert conversion specifiers in the correct way. - - that will receive the formatted result. - The on which the pattern converter should be executed. - - - - Derived pattern converters must override this method in order to - convert conversion specifiers in the correct way. - - that will receive the formatted result. - The state object on which the pattern converter should be executed. - - - - Flag indicating if this converter handles exceptions - - - false if this converter handles exceptions - - - - - Property pattern converter - - - - Writes out the value of a named property. The property name - should be set in the - property. - - - If the is set to null - then all the properties are written as key value pairs. - - - Nicko Cadell - - - - Write the property value to the output - - that will receive the formatted result. - the event being logged - - - Writes out the value of a named property. The property name - should be set in the - property. - - - If the is set to null - then all the properties are written as key value pairs. - - - - - - Converter to output the relative time of the event - - - - Converter to output the time of the event relative to the start of the program. - - - Nicko Cadell - - - - Write the relative time to the output - - that will receive the formatted result. - the event being logged - - - Writes out the relative time of the event in milliseconds. - That is the number of milliseconds between the event - and the . - - - - - - Helper method to get the time difference between two DateTime objects - - start time (in the current local time zone) - end time (in the current local time zone) - the time difference in milliseconds - - - - Write the caller stack frames to the output - - - - Writes the to the output writer, using format: - type3.MethodCall3(type param,...) > type2.MethodCall2(type param,...) > type1.MethodCall1(type param,...) - - - Adam Davies - - - - The fully qualified type of the StackTraceDetailPatternConverter class. - - - Used by the internal logger to record the Type of the - log message. - - - - - Write the caller stack frames to the output - - - - Writes the to the output writer, using format: - type3.MethodCall3 > type2.MethodCall2 > type1.MethodCall1 - - - Michael Cromwell - - - - Initialize the converter - - - - This is part of the delayed object - activation scheme. The method must - be called on this object after the configuration properties have - been set. Until is called this - object is in an undefined state and must not be used. - - - If any of the configuration properties are modified then - must be called again. - - - - - - Write the strack frames to the output - - that will receive the formatted result. - the event being logged - - - Writes the to the output writer. - - - - - - Returns the Name of the method - - - This method was created, so this class could be used as a base class for StackTraceDetailPatternConverter - string - - - - The fully qualified type of the StackTracePatternConverter class. - - - Used by the internal logger to record the Type of the - log message. - - - - - Converter to include event thread name - - - - Writes the to the output. - - - Nicko Cadell - - - - Write the ThreadName to the output - - that will receive the formatted result. - the event being logged - - - Writes the to the . - - - - - - Pattern converter for the class name - - - - Outputs the of the event. - - - Nicko Cadell - - - - Gets the fully qualified name of the class - - the event being logged - The fully qualified type name for the caller location - - - Returns the of the . - - - - - - Converter to include event user name - - Douglas de la Torre - Nicko Cadell - - - - Convert the pattern to the rendered message - - that will receive the formatted result. - the event being logged - - - - Write the TimeStamp to the output - - - - Date pattern converter, uses a to format - the date of a . - - - Uses a to format the - in Universal time. - - - See the for details on the date pattern syntax. - - - - Nicko Cadell - - - - Write the TimeStamp to the output - - that will receive the formatted result. - the event being logged - - - Pass the to the - for it to render it to the writer. - - - The passed is in the local time zone, this is converted - to Universal time before it is rendered. - - - - - - - The fully qualified type of the UtcDatePatternConverter class. - - - Used by the internal logger to record the Type of the - log message. - - - - - Type converter for the interface - - - - Used to convert objects to the interface. - Supports converting from the interface to - the interface using the . - - - Nicko Cadell - Gert Driesen - - - - Can the sourceType be converted to an - - the source to be to be converted - true if the source type can be converted to - - - Test if the can be converted to a - . Only is supported - as the . - - - - - - Convert the value to a object - - the value to convert - the object - - - Convert the object to a - object. If the object - is a then the - is used to adapt between the two interfaces, otherwise an - exception is thrown. - - - - - - Extract the value of a property from the - - - - Extract the value of a property from the - - - Nicko Cadell - - - - Constructs a RawPropertyLayout - - - - - The name of the value to lookup in the LoggingEvent Properties collection. - - - Value to lookup in the LoggingEvent Properties collection - - - - String name of the property to lookup in the . - - - - - - Lookup the property for - - The event to format - returns property value - - - Looks up and returns the object value of the property - named . If there is no property defined - with than name then null will be returned. - - - - - - Extract the date from the - - - - Extract the date from the - - - Nicko Cadell - Gert Driesen - - - - Constructs a RawTimeStampLayout - - - - - Gets the as a . - - The event to format - returns the time stamp - - - Gets the as a . - - - The time stamp is in local time. To format the time stamp - in universal time use . - - - - - - Extract the date from the - - - - Extract the date from the - - - Nicko Cadell - Gert Driesen - - - - Constructs a RawUtcTimeStampLayout - - - - - Gets the as a . - - The event to format - returns the time stamp - - - Gets the as a . - - - The time stamp is in universal time. To format the time stamp - in local time use . - - - - - - A very simple layout - - - - SimpleLayout consists of the level of the log statement, - followed by " - " and then the log message itself. For example, - - DEBUG - Hello world - - - - Nicko Cadell - Gert Driesen - - - - Constructs a SimpleLayout - - - - - Initialize layout options - - - - This is part of the delayed object - activation scheme. The method must - be called on this object after the configuration properties have - been set. Until is called this - object is in an undefined state and must not be used. - - - If any of the configuration properties are modified then - must be called again. - - - - - - Produces a simple formatted output. - - the event being logged - The TextWriter to write the formatted event to - - - Formats the event as the level of the even, - followed by " - " and then the log message itself. The - output is terminated by a newline. - - - - - - Layout that formats the log events as XML elements. - - - - The output of the 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 external entity - in a separate file to form a correct XML file. - - - For example, if abc is the name of the file where - the output goes, then a well-formed XML file would - be: - - - <?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> - - - This approach enforces the independence of the - and the appender where it is embedded. - - - The version attribute helps components to correctly - interpret output generated by . The value of - this attribute should be "1.2" for release 1.2 and later. - - - Alternatively the Header and Footer properties can be - configured to output the correct XML header, open tag and close tag. - When setting the Header and Footer properties it is essential - that the underlying data store not be appendable otherwise the data - will become invalid XML. - - - Nicko Cadell - Gert Driesen - - - - Constructs an XmlLayout - - - - - Constructs an XmlLayout. - - - - The LocationInfo 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. - - - If you are embedding this layout within an SmtpAppender - then make sure to set the LocationInfo option of that - appender as well. - - - - - - The prefix to use for all element names - - - - The default prefix is log4net. Set this property - to change the prefix. If the prefix is set to an empty string - then no prefix will be written. - - - - - - Set whether or not to base64 encode the message. - - - - 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 ) will not be performed - on the log message. - - - - - - Set whether or not to base64 encode the property values. - - - - 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 ) will not be performed - on the property values. - - - - - - Initialize layout options - - - - This is part of the delayed object - activation scheme. The method must - be called on this object after the configuration properties have - been set. Until is called this - object is in an undefined state and must not be used. - - - If any of the configuration properties are modified then - must be called again. - - - Builds a cache of the element names - - - - - - Does the actual writing of the XML. - - The writer to use to output the event to. - The event to write. - - - Override the base class method - to write the to the . - - - - - - The prefix to use for all generated element names - - - - - Layout that formats the log events as XML elements. - - - - This is an abstract class that must be subclassed by an implementation - to conform to a specific schema. - - - Deriving classes must implement the method. - - - Nicko Cadell - Gert Driesen - - - - Protected constructor to support subclasses - - - - Initializes a new instance of the class - with no location info. - - - - - - Protected constructor to support subclasses - - - - The parameter determines whether - location information will be output by the layout. If - is set to true, then the - file name and line number of the statement at the origin of the log - statement will be output. - - - If you are embedding this layout within an SMTPAppender - then make sure to set the LocationInfo option of that - appender as well. - - - - - - Gets a value indicating whether to include location information in - the XML events. - - - true if location information should be included in the XML - events; otherwise, false. - - - - If is set to true, then the file - name and line number of the statement at the origin of the log - statement will be output. - - - If you are embedding this layout within an SMTPAppender - then make sure to set the LocationInfo option of that - appender as well. - - - - - - The string to replace characters that can not be expressed in XML with. - - - 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. - - - - - - - Initialize layout options - - - - This is part of the delayed object - activation scheme. The method must - be called on this object after the configuration properties have - been set. Until is called this - object is in an undefined state and must not be used. - - - If any of the configuration properties are modified then - must be called again. - - - - - - Gets the content type output by this layout. - - - As this is the XML layout, the value is always "text/xml". - - - - As this is the XML layout, the value is always "text/xml". - - - - - - Produces a formatted string. - - The event being logged. - The TextWriter to write the formatted event to - - - Format the and write it to the . - - - This method creates an that writes to the - . The is passed - to the method. Subclasses should override the - method rather than this method. - - - - - - Does the actual writing of the XML. - - The writer to use to output the event to. - The event to write. - - - Subclasses should override this method to format - the as XML. - - - - - - Flag to indicate if location information should be included in - the XML events. - - - - - The string to replace invalid chars with - - - - - Layout that formats the log events as XML elements compatible with the log4j schema - - - - Formats the log events according to the http://logging.apache.org/log4j schema. - - - Nicko Cadell - - - - The 1st of January 1970 in UTC - - - - - Constructs an XMLLayoutSchemaLog4j - - - - - Constructs an XMLLayoutSchemaLog4j. - - - - The LocationInfo 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. - - - If you are embedding this layout within an SMTPAppender - then make sure to set the LocationInfo option of that - appender as well. - - - - - - The version of the log4j schema to use. - - - - Only version 1.2 of the log4j schema is supported. - - - - - - Actually do the writing of the xml - - the writer to use - the event to write - - - Generate XML that is compatible with the log4j schema. - - - - - - The log4net Logical Thread Context. - - - - The LogicalThreadContext provides a location for specific debugging - information to be stored. - The LogicalThreadContext properties override any or - properties with the same name. - - - For .NET Standard 1.3 this class uses - System.Threading.AsyncLocal rather than . - - - 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 - supports selecting and outputting these properties. - - - 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. - - - The Logical Thread Context is managed on a per basis. - - - The requires a link time - for the - . - 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. - - - Example of using the thread context properties to store a username. - - LogicalThreadContext.Properties["user"] = userName; - log.Info("This log message has a LogicalThreadContext Property called 'user'"); - - - Example of how to push a message into the context stack - - 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 - - - - Nicko Cadell - - - - Private Constructor. - - - - Uses a private access modifier to prevent instantiation of this class. - - - - - - The thread properties map - - - The thread properties map - - - - The LogicalThreadContext properties override any - or properties with the same name. - - - - - - The thread stacks - - - stack map - - - - The logical thread stacks. - - - - - - The thread context properties instance - - - - - The thread context stacks instance - - - - - This class is used by client applications to request logger instances. - - - - This class has static methods that are used by a client to request - a logger instance. The method is - used to retrieve a logger. - - - See the interface for more details. - - - Simple example of logging messages - - 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"); - } - - - - - Nicko Cadell - Gert Driesen - - - - Initializes a new instance of the class. - - - Uses a private access modifier to prevent instantiation of this class. - - - - Returns the named logger if it exists. - - Returns the named logger if it exists. - - - - If the named logger exists (in the default repository) then it - returns a reference to the logger, otherwise it returns null. - - - The fully qualified logger name to look for. - The logger found, or null if no logger could be found. - - - Get the currently defined loggers. - - Returns all the currently defined loggers in the default repository. - - - The root logger is not included in the returned array. - - All the defined loggers. - - - Get or create a logger. - - Retrieves or creates a named logger. - - - - Retrieves a logger named as the - parameter. If the named logger already exists, then the - existing instance will be returned. Otherwise, a new instance is - created. - - By default, loggers do not have a set level but inherit - it from the hierarchy. This is one of the central features of - log4net. - - - The name of the logger to retrieve. - The logger with the name specified. - - - - Returns the named logger if it exists. - - - - If the named logger exists (in the specified repository) then it - returns a reference to the logger, otherwise it returns - null. - - - The repository to lookup in. - The fully qualified logger name to look for. - - The logger found, or null if the logger doesn't exist in the specified - repository. - - - - - Returns the named logger if it exists. - - - - If the named logger exists (in the repository for the specified assembly) then it - returns a reference to the logger, otherwise it returns - null. - - - The assembly to use to lookup the repository. - The fully qualified logger name to look for. - - The logger, or null if the logger doesn't exist in the specified - assembly's repository. - - - - - Returns all the currently defined loggers in the specified repository. - - The repository to lookup in. - - The root logger is not included in the returned array. - - All the defined loggers. - - - - Returns all the currently defined loggers in the specified assembly's repository. - - The assembly to use to lookup the repository. - - The root logger is not included in the returned array. - - All the defined loggers. - - - - Retrieves or creates a named logger. - - - - Retrieve a logger named as the - parameter. If the named logger already exists, then the - existing instance will be returned. Otherwise, a new instance is - created. - - - By default, loggers do not have a set level but inherit - it from the hierarchy. This is one of the central features of - log4net. - - - The repository to lookup in. - The name of the logger to retrieve. - The logger with the name specified. - - - - Retrieves or creates a named logger. - - - - Retrieve a logger named as the - parameter. If the named logger already exists, then the - existing instance will be returned. Otherwise, a new instance is - created. - - - By default, loggers do not have a set level but inherit - it from the hierarchy. This is one of the central features of - log4net. - - - The assembly to use to lookup the repository. - The name of the logger to retrieve. - The logger with the name specified. - - - - Shorthand for . - - - Get the logger for the fully qualified name of the type specified. - - The full name of will be used as the name of the logger to retrieve. - The logger with the name specified. - - - - Shorthand for . - - - Gets the logger for the fully qualified name of the type specified. - - The repository to lookup in. - The full name of will be used as the name of the logger to retrieve. - The logger with the name specified. - - - - Shorthand for . - - - Gets the logger for the fully qualified name of the type specified. - - The assembly to use to lookup the repository. - The full name of will be used as the name of the logger to retrieve. - The logger with the name specified. - - - - Shuts down the log4net system. - - - - Calling this method will safely close and remove all - appenders in all the loggers including root contained in all the - default repositories. - - - Some appenders need to be closed before the application exists. - Otherwise, pending logging events might be lost. - - The 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. - - - - - Shutdown a logger repository. - - Shuts down the default repository. - - - - Calling this method will safely close and remove all - appenders in all the loggers including root contained in the - default repository. - - Some appenders need to be closed before the application exists. - Otherwise, pending logging events might be lost. - - The 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. - - - - - - Shuts down the repository for the repository specified. - - - - Calling this method will safely close and remove all - appenders in all the loggers including root contained in the - specified. - - - Some appenders need to be closed before the application exists. - Otherwise, pending logging events might be lost. - - The 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. - - - The repository to shutdown. - - - - Shuts down the repository specified. - - - - Calling this method will safely close and remove all - appenders in all the loggers including root contained in the - repository. The repository is looked up using - the specified. - - - Some appenders need to be closed before the application exists. - Otherwise, pending logging events might be lost. - - - The 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. - - - The assembly to use to lookup the repository. - - - Reset the configuration of a repository - - Resets all values contained in this repository instance to their defaults. - - - - 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 null, - sets their additivity flag to true and sets the level - of the root logger to . Moreover, - message disabling is set to its default "off" value. - - - - - - Resets all values contained in this repository instance to their defaults. - - - - 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 null, - sets their additivity flag to true and sets the level - of the root logger to . Moreover, - message disabling is set to its default "off" value. - - - The repository to reset. - - - - Resets all values contained in this repository instance to their defaults. - - - - 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 null, - sets their additivity flag to true and sets the level - of the root logger to . Moreover, - message disabling is set to its default "off" value. - - - The assembly to use to lookup the repository to reset. - - - Get the logger repository. - - Returns the default instance. - - - - Gets the for the repository specified - by the callers assembly (). - - - The instance for the default repository. - - - - Returns the default instance. - - The default instance. - - - Gets the for the repository specified - by the argument. - - - The repository to lookup in. - - - - Returns the default instance. - - The default instance. - - - Gets the for the repository specified - by the argument. - - - The assembly to use to lookup the repository. - - - Get a logger repository. - - Returns the default instance. - - - - Gets the for the repository specified - by the callers assembly (). - - - The instance for the default repository. - - - - Returns the default instance. - - The default instance. - - - Gets the for the repository specified - by the argument. - - - The repository to lookup in. - - - - Returns the default instance. - - The default instance. - - - Gets the for the repository specified - by the argument. - - - The assembly to use to lookup the repository. - - - Create a domain - - Creates a repository with the specified repository type. - - - - CreateDomain is obsolete. Use CreateRepository instead of CreateDomain. - - - The created will be associated with the repository - specified such that a call to will return - the same repository instance. - - - A that implements - and has a no arg constructor. An instance of this type will be created to act - as the for the repository specified. - The created for the repository. - - - Create a logger repository. - - Creates a repository with the specified repository type. - - A that implements - and has a no arg constructor. An instance of this type will be created to act - as the for the repository specified. - The created for the repository. - - - The created will be associated with the repository - specified such that a call to will return - the same repository instance. - - - - - - Creates a repository with the specified name. - - - - CreateDomain is obsolete. Use CreateRepository instead of CreateDomain. - - - Creates the default type of which is a - object. - - - The name must be unique. Repositories cannot be redefined. - An will be thrown if the repository already exists. - - - The name of the repository, this must be unique amongst repositories. - The created for the repository. - The specified repository already exists. - - - - Creates a repository with the specified name. - - - - Creates the default type of which is a - object. - - - The name must be unique. Repositories cannot be redefined. - An will be thrown if the repository already exists. - - - The name of the repository, this must be unique amongst repositories. - The created for the repository. - The specified repository already exists. - - - - Creates a repository with the specified name and repository type. - - - - CreateDomain is obsolete. Use CreateRepository instead of CreateDomain. - - - The name must be unique. Repositories cannot be redefined. - An will be thrown if the repository already exists. - - - The name of the repository, this must be unique to the repository. - A that implements - and has a no arg constructor. An instance of this type will be created to act - as the for the repository specified. - The created for the repository. - The specified repository already exists. - - - - Creates a repository with the specified name and repository type. - - - - The name must be unique. Repositories cannot be redefined. - An will be thrown if the repository already exists. - - - The name of the repository, this must be unique to the repository. - A that implements - and has a no arg constructor. An instance of this type will be created to act - as the for the repository specified. - The created for the repository. - The specified repository already exists. - - - - Creates a repository for the specified assembly and repository type. - - - - CreateDomain is obsolete. Use CreateRepository instead of CreateDomain. - - - The created will be associated with the repository - specified such that a call to with the - same assembly specified will return the same repository instance. - - - The assembly to use to get the name of the repository. - A that implements - and has a no arg constructor. An instance of this type will be created to act - as the for the repository specified. - The created for the repository. - - - - Creates a repository for the specified assembly and repository type. - - - - The created will be associated with the repository - specified such that a call to with the - same assembly specified will return the same repository instance. - - - The assembly to use to get the name of the repository. - A that implements - and has a no arg constructor. An instance of this type will be created to act - as the for the repository specified. - The created for the repository. - - - - Gets the list of currently defined repositories. - - - - Get an array of all the objects that have been created. - - - An array of all the known objects. - - - - Flushes logging events buffered in all configured appenders in the default repository. - - The maximum time in milliseconds to wait for logging events from asycnhronous appenders to be flushed. - True if all logging events were flushed successfully, else false. - - - - Looks up the wrapper object for the logger specified. - - The logger to get the wrapper for. - The wrapper for the logger specified. - - - - Looks up the wrapper objects for the loggers specified. - - The loggers to get the wrappers for. - The wrapper objects for the loggers specified. - - - - Create the objects used by - this manager. - - The logger to wrap. - The wrapper for the logger specified. - - - - The wrapper map to use to hold the objects. - - - - - Implementation of Mapped Diagnostic Contexts. - - - - - The MDC is deprecated and has been replaced by the . - The current MDC implementation forwards to the ThreadContext.Properties. - - - - The MDC class is similar to the class except that it is - based on a map instead of a stack. It provides mapped - diagnostic contexts. A Mapped Diagnostic Context, 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. - - - The MDC is managed on a per thread basis. - - - - Nicko Cadell - Gert Driesen - - - - Initializes a new instance of the class. - - - Uses a private access modifier to prevent instantiation of this class. - - - - - Gets the context value identified by the parameter. - - The key to lookup in the MDC. - The string value held for the key, or a null reference if no corresponding value is found. - - - - The MDC is deprecated and has been replaced by the . - The current MDC implementation forwards to the ThreadContext.Properties. - - - - If the parameter does not look up to a - previously defined context then null will be returned. - - - - - - Add an entry to the MDC - - The key to store the value under. - The value to store. - - - - The MDC is deprecated and has been replaced by the . - The current MDC implementation forwards to the ThreadContext.Properties. - - - - Puts a context value (the parameter) as identified - with the parameter into the current thread's - context map. - - - If a value is already defined for the - specified then the value will be replaced. If the - is specified as null then the key value mapping will be removed. - - - - - - Removes the key value mapping for the key specified. - - The key to remove. - - - - The MDC is deprecated and has been replaced by the . - The current MDC implementation forwards to the ThreadContext.Properties. - - - - Remove the specified entry from this thread's MDC - - - - - - Clear all entries in the MDC - - - - - The MDC is deprecated and has been replaced by the . - The current MDC implementation forwards to the ThreadContext.Properties. - - - - Remove all the entries from this thread's MDC - - - - - - Implementation of Nested Diagnostic Contexts. - - - - - The NDC is deprecated and has been replaced by the . - The current NDC implementation forwards to the ThreadContext.Stacks["NDC"]. - - - - 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. - - - 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. - - - 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. - - - How to push a message into the context - - 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 - - - - Nicko Cadell - Gert Driesen - - - - Initializes a new instance of the class. - - - Uses a private access modifier to prevent instantiation of this class. - - - - - Gets the current context depth. - - The current context depth. - - - - The NDC is deprecated and has been replaced by the . - The current NDC implementation forwards to the ThreadContext.Stacks["NDC"]. - - - - The number of context values pushed onto the context stack. - - - Used to record the current depth of the context. This can then - be restored using the method. - - - - - - - Clears all the contextual information held on the current thread. - - - - - The NDC is deprecated and has been replaced by the . - The current NDC implementation forwards to the ThreadContext.Stacks["NDC"]. - - - - Clears the stack of NDC data held on the current thread. - - - - - - Creates a clone of the stack of context information. - - A clone of the context info for this thread. - - - - The NDC is deprecated and has been replaced by the . - The current NDC implementation forwards to the ThreadContext.Stacks["NDC"]. - - - - The results of this method can be passed to the - method to allow child threads to inherit the context of their - parent thread. - - - - - - Inherits the contextual information from another thread. - - The context stack to inherit. - - - - The NDC is deprecated and has been replaced by the . - The current NDC implementation forwards to the ThreadContext.Stacks["NDC"]. - - - - 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 NOT be shared. Any further contexts that - are pushed onto the stack will not be visible to the other. - Call to obtain a stack to pass to - this method. - - - - - - Removes the top context from the stack. - - - The message in the context that was removed from the top - of the stack. - - - - - The NDC is deprecated and has been replaced by the . - The current NDC implementation forwards to the ThreadContext.Stacks["NDC"]. - - - - Remove the top context from the stack, and return - it to the caller. If the stack is empty then an - empty string (not null) is returned. - - - - - - Pushes a new context message. - - The new context message. - - An that can be used to clean up - the context stack. - - - - - The NDC is deprecated and has been replaced by the . - The current NDC implementation forwards to the ThreadContext.Stacks["NDC"]. - - - - Pushes a new context onto the context stack. An - is returned that can be used to clean up the context stack. This - can be easily combined with the using keyword to scope the - context. - - - Simple example of using the Push method with the using keyword. - - using(log4net.NDC.Push("NDC_Message")) - { - log.Warn("This should have an NDC message"); - } - - - - - - Pushes a new context message. - - The new context message string format. - Arguments to be passed into messageFormat. - - An that can be used to clean up - the context stack. - - - - - The NDC is deprecated and has been replaced by the . - The current NDC implementation forwards to the ThreadContext.Stacks["NDC"]. - - - - Pushes a new context onto the context stack. An - is returned that can be used to clean up the context stack. This - can be easily combined with the using keyword to scope the - context. - - - Simple example of using the Push method with the using keyword. - - var someValue = "ExampleContext" - using(log4net.NDC.PushFormat("NDC_Message {0}", someValue)) - { - log.Warn("This should have an NDC message"); - } - - - - - - Removes the context information for this thread. It is - not required to call this method. - - - - - The NDC is deprecated and has been replaced by the . - The current NDC implementation forwards to the ThreadContext.Stacks["NDC"]. - - - - This method is not implemented. - - - - - - Forces the stack depth to be at most . - - The maximum depth of the stack - - - - The NDC is deprecated and has been replaced by the . - The current NDC implementation forwards to the ThreadContext.Stacks["NDC"]. - - - - Forces the stack depth to be at most . - 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. - - - - - - The default object Renderer. - - - - The default renderer supports rendering objects and collections to strings. - - - See the method for details of the output. - - - Nicko Cadell - Gert Driesen - - - - Default constructor - - - - Default constructor - - - - - - Render the object to a string - - The map used to lookup renderers - The object to render - The writer to render to - - - Render the object to a string. - - - The parameter is - provided to lookup and render other objects. This is - very useful where contains - nested objects of unknown type. The - method can be used to render these objects. - - - The default renderer supports rendering objects to strings as follows: - - - - Value - Rendered String - - - null - - "(null)" - - - - - - - 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: int[] {1, 2, 3}. - - - If the array is not one dimensional the - Array.ToString() is returned. - - - - - , & - - - 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: {a, b, c}. - - - All collection classes that implement its subclasses, - or generic equivalents all implement the interface. - - - - - - - - Rendered as the key, an equals sign ('='), and the value (using the appropriate - renderer). - - - For example: key=value. - - - - - other - - Object.ToString() - - - - - - - - Render the array argument into a string - - The map used to lookup renderers - the array to render - The writer to render to - - - 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: - int[] {1, 2, 3}. - - - If the array is not one dimensional the - Array.ToString() is returned. - - - - - - Render the enumerator argument into a string - - The map used to lookup renderers - the enumerator to render - The writer to render to - - - 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: - {a, b, c}. - - - - - - Render the DictionaryEntry argument into a string - - The map used to lookup renderers - the DictionaryEntry to render - The writer to render to - - - Render the key, an equals sign ('='), and the value (using the appropriate - renderer). For example: key=value. - - - - - - Implement this interface in order to render objects as strings - - - - Certain types require special case conversion to - string form. This conversion is done by an object renderer. - Object renderers implement the - interface. - - - Nicko Cadell - Gert Driesen - - - - Render the object to a string - - The map used to lookup renderers - The object to render - The writer to render to - - - Render the object to a - string. - - - The parameter is - provided to lookup and render other objects. This is - very useful where contains - nested objects of unknown type. The - method can be used to render these objects. - - - - - - Map class objects to an . - - - - Maintains a mapping between types that require special - rendering and the that - is used to render them. - - - The method is used to render an - object using the appropriate renderers defined in this map. - - - Nicko Cadell - Gert Driesen - - - - Render using the appropriate renderer. - - the object to render to a string - the object rendered as a string - - - This is a convenience method used to render an object to a string. - The alternative method - should be used when streaming output to a . - - - - - - Render using the appropriate renderer. - - the object to render to a string - The writer to render to - - - Find the appropriate renderer for the type of the - parameter. This is accomplished by calling the - method. Once a renderer is found, it is - applied on the object and the result is returned - as a . - - - - - - Gets the renderer for the specified object type - - the object to lookup the renderer for - the renderer for - - - Gets the renderer for the specified object type. - - - Syntactic sugar method that calls - with the type of the object parameter. - - - - - - Gets the renderer for the specified type - - the type to lookup the renderer for - the renderer for the specified type - - - Returns the renderer for the specified type. - If no specific renderer has been defined the - will be returned. - - - - - - Internal function to recursively search interfaces - - the type to lookup the renderer for - the renderer for the specified type - - - - Get the default renderer instance - - the default renderer - - - Get the default renderer - - - - - - Clear the map of renderers - - - - Clear the custom renderers defined by using - . The - cannot be removed. - - - - - - Register an for . - - the type that will be rendered by - the renderer for - - - Register an object renderer for a specific source type. - This renderer will be returned from a call to - specifying the same as an argument. - - - - - - Interface implemented by logger repository plugins. - - - - Plugins define additional behavior that can be associated - with a . - The held by the - property is used to store the plugins for a repository. - - - The log4net.Config.PluginAttribute can be used to - attach plugins to repositories created using configuration - attributes. - - - Nicko Cadell - Gert Driesen - - - - Gets the name of the plugin. - - - The name of the plugin. - - - - Plugins are stored in the - keyed by name. Each plugin instance attached to a - repository must be a unique name. - - - - - - Attaches the plugin to the specified . - - The that this plugin should be attached to. - - - A plugin may only be attached to a single repository. - - - This method is called when the plugin is attached to the repository. - - - - - - Is called when the plugin is to shutdown. - - - - This method is called to notify the plugin that - it should stop operating and should detach from - the repository. - - - - - - Interface used to create plugins. - - - - Interface used to create a plugin. - - - Nicko Cadell - Gert Driesen - - - - Creates the plugin object. - - the new plugin instance - - - Create and return a new plugin instance. - - - - - - A strongly-typed collection of objects. - - Nicko Cadell - - - - Supports type-safe iteration over a . - - - - - - Gets the current element in the collection. - - - - - Advances the enumerator to the next element in the collection. - - - true if the enumerator was successfully advanced to the next element; - false if the enumerator has passed the end of the collection. - - - The collection was modified after the enumerator was created. - - - - - Sets the enumerator to its initial position, before the first element in the collection. - - - - - Creates a read-only wrapper for a PluginCollection instance. - - list to create a readonly wrapper arround - - A PluginCollection wrapper that is read-only. - - - - - Initializes a new instance of the PluginCollection class - that is empty and has the default initial capacity. - - - - - Initializes a new instance of the PluginCollection class - that has the specified initial capacity. - - - The number of elements that the new PluginCollection is initially capable of storing. - - - - - Initializes a new instance of the PluginCollection class - that contains elements copied from the specified PluginCollection. - - The PluginCollection whose elements are copied to the new collection. - - - - Initializes a new instance of the PluginCollection class - that contains elements copied from the specified array. - - The array whose elements are copied to the new list. - - - - Initializes a new instance of the PluginCollection class - that contains elements copied from the specified collection. - - The collection whose elements are copied to the new list. - - - - Type visible only to our subclasses - Used to access protected constructor - - - - - - A value - - - - - Allow subclasses to avoid our default constructors - - - - - - - Gets the number of elements actually contained in the PluginCollection. - - - - - Copies the entire PluginCollection to a one-dimensional - array. - - The one-dimensional array to copy to. - - - - Copies the entire PluginCollection to a one-dimensional - array, starting at the specified index of the target array. - - The one-dimensional array to copy to. - The zero-based index in at which copying begins. - - - - Gets a value indicating whether access to the collection is synchronized (thread-safe). - - false, because the backing type is an array, which is never thread-safe. - - - - Gets an object that can be used to synchronize access to the collection. - - - An object that can be used to synchronize access to the collection. - - - - - Gets or sets the at the specified index. - - - The at the specified index. - - The zero-based index of the element to get or set. - - is less than zero. - -or- - is equal to or greater than . - - - - - Adds a to the end of the PluginCollection. - - The to be added to the end of the PluginCollection. - The index at which the value has been added. - - - - Removes all elements from the PluginCollection. - - - - - Creates a shallow copy of the . - - A new with a shallow copy of the collection data. - - - - Determines whether a given is in the PluginCollection. - - The to check for. - true if is found in the PluginCollection; otherwise, false. - - - - Returns the zero-based index of the first occurrence of a - in the PluginCollection. - - The to locate in the PluginCollection. - - The zero-based index of the first occurrence of - in the entire PluginCollection, if found; otherwise, -1. - - - - - Inserts an element into the PluginCollection at the specified index. - - The zero-based index at which should be inserted. - The to insert. - - is less than zero - -or- - is equal to or greater than . - - - - - Removes the first occurrence of a specific from the PluginCollection. - - The to remove from the PluginCollection. - - The specified was not found in the PluginCollection. - - - - - Removes the element at the specified index of the PluginCollection. - - The zero-based index of the element to remove. - - is less than zero. - -or- - is equal to or greater than . - - - - - Gets a value indicating whether the collection has a fixed size. - - true if the collection has a fixed size; otherwise, false. The default is false. - - - - Gets a value indicating whether the IList is read-only. - - true if the collection is read-only; otherwise, false. The default is false. - - - - Returns an enumerator that can iterate through the PluginCollection. - - An for the entire PluginCollection. - - - - Gets or sets the number of elements the PluginCollection can contain. - - - The number of elements the PluginCollection can contain. - - - - - Adds the elements of another PluginCollection to the current PluginCollection. - - The PluginCollection whose elements should be added to the end of the current PluginCollection. - The new of the PluginCollection. - - - - Adds the elements of a array to the current PluginCollection. - - The array whose elements should be added to the end of the PluginCollection. - The new of the PluginCollection. - - - - Adds the elements of a collection to the current PluginCollection. - - The collection whose elements should be added to the end of the PluginCollection. - The new of the PluginCollection. - - - - Sets the capacity to the actual number of elements. - - - - - is less than zero. - -or- - is equal to or greater than . - - - - - is less than zero. - -or- - is equal to or greater than . - - - - - Supports simple iteration over a . - - - - - - Initializes a new instance of the Enumerator class. - - - - - - Gets the current element in the collection. - - - The current element in the collection. - - - - - Advances the enumerator to the next element in the collection. - - - true if the enumerator was successfully advanced to the next element; - false if the enumerator has passed the end of the collection. - - - The collection was modified after the enumerator was created. - - - - - Sets the enumerator to its initial position, before the first element in the collection. - - - - - - - - Map of repository plugins. - - - - This class is a name keyed map of the plugins that are - attached to a repository. - - - Nicko Cadell - Gert Driesen - - - - Constructor - - The repository that the plugins should be attached to. - - - Initialize a new instance of the class with a - repository that the plugins should be attached to. - - - - - - Gets a by name. - - The name of the to lookup. - - The from the map with the name specified, or - null if no plugin is found. - - - - Lookup a plugin by name. If the plugin is not found null - will be returned. - - - - - - Gets all possible plugins as a list of objects. - - All possible plugins as a list of objects. - - - Get a collection of all the plugins defined in this map. - - - - - - Adds a to the map. - - The to add to the map. - - - The will be attached to the repository when added. - - - If there already exists a plugin with the same name - attached to the repository then the old plugin will - be and replaced with - the new plugin. - - - - - - Removes a from the map. - - The to remove from the map. - - - Remove a specific plugin from this map. - - - - - - Base implementation of - - - - Default abstract implementation of the - interface. This base class can be used by implementors - of the interface. - - - Nicko Cadell - Gert Driesen - - - - Constructor - - the name of the plugin - - Initializes a new Plugin with the specified name. - - - - - Gets or sets the name of the plugin. - - - The name of the plugin. - - - - Plugins are stored in the - keyed by name. Each plugin instance attached to a - repository must be a unique name. - - - The name of the plugin must not change one the - plugin has been attached to a repository. - - - - - - Attaches this plugin to a . - - The that this plugin should be attached to. - - - A plugin may only be attached to a single repository. - - - This method is called when the plugin is attached to the repository. - - - - - - Is called when the plugin is to shutdown. - - - - This method is called to notify the plugin that - it should stop operating and should detach from - the repository. - - - - - - The repository for this plugin - - - The that this plugin is attached to. - - - - Gets or sets the that this plugin is - attached to. - - - - - - The name of this plugin. - - - - - The repository this plugin is attached to. - - - - - Plugin that listens for events from the - - - - This plugin publishes an instance of - on a specified . This listens for logging events delivered from - a remote . - - - When an event is received it is relogged within the attached repository - as if it had been raised locally. - - - Nicko Cadell - Gert Driesen - - - - Default constructor - - - - Initializes a new instance of the class. - - - The property must be set. - - - - - - Construct with sink Uri. - - The name to publish the sink under in the remoting infrastructure. - See for more details. - - - Initializes a new instance of the class - with specified name. - - - - - - Gets or sets the URI of this sink. - - - The URI of this sink. - - - - This is the name under which the object is marshaled. - - - - - - - Attaches this plugin to a . - - The that this plugin should be attached to. - - - A plugin may only be attached to a single repository. - - - This method is called when the plugin is attached to the repository. - - - - - - Is called when the plugin is to shutdown. - - - - When the plugin is shutdown the remote logging - sink is disconnected. - - - - - - The fully qualified type of the RemoteLoggingServerPlugin class. - - - Used by the internal logger to record the Type of the - log message. - - - - - Delivers objects to a remote sink. - - - - Internal class used to listen for logging events - and deliver them to the local repository. - - - - - - Constructor - - The repository to log to. - - - Initializes a new instance of the for the - specified . - - - - - - Logs the events to the repository. - - The events to log. - - - The events passed are logged to the - - - - - - Obtains a lifetime service object to control the lifetime - policy for this instance. - - null to indicate that this instance should live forever. - - - Obtains a lifetime service object to control the lifetime - policy for this instance. This object should live forever - therefore this implementation returns null. - - - - - - The underlying that events should - be logged to. - - - - - - - - - - - - - - - - - - - - - Default implementation of - - - - This default implementation of the - interface is used to create the default subclass - of the object. - - - Nicko Cadell - Gert Driesen - - - - Default constructor - - - - Initializes a new instance of the class. - - - - - - Create a new instance - - The that will own the . - The name of the . - The instance for the specified name. - - - Create a new instance with the - specified name. - - - Called by the to create - new named instances. - - - If the is null then the root logger - must be returned. - - - - - - Default internal subclass of - - - - This subclass has no additional behavior over the - class but does allow instances - to be created. - - - - - - Construct a new Logger - - the name of the logger - - - Initializes a new instance of the class - with the specified name. - - - - - - Delegate used to handle logger creation event notifications. - - The in which the has been created. - The event args that hold the instance that has been created. - - - Delegate used to handle logger creation event notifications. - - - - - - Provides data for the event. - - - - A event is raised every time a - is created. - - - - - - The created - - - - - Constructor - - The that has been created. - - - Initializes a new instance of the event argument - class,with the specified . - - - - - - Gets the that has been created. - - - The that has been created. - - - - The that has been created. - - - - - - Hierarchical organization of loggers - - - - The casual user should not have to deal with this class - directly. - - - This class is specialized in retrieving loggers by name and - also maintaining the logger hierarchy. Implements the - interface. - - - The structure of the logger hierarchy is maintained by the - 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. - - - 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. - - - Nicko Cadell - Gert Driesen - - - - Event used to notify that a logger has been created. - - - - Event raised when a logger is created. - - - - - - Default constructor - - - - Initializes a new instance of the class. - - - - - - Construct with properties - - The properties to pass to this repository. - - - Initializes a new instance of the class. - - - - - - Construct with a logger factory - - The factory to use to create new logger instances. - - - Initializes a new instance of the class with - the specified . - - - - - - Construct with properties and a logger factory - - The properties to pass to this repository. - The factory to use to create new logger instances. - - - Initializes a new instance of the class with - the specified . - - - - - - Has no appender warning been emitted - - - - Flag to indicate if we have already issued a warning - about not having an appender warning. - - - - - - Get the root of this hierarchy - - - - Get the root of this hierarchy. - - - - - - Gets or sets the default instance. - - The default - - - The logger factory is used to create logger instances. - - - - - - Test if a logger exists - - The name of the logger to lookup - The Logger object with the name specified - - - Check if the named logger exists in the hierarchy. If so return - its reference, otherwise returns null. - - - - - - Returns all the currently defined loggers in the hierarchy as an Array - - All the defined loggers - - - Returns all the currently defined loggers in the hierarchy as an Array. - The root logger is not included in the returned - enumeration. - - - - - - Return a new logger instance named as the first parameter using - the default factory. - - - - Return a new logger instance named as the first parameter using - the default factory. - - - 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. - - - The name of the logger to retrieve - The logger object with the name specified - - - - Shutting down a hierarchy will safely close and remove - all appenders in all loggers including the root logger. - - - - Shutting down a hierarchy will safely close and remove - all appenders in all loggers including the root logger. - - - Some appenders need to be closed before the - application exists. Otherwise, pending logging events might be - lost. - - - The 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. - - - - - - Reset all values contained in this hierarchy instance to their default. - - - - 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 null, - sets their additivity flag to true and sets the level - of the root logger to . Moreover, - message disabling is set its default "off" value. - - - Existing loggers are not removed. They are just reset. - - - This method should be used sparingly and with care as it will - block all logging until it is completed. - - - - - - Log the logEvent through this hierarchy. - - the event to log - - - This method should not normally be used to log. - The interface should be used - for routine logging. This interface can be obtained - using the method. - - - The logEvent is delivered to the appropriate logger and - that logger is then responsible for logging the event. - - - - - - Returns all the Appenders that are currently configured - - An array containing all the currently configured appenders - - - Returns all the 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. - - - The list returned is unordered but does not contain duplicates. - - - - - - Collect the appenders from an . - The appender may also be a container. - - - - - - - Collect the appenders from an container - - - - - - - Initialize the log4net system using the specified appender - - the appender to use to log all logging events - - - - Initialize the log4net system using the specified appenders - - the appenders to use to log all logging events - - - - Initialize the log4net system using the specified appenders - - the appenders to use to log all logging events - - - This method provides the same functionality as the - method implemented - on this object, but it is protected and therefore can be called by subclasses. - - - - - - Initialize the log4net system using the specified config - - the element containing the root of the config - - - - Initialize the log4net system using the specified config - - the element containing the root of the config - - - This method provides the same functionality as the - method implemented - on this object, but it is protected and therefore can be called by subclasses. - - - - - - Test if this hierarchy is disabled for the specified . - - The level to check against. - - true if the repository is disabled for the level argument, false otherwise. - - - - If this hierarchy has not been configured then this method will - always return true. - - - This method will return true if this repository is - disabled for level object passed as parameter and - false otherwise. - - - See also the property. - - - - - - Clear all logger definitions from the internal hashtable - - - - This call will clear all logger definitions from the internal - hashtable. Invoking this method will irrevocably mess up the - logger hierarchy. - - - You should really know what you are doing before - invoking this method. - - - - - - Return a new logger instance named as the first parameter using - . - - The name of the logger to retrieve - The factory that will make the new logger instance - The logger object with the name specified - - - If a logger of that name already exists, then it will be - returned. Otherwise, a new logger will be instantiated by the - parameter and linked with its existing - ancestors as well as children. - - - - - - Sends a logger creation event to all registered listeners - - The newly created logger - - Raises the logger creation event. - - - - - Updates all the parents of the specified logger - - The logger to update the parents for - - - This method loops through all the potential parents of - . There 3 possible cases: - - - - No entry for the potential parent of exists - - We create a ProvisionNode for this potential - parent and insert in that provision node. - - - - The entry is of type Logger for the potential parent. - - The entry is 's nearest existing parent. We - update 's parent field with this entry. We also break from - he loop because updating our parent's parent is our parent's - responsibility. - - - - The entry is of type ProvisionNode for this potential parent. - - We add to the list of children for this - potential parent. - - - - - - - - Replace a with a in the hierarchy. - - - - - - 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'. - - - We loop on all the children 'c' in 'pn'. - - - If the child 'c' has been already linked to a child of - 'log' then there is no need to update 'c'. - - - Otherwise, we set log's parent field to c's parent and set - c's parent field to log. - - - - - - Define or redefine a Level using the values in the argument - - the level values - - - Define or redefine a Level using the values in the argument - - - Supports setting levels via the configuration file. - - - - - - A class to hold the value, name and display name for a level - - - - A class to hold the value, name and display name for a level - - - - - - Value of the level - - - - If the value is not set (defaults to -1) the value will be looked - up for the current level with the same name. - - - - - - Name of the level - - - The name of the level - - - - The name of the level. - - - - - - Display name for the level - - - The display name of the level - - - - The display name of the level. - - - - - - Override Object.ToString to return sensible debug info - - string info about this object - - - - Set a Property using the values in the argument - - the property value - - - Set a Property using the values in the argument. - - - Supports setting property values via the configuration file. - - - - - - The fully qualified type of the Hierarchy class. - - - Used by the internal logger to record the Type of the - log message. - - - - - Interface abstracts creation of instances - - - - This interface is used by the to - create new objects. - - - The method is called - to create a named . - - - Implement this interface to create new subclasses of . - - - Nicko Cadell - Gert Driesen - - - - Create a new instance - - The that will own the . - The name of the . - The instance for the specified name. - - - Create a new instance with the - specified name. - - - Called by the to create - new named instances. - - - If the is null then the root logger - must be returned. - - - - - - Implementation of used by - - - - Internal class used to provide implementation of - interface. Applications should use to get - logger instances. - - - 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 organizes the - instances into a rooted tree hierarchy. - - - The class is abstract. Only concrete subclasses of - can be created. The - is used to create instances of this type for the . - - - Nicko Cadell - Gert Driesen - Aspi Havewala - Douglas de la Torre - - - - This constructor created a new instance and - sets its name. - - The name of the . - - - This constructor is protected and designed to be used by - a subclass that is not abstract. - - - Loggers are constructed by - objects. See for the default - logger creator. - - - - - - Gets or sets the parent logger in the hierarchy. - - - The parent logger in the hierarchy. - - - - Part of the Composite pattern that makes the hierarchy. - The hierarchy is parent linked rather than child linked. - - - - - - Gets or sets a value indicating if child loggers inherit their parent's appenders. - - - true if child loggers inherit their parent's appenders. - - - - Additivity is set to true by default, that is children inherit - the appenders of their ancestors by default. If this variable is - set to false 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 false too. See - the user manual for more details. - - - - - - Gets the effective level for this logger. - - The nearest level in the logger hierarchy. - - - Starting from this logger, searches the logger hierarchy for a - non-null level and returns it. Otherwise, returns the level of the - root logger. - - The Logger class is designed so that this method executes as - quickly as possible. - - - - - Gets or sets the where this - Logger instance is attached to. - - The hierarchy that this logger belongs to. - - - This logger must be attached to a single . - - - - - - Gets or sets the assigned , if any, for this Logger. - - - The of this logger. - - - - The assigned can be null. - - - - - - Add to the list of appenders of this - Logger instance. - - An appender to add to this logger - - - Add to the list of appenders of this - Logger instance. - - - If is already in the list of - appenders, then it won't be added again. - - - - - - Get the appenders contained in this logger as an - . - - A collection of the appenders in this logger - - - Get the appenders contained in this logger as an - . If no appenders - can be found, then a is returned. - - - - - - Look for the appender named as name - - The name of the appender to lookup - The appender with the name specified, or null. - - - Returns the named appender, or null if the appender is not found. - - - - - - Remove all previously added appenders from this Logger instance. - - - - Remove all previously added appenders from this Logger instance. - - - This is useful when re-reading configuration information. - - - - - - Remove the appender passed as parameter form the list of appenders. - - The appender to remove - The appender removed from the list - - - 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 - on the appender removed. - - - - - - Remove the appender passed as parameter form the list of appenders. - - The name of the appender to remove - The appender removed from the list - - - 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 - on the appender removed. - - - - - - Gets the logger name. - - - The name of the logger. - - - - The name of this logger - - - - - - This generic form is intended to be used by wrappers. - - The declaring type of the method that is - the stack boundary into the logging system for this call. - The level of the message to be logged. - The message object to log. - The exception to log, including its stack trace. - - - Generate a logging event for the specified using - the and . - - - This method must not throw any exception to the caller. - - - - - - This is the most generic printing method that is intended to be used - by wrappers. - - The event being logged. - - - Logs the specified logging event through this logger. - - - This method must not throw any exception to the caller. - - - - - - Checks if this logger is enabled for a given passed as parameter. - - The level to check. - - true if this logger is enabled for level, otherwise false. - - - - Test if this logger is going to log events of the specified . - - - This method must not throw any exception to the caller. - - - - - - Gets the where this - Logger instance is attached to. - - - The that this logger belongs to. - - - - Gets the where this - Logger instance is attached to. - - - - - - Deliver the to the attached appenders. - - The event to log. - - - Call the appenders in the hierarchy starting at - this. If no appenders could be found, emit a - warning. - - - 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. - - - - - - Closes all attached appenders implementing the interface. - - - - Used to ensure that the appenders are correctly shutdown. - - - - - - This is the most generic printing method. This generic form is intended to be used by wrappers - - The level of the message to be logged. - The message object to log. - The exception to log, including its stack trace. - - - Generate a logging event for the specified using - the . - - - - - - Creates a new logging event and logs the event without further checks. - - The declaring type of the method that is - the stack boundary into the logging system for this call. - The level of the message to be logged. - The message object to log. - The exception to log, including its stack trace. - - - Generates a logging event and delivers it to the attached - appenders. - - - - - - Creates a new logging event and logs the event without further checks. - - The event being logged. - - - Delivers the logging event to the attached appenders. - - - - - - The fully qualified type of the Logger class. - - - - - The name of this logger. - - - - - The assigned level of this logger. - - - - The level variable need not be - assigned a value in which case it is inherited - form the hierarchy. - - - - - - The parent of this logger. - - - - The parent of this logger. - All loggers have at least one ancestor which is the root logger. - - - - - - Loggers need to know what Hierarchy they are in. - - - - Loggers need to know what Hierarchy they are in. - The hierarchy that this logger is a member of is stored - here. - - - - - - Helper implementation of the interface - - - - - Flag indicating if child loggers inherit their parents appenders - - - - Additivity is set to true by default, that is children inherit - the appenders of their ancestors by default. If this variable is - set to false 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 false too. See - the user manual for more details. - - - - - - Lock to protect AppenderAttachedImpl variable m_appenderAttachedImpl - - - - - Used internally to accelerate hash table searches. - - - - Internal class used to improve performance of - string keyed hashtables. - - - The hashcode of the string is cached for reuse. - The string is stored as an interned value. - When comparing two objects for equality - the reference equality of the interned strings is compared. - - - Nicko Cadell - Gert Driesen - - - - Construct key with string name - - - - Initializes a new instance of the class - with the specified name. - - - Stores the hashcode of the string and interns - the string key to optimize comparisons. - - - The Compact Framework 1.0 the - method does not work. On the Compact Framework - the string keys are not interned nor are they - compared by reference. - - - The name of the logger. - - - - Returns a hash code for the current instance. - - A hash code for the current instance. - - - Returns the cached hashcode. - - - - - - Determines whether two instances - are equal. - - The to compare with the current . - - true if the specified is equal to the current ; otherwise, false. - - - - Compares the references of the interned strings. - - - - - - Provision nodes are used where no logger instance has been specified - - - - instances are used in the - when there is no specified - for that node. - - - A provision node holds a list of child loggers on behalf of - a logger that does not exist. - - - Nicko Cadell - Gert Driesen - - - - Create a new provision node with child node - - A child logger to add to this node. - - - Initializes a new instance of the class - with the specified child logger. - - - - - - The sits at the root of the logger hierarchy tree. - - - - The is a regular except - that it provides several guarantees. - - - First, it cannot be assigned a null - level. Second, since the root logger cannot have a parent, the - property always returns the value of the - level field without walking the hierarchy. - - - Nicko Cadell - Gert Driesen - - - - Construct a - - The level to assign to the root logger. - - - Initializes a new instance of the class with - the specified logging level. - - - The root logger names itself as "root". However, the root - logger cannot be retrieved by name. - - - - - - Gets the assigned level value without walking the logger hierarchy. - - The assigned level value without walking the logger hierarchy. - - - Because the root logger cannot have a parent and its level - must not be null this property just returns the - value of . - - - - - - Gets or sets the assigned for the root logger. - - - The of the root logger. - - - - Setting the level of the root logger to a null reference - may have catastrophic results. We prevent this here. - - - - - - The fully qualified type of the RootLogger class. - - - Used by the internal logger to record the Type of the - log message. - - - - - Initializes the log4net environment using an XML DOM. - - - - Configures a using an XML DOM. - - - Nicko Cadell - Gert Driesen - - - - Construct the configurator for a hierarchy - - The hierarchy to build. - - - Initializes a new instance of the class - with the specified . - - - - - - Configure the hierarchy by parsing a DOM tree of XML elements. - - The root element to parse. - - - Configure the hierarchy by parsing a DOM tree of XML elements. - - - - - - Parse appenders by IDREF. - - The appender ref element. - The instance of the appender that the ref refers to. - - - Parse an XML element that represents an appender and return - the appender. - - - - - - Parses an appender element. - - The appender element. - The appender instance or null when parsing failed. - - - Parse an XML element that represents an appender and return - the appender instance. - - - - - - Parses a logger element. - - The logger element. - - - Parse an XML element that represents a logger. - - - - - - Parses the root logger element. - - The root element. - - - Parse an XML element that represents the root logger. - - - - - - Parses the children of a logger element. - - The category element. - The logger instance. - Flag to indicate if the logger is the root logger. - - - Parse the child elements of a <logger> element. - - - - - - Parses an object renderer. - - The renderer element. - - - Parse an XML element that represents a renderer. - - - - - - Parses a level element. - - The level element. - The logger object to set the level on. - Flag to indicate if the logger is the root logger. - - - Parse an XML element that represents a level. - - - - - - Sets a parameter on an object. - - The parameter element. - The object to set the parameter on. - - 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 Parse 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. - - - - - Test if an element has no attributes or child elements - - the element to inspect - true if the element has any attributes or child elements, false otherwise - - - - Test if a is constructible with Activator.CreateInstance. - - the type to inspect - true if the type is creatable using a default constructor, false otherwise - - - - Look for a method on the that matches the supplied - - the type that has the method - the name of the method - the method info found - - - The method must be a public instance method on the . - The method must be named or "Add" followed by . - The method must take a single parameter. - - - - - - Converts a string value to a target type. - - The type of object to convert the string to. - The string value to use as the value of the object. - - - An object of type with value or - null when the conversion could not be performed. - - - - - - Creates an object as specified in XML. - - The XML element that contains the definition of the object. - The object type to use if not explicitly specified. - The type that the returned object must be or must inherit from. - The object or null - - - Parse an XML element and create an object instance based on the configuration - data. - - - The type of the instance may be specified in the XML. If not - specified then the is used - as the type. However the type is specified it must support the - type. - - - - - - key: appenderName, value: appender. - - - - - The Hierarchy being configured. - - - - - The fully qualified type of the XmlHierarchyConfigurator class. - - - Used by the internal logger to record the Type of the - log message. - - - - - Basic Configurator interface for repositories - - - - Interface used by basic configurator to configure a - with a default . - - - A should implement this interface to support - configuration by the . - - - Nicko Cadell - Gert Driesen - - - - Initialize the repository using the specified appender - - the appender to use to log all logging events - - - Configure the repository to route all logging events to the - specified appender. - - - - - - Initialize the repository using the specified appenders - - the appenders to use to log all logging events - - - Configure the repository to route all logging events to the - specified appenders. - - - - - - Delegate used to handle logger repository shutdown event notifications - - The that is shutting down. - Empty event args - - - Delegate used to handle logger repository shutdown event notifications. - - - - - - Delegate used to handle logger repository configuration reset event notifications - - The that has had its configuration reset. - Empty event args - - - Delegate used to handle logger repository configuration reset event notifications. - - - - - - Delegate used to handle event notifications for logger repository configuration changes. - - The that has had its configuration changed. - Empty event arguments. - - - Delegate used to handle event notifications for logger repository configuration changes. - - - - - - Interface implemented by logger repositories. - - - - This interface is implemented by logger repositories. e.g. - . - - - This interface is used by the - to obtain interfaces. - - - Nicko Cadell - Gert Driesen - - - - The name of the repository - - - The name of the repository - - - - The name of the repository. - - - - - - RendererMap accesses the object renderer map for this repository. - - - RendererMap accesses the object renderer map for this repository. - - - - RendererMap accesses the object renderer map for this repository. - - - The RendererMap holds a mapping between types and - objects. - - - - - - The plugin map for this repository. - - - The plugin map for this repository. - - - - The plugin map holds the instances - that have been attached to this repository. - - - - - - Get the level map for the Repository. - - - - Get the level map for the Repository. - - - The level map defines the mappings between - level names and objects in - this repository. - - - - - - The threshold for all events in this repository - - - The threshold for all events in this repository - - - - The threshold for all events in this repository. - - - - - - Check if the named logger exists in the repository. If so return - its reference, otherwise returns null. - - The name of the logger to lookup - The Logger object with the name specified - - - If the names logger exists it is returned, otherwise - null is returned. - - - - - - Returns all the currently defined loggers as an Array. - - All the defined loggers - - - Returns all the currently defined loggers as an Array. - - - - - - Returns a named logger instance - - The name of the logger to retrieve - The logger object with the name specified - - - Returns a named logger instance. - - - 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. - - - - - Shutdown the repository - - - Shutting down a repository will safely close and remove - all appenders in all loggers including the root logger. - - - Some appenders need to be closed before the - application exists. Otherwise, pending logging events might be - lost. - - - The 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. - - - - - - Reset the repositories configuration to a default state - - - - Reset all values contained in this instance to their - default state. - - - Existing loggers are not removed. They are just reset. - - - This method should be used sparingly and with care as it will - block all logging until it is completed. - - - - - - Log the through this repository. - - the event to log - - - This method should not normally be used to log. - The interface should be used - for routine logging. This interface can be obtained - using the method. - - - The logEvent is delivered to the appropriate logger and - that logger is then responsible for logging the event. - - - - - - Flag indicates if this repository has been configured. - - - Flag indicates if this repository has been configured. - - - - Flag indicates if this repository has been configured. - - - - - - Collection of internal messages captured during the most - recent configuration process. - - - - - Event to notify that the repository has been shutdown. - - - Event to notify that the repository has been shutdown. - - - - Event raised when the repository has been shutdown. - - - - - - Event to notify that the repository has had its configuration reset. - - - Event to notify that the repository has had its configuration reset. - - - - Event raised when the repository's configuration has been - reset to default. - - - - - - Event to notify that the repository has had its configuration changed. - - - Event to notify that the repository has had its configuration changed. - - - - Event raised when the repository's configuration has been changed. - - - - - - Repository specific properties - - - Repository specific properties - - - - These properties can be specified on a repository specific basis. - - - - - - Returns all the Appenders that are configured as an Array. - - All the Appenders - - - Returns all the Appenders that are configured as an Array. - - - - - - Configure repository using XML - - - - Interface used by Xml configurator to configure a . - - - A should implement this interface to support - configuration by the . - - - Nicko Cadell - Gert Driesen - - - - Initialize the repository using the specified config - - the element containing the root of the config - - - The schema for the XML configuration data is defined by - the implementation. - - - - - - Base implementation of - - - - Default abstract implementation of the interface. - - - Skeleton implementation of the interface. - All types can extend this type. - - - Nicko Cadell - Gert Driesen - - - - Default Constructor - - - - Initializes the repository with default (empty) properties. - - - - - - Construct the repository using specific properties - - the properties to set for this repository - - - Initializes the repository with specified properties. - - - - - - The name of the repository - - - The string name of the repository - - - - The name of this repository. The name is - used to store and lookup the repositories - stored by the . - - - - - - The threshold for all events in this repository - - - The threshold for all events in this repository - - - - The threshold for all events in this repository - - - - - - RendererMap accesses the object renderer map for this repository. - - - RendererMap accesses the object renderer map for this repository. - - - - RendererMap accesses the object renderer map for this repository. - - - The RendererMap holds a mapping between types and - objects. - - - - - - The plugin map for this repository. - - - The plugin map for this repository. - - - - The plugin map holds the instances - that have been attached to this repository. - - - - - - Get the level map for the Repository. - - - - Get the level map for the Repository. - - - The level map defines the mappings between - level names and objects in - this repository. - - - - - - Test if logger exists - - The name of the logger to lookup - The Logger object with the name specified - - - Check if the named logger exists in the repository. If so return - its reference, otherwise returns null. - - - - - - Returns all the currently defined loggers in the repository - - All the defined loggers - - - Returns all the currently defined loggers in the repository as an Array. - - - - - - Return a new logger instance - - The name of the logger to retrieve - The logger object with the name specified - - - Return a new logger instance. - - - 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. - - - - - - Shutdown the repository - - - - Shutdown the repository. Can be overridden in a subclass. - This base class implementation notifies the - listeners and all attached plugins of the shutdown event. - - - - - - Reset the repositories configuration to a default state - - - - Reset all values contained in this instance to their - default state. - - - Existing loggers are not removed. They are just reset. - - - This method should be used sparingly and with care as it will - block all logging until it is completed. - - - - - - Log the logEvent through this repository. - - the event to log - - - This method should not normally be used to log. - The interface should be used - for routine logging. This interface can be obtained - using the method. - - - The logEvent is delivered to the appropriate logger and - that logger is then responsible for logging the event. - - - - - - Flag indicates if this repository has been configured. - - - Flag indicates if this repository has been configured. - - - - Flag indicates if this repository has been configured. - - - - - - Contains a list of internal messages captures during the - last configuration. - - - - - Event to notify that the repository has been shutdown. - - - Event to notify that the repository has been shutdown. - - - - Event raised when the repository has been shutdown. - - - - - - Event to notify that the repository has had its configuration reset. - - - Event to notify that the repository has had its configuration reset. - - - - Event raised when the repository's configuration has been - reset to default. - - - - - - Event to notify that the repository has had its configuration changed. - - - Event to notify that the repository has had its configuration changed. - - - - Event raised when the repository's configuration has been changed. - - - - - - Repository specific properties - - - Repository specific properties - - - These properties can be specified on a repository specific basis - - - - - Returns all the Appenders that are configured as an Array. - - All the Appenders - - - Returns all the Appenders that are configured as an Array. - - - - - - The fully qualified type of the LoggerRepositorySkeleton class. - - - Used by the internal logger to record the Type of the - log message. - - - - - Adds an object renderer for a specific class. - - The type that will be rendered by the renderer supplied. - The object renderer used to render the object. - - - Adds an object renderer for a specific class. - - - - - - Notify the registered listeners that the repository is shutting down - - Empty EventArgs - - - Notify any listeners that this repository is shutting down. - - - - - - Notify the registered listeners that the repository has had its configuration reset - - Empty EventArgs - - - Notify any listeners that this repository's configuration has been reset. - - - - - - Notify the registered listeners that the repository has had its configuration changed - - Empty EventArgs - - - Notify any listeners that this repository's configuration has changed. - - - - - - Raise a configuration changed event on this repository - - EventArgs.Empty - - - Applications that programmatically change the configuration of the repository should - raise this event notification to notify listeners. - - - - - - Flushes all configured Appenders that implement . - - The maximum time in milliseconds to wait for logging events from asycnhronous appenders to be flushed, - or to wait indefinitely. - True if all logging events were flushed successfully, else false. - - - - The log4net Thread Context. - - - - The ThreadContext provides a location for thread specific debugging - information to be stored. - The ThreadContext properties override any - properties with the same name. - - - The thread context has a properties map and a stack. - The properties and stack can - be included in the output of log messages. The - supports selecting and outputting these properties. - - - 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. - - - The Thread Context is managed on a per thread basis. - - - Example of using the thread context properties to store a username. - - ThreadContext.Properties["user"] = userName; - log.Info("This log message has a ThreadContext Property called 'user'"); - - - Example of how to push a message into the context stack - - 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 - - - - Nicko Cadell - - - - Private Constructor. - - - - Uses a private access modifier to prevent instantiation of this class. - - - - - - The thread properties map - - - The thread properties map - - - - The ThreadContext properties override any - properties with the same name. - - - - - - The thread stacks - - - stack map - - - - The thread local stacks. - - - - - - The thread context properties instance - - - - - The thread context stacks instance - - - - - A straightforward implementation of the interface. - - - - This is the default implementation of the - interface. Implementors of the interface - should aggregate an instance of this type. - - - Nicko Cadell - Gert Driesen - - - - Constructor - - - - Initializes a new instance of the class. - - - - - - Append on on all attached appenders. - - The event being logged. - The number of appenders called. - - - Calls the method on all - attached appenders. - - - - - - Append on on all attached appenders. - - The array of events being logged. - The number of appenders called. - - - Calls the method on all - attached appenders. - - - - - - Calls the DoAppende method on the with - the objects supplied. - - The appender - The events - - - If the supports the - interface then the will be passed - through using that interface. Otherwise the - objects in the array will be passed one at a time. - - - - - - Attaches an appender. - - The appender to add. - - - If the appender is already in the list it won't be added again. - - - - - - Gets all attached appenders. - - - A collection of attached appenders, or null if there - are no attached appenders. - - - - The read only collection of all currently attached appenders. - - - - - - Gets an attached appender with the specified name. - - The name of the appender to get. - - The appender with the name specified, or null if no appender with the - specified name is found. - - - - Lookup an attached appender by name. - - - - - - Removes all attached appenders. - - - - Removes and closes all attached appenders - - - - - - Removes the specified appender from the list of attached appenders. - - The appender to remove. - The appender removed from the list - - - The appender removed is not closed. - If you are discarding the appender you must call - on the appender removed. - - - - - - Removes the appender with the specified name from the list of appenders. - - The name of the appender to remove. - The appender removed from the list - - - The appender removed is not closed. - If you are discarding the appender you must call - on the appender removed. - - - - - - List of appenders - - - - - Array of appenders, used to cache the m_appenderList - - - - - The fully qualified type of the AppenderAttachedImpl class. - - - Used by the internal logger to record the Type of the - log message. - - - - - This class aggregates several PropertiesDictionary collections together. - - - - Provides a dictionary style lookup over an ordered list of - collections. - - - Nicko Cadell - - - - Constructor - - - - Initializes a new instance of the class. - - - - - - Gets the value of a property - - - The value for the property with the specified key - - - - Looks up the value for the specified. - The 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. - - - If none of the collections contain the specified key then - null is returned. - - - - - - Add a Properties Dictionary to this composite collection - - the properties to add - - - Properties dictionaries added first take precedence over dictionaries added - later. - - - - - - Flatten this composite collection into a single properties dictionary - - the flattened dictionary - - - Reduces the collection of ordered dictionaries to a single dictionary - containing the resultant values for the keys. - - - - - - Base class for Context Properties implementations - - - - This class defines a basic property get set accessor - - - Nicko Cadell - - - - Gets or sets the value of a property - - - The value for the property with the specified key - - - - Gets or sets the value of a property - - - - - - Wrapper class used to map converter names to converter types - - - - Pattern converter info class used during configuration by custom - PatternString and PatternLayer converters. - - - - - - default constructor - - - - - Gets or sets the name of the conversion pattern - - - - The name of the pattern in the format string - - - - - - Gets or sets the type of the converter - - - - The value specified must extend the - type. - - - - - - - - - - - - - - - - - Subclass of that maintains a count of - the number of bytes written. - - - - This writer counts the number of bytes written. - - - Nicko Cadell - Gert Driesen - - - - Constructor - - The to actually write to. - The to report errors to. - - - Creates a new instance of the class - with the specified and . - - - - - - Writes a character to the underlying writer and counts the number of bytes written. - - the char to write - - - Overrides implementation of . Counts - the number of bytes written. - - - - - - Writes a buffer to the underlying writer and counts the number of bytes written. - - the buffer to write - the start index to write from - the number of characters to write - - - Overrides implementation of . Counts - the number of bytes written. - - - - - - Writes a string to the output and counts the number of bytes written. - - The string data to write to the output. - - - Overrides implementation of . Counts - the number of bytes written. - - - - - - Gets or sets the total number of bytes written. - - - The total number of bytes written. - - - - Gets or sets the total number of bytes written. - - - - - - Total number of bytes written. - - - - - A fixed size rolling buffer of logging events. - - - - An array backed fixed size leaky bucket. - - - Nicko Cadell - Gert Driesen - - - - Constructor - - The maximum number of logging events in the buffer. - - - Initializes a new instance of the class with - the specified maximum number of buffered logging events. - - - The argument is not a positive integer. - - - - Appends a to the buffer. - - The event to append to the buffer. - The event discarded from the buffer, if the buffer is full, otherwise null. - - - Append an event to the buffer. If the buffer still contains free space then - null 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. - - - - - - Get and remove the oldest event in the buffer. - - The oldest logging event in the buffer - - - Gets the oldest (first) logging event in the buffer and removes it - from the buffer. - - - - - - Pops all the logging events from the buffer into an array. - - An array of all the logging events in the buffer. - - - Get all the events in the buffer and clear the buffer. - - - - - - Clear the buffer - - - - Clear the buffer of all events. The events in the buffer are lost. - - - - - - Gets the th oldest event currently in the buffer. - - The th oldest event currently in the buffer. - - - If is outside the range 0 to the number of events - currently in the buffer, then null is returned. - - - - - - Gets the maximum size of the buffer. - - The maximum size of the buffer. - - - Gets the maximum size of the buffer - - - - - - Gets the number of logging events in the buffer. - - The number of logging events in the buffer. - - - This number is guaranteed to be in the range 0 to - (inclusive). - - - - - - An always empty . - - - - A singleton implementation of the - interface that always represents an empty collection. - - - Nicko Cadell - Gert Driesen - - - - Initializes a new instance of the class. - - - - Uses a private access modifier to enforce the singleton pattern. - - - - - - Gets the singleton instance of the empty collection. - - The singleton instance of the empty collection. - - - Gets the singleton instance of the empty collection. - - - - - - Copies the elements of the to an - , starting at a particular Array index. - - The one-dimensional - that is the destination of the elements copied from - . The Array must have zero-based - indexing. - The zero-based index in array at which - copying begins. - - - As the collection is empty no values are copied into the array. - - - - - - Gets a value indicating if access to the is synchronized (thread-safe). - - - true if access to the is synchronized (thread-safe); otherwise, false. - - - - For the this property is always true. - - - - - - Gets the number of elements contained in the . - - - The number of elements contained in the . - - - - As the collection is empty the is always 0. - - - - - - Gets an object that can be used to synchronize access to the . - - - An object that can be used to synchronize access to the . - - - - As the collection is empty and thread safe and synchronized this instance is also - the object. - - - - - - Returns an enumerator that can iterate through a collection. - - - An that can be used to - iterate through the collection. - - - - As the collection is empty a is returned. - - - - - - The singleton instance of the empty collection. - - - - - An always empty . - - - - A singleton implementation of the - interface that always represents an empty collection. - - - Nicko Cadell - Gert Driesen - - - - Initializes a new instance of the class. - - - - Uses a private access modifier to enforce the singleton pattern. - - - - - - Gets the singleton instance of the . - - The singleton instance of the . - - - Gets the singleton instance of the . - - - - - - Copies the elements of the to an - , starting at a particular Array index. - - The one-dimensional - that is the destination of the elements copied from - . The Array must have zero-based - indexing. - The zero-based index in array at which - copying begins. - - - As the collection is empty no values are copied into the array. - - - - - - Gets a value indicating if access to the is synchronized (thread-safe). - - - true if access to the is synchronized (thread-safe); otherwise, false. - - - - For the this property is always true. - - - - - - Gets the number of elements contained in the - - - The number of elements contained in the . - - - - As the collection is empty the is always 0. - - - - - - Gets an object that can be used to synchronize access to the . - - - An object that can be used to synchronize access to the . - - - - As the collection is empty and thread safe and synchronized this instance is also - the object. - - - - - - Returns an enumerator that can iterate through a collection. - - - An that can be used to - iterate through the collection. - - - - As the collection is empty a is returned. - - - - - - Adds an element with the provided key and value to the - . - - The to use as the key of the element to add. - The to use as the value of the element to add. - - - As the collection is empty no new values can be added. A - is thrown if this method is called. - - - This dictionary is always empty and cannot be modified. - - - - Removes all elements from the . - - - - As the collection is empty no values can be removed. A - is thrown if this method is called. - - - This dictionary is always empty and cannot be modified. - - - - Determines whether the contains an element - with the specified key. - - The key to locate in the . - false - - - As the collection is empty the method always returns false. - - - - - - Returns an enumerator that can iterate through a collection. - - - An that can be used to - iterate through the collection. - - - - As the collection is empty a is returned. - - - - - - Removes the element with the specified key from the . - - The key of the element to remove. - - - As the collection is empty no values can be removed. A - is thrown if this method is called. - - - This dictionary is always empty and cannot be modified. - - - - Gets a value indicating whether the has a fixed size. - - true - - - As the collection is empty always returns true. - - - - - - Gets a value indicating whether the is read-only. - - true - - - As the collection is empty always returns true. - - - - - - Gets an containing the keys of the . - - An containing the keys of the . - - - As the collection is empty a is returned. - - - - - - Gets an containing the values of the . - - An containing the values of the . - - - As the collection is empty a is returned. - - - - - - Gets or sets the element with the specified key. - - The key of the element to get or set. - null - - - As the collection is empty no values can be looked up or stored. - If the index getter is called then null is returned. - A is thrown if the setter is called. - - - This dictionary is always empty and cannot be modified. - - - - The singleton instance of the empty dictionary. - - - - - Contain the information obtained when parsing formatting modifiers - in conversion modifiers. - - - - Holds the formatting information extracted from the format string by - the . This is used by the - objects when rendering the output. - - - Nicko Cadell - Gert Driesen - - - - Defaut Constructor - - - - Initializes a new instance of the class. - - - - - - Constructor - - - - Initializes a new instance of the class - with the specified parameters. - - - - - - Gets or sets the minimum value. - - - The minimum value. - - - - Gets or sets the minimum value. - - - - - - Gets or sets the maximum value. - - - The maximum value. - - - - Gets or sets the maximum value. - - - - - - Gets or sets a flag indicating whether left align is enabled - or not. - - - A flag indicating whether left align is enabled or not. - - - - Gets or sets a flag indicating whether left align is enabled or not. - - - - - - Implementation of Properties collection for the - - - - 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. - - - This class is optimized to the scenario where the properties are read frequently - and are modified infrequently. - - - Nicko Cadell - - - - The read only copy of the properties. - - - - This variable is declared volatile to prevent the compiler and JIT from - reordering reads and writes of this thread performed on different threads. - - - - - - Lock object used to synchronize updates within this instance - - - - - Constructor - - - - Initializes a new instance of the class. - - - - - - Gets or sets the value of a property - - - The value for the property with the specified key - - - - 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. - - - - - - Remove a property from the global context - - the key for the entry to remove - - - Removing an entry from the global context properties is relatively expensive compared - with reading a value. - - - - - - Clear the global context properties - - - - - Get a readonly immutable copy of the properties - - the current global context properties - - - This implementation is fast because the GlobalContextProperties class - stores a readonly copy of the properties. - - - - - - The static class ILogExtensions contains a set of widely used - methods that ease the interaction with the ILog interface implementations. - - - - 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. - - - Simple example of logging messages - - using log4net.Util; - - ILog log = LogManager.GetLogger("application-log"); - - log.InfoExt("Application Start"); - log.DebugExt("This is a debug message"); - - - - - - The fully qualified type of the Logger class. - - - - - Log a message object with the level. - - The logger on which the message is logged. - The lambda expression that gets the object to log. - - - This method first checks if this logger is INFO - enabled by reading the value property. - This check happens always and does not depend on the - implementation. If this logger is INFO enabled, then it converts - the message object (retrieved by invocation of the provided callback) to a - string by invoking the appropriate . - 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. - - WARNING Note that passing an - to this method will print the name of the - but no stack trace. To print a stack trace use the - form instead. - - - - - - - - Log a message object with the level including - the stack trace of the passed - as a parameter. - - The logger on which the message is logged. - The lambda expression that gets the object to log. - The exception to log, including its stack trace. - - - See the form for more detailed information. - - - - - - - Log a message object with the level. //TODO - - Log a message object with the level. - - The logger on which the message is logged. - The message object to log. - - - This method first checks if this logger is INFO - enabled by reading the value property. - This check happens always and does not depend on the - implementation. If this logger is INFO enabled, then it converts - the message object (passed as parameter) to a string by invoking the appropriate - . 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. - - WARNING Note that passing an - to this method will print the name of the - but no stack trace. To print a stack trace use the - form instead. - - - - - - - - Log a message object with the level including - the stack trace of the passed - as a parameter. - - The logger on which the message is logged. - The message object to log. - The exception to log, including its stack trace. - - - See the form for more detailed information. - - - - - - - - Logs a formatted message string with the level. - - The logger on which the message is logged. - A String containing zero or more format items - An Object to format - - - The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior - of the formatting. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - - - Logs a formatted message string with the level. - - The logger on which the message is logged. - A String containing zero or more format items - An Object array containing zero or more objects to format - - - The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior - of the formatting. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - - - Logs a formatted message string with the level. - - An that supplies culture-specific formatting information - The logger on which the message is logged. - A String containing zero or more format items - An Object array containing zero or more objects to format - - - The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior - of the formatting. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - - - Logs a formatted message string with the level. - - The logger on which the message is logged. - A String containing zero or more format items - An Object to format - An Object to format - - - The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior - of the formatting. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - - - Logs a formatted message string with the level. - - The logger on which the message is logged. - A String containing zero or more format items - An Object to format - An Object to format - An Object to format - - - The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior - of the formatting. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - - - Log a message object with the level. - - The logger on which the message is logged. - The lambda expression that gets the object to log. - - - This method first checks if this logger is INFO - enabled by reading the value property. - This check happens always and does not depend on the - implementation. If this logger is INFO enabled, then it converts - the message object (retrieved by invocation of the provided callback) to a - string by invoking the appropriate . - 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. - - WARNING Note that passing an - to this method will print the name of the - but no stack trace. To print a stack trace use the - form instead. - - - - - - - - Log a message object with the level including - the stack trace of the passed - as a parameter. - - The logger on which the message is logged. - The lambda expression that gets the object to log. - The exception to log, including its stack trace. - - - See the form for more detailed information. - - - - - - - Log a message object with the level. //TODO - - Log a message object with the level. - - The logger on which the message is logged. - The message object to log. - - - This method first checks if this logger is INFO - enabled by reading the value property. - This check happens always and does not depend on the - implementation. If this logger is INFO enabled, then it converts - the message object (passed as parameter) to a string by invoking the appropriate - . 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. - - WARNING Note that passing an - to this method will print the name of the - but no stack trace. To print a stack trace use the - form instead. - - - - - - - - Log a message object with the level including - the stack trace of the passed - as a parameter. - - The logger on which the message is logged. - The message object to log. - The exception to log, including its stack trace. - - - See the form for more detailed information. - - - - - - - - Logs a formatted message string with the level. - - The logger on which the message is logged. - A String containing zero or more format items - An Object to format - - - The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior - of the formatting. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - - - Logs a formatted message string with the level. - - The logger on which the message is logged. - A String containing zero or more format items - An Object array containing zero or more objects to format - - - The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior - of the formatting. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - - - Logs a formatted message string with the level. - - An that supplies culture-specific formatting information - The logger on which the message is logged. - A String containing zero or more format items - An Object array containing zero or more objects to format - - - The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior - of the formatting. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - - - Logs a formatted message string with the level. - - The logger on which the message is logged. - A String containing zero or more format items - An Object to format - An Object to format - - - The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior - of the formatting. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - - - Logs a formatted message string with the level. - - The logger on which the message is logged. - A String containing zero or more format items - An Object to format - An Object to format - An Object to format - - - The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior - of the formatting. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - - - Log a message object with the level. - - The logger on which the message is logged. - The lambda expression that gets the object to log. - - - This method first checks if this logger is WARN - enabled by reading the value property. - This check happens always and does not depend on the - implementation. If this logger is WARN enabled, then it converts - the message object (retrieved by invocation of the provided callback) to a - string by invoking the appropriate . - 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. - - WARNING Note that passing an - to this method will print the name of the - but no stack trace. To print a stack trace use the - form instead. - - - - - - - - Log a message object with the level including - the stack trace of the passed - as a parameter. - - The logger on which the message is logged. - The lambda expression that gets the object to log. - The exception to log, including its stack trace. - - - See the form for more detailed information. - - - - - - - Log a message object with the level. //TODO - - Log a message object with the level. - - The logger on which the message is logged. - The message object to log. - - - This method first checks if this logger is WARN - enabled by reading the value property. - This check happens always and does not depend on the - implementation. If this logger is WARN enabled, then it converts - the message object (passed as parameter) to a string by invoking the appropriate - . 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. - - WARNING Note that passing an - to this method will print the name of the - but no stack trace. To print a stack trace use the - form instead. - - - - - - - - Log a message object with the level including - the stack trace of the passed - as a parameter. - - The logger on which the message is logged. - The message object to log. - The exception to log, including its stack trace. - - - See the form for more detailed information. - - - - - - - - Logs a formatted message string with the level. - - The logger on which the message is logged. - A String containing zero or more format items - An Object to format - - - The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior - of the formatting. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - - - Logs a formatted message string with the level. - - The logger on which the message is logged. - A String containing zero or more format items - An Object array containing zero or more objects to format - - - The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior - of the formatting. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - - - Logs a formatted message string with the level. - - An that supplies culture-specific formatting information - The logger on which the message is logged. - A String containing zero or more format items - An Object array containing zero or more objects to format - - - The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior - of the formatting. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - - - Logs a formatted message string with the level. - - The logger on which the message is logged. - A String containing zero or more format items - An Object to format - An Object to format - - - The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior - of the formatting. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - - - Logs a formatted message string with the level. - - The logger on which the message is logged. - A String containing zero or more format items - An Object to format - An Object to format - An Object to format - - - The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior - of the formatting. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - - - Log a message object with the level. - - The logger on which the message is logged. - The lambda expression that gets the object to log. - - - This method first checks if this logger is ERROR - enabled by reading the value property. - This check happens always and does not depend on the - implementation. If this logger is ERROR enabled, then it converts - the message object (retrieved by invocation of the provided callback) to a - string by invoking the appropriate . - 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. - - WARNING Note that passing an - to this method will print the name of the - but no stack trace. To print a stack trace use the - form instead. - - - - - - - - Log a message object with the level including - the stack trace of the passed - as a parameter. - - The logger on which the message is logged. - The lambda expression that gets the object to log. - The exception to log, including its stack trace. - - - See the form for more detailed information. - - - - - - - Log a message object with the level. //TODO - - Log a message object with the level. - - The logger on which the message is logged. - The message object to log. - - - This method first checks if this logger is ERROR - enabled by reading the value property. - This check happens always and does not depend on the - implementation. If this logger is ERROR enabled, then it converts - the message object (passed as parameter) to a string by invoking the appropriate - . 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. - - WARNING Note that passing an - to this method will print the name of the - but no stack trace. To print a stack trace use the - form instead. - - - - - - - - Log a message object with the level including - the stack trace of the passed - as a parameter. - - The logger on which the message is logged. - The message object to log. - The exception to log, including its stack trace. - - - See the form for more detailed information. - - - - - - - - Logs a formatted message string with the level. - - The logger on which the message is logged. - A String containing zero or more format items - An Object to format - - - The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior - of the formatting. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - - - Logs a formatted message string with the level. - - The logger on which the message is logged. - A String containing zero or more format items - An Object array containing zero or more objects to format - - - The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior - of the formatting. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - - - Logs a formatted message string with the level. - - An that supplies culture-specific formatting information - The logger on which the message is logged. - A String containing zero or more format items - An Object array containing zero or more objects to format - - - The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior - of the formatting. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - - - Logs a formatted message string with the level. - - The logger on which the message is logged. - A String containing zero or more format items - An Object to format - An Object to format - - - The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior - of the formatting. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - - - Logs a formatted message string with the level. - - The logger on which the message is logged. - A String containing zero or more format items - An Object to format - An Object to format - An Object to format - - - The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior - of the formatting. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - - - Log a message object with the level. - - The logger on which the message is logged. - The lambda expression that gets the object to log. - - - This method first checks if this logger is FATAL - enabled by reading the value property. - This check happens always and does not depend on the - implementation. If this logger is FATAL enabled, then it converts - the message object (retrieved by invocation of the provided callback) to a - string by invoking the appropriate . - 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. - - WARNING Note that passing an - to this method will print the name of the - but no stack trace. To print a stack trace use the - form instead. - - - - - - - - Log a message object with the level including - the stack trace of the passed - as a parameter. - - The logger on which the message is logged. - The lambda expression that gets the object to log. - The exception to log, including its stack trace. - - - See the form for more detailed information. - - - - - - - Log a message object with the level. //TODO - - Log a message object with the level. - - The logger on which the message is logged. - The message object to log. - - - This method first checks if this logger is FATAL - enabled by reading the value property. - This check happens always and does not depend on the - implementation. If this logger is FATAL enabled, then it converts - the message object (passed as parameter) to a string by invoking the appropriate - . 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. - - WARNING Note that passing an - to this method will print the name of the - but no stack trace. To print a stack trace use the - form instead. - - - - - - - - Log a message object with the level including - the stack trace of the passed - as a parameter. - - The logger on which the message is logged. - The message object to log. - The exception to log, including its stack trace. - - - See the form for more detailed information. - - - - - - - - Logs a formatted message string with the level. - - The logger on which the message is logged. - A String containing zero or more format items - An Object to format - - - The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior - of the formatting. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - - - Logs a formatted message string with the level. - - The logger on which the message is logged. - A String containing zero or more format items - An Object array containing zero or more objects to format - - - The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior - of the formatting. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - - - Logs a formatted message string with the level. - - An that supplies culture-specific formatting information - The logger on which the message is logged. - A String containing zero or more format items - An Object array containing zero or more objects to format - - - The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior - of the formatting. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - - - Logs a formatted message string with the level. - - The logger on which the message is logged. - A String containing zero or more format items - An Object to format - An Object to format - - - The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior - of the formatting. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - - - Logs a formatted message string with the level. - - The logger on which the message is logged. - A String containing zero or more format items - An Object to format - An Object to format - An Object to format - - - The message is formatted using the String.Format method. See - for details of the syntax of the format string and the behavior - of the formatting. - - - This method does not take an object to include in the - log event. To pass an use one of the - methods instead. - - - - - - - - Manages a mapping from levels to - - - - Manages an ordered mapping from instances - to subclasses. - - - Nicko Cadell - - - - Default constructor - - - - Initialise a new instance of . - - - - - - Add a to this mapping - - the entry to add - - - If a has previously been added - for the same then that entry will be - overwritten. - - - - - - Lookup the mapping for the specified level - - the level to lookup - the for the level or null if no mapping found - - - Lookup the value for the specified level. Finds the nearest - mapping value for the level that is equal to or less than the - specified. - - - If no mapping could be found then null is returned. - - - - - - Initialize options - - - - Caches the sorted list of in an array - - - - - - An entry in the - - - - This is an abstract base class for types that are stored in the - object. - - - Nicko Cadell - - - - Default protected constructor - - - - Default protected constructor - - - - - - The level that is the key for this mapping - - - The that is the key for this mapping - - - - Get or set the that is the key for this - mapping subclass. - - - - - - Initialize any options defined on this entry - - - - Should be overridden by any classes that need to initialise based on their options - - - - - - Implementation of Properties collection for the - - - - Class implements a collection of properties that is specific to each thread. - The class is not synchronized as each thread has its own . - - - This class stores its properties in a slot on the named - log4net.Util.LogicalThreadContextProperties. - - - For .NET Standard 1.3 this class uses - System.Threading.AsyncLocal rather than . - - - The requires a link time - for the - . - 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. - - - Nicko Cadell - - - - Flag used to disable this context if we don't have permission to access the CallContext. - - - - - Constructor - - - - Initializes a new instance of the class. - - - - - - Gets or sets the value of a property - - - The value for the property with the specified key - - - - Get or set the property value for the specified. - - - - - - Remove a property - - the key for the entry to remove - - - Remove the value for the specified from the context. - - - - - - Clear all the context properties - - - - Clear all the context properties - - - - - - Get the PropertiesDictionary stored in the LocalDataStoreSlot for this thread. - - create the dictionary if it does not exist, otherwise return null if is does not exist - the properties for this thread - - - 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. - - - - - - Gets the call context get data. - - The peroperties dictionary stored in the call context - - The method has a - security link demand, therfore we must put the method call in a seperate method - that we can wrap in an exception handler. - - - - - Sets the call context data. - - The properties. - - The method has a - security link demand, therfore we must put the method call in a seperate method - that we can wrap in an exception handler. - - - - - The fully qualified type of the LogicalThreadContextProperties class. - - - Used by the internal logger to record the Type of the - log message. - - - - - Delegate type used for LogicalThreadContextStack's callbacks. - - - - - Implementation of Stack for the - - - - Implementation of Stack for the - - - Nicko Cadell - - - - The stack store. - - - - - The name of this within the - . - - - - - The callback used to let the register a - new instance of a . - - - - - Internal constructor - - - - Initializes a new instance of the class. - - - - - - The number of messages in the stack - - - The current number of messages in the stack - - - - The current number of messages in the stack. That is - the number of times has been called - minus the number of times has been called. - - - - - - Clears all the contextual information held in this stack. - - - - Clears all the contextual information held in this stack. - Only call this if you think that this thread 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 method of the - returned from even in exceptional circumstances, - for example by using the using(log4net.LogicalThreadContext.Stacks["NDC"].Push("Stack_Message")) - syntax. - - - - - - Removes the top context from this stack. - - The message in the context that was removed from the top of this stack. - - - Remove the top context from this stack, and return - it to the caller. If this stack is empty then an - empty string (not ) is returned. - - - - - - Pushes a new context message into this stack. - - The new context message. - - An that can be used to clean up the context stack. - - - - Pushes a new context onto this stack. An - is returned that can be used to clean up this stack. This - can be easily combined with the using keyword to scope the - context. - - - Simple example of using the Push method with the using keyword. - - using(log4net.LogicalThreadContext.Stacks["NDC"].Push("Stack_Message")) - { - log.Warn("This should have an ThreadContext Stack message"); - } - - - - - - Gets the current context information for this stack. - - The current context information. - - - - Gets and sets the internal stack used by this - - The internal storage stack - - - This property is provided only to support backward compatability - of the . Tytpically the internal stack should not - be modified. - - - - - - Gets the current context information for this stack. - - Gets the current context information - - - Gets the current context information for this stack. - - - - - - Get a portable version of this object - - the portable instance of this object - - - Get a cross thread portable version of this object - - - - - - Inner class used to represent a single context frame in the stack. - - - - Inner class used to represent a single context frame in the stack. - - - - - - Constructor - - The message for this context. - The parent context in the chain. - - - Initializes a new instance of the class - with the specified message and parent context. - - - - - - Get the message. - - The message. - - - Get the message. - - - - - - Gets the full text of the context down to the root level. - - - The full text of the context down to the root level. - - - - Gets the full text of the context down to the root level. - - - - - - Struct returned from the method. - - - - This struct implements the and is designed to be used - with the pattern to remove the stack frame at the end of the scope. - - - - - - The depth to trim the stack to when this instance is disposed - - - - - The outer LogicalThreadContextStack. - - - - - Constructor - - The internal stack used by the ThreadContextStack. - The depth to return the stack to when this object is disposed. - - - Initializes a new instance of the class with - the specified stack and return depth. - - - - - - Returns the stack to the correct depth. - - - - Returns the stack to the correct depth. - - - - - - Implementation of Stacks collection for the - - - - Implementation of Stacks collection for the - - - Nicko Cadell - - - - Internal constructor - - - - Initializes a new instance of the class. - - - - - - Gets the named thread context stack - - - The named stack - - - - Gets the named thread context stack - - - - - - The fully qualified type of the ThreadContextStacks class. - - - Used by the internal logger to record the Type of the - log message. - - - - - - - - - - - - Outputs log statements from within the log4net assembly. - - - - Log4net components cannot make log4net logging calls. However, it is - sometimes useful for the user to learn about what log4net is - doing. - - - All log4net internal debug calls go to the standard output stream - whereas internal error messages are sent to the standard error output - stream. - - - Nicko Cadell - Gert Driesen - - - - The event raised when an internal message has been received. - - - - - The Type that generated the internal message. - - - - - The DateTime stamp of when the internal message was received. - - - - - The UTC DateTime stamp of when the internal message was received. - - - - - A string indicating the severity of the internal message. - - - "log4net: ", - "log4net:ERROR ", - "log4net:WARN " - - - - - The internal log message. - - - - - The Exception related to the message. - - - Optional. Will be null if no Exception was passed. - - - - - Formats Prefix, Source, and Message in the same format as the value - sent to Console.Out and Trace.Write. - - - - - - Initializes a new instance of the class. - - - - - - - - - Static constructor that initializes logging by reading - settings from the application configuration file. - - - - The log4net.Internal.Debug application setting - controls internal debugging. This setting should be set - to true to enable debugging. - - - The log4net.Internal.Quiet application setting - suppresses all internal logging including error messages. - This setting should be set to true to enable message - suppression. - - - - - - Gets or sets a value indicating whether log4net internal logging - is enabled or disabled. - - - true if log4net internal logging is enabled, otherwise - false. - - - - When set to true, internal debug level logging will be - displayed. - - - This value can be set by setting the application setting - log4net.Internal.Debug in the application configuration - file. - - - The default value is false, i.e. debugging is - disabled. - - - - - The following example enables internal debugging using the - application configuration file : - - - - - - - - - - - - - Gets or sets a value indicating whether log4net should generate no output - from internal logging, not even for errors. - - - true if log4net should generate no output at all from internal - logging, otherwise false. - - - - When set to true 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 setting and - disables all debug also. - - This value can be set by setting the application setting - log4net.Internal.Quiet in the application configuration file. - - - The default value is false, i.e. internal logging is not - disabled. - - - - The following example disables internal logging using the - application configuration file : - - - - - - - - - - - - - - - - - Raises the LogReceived event when an internal messages is received. - - - - - - - - - Test if LogLog.Debug is enabled for output. - - - true if Debug is enabled - - - - Test if LogLog.Debug is enabled for output. - - - - - - Writes log4net internal debug messages to the - standard output stream. - - - The message to log. - - - All internal debug messages are prepended with - the string "log4net: ". - - - - - - Writes log4net internal debug messages to the - standard output stream. - - The Type that generated this message. - The message to log. - An exception to log. - - - All internal debug messages are prepended with - the string "log4net: ". - - - - - - Test if LogLog.Warn is enabled for output. - - - true if Warn is enabled - - - - Test if LogLog.Warn is enabled for output. - - - - - - Writes log4net internal warning messages to the - standard error stream. - - The Type that generated this message. - The message to log. - - - All internal warning messages are prepended with - the string "log4net:WARN ". - - - - - - Writes log4net internal warning messages to the - standard error stream. - - The Type that generated this message. - The message to log. - An exception to log. - - - All internal warning messages are prepended with - the string "log4net:WARN ". - - - - - - Test if LogLog.Error is enabled for output. - - - true if Error is enabled - - - - Test if LogLog.Error is enabled for output. - - - - - - Writes log4net internal error messages to the - standard error stream. - - The Type that generated this message. - The message to log. - - - All internal error messages are prepended with - the string "log4net:ERROR ". - - - - - - Writes log4net internal error messages to the - standard error stream. - - The Type that generated this message. - The message to log. - An exception to log. - - - All internal debug messages are prepended with - the string "log4net:ERROR ". - - - - - - Writes output to the standard output stream. - - The message to log. - - - Writes to both Console.Out and System.Diagnostics.Trace. - Note that the System.Diagnostics.Trace is not supported - on the Compact Framework. - - - 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. - - - - - - Writes output to the standard error stream. - - The message to log. - - - Writes to both Console.Error and System.Diagnostics.Trace. - Note that the System.Diagnostics.Trace is not supported - on the Compact Framework. - - - 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. - - - - - - Default debug level - - - - - In quietMode not even errors generate any output. - - - - - Subscribes to the LogLog.LogReceived event and stores messages - to the supplied IList instance. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Represents a native error code and message. - - - - Represents a Win32 platform native error. - - - Nicko Cadell - Gert Driesen - - - - Create an instance of the class with the specified - error number and message. - - The number of the native error. - The message of the native error. - - - Create an instance of the class with the specified - error number and message. - - - - - - Gets the number of the native error. - - - The number of the native error. - - - - Gets the number of the native error. - - - - - - Gets the message of the native error. - - - The message of the native error. - - - - - Gets the message of the native error. - - - - - Create a new instance of the class for the last Windows error. - - - An instance of the class for the last windows error. - - - - The message for the error number is lookup up using the - native Win32 FormatMessage function. - - - - - - Create a new instance of the class. - - the error number for the native error - - An instance of the class for the specified - error number. - - - - The message for the specified error number is lookup up using the - native Win32 FormatMessage function. - - - - - - Retrieves the message corresponding with a Win32 message identifier. - - Message identifier for the requested message. - - The message corresponding with the specified message identifier. - - - - The message will be searched for in system message-table resource(s) - using the native FormatMessage function. - - - - - - Return error information string - - error information string - - - Return error information string - - - - - - Formats a message string. - - Formatting options, and how to interpret the parameter. - Location of the message definition. - Message identifier for the requested message. - Language identifier for the requested message. - If includes FORMAT_MESSAGE_ALLOCATE_BUFFER, the function allocates a buffer using the LocalAlloc function, and places the pointer to the buffer at the address specified in . - 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. - Pointer to an array of values that are used as insert values in the formatted message. - - - 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. - - - To prevent the usage of unsafe code, this stub does not support inserting values in the formatted message. - - - - - If the function succeeds, the return value is the number of TCHARs stored in the output - buffer, excluding the terminating null character. - - - If the function fails, the return value is zero. To get extended error information, - call . - - - - - - An always empty . - - - - A singleton implementation of the over a collection - that is empty and not modifiable. - - - Nicko Cadell - Gert Driesen - - - - Initializes a new instance of the class. - - - - Uses a private access modifier to enforce the singleton pattern. - - - - - - Gets the singleton instance of the . - - The singleton instance of the . - - - Gets the singleton instance of the . - - - - - - Gets the current object from the enumerator. - - - Throws an because the - never has a current value. - - - - As the enumerator is over an empty collection its - value cannot be moved over a valid position, therefore - will throw an . - - - The collection is empty and - cannot be positioned over a valid location. - - - - Test if the enumerator can advance, if so advance. - - false as the cannot advance. - - - As the enumerator is over an empty collection its - value cannot be moved over a valid position, therefore - will always return false. - - - - - - Resets the enumerator back to the start. - - - - As the enumerator is over an empty collection does nothing. - - - - - - Gets the current key from the enumerator. - - - Throws an exception because the - never has a current value. - - - - As the enumerator is over an empty collection its - value cannot be moved over a valid position, therefore - will throw an . - - - The collection is empty and - cannot be positioned over a valid location. - - - - Gets the current value from the enumerator. - - The current value from the enumerator. - - Throws an because the - never has a current value. - - - - As the enumerator is over an empty collection its - value cannot be moved over a valid position, therefore - will throw an . - - - The collection is empty and - cannot be positioned over a valid location. - - - - Gets the current entry from the enumerator. - - - Throws an because the - never has a current entry. - - - - As the enumerator is over an empty collection its - value cannot be moved over a valid position, therefore - will throw an . - - - The collection is empty and - cannot be positioned over a valid location. - - - - The singleton instance of the . - - - - - An always empty . - - - - A singleton implementation of the over a collection - that is empty and not modifiable. - - - Nicko Cadell - Gert Driesen - - - - Initializes a new instance of the class. - - - - Uses a private access modifier to enforce the singleton pattern. - - - - - - Get the singleton instance of the . - - The singleton instance of the . - - - Gets the singleton instance of the . - - - - - - Gets the current object from the enumerator. - - - Throws an because the - never has a current value. - - - - As the enumerator is over an empty collection its - value cannot be moved over a valid position, therefore - will throw an . - - - The collection is empty and - cannot be positioned over a valid location. - - - - Test if the enumerator can advance, if so advance - - false as the cannot advance. - - - As the enumerator is over an empty collection its - value cannot be moved over a valid position, therefore - will always return false. - - - - - - Resets the enumerator back to the start. - - - - As the enumerator is over an empty collection does nothing. - - - - - - The singleton instance of the . - - - - - A SecurityContext used when a SecurityContext is not required - - - - The is a no-op implementation of the - base class. It is used where a - is required but one has not been provided. - - - Nicko Cadell - - - - Singleton instance of - - - - Singleton instance of - - - - - - Private constructor - - - - Private constructor for singleton pattern. - - - - - - Impersonate this SecurityContext - - State supplied by the caller - null - - - No impersonation is done and null is always returned. - - - - - - 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. - - - - The error message is processed using the LogLog sub-system by default. - - - This policy aims at protecting an otherwise working application - from being flooded with error messages when logging fails. - - - Nicko Cadell - Gert Driesen - Ron Grabowski - - - - Default Constructor - - - - Initializes a new instance of the class. - - - - - - Constructor - - The prefix to use for each message. - - - Initializes a new instance of the class - with the specified prefix. - - - - - - Reset the error handler back to its initial disabled state. - - - - - Log an Error - - The error message. - The exception. - The internal error code. - - - Invokes if and only if this is the first error or the first error after has been called. - - - - - - Log the very first error - - The error message. - The exception. - The internal error code. - - - Sends the error information to 's Error method. - - - - - - Log an Error - - The error message. - The exception. - - - Invokes if and only if this is the first error or the first error after has been called. - - - - - - Log an error - - The error message. - - - Invokes if and only if this is the first error or the first error after has been called. - - - - - - Is error logging enabled - - - - Is error logging enabled. Logging is only enabled for the - first error delivered to the . - - - - - - The date the first error that trigged this error handler occurred, or if it has not been triggered. - - - - - The UTC date the first error that trigged this error handler occured, or if it has not been triggered. - - - - - The message from the first error that trigged this error handler. - - - - - The exception from the first error that trigged this error handler. - - - May be . - - - - - The error code from the first error that trigged this error handler. - - - Defaults to - - - - - The UTC date the error was recorded. - - - - - Flag to indicate if it is the first error - - - - - The message recorded during the first error. - - - - - The exception recorded during the first error. - - - - - The error code recorded during the first error. - - - - - String to prefix each message with - - - - - The fully qualified type of the OnlyOnceErrorHandler class. - - - Used by the internal logger to record the Type of the - log message. - - - - - A convenience class to convert property values to specific types. - - - - Utility functions for converting types and parsing values. - - - Nicko Cadell - Gert Driesen - - - - Initializes a new instance of the class. - - - - Uses a private access modifier to prevent instantiation of this class. - - - - - - Converts a string to a value. - - String to convert. - The default value. - The value of . - - - If is "true", then true is returned. - If is "false", then false is returned. - Otherwise, is returned. - - - - - - Parses a file size into a number. - - String to parse. - The default value. - The value of . - - - Parses a file size of the form: number[KB|MB|GB] into a - long value. It is scaled with the appropriate multiplier. - - - is returned when - cannot be converted to a value. - - - - - - Converts a string to an object. - - The target type to convert to. - The string to convert to an object. - - The object converted from a string or null when the - conversion failed. - - - - Converts a string to an object. Uses the converter registry to try - to convert the string value into the specified target type. - - - - - - Checks if there is an appropriate type conversion from the source type to the target type. - - The type to convert from. - The type to convert to. - true if there is a conversion from the source type to the target type. - - Checks if there is an appropriate type conversion from the source type to the target type. - - - - - - - Converts an object to the target type. - - The object to convert to the target type. - The type to convert to. - The converted object. - - - Converts an object to the target type. - - - - - - Instantiates an object given a class name. - - The fully qualified class name of the object to instantiate. - The class to which the new object should belong. - The object to return in case of non-fulfillment. - - An instance of the or - if the object could not be instantiated. - - - - Checks that the is a subclass of - . If that test fails or the object could - not be instantiated, then is returned. - - - - - - Performs variable substitution in string from the - values of keys found in . - - The string on which variable substitution is performed. - The dictionary to use to lookup variables. - The result of the substitutions. - - - The variable substitution delimiters are ${ and }. - - - For example, if props contains key=value, then the call - - - - string s = OptionConverter.SubstituteVariables("Value of key is ${key}."); - - - - will set the variable s to "Value of key is value.". - - - If no value could be found for the specified key, then substitution - defaults to an empty string. - - - For example, if system properties contains no value for the key - "nonExistentKey", then the call - - - - string s = OptionConverter.SubstituteVariables("Value of nonExistentKey is [${nonExistentKey}]"); - - - - will set s to "Value of nonExistentKey is []". - - - An Exception is thrown if contains a start - delimiter "${" which is not balanced by a stop delimiter "}". - - - - - - Converts the string representation of the name or numeric value of one or - more enumerated constants to an equivalent enumerated object. - - The type to convert to. - The enum string value. - If true, ignore case; otherwise, regard case. - An object of type whose value is represented by . - - - - The fully qualified type of the OptionConverter class. - - - Used by the internal logger to record the Type of the - log message. - - - - - Abstract class that provides the formatting functionality that - derived classes need. - - - - 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. - - - Nicko Cadell - Gert Driesen - - - - Protected constructor - - - - Initializes a new instance of the class. - - - - - - Get the next pattern converter in the chain - - - the next pattern converter in the chain - - - - Get the next pattern converter in the chain - - - - - - Gets or sets the formatting info for this converter - - - The formatting info for this converter - - - - Gets or sets the formatting info for this converter - - - - - - Gets or sets the option value for this converter - - - The option for this converter - - - - Gets or sets the option value for this converter - - - - - - Evaluate this pattern converter and write the output to a writer. - - that will receive the formatted result. - The state object on which the pattern converter should be executed. - - - Derived pattern converters must override this method in order to - convert conversion specifiers in the appropriate way. - - - - - - Set the next pattern converter in the chains - - the pattern converter that should follow this converter in the chain - the next converter - - - 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. - - - - - - Write the pattern converter to the writer with appropriate formatting - - that will receive the formatted result. - The state object on which the pattern converter should be executed. - - - This method calls to allow the subclass to perform - appropriate conversion of the pattern converter. If formatting options have - been specified via the then this method will - apply those formattings before writing the output. - - - - - - Fast space padding method. - - to which the spaces will be appended. - The number of spaces to be padded. - - - Fast space padding method. - - - - - - The option string to the converter - - - - - Initial buffer size - - - - - Maximum buffer size before it is recycled - - - - - Write an dictionary to a - - the writer to write to - a to use for object conversion - the value to write to the writer - - - Writes the to a writer in the form: - - - {key1=value1, key2=value2, key3=value3} - - - If the specified - is not null then it is used to render the key and value to text, otherwise - the object's ToString method is called. - - - - - - Write an dictionary to a - - the writer to write to - a to use for object conversion - the value to write to the writer - - - Writes the to a writer in the form: - - - {key1=value1, key2=value2, key3=value3} - - - If the specified - is not null then it is used to render the key and value to text, otherwise - the object's ToString method is called. - - - - - - Write an object to a - - the writer to write to - a to use for object conversion - the value to write to the writer - - - Writes the Object to a writer. If the specified - is not null then it is used to render the object to text, otherwise - the object's ToString method is called. - - - - - - - - - - - Most of the work of the class - is delegated to the PatternParser class. - - - - The PatternParser processes a pattern string and - returns a chain of objects. - - - Nicko Cadell - Gert Driesen - - - - Constructor - - The pattern to parse. - - - Initializes a new instance of the class - with the specified pattern string. - - - - - - Parses the pattern into a chain of pattern converters. - - The head of a chain of pattern converters. - - - Parses the pattern into a chain of pattern converters. - - - - - - Get the converter registry used by this parser - - - The converter registry used by this parser - - - - Get the converter registry used by this parser - - - - - - Build the unified cache of converters from the static and instance maps - - the list of all the converter names - - - Build the unified cache of converters from the static and instance maps - - - - - - Sort strings by length - - - - that orders strings by string length. - The longest strings are placed first - - - - - - Internal method to parse the specified pattern to find specified matches - - the pattern to parse - the converter names to match in the pattern - - - The matches param must be sorted such that longer strings come before shorter ones. - - - - - - Process a parsed literal - - the literal text - - - - Process a parsed converter pattern - - the name of the converter - the optional option for the converter - the formatting info for the converter - - - - Resets the internal state of the parser and adds the specified pattern converter - to the chain. - - The pattern converter to add. - - - - The first pattern converter in the chain - - - - - the last pattern converter in the chain - - - - - The pattern - - - - - Internal map of converter identifiers to converter types - - - - This map overrides the static s_globalRulesRegistry map. - - - - - - The fully qualified type of the PatternParser class. - - - Used by the internal logger to record the Type of the - log message. - - - - - This class implements a patterned string. - - - - This string has embedded patterns that are resolved and expanded - when the string is formatted. - - - This class functions similarly to the - in that it accepts a pattern and renders it to a string. Unlike the - however the PatternString - does not render the properties of a specific but - of the process in general. - - - The recognized conversion pattern names are: - - - - Conversion Pattern Name - Effect - - - appdomain - - - Used to output the friendly name of the current AppDomain. - - - - - appsetting - - - Used to output the value of a specific appSetting key in the application - configuration file. - - - - - date - - - Used to output the current date and time in the local time zone. - To output the date in universal time use the %utcdate pattern. - The date conversion - specifier may be followed by a date format specifier enclosed - between braces. For example, %date{HH:mm:ss,fff} or - %date{dd MMM yyyy HH:mm:ss,fff}. If no date format specifier is - given then ISO8601 format is - assumed (). - - - The date format specifier admits the same syntax as the - time pattern string of the . - - - 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 - , - and respectively - . For example, - %date{ISO8601} or %date{ABSOLUTE}. - - - These dedicated date formatters perform significantly - better than . - - - - - env - - - 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. %env{COMPUTERNAME} would include the value - of the COMPUTERNAME environment variable. - - - The env pattern is not supported on the .NET Compact Framework. - - - - - identity - - - Used to output the user name for the currently active user - (Principal.Identity.Name). - - - - - newline - - - Outputs the platform dependent line separator character or - characters. - - - 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. - - - - - processid - - - Used to output the system process ID for the current process. - - - - - property - - - Used to output a specific context property. The key to - lookup must be specified within braces and directly following the - pattern specifier, e.g. %property{user} 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 log4net:HostName property is set to the name of machine on - which the event was originally logged. - - - If no key is specified, e.g. %property then all the keys and their - values are printed in a comma separated list. - - - 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. - - - - the thread properties - - The that are set on the current - thread. These properties are shared by all events logged on this thread. - - - - the global properties - - The that are set globally. These - properties are shared by all the threads in the AppDomain. - - - - - - - random - - - 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. %random{8} would output an 8 character string. - - - - - username - - - Used to output the WindowsIdentity for the currently - active user. - - - - - utcdate - - - Used to output the date of the logging event in universal time. - The date conversion - specifier may be followed by a date format specifier enclosed - between braces. For example, %utcdate{HH:mm:ss,fff} or - %utcdate{dd MMM yyyy HH:mm:ss,fff}. If no date format specifier is - given then ISO8601 format is - assumed (). - - - The date format specifier admits the same syntax as the - time pattern string of the . - - - 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 - , - and respectively - . For example, - %utcdate{ISO8601} or %utcdate{ABSOLUTE}. - - - These dedicated date formatters perform significantly - better than . - - - - - % - - - The sequence %% outputs a single percent sign. - - - - - - Additional pattern converters may be registered with a specific - instance using or - . - - - See the for details on the - format modifiers supported by the patterns. - - - Nicko Cadell - - - - Internal map of converter identifiers to converter types. - - - - - the pattern - - - - - the head of the pattern converter chain - - - - - patterns defined on this PatternString only - - - - - Initialize the global registry - - - - - Default constructor - - - - Initialize a new instance of - - - - - - Constructs a PatternString - - The pattern to use with this PatternString - - - Initialize a new instance of with the pattern specified. - - - - - - Gets or sets the pattern formatting string - - - The pattern formatting string - - - - The ConversionPattern option. This is the string which - controls formatting and consists of a mix of literal content and - conversion specifiers. - - - - - - Initialize object options - - - - This is part of the delayed object - activation scheme. The method must - be called on this object after the configuration properties have - been set. Until is called this - object is in an undefined state and must not be used. - - - If any of the configuration properties are modified then - must be called again. - - - - - - Create the used to parse the pattern - - the pattern to parse - The - - - Returns PatternParser used to parse the conversion string. Subclasses - may override this to return a subclass of PatternParser which recognize - custom conversion pattern name. - - - - - - Produces a formatted string as specified by the conversion pattern. - - The TextWriter to write the formatted event to - - - Format the pattern to the . - - - - - - Format the pattern as a string - - the pattern formatted as a string - - - Format the pattern to a string. - - - - - - Add a converter to this PatternString - - the converter info - - - This version of the method is used by the configurator. - Programmatic users should use the alternative method. - - - - - - Add a converter to this PatternString - - the name of the conversion pattern for this converter - the type of the converter - - - Add a converter to this PatternString - - - - - - Write the name of the current AppDomain to the output - - - - Write the name of the current AppDomain to the output writer - - - Nicko Cadell - - - - Write the name of the current AppDomain to the output - - the writer to write to - null, state is not set - - - Writes name of the current AppDomain to the output . - - - - - - AppSetting pattern converter - - - - This pattern converter reads appSettings from the application configuration file. - - - If the is specified then that will be used to - lookup a single appSettings value. If no is specified - then all appSettings will be dumped as a list of key value pairs. - - - A typical use is to specify a base directory for log files, e.g. - - - - - ... - - - ]]> - - - - - - - Write the property value to the output - - that will receive the formatted result. - null, state is not set - - - Writes out the value of a named property. The property name - should be set in the - property. - - - If the is set to null - then all the properties are written as key value pairs. - - - - - - Write the current date to the output - - - - Date pattern converter, uses a to format - the current date and time to the writer as a string. - - - The value of the determines - the formatting of the date. The following values are allowed: - - - Option value - Output - - - ISO8601 - - Uses the formatter. - Formats using the "yyyy-MM-dd HH:mm:ss,fff" pattern. - - - - DATE - - Uses the formatter. - Formats using the "dd MMM yyyy HH:mm:ss,fff" for example, "06 Nov 1994 15:49:37,459". - - - - ABSOLUTE - - Uses the formatter. - Formats using the "HH:mm:ss,fff" for example, "15:49:37,459". - - - - other - - Any other pattern string uses the formatter. - This formatter passes the pattern string to the - method. - For details on valid patterns see - DateTimeFormatInfo Class. - - - - - - The date and time is in the local time zone and is rendered in that zone. - To output the time in Universal time see . - - - Nicko Cadell - - - - The used to render the date to a string - - - - The used to render the date to a string - - - - - - Initialize the converter options - - - - This is part of the delayed object - activation scheme. The method must - be called on this object after the configuration properties have - been set. Until is called this - object is in an undefined state and must not be used. - - - If any of the configuration properties are modified then - must be called again. - - - - - - Write the current date to the output - - that will receive the formatted result. - null, state is not set - - - Pass the current date and time to the - for it to render it to the writer. - - - The date and time passed is in the local time zone. - - - - - - The fully qualified type of the DatePatternConverter class. - - - Used by the internal logger to record the Type of the - log message. - - - - - Write an folder path to the output - - - - Write an special path environment folder path to the output writer. - The value of the determines - the name of the variable to output. - should be a value in the enumeration. - - - Ron Grabowski - - - - Write an special path environment folder path to the output - - the writer to write to - null, state is not set - - - Writes the special path environment folder path to the output . - The name of the special path environment folder path to output must be set - using the - property. - - - - - - The fully qualified type of the EnvironmentFolderPathPatternConverter class. - - - Used by the internal logger to record the Type of the - log message. - - - - - Write an environment variable to the output - - - - Write an environment variable to the output writer. - The value of the determines - the name of the variable to output. - - - Nicko Cadell - - - - Write an environment variable to the output - - the writer to write to - null, state is not set - - - Writes the environment variable to the output . - The name of the environment variable to output must be set - using the - property. - - - - - - The fully qualified type of the EnvironmentPatternConverter class. - - - Used by the internal logger to record the Type of the - log message. - - - - - Write the current thread identity to the output - - - - Write the current thread identity to the output writer - - - Nicko Cadell - - - - Write the current thread identity to the output - - the writer to write to - null, state is not set - - - Writes the current thread identity to the output . - - - - - - The fully qualified type of the IdentityPatternConverter class. - - - Used by the internal logger to record the Type of the - log message. - - - - - Pattern converter for literal string instances in the pattern - - - - Writes the literal string value specified in the - property to - the output. - - - Nicko Cadell - - - - Set the next converter in the chain - - The next pattern converter in the chain - The next pattern converter - - - Special case the building of the pattern converter chain - for instances. Two adjacent - literals in the pattern can be represented by a single combined - pattern converter. This implementation detects when a - is added to the chain - after this converter and combines its value with this converter's - literal value. - - - - - - Write the literal to the output - - the writer to write to - null, not set - - - Override the formatting behavior to ignore the FormattingInfo - because we have a literal instead. - - - Writes the value of - to the output . - - - - - - Convert this pattern into the rendered message - - that will receive the formatted result. - null, not set - - - This method is not used. - - - - - - Writes a newline to the output - - - - Writes the system dependent line terminator to the output. - This behavior can be overridden by setting the : - - - - Option Value - Output - - - DOS - DOS or Windows line terminator "\r\n" - - - UNIX - UNIX line terminator "\n" - - - - Nicko Cadell - - - - Initialize the converter - - - - This is part of the delayed object - activation scheme. The method must - be called on this object after the configuration properties have - been set. Until is called this - object is in an undefined state and must not be used. - - - If any of the configuration properties are modified then - must be called again. - - - - - - Write the current process ID to the output - - - - Write the current process ID to the output writer - - - Nicko Cadell - - - - Write the current process ID to the output - - the writer to write to - null, state is not set - - - Write the current process ID to the output . - - - - - - The fully qualified type of the ProcessIdPatternConverter class. - - - Used by the internal logger to record the Type of the - log message. - - - - - Property pattern converter - - - - This pattern converter reads the thread and global properties. - The thread properties take priority over global properties. - See for details of the - thread properties. See for - details of the global properties. - - - If the is specified then that will be used to - lookup a single property. If no is specified - then all properties will be dumped as a list of key value pairs. - - - Nicko Cadell - - - - Write the property value to the output - - that will receive the formatted result. - null, state is not set - - - Writes out the value of a named property. The property name - should be set in the - property. - - - If the is set to null - then all the properties are written as key value pairs. - - - - - - A Pattern converter that generates a string of random characters - - - - The converter generates a string of random characters. By default - the string is length 4. This can be changed by setting the - to the string value of the length required. - - - The random characters in the string are limited to uppercase letters - and numbers only. - - - The random number generator used by this class is not cryptographically secure. - - - Nicko Cadell - - - - Shared random number generator - - - - - Length of random string to generate. Default length 4. - - - - - Initialize the converter options - - - - This is part of the delayed object - activation scheme. The method must - be called on this object after the configuration properties have - been set. Until is called this - object is in an undefined state and must not be used. - - - If any of the configuration properties are modified then - must be called again. - - - - - - Write a randoim string to the output - - the writer to write to - null, state is not set - - - Write a randoim string to the output . - - - - - - The fully qualified type of the RandomStringPatternConverter class. - - - Used by the internal logger to record the Type of the - log message. - - - - - Write the current threads username to the output - - - - Write the current threads username to the output writer - - - Nicko Cadell - - - - Write the current threads username to the output - - the writer to write to - null, state is not set - - - Write the current threads username to the output . - - - - - - The fully qualified type of the UserNamePatternConverter class. - - - Used by the internal logger to record the Type of the - log message. - - - - - Write the UTC date time to the output - - - - Date pattern converter, uses a to format - the current date and time in Universal time. - - - See the for details on the date pattern syntax. - - - - Nicko Cadell - - - - Write the current date and time to the output - - that will receive the formatted result. - null, state is not set - - - Pass the current date and time to the - for it to render it to the writer. - - - The date is in Universal time when it is rendered. - - - - - - - The fully qualified type of the UtcDatePatternConverter class. - - - Used by the internal logger to record the Type of the - log message. - - - - - String keyed object map. - - - - While this collection is serializable only member - objects that are serializable will - be serialized along with this collection. - - - Nicko Cadell - Gert Driesen - - - - Constructor - - - - Initializes a new instance of the class. - - - - - - Constructor - - properties to copy - - - Initializes a new instance of the class. - - - - - - Initializes a new instance of the class - with serialized data. - - The that holds the serialized object data. - The that contains contextual information about the source or destination. - - - Because this class is sealed the serialization constructor is private. - - - - - - Gets or sets the value of the property with the specified key. - - - The value of the property with the specified key. - - The key of the property to get or set. - - - 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. - - - - - - Remove the entry with the specified key from this dictionary - - the key for the entry to remove - - - Remove the entry with the specified key from this dictionary - - - - - - See - - an enumerator - - - Returns a over the contest of this collection. - - - - - - See - - the key to remove - - - Remove the entry with the specified key from this dictionary - - - - - - See - - the key to lookup in the collection - true if the collection contains the specified key - - - Test if this collection contains a specified key. - - - - - - Remove all properties from the properties collection - - - - Remove all properties from the properties collection - - - - - - See - - the key - the value to store for the key - - - Store a value for the specified . - - - Thrown if the is not a string - - - - See - - - false - - - - This collection is modifiable. This property always - returns false. - - - - - - See - - - The value for the key specified. - - - - Get or set a value for the specified . - - - Thrown if the is not a string - - - - See - - - - - See - - - - - See - - - - - See - - - - - - - See - - - - - See - - - - - See - - - - - A class to hold the key and data for a property set in the config file - - - - A class to hold the key and data for a property set in the config file - - - - - - Property Key - - - Property Key - - - - Property Key. - - - - - - Property Value - - - Property Value - - - - Property Value. - - - - - - Override Object.ToString to return sensible debug info - - string info about this object - - - - A that ignores the message - - - - This writer is used in special cases where it is necessary - to protect a writer from being closed by a client. - - - Nicko Cadell - - - - Constructor - - the writer to actually write to - - - Create a new ProtectCloseTextWriter using a writer - - - - - - Attach this instance to a different underlying - - the writer to attach to - - - Attach this instance to a different underlying - - - - - - Does not close the underlying output writer. - - - - Does not close the underlying output writer. - This method does nothing. - - - - - - that does not leak exceptions - - - - does not throw exceptions when things go wrong. - Instead, it delegates error handling to its . - - - Nicko Cadell - Gert Driesen - - - - Constructor - - the writer to actually write to - the error handler to report error to - - - Create a new QuietTextWriter using a writer and error handler - - - - - - Gets or sets the error handler that all errors are passed to. - - - The error handler that all errors are passed to. - - - - Gets or sets the error handler that all errors are passed to. - - - - - - Gets a value indicating whether this writer is closed. - - - true if this writer is closed, otherwise false. - - - - Gets a value indicating whether this writer is closed. - - - - - - Writes a character to the underlying writer - - the char to write - - - Writes a character to the underlying writer - - - - - - Writes a buffer to the underlying writer - - the buffer to write - the start index to write from - the number of characters to write - - - Writes a buffer to the underlying writer - - - - - - Writes a string to the output. - - The string data to write to the output. - - - Writes a string to the output. - - - - - - Closes the underlying output writer. - - - - Closes the underlying output writer. - - - - - - The error handler instance to pass all errors to - - - - - Flag to indicate if this writer is closed - - - - - Defines a lock that supports single writers and multiple readers - - - - ReaderWriterLock 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 - ReaderWriterLock provides better throughput than a simple - one-at-a-time lock, such as . - - - If a platform does not support a System.Threading.ReaderWriterLock - implementation then all readers and writers are serialized. Therefore - the caller must not rely on multiple simultaneous readers. - - - Nicko Cadell - - - - Constructor - - - - Initializes a new instance of the class. - - - - - - Acquires a reader lock - - - - blocks if a different thread has the writer - lock, or if at least one thread is waiting for the writer lock. - - - - - - Decrements the lock count - - - - decrements the lock count. When the count - reaches zero, the lock is released. - - - - - - Acquires the writer lock - - - - This method blocks if another thread has a reader lock or writer lock. - - - - - - Decrements the lock count on the writer lock - - - - ReleaseWriterLock decrements the writer lock count. - When the count reaches zero, the writer lock is released. - - - - - - String keyed object map that is read only. - - - - This collection is readonly and cannot be modified. - - - While this collection is serializable only member - objects that are serializable will - be serialized along with this collection. - - - Nicko Cadell - Gert Driesen - - - - The Hashtable used to store the properties data - - - - - Constructor - - - - Initializes a new instance of the class. - - - - - - Copy Constructor - - properties to copy - - - Initializes a new instance of the class. - - - - - - Deserialization constructor - - The that holds the serialized object data. - The that contains contextual information about the source or destination. - - - Initializes a new instance of the class - with serialized data. - - - - - - Gets the key names. - - An array of all the keys. - - - Gets the key names. - - - - - - Gets or sets the value of the property with the specified key. - - - The value of the property with the specified key. - - The key of the property to get or set. - - - 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. - - - - - - Test if the dictionary contains a specified key - - the key to look for - true if the dictionary contains the specified key - - - Test if the dictionary contains a specified key - - - - - - The hashtable used to store the properties - - - The internal collection used to store the properties - - - - The hashtable used to store the properties - - - - - - Serializes this object into the provided. - - The to populate with data. - The destination for this serialization. - - - Serializes this object into the provided. - - - - - - See - - - - - See - - - - - - See - - - - - - - Remove all properties from the properties collection - - - - - See - - - - - - - See - - - - - See - - - - - See - - - - - See - - - - - See - - - - - See - - - - - - - See - - - - - The number of properties in this collection - - - - - See - - - - - See - - - - - A that can be and reused - - - - A that can be and reused. - This uses a single buffer for string operations. - - - Nicko Cadell - - - - Create an instance of - - the format provider to use - - - Create an instance of - - - - - - Override Dispose to prevent closing of writer - - flag - - - Override Dispose to prevent closing of writer - - - - - - Reset this string writer so that it can be reused. - - the maximum buffer capacity before it is trimmed - the default size to make the buffer - - - Reset this string writer so that it can be reused. - The internal buffers are cleared and reset. - - - - - - Utility class for system specific information. - - - - Utility class of static methods for system specific information. - - - Nicko Cadell - Gert Driesen - Alexey Solofnenko - - - - Private constructor to prevent instances. - - - - Only static methods are exposed from this type. - - - - - - Initialize default values for private static fields. - - - - Only static methods are exposed from this type. - - - - - - Gets the system dependent line terminator. - - - The system dependent line terminator. - - - - Gets the system dependent line terminator. - - - - - - Gets the base directory for this . - - The base directory path for the current . - - - Gets the base directory for this . - - - The value returned may be either a local file path or a URI. - - - - - - Gets the path to the configuration file for the current . - - The path to the configuration file for the current . - - - 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. - - - The value returned may be either a local file path or a URI. - - - - - - Gets the path to the file that first executed in the current . - - The path to the entry assembly. - - - Gets the path to the file that first executed in the current . - - - - - - Gets the ID of the current thread. - - The ID of the current thread. - - - On the .NET framework, the AppDomain.GetCurrentThreadId method - is used to obtain the thread ID for the current thread. This is the - operating system ID for the thread. - - - 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 - GetCurrentThreadId is implemented inline in a header file - and cannot be called. - - - On the .NET Framework 2.0 the Thread.ManagedThreadId is used as this - gives a stable id unrelated to the operating system thread ID which may - change if the runtime is using fibers. - - - - - - Get the host name or machine name for the current machine - - - The hostname or machine name - - - - Get the host name or machine name for the current machine - - - The host name () or - the machine name (Environment.MachineName) for - the current machine, or if neither of these are available - then NOT AVAILABLE is returned. - - - - - - Get this application's friendly name - - - The friendly name of this application as a string - - - - If available the name of the application is retrieved from - the AppDomain using AppDomain.CurrentDomain.FriendlyName. - - - Otherwise the file name of the entry assembly is used. - - - - - - Get the start time for the current process. - - - - This is the time at which the log4net library was loaded into the - AppDomain. Due to reports of a hang in the call to System.Diagnostics.Process.StartTime - this is not the start time for the current process. - - - 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. - - - 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. - - - - - - Get the UTC start time for the current process. - - - - This is the UTC time at which the log4net library was loaded into the - AppDomain. Due to reports of a hang in the call to System.Diagnostics.Process.StartTime - this is not the start time for the current process. - - - 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. - - - 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. - - - - - - Text to output when a null is encountered. - - - - Use this value to indicate a null has been encountered while - outputting a string representation of an item. - - - The default value is (null). This value can be overridden by specifying - a value for the log4net.NullText appSetting in the application's - .config file. - - - - - - Text to output when an unsupported feature is requested. - - - - Use this value when an unsupported feature is requested. - - - The default value is NOT AVAILABLE. This value can be overridden by specifying - a value for the log4net.NotAvailableText appSetting in the application's - .config file. - - - - - - Gets the assembly location path for the specified assembly. - - The assembly to get the location for. - The location of the assembly. - - - 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. - - - - - - Gets the fully qualified name of the , including - the name of the assembly from which the was - loaded. - - The to get the fully qualified name for. - The fully qualified name for the . - - - This is equivalent to the Type.AssemblyQualifiedName property, - but this method works on the .NET Compact Framework 1.0 as well as - the full .NET runtime. - - - - - - Gets the short name of the . - - The to get the name for. - The short name of the . - - - The short name of the assembly is the - without the version, culture, or public key. i.e. it is just the - assembly's file name without the extension. - - - Use this rather than Assembly.GetName().Name because that - is not available on the Compact Framework. - - - Because of a FileIOPermission security demand we cannot do - the obvious Assembly.GetName().Name. We are allowed to get - the of the assembly so we - start from there and strip out just the assembly name. - - - - - - Gets the file name portion of the , including the extension. - - The to get the file name for. - The file name of the assembly. - - - Gets the file name portion of the , including the extension. - - - - - - Loads the type specified in the type string. - - A sibling type to use to load the type. - The name of the type to load. - Flag set to true to throw an exception if the type cannot be loaded. - true to ignore the case of the type name; otherwise, false - The type loaded or null if it could not be loaded. - - - 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 - . - - - 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. - - - - - - Loads the type specified in the type string. - - The name of the type to load. - Flag set to true to throw an exception if the type cannot be loaded. - true to ignore the case of the type name; otherwise, false - The type loaded or null if it could not be loaded. - - - 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 - . - - - 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. - - - - - - Loads the type specified in the type string. - - An assembly to load the type from. - The name of the type to load. - Flag set to true to throw an exception if the type cannot be loaded. - true to ignore the case of the type name; otherwise, false - The type loaded or null if it could not be loaded. - - - 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 - . - - - 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. - - - - - - Generate a new guid - - A new Guid - - - Generate a new guid - - - - - - Create an - - The name of the parameter that caused the exception - The value of the argument that causes this exception - The message that describes the error - the ArgumentOutOfRangeException object - - - Create a new instance of the class - with a specified error message, the parameter name, and the value - of the argument. - - - The Compact Framework does not support the 3 parameter constructor for the - type. This method provides an - implementation that works for all platforms. - - - - - - Parse a string into an value - - the string to parse - out param where the parsed value is placed - true if the string was able to be parsed into an integer - - - Attempts to parse the string into an integer. If the string cannot - be parsed then this method returns false. The method does not throw an exception. - - - - - - Parse a string into an value - - the string to parse - out param where the parsed value is placed - true if the string was able to be parsed into an integer - - - Attempts to parse the string into an integer. If the string cannot - be parsed then this method returns false. The method does not throw an exception. - - - - - - Parse a string into an value - - the string to parse - out param where the parsed value is placed - true if the string was able to be parsed into an integer - - - Attempts to parse the string into an integer. If the string cannot - be parsed then this method returns false. The method does not throw an exception. - - - - - - Lookup an application setting - - the application settings key to lookup - the value for the key, or null - - - Configuration APIs are not supported under the Compact Framework - - - - - - Convert a path into a fully qualified local file path. - - The path to convert. - The fully qualified path. - - - Converts the path specified to a fully - qualified path. If the path is relative it is - taken as relative from the application base - directory. - - - The path specified must be a local file path, a URI is not supported. - - - - - - Creates a new case-insensitive instance of the class with the default initial capacity. - - A new case-insensitive instance of the class with the default initial capacity - - - The new Hashtable instance uses the default load factor, the CaseInsensitiveHashCodeProvider, and the CaseInsensitiveComparer. - - - - - - Tests two strings for equality, the ignoring case. - - - If the platform permits, culture information is ignored completely (ordinal comparison). - The aim of this method is to provide a fast comparison that deals with null and ignores different casing. - It is not supposed to deal with various, culture-specific habits. - Use it to compare against pure ASCII constants, like keywords etc. - - The one string. - The other string. - true if the strings are equal, false otherwise. - - - - Gets an empty array of types. - - - - The Type.EmptyTypes field is not available on - the .NET Compact Framework 1.0. - - - - - - The fully qualified type of the SystemInfo class. - - - Used by the internal logger to record the Type of the - log message. - - - - - Cache the host name for the current machine - - - - - Cache the application friendly name - - - - - Text to output when a null is encountered. - - - - - Text to output when an unsupported feature is requested. - - - - - Start time for the current process. - - - - - Utility class that represents a format string. - - - - Utility class that represents a format string. - - - Nicko Cadell - - - - Format - - - - - Args - - - - - Initialise the - - An that supplies culture-specific formatting information. - A containing zero or more format items. - An array containing zero or more objects to format. - - - - Format the string and arguments - - the formatted string - - - - Replaces the format item in a specified with the text equivalent - of the value of a corresponding instance in a specified array. - A specified parameter supplies culture-specific formatting information. - - An that supplies culture-specific formatting information. - A containing zero or more format items. - An array containing zero or more objects to format. - - A copy of format in which the format items have been replaced by the - equivalent of the corresponding instances of in args. - - - - This method does not throw exceptions. If an exception thrown while formatting the result the - exception and arguments are returned in the result string. - - - - - - Process an error during StringFormat - - - - - Dump the contents of an array into a string builder - - - - - Dump an object to a string - - - - - The fully qualified type of the SystemStringFormat class. - - - Used by the internal logger to record the Type of the - log message. - - - - - Adapter that extends and forwards all - messages to an instance of . - - - - Adapter that extends and forwards all - messages to an instance of . - - - Nicko Cadell - - - - The writer to forward messages to - - - - - Create an instance of that forwards all - messages to a . - - The to forward to - - - Create an instance of that forwards all - messages to a . - - - - - - Gets or sets the underlying . - - - The underlying . - - - - Gets or sets the underlying . - - - - - - The Encoding in which the output is written - - - The - - - - The Encoding in which the output is written - - - - - - Gets an object that controls formatting - - - The format provider - - - - Gets an object that controls formatting - - - - - - Gets or sets the line terminator string used by the TextWriter - - - The line terminator to use - - - - Gets or sets the line terminator string used by the TextWriter - - - - - - Closes the writer and releases any system resources associated with the writer - - - - - - - - - Dispose this writer - - flag indicating if we are being disposed - - - Dispose this writer - - - - - - Flushes any buffered output - - - - Clears all buffers for the writer and causes any buffered data to be written - to the underlying device - - - - - - Writes a character to the wrapped TextWriter - - the value to write to the TextWriter - - - Writes a character to the wrapped TextWriter - - - - - - Writes a character buffer to the wrapped TextWriter - - the data buffer - the start index - the number of characters to write - - - Writes a character buffer to the wrapped TextWriter - - - - - - Writes a string to the wrapped TextWriter - - the value to write to the TextWriter - - - Writes a string to the wrapped TextWriter - - - - - - Implementation of Properties collection for the - - - - Class implements a collection of properties that is specific to each thread. - The class is not synchronized as each thread has its own . - - - Nicko Cadell - - - - Each thread will automatically have its instance. - - - - - Internal constructor - - - - Initializes a new instance of the class. - - - - - - Gets or sets the value of a property - - - The value for the property with the specified key - - - - Gets or sets the value of a property - - - - - - Remove a property - - the key for the entry to remove - - - Remove a property - - - - - - Get the keys stored in the properties. - - - Gets the keys stored in the properties. - - a set of the defined keys - - - - Clear all properties - - - - Clear all properties - - - - - - Get the PropertiesDictionary for this thread. - - create the dictionary if it does not exist, otherwise return null if does not exist - the properties for this thread - - - 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. - - - - - - Implementation of Stack for the - - - - Implementation of Stack for the - - - Nicko Cadell - - - - The stack store. - - - - - Internal constructor - - - - Initializes a new instance of the class. - - - - - - The number of messages in the stack - - - The current number of messages in the stack - - - - The current number of messages in the stack. That is - the number of times has been called - minus the number of times has been called. - - - - - - Clears all the contextual information held in this stack. - - - - 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 method of the - returned from even in exceptional circumstances, - for example by using the using(log4net.ThreadContext.Stacks["NDC"].Push("Stack_Message")) - syntax. - - - - - - Removes the top context from this stack. - - The message in the context that was removed from the top of this stack. - - - Remove the top context from this stack, and return - it to the caller. If this stack is empty then an - empty string (not ) is returned. - - - - - - Pushes a new context message into this stack. - - The new context message. - - An that can be used to clean up the context stack. - - - - Pushes a new context onto this stack. An - is returned that can be used to clean up this stack. This - can be easily combined with the using keyword to scope the - context. - - - Simple example of using the Push method with the using keyword. - - using(log4net.ThreadContext.Stacks["NDC"].Push("Stack_Message")) - { - log.Warn("This should have an ThreadContext Stack message"); - } - - - - - - Gets the current context information for this stack. - - The current context information. - - - - Gets and sets the internal stack used by this - - The internal storage stack - - - This property is provided only to support backward compatability - of the . Tytpically the internal stack should not - be modified. - - - - - - Gets the current context information for this stack. - - Gets the current context information - - - Gets the current context information for this stack. - - - - - - Get a portable version of this object - - the portable instance of this object - - - Get a cross thread portable version of this object - - - - - - Inner class used to represent a single context frame in the stack. - - - - Inner class used to represent a single context frame in the stack. - - - - - - Constructor - - The message for this context. - The parent context in the chain. - - - Initializes a new instance of the class - with the specified message and parent context. - - - - - - Get the message. - - The message. - - - Get the message. - - - - - - Gets the full text of the context down to the root level. - - - The full text of the context down to the root level. - - - - Gets the full text of the context down to the root level. - - - - - - Struct returned from the method. - - - - This struct implements the and is designed to be used - with the pattern to remove the stack frame at the end of the scope. - - - - - - The ThreadContextStack internal stack - - - - - The depth to trim the stack to when this instance is disposed - - - - - Constructor - - The internal stack used by the ThreadContextStack. - The depth to return the stack to when this object is disposed. - - - Initializes a new instance of the class with - the specified stack and return depth. - - - - - - Returns the stack to the correct depth. - - - - Returns the stack to the correct depth. - - - - - - Implementation of Stacks collection for the - - - - Implementation of Stacks collection for the - - - Nicko Cadell - - - - Internal constructor - - - - Initializes a new instance of the class. - - - - - - Gets the named thread context stack - - - The named stack - - - - Gets the named thread context stack - - - - - - The fully qualified type of the ThreadContextStacks class. - - - Used by the internal logger to record the Type of the - log message. - - - - - Utility class for transforming strings. - - - - Utility class for transforming strings. - - - Nicko Cadell - Gert Driesen - - - - Initializes a new instance of the class. - - - - Uses a private access modifier to prevent instantiation of this class. - - - - - - Write a string to an - - the writer to write to - the string to write - The string to replace non XML compliant chars with - - - The test is escaped either using XML escape entities - or using CDATA sections. - - - - - - Replace invalid XML characters in text string - - the XML text input string - the string to use in place of invalid characters - A string that does not contain invalid XML characters. - - - Certain Unicode code points are not allowed in the XML InfoSet, for - details see: http://www.w3.org/TR/REC-xml/#charsets. - - - This method replaces any illegal characters in the input string - with the mask string specified. - - - - - - Count the number of times that the substring occurs in the text - - the text to search - the substring to find - the number of times the substring occurs in the text - - - The substring is assumed to be non repeating within itself. - - - - - - Characters illegal in XML 1.0 - - - - - Type converter for Boolean. - - - - Supports conversion from string to bool type. - - - - - - Nicko Cadell - Gert Driesen - - - - Can the source type be converted to the type supported by this object - - the type to convert - true if the conversion is possible - - - Returns true if the is - the type. - - - - - - Convert the source object to the type supported by this object - - the object to convert - the converted object - - - Uses the method to convert the - argument to a . - - - - The object cannot be converted to the - target type. To check for this condition use the - method. - - - - - Exception base type for conversion errors. - - - - This type extends . It - does not add any new functionality but does differentiate the - type of exception being thrown. - - - Nicko Cadell - Gert Driesen - - - - Constructor - - - - Initializes a new instance of the class. - - - - - - Constructor - - A message to include with the exception. - - - Initializes a new instance of the class - with the specified message. - - - - - - Constructor - - A message to include with the exception. - A nested exception to include. - - - Initializes a new instance of the class - with the specified message and inner exception. - - - - - - Serialization constructor - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - - - Initializes a new instance of the class - with serialized data. - - - - - - Creates a new instance of the class. - - The conversion destination type. - The value to convert. - An instance of the . - - - Creates a new instance of the class. - - - - - - Creates a new instance of the class. - - The conversion destination type. - The value to convert. - A nested exception to include. - An instance of the . - - - Creates a new instance of the class. - - - - - - Register of type converters for specific types. - - - - Maintains a registry of type converters used to convert between - types. - - - Use the and - methods to register new converters. - The and methods - lookup appropriate converters to use. - - - - - Nicko Cadell - Gert Driesen - - - - Private constructor - - - Initializes a new instance of the class. - - - - - Static constructor. - - - - This constructor defines the intrinsic type converters. - - - - - - Adds a converter for a specific type. - - The type being converted to. - The type converter to use to convert to the destination type. - - - Adds a converter instance for a specific type. - - - - - - Adds a converter for a specific type. - - The type being converted to. - The type of the type converter to use to convert to the destination type. - - - Adds a converter for a specific type. - - - - - - Gets the type converter to use to convert values to the destination type. - - The type being converted from. - The type being converted to. - - The type converter instance to use for type conversions or null - if no type converter is found. - - - - Gets the type converter to use to convert values to the destination type. - - - - - - Gets the type converter to use to convert values to the destination type. - - The type being converted to. - - The type converter instance to use for type conversions or null - if no type converter is found. - - - - Gets the type converter to use to convert values to the destination type. - - - - - - Lookups the type converter to use as specified by the attributes on the - destination type. - - The type being converted to. - - The type converter instance to use for type conversions or null - if no type converter is found. - - - - - Creates the instance of the type converter. - - The type of the type converter. - - The type converter instance to use for type conversions or null - if no type converter is found. - - - - The type specified for the type converter must implement - the or interfaces - and must have a public default (no argument) constructor. - - - - - - The fully qualified type of the ConverterRegistry class. - - - Used by the internal logger to record the Type of the - log message. - - - - - Mapping from to type converter. - - - - - Supports conversion from string to type. - - - - Supports conversion from string to type. - - - - - - Nicko Cadell - Gert Driesen - - - - Can the source type be converted to the type supported by this object - - the type to convert - true if the conversion is possible - - - Returns true if the is - the type. - - - - - - Overrides the ConvertFrom method of IConvertFrom. - - the object to convert to an encoding - the encoding - - - Uses the method to - convert the argument to an . - - - - The object cannot be converted to the - target type. To check for this condition use the - method. - - - - - Interface supported by type converters - - - - This interface supports conversion from arbitrary types - to a single target type. See . - - - Nicko Cadell - Gert Driesen - - - - Can the source type be converted to the type supported by this object - - the type to convert - true if the conversion is possible - - - Test if the can be converted to the - type supported by this converter. - - - - - - Convert the source object to the type supported by this object - - the object to convert - the converted object - - - Converts the to the type supported - by this converter. - - - - - - Interface supported by type converters - - - - This interface supports conversion from a single type to arbitrary types. - See . - - - Nicko Cadell - - - - Returns whether this converter can convert the object to the specified type - - A Type that represents the type you want to convert to - true if the conversion is possible - - - Test if the type supported by this converter can be converted to the - . - - - - - - Converts the given value object to the specified type, using the arguments - - the object to convert - The Type to convert the value parameter to - the converted object - - - Converts the (which must be of the type supported - by this converter) to the specified.. - - - - - - Supports conversion from string to type. - - - - Supports conversion from string to type. - - - - - Nicko Cadell - - - - Can the source type be converted to the type supported by this object - - the type to convert - true if the conversion is possible - - - Returns true if the is - the type. - - - - - - Overrides the ConvertFrom method of IConvertFrom. - - the object to convert to an IPAddress - the IPAddress - - - Uses the method to convert the - argument to an . - If that fails then the string is resolved as a DNS hostname. - - - - The object cannot be converted to the - target type. To check for this condition use the - method. - - - - - Valid characters in an IPv4 or IPv6 address string. (Does not support subnets) - - - - - Supports conversion from string to type. - - - - Supports conversion from string to type. - - - The string is used as the - of the . - - - - - - Nicko Cadell - - - - Can the source type be converted to the type supported by this object - - the type to convert - true if the conversion is possible - - - Returns true if the is - the type. - - - - - - Overrides the ConvertFrom method of IConvertFrom. - - the object to convert to a PatternLayout - the PatternLayout - - - Creates and returns a new using - the as the - . - - - - The object cannot be converted to the - target type. To check for this condition use the - method. - - - - - Convert between string and - - - - Supports conversion from string to type, - and from a type to a string. - - - The string is used as the - of the . - - - - - - Nicko Cadell - - - - Can the target type be converted to the type supported by this object - - A that represents the type you want to convert to - true if the conversion is possible - - - Returns true if the is - assignable from a type. - - - - - - Converts the given value object to the specified type, using the arguments - - the object to convert - The Type to convert the value parameter to - the converted object - - - Uses the method to convert the - argument to a . - - - - The object cannot be converted to the - . To check for this condition use the - method. - - - - - Can the source type be converted to the type supported by this object - - the type to convert - true if the conversion is possible - - - Returns true if the is - the type. - - - - - - Overrides the ConvertFrom method of IConvertFrom. - - the object to convert to a PatternString - the PatternString - - - Creates and returns a new using - the as the - . - - - - The object cannot be converted to the - target type. To check for this condition use the - method. - - - - - Supports conversion from string to type. - - - - Supports conversion from string to type. - - - - - - Nicko Cadell - - - - Can the source type be converted to the type supported by this object - - the type to convert - true if the conversion is possible - - - Returns true if the is - the type. - - - - - - Overrides the ConvertFrom method of IConvertFrom. - - the object to convert to a Type - the Type - - - Uses the method to convert the - argument to a . - Additional effort is made to locate partially specified types - by searching the loaded assemblies. - - - - The object cannot be converted to the - target type. To check for this condition use the - method. - - - - - Attribute used to associate a type converter - - - - Class and Interface level attribute that specifies a type converter - to use with the associated type. - - - To associate a type converter with a target type apply a - TypeConverterAttribute to the target type. Specify the - type of the type converter on the attribute. - - - Nicko Cadell - Gert Driesen - - - - The string type name of the type converter - - - - - Default constructor - - - - Default constructor - - - - - - Create a new type converter attribute for the specified type name - - The string type name of the type converter - - - The type specified must implement the - or the interfaces. - - - - - - Create a new type converter attribute for the specified type - - The type of the type converter - - - The type specified must implement the - or the interfaces. - - - - - - The string type name of the type converter - - - The string type name of the type converter - - - - The type specified must implement the - or the interfaces. - - - - - - Impersonate a Windows Account - - - - This impersonates a Windows account. - - - How the impersonation is done depends on the value of . - 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. - - - - - - The impersonation modes for the - - - - See the property for - details. - - - - - - Impersonate a user using the credentials supplied - - - - - Revert this the thread to the credentials of the process - - - - - Default constructor - - - - Default constructor - - - - - - Gets or sets the impersonation mode for this security context - - - The impersonation mode for this security context - - - - Impersonate either a user with user credentials or - revert this thread to the credentials of the process. - The value is one of the - enum. - - - The default value is - - - When the mode is set to - the user's credentials are established using the - , and - values. - - - When the mode is set to - no other properties need to be set. If the calling thread is - impersonating then it will be reverted back to the process credentials. - - - - - - Gets or sets the Windows username for this security context - - - The Windows username for this security context - - - - This property must be set if - is set to (the default setting). - - - - - - Gets or sets the Windows domain name for this security context - - - The Windows domain name for this security context - - - - The default value for is the local machine name - taken from the property. - - - This property must be set if - is set to (the default setting). - - - - - - Sets the password for the Windows account specified by the and properties. - - - The password for the Windows account specified by the and properties. - - - - This property must be set if - is set to (the default setting). - - - - - - Initialize the SecurityContext based on the options set. - - - - This is part of the delayed object - activation scheme. The method must - be called on this object after the configuration properties have - been set. Until is called this - object is in an undefined state and must not be used. - - - If any of the configuration properties are modified then - must be called again. - - - The security context will try to Logon the specified user account and - capture a primary token for impersonation. - - - The required , - or properties were not specified. - - - - Impersonate the Windows account specified by the and properties. - - caller provided state - - An instance that will revoke the impersonation of this SecurityContext - - - - Depending on the property either - impersonate a user using credentials supplied or revert - to the process credentials. - - - - - - Create a given the userName, domainName and password. - - the user name - the domain name - the password - the for the account specified - - - Uses the Windows API call LogonUser to get a principal token for the account. This - token is used to initialize the WindowsIdentity. - - - - - - Adds to - - - - Helper class to expose the - through the interface. - - - - - - Constructor - - the impersonation context being wrapped - - - Constructor - - - - - - Revert the impersonation - - - - Revert the impersonation - - - - - diff --git a/Txgy.Controls/CalendarClock2row.xaml b/Txgy.Controls/CalendarClock2row.xaml index f7fa111..309f986 100644 --- a/Txgy.Controls/CalendarClock2row.xaml +++ b/Txgy.Controls/CalendarClock2row.xaml @@ -1,12 +1,13 @@ - + @@ -21,27 +22,30 @@ - diff --git a/Txgy.Controls/ColorMapBar.xaml b/Txgy.Controls/ColorMapBar.xaml index 633b54b..8776bf5 100644 --- a/Txgy.Controls/ColorMapBar.xaml +++ b/Txgy.Controls/ColorMapBar.xaml @@ -1,26 +1,31 @@ - + - + - + diff --git a/Txgy.EWS.Client.Assets/Styles/BaseResources.xaml b/Txgy.EWS.Client.Assets/Styles/BaseResources.xaml index 57814ae..23662c7 100644 --- a/Txgy.EWS.Client.Assets/Styles/BaseResources.xaml +++ b/Txgy.EWS.Client.Assets/Styles/BaseResources.xaml @@ -1,4 +1,3 @@ - + pack://application:,,,/Txgy.EWS.Client.Assets;component/Fonts/#iconfont \ No newline at end of file diff --git a/Txgy.EWS.Client.Assets/Styles/ButtonStyles.xaml b/Txgy.EWS.Client.Assets/Styles/ButtonStyles.xaml index 6d6407d..02764f0 100644 --- a/Txgy.EWS.Client.Assets/Styles/ButtonStyles.xaml +++ b/Txgy.EWS.Client.Assets/Styles/ButtonStyles.xaml @@ -1,5 +1,4 @@ - + - diff --git a/Txgy.EWS.Client.Common/BusinessConfig.cs b/Txgy.EWS.Client.Common/BusinessConfig.cs index 7899a78..4a70fc1 100644 --- a/Txgy.EWS.Client.Common/BusinessConfig.cs +++ b/Txgy.EWS.Client.Common/BusinessConfig.cs @@ -1,3 +1,5 @@ +using Newtonsoft.Json; +using System; using System.Collections.Generic; namespace Txgy.EWS.Client.Common @@ -39,8 +41,14 @@ namespace Txgy.EWS.Client.Common public bool IsDesign { get; set; } public bool IsRealtime { get; set; } public int RefreshInterval { get; set; } - public int EventShowTotalSeconds { get; set; } - public int LoadDataTimeLenMins { get; set; } + public double DataLookbackHours { get; set; } + + [JsonIgnore] + public int EventShowTotalSeconds => (int)Math.Round(DataLookbackHours * 3600.0); + + [JsonIgnore] + public int LoadDataTimeLenMins => (int)Math.Round(DataLookbackHours * 60.0); + public int DataCacheTimeLenMins { get; set; } } diff --git a/Txgy.EWS.Client.Common/BusinessConfigManager.cs b/Txgy.EWS.Client.Common/BusinessConfigManager.cs index 12445a6..5d1f76f 100644 --- a/Txgy.EWS.Client.Common/BusinessConfigManager.cs +++ b/Txgy.EWS.Client.Common/BusinessConfigManager.cs @@ -1,5 +1,6 @@ using Newtonsoft.Json; using Newtonsoft.Json.Linq; +using Newtonsoft.Json.Serialization; using System; using System.Collections.Generic; using System.IO; @@ -33,6 +34,7 @@ namespace Txgy.EWS.Client.Common var json = File.ReadAllText(ConfigPath); var config = JsonConvert.DeserializeObject(json); + NormalizeRuntimeSettings(config); Validate(config); return config; } @@ -48,6 +50,20 @@ namespace Txgy.EWS.Client.Common } } + public static BusinessConfig Save(BusinessConfig config) + { + lock (SyncRoot) + { + NormalizeRuntimeSettings(config); + Validate(config); + SaveConfig(config); + _current = Read(); + FreeSqlTencent.Reset(); + FreeSqlLocalSqLite.Reset(); + return _current; + } + } + public static string GetConnectionString(string name) { var connections = Current.Database.Connections; @@ -105,14 +121,25 @@ namespace Txgy.EWS.Client.Common } public static void UpdateRuntimeSettings(int loadDataTimeLenMins, int dataCacheTimeLenMins) + { + UpdateDataLookbackHours(loadDataTimeLenMins / 60.0); + } + + public static void UpdateDataLookbackHours(double dataLookbackHours) { lock (SyncRoot) { + if (dataLookbackHours <= 0) + { + throw new InvalidOperationException("runtime.dataLookbackHours must be greater than 0."); + } + var root = ReadRoot(); - root["runtime"]["loadDataTimeLenMins"] = loadDataTimeLenMins; - root["runtime"]["dataCacheTimeLenMins"] = dataCacheTimeLenMins; + root["runtime"]["dataLookbackHours"] = dataLookbackHours; + root["runtime"]["dataCacheTimeLenMins"] = (int)Math.Round(dataLookbackHours * 60.0); SaveRoot(root); _current = root.ToObject(); + NormalizeRuntimeSettings(_current); Validate(_current); } } @@ -127,6 +154,29 @@ namespace Txgy.EWS.Client.Common return JObject.Parse(File.ReadAllText(ConfigPath)); } + private static void SaveConfig(BusinessConfig config) + { + var serializer = JsonSerializer.Create(new JsonSerializerSettings + { + Formatting = Formatting.Indented, + StringEscapeHandling = StringEscapeHandling.EscapeNonAscii, + ContractResolver = new DefaultContractResolver + { + NamingStrategy = new CamelCaseNamingStrategy + { + ProcessDictionaryKeys = false + } + } + }); + string json; + using (var writer = new StringWriter()) + { + serializer.Serialize(writer, config); + json = writer.ToString(); + } + WriteJson(json); + } + private static void SaveRoot(JObject root) { var serializer = JsonSerializer.Create(new JsonSerializerSettings @@ -140,11 +190,31 @@ namespace Txgy.EWS.Client.Common serializer.Serialize(writer, root); json = writer.ToString(); } + WriteJson(json); + } + + private static void WriteJson(string json) + { + var directory = Path.GetDirectoryName(ConfigPath); + if (!Directory.Exists(directory)) + { + Directory.CreateDirectory(directory); + } var tempPath = ConfigPath + ".tmp"; - File.WriteAllText(tempPath, json); + File.WriteAllText(tempPath, json, System.Text.Encoding.UTF8); if (File.Exists(ConfigPath)) { - File.Delete(ConfigPath); + var backupPath = ConfigPath + ".bak"; + if (File.Exists(backupPath)) + { + File.Delete(backupPath); + } + File.Replace(tempPath, ConfigPath, backupPath, true); + if (File.Exists(backupPath)) + { + File.Delete(backupPath); + } + return; } File.Move(tempPath, ConfigPath); } @@ -174,8 +244,7 @@ namespace Txgy.EWS.Client.Common { "IsDesign", root["runtime"]?["isDesign"] }, { "IsRealtime", root["runtime"]?["isRealtime"] }, { "RefreshInterval", root["runtime"]?["refreshInterval"] }, - { "EventShowTotalSeconds", root["runtime"]?["eventShowTotalSeconds"] }, - { "LoadDataTimeLenMins", root["runtime"]?["loadDataTimeLenMins"] }, + { "DataLookbackHours", root["runtime"]?["dataLookbackHours"] }, { "DataCacheTimeLenMins", root["runtime"]?["dataCacheTimeLenMins"] }, { "RealtimeResultTable", root["database"]?["tables"]?["realtimeResultTable"] }, { "RealtimeWaveDataTable", root["database"]?["tables"]?["realtimeWaveDataTable"] }, @@ -244,6 +313,23 @@ namespace Txgy.EWS.Client.Common Require(config.Database?.Tables?.PostFocalmechanismTable, "database.tables.postFocalmechanismTable"); GetConnectionStringFromConfig(config, "TencetnMySQL"); GetConnectionStringFromConfig(config, "NasMySQL"); + DateTime.Parse(config.Report.DailyReportStartTime); + } + + private static void NormalizeRuntimeSettings(BusinessConfig config) + { + if (config?.Runtime == null) + { + return; + } + + var runtime = config.Runtime; + if (runtime.DataLookbackHours <= 0) + { + throw new InvalidOperationException("runtime.dataLookbackHours must be greater than 0."); + } + + runtime.DataCacheTimeLenMins = (int)Math.Round(runtime.DataLookbackHours * 60.0); } private static void Require(string value, string name) diff --git a/Txgy.EWS.Client.Common/GlobalConfig.cs b/Txgy.EWS.Client.Common/GlobalConfig.cs index c01ed89..68f3a13 100644 --- a/Txgy.EWS.Client.Common/GlobalConfig.cs +++ b/Txgy.EWS.Client.Common/GlobalConfig.cs @@ -82,15 +82,32 @@ namespace Txgy.EWS.Client.Common } private static int _loadDataTimeLenMins = 720; + private static double _dataLookbackHours = 12; + public static double DataLookbackHours + { + get { return _dataLookbackHours; } + set + { + if (value <= 0) + { + throw new InvalidOperationException("数据回看时长必须大于 0。"); + } + + _dataLookbackHours = value; + _loadDataTimeLenMins = (int)Math.Round(value * 60.0); + _dataCacheTimeLenMins = _loadDataTimeLenMins; + StaticPropertyChanged?.Invoke(null, new PropertyChangedEventArgs("DataLookbackHours")); + StaticPropertyChanged?.Invoke(null, new PropertyChangedEventArgs("LoadDataTimeLenMins")); + StaticPropertyChanged?.Invoke(null, new PropertyChangedEventArgs("DataCacheTimeLenMins")); + BusinessConfigManager.UpdateDataLookbackHours(value); + } + } //程序启动时,数据加载时间 public static int LoadDataTimeLenMins { get { return _loadDataTimeLenMins; } set { - _loadDataTimeLenMins = value; - StaticPropertyChanged?.Invoke(null, new PropertyChangedEventArgs("LoadDataTimeLenMins")); - BusinessConfigManager.UpdateRuntimeSettings(LoadDataTimeLenMins, DataCacheTimeLenMins); - + DataLookbackHours = value / 60.0; } } private static int _dataCacheTimeLenMins = 720; @@ -100,21 +117,59 @@ namespace Txgy.EWS.Client.Common { get { return _dataCacheTimeLenMins; } set { - _dataCacheTimeLenMins = value; - StaticPropertyChanged?.Invoke(null, new PropertyChangedEventArgs("DataCacheTimeLenMins")); - BusinessConfigManager.UpdateRuntimeSettings(LoadDataTimeLenMins, DataCacheTimeLenMins); + DataLookbackHours = value / 60.0; } } public static void InitializeRuntimeSettings(RuntimeSettings runtime) { IsDesign = runtime.IsDesign; + _dataLookbackHours = runtime.DataLookbackHours; _loadDataTimeLenMins = runtime.LoadDataTimeLenMins; _dataCacheTimeLenMins = runtime.DataCacheTimeLenMins; + StaticPropertyChanged?.Invoke(null, new PropertyChangedEventArgs("DataLookbackHours")); StaticPropertyChanged?.Invoke(null, new PropertyChangedEventArgs("LoadDataTimeLenMins")); StaticPropertyChanged?.Invoke(null, new PropertyChangedEventArgs("DataCacheTimeLenMins")); } + public static void ApplyBusinessConfig(BusinessConfig config) + { + InitializeRuntimeSettings(config.Runtime); + SystemNameCN = config.Branding.SystemNameCn; + SystemNameEN = config.Branding.SystemNameEn; + CommpanyName = config.Branding.CommpanyName; + WorkAreaName = config.Branding.WorkAreaName; + SystemShortName = config.Branding.SystemShortName; + IsRealtime = config.Runtime.IsRealtime; + BaseX = config.Coordinates.BaseX; + BaseY = config.Coordinates.BaseY; + BaseZ = config.Coordinates.BaseZ; + DailyReportStartTime = DateTime.Parse(config.Report.DailyReportStartTime); + DailyReportPlanOffX = config.Report.DailyReportPlanOffsetX; + DailyReportPlanOffY = config.Report.DailyReportPlanOffsetY; + ApplyTableSettings(config); + } + + private static void ApplyTableSettings(BusinessConfig config) + { + if (IsRealtime) + { + UseResultTable = config.Database.Tables.RealtimeResultTable; + UseFocalMechanismTable = config.Database.Tables.RealtimeFocalmechanismTable; + UseWaveDataTable = config.Database.Tables.RealtimeWaveDataTable; + DataTypeString = "A"; + EventIDColName = "RTEventID"; + } + else + { + UseResultTable = config.Database.Tables.PostResultTable; + UseFocalMechanismTable = config.Database.Tables.PostFocalmechanismTable; + UseWaveDataTable = config.Database.Tables.PostWaveDataTable; + DataTypeString = "B"; + EventIDColName = "PostEventID"; + } + } + private static bool _isInitializing=false; public static bool IsInitializing { @@ -193,11 +248,7 @@ namespace Txgy.EWS.Client.Common public static void ReadConfig() { var config = BusinessConfigManager.Current; - GlobalConfig.SystemNameCN = config.Branding.SystemNameCn; - GlobalConfig.SystemNameEN = config.Branding.SystemNameEn; - GlobalConfig.CommpanyName = config.Branding.CommpanyName; - GlobalConfig.WorkAreaName = config.Branding.WorkAreaName; - GlobalConfig.SystemShortName = config.Branding.SystemShortName; + ApplyBusinessConfig(config); string jsonText; //读取工区配置文件 using (System.IO.StreamReader sr = new System.IO.StreamReader(AppDomain.CurrentDomain.BaseDirectory + @@ -246,23 +297,7 @@ namespace Txgy.EWS.Client.Common DailyReportPlanOffY = config.Report.DailyReportPlanOffsetY; //Console.WriteLine(DailyReportStartTime.ToString()); //设置实时监测数据配置文件 - IsRealtime = config.Runtime.IsRealtime; - if (IsRealtime) - { - UseResultTable = config.Database.Tables.RealtimeResultTable; - UseFocalMechanismTable = config.Database.Tables.RealtimeFocalmechanismTable; - UseWaveDataTable= config.Database.Tables.RealtimeWaveDataTable; - DataTypeString = "A"; - EventIDColName = "RTEventID"; - } - else - { - UseResultTable = config.Database.Tables.PostResultTable; - UseFocalMechanismTable = config.Database.Tables.PostFocalmechanismTable; - UseWaveDataTable = config.Database.Tables.PostWaveDataTable; - DataTypeString = "B"; - EventIDColName = "PostEventID"; - } + ApplyTableSettings(config); ProjectConfig.CadFileName = AppDomain.CurrentDomain.BaseDirectory + config.Paths.CadDwgFilePath; diff --git a/Txgy.EWS.Client.Common/Helpers/ReportPlanImage.cs b/Txgy.EWS.Client.Common/Helpers/ReportPlanImage.cs index e92ed37..d1c81e7 100644 --- a/Txgy.EWS.Client.Common/Helpers/ReportPlanImage.cs +++ b/Txgy.EWS.Client.Common/Helpers/ReportPlanImage.cs @@ -319,6 +319,11 @@ namespace Txgy.EWS.Client.Common.Helpers { foreach (GridItemEventResult item in events) { + if ((inTime - DateTime.Parse(item.EventTime)).TotalSeconds > EventShowTotalSeconds) + { + continue; + } + TaggedVisual visualE = new TaggedVisual(); using (DrawingContext dc = visualE.RenderOpen()) @@ -521,7 +526,7 @@ namespace Txgy.EWS.Client.Common.Helpers { foreach (var item in events) { - if ((DateTime.Parse(item.EventTime) - inTime).TotalSeconds < EventShowTotalSeconds) + if ((inTime - DateTime.Parse(item.EventTime)).TotalSeconds <= EventShowTotalSeconds) { float sizeFactor = (float)(((4f + item.ML) / (10f)) * 10f) + 0.1f; diff --git a/Txgy.EWS.Client.Common/MessageEvents/BusinessConfigChangedEvent.cs b/Txgy.EWS.Client.Common/MessageEvents/BusinessConfigChangedEvent.cs new file mode 100644 index 0000000..8a3d29a --- /dev/null +++ b/Txgy.EWS.Client.Common/MessageEvents/BusinessConfigChangedEvent.cs @@ -0,0 +1,8 @@ +using Prism.Events; + +namespace Txgy.EWS.Client.Common.MessageEvents +{ + public class BusinessConfigChangedEvent : PubSubEvent + { + } +} diff --git a/Txgy.EWS.Client.Common/MessageEvents/ClearWarningDataEvent.cs b/Txgy.EWS.Client.Common/MessageEvents/ClearWarningDataEvent.cs new file mode 100644 index 0000000..70ea56e --- /dev/null +++ b/Txgy.EWS.Client.Common/MessageEvents/ClearWarningDataEvent.cs @@ -0,0 +1,8 @@ +using Prism.Events; + +namespace Txgy.EWS.Client.Common.MessageEvents +{ + public class ClearWarningDataEvent : PubSubEvent + { + } +} diff --git a/Txgy.EWS.Client.Common/MessageEvents/ReloadWarningDataEvent.cs b/Txgy.EWS.Client.Common/MessageEvents/ReloadWarningDataEvent.cs new file mode 100644 index 0000000..c3462a7 --- /dev/null +++ b/Txgy.EWS.Client.Common/MessageEvents/ReloadWarningDataEvent.cs @@ -0,0 +1,8 @@ +using Prism.Events; + +namespace Txgy.EWS.Client.Common.MessageEvents +{ + public class ReloadWarningDataEvent : PubSubEvent + { + } +} diff --git a/Txgy.EWS.Client.Common/Txgy.EWS.Client.Common.csproj b/Txgy.EWS.Client.Common/Txgy.EWS.Client.Common.csproj index 88eef3f..6c89ab1 100644 --- a/Txgy.EWS.Client.Common/Txgy.EWS.Client.Common.csproj +++ b/Txgy.EWS.Client.Common/Txgy.EWS.Client.Common.csproj @@ -189,10 +189,13 @@ + + + diff --git a/Txgy.EWS.Client.FocalMechanism/bin/Debug/Aspose.Cells.dll b/Txgy.EWS.Client.FocalMechanism/bin/Debug/Aspose.Cells.dll deleted file mode 100644 index a34b4a0..0000000 Binary files a/Txgy.EWS.Client.FocalMechanism/bin/Debug/Aspose.Cells.dll and /dev/null differ diff --git a/Txgy.EWS.Client.FocalMechanism/bin/Debug/DotRas.dll b/Txgy.EWS.Client.FocalMechanism/bin/Debug/DotRas.dll deleted file mode 100644 index 3666b34..0000000 Binary files a/Txgy.EWS.Client.FocalMechanism/bin/Debug/DotRas.dll and /dev/null differ diff --git a/Txgy.EWS.Client.FocalMechanism/bin/Debug/FreeSql.dll b/Txgy.EWS.Client.FocalMechanism/bin/Debug/FreeSql.dll deleted file mode 100644 index b2785bc..0000000 Binary files a/Txgy.EWS.Client.FocalMechanism/bin/Debug/FreeSql.dll and /dev/null differ diff --git a/Txgy.EWS.Client.FocalMechanism/bin/Debug/Newtonsoft.Json.dll b/Txgy.EWS.Client.FocalMechanism/bin/Debug/Newtonsoft.Json.dll deleted file mode 100644 index 7af125a..0000000 Binary files a/Txgy.EWS.Client.FocalMechanism/bin/Debug/Newtonsoft.Json.dll and /dev/null differ diff --git a/Txgy.EWS.Client.FocalMechanism/bin/Debug/Prism.dll b/Txgy.EWS.Client.FocalMechanism/bin/Debug/Prism.dll deleted file mode 100644 index 7d5227d..0000000 Binary files a/Txgy.EWS.Client.FocalMechanism/bin/Debug/Prism.dll and /dev/null differ diff --git a/Txgy.EWS.Client.FocalMechanism/bin/Debug/zh-Hans/FreeSql.resources.dll b/Txgy.EWS.Client.FocalMechanism/bin/Debug/zh-Hans/FreeSql.resources.dll deleted file mode 100644 index 41ce3f8..0000000 Binary files a/Txgy.EWS.Client.FocalMechanism/bin/Debug/zh-Hans/FreeSql.resources.dll and /dev/null differ diff --git a/Txgy.EWS.Client.MainModule/ViewModels/TreeMenuViewModel.cs b/Txgy.EWS.Client.MainModule/ViewModels/TreeMenuViewModel.cs index 4f004b8..2a5b17d 100644 --- a/Txgy.EWS.Client.MainModule/ViewModels/TreeMenuViewModel.cs +++ b/Txgy.EWS.Client.MainModule/ViewModels/TreeMenuViewModel.cs @@ -14,6 +14,8 @@ namespace Txgy.EWS.Client.MainModule.ViewModels { public class TreeMenuViewModel : BindableBase { + private const string SystemSettingsTargetView = "SystemSettingsView"; + public List Menus { get; set; } = new List(); private List origMenus = null; @@ -29,6 +31,8 @@ namespace Txgy.EWS.Client.MainModule.ViewModels origMenus = GlobalData.CurrentUserInfo.Menus; this.FillMenus(Menus, 0); } + + AddLocalSystemSettingsMenu(); } ///递归 @@ -53,5 +57,44 @@ namespace Txgy.EWS.Client.MainModule.ViewModels } } } + + private void AddLocalSystemSettingsMenu() + { + if (ContainsTargetView(Menus, SystemSettingsTargetView)) + { + return; + } + + Menus.Add(new MenuItemModel(_regionManager) + { + MenuHeader = "系统设置", + MenuIcon = "\ue64c", + TargetView = SystemSettingsTargetView, + Children = new List() + }); + } + + private bool ContainsTargetView(IEnumerable menus, string targetView) + { + if (menus == null) + { + return false; + } + + foreach (var menu in menus) + { + if (string.Equals(menu.TargetView, targetView, StringComparison.OrdinalIgnoreCase)) + { + return true; + } + + if (ContainsTargetView(menu.Children, targetView)) + { + return true; + } + } + + return false; + } } } diff --git a/Txgy.EWS.Client.PageModule/ViewModels/EarlyWarningViewModel.cs b/Txgy.EWS.Client.PageModule/ViewModels/EarlyWarningViewModel.cs index a45ae2e..99c322d 100644 --- a/Txgy.EWS.Client.PageModule/ViewModels/EarlyWarningViewModel.cs +++ b/Txgy.EWS.Client.PageModule/ViewModels/EarlyWarningViewModel.cs @@ -655,6 +655,7 @@ namespace Txgy.EWS.Client.PageModule.ViewModels //ReceviedEvents = new ObservableCollection(); //AlarmEvents = new ObservableCollection(); }); + this._ea.GetEvent().Subscribe(ClearWarningData, ThreadOption.UIThread); //更新接收到的事件 this._ea.GetEvent().Subscribe(gier => { @@ -662,7 +663,7 @@ namespace Txgy.EWS.Client.PageModule.ViewModels { //从接收事件列表中删除超过指定时间范围的数据 var timeoutReceivedEvents = ReceviedEvents.Where(re => - (DateTime.Now - DateTime.Parse(re.EventTime)).TotalSeconds >= GlobalData.EventShowTimeout).ToArray(); + (DateTime.Now - DateTime.Parse(re.EventTime)).TotalHours >= GlobalConfig.DataLookbackHours).ToArray(); _dispatcher.Invoke(new System.Action(() => { if (timeoutReceivedEvents.Length > 0) @@ -690,7 +691,7 @@ namespace Txgy.EWS.Client.PageModule.ViewModels if (!GlobalConfig.IsDesign) { var timeoutAlarmEvents = AlarmEvents.Where(re => - (DateTime.Now - DateTime.Parse(re.EventTime)).TotalSeconds >= GlobalConfig.DataCacheTimeLenMins*60).ToArray(); + (DateTime.Now - DateTime.Parse(re.EventTime)).TotalHours >= GlobalConfig.DataLookbackHours).ToArray(); _dispatcher.Invoke(new System.Action(() => { if (timeoutAlarmEvents.Length > 0) @@ -713,6 +714,19 @@ namespace Txgy.EWS.Client.PageModule.ViewModels }); } + private void ClearWarningData() + { + AlarmEvents.Clear(); + ReceviedEvents.Clear(); + ListEnergy.Clear(); + ListML.Clear(); + ListDominantFreq.Clear(); + LastAlarmEventEnergy = 0; + LastAlarmEventML = 0; + LastAlarmEventDominFreq = 0; + EnergyMaxY = 2000; + } + private void ListEnergy_NoisyCollectionChanged(IEnumerable oldItems, IEnumerable newItems) { if (ListEnergy.Count > TableShowCount) diff --git a/Txgy.EWS.Client.PageModule/ViewModels/TitleViewModel.cs b/Txgy.EWS.Client.PageModule/ViewModels/TitleViewModel.cs index d8e5fe8..16069d4 100644 --- a/Txgy.EWS.Client.PageModule/ViewModels/TitleViewModel.cs +++ b/Txgy.EWS.Client.PageModule/ViewModels/TitleViewModel.cs @@ -37,6 +37,9 @@ namespace Txgy.EWS.Client.PageModule.ViewModels private readonly ILogHelper _logHelper; Dispatcher _dispatcher; private bool isCanRun = true; + private readonly object _reloadWarningDataSync = new object(); + private bool _isReloadingWarningData; + private bool _reloadWarningDataRequested; SoundPlayer alarmPlayer = new SoundPlayer(); @@ -176,41 +179,75 @@ namespace Txgy.EWS.Client.PageModule.ViewModels this._ea = ea; this._logHelper = logHelper; this.searchMsEventBLL = searchMsEventBLL; - var config = BusinessConfigManager.Current; - //AlarmThreshold = 1000; - using (System.IO.StreamReader sr = new System.IO.StreamReader(AppDomain.CurrentDomain.BaseDirectory + - config.Paths.AlarmSetting)) + LoadBusinessConfig(BusinessConfigManager.Current); + this._ea.GetEvent().Subscribe(LoadBusinessConfig, ThreadOption.UIThread); + this._ea.GetEvent().Subscribe(() => { - AlarmSetting = JsonConvert.DeserializeObject(sr.ReadToEnd()); + QueueReloadWarningData(); + }); + + ListAlramMusic = new List(); + string[] alarmTmpArray = Directory.GetFiles(AppDomain.CurrentDomain.BaseDirectory + "audio", "*.wav"); + for (int i = 0; i < alarmTmpArray.Length; i++) + { + ListAlramMusic.Add(Path.GetFileName(alarmTmpArray[i])); } - //AlarmThreshold = AlarmSettingConfig.AlarmThreshold; - //RefreshInterval = AlarmSetting.RefreshInterval; - RefreshInterval = config.Runtime.RefreshInterval; - CurAlarmMusic = AlarmSetting.AlarmSound; - ListAlarmLevel = new List(); - using (System.IO.StreamReader sr = new System.IO.StreamReader(AppDomain.CurrentDomain.BaseDirectory + - config.Paths.AlarmLevelConfig)) + QueueReloadWarningData(); + + // + } + + private void QueueReloadWarningData() + { + lock (_reloadWarningDataSync) { - ListAlarmLevel = JsonConvert.DeserializeObject>(sr.ReadToEnd()); + _reloadWarningDataRequested = true; + if (_isReloadingWarningData) + { + return; + } + + _isReloadingWarningData = true; } - CurAlarmLevel = ListAlarmLevel.First(la => la.Level == 1); - _dispatcher.Invoke(new System.Action(() => + + Task.Run(async () => await ProcessReloadWarningDataQueueAsync()); + } + + private async Task ProcessReloadWarningDataQueueAsync() + { + try { - GlobalData.CurAlarmLevelValue = CurAlarmLevel.Level; - GlobalData.CurAlarmLevelColor = new SolidColorBrush((Color)ColorConverter.ConvertFromString(CurAlarmLevel.ColorStr)); - })); + while (true) + { + lock (_reloadWarningDataSync) + { + if (!_reloadWarningDataRequested) + { + return; + } - ListAlramMusic = new List(); - string[] alarmTmpArray = Directory.GetFiles(AppDomain.CurrentDomain.BaseDirectory + "audio", "*.wav"); - for (int i = 0; i < alarmTmpArray.Length; i++) + _reloadWarningDataRequested = false; + } + + await ReloadWarningDataAsync(); + } + } + finally { - ListAlramMusic.Add(Path.GetFileName(alarmTmpArray[i])); + lock (_reloadWarningDataSync) + { + _isReloadingWarningData = false; + } } + } - GlobalConfig.IsInitializing = true; - //初始化检索数据库数据 - Task.Run(async () => { + private async Task ReloadWarningDataAsync() + { + try + { + GlobalConfig.IsInitializing = true; + GlobalConfig.InitializingCounter = 0; string dataFilePath = GlobalConfig.ProjectConfig.MseedFilePath + "\\"; GlobalData.ListAlarmEventId = new List(); @@ -218,22 +255,55 @@ namespace Txgy.EWS.Client.PageModule.ViewModels GlobalData.ReceivedEvents = new List(); GlobalData.LastEvent = new GridItemEventResult(); GlobalData.LastEvent.EventID = 0; - //预警平面参数 GlobalData.AlarmPlanList = new List(); GlobalData.MidEventList = new List(); + _ea.GetEvent().Publish(); DateTime timeNow = DateTime.Now; + var events = searchMsEventBLL.GetGridEvents(timeNow.AddHours(-GlobalConfig.DataLookbackHours), timeNow, -3, 0); + if (events == null || events.Count == 0) + { + GlobalConfig.InitializingCounter = 100; + return; + } - var events = searchMsEventBLL.GetGridEvents(timeNow.AddMinutes(-GlobalConfig.LoadDataTimeLenMins), timeNow, -3, 0); for (int i = 0; i < events.Count; i++) { await searchMsEventBLL.DownloadJsonDataAsync(events[i], dataFilePath, NotifyView); - GlobalConfig.InitializingCounter = ((i+1.0)/(double)events.Count)*100.0; - //await Console.Out.WriteLineAsync(GlobalConfig.InitializingCounter.ToString()); + GlobalConfig.InitializingCounter = ((i + 1.0) / (double)events.Count) * 100.0; } - }).ContinueWith(t => { GlobalConfig.IsInitializing = false; }); + } + catch (Exception ex) + { + _logHelper.Error(this, $"刷新预警信息数据失败:{ex.Message}"); + } + finally + { + GlobalConfig.IsInitializing = false; + } + } - // + private void LoadBusinessConfig(BusinessConfig config) + { + using (System.IO.StreamReader sr = new System.IO.StreamReader(AppDomain.CurrentDomain.BaseDirectory + + config.Paths.AlarmSetting)) + { + AlarmSetting = JsonConvert.DeserializeObject(sr.ReadToEnd()); + } + + RefreshInterval = config.Runtime.RefreshInterval; + CurAlarmMusic = AlarmSetting.AlarmSound; + using (System.IO.StreamReader sr = new System.IO.StreamReader(AppDomain.CurrentDomain.BaseDirectory + + config.Paths.AlarmLevelConfig)) + { + ListAlarmLevel = JsonConvert.DeserializeObject>(sr.ReadToEnd()); + } + CurAlarmLevel = ListAlarmLevel.First(la => la.Level == 1); + _dispatcher.Invoke(new System.Action(() => + { + GlobalData.CurAlarmLevelValue = CurAlarmLevel.Level; + GlobalData.CurAlarmLevelColor = new SolidColorBrush((Color)ColorConverter.ConvertFromString(CurAlarmLevel.ColorStr)); + })); } void StartMonitorning() @@ -454,7 +524,7 @@ namespace Txgy.EWS.Client.PageModule.ViewModels gier.DominantFreq = GlobalData.GetDominFreq(gier.EventTime); //从接收事件列表中删除超过指定时间范围的数据 - var timeoutReceivedEvents = GlobalData.ReceivedEvents.FindAll(re => (DateTime.Now - DateTime.Parse(re.EventTime)).TotalSeconds >= GlobalData.EventShowTimeout).ToArray(); + var timeoutReceivedEvents = GlobalData.ReceivedEvents.FindAll(re => (DateTime.Now - DateTime.Parse(re.EventTime)).TotalHours >= GlobalConfig.DataLookbackHours).ToArray(); if (timeoutReceivedEvents.Length > 0) { for (int i = timeoutReceivedEvents.Length - 1; i >= 0; i--) @@ -640,7 +710,7 @@ namespace Txgy.EWS.Client.PageModule.ViewModels if (!GlobalConfig.IsDesign) { //从预警事件列表中删除超过指定时间范围的数据 - var timeoutAlarmEvents = GlobalData.AlarmEvents.FindAll(re => (DateTime.Now - DateTime.Parse(re.EventTime)).TotalSeconds >= GlobalData.EventShowTimeout).ToArray(); + var timeoutAlarmEvents = GlobalData.AlarmEvents.FindAll(re => (DateTime.Now - DateTime.Parse(re.EventTime)).TotalHours >= GlobalConfig.DataLookbackHours).ToArray(); if (timeoutAlarmEvents.Length > 0) { for (int i = timeoutAlarmEvents.Length - 1; i >= 0; i--) diff --git a/Txgy.EWS.Client.PageModule/Views/EarlyWarningView.xaml b/Txgy.EWS.Client.PageModule/Views/EarlyWarningView.xaml index 9be5980..22b8d07 100644 --- a/Txgy.EWS.Client.PageModule/Views/EarlyWarningView.xaml +++ b/Txgy.EWS.Client.PageModule/Views/EarlyWarningView.xaml @@ -498,7 +498,7 @@ Header="所有事件列表" Style="{StaticResource MaterialDesignGroupBox}"> ().Subscribe(config => + { + EventShowTotalSeconds = config.Runtime.EventShowTotalSeconds; + RedrawReceivedEvents(); + }, ThreadOption.UIThread); + this._ea.GetEvent().Subscribe(RedrawReceivedEvents, ThreadOption.UIThread); _handleDataGenerated = new HandleDataGeneratedDelegate(rpi.DrawGierInTime); //更新接收到的事件到平面图 this._ea.GetEvent().Subscribe(u => { - _dispatcher.Invoke(_handleDataGenerated, GlobalData.ReceivedEvents, canvas.ActualWidth, canvas.ActualHeight, EventShowTotalSeconds, DateTime.Now); + RedrawReceivedEvents(); }); //开始监控 //this._ea.GetEvent().Subscribe(() => @@ -181,6 +187,16 @@ namespace Txgy.EWS.Client.PageModule.Views // //_dispatcher.Invoke(_handleDataGenerated); //}); } + + private void RedrawReceivedEvents() + { + if (_handleDataGenerated == null) + { + return; + } + + _dispatcher.Invoke(_handleDataGenerated, GlobalData.ReceivedEvents, canvas.ActualWidth, canvas.ActualHeight, EventShowTotalSeconds, DateTime.Now); + } //点击事件列表动画效果 public void ClickEventInListStoryBoard(GridItemEventResult gier, int Repeat) { @@ -405,7 +421,7 @@ namespace Txgy.EWS.Client.PageModule.Views foreach (var item in GlobalData.AlarmEvents) { //如果事件时间在24小时内显示 - if ((DateTime.Parse(item.EventTime) - DateTime.Now).TotalSeconds < EventShowTotalSeconds) + if ((DateTime.Now - DateTime.Parse(item.EventTime)).TotalSeconds <= EventShowTotalSeconds) { float sizeFactor = (float)(((4f + item.ML) / (4f)) * 2f) + 0.1f; int colorIndex = (int)(((item.Z - GlobalConfig.ProjectConfig.WorkArea.ZMin) diff --git a/Txgy.EWS.Client.PageModule/Views/EarlyWarningViewBak.xaml.cs b/Txgy.EWS.Client.PageModule/Views/EarlyWarningViewBak.xaml.cs index a41e346..bec1bb5 100644 --- a/Txgy.EWS.Client.PageModule/Views/EarlyWarningViewBak.xaml.cs +++ b/Txgy.EWS.Client.PageModule/Views/EarlyWarningViewBak.xaml.cs @@ -133,6 +133,12 @@ namespace Txgy.EWS.Client.PageModule.Views canvas.RenderTransform = transGroup; //事件时限秒数 EventShowTotalSeconds = BusinessConfigManager.Current.Runtime.EventShowTotalSeconds; + this._ea.GetEvent().Subscribe(config => + { + EventShowTotalSeconds = config.Runtime.EventShowTotalSeconds; + RedrawReceivedEvents(); + }, ThreadOption.UIThread); + this._ea.GetEvent().Subscribe(RedrawReceivedEvents, ThreadOption.UIThread); _handleDataGenerated = new HandleDataGeneratedDelegate(rpi.DrawGierInTime); @@ -163,6 +169,15 @@ namespace Txgy.EWS.Client.PageModule.Views // //_dispatcher.Invoke(_handleDataGenerated); //}); } + private void RedrawReceivedEvents() + { + if (_handleDataGenerated == null) + { + return; + } + + _dispatcher.Invoke(_handleDataGenerated, GlobalData.ReceivedEvents, canvas.ActualWidth, canvas.ActualHeight, EventShowTotalSeconds, DateTime.Now); + } public void CreateStoryBoard() { var myCircle = new Ellipse(); @@ -266,7 +281,7 @@ namespace Txgy.EWS.Client.PageModule.Views foreach (var item in GlobalData.AlarmEvents) { //如果事件时间在24小时内显示 - if ((DateTime.Parse(item.EventTime) - DateTime.Now).TotalSeconds < EventShowTotalSeconds) + if ((DateTime.Now - DateTime.Parse(item.EventTime)).TotalSeconds <= EventShowTotalSeconds) { float sizeFactor = (float)(((4f + item.ML) / (4f)) * 2f) + 0.1f; int colorIndex = (int)(((item.Z - GlobalConfig.ProjectConfig.WorkArea.ZMin) diff --git a/Txgy.EWS.Client.PageModule/Views/ReportView.xaml b/Txgy.EWS.Client.PageModule/Views/ReportView.xaml index 6ed1463..1c4c8b8 100644 --- a/Txgy.EWS.Client.PageModule/Views/ReportView.xaml +++ b/Txgy.EWS.Client.PageModule/Views/ReportView.xaml @@ -168,20 +168,13 @@ SelectedDateTime="{Binding TimeFC.Cond2}" FontSize="14" /> - + - - - - + Margin="5" + d:Text="12" + Text="{Binding Path=(comm:GlobalConfig.DataLookbackHours)}" + TextAlignment="Right" /> + diff --git a/Txgy.EWS.Client.PageModule/Views/TitleView.xaml b/Txgy.EWS.Client.PageModule/Views/TitleView.xaml index 1f62699..43047cf 100644 --- a/Txgy.EWS.Client.PageModule/Views/TitleView.xaml +++ b/Txgy.EWS.Client.PageModule/Views/TitleView.xaml @@ -1,18 +1,19 @@ - + @@ -25,9 +26,10 @@ - + - + - - - - + + + + @@ -93,47 +100,52 @@ - + - + + RepeatBehavior="Forever" + AutoReverse="True" + Duration="0:0:2" + Storyboard.TargetName="back" + Storyboard.TargetProperty="Effect.(BlurEffect.Radius)" />--> - - + + - + @@ -149,80 +161,105 @@ - + - - - - + + + + - + - - + + - - + + + + + + - - + + -