Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/

API Reference

Struct

OfficeArtColorReference

Namespace OfficeIMO.Drawing.Binary
Assembly OfficeIMO.Core
Base ValueType
Implements
IEquatable<OfficeArtColorReference>
Modifiers sealed

Represents the packed OfficeArtCOLORREF value defined by MS-ODRAW.

Inheritance

  • ValueType
  • OfficeArtColorReference

Usage

Explore 12 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Accepted by parameters 5

Constructors

public OfficeArtColorReference(UInt32 value) #

Creates a color reference from its packed 32-bit value.

Parameters

value System.UInt32 requiredposition: 0

Methods

Equals 2 overloads
public Boolean Equals(OfficeArtColorReference other) #
Returns: Boolean

Indicates whether the current object is equal to another object of the same type.

Parameters

other OfficeIMO.Drawing.Binary.OfficeArtColorReference requiredposition: 0
An object to compare with this object.

Returns

true if the current object is equal to the other parameter; otherwise, false.

public override Boolean Equals(Object? obj) #
Returns: Boolean

Indicates whether this instance and a specified object are equal.

Parameters

obj System.Object? requiredposition: 0
The object to compare with the current instance.

Returns

true if obj and this instance are the same type and represent the same value; otherwise, false.

public override Int32 GetHashCode() #
Returns: Int32

Returns the hash code for this instance.

Returns

A 32-bit signed integer that is the hash code for this instance.

public static Boolean op_Equality(OfficeArtColorReference left, OfficeArtColorReference right) #
Returns: Boolean

Compares two color references.

Parameters

left OfficeIMO.Drawing.Binary.OfficeArtColorReference requiredposition: 0
right OfficeIMO.Drawing.Binary.OfficeArtColorReference requiredposition: 1
public static Boolean op_Inequality(OfficeArtColorReference left, OfficeArtColorReference right) #
Returns: Boolean

Compares two color references.

Parameters

left OfficeIMO.Drawing.Binary.OfficeArtColorReference requiredposition: 0
right OfficeIMO.Drawing.Binary.OfficeArtColorReference requiredposition: 1
public override String ToString() #
Returns: String

Returns the fully qualified type name of this instance.

Returns

The fully qualified type name.

public Boolean TryResolve(Func<Byte, OfficeColor?>? schemeColorResolver, out OfficeColor color) #
Returns: Boolean

Resolves the reference to RGB. Scheme colors are delegated to schemeColorResolver; system and palette indexes remain unresolved.

Parameters

schemeColorResolver System.Func<System.Byte, OfficeIMO.Drawing.OfficeColor?>? requiredposition: 0
color OfficeIMO.Drawing.OfficeColor requiredposition: 1

Properties

public UInt32 Value { get; } #

Gets the packed 32-bit value.

public Byte Red { get; } #

Gets the red byte or scheme index.

public Byte Green { get; } #

Gets the green byte.

public Byte Blue { get; } #

Gets the blue byte.

public Byte Flags { get; } #

Gets the OfficeArt color flags.

public Boolean IsIgnored { get; } #

Gets whether the high byte marks this reference as ignored.

public Boolean IsSchemeIndex { get; } #

Gets whether the color resolves through the current application color scheme.

public Boolean IsSystemIndex { get; } #

Gets whether the value uses a system color index.

public Boolean IsPaletteIndex { get; } #

Gets whether the value uses a palette index.

public Byte? SchemeIndex { get; } #

Gets the scheme index when OfficeArtColorReference.IsSchemeIndex is true.