RenderOnCanvas Method

public IAsyncOperation<RenderTargetBitmap> RenderOnCanvas( 
   AnnContainer container,
   Canvas inputCanvas
)

'Declaration
 

Public Function RenderOnCanvas( _
   ByVal container As AnnContainer, _
   ByVal inputCanvas As Canvas _
) As IAsyncOperation(Of RenderTargetBitmap)

'Usage
 

Dim instance As AnnD2DRenderingEngine
Dim container As AnnContainer
Dim inputCanvas As Canvas
Dim value As IAsyncOperation(Of RenderTargetBitmap)
 
value = instance.RenderOnCanvas(container, inputCanvas)

public IAsyncOperation<RenderTargetBitmap> RenderOnCanvas( 
   AnnContainer container,
   Canvas inputCanvas
)

 function Leadtools.Annotations.Rendering.AnnD2DRenderingEngine.RenderOnCanvas( 
   container ,
   inputCanvas 
)

Parameters

container

The source AnnContainer to be rendered.

inputCanvas

The source Canvas.

RenderOnCanvas can be used to quickly render an annotation to a destination RenderTargetBitmap. The method will automatically render the objects of the container fitted into the rectangle created by the image width and height keeping the aspect ratio. This method does not erase the content of the image, instead the objects are rendered on top of the existing pixel data.

The method can be used to quickly accomplish the following:

• Render the container on a smaller image, for example to create a thumbnail: Create a smaller version of the original image at the desired size and then pass it to RenderOnCanvas.

• Render the container on an image used for printing. Create a temporary image, renders the container on it and then print the result image.

• Render the container on an image for saving to an external file or taking a screenshot of the current container.

RenderState can be used to control what state parts of the annotation objects are rendered. For example, you may choose not to render the lock or content pictures when creating a thumbnail, save the original value of RenderState, set it to AnnRenderState.None, call RenderOnCanvas and then re-set the original value.

This method returns the same inputCanvas reference.

Target Platforms

Reference

AnnD2DRenderingEngine Class
AnnD2DRenderingEngine Members