PC SOFT

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Home | Sign in | English US
  • Properties specific to the description of docStyle variables
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadApple WatchUniversal Windows 10 AppWindows Mobile
Others
Stored procedures
docStyle (Type of variable)
In French: docStyle
The docStyle type is used to define the advanced characteristics of a style belonging to a document, a paragraph or a document fragment. The characteristics of this style can be retrieved by several WLanguage properties.
CAUTION: This type must not be used directly. It must only be used via the Document variables that contain an arry of styles associated with the document.
To associate a style with a paragraph, all you have to do is use the style identifier (..StyleID available in the docParagraph, docFragment and docElementText variables).
Example
MyDocControl is Control = {"DocControl", indControl}
// Retrieve the associated document
MyDoc is Document = MyDocControl
// Retrieve the fragment corresponding to the current selection in the control
Frag is Fragment = MyDoc[MyDocControl..Cursor to MyDocControl..CursorEnd]
// Switch the fragment content to bold
Frag..Style..FontBold = True
Remarks

Properties specific to the description of docStyle variables

The following properties can be used to handle a style:
Property nameType usedEffect
AliasCharacter stringDisplay name of style. This name is used if ..Name does not correspond to a display name.
If several names are available, they are separated by a comma (",").
This property is available in read-only.
InvisibleBoolean
  • True if the style must be hidden to the user,
  • False otherwise.
If ..Invisible = True, this style is an internal style (for example, this style is a Parent style and it must not be proposed in the GUI).
This property is available in read-only.
InvisibleIfNotUsedBoolean
  • True if the style must be hidden to the user except if it is already used in the document,
  • False otherwise.
This property is available in read-only.
NameCharacter stringPreset name of style or display name of style.
This property is available in read-only.
ByDefaultBoolean
  • True if the style is the default style,
  • False otherwise.
DisplayPriorityIntegerPriority order when displaying styles in an interface (GUI). This priority order is an ascending order.
StyleIDCharacter stringUnique identifier of style in the document.
This property is available in read-only.
StyleIDLinkedCharacter stringIdentifier of linked style (Paragraph style or Character style).
If the style is a paragraph style, this property returns the identifier of the associated character type.
This property is available in read-only.
StyleIDParentCharacter stringIdentifier of parent style (which means on which the current style is based).
This property is available in read-only.
TypeInteger constantType of style:
  • docstyleCharacter: Style of characters. This style is applied to a text section.
  • docstyleNumbering: Numbering style.
  • docstyleParagraph: Paragraph style. This style is applied to an entire paragraph.
  • docstyleTable: Style of table.
This property is available in read-only.
Note: the change of paragraph or fragment style automatically applies the linked paragraph style and character style if they exist.
Note: These properties can be handled by using one of the following syntaxes:
  • <Variable Name>..<Property Name>
  • <Variable Name>.<Property Name>
Minimum required version
  • Version 22
This page is also available for…
Comments
Click [Add] to post a comment