GemBox.Pdf
  • Overview
  • Examples
  • Free version
  • Support
  • Pricelist

    Show / Hide Table of Contents

    PdfRectangle Class

    Namespace:
    GemBox.Pdf
    Assembly:
    GemBox.Pdf.dll

    Represents a rectangle used to describe locations on a page and bounding boxes for a variety of objects.

    • C#
    • VB.NET
    public sealed class PdfRectangle : PdfObject, IEquatable<PdfRectangle>
    Public NotInheritable Class PdfRectangle
        Inherits PdfObject
        Implements IEquatable(Of PdfRectangle)
    Inheritance:
    System.Object
    PdfObject
    PdfRectangle
    Implements
    System.IEquatable<PdfRectangle>

    Properties

    Bottom

    Gets the bottom Y coordinate of the rectangle.

    • C#
    • VB.NET
    public double Bottom { get; }
    Public ReadOnly Property Bottom As Double
    Property Value
    System.Double

    The bottom Y coordinate of the rectangle.

    Height

    Gets the height of the rectangle.

    • C#
    • VB.NET
    public double Height { get; }
    Public ReadOnly Property Height As Double
    Property Value
    System.Double

    The height of the rectangle.

    Left

    Gets the left X coordinate of the rectangle.

    • C#
    • VB.NET
    public double Left { get; }
    Public ReadOnly Property Left As Double
    Property Value
    System.Double

    The left X coordinate of the rectangle.

    Right

    Gets the right X coordinate of the rectangle.

    • C#
    • VB.NET
    public double Right { get; }
    Public ReadOnly Property Right As Double
    Property Value
    System.Double

    The right X coordinate of the rectangle.

    Top

    Gets the top Y coordinate of the rectangle.

    • C#
    • VB.NET
    public double Top { get; }
    Public ReadOnly Property Top As Double
    Property Value
    System.Double

    The top Y coordinate of the rectangle.

    Width

    Gets the width of the rectangle.

    • C#
    • VB.NET
    public double Width { get; }
    Public ReadOnly Property Width As Double
    Property Value
    System.Double

    The width of the rectangle.

    Methods

    Equals(PdfRectangle)

    Determines whether the other PdfRectangle is equal to this PdfRectangle instance.

    • C#
    • VB.NET
    public bool Equals(PdfRectangle other)
    Public Function Equals(other As PdfRectangle) As Boolean
    Parameters
    other
    PdfRectangle

    The other rectangle to compare with this rectangle instance.

    Returns
    System.Boolean

    true if the other PdfRectangle is equal to this PdfRectangle instance; otherwise, false.

    Equals(Object)

    Determines whether the specified System.Object is equal to this PdfRectangle instance.

    • C#
    • VB.NET
    public override bool Equals(object obj)
    Public Overrides Function Equals(obj As Object) As Boolean
    Parameters
    obj
    System.Object

    The System.Object to compare with this PdfRectangle instance.

    Returns
    System.Boolean

    true if the specified System.Object is equal to this PdfRectangle instance; otherwise, false.

    Overrides
    System.Object.Equals(System.Object)

    GetHashCode()

    Returns a hash code for this PdfRectangle instance.

    • C#
    • VB.NET
    public override int GetHashCode()
    Public Overrides Function GetHashCode As Integer
    Returns
    System.Int32

    A hash code for this PdfRectangle instance, suitable for use in hashing algorithms and data structures like a hash table.

    Overrides
    System.Object.GetHashCode()

    ToString()

    Returns a System.String that represents this PdfRectangle instance.

    • C#
    • VB.NET
    public override string ToString()
    Public Overrides Function ToString As String
    Returns
    System.String

    A System.String that represents this PdfRectangle instance.

    Overrides
    System.Object.ToString()
    Remarks

    This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

    Inherited Properties

    Metadata

    (Optional; PDF 1.4) A metadata stream containing metadata for the component.

    (Inherited from PdfObject)

    Implements

    System.IEquatable<T>

    Extension Methods

    PdfObjectExtensions.GetDictionary(PdfObject)
    PdfObjectExtensions.GetOrAddDictionary(PdfObject)
    PdfObjectExtensions.GetArray(PdfObject)

    See Also

    PDF Specification ISO 32000-1:2008, section '7.9.5 Rectangles'
    Back to top

    Facebook • Twitter • LinkedIn

    © GemBox Ltd. — All rights reserved.