SpreadsheetIcon Struct

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

Represents a spreadsheet icon.

public struct SpreadsheetIcon : IEquatable<SpreadsheetIcon>
Public Structure SpreadsheetIcon
    Implements IEquatable(Of SpreadsheetIcon)
Implements
System.IEquatable<SpreadsheetIcon>

Constructors

SpreadsheetIcon(SpreadsheetIconStyle, Int32)

Initializes a new instance of the SpreadsheetIcon.

public SpreadsheetIcon(SpreadsheetIconStyle iconStyle, int id)
Public Sub New(iconStyle As SpreadsheetIconStyle, id As Integer)
Parameters
iconStyle
SpreadsheetIconStyle

The icon style.

id
System.Int32

The identifier of the icon from the set of icons specified by iconStyle (usually a value between 0 and 4).

Exceptions
System.ArgumentException

iconStyle cannot be set to Custom.

System.ArgumentOutOfRangeException

id must be equal to 0 if iconStyle is None or must be equal to or greater than 0 and less than then number of icons defined in the iconStyle.

Fields

None

Gets the SpreadsheetIcon instance whose IconStyle is equal to None.

public static readonly SpreadsheetIcon None
Public Shared ReadOnly None As SpreadsheetIcon
Field Value
SpreadsheetIcon

Properties

IconStyle

Gets the icon style.

public readonly SpreadsheetIconStyle IconStyle { get; }
Public ReadOnly Property IconStyle As SpreadsheetIconStyle
Property Value
SpreadsheetIconStyle

The icon style.

Id

Gets the identifier of the icon from the set of icons specified in IconStyle.

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

The identifier of the icon from the set of icons specified in IconStyle.

Methods

Equals(SpreadsheetIcon)

Determines whether the other SpreadsheetIcon is equal to this SpreadsheetIcon instance.

public bool Equals(SpreadsheetIcon other)
Public Function Equals(other As SpreadsheetIcon) As Boolean
Parameters
other
SpreadsheetIcon

The other SpreadsheetIcon to compare with this SpreadsheetIcon instance.

Returns
System.Boolean

true if the other SpreadsheetIcon is equal to this SpreadsheetIcon instance; otherwise, false.

Equals(Object)

Determines whether the specified System.Object is equal to this SpreadsheetIcon instance.

public override bool Equals(object obj)
Public Overrides Function Equals(obj As Object) As Boolean
Parameters
obj
System.Object

The System.Object to compare with this SpreadsheetIcon instance.

Returns
System.Boolean

true if the specified System.Object is a SpreadsheetIcon and is equal to this SpreadsheetIcon instance; otherwise, false.

Overrides
System.ValueType.Equals(System.Object)

GetHashCode()

Returns a hash code for this SpreadsheetIcon instance.

public override int GetHashCode()
Public Overrides Function GetHashCode As Integer
Returns
System.Int32

An integer value that specifies a hash value for this SpreadsheetIcon instance.

Overrides
System.ValueType.GetHashCode()

ToString()

Returns a System.String that represents this SpreadsheetIcon instance.

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

A System.String that represents this SpreadsheetIcon instance.

Overrides
System.ValueType.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).

Operators

Equality(SpreadsheetIcon, SpreadsheetIcon)

Determines whether first and second SpreadsheetIcons are equal.

public static bool operator ==(SpreadsheetIcon first, SpreadsheetIcon second)
Public Shared Operator =(first As SpreadsheetIcon, second As SpreadsheetIcon) As Boolean
Parameters
first
SpreadsheetIcon

The first SpreadsheetIcon.

second
SpreadsheetIcon

The second SpreadsheetIcon.

Returns
System.Boolean

true if first and second SpreadsheetIcons are equal; otherwise, false.

Inequality(SpreadsheetIcon, SpreadsheetIcon)

Determines whether first and second SpreadsheetIcons are not equal.

public static bool operator !=(SpreadsheetIcon first, SpreadsheetIcon second)
Public Shared Operator <>(first As SpreadsheetIcon, second As SpreadsheetIcon) As Boolean
Parameters
first
SpreadsheetIcon

The first SpreadsheetIcon.

second
SpreadsheetIcon

The second SpreadsheetIcon.

Returns
System.Boolean

true if first and second SpreadsheetIcons are not equal; otherwise, false.

Implements

System.IEquatable<T>