sbITextPropertyInfo Interface Reference

The property information specific to text fields. More...

import"sbIPropertyInfo.idl";

Inheritance diagram for sbITextPropertyInfo:
[legend]
Collaboration diagram for sbITextPropertyInfo:
[legend]

Public Attributes

attribute unsigned long minLength
 Minimum length of string. More...
 
attribute unsigned long maxLength
 Maximum length of string. More...
 
attribute boolean enforceLowercase
 Must be lowercase (only valid for languages where this applies) More...
 
attribute boolean noCompressWhitespace
 The property value should not be formatted. More...
 
- Public Attributes inherited from sbIPropertyInfo
readonly attribute AString OPERATOR_EQUALS
 
readonly attribute AString OPERATOR_NOTEQUALS
 
readonly attribute AString OPERATOR_GREATER
 
readonly attribute AString OPERATOR_GREATEREQUAL
 
readonly attribute AString OPERATOR_LESS
 
readonly attribute AString OPERATOR_LESSEQUAL
 
readonly attribute AString OPERATOR_CONTAINS
 
readonly attribute AString OPERATOR_NOTCONTAINS
 
readonly attribute AString OPERATOR_BEGINSWITH
 
readonly attribute AString OPERATOR_NOTBEGINSWITH
 
readonly attribute AString OPERATOR_ENDSWITH
 
readonly attribute AString OPERATOR_NOTENDSWITH
 
readonly attribute AString OPERATOR_BETWEEN
 
readonly attribute AString OPERATOR_ISSET
 
readonly attribute AString OPERATOR_ISNOTSET
 
const unsigned long SORT_NULL_SMALL = 0
 Causes null values to be infinitely small. This is the default. More...
 
const unsigned long SORT_NULL_BIG = 1
 Causes null values to be infinitely large. More...
 
const unsigned long SORT_NULL_FIRST = 2
 Null values always first. More...
 
const unsigned long SORT_NULL_LAST = 3
 Null values always last. More...
 
attribute unsigned long nullSort
 Set where NULL values get sorted to. More...
 
attribute sbIPropertyArray secondarySort
 When sorting by this property, additionally sort by the following properties. More...
 
attribute AString id
 Unique ID for this property. More...
 
attribute AString type
 The type property. More...
 
attribute AString displayName
 Localized display name of this property. More...
 
attribute AString localizationKey
 Key used to find related localization strings. More...
 
attribute boolean userViewable
 A user may view this property. This does not impede reading the value, it's merely meant as a guideline. More...
 
attribute boolean userEditable
 A user may edit this property. This does not impede editing the value, it's merely meant as a guideline. More...
 
attribute boolean remoteReadable
 A web site may read the value of this property. More...
 
attribute boolean remoteWritable
 A web site may write the value of this property. More...
 
attribute boolean usedInIdentity
 This attribute indicates that changing this property may change the computed hash for the item. If a property with usedInIdentity of true is changed, the identity is recalculated. More...
 
attribute nsISimpleEnumerator operators
 True if this property has a selection list. More...
 
readonly attribute
sbIPropertyUnitConverter 
unitConverter
 A unit converter to convert to and from the units in which the property can be expressed. More...
 

Additional Inherited Members

- Public Member Functions inherited from sbIPropertyInfo
sbIPropertyOperator getOperator (in AString aOperator)
 Get the sbIPropertyOperator for the given operator string. More...
 
boolean validate (in AString aValue)
 Validates the string for this property type. More...
 
AString sanitize (in AString aValue)
 Sanitize a value so that it passes validation. More...
 
AString format (in AString aValue)
 Formats the value for display. More...
 
AString makeSortable (in AString aValue)
 Transforms the string into its sortable collation data equivalent. More...
 
AString makeSearchable (in AString aValue)
 Formats the value to enable proper search. More...
 

Detailed Description

The property information specific to text fields.

See Also
sbIPropertyInfo

Definition at line 231 of file sbIPropertyInfo.idl.

Member Data Documentation

attribute boolean sbITextPropertyInfo::enforceLowercase

Must be lowercase (only valid for languages where this applies)

Definition at line 246 of file sbIPropertyInfo.idl.

attribute unsigned long sbITextPropertyInfo::maxLength

Maximum length of string.

Definition at line 241 of file sbIPropertyInfo.idl.

attribute unsigned long sbITextPropertyInfo::minLength

Minimum length of string.

Definition at line 236 of file sbIPropertyInfo.idl.

attribute boolean sbITextPropertyInfo::noCompressWhitespace

The property value should not be formatted.

Definition at line 251 of file sbIPropertyInfo.idl.


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