View as Markdown

You’re viewing outdated documentation. View the latest Customer’s Canvas On-Premises documentation.

BuildCanvas Method

Applies to: Customer's Canvas On-Premises; Design Atoms .NET 6.0.0, 6.x (may differ) · Archived documentation

Creates a canvas for rendering.

Namespace: Aurigma.DesignAtoms.Rendering
Assembly: Aurigma.DesignAtoms (in Aurigma.DesignAtoms.dll)

Syntax

C#

public ICanvas BuildCanvas(
	Surface surface,
	PrintArea printArea,
	WatermarkConfig watermarkConfig,
	CanvasBuilderSettings settings,
	SurfaceContainer renderedContainer,
	Func<ICanvasRenderer> getRendererFactoryMethod
)

Parameters

surface: Type: Aurigma.DesignAtoms.Model.Surface
A Surface to render.

printArea: Type: Aurigma.DesignAtoms.Model.PrintArea
A PrintArea to render.

watermarkConfig: Type: Aurigma.DesignAtoms.Configuration.WatermarkConfig
Configuration of watermarks.

settings: Type: Aurigma.DesignAtoms.Rendering.CanvasBuilderSettings
Settings of the canvas builder. The default value is null.

renderedContainer: Type: Aurigma.DesignAtoms.Model.SurfaceContainer
A container to render. You can use this parameter to render all items from the specified container. If you skip this parameter, the resulting canvas contains the entire Surface including safety lines and watermarks. The default value is null.

getRendererFactoryMethod: Type: System.Func<ICanvasRenderer>
A callback function that redefines the RenderWorkspace method. The default value is null.

Return Value

The resulting canvas.

Implements

ICanvasBuilder.BuildCanvas(Surface, PrintArea, WatermarkConfig, CanvasBuilderSettings, SurfaceContainer, Func<ICanvasRenderer>)

See Also

Reference