SetSelectionMode method

Subsequent mouse selection by the user is performed in the specified mode.

Method

short SetSelectionMode(

short Mode )

Parameters

Mode

Specifies the new selection mode. This must be one of the following selection mode values found in ARSOLEEX.H:

  ARS_OLE_SELECTION_MODE_NONE
  ARS_OLE_SELECTION_MODE_AREA
  ARS_OLE_SELECTION_MODE_TEXT

ARS_OLE_SELECTION_MODE_NONE specifies that the user cannot select a portion of the document with the mouse. This is the default mode when a document is opened. Setting this mode removes any existing selection.

ARS_OLE_SELECTION_MODE_AREA specifies that user selection is performed in the same manner as Options > Selection Mode > Area with the OnDemand Client.

ARS_OLE_SELECTION_MODE_TEXT specifies that user selection is performed in the same manner as Options > Selection Mode > Text with the OnDemand Client.

Description

Subsequent mouse selection by the user is performed in the specified mode.

Return Value

Refer to return codes.

See Also

CopyBitmap and CopyText methods

C/C + +

The following example sets the selection mode to area selection.

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

Visual Basic

Dim rc As Integer

 .
 .

rc = ArsOle.SetSelectionMode (ARS_OLE_SELECTION_MODE_AREA)
If rc <> ARS_OLE_RC_SUCCESS Then
   MsgBox "ERROR"
   End
End If

 .
 .