SetDocBackgroundColor method

The document is displayed with the new background color.

Method

short SetDocBackgroundColor(

short color )

Parameters

Color

Specifies the new document background color. This must be one of the following color values found in ARSOLEEX.H:

  ARS_OLE_COLOR_WHITE
  ARS_OLE_COLOR_BLACK
  ARS_OLE_COLOR_RED
  ARS_OLE_COLOR_BLUE
  ARS_OLE_COLOR_GREEN
  ARS_OLE_COLOR_YELLOW
  ARS_OLE_COLOR_GRAY

Description

The document is displayed with the new background color.

Return Value:

Refer to return codes.

See Also

GetDocBackgroundColor method

C/C + +

The following example sets the document background color to gray.

 CArsOle * pArsCtrl;
 short rc;
   .
   .
 rc = pArsCtrl->SetDocBackgroundColor( ARS_OLE_COLOR_GRAY );
 if ( rc != ARS_OLE_RC_SUCCESS )
   ERROR;
   .
   .

Visual Basic

Dim rc As Integer

 .
 .

rc = ArsOle.SetDocBackgroundColor (ARS_OLE_COLOR_GRAY)
If rc <> ARS_OLE_RC_SUCCESS Then
   MsgBox "ERROR"
   End
End If

 .
 .