Skip to content

Canvas::RenderPage method

Render a page to the canvas using default options.

Overloads

RenderPage(Page) Render a page to the canvas using default options.
RenderPage(Page, string) Render a page to the canvas using the specified options.
RenderPage(Page, string, RenderPageProperties) Render the page to the canvas with the specified properties.

RenderPage(Page)

Prototype

void RenderPage(Page page)

void RenderPage(Page page) throws IGRException;

def RenderPage(self, page: Page) -> void

void RenderPage(Page page)

void RenderPage(Page page)

HRESULT RenderPage([in] Page* page)

Parameters

page: Page : The page to be rendered

RenderPage(Page, string)

Prototype

void RenderPage(Page page, string options)

void RenderPage(Page page, string options) throws IGRException;

def RenderPage(self, page: Page, options: string) -> void

void RenderPage(Page page, const std::wstring& options)

void RenderPage(Page page, std::wstring options)

HRESULT RenderPage([in] Page* page, [in] BSTR options)

Parameters

page: Page : The page to be rendered

options: string : Canvas processing options to use when creating the new page.

RenderPage(Page, string, RenderPageProperties)

Prototype

void RenderPage(Page page, string options, RenderPageProperties renderPageProperties)

void RenderPage(Page page, string options, RenderPageProperties renderPageProperties) throws IGRException;

def RenderPage(self, page: Page, options: string, renderPageProperties: RenderPageProperties) -> void

void RenderPage(Page page, const std::wstring& options, RenderPageProperties renderPageProperties)

Parameters

page: Page : The page to render.

options: string : Canvas options to use when rendering page.

renderPageProperties: RenderPageProperties : Render properties to use when rendering the page.

Sample Code

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
using Hyland.DocumentFilters;

var api = new Hyland.DocumentFilters.Api();
api.Initialize("License Code", ".");

using var doc = api.OpenExtractor("filename.doc", OpenMode.Paginated);

foreach (var page in doc.Pages)
{
    using (page)
    {
        using var canvas = api.MakeOutputCanvas($"page-{page.Index+1}.png", CanvasType.PNG);

        var renderPageProperties = new RenderPageProperties();
        renderPageProperties.AddFormValue("FormKey", "NewFormValue", true);

        canvas.RenderPage(page, "", renderPageProperties);
    }
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
#include <DocumentFiltersObjects.h>

int main() {
    try {
        // Create and initialize the API object
        Hyland::DocFilters::Api api;
        api.Initialize("License Code", ".");

        // Open the input file
        Hyland::DocFilters::Extractor doc = api.OpenExtractor("filename.doc", Hyland::DocFilters::OpenMode::Paginated);

        // Create the output canvas 
        Hyland::DocFilters::Canvas canvas = api.MakeOutputCanvas("output.pdf", Hyland::DocFilters::CanvasType::PDF);

        Hyland::DocFilters::RenderPageProperties renderProps;
        renderProps.AddFormValue(L"FormKey", L"NewFormValue", true);

        // Render all pages to the output
        for (auto page : doc.pages()) {
            canvas.RenderPage(page, renderProps);
        }
    } catch (const std::exception& e) {
        std::cerr << "Error: " << e.what() << std::endl;
        return 1; // Indicate an error
    }

    return 0; // Successful execution
}