ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

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
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Others
Stored procedures
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 nameType usedEffect
Line.ThicknessRealLine thickness (in millimeters).
Line.TypeInteger constantType of line:
  • LineNone: No line.
  • LineSolid:
  • LineSolidThick:
  • LineSolidMedium:
  • LineDouble:
  • LineDotAndDash:
  • LineDotAndDashMedium:
  • LineDotAndDashDoubleDash:
  • LineDotAndDashDoubleDashMedium:
  • LineDotted:
  • LineDottedMedium:
  • LineDash:
  • LineDashMedium:
Line.ColorInteger or Integer constantLine color: This color can correspond to an RGB color (returned by RGB), or to a preset color.
BackgroundBackground variableArea background.
ContentdocFragment variableFragment of area text.
HeightRealHeight of text area in millimeters.
InnerMarginBottomRealInside margin at the bottom of text area (in millimeters).
InnerMarginLeftRealInside margin on the left of text area (in millimeters)
InnerMarginRightRealInside margin on the right of text area (in millimeters)
InnerMarginTopRealInside margin at the top of text area (in millimeters)
LineCharacteristics of text area outline.
PresetShapeCharacter stringName 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.
WidthRealWidth of text area in millimeters.
WrappingInteger constantType 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).
XRealX 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.
YRealY 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.
ZOrderIntegerNumber 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:
orderCallout1curvedConnector5foldedCornerribbon2
accentBorderCallout2curvedDownArrowframerightArrow
accentBorderCallout3curvedLeftArrowfunnelrightArrowCallout
accentCallout1curvedRightArrowgear6rightBrace
accentCallout2curvedUpArrowgear9rightBracket
accentCallout3decagonhalfFrameround1Rect
actionButtonBackPreviousdiagStripeheartround2DiagRect
actionButtonBeginningdiamondheptagonround2SameRect
actionButtonBlankdodecagonhexagonroundRect
actionButtonDocumentdonuthomePlatertTriangle
actionButtonEnddoubleWavehorizontalScrollsmileyFace
actionButtonForwardNextdownArrowirregularSeal1snip1Rect
actionButtonHelpdownArrowCalloutirregularSeal2snip2DiagRect
actionButtonHomeellipsisleftArrowsnip2SameRect
actionButtonInformationellipseRibbonleftArrowCalloutsnipRoundRect
actionButtonMovieellipseRibbon2leftBracestar4
actionButtonReturnflowChartAlternateProcessleftBracketstar5
actionButtonSoundflowChartCollateleftCircularArrowstar6
arcflowChartConnectorleftRightArrowstar7
bentArrowflowChartDecisionleftRightArrowCalloutstar8
bentConnector2flowChartDelayleftRightCircularArrowstar10
bentConnector3flowChartDisplayleftRightUpArrowstar12
bentConnector4flowChartDocumentleftUpArrowstar16
bentConnector5flowChartExtractlightningBoltstar24
bentUpArrowflowChartInputOutputlinestar32
bevelflowChartInternalStoragemathDividestraightConnector1
blockArcflowChartMagneticDiskmathEqualstripedRightArrow
borderCallout1flowChartMagneticDrummathMinussun
borderCallout2flowChartMagneticTapemathMultiplyswooshArrow
borderCallout3flowChartManualInputmathNotEqualteardrop
bracePairflowChartManualOperationmathPlustrapezoid
bracketPairflowChartMergemoontriangle
callout1flowChartMultidocumentnonIsoscelesTrapezoidupArrow
callout2flowChartOfflineStoragenoSmokingupArrowCallout
callout3flowChartOffpageConnectornotchedRightArrowupDownArrow
canflowChartOnlineStorageoctagonupDownArrowCallout
chevronflowChartOrparallelogramuturnArrow
chordflowChartPredefinedProcesspentagonverticalScroll
circularArrowflowChartPreparationpieWedgewave
cloudCalloutflowChartProcessplaquewedgeEllipseCallout
cornerflowChartPunchedCardpluswedgeRectCallout
cubeflowChartPunchedTapequadArrowwedgeRoundRectCallout
curvedConnector2flowChartSortquadArrowCallout
curvedConnector3flowChartSummingJunctionrect
curvedConnector4flowChartTerminatorribbon
Minimum version required
  • Version 23
This page is also available for…
Comments
Click [Add] to post a comment

Last update: 05/26/2022

Send a report | Local help