ColorTranslator.FromOle(Int32) Method

Reference

Definition

Namespace:: System.Drawing

Assembly:: System.Drawing.Primitives.dll

Assembly:: System.Drawing.dll

Assembly:: System.Drawing.Common.dll

Package:: System.Drawing.Common v10.0.0-preview.1.25080.3

Source:: ColorTranslator.cs

Source:: ColorTranslator.cs

Source:: ColorTranslator.cs

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.

Translates an OLE color value to a GDI+ Color structure.

public:
 static System::Drawing::Color FromOle(int oleColor);

public static System.Drawing.Color FromOle(int oleColor);

static member FromOle : int -> System.Drawing.Color

Public Shared Function FromOle (oleColor As Integer) As Color

Parameters

oleColor: Int32

The OLE color to translate.

Returns

Color

The Color structure that represents the translated OLE color.

Examples

The following example is designed for use with Windows Forms, and it requires PaintEventArgs e, which is a parameter of the Paint event handler. The code translates an OLE color value to a Color structure, and then uses that color to fill a rectangle.

public:
   void FromOle_Example( PaintEventArgs^ e )
   {
      // Create an integer representation of an OLE color.
      int oleColor = 0xFF00;

      // Translate oleColor to a GDI+ Color structure.
      Color myColor = ColorTranslator::FromOle( oleColor );

      // Fill a rectangle with myColor.
      e->Graphics->FillRectangle( gcnew SolidBrush( myColor ), 0, 0, 100, 100 );
   }

public void FromOle_Example(PaintEventArgs e)
{
    // Create an integer representation of an OLE color.
    int oleColor = 0xFF00;
             
    // Translate oleColor to a GDI+ Color structure.
    Color myColor = ColorTranslator.FromOle(oleColor);
             
    // Fill a rectangle with myColor.
    e.Graphics.FillRectangle( new SolidBrush(myColor), 0, 0, 
        100, 100);
}

Public Sub FromOle_Example(ByVal e As PaintEventArgs)

    ' Create an integer representation of an HTML color.
    Dim oleColor As Integer = &HFF00

    ' Translate oleColor to a GDI+ Color structure.
    Dim myColor As Color = ColorTranslator.FromOle(oleColor)

    ' Fill a rectangle with myColor.
    e.Graphics.FillRectangle(New SolidBrush(myColor), 0, 0, 100, 100)
End Sub

Applies to

Product	Versions
.NET	Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10
.NET Framework	1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard	2.0 (package-provided)

Share via