Skip to content

PDFRectilinearMeasure

Namespace: O2S.Components.PDF4NET.Spatial

Defines a rectilinear measure.

public class PDFRectilinearMeasure : PDFMeasure

Inheritance ObjectPDFMeasurePDFRectilinearMeasure

Remarks

The rectilinear measure defines a rectilinear coordinate system. A rectilinear coordinate system is defined as one in which the x and y axes are perpendicular and have units that increment linearly (to the right and up, respectively).

Constructors

PDFRectilinearMeasure()

Initializes a new PDFRectilinearMeasure object.

public PDFRectilinearMeasure()

Properties

Angle

Gets or sets the number formats for angles.

public PDFNumberFormatCollection Angle { get; set; }

Property Value

PDFNumberFormatCollection
A number format collection for measurement of angles.

Remarks

The first element in the collection shall specify the conversion to the largest angle unit from degrees. The scale factor from PDFRectilinearMeasure.CXY (if present) shall be used to convert from default PDF units to the appropriate units before applying the angle function.


Area

Gets or sets the number formats for area.

public PDFNumberFormatCollection Area { get; set; }

Property Value

PDFNumberFormatCollection
A number format collection for measurement of area.

Remarks

The first element in the collection shall specify the conversion to the largest area unit from units represented by the first element in PDFRectilinearMeasure.X, squared. The scale factors from PDFRectilinearMeasure.X, PDFRectilinearMeasure.Y (if present) and PDFRectilinearMeasure.CXY (if PDFRectilinearMeasure.Y is present) shall be used to convert from default PDF units to the appropriate units before applying the area function.


CXY

Gets or sets the conversion factor.

public double CXY { get; set; }

Property Value

Double
A factor that shall be used to convert the largest units along the y axis to the largest units along the x axis.

Remarks

It shall be used for calculations (distance, area, and angle) where the units are be equivalent; if not specified, these calculations may not be performed.


Distance

Gets or sets the number formats for distance.

public PDFNumberFormatCollection Distance { get; set; }

Property Value

PDFNumberFormatCollection
A number format collection for measurement of distance in any direction.

Remarks

The first element in the collection shall specify the conversion to the largest distance unit from units represented by the first element in PDFRectilinearMeasure.X. The scale factors from PDFRectilinearMeasure.X, PDFRectilinearMeasure.Y (if present) and PDFRectilinearMeasure.CXY (if PDFRectilinearMeasure.Y is present) shall be used to convert from default PDF units to the appropriate units before applying the distance function.


Origin

Gets or sets the origin of the measurement coordinate system.

public PDFPoint Origin { get; }

Property Value

PDFPoint
A point that specifies the origin of the measurement coordinate system in default PDF coordinate system (the same coordinate system used for defining the PDFViewport.Bounds.)


ScaleRatio

Gets or sets the scale ratio.

public string ScaleRatio { get; set; }

Property Value

String
A text string expressing the scale ratio of the drawing in the region corresponding to this object.

Remarks

Universally recognized unit abbreviations should be used, either matching those of the number format collections in this object or those of commonly used scale ratios.
For example: ¼ in = 1 ft


Slope

Gets or sets the number formats for slopes.

public PDFNumberFormatCollection Slope { get; set; }

Property Value

PDFNumberFormatCollection
A number format collection for measurement of the slope of a line.

Remarks

The first element in the collection shall specify the conversion to the largest slope unit from units represented by the first element in PDFRectilinearMeasure.Y divided by the first element in PDFRectilinearMeasure.X. The scale factors from PDFRectilinearMeasure.X, PDFRectilinearMeasure.Y (if present) and PDFRectilinearMeasure.CXY (if PDFRectilinearMeasure.Y is present) shall be used to convert from default PDF units to the appropriate units before applying the slope function.


X

Gets or sets the number formats for X axis.

public PDFNumberFormatCollection X { get; set; }

Property Value

PDFNumberFormatCollection
A number format collection for measurement of change along the x axis and, if PDFRectilinearMeasure.Y is not present, along the y axis as well.

Remarks

The first element in the array shall contain the scale factor for converting from default user space units to the largest units in the measuring coordinate system along that axis.


Y

Gets or sets the number formats for Y axis.

public PDFNumberFormatCollection Y { get; set; }

Property Value

PDFNumberFormatCollection
A number format collection for measurement of change along the y.

Remarks

The first element in the array shall contain the scale factor for converting from default user space units to the largest units in the measuring coordinate system along the Y axis.