Share via


ChartLegend Class

Represents the properties that can be used to display instances of the series groups in a chart legend.

Inheritance Hierarchy

System.Object
  Microsoft.ReportingServices.OnDemandReportRendering.ChartObjectCollectionItem<ChartLegendInstance>
    Microsoft.ReportingServices.OnDemandReportRendering.ChartLegend

Namespace:  Microsoft.ReportingServices.OnDemandReportRendering
Assembly:  Microsoft.ReportingServices.ProcessingCore (in Microsoft.ReportingServices.ProcessingCore.dll)

Syntax

'Declaration
Public NotInheritable Class ChartLegend _
    Inherits ChartObjectCollectionItem(Of ChartLegendInstance) _
    Implements IROMStyleDefinitionContainer
'Usage
Dim instance As ChartLegend
public sealed class ChartLegend : ChartObjectCollectionItem<ChartLegendInstance>, 
    IROMStyleDefinitionContainer
public ref class ChartLegend sealed : public ChartObjectCollectionItem<ChartLegendInstance^>, 
    IROMStyleDefinitionContainer
[<SealedAttribute>]
type ChartLegend =  
    class
        inherit ChartObjectCollectionItem<ChartLegendInstance>
        interface IROMStyleDefinitionContainer
    end
public final class ChartLegend extends ChartObjectCollectionItem<ChartLegendInstance> implements IROMStyleDefinitionContainer

The ChartLegend type exposes the following members.

Properties

  Name Description
Public property AutoFitTextDisabled Gets an expression that evaluates to a value that indicates whether text will not be autosized to fit in the legend area.
Public property ChartElementPosition Gets a custom position for the legend.
Public property ColumnSeparator Gets an expression that evaluates to a value that indicates what type of separator to use for the columns.
Public property ColumnSeparatorColor Gets an expression that evaluates to the color to use for the column separator.
Public property ColumnSpacing Gets an expression that evaluates to the spacing between columns as a percent of the font size.
Public property DockOutsideChartArea Gets an expression that evaluates to a value that indicates whether the title should be docked outside the chart area rather than inside the chart area.
Public property DockToChartArea Gets the name of the chart area on which to draw the legend.
Public property EquallySpacedItems Gets an expression that evaluates to a value that indicates whether legend items should be equally spaced.
Public property HeaderSeparator Gets an expression that evaluates to the type of separator to use for the legend header.
Public property HeaderSeparatorColor Gets an expression that evaluates to the color to use for the legend header separator.
Public property Hidden Gets an expression that evaluates to a value that indicates whether the legend is hidden.
Public property Instance Gets the report instance object that contains the calculated values of this report definition object.
Public property InterlacedRows Gets an expression that evaluates to a value that indicates whether legend rows should use interlaced colors.
Public property InterlacedRowsColor Gets an expression that evaluates to the background color to use for interlaced legend rows.
Public property Layout Gets an expression that evaluates to the arrangement of labels within the legend.
Public property LegendColumns Gets the legend columns.
Public property LegendCustomItems Gets the custom legend items.
Public property LegendTitle Gets the legend title.
Public property MaxAutoSize Gets an expression that evaluates to the maximum size for the legend, as a percent of the chart size.
Public property MinFontSize Gets an expression that evaluates to the minimum size for autosized legend text.
Public property Name Gets the name of the chart legend.
Public property Position Gets an expression that evaluates to the position of the legend.
Public property Reversed Gets an expression that evaluates to a value that indicates the direction of the legend should be reversed.
Public property Style Gets the style properties of this report definition object.
Public property TextWrapThreshold Gets an expression that evaluates to the number of characters after which to wrap the legend text.

Top

Methods

  Name Description
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Public method ToString (Inherited from Object.)

Top

Fields

  Name Description
Protected field m_instance Infrastructure. (Inherited from ChartObjectCollectionItem<T>.)

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.