RiverSoftAVG Products Help

Zoom Window Out
Larger Text | Smaller Text
Hide Page Header
Show Expanding Text
Printable Version
Send Mail Feedback
Save Permalink URL

Navigation: Code Documentation > RSVclSVG > RSSVGTypes > Classes

TSVGLength Class

Defines the SVG Length type, including its Raw value, Unit, and whether it is a percentage. The RSSVGTypes.TSVGLength.Raw value represents the length in the current unit (e.g., inch, centimeter, etc); the RSSVGTypes.TSVGLength.Pixels and RSSVGTypes.TSVGLength.Value properties display the length converted to pixels. This allows you to set the length to 2 inches. Then, depending on what the RSSVGTypes.TSVGLength.GetUnitFactors method returns for pixels per inch, the Pixels property can change.

In SVGs, a length is a distance measurement, given as a number along with a unit which may be optional. Lengths are specified in one of two ways depending upon whether they are used in CSS property syntax or SVG presentation attribute syntax:

• When a <length> is used in a style sheet or with a property in a ‘style’ attribute, the syntax must match the following pattern:

length ::= number (~"em" | ~"ex" | ~"px" | ~"in" | ~"cm" | ~"mm" | ~"pt" | ~"pc")?
See the CSS2 specification for the meanings of the unit identifiers. The unit identifier may be in lower (recommended) or upper case.

For properties defined in CSS2 [CSS2], a length unit identifier must be provided (for non-zero values). For SVG-specific properties, the length unit identifier is optional. If a unit is not provided, the length value represents a distance in the current user coordinate system.

• When a <length> is used in an SVG presentation attribute, the syntax must match the following pattern:

length ::= number ("em" | "ex" | "px" | "in" | "cm" | "mm" | "pt" | "pc" | "%")?
The unit identifier, if present, must be in lower case; if not present, the length value represents a distance in the current user coordinate system.

Note that the non-property <length> definition also allows a percentage unit identifier. The meaning of a percentage length value depends on the attribute for which the percentage length value has been specified. Two common cases are: (a) when a percentage length value represents a percentage of the viewport width or height (refer to the section that discusses units in general), and (b) when a percentage length value represents a percentage of the bounding box width or height on a given object (refer to the section that describes object bounding box units).

Namespace: RSSVGTypes

	Name	Description
	Create	Overloaded. Initializes a new instance of the TSVGLength class.
	Create(Single,Boolean,TSVGUnit)	Overloaded. Constructs the length with the specified RSSVGTypes.TSVGLength.Raw value, Unit, and if it is a percentage

Top

	Name	Description
	AsUnit[TSVGUnit]	Reads and writes the current length using the specified unit. Setting this property will convert the length to the new unit and the Raw value will be changed.
	aUnit	Specifies the units (e.g., inches, centimeters, etc) that the length is currently specified in.
	DefaultIsPercent	Defines the default RSSVGTypes.TSVGLength.IsPercent value, used to determine if the IsPercent value should be streamed
	IsPercent	Specifies whether the RSSVGTypes.TSVGLength.Raw value should be interpreted as a percentage or not (with 0 being 0% and 1 equal to 100%)
	OnChange	Occurs when the length is changed, either the value or the units
	Pixels	Returns the length in pixels by converting the RSSVGTypes.TSVGLength.Raw value from its units to pixels, using the RSSVGTypes.TSVGLength.GetUnitFactors for conversion of the raw value. If the raw value is a percentage, the property returns the raw value as a value between 0 and 1. Use the RSSVGTypes.TSVGLength.Value property to convert the percentage into a value in its range.
	Raw	Defines the raw value in the current unit. The length class uses this value as the base value of the length. When you request the raw value in Pixels, the class converts the raw value to number of pixels using the Unit Factors.
	Value	Specifies the length value in pixels (based on converting from the Unit). If the length is a percentage, the Pixels value is converted to a final value using the range of the length

Top

	Name	Description
	Assign(TPersistent)	Represents method Assign(TPersistent).
	Change	Represents method Change.
	Clear	Clears the length to 0 and no units
	Clone	Creates a copy of the length
	GetPercentValue(Single,Single)	Returns the Raw value. If the length is a percentage, it converts the raw value into a value between Min and Max parameters
	GetUnitFactors	Returns the unit factors array for converting RSSVGTypes.TSVGLength.Raw values into RSSVGTypes.TSVGLength.Pixels. This method calls the RSSVGTypes.TSVGLength.OnUnitFactors event if assigned or returns the RSSVGTypes.SVGUnitFactors constant if it is not.
	GetValue	Represents method GetValue.
	Initialize(Single,Boolean,TSVGUnit)	Initializes the length to the specified RSSVGTypes.TSVGLength.Raw value, Unit, and if it is a percentage
	SetValue(Single)	Represents method SetValue(Single).
	ToString(String,Single,Single)	Overloaded. Returns a string representation of the length. If the length is a percentage, the method uses the Min and Max values to convert the Raw value into its final value

Top

Name

Description

public event

OnRange

Occurs when the length needs to convert a percentage value into a length based on a range. The OnRange event is called to return the Min and Max for calculating the percentage value

public event

OnUnitFactors

Occurs when the length needs the Unit Factors array for calculating the RSSVGTypes.TSVGLength.Pixels property from the RSSVGTypes.TSVGLength.Raw property

Called by the RSSVGTypes.TSVGLength.GetUnitFactors method

Top

	Name	Description
	FIsPercent	Determines if the length in raw value is a percentage or not
	FRaw	Stores the raw value of the length
	FUnit	Stores the unit type (e.g., mm, px, etc) to use when displaying the length

Top

RiverSoftAVG Products Help

Reference