TcxCanvas.SetClipRegion(TcxRegion,TcxRegionOperation,Boolean,Boolean) Method

Defines or changes the clip region for the canvas.

Declaration

procedure SetClipRegion(ARegion: TcxRegion; AOperation: TcxRegionOperation; ADestroyRegion: Boolean = True; AConsiderOrigin: Boolean = True);

Parameters

Name	Type
ARegion	TcxRegion
AOperation	TcxRegionOperation
ADestroyRegion	Boolean
AConsiderOrigin	Boolean

Remarks

Call this procedure and pass a source region as the ARegion parameter to set a new or change an existing clip region for the canvas. Use the AOperation parameter to switch between two different modes of the SetClipRegion procedure:

• Pass roSet as the parameter. The procedure uses the source region to define a new clip region for the canvas.

• Pass any other TcxRegionOperation value as the parameter. The procedure uses the source region to update an existing clip region according to the selected operation.

The optional ADestroyRegion parameter defines if the SetClipRegion procedure destroys the source region. Pass False as this parameter to retain the source region.

The optional AConsiderOrigin parameter defines if the updated clip region’s position shifts horizontally and/or vertically according to the DCOrigin property value. Pass False as this parameter to ignore the canvas origin.