docFragment (Type of variable)

AYUDA EN LÍNEA
DE WINDEV, WEBDEV Y WINDEV MOBILE

Versión:

Inicio | Iniciar sesión | Español

Properties specific to the description of docFragment variables
Functions that use the docFragment variables

WINDEV

WEBDEV

WINDEV Mobile

Otros

docFragment (Type of variable)

The docFragment type is used to define the characteristics of a fragment found in a "docx" document. The characteristics of this fragment can be defined and modified by several WLanguage properties.

A fragment is defined by its start and end positions. Therefore, it can:

extend on several paragraphs,
start in the middle of any ordinary word,
end in the middle of any ordinary word.

Note: See Declaring a variable for more details.

Ejemplo

// Change the selection color
// Get the current selection
MySelection is docFragment(WP_MyDocument, WP_MyDocument..Cursor, ...
WP_MyDocument..SelectionLength)
// Change the color
MySelection..Style..TextColor = PastelRed

// Load the document
MyDoc is Document = "c:\temp\doc.docx"

// Adds text at the end of document
FragmentEnd is docFragment(MyDoc, -1 , 0)
FragmentEnd..Text += "End of document"

Sintaxis

Declaring a document fragment that is not described Ocultar los detalles

MyVariable is docFragment

In this case, the document fragment is not described. The variable will have to be assigned with an existing fragment or with the result of one of the functions for handling documents (DocSeek for example).

Declaring and describing a fragment Ocultar los detalles

MyVariable is docFragment([<Document> [, <Start of Fragment> [, <Length>]]])

<Document>: Optional Document variable or character string (with or without quotes)

Document from which a fragment will be extracted. This document corresponds to:
the name of a Word Processing control.
a Document variable.

<Start of Fragment>: Optional integer

Start position of document fragment to use. This position is given in number of characters:
from the start of document (positive number).
from the end of document (negative number).

<Length>: Optional integer

Length of fragment to use, expressed in number of characters.

Observaciones

Properties specific to the description of docFragment variables

The following properties can be used to handle a docFragment variable:


Property name		Type used	Effect
Element		Array of docElement	Elements making up the document fragment used. The fragment elements can be browsed via the FOR EACH statement.
Word		Array of docFragment	Words making up the document fragment used. The fragment words can be browsed via the FOR EACH statement.
Paragraph		Array of docParagraph	Paragraphs affected by the fragment (if a fragment includes several paragraphs). The paragraphs can be browsed via the FOR EACH statement.
StartPosition		Integer	Start position of fragment. This position is relative to the entire document.
EndPosition		Integer	End position of fragment. This position is relative to the entire document.
Style			Information of combined styles for all elements making up the document fragment used.
	Style..VerticalAlign	Integer constant	Text position on the baseline: alignBaseline: The text is positioned on the base line. alignSuperscript: The text is positioned in superscript. alignSubscript: The text is positioned in subscript.
	Style..UnderlineColor	Integer	Color used to underline the text. This color corresponds to: an RGB color (returned by RGB). an HSL color (returned by HSL), a preset color of WLanguage.
	Style..HighlightColor	Integer	Color used to highlight the text. Only the following colors are available: Transparent Black LightBlue LightCyan LightGreen LightMagenta LightRed LightYellow White DarkBlue DarkCyan DarkGreen DarklMagenta DarkRed DarkYellow LightGray DarkGray
	Style..TextColor	Integer	Text color. This color corresponds to: an RGB color (returned by RGB). an HSL color (returned by HSL), a preset color of WLanguage.
	Style..FontStrikeOut	Integer	0: Font not struck 1: Font struck 2: Undefined
	Style..FontBold	Integer	0: Non-bold font 1: Bold font 2: Undefined
	Style..FontItalic	Integer	0: Non-italic font 1: Italic font 2: Undefined
	Style..FontName	Character string	Modify the font used for the fragment.
	Style..FontUnderlined	Integer constant	Type of underline: underlineNone: No underline underlineDouble: Double underline underlineThick: Thick underline underlineWords: Underline words only underlineDotted: Underline in dots underlineDottedHeavy: Underline in heavy dots underlineDotDotDash: Underline with dots and dashes underlineDotDotDashHeavy: Underline with heavy dots and dashes underlineDotDash: Underline with dashes underlineDotDashHeavy: Underline with heavy dashes underlineSingle: Single underline underlineDash: Underline with dashes underlineDashHeavy: Underline with heavy dashes
	Style..FontSize	Real	Font size.
Text		Character string	Rough text corresponding to the content of fragment used.


Property name		Type used	Effect
Element		Array of docElement	Elements making up the document fragment used. The fragment elements can be browsed via the FOR EACH statement.
SubDocumentIdentifier		Integer	Identifier corresponding to the sub-document associated with the fragment. This property is intended for an advanced use. Caution: This property is available from version 220071.
LanguageSpelling		Character string	Language of fragment. The notation used corresponds to the 639-1 standard. For example "FR-fr". In read mode, this property returns a valid information only if the fragment corresponds to a single language. Note: To perform the spell check corresponding to the fragment language, the dictionary of this language must be loaded by DictionaryLoad. This property is available from version 220059U (module dated 05/17/2017).
Formatting		docFormatting variable	Formatting information for all the elements making up the document fragment used.
PageLayout			Layout of current fragment. Caution: This property is available from version 220071.
	PageLayout..BrushColor	Integer	Background color of fragment. This color can correspond to: an RGB color (returned by RGB), a preset color.
	PageLayout..BackgroundFrame	Background variable	Characteristics of fragment background.
Word		Array of docFragment	Words making up the document fragment used. The fragment words can be browsed via the FOR EACH statement.
Paragraph		Array of docParagraph	Paragraphs affected by the fragment (if a fragment includes several paragraphs). The paragraphs can be browsed via the FOR EACH statement.
StartPosition		Integer	Start position of fragment. This position is relative to the entire document.
EndPosition		Integer	End position of fragment. This position is relative to the entire document.
StyleID		Character string	Identifier of style applied to the fragment. This identifier must exist among the styles linked to the document. Note: the change of paragraph or fragment style automatically applies the linked paragraph style and character style if they exist.
Text		Character string	Rough text corresponding to the content of fragment used.
TypeSubDocument		Integer constant	Section of document to which the fragment belongs. Caution: This property is available from version 220071. The possible values are as follows: Versiones 23 y posteriores typeSubDocCanvas: Image container Nueva funcionalidad versión 23 typeSubDocCanvas: Image container typeSubDocCanvas: Image container typeSubDocBody: Document body. typeSubDocHeaderOddPage: Header of odd page. typeSubDocHeaderEvenPage: Header of even page. typeSubDocHeaderFirstPage: Header of first page. typeSubDocFooterOddPage: Footer of odd page. typeSubDocFooterEvenPage: Footer of even page. typeSubDocFooterFirstPage: Footer of first page. Versiones 23 y posteriores typeSubDocTextArea: Text area. Nueva funcionalidad versión 23 typeSubDocTextArea: Text area. typeSubDocTextArea: Text area. This property is available in read-only.

Note: These properties can be handled by using one of the following syntaxes:

<Variable name>..<Property name>
<Variable name>.<Property name>

Functions that use the docFragment variables

Versión mínima requerida

Versión 22

Esta página también está disponible para…

Comentarios

Haga clic en [Agregar] para publicar un comentario

Última modificación: 27/06/2019

Señalar un error o enviar una sugerencia | Ayuda local