BeginClipPath Method

Summary

Sets the current path in the context as a clipping path.

Syntax

Java

Objective-C

C++

protected virtual object BeginClipPath()

Protected Overridable Function BeginClipPath() As Object

- (void)beginClipPath

protected Object beginClipPath()

protected:  
   virtual Object^ BeginClipPath()

Return Value

The path state. This value must be passed to EndClipPath.

Remarks

Some object renderers require that a clipping path be set in context in order to perform the rendering. These objects call the BeginClipPath method to notify a derived class that a clipping path has been set. The object then calls the EndClipPath method when the clipping path is removed. Between BeginClipPath and EndClipPath, the value of the ClipPath property gets set to true. Derived classes can check the value of this property to detect when the context has a clipping path.

Requirements

Target Platforms