Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Internet Explorer alert
This browser is not recommended for use with smartdevicelink.com, and may not function properly. Upgrade to a different browser to guarantee support of all features.
close alert
Documentation
SDLTextField

SDLTextField Class Reference

Section Contents

Overview

Struct defining the characteristics of a displayed field on the HMI.

@since SDL 1.0

name

The enumeration identifying the field.

See

SDLTextFieldName

Required

Objective-C

@property (nonatomic, strong) SDLTextFieldName _Nonnull name;

Swift

var name: SDLTextFieldName { get set }

characterSet

The set of characters that are supported by this text field. All text is sent in UTF-8 format, but not all systems may support all of the characters expressed by UTF-8. All systems will support at least ASCII, but they may support more, either the LATIN-1 character set, or the full UTF-8 character set.

Objective-C

@property (nonatomic, strong) SDLCharacterSet _Nonnull characterSet;

Swift

var characterSet: SDLCharacterSet { get set }

width

The number of characters in one row of this field.

Required, Integer 1 - 500

Objective-C

@property (nonatomic, strong) NSNumber<SDLInt> *_Nonnull width;

Swift

var width: NSNumber & SDLInt { get set }

rows

The number of rows for this text field.

Required, Integer 1 - 8

Objective-C

@property (nonatomic, strong) NSNumber<SDLInt> *_Nonnull rows;

Swift

var rows: NSNumber & SDLInt { get set }

-initWithName:characterSet:width:rows:

Convenience initalizer for the TextField RPC struct

Objective-C

- (nonnull instancetype)initWithName:(nonnull SDLTextFieldName)name
                        characterSet:(nonnull SDLCharacterSet)characterSet
                               width:(NSUInteger)width
                                rows:(NSUInteger)rows;

Swift

init(name: SDLTextFieldName, characterSet: SDLCharacterSet, width: UInt, rows: UInt)

Parameters

name

The name identifying this text field

characterSet

The character set of this text field

width

The number of characters per row allowed in this text field

rows

The number of rows allowed in this text field

View on GitHub.com
Previous Section Next Section