Platforms to show: All Mac Windows Linux Cross-Platform

Back to WindowsPDFPageMBS class.

WindowsPDFPageMBS.Constructor   Private

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Windows PDF MBS WinFrameworks Plugin 23.2 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
The private constructor.

See also:

WindowsPDFPageMBS.Constructor(other as WindowsPDFPageMBS)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Windows PDF MBS WinFrameworks Plugin 23.2 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
The copy constructor.

See also:

WindowsPDFPageMBS.Destructor

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Windows PDF MBS WinFrameworks Plugin 23.2 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
The destructor.

WindowsPDFPageMBS.RenderToMemory(Handler as RenderToMemoryFinishedMBS, Options as WindowsPDFPageRenderOptionsMBS = nil)   New in 24.0

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Windows PDF MBS WinFrameworks Plugin 24.0 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Requests asynchronous rendering of the page.

Calls the handler delegate later with results (or error code).
Produces a MemoryBlock with image data, which you can pass to Picture.FromData to get as picture.

Asynchronous mode will perform the work on a different thread in the background.

See also:

WindowsPDFPageMBS.RenderToMemory(Options as WindowsPDFPageRenderOptionsMBS = nil) as MemoryBlock   New in 24.0

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Windows PDF MBS WinFrameworks Plugin 24.0 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Outputs a stream of data, which represents a Portable Document Format (PDF) page's contents as image.

Takes a set of display settings, applies them to the output of a Portable Document Format (PDF) page's contents, and creates a stream with the customized, rendered output as an synchronous action. This asynchronous action can be used to create a customized display image of the Portable Document Format (PDF) page.

Please call RenderToStream if you need image as string, call RenderToMemory if you need a MemoryBlock and call RenderToPicture if you need a picture.

See also:

WindowsPDFPageMBS.RenderToPicture(Options as WindowsPDFPageRenderOptionsMBS = nil) as Picture   New in 24.0

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Windows PDF MBS WinFrameworks Plugin 24.0 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Outputs a stream of data, which represents a Portable Document Format (PDF) page's contents as image.
Example
Dim page As WindowsPDFPageMBS = List.RowTagAt(index)
Dim options As New WindowsPDFPageRenderOptionsMBS

if out.Width > out.Height then
options.DestinationWidth = out.Width * 2
else
options.DestinationHeight = out.Height * 2
end if

options.setBitmapEncoderJPEG

currentimage = page.RenderToPicture(options)
out.Refresh // refresh canvas to show the picture

Takes a set of display settings, applies them to the output of a Portable Document Format (PDF) page's contents, and creates a stream with the customized, rendered output as an synchronous action.
Provides the resulting stream as picture for Xojo.

Please call RenderToStream if you need image as string, call RenderToMemory if you need a MemoryBlock and call RenderToPicture if you need a picture.

WindowsPDFPageMBS.RenderToStream(Handler as RenderToStreamFinishedMBS, Options as WindowsPDFPageRenderOptionsMBS = nil)   New in 24.0

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Windows PDF MBS WinFrameworks Plugin 24.0 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Requests asynchronous rendering of the page.
Example
Dim page As WindowsPDFPageMBS // current page
page.RenderToStream AddressOf RenderToStreamFinished

Calls the handler delegate later with results (or error code).
Produces a string with the image data.

Asynchronous mode will perform the work on a different thread in the background.

See also:

Some examples using this method:

WindowsPDFPageMBS.RenderToStream(Options as WindowsPDFPageRenderOptionsMBS = nil) as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Windows PDF MBS WinFrameworks Plugin 23.2 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Outputs a stream of data, which represents a Portable Document Format (PDF) page's contents as image.
Example
Dim page As WindowsPDFPageMBS // your page
Dim options As New WindowsPDFPageRenderOptionsMBS

if out.Width > out.Height then
options.DestinationWidth = out.Width * 2
else
options.DestinationHeight = out.Height * 2
end if

options.setBitmapEncoderJPEG

dim data as string = page.RenderToStream(options)
if data.Bytes > 0 then
currentimage = Picture.FromData(data)
out.Refresh // refresh canvas to show the picture
end if

Takes a set of display settings, applies them to the output of a Portable Document Format (PDF) page's contents, and creates a stream with the customized, rendered output as an synchronous action. This asynchronous action can be used to create a customized display image of the Portable Document Format (PDF) page.

Please call RenderToStream if you need image as string, call RenderToMemory if you need a MemoryBlock and call RenderToPicture if you need a picture.

See also:

The items on this page are in the following plugins: MBS WinFrameworks Plugin.


The biggest plugin in space...