ColorTranslator.ToOle(Color) Method

Reference

Definition

Namespace:: System.Drawing

Assembly:: System.Drawing.Primitives.dll

Assembly:: System.Drawing.dll

Assembly:: System.Drawing.Common.dll

Package:: System.Drawing.Common v9.0.0

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 the specified Color structure to an OLE color.

public:
 static int ToOle(System::Drawing::Color c);

public static int ToOle (System.Drawing.Color c);

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

Public Shared Function ToOle (c As Color) As Integer

Parameters

c: Color

The Color structure to translate.

Returns

Int32

The OLE color value.

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 a Color structure to an integer that represents an OLE color, and then shows a message box with the resulting string.

public:
   void ToOle_Example( PaintEventArgs^ /*e*/ )
   {
      // Create an instance of a Color structure.
      Color myColor = Color::Red;

      // Translate myColor to an OLE color.
      int oleColor = ColorTranslator::ToOle( myColor );

      // Show a message box with the value of oleColor.
      MessageBox::Show( oleColor.ToString() );
   }

public void ToOle_Example(PaintEventArgs e)
{
   // Create an instance of a Color structure.
    Color myColor = Color.Red;
             
    // Translate myColor to an OLE color.
    int oleColor = ColorTranslator.ToOle(myColor);
             
    // Show a message box with the value of oleColor.
    MessageBox.Show(oleColor.ToString());
}

Public Sub ToOle_Example(ByVal e As PaintEventArgs)

    ' Create an instance of a Color structure.
    Dim myColor As Color = Color.Green

    ' Translate myColor to an OLE color.
    Dim oleColor As Integer = ColorTranslator.ToOle(myColor)

    ' Show a message box with the value of htmlColor.
    MessageBox.Show(oleColor.ToString())
End Sub

Applies to

Jaa