Set image size limits Leave feedback

The HtmlViewOptions class has the following properties to set the image width or/and height:

/// <summary>
/// Max width of an output image in pixels.
/// </summary>
public int ImageMaxWidth { get; set; }

/// <summary>
/// Max height of an output image in pixels.
/// </summary>
public int ImageMaxHeight { get; set; }

/// <summary>
/// The width of the output image in pixels.
/// </summary>
public int ImageWidth { get; set; }

/// <summary>
/// The height of an output image in pixels.
/// </summary>
public int ImageHeight { get; set; }

VB.NET

Class SurroundingClass
    ''' <summary>
    ''' Max width of an output image in pixels.
    ''' </summary>
    Public Property ImageMaxWidth As Integer

    ''' <summary>
    ''' Max height of an output image in pixels.
    ''' </summary>
    Public Property ImageMaxHeight As Integer

    ''' <summary>
    ''' The width of the output image in pixels.
    ''' </summary>
    Public Property ImageWidth As Integer

    ''' <summary>
    ''' The height of an output image in pixels.
    ''' </summary>
    Public Property ImageHeight As Integer
End Class

You can set the width and/or height of the output images. Use one of the following methods:

To render a single image, set ImageWidth/ImageHeight options.
To render multiple images, set ImageMaxWidth/ImageMaxHeight options. If an image exceeds these limits, it is resized proportionally.

Warning
If you set the ImageWidth/ImageHeight options, the ImageMaxWidth/ImageMaxHeight options are ignored.

To set the ImageMaxWidth/ImageMaxHeight options, follow these steps:

Instantiate the Viewer object.
Instantiate the HtmlViewOptions object.
Set the ImageMaxWidth and/or ImageMaxHeight values;
Call the View method.

The following code snippet shows how to set the output image size limits:

using GroupDocs.Viewer;
using GroupDocs.Viewer.Options;
// ...

using (Viewer viewer = new Viewer("sample.jpeg"))
{
    // Create view options.
    var viewOptions = HtmlViewOptions.ForEmbeddedResources();
    // Specify the maximum width and height.
    viewOptions.ImageMaxWidth = 800;
    viewOptions.ImageMaxHeight = 600;
    viewer.View(viewOptions);
}

VB.NET

Imports GroupDocs.Viewer
Imports GroupDocs.Viewer.Options
' ...

Module Program
    Sub Main(args As String())
        Using viewer As Viewer = New Viewer("sample.jpeg")
            ' Create view options.
            Dim viewOptions = HtmlViewOptions.ForEmbeddedResources()
            ' Specify the maximum width and height.
            viewOptions.ImageMaxWidth = 800
            viewOptions.ImageMaxHeight = 600
            viewer.View(viewOptions)
        End Using
    End Sub
End Module

We value your opinion. Your feedback will help us improve our documentation.

Set image size limits Leave feedback

Was this page helpful?

Any additional feedback you'd like to share with us?

Please tell us how we can improve this page.

Thank you for your feedback!