WordWrap Property

Summary

Gets or sets a value that indicates whether an AnnTextObject automatically wraps words to the beginning of the next line when necessary.

Syntax

Java

Objective-C

WinRT C#

C++

public bool WordWrap { get; set; }

Public Property WordWrap As Boolean

public bool WordWrap {get; set;}

@property (nonatomic) bool wordWrap;

public boolean getWordWrap() 
public void setWordWrap(boolean wordWrap)

  
get_WordWrap(); 
set_WordWrap(value); 
Object.defineProperty('WordWrap');

public:  
   property bool WordWrap 
   { 
      bool get() 
      void set(bool value) 
   }

Property Value

true if the multiline AnnTextObject wraps words; otherwise, false. The default value is true.

Remarks

AnnTextObject will render multiline text as follows:

If a new line character is encountered, then the following word will be rendered on the next line
If there is not enough space to render the current word in the current line, then the renderer uses the value of WordWrap to determine whether to start a new line when rendering the current and subsequent words.

If there is not enough space to render the current word in the current line, but the WordWrap value is false, the line of text is rendered horizontally beyond the edge of the object and will be clipped.

An AnnTextObject does not automatically resize itself when there is not enough space to render characters and words. The bounding rectangle can be changed programatically or through automation using the AnnRectangleObject.Rect property.

Requirements

Target Platforms