PTTextWidgetAnnotationProperties


@interface PTTextWidgetAnnotationProperties
    : PTWidgetAnnotationProperties <PTRichTextAnnotationProperties>

Properties of a text widget annotation.

  • Initializes a newly created PTTextWidgetAnnotationProperties instance.

    Declaration

    Objective-C

    - (nonnull instancetype)init;

    Swift

    init()

    Return Value

    An initialized PTTextWidgetAnnotationProperties instance.

  • The default color of text.

    Note

    The default value of this property is UIColor.blackColor.

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) UIColor *textColor;

    Swift

    var textColor: UIColor? { get set }

  • Whether multiple lines of text are permitted.

    Note

    The default value of this property is YES.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite,
          getter=isMultilineEnabled) BOOL multilineEnabled;

    Swift

    var isMultilineEnabled: Bool { get set }

  • Whether spelling should be checked.

    Note

    The default value of this property is YES.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite,
          getter=isSpellCheckEnabled) BOOL spellCheckEnabled;

    Swift

    var isSpellCheckEnabled: Bool { get set }

  • Whether scrolling of the text is allowed.

    Text is scrolled horizontally for single-line mode and vertically for multiple-line mode (as determined by PTTextWidgetAnnotationProperties.multiline).

    Note

    The default value of this property is YES.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite,
          getter=isScrollEnabled) BOOL scrollEnabled;

    Swift

    var isScrollEnabled: Bool { get set }

  • Whether rich text contents are allowed.

    Note

    The default value of this property is NO.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite,
          getter=isRichTextEnabled) BOOL richTextEnabled;

    Swift

    var isRichTextEnabled: Bool { get set }

  • The maximum text length allowed, or -1 if there is no limit.

    Note

    The default value of this property is -1 (no limit).

    Declaration

    Objective-C

    @property (nonatomic) NSInteger maximumLength;

    Swift

    var maximumLength: Int { get set }

  • The form of quadding or justification used in displaying text.

    Note

    The default value of this property is e_ptleft_justified.

    Declaration

    Objective-C

    @property (nonatomic) PTTextJustification textJustification;

    Swift

    var textJustification: PTTextJustification { get set }

Font

  • The default font for the text.

    Note

    The default value of this property is a 12pt Helvetica font.

    See

    PTTextWidgetAnnotationProperties.fontSize

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) UIFont *font;

    Swift

    var font: UIFont? { get set }

  • The default font size in points for the text.

    Note

    The default value of this property is 12.

    See

    PTTextWidgetAnnotationProperties.font

    Declaration

    Objective-C

    @property (nonatomic) CGFloat fontSize;

    Swift

    var fontSize: CGFloat { get set }