ExcelDrawingMetadata Class

Namespace:
GemBox.Spreadsheet
Assembly:
GemBox.Spreadsheet.dll

Represents a set of non-visual properties which shall be applied to the parent ExcelDrawing.

public sealed class ExcelDrawingMetadata
Public NotInheritable Class ExcelDrawingMetadata
Inheritance:
System.Object
ExcelDrawingMetadata

Properties

Description

Gets or sets the alternative text for the current drawing, for use by assistive technologies or applications which will not display the current drawing.

public string Description { get; set; }
Public Property Description As String
Property Value
System.String

The alternative text for the current drawing, for use by assistive technologies or applications which will not display the current drawing.

Id

Gets a unique identifier for the current drawing within the worksheet.

public int Id { get; }
Public ReadOnly Property Id As Integer
Property Value
System.Int32

A unique identifier for the current drawing within the worksheet.

Remarks

This ID may be used to assist in uniquely identifying this drawing so that it can be referred to by other parts of the workbook.

Name

Gets or sets the name for the current drawing.

public string Name { get; set; }
Public Property Name As String
Property Value
System.String

The name for the current drawing.

Exceptions
System.ArgumentException

Drawing's name cannot be empty.

Title

Gets or sets the title, caption, for the current drawing.

public string Title { get; set; }
Public Property Title As String
Property Value
System.String

The title for the current drawing.

Methods

ToString()

Returns a System.String that represents this ExcelDrawingMetadata instance.

public override string ToString()
Public Overrides Function ToString As String
Returns
System.String

A System.String that represents this ExcelDrawingMetadata instance.

Overrides
System.Object.ToString()
Remarks

This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).