Class UserPlaceableObject

Namespace

Root.ReportNet.Pdf.Tools

Assembly

ReportNet.dll

The UserPlaceableObject class serves as an abstract foundation for positioning and aligning report objects on a page. It represents a report object that can be placed and aligned on a page, whereby the properties can be set directly using code or they can be taken from another source as an input mask or a configuration dataset. For instance, by providing an input mask or configuration dataset, program users can customize the positioning of the objects within the page's header themselves. For more information, see the example Alignment of Header Objects.

public abstract class UserPlaceableObject

Inheritance

object

UserPlaceableObject

Derived

UserPlaceableImage

UserPlaceableText

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Examples

Example using class UserPlaceableText which is derived from this class.

public class ExampleReport : HeaderFooterReport {
  public ExampleReport() {
    Title = new UserPlaceableText("Example Report", TextFont, 0, AlignHor.Left, -50, AlignVert.Top);
  }

Remarks

This class is abstract and is intended to be subclassed by specific report objects that require precise positioning and alignment in a PDF document's layout. The positions and sizes can be specified in both points and millimeters, allowing for flexibility in layout design.

Properties

AlignHor

Gets or sets the horizontal alignment of the object. It defines the alignment of the object in relation to the X-coordinate.

public AlignHor AlignHor { get; set; }

Property Value

AlignHor

The horizontal alignment value.

AlignVert

Gets or sets the vertical alignment of the object. It defines the alignment of the object in relation to the Y-coordinate.

public AlignVert AlignVert { get; set; }

Property Value

AlignVert

The vertical alignment value.

RelativeAlignHor

Gets or sets which side of the relative object is used for the horizontal alignment.

public AlignHor RelativeAlignHor { get; set; }

Property Value

AlignHor

The horizontal alignment value.

RelativeAlignVert

Gets or sets which side of the relative object is used for the vertical alignment.

public AlignVert RelativeAlignVert { get; set; }

Property Value

AlignVert

The vertical alignment value.

RelativeObjectHor

Gets or sets the report object that is the reference for horizontal positioning.

public UserPlaceableObject? RelativeObjectHor { get; set; }

Property Value

UserPlaceableObject

The UserPlaceableObject object that is the reference for horizontal positioning. If the value is null, the positioning is absolute.

RelativeObjectVert

Gets or sets the report object that is the reference for vertical positioning.

public UserPlaceableObject? RelativeObjectVert { get; set; }

Property Value

UserPlaceableObject

The UserPlaceableObject object that is the reference for vertical positioning. If the value is null, the positioning is absolute.

X

Gets or sets the horizontal position of the object in points. If the relative object RelativeObjectHor is set, the position is relative to the relative object, otherwise it is an absolute position.

public double X { get; set; }

Property Value

double

The horizontal position of the object in points.

Xmm

Gets or sets the horizontal position of the object in millimeters. If the relative object RelativeObjectHor is set, the position is relative to the relative object, otherwise it is an absolute position.

public double Xmm { get; set; }

Property Value

double

The horizontal position of the object in millimeters.

Y

Gets or sets the vertical position of the object in points. If the relative object RelativeObjectVert is set, the position is relative to the relative object, otherwise it is an absolute position.

public double Y { get; set; }

Property Value

double

The vertical position of the object in points.

Ymm

Gets or sets the vertical position of the object in millimeters. If the relative object RelativeObjectVert is set, the position is relative to the relative object, otherwise it is an absolute position.

public double Ymm { get; set; }

Property Value

double

The vertical position of the object in millimeters.

See Also

Example: Alignment of Header Objects