StiUnit Class

Namespace: Stimulsoft.Report.Units

Report units.

Properties

Property Type Description
Factor double Gets the ruler scale in hundredths of inch on the one step.
RollerStep double Gets ruler step.
ShortName string Gets the shor unit name.

Methods

Method Returns Description
ConvertFromHInches (+5 overloads) double Converts a value from hundredths of inch into units of this class.
ConvertToHInches (+5 overloads) double Converts a value from hundredths of inch into units of this class.
GetUnitFromReportUnit static StiUnit  
LoadFromJsonObject static StiUnit  
SaveToJsonObject static JObject  

Method Details

ConvertFromHInches

ConvertFromHInches(value: double): double

Converts a value from hundredths of inch into units of this class.

Parameters

  • value (double) — Value for conversion.

Returns double — Converted value.


ConvertFromHInches(value: decimal): decimal

Converts a value from hundredths of inch into units of this class.

Parameters

  • value (decimal) — Value for conversion.

Returns decimal — Converted value.


ConvertFromHInches(rect: RectangleD): RectangleD

Converts a rectangle from hundredths of inch into units of this class.

Parameters

Returns RectangleD — Converted rectangle.


ConvertFromHInches(rect: RectangleM): RectangleM

Converts a rectangle from hundredths of inch into units of this class.

Parameters

Returns RectangleM — Converted rectangle.


ConvertFromHInches(size: SizeD): SizeD

Converts a size from hundredths of inch into units of this class.

Parameters

  • size (SizeD) — Size for conversion.

Returns SizeD — Converted size.


ConvertFromHInches(size: SizeM): SizeM

Converts a size from hundredths of inch into units of this class.

Parameters

  • size (SizeM) — Size for conversion.

Returns SizeM — Converted size.


ConvertToHInches

ConvertToHInches(value: double): double

Converts a value from hundredths of inch into units of this class.

Parameters

  • value (double) — Value for conversion.

Returns double — Converted value.


ConvertToHInches(value: decimal): decimal

Converts a value from hundredths of inch into units of this class.

Parameters

  • value (decimal) — Value for conversion.

Returns decimal — Converted value.


ConvertToHInches(rect: RectangleD): RectangleD

Converts a rectangle from units of this class into hundredths of inch.

Parameters

Returns RectangleD — Converted rectangle.


ConvertToHInches(rect: RectangleM): RectangleM

Converts a rectangle from units of this class into hundredths of inch.

Parameters

Returns RectangleM — Converted rectangle.


ConvertToHInches(size: SizeD): SizeD

Converts a size from units of this class into hundredths of inch.

Parameters

  • size (SizeD) — Size for conversion.

Returns SizeD — Converted size.


ConvertToHInches(size: SizeM): SizeM

Converts a size from units of this class into hundredths of inch.

Parameters

  • size (SizeM) — Size for conversion.

Returns SizeM — Converted size.


GetUnitFromReportUnit static

GetUnitFromReportUnit(reportUnit: StiReportUnitType): StiUnit

Parameters

Returns StiUnit


LoadFromJsonObject static

LoadFromJsonObject(jObject: JObject): StiUnit

Parameters

Returns StiUnit


SaveToJsonObject static

SaveToJsonObject(unit: StiUnit): JObject

Parameters

Returns JObject

Fields

Field Type Description
Centimeters StiCentimetersUnit  
HundredthsOfInch StiHundredthsOfInchUnit  
Inches StiInchesUnit  
Millimeters StiMillimetersUnit