Extract the number of frames from the image data.

Namespace: TallComponents.PDF.Layout.Shapes
Assembly: TallComponents.PDF.Layout (in TallComponents.PDF.Layout.dll) Version: 3.0.63.0

Syntax

C#
public static int GetFrameCount(
	string path,
	Object sender,
	GetWebCredentialsEventHandler getWebCredentials
)
Visual Basic
Public Shared Function GetFrameCount ( _
	path As String, _
	sender As Object, _
	getWebCredentials As GetWebCredentialsEventHandler _
) As Integer

Parameters

path
Type: System..::..String
The path to the image. May be a file path or a URL.
sender
Type: System..::..Object
The sender for the GetWebCredentials event.
getWebCredentials
Type: TallComponents.PDF.Layout..::..GetWebCredentialsEventHandler
The event handlers to query for the web credentials.

Return Value

Number of frames in this image.

Examples

VB.NET
CopyC#
' Get the number of frames
Dim frameCount As Integer = ImageShape.GetFrameCount( path )
Dim index As Integer

For index = 0 To frameCount - 1
   ' Load the image for the frame
   Dim image as ImageShape = New ImageShape(path, index)

   'Create new page and append to document
   Dim page As New Page(image.Width, image.Height)
   document.Pages.Append(page)
   page.VisualOverlay.Add(image)
Next index

See Also