List of 'A' methods

Top  Previous  Next

The most important 'A' function is:

 

Method ASet(WPAT_Code: Byte; Value: Integer);

 

Set the value of a certain property element. Value may be an integer value in the range

   -8388607 ..  +8388607. (24 bits)

 

Note: If you need to set a color value you can use ASetColor

 

Reference:

 

Method ABorderEqual        

 

Method ABorderHash        

 

Method AClearCharAttr        

 

Method ACopy        

 

Method ADel        

This procedure is used to reset a property to the default value.

 

Method ADelAllFromTo        

Deletes all properties from/to certain WPAT_values.

 

Method ADelAllIn

Delete all properties which are included in this array.

 

Method ADelAttr        

 

Deletes groups of attributes attributes.

 

Method ADeleteDifferentSettings

This method deletes all properties from this paragraph or style which are not defined in the style which was passed as the parameter. Please also see ADeleteEqualSettings.

 

Method ADeleteEqualSettings        

This method deletes all properties from this paragraph or style which are also set in the style which is passed as the parameter. . Please also see ADeleteDifferentSettings.

 

Method AGet        

This procedure is used to read most of the paragraph properties. It returns as true if the value was found.

 

Method AGetAsINI        

 

Method AGetBorder

Initialize the border record with the setting in this paragraph. When Init=TRUE all values will be initialized.

 

Method AGetCharProps        

This procedure fills a TCharAttr record with character properties which are defined here. If Overwrite=FALSE, then it will not overwrite values which are marked as "used" in the mask except for the CharStyle value which is assigned using the 'or' operator.

 

Method AGetCharStyle        

 

Method AGetColor        

 

Method AGetDef

This procedure is used to read most of the paragraph properties.

 

Method AGetDefInherited

This function reads the attributes defined in this style or paragraph by following the inheritence order. The definition which was made last is used. (See AGetDef)

 

Method AGetFontName        

This function retrieves the font name defined for this style or its basestyle (= the inherited WPAT_CharFont property). If no font is defined, the result value is an empty string.

 

Method AGetInherited        

This function reads the attributes defined in this style or paragraph by following the inheritence order. The definition which was made last is used. (See AGet)

 

Method AGetStringProp

Reads a property which is a string. Strings are stored as index values into a global string list.        

 

Method AGetStyleCharAttr        

 

Method AGetWPSS

This function creates a CSS-like style sheet using WPTools special names. Note: All position values are measured in twips. If 'OnlyUsePTag' is set to true, only generic 'P' and 'Tab' tags are created: The string created can then only be used for text which uses the same RTFProps object in the same instance of the application.

 

Method AGet_CSS        

 

Method AInc

Increments which increase a property (with offset>0) or decrease a property (with offset<0). In either case the value is checked for the minimum value.

 

Method AMerge        

Merges Attributes

 

Method ASet        

Set the value of a certain property element. Value may an integer value within the range -8388607 .. +8388607. (24 bits)

 

Method ASetAdd        

Executes a bitwise OR operation with the current value and the passed value and assigns the result.

 

Method ASetAddCharStyle        

Adds a character style attribute (WPSTY_BOLD...) to the paragraph or style.

 

Method ASetAsINI        

Set the propertyies in the WPTools 4 INI format used by the style collection

 

Method ASetBaseStyle        

ASetBaseStyle sets the number of the base style for this element. The number is the ID (not the index!) of a style which is stored in the ParStyles property of the TWPRTFProps object.

 

Method ASetBorder

Define the borders using the given border record. Don't forget to set blEnabled in LineType, otherwise all borders will be disabled. This function overwrites all defined borders in these paragraphs and, if all borders are the same or 0, removes existing definitions.

 

Method ASetBorderFlags        

 

Method ASetCharStyle        

 

Method ASetCharStyle        

 

Method ASetColor        

Assigns a color value;to reset to default use clNone.

 

Method ASetColorString

Assigns a color string; to reset to default use an empty string.

 

Method ASetDel        

Executes a bitwise AND NOT operation with the current value and the passed value and assigns the result.

 

Method ASetDelCharStyle

Removes a character style attribute (WPSTY_BOLD...) from the paragraph or style. This actually adds a negative style attribute, this means it also deletes an inherited value.

 

Method ASetFontName

This method sets the font used by this style. If an empty string is passed, it deletes the current setting. It cannot be used to set an inherited value which is reported by AGetFontName.

 

Method ASetNeutral

This procedure is used to write most of the paragraph properties. If the value is 0, it will delete an existing entry unless the 0 value is required to override an inherited value. Please note that you may only use 23 bits of Value

 

Method ASetStringProp        

 

Method ASetWPSS        

This procedure applies the properties defined in the given string. They must have been created using the AGetWPSS function. Please note that white space characters are not expected in the string. If the optional parameter "Merge" is set to TRUE, the name and the base style parameter are not changed (even if they are included in the string) and no properties in the style are initialized before the new properties are applied.

 

Method AStringToNumber

AStringToNumber saves a string to a global list and returns the number to identify the string. This feature is required for style properties which require string variables.