WOString

Element Description

A WOString represents itself in the HTML page as a dynamically generated string.

Synopsis

WOString { value=aString; [formatter=formatterObj;] [escapeHTML=aBoolean; ] [dateformat=dateFormatString;] [numberformat=numberFormatString;] [valueWhenEmpty=emptyString... };

Bindings

value: Text to display in the HTML page. value is typically assigned an NSString object, an object that responds to a description message by returning an NSString, or a method that returns an NSString. The NSString's contents are substituted into the HTML in the place occupied by this dynamic element.

escapeHTML: If escapeHTML evaluates to true (or YES ), the string rendered by value is converted so that characters which would be interpreted as HTML control characters become their escaped equivalent (this is the default). Thus, if a your value is "a bold idea", the string passed to the client browser would be "a bold idea", but it would display in the browser as "a bold idea". If escapeHTML evaluates to false (or NO), WebObjects simply passes your data to the client browser "as is." In this case, the above example would display in the client browser as "a bold idea". If you are certain that your strings have no characters in them which might be interpreted as HTML control characters, you get better performance if you set escapeHTML to false (or NO).

formatter

An instance of an NSFormatter subclass to be used to format object values for display as strings. This attribute should specify a variable containing (or method returning) a preconfigured formatter object. For instance, a WOString might have the binding:

formatter = application.dateFormatter

With the following code:

// Application.wos
NSFormatter *_dateFormatter;

- (NSFormatter *)dateFormatter {
    if (!_dateFormatter) {
        _dateFormatter = [[NSDateFormatter alloc]               initWithDateFormat:@"%m/%d/%Y"             allowNaturalLanguage:NO];
    }
    return _dateFormatter;
}

If a user enters an "unformattable" value, WOString passes the invalid value through, allowing you to send back an error page that shows the invalid value.

dateformat: A format string that specifies how value should be formatted as a date. If a date format is used, value can be assigned an NSCalendarDate object (if it is assigned an NSString object, it is stored as the string representation of an NSCalendarDate object). If the element's value can't be interpreted according to the format you specify, value is set to nil. See the NSCalendarDate class specification for a description of the date format syntax.

numberformat: A format string that specifies how value should be formatted as a number. If a number format is used, value must be assigned an NSNumber object. If the element's value can't be interpreted according to the format you specify, value is set to nil. See the NSNumberFormatter class specification for a description of the number format syntax.

valueWhenEmpty: A string that will be substituted for value when value is the empty string.