Version Information
Release Notes, Update information, Certifications and Frequently Asked Questions.
Concepts
Your first step into modern and powerful process visualization.
Deployment
Topics, you need to know, before using WinCC OA.
Security
Go beyond the norm in cybersecurity.
Engineering
Powerful tools for easy or complex engineering tasks.
Data Management
Classify, structure and archive your data.
Business Logic / Control
Endless possibilities in data processing for your projects.
- Introduction to CTRL
  An introduction to the product's own programming language Control(CTRL).
- Control Classes
  The overview of classes available in Control.
- Types of Control Functions
  An overview of the types of functions distinguished within Control.
- Control graphics
  - Graphics objects
  - Attributes of graphics objects
  - Panel functions
  - Reference Functions
  - Arc
  - AttentionEffect EWO functions
  - Bar trend
  - BarChart3D EWO
  - Button
  - Chart.ewo
  - Calendar
  - Cascade
  - Checkbox
  - Clock
  - Combobox
  - DateTimeEdit EWO functions
  - DialGauge EWO
  - DoubleSpinbox EWO
  - DpTreeView
  - DpTypeView
  - Embedded module
  - Frame
  - GIS Viewer EWO
    WinCC OA GIS Viewer provides the cartographic representation of objects in WinCC OA. This new feature provides numerous advantages, particularly in geographical distributed systems, like in Water, Traffic, Oil & Gas or Energy.
  - Label Functions
  - Layoutgroup functions
  - LCD number
  - Maps Widget - Properties and Functions
  - PDF Viewer EWO
  - PictureFlow EWO functions
  - Pipe
  - Polyline
  - Primitive text
  - Progress bar
  - Radio box
  - Rectangle
  - Reference Functions
  - Scheduler.ewo
  - Selection list
  - Slider
  - Spin button
  - Splitter
  - Tab
  - Table
  - TextEdit
    - "acceptDrops"
      Specifies whether drop events are enabled for this object.
    - "append"
      Adds a text to a textEdit document.
    - "alignment"
      Changes the alignment at the cursor position or the alignment of the selected text.
    - "autoFormatting"
    - "backgroundOrigin"
      Returns the origin of the widget`s background. This attribute only makes a difference if the widget has a background pixmap, in which case positioning matters. You can also set the origin.
    - "bold"
      Sets the font to bold.
    - "contentsHeight, contentsWidth"
      The attribute "contentsHeight" returns the height of an object, for example, the height of a TextEdit text area. The attribute "contentsWidth" again returns the width of a TextEdit text area.
    - "contentsX", "contentsY"
      The attributes contentsX and contentsY return the coordinate of an object, for example, of a TextEdit text or of a tree widget. contentsX returns the X coordinate of the contents (text) that are at the left edge of the view. contentsY returns the Y coordinate of the contents (text) that are at the top edge of the view.
    - "contextMenuPolicy"
      Defines how the respective widgets shows the context menu.
    - "currentFont"
      Changes the font at cursor position.
    - "cursorWidth"
      The attribute "cursorWidth" sets the cursor width of a textEdit.
    - "documentTitle"
      The attribute "documentTitle" gets or sets the title of a textEdit document.
    - "family"
      The attribute "family" returns the font family of the current font.
    - "focus"
      The attribute "focus"; returns TRUEif the object has the focus.
    - "font"
      Sets the font of an object.
    - "frameShadow"
      The attribute "frameShadow" specifies the frame effect (3D effect) of an object (textEdit, progress bar, tree widget, thumb wheel, LCD number, DpTreeView or zoom navigator).
    - "frameShape"
      The attribute "frameShape" sets the style of an object frame (textEdit frame, a thumb wheel, a tree widget, a zoom navigator , an LCD number or a progress bar).
    - "frameWidth"
      The attribute "frameWidth"; returns the width of a frame (a textEdit, a tree widget, a zoom navigator, LCD number, a thumb wheel etc.)
    - "getCursorPosition"
      Returns the cursor position in a textEdit document.
    - "hasSelectedText"
      The attribute "hasSelectedText"; returns TRUE if the text of a textEdit has been selected.
    - "height"
      The attribute "height" returns the height of an object (textEdit, progress bar, tree widget, zoom navigator, LCD number or a thumb wheel.)
    - "horizontalScrollBarPolicy" / "hScrollBarMode"
      The attribute "horizontalScrollBarPolicy"; sets the horizontal scroll bar mode of an object, for example, textEdit, tree widget or a table. (Until Version 3.10 "hScrollBarMode")
    - "insert"
      Inserts a text at the current cursor position.
    - "insertAt"
      Adds a text to a textEdit document at the defined position.
    - "insertHtml"
      Inserts an HTML text at the current cursor position.
    - "insertHtmlAt"
      Inserts an HTML text at the given position.
    - "insertParagraph"
      Adds a paragraph to a textEdit document at the given position.
    - "isActiveWindow"
      The attribute "isActiveWindow"; returns TRUE if this widget is the active window, otherwise FALSE.
    - "italic"
      The attribute "italic"; sets the font (of a textEdit) italic (beginning from the cursor position). The attribute also returns TRUE if the current font is italic.
    - "layoutDirection"
      Defines the widget's layout direction.
    - "length"
      The attribute "length" returns the length of a textEdit text.
    - "lineWidth"
      The attribute "lineWidth"; sets the width of an object (a textEdit, progress bar, tree widget, zoom navigator, LCD number or a thumb wheel (frame) ) line.
    - "linkUnderline" - obsolete
      The attribute "linkUnderline"; underlines a link. (Obsolete since Version 3.10)
    - "margin" - obsolete with version 3.12
      The attribute "margin" specifies the distance between the innermost pixel of the frame and the outermost pixel of the rectangle inside the frame.
    - "margin"
      The attribute sets the distance between the edge of the Text Edit and the text within the shape.
    - "maximumHeight, maximumWidth"
      The attribute "maximumHeight"; returns the maximum height of a textEdit (excluding any window frame), a tree widget or a slider and the attribute "maximumWidth"; the maximum width of a textEdit, a tree widget or a slider.
    - "midLineWidth"
      The attribute "midLineWidth" sets the width of the mid line (content) of an object (for example, a thumb wheel, tree widget, zoom navigator, LCD number or a progress bar).
    - "minimumHeight, minimumWidth"
      The attribute "minimumHeight"; returns the minimum height of a textEdit (excluding any window frame), a tree widget or of a slider and the attribute "minimumWidth"; the minimum width of a textEdit, tree widget or a slider.
    - "modified"
      The attribute "modified"; returns TRUE if a textEdit has been modified.
    - "overwriteMode";
      Sets the overwrite mode of a textEdit.
    - "ownCursor";
      The attribute "ownCursor" returns TRUE if an object (for example a textEdit, a tree widget, a slider, a zoom navigator or a thumb wheel) uses its own cursor. If the value is FALSE, the object uses its parent widget`s cursor.
    - "ownFont";
      The attribute "ownFont"; returns TRUE if an object (for example, a textEdit, a slider, a zoom navigator or a tree widget) uses its own font. If the value is FALSE, the object uses its parent widget`s font.
    - "placeholderText"
      This text is displayed grayed out until the user writes something in the text field.
    - "pointSize";
      The attribute "pointSize"; sets the font size of a textEdit text.
    - "readOnly";
      The attribute "readOnly"; sets a textEdit document to read only.
    - "removeParagraph"
      Removes a paragraph from a textEdit document at the given position.
    - "scrollBy"
      Scrolls the content by dx to the left and dy upwards.
    - "selectedText"
      The attribute "selectedText" returns the selected text of a textEdit.
    - "setCursorPosition"
      Sets the cursor position in a textEdit document.
    - "setSelection"
      Selects and highlights a given part of a TextEdit text.
    - "tabChangesFocus"
      If the attribute "tabChangesFocus" is set to TRUE, it is not possible to input tabulators.
    - "tabStopWidth"
      The attribute "tabStopWidth" sets the tab stop width of a textEdit.
    - "text"
      Returns the content (text) of a text field.
    - "textFormat"
      Sets the text format of a textEdit.
    - "textInteractionFlags"
      Defines how the TextEdit widget reacts to user inputs.
    - "tooltipDuration"
      Specifies how long a tooltip is shown.
    - "underline"
      Underlines the current font (text) or returns TRUE if the current font (text) has been underlined.
    - "underMouse"
      Returns TRUE if a widget (textEdit, slider, thumb wheel, tree widget, zoom navigator, LCD number or progress bar) is beneath the cursor.
    - "undoDepth" - obsolete
      This property holds the depth of the undo history. (Obsolete since Version 3.10)
    - "undoRedoEnabled"
      This property holds whether undo/redo is enabled.
    - "updatesEnabled"
      This attribute specifies whether updates of a widget (for example, a textEdit, slider, progress bar, zoom navigator, LCD number or thumb wheel) have been enabled.
    - "value"
      Defines the current value / text for multiline texts.
    - "visibleHeight"
      This property holds the vertical amount of the content that is visible.
    - "visibleWidth"
      This property holds the horizontal amount of the content that is visible.
    - "verticalScrollBarPolicy" / "vScrollBarMode"
      The attribute "verticalScrollBarPolicy" sets the vertical scroll bar mode of an object e.g. of a textEdit, a tree widget or a table. (Until Version 3.10 "vScrollBarMode")
    - "width"
      The attribute "width" returns the width of an object (e.g. a textEdit, a zoom navigator or a slider).
    - "wordWrap"
      The attribute "wordWrap" specifies the different word wrap modes.
    - "wrapColumnOrWidth"
      The attribute "wrapColumnOrWidth" sets the number of characters for the wrap mode "FixedColumnWidth" and the number of pixels for the wrap mode "FixedPixelWidth".
    - "wrapPolicy"
      The attribute "wrapPolicy" specifies where text (of a textEdit) can be wrapped in word wrap mode.
    - "x", "y"
      The attributes x and y return the coordinate of an object (e.g. a textEdit, a progress bar, a slider, a zoom navigator, an LCD number or a thumb wheel). x returns the X coordinate of an object. y returns the Y coordinate of an object.
  - Text field
  - Thumb wheel
  - ToggleSwitch EWO
  - Tree widget
  - Trend
  - VideoPlayer.ewo
  - WebView EWO
    All functions, specifically available for the WebView EWO.
  - Zoom Navigator
    Functions available for the Zoom Navigator widget.
- CONTROL Functions
- CtrlExtension
  The CtrlExtension allows the addition of custom C++ code.
- CTRL Debugger
  You can use the CTRL debugger to debug the Control programming language. The debugger can be used via its own panel, which also enables the monitoring and setting of variable values during the execution of a script.
- SQL in CONTROL
  The database functions enable you to quickly carry out value queries on data points and elements.
- API Manager
  The WinCC OA API (Application Programming Interface) offers a number of functions adding special Managers to this process control system.
- NextGen Archiver Backend-API
  This chapter describes the NextGen Archiver Backend API
Data Visualization
User interfaces, Trends and Reports for every purpose and device.
Southbound Interfaces
The process connection to the actual machines/sensors.
Northbound Interfaces
Your portal to the cloud or supervising systems.
Web Connectivity / Network Interfaces
Data exchange, APIs and web technologies
User Management
All about authorization, authentication and login-customization.
Availability
How to get your system uptime to the maximum.
Reporting
Create state of the art project reports without limits.
Addons
Useful tools and enhancements for special demands.
Reference Tables
Detailed and extensive content for special project adaptation.
Videos & Tutorials
Explore the capabilities of WinCC OA with our carefully selected collection of video tutorials and guides.
WinCC OA Documentation
Basic information about terms and functions within the documentation.
Disclaimer
A brief clarification of liability exclusions or legal notices.

"textFormat"

Sets the text format of a textEdit.

Synopsis

shape.textFormat(string tFormat);

Parameter


Parameter	Description
shape	Name of the object
tFormat	Following text formats are available: "PlainText" => plain text "RichText" => HTML text "AutoText" => automatic selection if plain or rich text

Description

Sets the text format of a textEdit.

Example

The following example sets the format of a textEdit to RichText.

main(bool enter)
{
  this.textFormat = "RichText";
  this.Text = "<b>in Bold</b> not bold";
}

Assignment

TextEdit