iPhone OS Reference Library Apple Developer Connection spyglass button

UIAlertView Class Reference

Inherits from
Conforms to
Framework
/System/Library/Frameworks/UIKit.framework
Availability
Available in iPhone OS 2.0 and later.
Declared in
UIAlert.h
Related sample code

Overview

Use the UIAlertView class to display an alert message to the user. An alert view functions similar to but differs in appearance from an action sheet (an instance of UIActionSheet).

Use the properties and methods defined in this class to set the title, message, and delegate of an alert view and configure the buttons. You must set a delegate if you add custom buttons. The delegate should conform to the UIAlertViewDelegate protocol. Use the show method to display an alert view once it is configured.

Tasks

Creating Alert Views

Setting Properties

Configuring Buttons

Displaying

Dismissing

Properties

For more about Objective-C properties, see “Properties” in The Objective-C Programming Language.

cancelButtonIndex

The index number of the cancel button.

@property(nonatomic) NSInteger cancelButtonIndex
Discussion

The button indices start at 0. If -1, then the index is not set.

Availability
Declared In
UIAlert.h

delegate

The receiver’s delegate or nil if it doesn’t have a delegate.

@property(nonatomic, assign) id delegate
Discussion

See UIAlertViewDelegate Protocol Reference for the methods this delegate should implement.

Availability
Declared In
UIAlert.h

firstOtherButtonIndex

The index of the first other button. (read-only)

@property(nonatomic, readonly) NSInteger firstOtherButtonIndex
Discussion

The button indices start at 0. If -1, then the index is not set. This property is ignored if there are no other buttons. The default value is -1.

Availability
Declared In
UIAlert.h

message

Descriptive text that provides more details than the title.

@property(nonatomic, copy) NSString *message
Availability
Declared In
UIAlert.h

numberOfButtons

The number of buttons on the alert view. (read-only)

@property(nonatomic, readonly) NSInteger numberOfButtons
Availability
Declared In
UIAlert.h

title

The string that appears in the receiver’s title bar.

@property(nonatomic, copy) NSString *title
Availability
Declared In
UIAlert.h

visible

A Boolean value that indicates whether the receiver is displayed. (read-only)

@property(nonatomic, readonly, getter=isVisible) BOOL visible
Discussion

If YES, the receiver is displayed; otherwise, NO.

Availability
Related Sample Code
Declared In
UIAlert.h

Instance Methods

addButtonWithTitle:

Adds a button to the receiver with the given title.

- (NSInteger)addButtonWithTitle:(NSString *)title

Parameters
title

The title of the new button.

Return Value

The index of the new button. Button indices start at 0 and increase in the order they are added.

Availability
  • Available in iPhone OS 2.0 and later.
See Also
Declared In
UIAlert.h

buttonTitleAtIndex:

Returns the title of the button at the given index.

- (NSString *)buttonTitleAtIndex:(NSInteger)buttonIndex

Parameters
buttonIndex

The index of the button. The button indices start at 0.

Return Value

The title of the button specified by index buttonIndex.

Availability
  • Available in iPhone OS 2.0 and later.
See Also
Declared In
UIAlert.h

dismissWithClickedButtonIndex:animated:

Dismisses the receiver, optionally with animation.

- (void)dismissWithClickedButtonIndex:(NSInteger)buttonIndex animated:(BOOL)animated

Parameters
buttonIndex

The index of the button that was clicked just before invoking this method. The button indices start at 0.

animated

YES if the receiver should be removed by animating it first; otherwise, NO if it should be removed immediately with no animation.

Availability
  • Available in iPhone OS 2.0 and later.
Declared In
UIAlert.h

initWithTitle:message:delegate:cancelButtonTitle:otherButtonTitles:

Convenience method for initializing an alert view.

- (id)initWithTitle:(NSString *)title message:(NSString *)message delegate:(id)delegate cancelButtonTitle:(NSString *)cancelButtonTitle otherButtonTitles:(NSString *)otherButtonTitles, ...

Parameters
title

The string that appears in the receiver’s title bar.

message

Descriptive text that provides more details than the title.

delegate

The receiver’s delegate or nil if it doesn’t have a delegate.

cancelButtonTitle

The title of the cancel button or nil if there is no cancel button.

Using this argument is equivalent to setting the cancel button index to the value returned by invoking addButtonWithTitle: specifying this title.

otherButtonTitles,

The title of another button.

Using this argument is equivalent to invoking addButtonWithTitle: with this title to add more buttons.

...

Titles of additional buttons to add to the receiver, terminated with nil.

Return Value

Newly initialized alert view.

Availability
  • Available in iPhone OS 2.0 and later.
See Also
Related Sample Code
Declared In
UIAlert.h

show

Displays the receiver using animation.

- (void)show

Availability
  • Available in iPhone OS 2.0 and later.
Related Sample Code
Declared In
UIAlert.h


Last updated: 2009-04-30

Did this document help you? Yes It's good, but... Not helpful...