AnalysisDisplayLegendSettings

Description:
Contains legend settings for analysis display style element.

Inheritance Hierarchy:
System.Object
Autodesk.Revit.DB.Analysis.AnalysisDisplayLegendSettings

public class AnalysisDisplayLegendSettings : IDisposable

Public Class AnalysisDisplayLegendSettings _
	Implements IDisposable

public ref class AnalysisDisplayLegendSettings : IDisposable

AnalysisDisplayLegendSettings legendSettings = new AnalysisDisplayLegendSettings();
legendSettings.NumberOfSteps = 10;
legendSettings.Rounding = 0.05;
legendSettings.ShowDataDescription = false;
legendSettings.ShowLegend = true;

Dim legendSettings As New AnalysisDisplayLegendSettings()
legendSettings.NumberOfSteps = 10
legendSettings.Rounding = 0.05
legendSettings.ShowDataDescription = False
legendSettings.ShowLegend = True

Name	Return Type	Description
C AnalysisDisplayLegendSettings()	None	Constructs a default instance of legend settings.
C AnalysisDisplayLegendSettings(AnalysisDisplayLegendSettings)	None	Constructs a new copy of the input AnalysisDisplayLegendSettings object.

Name	Return Type	Description
M Dispose()	None	Releases all resources used by the
M IsEqual(AnalysisDisplayLegendSettings)	bool	Compares two legend settings objects.

Name	Return Type	Description
P ColorRangeHeight	int	Height of color range (for Colored Surface, Markers and Text, and Vector display). Measured in paperspace units.
P ColorRangeWidth	int	Width of color range (for Colored Surface, Markers and Text, and Vector display). Measured in paperspace units.
P HeadingTextTypeId	ElementId	Element id of text associated with legend heading.
P IsValidObject	bool	Specifies whether the .NET object represents a valid Revit entity.
P NumberForScale	double	A fixed value to display on the legend scale (0 by default; 0 means width of legend scale is calculated dynamically).
P NumberOfSteps	int	Number of steps (values between minimum and maximum) to be shown in legend.
P Rounding	double	Rounding increment for numeric values of analysis results.
P ScaleHeight	int	Height of scale (for Diagram display). Measured in paperspace units.
P ShowDataDescription	bool	If true, data description is shown in the legend.
P ShowDataName	bool	If true, data name is shown in the legend.
P ShowLegend	bool	If true, legend is shown in the view.
P ShowUnits	bool	If true, units are shown in the legend.
P TextTypeId	ElementId	Element id of text associated with legend body.