NdefLibrary.Ndef.NdefTextRecord Class Reference

The Text record as specified by the NFC Forum URI record type definition. More...

Inheritance diagram for NdefLibrary.Ndef.NdefTextRecord:

Public Types
enum	TextEncodingType { Utf8, Utf16 }
	Text encoding to use - either Utf8 or Utf16 (big endian) More...
Public Types inherited from NdefLibrary.Ndef.NdefRecord
enum	TypeNameFormatType {   TypeNameFormatType.Empty = 0x00, TypeNameFormatType.NfcRtd = 0x01, TypeNameFormatType.Mime = 0x02, TypeNameFormatType.Uri = 0x03,   TypeNameFormatType.ExternalRtd = 0x04, TypeNameFormatType.Unknown = 0x05, TypeNameFormatType.Unchanged = 0x06, TypeNameFormatType.Reserved = 0x07 }
	Standardized type name formats, as defined by the NDEF record specification from the Nfc Forum. More...

Public Member Functions
	NdefTextRecord ()
	Create an empty Text record. More...
	NdefTextRecord (NdefRecord other)
	Create a Text record based on the record passed through the argument. More...
Public Member Functions inherited from NdefLibrary.Ndef.NdefRecord
	NdefRecord ()
	Create an empty record, not setting any information. More...
	NdefRecord (TypeNameFormatType tnf, byte[] type)
	Create a new record with the specified type name format and type. Doesn't set the payload and ID. More...
	NdefRecord (NdefRecord other)
	Create a new record, copying the information of the record sent through the parameter. More...
Type	CheckSpecializedType (bool checkForSubtypes)
	Checks the type name format and type of this record and returns the appropriate specialized class, if one is available and known for this record type. More...
virtual bool	CheckIfValid ()
	Checks if the contents of the record are valid; throws an exception if a problem is found, containing a textual description of the issue. More...

Static Public Member Functions
static bool	IsRecordType (NdefRecord record)
	Checks if the record sent via the parameter is indeed a Text record. Only checks the type and type name format, doesn't analyze if the payload is valid. More...

Static Public Attributes
static readonly byte []	TextType = { (byte)'T' }
	Type of the NDEF Text record (well-known, type 'T'). More...

Properties
string	LanguageCode [get, set]
	Language code that corresponds to the text. All language codes MUST be done according to RFC 3066 [RFC3066]. The language code MAY NOT be omitted. More...
string	Text [get, set]
	The text stored in the text record as a string. More...
TextEncodingType	TextEncoding [get, set]
	The encoding of the text - can be either Utf8 or Utf16. More...
Properties inherited from NdefLibrary.Ndef.NdefRecord
TypeNameFormatType	TypeNameFormat [get, set]
	Indicates the structure of the value of the TYPE field. More...
virtual byte []	Type [get, set]
	An identifier describing the type of the payload. More...
byte []	Id [get, set]
	An identifier in the form of a URI reference. More...
virtual byte []	Payload [get, set]
	The application data carried within an NDEF record. More...

Additional Inherited Members
Protected Attributes inherited from NdefLibrary.Ndef.NdefRecord
byte []	_type
	Byte array storing raw contents of the type. Use Type property to access it whenever possible. More...
byte []	_payload
	Byte array storing raw contents of the payload. Use Payload property to access it whenever possible. More...

Detailed Description

The Text record as specified by the NFC Forum URI record type definition.

Stores an arbritary string. Multiple text records can be part of a message, each of those should have a different language so that the reading device can choose the most appropriate language. Text can be encoded either in Utf-8 or Utf-16.

The text record is usually used within a Smart Poster record or other meta records, where the text contained here describes the properties of the other record, in order to for example guide the user.

Member Enumeration Documentation

TextEncodingType

enum NdefLibrary.Ndef.NdefTextRecord.TextEncodingType

strong

Text encoding to use - either Utf8 or Utf16 (big endian)

Constructor & Destructor Documentation

NdefTextRecord() [1/2]

NdefLibrary.Ndef.NdefTextRecord.NdefTextRecord

(

)

Create an empty Text record.

NdefTextRecord() [2/2]

NdefLibrary.Ndef.NdefTextRecord.NdefTextRecord

(

NdefRecord

other

)

Create a Text record based on the record passed through the argument.

Internalizes and parses the payload of the original record. The original record has to be a Text record as well.

Parameters

other

Record to copy into this Text record.

Exceptions

NdefException

Thrown if attempting to create a Text record based on an incompatible record type.

Member Function Documentation

IsRecordType()

static bool NdefLibrary.Ndef.NdefTextRecord.IsRecordType ( NdefRecord  record )

static

Checks if the record sent via the parameter is indeed a Text record. Only checks the type and type name format, doesn't analyze if the payload is valid.

Parameters

record

Record to check.

Returns

True if the record has the correct type and type name format to be a Text record, false if it's a different record.

Member Data Documentation

TextType

readonly byte [] NdefLibrary.Ndef.NdefTextRecord.TextType = { (byte)'T' }

static

Type of the NDEF Text record (well-known, type 'T').

Property Documentation

LanguageCode

string NdefLibrary.Ndef.NdefTextRecord.LanguageCode

getset

Language code that corresponds to the text. All language codes MUST be done according to RFC 3066 [RFC3066]. The language code MAY NOT be omitted.

Text

string NdefLibrary.Ndef.NdefTextRecord.Text

getset

The text stored in the text record as a string.

TextEncoding

TextEncodingType NdefLibrary.Ndef.NdefTextRecord.TextEncoding

getset

The encoding of the text - can be either Utf8 or Utf16.

---

The documentation for this class was generated from the following file:

• NdefLibrary/Ndef/NdefTextRecord.cs