Click or drag to resize

LightningChart Methods

LightningChart .NET Help

The LightningChart type exposes the following members.

Methods
  NameDescription
Public methodBeginInvoke(Delegate)
Executes the specified delegate asynchronously on the thread that the control's underlying handle was created on.
(Inherited from Control.)
Public methodBeginInvoke(Delegate, Object)
Executes the specified delegate asynchronously with the specified arguments, on the thread that the control's underlying handle was created on.
(Inherited from Control.)
Public methodBeginUpdate
Begin update. Disables control repaints when a property is changed. Handy when updating status of many properties or updating series points.
Public methodBringToFront
Brings the control to the front of the z-order.
(Inherited from Control.)
Public methodCaptureToBitmap
Get chart as bitmap.
Public methodCaptureToByteArray
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

Public methodStatic memberCloseGestureInfoHandle
Close gesture info handle.
Public methodContains
Retrieves a value indicating whether the specified control is a child of the control.
(Inherited from Control.)
Public methodCopyToClipboard
Copy the chart to clipboard bitmap image.
Public methodCopyToClipboard(ClipboardImageFormat)
Copy the chart to clipboard image by given format.
Public methodCopyToClipboard(ClipboardImageFormat, BitmapAntialiasOptions)
Copy the chart to clipboard image.
Public methodCopyToClipboard(Int32, Int32)
Copy the chart to clipboard bitmap image.
Public methodCopyToClipboard(ClipboardImageFormat, Int32, Int32, Boolean)
Copy the chart to clipboard image by given format.
Public methodCopyToClipboard(ClipboardImageFormat, BitmapAntialiasOptions, Int32, Int32, Boolean)
Copy the chart to clipboard image.
Public methodCopyToClipboardAsEmf
Copy chart to clipboard as emf.
Public methodCreateControl
Forces the creation of the visible control, including the creation of the handle and any visible child controls.
(Inherited from Control.)
Public methodCreateGraphics
Creates the Graphics for the control.
(Inherited from Control.)
Public methodCreateObjRef
Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
(Inherited from MarshalByRefObject.)
Public methodDispose
Releases all resources used by the Component.
(Inherited from Component.)
Public methodDoDragDrop
Begins a drag-and-drop operation.
(Inherited from Control.)
Public methodDrawToBitmap
Supports rendering to the specified bitmap.
(Inherited from Control.)
Public methodEnableObjectTreeTimer
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.
Public methodEndInvoke
Retrieves the return value of the asynchronous operation represented by the IAsyncResult passed.
(Inherited from Control.)
Public methodEndUpdate
End update. Enables control repainting, and refreshes the control.
Public methodStatic memberEngineInitResultsToString
Used to convert GetLastEngineInitResults to string to help reporting of it's contents.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodFindForm
Retrieves the form that the control is on.
(Inherited from Control.)
Public methodFocus
Sets input focus to the control.
(Inherited from Control.)
Public methodFullRepaint
Destroy all buffered draw data and repaint the chart This is slower than Refresh(), but thorough.
Public methodGetActiveUserInteractiveDeviceOverObject
Get the chart object that is activated by mouse. Note that this information is not correct if we do not have proper device set.
Public methodGetBeginUpdateCount
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.

Public methodGetBeginUpdateCountPublic
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.
Public methodGetChildAtPoint(Point)
Retrieves the child control that is located at the specified coordinates.
(Inherited from Control.)
Public methodGetChildAtPoint(Point, GetChildAtPointSkip)
Retrieves the child control that is located at the specified coordinates, specifying whether to ignore child controls of a certain type.
(Inherited from Control.)
Public methodGetContainerControl
Returns the next ContainerControl up the control's chain of parent controls.
(Inherited from Control.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetLastEngineInitResults
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.

Public methodGetLastOutputStreamFormat
Getter of the pixel format of the last written data to the OutputStream.
Public methodGetLastOutputStreamSize
Getter of the image size of the last image written to OutputStream as pixels (not DIP's).
Public methodGetLifetimeService
Retrieves the current lifetime service object that controls the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
Public methodGetNextControl
Retrieves the next control forward or back in the tab order of child controls.
(Inherited from Control.)
Public methodGetParentWindow
Get parent window handle (HWND). Needed when using the control from other systems than .NET.
Public methodGetPreferredSize
Retrieves the size of a rectangular area into which a control can be fitted.
(Inherited from Control.)
Public methodGetRenderDeviceInfo
Get render device information. Gives information about your graphics adapter. Tells if there is something that prevents the control to run at optimal performance.
Public methodGetThemeAuroras
Get Predefined theme Auroras
Public methodGetThemeBrushedMetal
Get Predefined theme Brushed metal
Public methodGetThemeMagma
Get predefined theme magma.
Public methodGetThemePaper
Get Predefined theme Paper
Public methodGetThemeRedCarbon
Get Predefined theme Red carbon
Public methodGetThemeTurquoiseHexagon
Get predefined theme TurgouiseHexagon.
Public methodGetThemeWorldCyberSpace
Get Predefined theme Wolrd cyber space
Public methodStatic memberGetTotalChartCount
Gets total count of chart instances in application context.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetVersion
Version and revision.
Public methodHide
Conceals the control from the user.
(Inherited from Control.)
Public methodHighqualityFontConflictCheck
Checks if high quality font and transparency background is used with DX11 and gives warning of this conflict combination.
Public methodInitializeLifetimeService
Obtains a lifetime service object to control the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
Public methodInitializeRenderingDevice
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.
Public methodInvalidate
Invalidates the entire surface of the control and causes the control to be redrawn.
(Inherited from Control.)
Public methodInvalidate(Boolean)
Invalidates a specific region of the control and causes a paint message to be sent to the control. Optionally, invalidates the child controls assigned to the control.
(Inherited from Control.)
Public methodInvalidate(Rectangle)
Invalidates the specified region of the control (adds it to the control's update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control.
(Inherited from Control.)
Public methodInvalidate(Region)
Invalidates the specified region of the control (adds it to the control's update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control.
(Inherited from Control.)
Public methodInvalidate(Rectangle, Boolean)
Invalidates the specified region of the control (adds it to the control's update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control. Optionally, invalidates the child controls assigned to the control.
(Inherited from Control.)
Public methodInvalidate(Region, Boolean)
Invalidates the specified region of the control (adds it to the control's update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control. Optionally, invalidates the child controls assigned to the control.
(Inherited from Control.)
Public methodStatic memberInvert
Opposite color
Public methodInvoke(Delegate)
Executes the specified delegate on the thread that owns the control's underlying window handle.
(Inherited from Control.)
Public methodInvoke(Delegate, Object)
Executes the specified delegate, on the thread that owns the control's underlying window handle, with the specified list of arguments.
(Inherited from Control.)
Public methodStatic memberIsHardwareRenderingSupported
Check if hardware rendering is supported.
Public methodStatic memberIsHardwareRenderingSupported(DeviceTypeFlags)
Check if hardware rendering is supported.
Public methodIsPositionOver
Finds out if the given coordinate is over the chart control with pixels.
Public methodIsUsingHardwareRendering
Check if chart is using hardware rendering.
Public methodMeasureText
Measure text with given font in pixels.
Public methodPerformAutoScale
Performs scaling of the container control and its children.
(Inherited from ContainerControl.)
Public methodPerformLayout
Forces the control to apply layout logic to all its child controls.
(Inherited from Control.)
Public methodPerformLayout(Control, String)
Forces the control to apply layout logic to all its child controls.
(Inherited from Control.)
Public methodPointToClient
Computes the location of the specified screen point into client coordinates.
(Inherited from Control.)
Public methodPointToScreen
Computes the location of the specified client point into screen coordinates.
(Inherited from Control.)
Public methodPreProcessControlMessage
Preprocesses keyboard or input messages within the message loop before they are dispatched.
(Inherited from Control.)
Public methodPreProcessMessage
Preprocesses keyboard or input messages within the message loop before they are dispatched.
(Inherited from Control.)
Public methodPrint
Print chart to default printer with default settings using raster output. No header nor footer.
Public methodPrint(ImageType, Boolean, Boolean, Boolean, String, String, Boolean, Padding)
Print chart to default printer with given settings.
Public methodPrintPreview
Print preview of chart.
Public methodPrintPreview(String, String, Boolean)
Print preview of chart.
Public methodPrintWithPageSetup
Show page setup dialog and print if ok clicked and allowed.
Public methodPrintWithPrinterSelection
Show printer selection dialog and print if allowed.
Public methodRectangleToClient
Computes the size and location of the specified screen rectangle in client coordinates.
(Inherited from Control.)
Public methodRectangleToScreen
Computes the size and location of the specified client rectangle in screen coordinates.
(Inherited from Control.)
Public methodRefresh
Refresh the control, does not free the buffered draw data, so it's faster than FullRepaint()
(Overrides ControlRefresh.)
Public methodResetBeginUpdateCount
Reset BeginUpdate/EndUpdate counter. Usually not required to call.
Public methodResetPageSettings
Reset page settings.
Public methodResetText
Resets the Text property to its default value.
(Inherited from Control.)
Public methodResumeLayout
Resumes usual layout logic.
(Inherited from Control.)
Public methodResumeLayout(Boolean)
Resumes usual layout logic, optionally forcing an immediate layout of pending layout requests.
(Inherited from Control.)
Public methodRTK
Read Trader Key
Public methodSaveToFile(String)
Save the chart into a image file with no extra anti-aliasing applied.
Public methodSaveToFile(String, BitmapAntialiasOptions)
Save the chart into a image file by using given anti-aliasing options.
Public methodSaveToFile(String, Int32, Int32, Boolean)
Save to file as given size.
Public methodSaveToFile(String, BitmapAntialiasOptions, Int32, Int32, Boolean)
Save the chart into a image file by using given anti-aliasing options.
Public methodSaveToStream(Stream)
Save the chart into stream in bitmap format.
Public methodSaveToStream(Stream, TargetImageFormat)
Save the chart into stream in given format and anti-aliasing options.
Public methodSaveToStream(Stream, TargetImageFormat, BitmapAntialiasOptions)
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.

Public methodSaveToStream(Stream, Int32, Int32)
Save the chart into stream in given size.
Public methodSaveToStream(Stream, TargetImageFormat, Int32, Int32, Boolean)
Save the chart into stream in given format and anti-aliasing options.
Public methodSaveToStream(Stream, TargetImageFormat, BitmapAntialiasOptions, Int32, Int32, Boolean)
Save the chart into stream in given format and anti-aliasing options.
Public methodScale
Scales the control and all child controls by the specified scaling factor.
(Inherited from Control.)
Public methodScrollControlIntoView
Scrolls the specified child control into view on an auto-scroll enabled control.
(Inherited from ScrollableControl.)
Public methodSelect
Activates the control.
(Inherited from Control.)
Public methodSelectNextControl
Activates the next control.
(Inherited from Control.)
Public methodSendToBack
Sends the control to the back of the z-order.
(Inherited from Control.)
Public methodSetAutoScrollMargin
Sets the size of the auto-scroll margins.
(Inherited from ScrollableControl.)
Public methodSetBounds(Int32, Int32, Int32, Int32)
Sets the bounds of the control to the specified location and size.
(Inherited from Control.)
Public methodSetBounds(Int32, Int32, Int32, Int32, BoundsSpecified)
Sets the specified bounds of the control to the specified location and size.
(Inherited from Control.)
Public methodStatic memberSetDeploymentKey
Set Deployment Key
Public methodSetParentWindow
Set parent window handle (HWND). Needed when using the control from other systems than .NET. Parent window handle.
Public methodShow
Displays the control to the user.
(Inherited from Control.)
Public methodShowPropertiesEditor
Show properties editor window.
Public methodShowPropertiesEditor(Int32, Int32)
Show properties editor dialog in specific location.
Public methodSuspendLayout
Temporarily suspends the layout logic for the control.
(Inherited from Control.)
Public methodToString
Convert class description to string
(Overrides ComponentToString.)
Public methodTweakDisablePresent
Disable DirectX present calls, but let the rendering routines run otherwise
Public methodTweakEnablePresent
Enable DirectX present calls again
Public methodUpdate
Causes the control to redraw the invalidated regions within its client area.
(Inherited from Control.)
Public methodUpdateCustomTheme
Update custom themes.
Public methodUpdatePixelAlignment
Forces update of WPF pixel alignment. Calling this should not be required normally.
Public methodValidate
Verifies the value of the control losing focus by causing the Validating and Validated events to occur, in that order.
(Inherited from ContainerControl.)
Public methodValidate(Boolean)
Verifies the value of the control that is losing focus; conditionally dependent on whether automatic validation is turned on.
(Inherited from ContainerControl.)
Public methodValidateChildren (Inherited from UserControl.)
Public methodValidateChildren(ValidationConstraints) (Inherited from UserControl.)
Top
Extension Methods
  NameDescription
Public Extension MethodGatherApplicationInformation
Gathers various information from the current chart for debugging purposes as a string by calling GatherApplicationInformation(ChartToolsGatherDataOptions, LightningChart, String, String) Optionally saves the output to a text file if file path and file name are specified. Gathered data (if ChartToolsGatherDataOptions is set to All): system information, chart information, list of running processes, DxDiag output, installed Windows hotfixes.
(Defined by ExtensionsClass.)
Top
See Also