SDLTextField Class Reference

Section Contents

Overview

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

Parameter List
Name Type Description SmartDeviceLink Ver. Available
name TextFieldName Enumeration identifying the field. SDL 1.0
characterSet CharacterSet The character set that is supported in this field. SDL 1.0
width Int16 The number of characters in one row of this field.
  • Minvalue=1
  • maxvalue=500
 SDL 1.0
rows Int16 The number of rows for this text field.
  • Minvalue=1
  • maxvalue=3
 SDL 1.0

@since SDL 1.0

-init

@abstract Constructs a newly allocated SDLTextField object

Objective-C

- (instancetype)init;

Swift

init!()

-initWithDictionary:

@abstract Constructs a newly allocated SDLTextField object indicated by the dictionary parameter

Objective-C

- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;

Swift

init!(dictionary dict: NSMutableDictionary!)

Parameters

dict

The dictionary to use to construct the object

name

@abstract The enumeration identifying the field.

See

SDLTextFieldName

Required

Objective-C

@property (readwrite, strong, atomic) SDLTextFieldName *name;

Swift

var name: SDLTextFieldName! { get set }

characterSet

@abstract The character set that is supported in this field.

See

SDLCharacterSet

Required

Objective-C

@property (readwrite, strong, atomic) SDLCharacterSet *characterSet;

Swift

var characterSet: SDLCharacterSet! { get set }

width

@abstract The number of characters in one row of this field.

Required, Integer 1 - 500

Objective-C

@property (readwrite, strong, atomic) NSNumber *width;

Swift

var width: NSNumber! { get set }

rows

@abstract The number of rows for this text field.

Required, Integer 1 - 8

Objective-C

@property (readwrite, strong, atomic) NSNumber *rows;

Swift

var rows: NSNumber! { get set }