Legend Interface

Reference

Definition

Namespace:: Microsoft.Office.Interop.Excel

Assembly:: Microsoft.Office.Interop.Excel.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Represents the legend in a chart.

public interface class Legend

[System.Runtime.InteropServices.Guid("000208CD-0000-0000-C000-000000000046")]
[System.Runtime.InteropServices.InterfaceType(2)]
public interface Legend

Public Interface Legend

Attributes: GuidAttribute InterfaceTypeAttribute

Remarks

Each chart can have only one legend. The Legend object contains one or more LegendEntry objects; each LegendEntry object contains a LegendKey object.

Use the Legend property to return the Legend object.

The chart legend isn’t visible unless the HasLegend property is True. If this property is False, properties and methods of the Legend object will fail.

Properties

Application	Returns an Application object that represents the Microsoft Excel application.
AutoScaleFont	True if the text in the object changes font size when the object size changes. The default value is True.
Border	Returns a Border object that represents the border of the object.
Creator	Returns a 32-bit integer that indicates the application in which this object was created.
Fill	Returns a ChartFillFormat object that contains fill formatting properties for the specified chart legend.
Font	Returns a Font object that represents the font of the specified object.
Format	Returns the ChartFormat object. Read-only.
Height	The height, in points, of the object.
IncludeInLayout	True if a legend will occupy the chart layout space when a chart layout is being determined. The default value is True. Read/write Boolean.
Interior	Returns an Interior object that represents the interior of the specified object.
Left	The distance, in points, from the left edge of the object to the left edge of the chart area.
Name	Returns the name of the object.
Parent	Returns the parent object for the specified object.
Position	Returns or sets the position of the legend on the chart.
Shadow	True if the font is a shadow font or if the object has a shadow.
Top	The distance, in points, from the top edge of the object to the top of the chart area.
Width	The width, in points, of the object.

Methods

Clear()	Clears the entire object.
Delete()	Deletes the object.
LegendEntries(Object)	Returns an object that represents either a single legend entry (a LegendEntry object) or a collection of legend entries (a LegendEntries object) for the legend.
Select()	Selects the object.

Applies to