docElementTextArea (Type of variable)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help / WLanguage / WLanguage functions / Controls, pages and windows / Word Processing functions / Types of variables

Properties specific to the description of docElementTextArea variables
Available preset shapes

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

docElementTextArea (Type of variable)

In french: docElémentZoneDeTexte

The docElementTextArea type is used to define the advanced characteristics of a text area found in a docElement variable. The characteristics of this text area can be defined and modified by several WLanguage properties.

Remark: For more details on the declaration of this type of variable and the use of WLanguage properties, see Declaring a variable.

Example

MyDoc is Document

e is docElément
e.Type = typeDocElementTextArea

e.TextArea.Height = 40
e.TextArea.Width = 50
e.TextArea.Wrapping = docWrappingFramed
e.TextArea.X = 10
e.TextArea.Y = 10

e.TextArea.PresetShape = "rect"
e.TextArea.Background.Color = White
e.TextArea.Line.Color = LightRed
e.TextArea.Line.Thickness = 0.5
e.TextArea.Line.Type = DottedLine

f is docFragment(MyDoc, 1, 1)
DocInsert(f, e)

MyElem is docElément = f.Elément[1]
MyElem.TextArea.Content.Text = "Text area text"

Remarks

Properties specific to the description of docElementTextArea variables

The following properties can be used to handle a Text Area element:


Property name		Type used	Effect
	Line.Thickness	Real	Line thickness (in millimeters).
	Line.Type	Integer constant	Type of line: LineNone: No line. LineSolid: LineSolidThick: LineSolidMedium: LineDouble: LineDotAndDash: LineDotAndDashMedium: LineDotAndDashDoubleDash: LineDotAndDashDoubleDashMedium: LineDotted: LineDottedMedium: LineDash: LineDashMedium:
	Line.Color	Integer or Integer constant	Line color: This color can correspond to an RGB color (returned by RGB), or to a preset color.
Background		Background variable	Area background.
Content		docFragment variable	Fragment of area text.
Height		Real	Height of text area in millimeters.
InnerMarginBottom		Real	Inside margin at the bottom of text area (in millimeters).
InnerMarginLeft		Real	Inside margin on the left of text area (in millimeters)
InnerMarginRight		Real	Inside margin on the right of text area (in millimeters)
InnerMarginTop		Real	Inside margin at the top of text area (in millimeters)
Line			Characteristics of text area outline.
PresetShape		Character string	Name of preset shape used for the area border. This property can correspond to: Empty string: The shape corresponds to a square without outline. "<shape name>": Custom shape, displayed in the control but not managed through programming. For more details, see Preset shapes.
Width		Real	Width of text area in millimeters.
Wrapping		Integer constant	Type of wrapping for the text area: docWrappingAlignedOnText: The text area is inserted into the line and its is linked to the text location where it was inserted. It is processed like any character. It moves with the text. docWrappingThrough: Used to customize the wrapping. docWrappingBehindTheText: Allows you to use the text area in watermark behind the text. docWrappingBeforeTheText: Used to display the text area above the text. docWrappingFramed: Wraps the text around the border of text area (recommended for a square text area). docWrappingTopAndBottom: The text area remains on its line and it is located between two text sections at the top and at the bottom. docWrappingNear: Wraps the text area according to its outlines (recommended for a round text area or for a text area with an irregular shape).
X		Real	X position of text area in relation to its anchoring point (in millimeters). This property is only used for text areas for which the Wrapping property is set to a constant other than docWrappingAlignedOnText.
Y		Real	Y position of text area in relation to its anchoring point (in millimeters). This property is only used for text areas for which the Wrapping property is set to a constant other than docWrappingAlignedOnText.
ZOrder		Integer	Number corresponding to the Z-order of the text area. This property is automatically modified when DocChangeZOrder is used.

Available preset shapes

The following preset shapes are available:


orderCallout1	curvedConnector5	foldedCorner	ribbon2
accentBorderCallout2	curvedDownArrow	frame	rightArrow
accentBorderCallout3	curvedLeftArrow	funnel	rightArrowCallout
accentCallout1	curvedRightArrow	gear6	rightBrace
accentCallout2	curvedUpArrow	gear9	rightBracket
accentCallout3	decagon	halfFrame	round1Rect
actionButtonBackPrevious	diagStripe	heart	round2DiagRect
actionButtonBeginning	diamond	heptagon	round2SameRect
actionButtonBlank	dodecagon	hexagon	roundRect
actionButtonDocument	donut	homePlate	rtTriangle
actionButtonEnd	doubleWave	horizontalScroll	smileyFace
actionButtonForwardNext	downArrow	irregularSeal1	snip1Rect
actionButtonHelp	downArrowCallout	irregularSeal2	snip2DiagRect
actionButtonHome	ellipsis	leftArrow	snip2SameRect
actionButtonInformation	ellipseRibbon	leftArrowCallout	snipRoundRect
actionButtonMovie	ellipseRibbon2	leftBrace	star4
actionButtonReturn	flowChartAlternateProcess	leftBracket	star5
actionButtonSound	flowChartCollate	leftCircularArrow	star6
arc	flowChartConnector	leftRightArrow	star7
bentArrow	flowChartDecision	leftRightArrowCallout	star8
bentConnector2	flowChartDelay	leftRightCircularArrow	star10
bentConnector3	flowChartDisplay	leftRightUpArrow	star12
bentConnector4	flowChartDocument	leftUpArrow	star16
bentConnector5	flowChartExtract	lightningBolt	star24
bentUpArrow	flowChartInputOutput	line	star32
bevel	flowChartInternalStorage	mathDivide	straightConnector1
blockArc	flowChartMagneticDisk	mathEqual	stripedRightArrow
borderCallout1	flowChartMagneticDrum	mathMinus	sun
borderCallout2	flowChartMagneticTape	mathMultiply	swooshArrow
borderCallout3	flowChartManualInput	mathNotEqual	teardrop
bracePair	flowChartManualOperation	mathPlus	trapezoid
bracketPair	flowChartMerge	moon	triangle
callout1	flowChartMultidocument	nonIsoscelesTrapezoid	upArrow
callout2	flowChartOfflineStorage	noSmoking	upArrowCallout
callout3	flowChartOffpageConnector	notchedRightArrow	upDownArrow
can	flowChartOnlineStorage	octagon	upDownArrowCallout
chevron	flowChartOr	parallelogram	uturnArrow
chord	flowChartPredefinedProcess	pentagon	verticalScroll
circularArrow	flowChartPreparation	pieWedge	wave
cloudCallout	flowChartProcess	plaque	wedgeEllipseCallout
corner	flowChartPunchedCard	plus	wedgeRectCallout
cube	flowChartPunchedTape	quadArrow	wedgeRoundRectCallout
curvedConnector2	flowChartSort	quadArrowCallout
curvedConnector3	flowChartSummingJunction	rect
curvedConnector4	flowChartTerminator	ribbon