org.pdfclown.documents.contents.composition.Length Class Reference

Distance measure. More...

List of all members.

Public Types
enum	UnitModeEnum { Absolute, Relative }
	Measurement mode. More...
Public Member Functions
double	GetValue (double baseValue)
	Gets the resolved distance value.
	Length (double value, UnitModeEnum unitMode)
override string	ToString ()
Properties
UnitModeEnum	UnitMode [get, set]
	Gets/Sets the measurement mode applied to the distance value.
double	Value [get, set]
	Gets/Sets the distance value.

---

Distance measure.

---

Member Enumeration Documentation

enum org::pdfclown::documents::contents::composition::Length::UnitModeEnum

Measurement mode.

Enumerator:

Absolute	Values are expressed as absolute measures.
Relative	Values are expressed as ratios relative to a specified base value.

---

Constructor & Destructor Documentation

org.pdfclown.documents.contents.composition.Length.Length	(	double	value,
		UnitModeEnum	unitMode
	)

---

Member Function Documentation

double org.pdfclown.documents.contents.composition.Length.GetValue

(

double

baseValue

)

Gets the resolved distance value.

This method ensures that relative distance values are transformed according to the specified base value.

Parameters:

baseValue

Value used to resolve relative values.

override string org.pdfclown.documents.contents.composition.Length.ToString

(

)

---

Property Documentation

UnitModeEnum org.pdfclown.documents.contents.composition.Length.UnitMode [get, set]

Gets/Sets the measurement mode applied to the distance value.

double org.pdfclown.documents.contents.composition.Length.Value [get, set]

Gets/Sets the distance value.

According to the applied unit mode, this value can be either an absolute measure or a ratio to be resolved through a base value.