FMX.Grid.TStringGridModel Methods

From RAD Studio API Documentation
Jump to: navigation, search

AfterConstructionpublicResponds after the last constructor has executed.
AssignpublicCopies the contents of another similar object.
AssignToprotectedCopies the properties of an object to a destination object.
BeforeDestructionpublicResponds before the first destructor executes.
BeginUpdatepublicMarks the start of an update session of this model.
CanNotifypublicReturns whether TMessageSender can send messages.
ClassInfopublicReturns a pointer to the run-time type information (RTTI) table for the object type.
ClassNamepublicReturns a string indicating the type of the object instance (as opposed to the type of the variable passed as an argument).
ClassNameIspublicDetermines whether an object is of a specific type.
ClassParentpublicReturns the type of the immediate ancestor of a class.
ClassTypepublicReturns the class reference for the object's class.
CleanupInstancepublicPerforms finalization on long strings, variants, and interface variables within a class.
ClearCachepublicClears the internal cache.
ClearColumnInCachepublicClears all values of the column with the specified column number in the internal cache.
ClearRowInCachepublicClears all values of the row with the specified row number in the internal cache.
ColumnChangedpublicNotifies the presentation of changes within the column with the specified column number.
ContentChangedpublicNotifies the presentation of changes in the content of the grid that affect the whole grid, such as size, count or order changes that affect columns or rows.
CreatepublicCreates an instance of TDataModel.
CreateCacheprotectedCreates the instance of TGridValues or a subclass for the internal cache.
CreateReceiverprotectedCreates a receiver for messages.
DataChangedpublicRemoves from the cache the value of the cell specified by ACol and ARow and sends the message to invalidate this cell.
DefaultHandlerpublicProvides the interface for a method that processes message records.
DefinePropertiesprotectedProvides an interface for a method that reads and writes otherwise unpublished data.
DestroypublicDestroys this instance of TStringGridModel.
DisableNotifypublicDisables TMessageSender from sending messages.
DispatchpublicCalls message-handling methods for the object, based on the contents of the Message parameter.
DisposeOfpublicDisposeOf forces the execution of the destructor code in an object.
DoCallbackGetValueprotectedDispatches the OnCallbackGetValue event if an event handler is defined, or executes ACallback otherwise.
DoColumnAddedprotectedMethod executed after a successful column insertion.
DoColumnRemovedprotectedMethod executed after a successful column removal.
DoDrawColumnCellprotectedDispatcher of the OnDrawColumnCell event.
DoEndUpdateprotectedApplies all the changes performed on the model during the current update session.
DoGetValueprotectedReturns the value of the cell located at the specified column number and row number.
DoRowCountChangedprotectedMethod that is executed when the number of rows changes.
DoSelChangedprotectedDispatches the OnSelChanged event.
DoSelectCellprotectedDispatches the OnSelectCell event.
DoSetValueprotectedUpdates the value of the cell at the specified column number and row number in the underlying data source to the specified value.
DoTextSettingsChangedprotectedMethod that is called after TextSettings or StyledSettings change to handle these changes.
DoViewportPositionChangepublicThis method is called when ScrollBox changes the content position or size.
EnableNotifypublicEnables TMessageSender to send messages.
EndUpdatepublicMarks the end of an update session of this model.
EqualspublicChecks whether the current instance and the Obj parameter are equal.
FieldAddresspublicReturns the address of a published object field.
FindNextCellpublicFills ACol and ARow with the column number and the row number of the cell that can be selected after the current cell, and returns True on success of False if a cell cannot be found.
FreepublicDestroys an object and frees its associated memory, if necessary.
FreeInstancepublicDeallocates memory allocated by a previous call to the NewInstance method.
FreeReceiverprotectedFrees the Receiver of the TMessageSender.
GetDefaultGridOptionsprotectedGetter of DefaultGridOptions.
GetDefaultTextSettingsprotectedGetter of DefaultTextSettings.
GetDisposedprotectedGetter for the Disposed property.
GetEditorValueprotectedReturns the current value of the cell editor if the grid is in editor mode, or TValue.Empty otherwise.
GetHashCodepublicReturns an integer containing the hash code.
GetInterfacepublicRetrieves a specified interface.
GetInterfaceEntrypublicReturns the entry for a specific interface implemented in a class.
GetInterfaceTablepublicReturns a pointer to a structure containing all of the interfaces implemented by a given class.
GetNamePathpublicReturns the name of the object as it appears in the Object Inspector.
GetOwnerprotectedReturns the owner of an object.
GetResultingTextSettingsprotectedGetter of ResultingTextSettings.
GetStyledSettingsprotectedGetter of StyledSettings.
GetTextSettingsprotectedGetter of TextSettings.
GetTextSettingsClassprotectedReturns a reference to the subclass of TCustomTextSettings that encapsulates the text settings.
GetValuepublicReturns the value of the cell located at the specified column number and row number.
HasReceiverpublicReturns whether TMessageSender has a Receiver.
HideEditorpublicNotifies the presentation that it should hide the cell editor and exit the editor mode.
IndexOfColumnpublicReturns the column number of the specified column, or -1 if the column cannot be found.
InheritsFrompublicDetermines the relationship of two object types.
InitInstancepublicInitializes a newly allocated object instance to all zeros and initializes the instance's virtual method table pointer.
InsertColumnpublicInserts the specified column into the model, at the specified column number.
InsertColumnIntoCachepublicInserts the column with the specified column number into the internal cache.
InstanceSizepublicReturns the size in bytes of each instance of the object type.
InvalidateContentSizepublicNotifies the presentation that the previously calculated content size is no longer valid.
IsOpaquepublicIndicates if the control should update effects when you scroll content.
IsUpdatingpublicReturns True if the model is in the middle of one or more update sessions, or False otherwise.
MethodAddresspublicReturns the address of a class method by name.
MethodNamepublicReturns the name of a class method by address.
MoveColumnpublicChanges to NewIndex the column number of the column at OldIndex.
MoveColumnInCachepublicMoves the column with the specified column number (OldIndex) to the specified column number (NewIndex) in the internal cache.
NewInstancepublicAllocates memory for an instance of an object type and returns a pointer to that new instance.
PostEditorValuepublicNotifies the presentation that it should update the value being edited.
QualifiedClassNamepublicReturns the qualified name of the class.
ReduceCachepublicReduces the internal cache so that only the cells within the specified boundaries stay in the internal cache.
RefreshEditorValuepublicNotifies the presentation that it should refresh a value in the cell editor.
RemoveColumnpublicRemoves the column that has the specified column number.
RemoveColumnFromCachepublicRemoves the column with the specified column number from the internal cache.
RemoveRowFromCachepublicRemoves the row with the specified row number from the internal cache.
SafeCallExceptionpublicHandles exceptions in methods declared using the safecall calling convention.
SelectCellpublicSelect the cell with the specified column number and row number.
SelectionChangedpublicNotifies the presentation of changes to the row number or to the column number of the current selection.
SendMessagepublicSends a message to an object.
SendMessageWithResultpublicSends a message to an object getting a result.
SetStyledSettingsprotectedSetter of StyledSettings.
SetTextSettingsprotectedSetter of TextSettings.
ShowEditorpublicNotifies the presentation that it should show the cell editor and enter the editor mode.
StyledSettingsStoredprotectedFunction that ensures that the value of StyledSettings is only stored in the form file if it is not the default value of the property.
ToStringpublicReturns a string containing the class name.
UnitNamepublicReturns the name of the unit where the class is defined.
UnitScopepublicReturns the class's unit scope.
ValueChangedprotectedIs called when the value of a cell located in the specified grid coordinates of the string grid changes.