Legend Class

Namespace: devDept.Eyeshot
Assembly: devDept.Eyeshot.Control.Wpf (in devDept.Eyeshot.Control.Wpf.dll)

Legend settings.

C++

JScript

Copy

Public Class Legend 
    Inherits UserInterfaceBase 
    Implements IUserInterfaceElement, _ 
               ICloneable

This language is not supported or no code example is available.

C++

JScript

Copy

public class Legend : UserInterfaceBase, 
   IUserInterfaceElement, 
   ICloneable

This language is not supported or no code example is available.

Constructors

	Name	Description
	Legend(double, double, string, string, Point, Size, bool, bool, bool, string, Color, Color, Color, Font, Font, Color[], bool)	Obsolete. Deprecated constructor.
	Legend(double, double, string, string, Point, Size, bool, bool, bool, string, Color, Color, Color, Font, Font, Color[])	Obsolete. Deprecated constructor.
	Legend(Legend)	Copy constructor.
	Legend()	Empty constructor.
	Legend(Color[])	Color table constructor (WinForms).
	Legend(ObservableCollection<Brush>)	Color table constructor (WPF).
	Legend(double, double, string, string, Point, Size, bool, bool, bool, string, Color, Color, Color, Font, Font, ObservableCollection<Brush>, bool, bool)	Standard constructor (WPF).
	Legend(double, double, string, string, Point, Size, bool, bool, bool, string, Color, Color, Color, Font, Font, Color[], bool, bool)	Standard constructor (WinForms).
	Legend(double, double, string, string, Point, Size, bool, bool, bool, string, Color, Color, Color, Color[], bool)	Standard constructor.
	Legend(double, double, string, string, Point, Size, bool, bool, bool, string, Color, Color, Color, Color[], bool, bool)	Standard constructor.
	Legend(double, double, string, string, Point, Size, bool, bool, bool, string, Color, Color, Color, Color[])	Standard constructor.

Top

Properties

	Name	Description
	AlignValuesRight	If true, values are aligned right.
	AlignValuesVerticalMiddle	If true, the values are vertically aligned to the middle of the colored rectangles.
	ColorTable	Gets or sets the color table.
	CustomViewport	Tells if the UI element is drawn with a custom viewport. (inherited from UserInterfaceBase).
	Disposed	(inherited from DisposableBase).
	FactorOfSafety15	Factor of safety color gradient (15 items).
	FontFamily	Gets or sets the text font family.
	FontSize	Gets or sets the text font size.
	FontStyle	Gets or sets the text font style.
	FontWeight	Gets or sets the text font weight.
	FormatString	Value's numeric format. Useful to change number format and decimal places.
	IsSlave	If true, the legend minimum and maximum values are set automatically (FEM only).
	ItemSize	Size of each color rectangle.
	Lighting	When false, the UI element is drawn with a flat color.
	LocationAtOrigin	When doing a render to Bitmap of the item, must not change the viewport origin. (inherited from UserInterfaceBase).
	Max	Gets or sets legend maximum value.
	Min	Gets or sets legend minimum value.
	ParentViewport	(inherited from UserInterfaceBase).
	Position	Top left corner position.
	RedToBlue17	Standard Red to Blue color gradient (17 items).
	RedToBlue33	Standard Red to Blue color gradient (33 items).
	RedToBlue9	Standard Red to Blue color gradient (9 items).
	Subtitle	Gets or sets the legend subtitle.
	TextBackgroundColor	Text background color (supports semi-transparent colors).
	TextColor	Value text color.
	TextFont	Gets or sets the value font.
	Title	Gets or sets the legend title.
	TitleColor	Title text color.
	TitleFont	Title font.
	TitleFontSize	Gets or sets the text font size.
	Values	Gets the legend values.
	Visible	Visibility status.

Top

Methods

	Name	Description
	BuildGradient(int)	Builds a red to blue gradient array of colors.
	Clone()
	Dispose()
	Draw(Workspace, Viewport)
	DrawForBitmap(object)
	DrawGdi(float, float, Graphics, Workspace, Viewport, Point)
	Equals(Object)	(inherited from Object).
	Finalize	(inherited from Object).
	GetBounds(Viewport)	Gets the bounds rectangle in screen coordinates.
	GetDefaultLayerName(Workspace)	Use this method to get the correct layer name for internal Meshes. (inherited from UserInterfaceBase).
	GetHashCode	(inherited from Object).
	GetScalingLevelRatio()	Gets scaling level ratio used to get the correct font size.
	GetStringValue(int)	Gets the string corresponding to the n-th value.
	GetThumbnail(Viewport, Size, Color)	Gets a thumbnail bitmap of the user interface element.
	GetType	(inherited from Object).
	MemberwiseClone	(inherited from Object).
	ScaleForDPI()	Scales the element for high DPI settings.
	SetRange(double, double)	Sets the range of legend values.
	ToString	(inherited from Object).
	Update(IUserInterfaceElement)