FormComboBoxControl.backgroundColor Method

  • Reference

Definition

Namespace:
Dynamics.AX.Application
Assembly:

Overloads

backgroundColor(Int32)
backgroundColor()

Gets or sets the background color of the control.

backgroundColor(Int32) 

public:
 virtual int backgroundColor(int _value);
public virtual int backgroundColor (int _value);
abstract member backgroundColor : int -> int
override this.backgroundColor : int -> int
Public Overridable Function backgroundColor (_value As Integer) As Integer

Parameters

_value
Int32

The value to assign as the background color of the control; optional. This can be one of the values from the control"s color scheme or a Winapi::RGB2int value.

Returns

Int32

Applies to

backgroundColor()

Gets or sets the background color of the control.

public:
 virtual int backgroundColor();
public virtual int backgroundColor ();
abstract member backgroundColor : unit -> int
override this.backgroundColor : unit -> int
Public Overridable Function backgroundColor () As Integer

Returns

Int32

An integer that contains a packed RGB color.

Remarks

The integer that is returned contains the RGB color as follows:

  • The low-order byte contains a value for the relative intensity of red.
  • The second byte contains a value for green.
  • The third byte contains a value for blue.
  • The high-order byte must be 0 (zero).
  • The maximum value for a single byte is 255.

The following example shows how to return and set the background color for a control.

// Retrieve the existing background color. 
info (strfmt("Background color: %1", this.backgroundColor())); 
// Set the background color. 
this.backgroundColor(WindowsPalette::DarkShadow3D);

Applies to