RiverSoftAVG Products Help

Create

Overloaded. Initializes a new instance of the TSVGLength class. (Inherited from RSSVGTypes.TSVGLength.)

Create(Single,Boolean,TSVGUnit)

Overloaded. Constructs the length with the specified RSSVGTypes.TSVGLength.Raw value,   Unit, and if it is a percentage (Inherited from RSSVGTypes.TSVGLength.)

Create(TSVGStyleProperty)

Initializes a new instance of the TSVGBaselineShiftLength class. (Overrides RSSVGTypes.TSVGStylePropertyLength.Create(TSVGStyleProperty).)

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. (Inherited from RSSVGTypes.TSVGLength.)

aUnit

Specifies the units (e.g., inches, centimeters, etc) that the length is currently specified in. (Inherited from RSSVGTypes.TSVGLength.)

DefaultIsPercent

Defines the default RSSVGTypes.TSVGLength.IsPercent value, used to determine if the IsPercent value should be streamed (Inherited from RSSVGTypes.TSVGLength.)

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%) (Inherited from RSSVGTypes.TSVGLength.)

OnChange

Occurs when the length is changed, either the value or the units (Inherited from RSSVGTypes.TSVGLength.)

ParentValue

Controls whether the Value property should return the parent's length value (i.e., the length is inherited) or its own value (Inherited from RSSVGTypes.TSVGStylePropertyLength.)

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. (Inherited from RSSVGTypes.TSVGLength.)

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. (Inherited from RSSVGTypes.TSVGLength.)

Shift

Specifies the repositioning of the dominant-baseline relative to the dominant-baseline of the parent text content element. The shifted object might be a sub- or superscript. Within the shifted object, the whole baseline-table is offset; not just a single baseline. The amount of the shift is determined from information from the parent text content element, the sub- or superscript offset from the nominal font of the parent text content element, percent of the "line-height" of the parent text content element or an absolute value.

StyleProperty

Returns the RSSVGTypes.TSVGStyleProperty that this length is used for. (Inherited from RSSVGTypes.TSVGStylePropertyLength.)

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 (Inherited from RSSVGTypes.TSVGLength.)

Assign(TPersistent)

Represents method Assign(TPersistent). (Overrides RSSVGTypes.TSVGStylePropertyLength.Assign(TPersistent).)

Change

Represents method Change. (Inherited from RSSVGTypes.TSVGLength.)

Clear

Clears the length to 0 and no units (Overrides RSSVGTypes.TSVGStylePropertyLength.Clear.)

Clone

Creates a copy of the length (Overrides RSSVGTypes.TSVGStylePropertyLength.Clone.)

GetParentValue

Returns the length representing the inherited value

Calls the OnGetParent event. If the value is not inherited, this method returns nil

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 (Inherited from RSSVGTypes.TSVGLength.)

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. (Inherited from RSSVGTypes.TSVGLength.)

GetValue

Represents method GetValue. (Overrides RSSVGTypes.TSVGLength.GetValue.)

Initialize(Single,Boolean,TSVGUnit)

Initializes the length to the specified RSSVGTypes.TSVGLength.Raw value,   Unit, and if it is a percentage (Inherited from RSSVGTypes.TSVGLength.)

SetValue(Single)

Represents method SetValue(Single). (Overrides RSSVGTypes.TSVGLength.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 (Inherited from RSSVGTypes.TSVGLength.)

OnGetInherited

Occurs when the RSSVGTypes.TSVGStylePropertyLength.ParentValue property is retrieved

Assign an event handler to respond when the ParentValue property is read

OnGetParent

Occurs when GetParent method is called.

Assign an event handler when you want to return the parent length of the current length

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 (Inherited from RSSVGTypes.TSVGLength.)

OnSetInherited

Occurs when the RSSVGTypes.TSVGStylePropertyLength.ParentValue property is set

Assign an event handler to respond when the ParentValue property is written

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

FIsPercent

Determines if the length in raw value is a percentage or not (Inherited from RSSVGTypes.TSVGLength.)

FRaw

Stores the raw value of the length (Inherited from RSSVGTypes.TSVGLength.)

FUnit

Stores the unit type (e.g., mm, px, etc) to use when displaying the length (Inherited from RSSVGTypes.TSVGLength.)