ITextUIDListValue Class Reference

#include <ITextUIDListValue.h>

Inheritance diagram for ITextUIDListValue:

Public Member Functions
virtual void	GetTextAsValue (UIDList &valueOut, ITextDataValidation::RangeError *pnError=nil)=0
virtual void	SetTextFromValue (UIDList &valueIn, bool16 invalidate=kTrue, bool16 notifyOfChange=kTrue)=0
virtual void	ReformatText (bool16 invalidate=kTrue, bool16 notifyOfChange=kTrue)=0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

Data interface to convert string to UIDList and vice versa. This interface usually lives on the UI controls like edit box.

Member Function Documentation

virtual void ITextUIDListValue::GetTextAsValue ( UIDList &  valueOut, ITextDataValidation::RangeError *  pnError = nil  )

pure virtual

Convert the string text getting from the control to a UIDList. For example, for page range editboxes, it gets page range string and convert to a UIDList of pages. Error will be set if there is error in conversion.

Parameters

valueOut	[OUT]: the converted UIDList.
pnError	[OUT]: the error that happens in conversion, see also .

virtual void ITextUIDListValue::ReformatText ( bool16  invalidate = kTrue, bool16  notifyOfChange = kTrue  )

pure virtual

Reset the string of the control with the string passed in through ITextControlData. This intends to be called when the user changes the text, by typing and hitting return or selecting a new item from a popup.

Parameters

invalidate	[IN]: boolean flag indicates if we should do invalidation the control or not when we set the string value in the control, default value is kTrue.
notifyOfChange	[IN]: boolean flag indicates if we should do notification or not when we set the string value in the control, default value is kTrue.

virtual void ITextUIDListValue::SetTextFromValue ( UIDList &  valueIn, bool16  invalidate = kTrue, bool16  notifyOfChange = kTrue  )

pure virtual

Convert the given UIDList to string text and set it in the control. For example, for page range editboxes, it will take UIDList and convert it to page range string like "1-5, 7, 9, 10-12".

Parameters

valueIn	[IN]: the given UIDList.
invalidate	[IN]: boolean flag indicates if we should do invalidation the control or not when we set the string value in the control, default value is kTrue.
notifyOfChange	[IN]: boolean flag indicates if we should do notification or not when we set the string value in the control, default value is kTrue.