Skip to content
Titanium SDK
Version13.4.1

Titanium.UI.AttributedString

proxyAndroidiPhoneiPadmacOSsince 3.6.0

Extends Titanium.Proxy

An attributed string proxy manages character strings and associated sets of attributes (for example, font and foregroundcolor) that apply to individual characters or ranges of characters in the string.

The AttributedString proxy is created with the Titanium.UI.createAttributedString method.

The text property must be set initially in the constructor when creating an attributed string. The attributes can either be set in the constructor or after it has been created.

For examples of Attributed Strings, see the Attributed Strings guide.

Examples

Adds an array of attributes to a label

Creates an AttributedString proxy, adds some attributes to it, and applies them to a <Titanium.UI.Label>.

var win = Titanium.UI.createWindow({
    backgroundColor: '#ddd',
});

win.open();

var text =  'Bacon ipsum dolor Titanium SDK rocks! sit amet fatback leberkas salami sausage tongue strip steak.';

var attr = Titanium.UI.createAttributedString({
    text: text,
    attributes: [
        // Underlines text
        {
            type: Titanium.UI.ATTRIBUTE_UNDERLINES_STYLE,
            value: Ti.UI.ATTRIBUTE_UNDERLINE_STYLE_SINGLE,
            range: [text.indexOf('Titanium'), ('Titanium').length]
        },
        // Sets a background color
        {
            type: Titanium.UI.ATTRIBUTE_BACKGROUND_COLOR,
            value: "red",
            range: [text.indexOf('Titanium'), ('Titanium').length]
        },
        {
            type: Titanium.UI.ATTRIBUTE_BACKGROUND_COLOR,
            value: "blue",
            range: [text.indexOf('Titanium'), ('Titanium').length]
        },
        {
            type: Titanium.UI.ATTRIBUTE_BACKGROUND_COLOR,
            value: "yellow",
            range: [text.indexOf('rocks!'), ('rocks!').length]
        },
        // Sets a foreground color
        {
            type: Titanium.UI.ATTRIBUTE_FOREGROUND_COLOR,
            value: "orange",
            range: [0,  text.length]
        },
        {
            type: Titanium.UI.ATTRIBUTE_FOREGROUND_COLOR,
            value: "black",
            range: [text.indexOf('rocks!'), ('rocks!').length]
        }
    ]
});

var label = Titanium.UI.createLabel({
    left: 20,
    right: 20,
    height: Titanium.UI.SIZE,
    attributedString: attr
});

win.add(label);

Adds attributes, one by one.

var win = Titanium.UI.createWindow({
    backgroundColor: '#ddd',
});

win.open();

var text =  'Bacon ipsum dolor Titanium SDK rocks! sit amet fatback leberkas salami sausage tongue strip steak.';

var attr = Titanium.UI.createAttributedString({
    text: text
});

// Underlines text
attr.addAttribute({
    type: Titanium.UI.ATTRIBUTE_UNDERLINES_STYLE,
    range: [0, text.length]
});

var label = Titanium.UI.createLabel({
    left: 20,
    right: 20,
    height: Titanium.UI.SIZE,
    attributedString: attr
});

win.add(label);

Links with underline color.

const win = Ti.UI.createWindow({
	backgroundColor: 'gray',
	layout: 'vertical'
});
const lbl_a = createLink();
const lbl_b = createLink();

colorLink(lbl_b);

win.add([lbl_a, lbl_b]);
win.open();

function createLink() {
	const label = Ti.UI.createLabel({
		top: 20,
		attributedString: Ti.UI.createAttributedString({
			text: 'Check out Titanium SDK',
			attributes: [{
				type: Ti.UI.ATTRIBUTE_LINK,
				value: 'https://titaniumsdk.com',
				range: [10, 12]
			}]
		})
	});

	label.addEventListener('link', e => {
		Ti.Platform.openURL(e.url);
	});

	return label;
}

function colorLink(lbl) {
	const attributedString = lbl.attributedString;
	const textColor = 'purple';
	const underlineColor = 'yellow';

	for (const attribute of attributedString.attributes) {
		if (attribute.type === Ti.UI.ATTRIBUTE_LINK) {

			// Set new link color.
			attributedString.addAttribute({
				type: Ti.UI.ATTRIBUTE_FOREGROUND_COLOR,
				value: textColor,
				range: attribute.range
			});

			// Set new underline color.
			attributedString.addAttribute({
				type: Ti.UI.ATTRIBUTE_UNDERLINE_COLOR,
				value: underlineColor,
				range: attribute.range
			});
		}
	}
}

Properties 5

apiName

Stringsince Android 3.2.0, iPhone 3.2.0, iPad 3.2.0, macOS 9.2.0read-only

Inherited from Titanium.Proxy

The name of the API that this proxy corresponds to.

bubbleParent

Booleansince Android 3.0.0, iPhone 3.0.0, iPad 3.0.0, macOS 9.2.0

Inherited from Titanium.Proxy

Indicates if the proxy will bubble an event to its parent.

Default: true

text

String

The text applied to the attributed string.

The text property must be set in the constructor and cannot be changed.

Methods 5

Adds an attribute with the given name and value to the characters in the specified range.

Parameters
ParametersTypeDescription
attributeAttribute

An attribute object.

Inherited from Titanium.Proxy

Adds the specified callback as an event listener for the named event.

Parameters
ParametersTypeDescription
nameString

Name of the event.

callbackCallback<Titanium.Event>

Callback function to invoke when the event is fired.

4 fields
bubbles Boolean

True if the event will try to bubble up if possible.

cancelBubble Boolean

Set to true to stop the event from bubbling.

source Object

Source object that fired the event.

type String

Name of the event fired.

Inherited from Titanium.Proxy

Fires a synthesized event to any registered listeners.

Parameters
ParametersTypeDescription
nameString

Name of the event.

event?Dictionary

A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.

Inherited from Titanium.Proxy

Removes the specified callback as an event listener for the named event.

Parameters
ParametersTypeDescription
nameString

Name of the event.

callbackCallback<Titanium.Event>

Callback function to remove. Must be the same function passed to addEventListener.

4 fields
bubbles Boolean

True if the event will try to bubble up if possible.

cancelBubble Boolean

Set to true to stop the event from bubbling.

source Object

Source object that fired the event.

type String

Name of the event fired.