Class UserPlaceableTextMM

Namespace

Root.ReportNet.Pdf.Tools

Assembly

ReportNet.dll

Represents a text object that can be placed and aligned on a page in millimeters, 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 text objects within the page's header themselves. For more information, see the example Alignment of Header Objects.

public class UserPlaceableTextMM : UserPlaceableText

Inheritance

object

UserPlaceableObject

UserPlaceableText

UserPlaceableTextMM

Inherited Members

UserPlaceableText.Text

UserPlaceableText.Font

UserPlaceableText.Width

UserPlaceableText.WidthMM

UserPlaceableText.TextOptions

UserPlaceableObject.X

UserPlaceableObject.Xmm

UserPlaceableObject.AlignHor

UserPlaceableObject.RelativeObjectHor

UserPlaceableObject.RelativeAlignHor

UserPlaceableObject.Y

UserPlaceableObject.Ymm

UserPlaceableObject.AlignVert

UserPlaceableObject.RelativeObjectVert

UserPlaceableObject.RelativeAlignVert

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Examples

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

Constructors

UserPlaceableTextMM(FontProp, double, AlignHor, double, AlignVert, double)

Initializes a new instance of the UserPlaceableTextMM class with specified font, positioning and alignment in millimeters. As the text is not set, this element is not displayed as long as the Text property is not set.

public UserPlaceableTextMM(FontProp font, double xMM, AlignHor alignHor, double yMM, AlignVert alignVert, double widthMM = 1.7976931348623157E+308)

Parameters

font FontProp

The font for the text.

xMM double

The horizontal position of the text in millimeters.

alignHor AlignHor

The horizontal alignment of the text.

yMM double

The vertical position of the text in millimeters.

alignVert AlignVert

The vertical alignment of the text.

widthMM double

The width of the text area in millimeters. Defaults to MaxValue, indicating no width constraint.

Remarks

The default of property TextOptions is set to AdjustWidth and SmallerFontIfToolLong.

Exceptions

ArgumentNullException

The font parameter is null.

UserPlaceableTextMM(string, FontProp, double, AlignHor, double, AlignVert, double)

Initializes a new instance of the UserPlaceableTextMM class with specified text, font, positioning and alignment in millimeters.

public UserPlaceableTextMM(string text, FontProp font, double xMM, AlignHor alignHor, double yMM, AlignVert alignVert, double widthMM = 1.7976931348623157E+308)

Parameters

text string

The text content. The formatting options of the text are explained in class RepText, e.g. This is an <i>italic title</i>.

font FontProp

The font for the text.

xMM double

The horizontal position of the text in millimeters.

alignHor AlignHor

The horizontal alignment of the text.

yMM double

The vertical position of the text in millimeters.

alignVert AlignVert

The vertical alignment of the text.

widthMM double

The width of the text area in millimeters. Defaults to MaxValue, indicating no width constraint.

Remarks

The default of property TextOptions is set to AdjustWidth and SmallerFontIfToolLong.

Exceptions

ArgumentNullException

The text or font parameters are null.

See Also

Example: Alignment of Header Objects