FMX.Layouts.TCustomScrollBox Methods

From RAD Studio API Documentation
Jump to: navigation, search

_AddRefprotectedCalled when an application uses a component interface.
_ReleaseprotectedCalled when an application releases a component interface.
AbsoluteToLocalpublicTranslates coordinated of the specified Point from an global perspective to a local coordinates of this control.
AbsoluteToLocalVectorpublicTransforms and returns a specified vector from the absolute perspective to the local perspective.
ActionChangeprotectedSpecifies the behavior of a TControl control when Action changes.
AddFreeNotifypublicAdds AObject to the list of objects to be notified when this TFmxObject is destroyed.
AddObjectpublicAdds the AObject object to the Children list of children attached to this parent object (self).
AddObjectsToListpublicAdds the children of this object to the given list.
AdjustFixedSizeprotectedSets the fixed size of the control.
AdjustSizeprotectedSets the size of the control.
AfterConstructionpublicResponds after the last constructor has executed.
AncestorParentChangedprotectedNotifies its child controls that the parent of an ancestor of your control has changed.
AncestorVisibleChangedprotectedNotifies its child controls that the visibility of an ancestor of your control has changed to Visible.
AnimateColor (deprecated)publicCreates a TColorAnimation for this object (self).
AnimateFloat (deprecated)publicCreates and runs a TFloatAnimation for this object (self).
AnimateFloatDelay (deprecated)publicCreates a TFloatAnimation for this object (self).
AnimateFloatWait (deprecated)publicCreates a TFloatAnimation for this object (self) and does not return until the animation is finished.
AnimateInt (deprecated)publicCreates and runs a TIntAnimation for this object (self).
AnimateIntWait (deprecated)publicCreates a TIntAnimation for this object (self) and does not return until the animation is finished.
ApplyEffectprotectedApplies effects to the control, if specified.
ApplyStyleLookuppublicGets and applies the style of a TStyledControl.
ApplyTriggerEffectpublicApplies the specified mouse trigger effect to all the children of this FMX object that are of type TEffect.
AssignpublicCopies the contents of another similar object.
AssignToprotectedCopies the properties of an object to a destination object.
AsyncScheduleprotectedSchedules asynch method calls.
BeforeDestructionpublicPerforms any necessary actions before the first destructor is called.
BeforeEffectEnabledChangedprotectedExecuted right before the value of the Enabled property of an effect changes, and provides the value of the property before it changes.
BeginAutoDragprotectedBegins the drag operation automatically.
BeginInvokepublicPerforms an asynchronous call to the method specified by either AProc or AFunc.
BeginUpdatepublicMarks the start of an update session of the control and its children.
BringToFrontpublicBrings this FMX visual object on top of other overlapping visual controls that are on the same form.
CaptureprotectedSaves the control that currently captures all the mouse messages.
CenterpublicScrolls to the center of the TScrollBox control.
ChangeNameprotectedSets the private, internal storage for the Name property to the string passed in NewName.
CheckForAllowFocusprotectedVerifies whether the current control can receive focus.
ChildrenAlignChangedprotectedExecuted when the alignment of the children of the control changes.
ChooseAdjustTypeprotectedReturns an adjust type based on the provided FixedSize.
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.
ClickprotectedResponds to user clicks, key pressing, and input on touch devices (gestures).
ClientHeightpublicspecifies the height of the component’s content (in dp).
ClientWidthpublicspecifies the width of the component’s content (in dp).
ClipChildrenChangedprotectedExecuted right after the value of the ClipChildren property changes.
ClonepublicReturns a new cloned instance of this FMX object.
ContainsObjectpublicReturns True if the specified object is a direct child.
ContentAddObjectprotectedVirtual method to be implemented in subclasses to provide further functionality when adding AObject to the scroll box.
ContentBeforeRemoveObjectprotectedVirtual method to be implemented in subclasses to provide further functionality right before removing AObject from the scroll box.
ContentRectprotectedReturns the rectangle that defines the scrolling area.
ContentRemoveObjectprotectedVirtual method to be implemented in subclasses to provide further functionality right after removing AObject from the scroll box.
CreateAniCalculationsprotectedConstructs a TScrollCalculations type object in which you can set properties and calculate parameters of the inertial scrolling.
DblClickprotectedResponds to user double-clicks.
DefaultHandlerpublicProvides the interface for a method that processes message records.
DeleteChildrenpublicDeletes all the children of this FMX object.
DestroyComponentspublicDestroys all owned components.
DestroyingpublicIndicates that the component and its owned components are about to be destroyed.
DialogKeyprotectedProcesses a dialog key.
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.
DoActionChangeprotectedTBasicAction.OnChange event dispatcher.
DoApplyStyleLookupprotectedExecuted internally each time ApplyStyleLookup is called for this TStyledControl object.
DoCalcContentBoundsprotectedCalculates the ContentBounds rectangle bounding all controls in the scrolling region.
DoDeactivateprotectedDispatcher of the OnDeactivate event.
DoEnterprotectedResponds when receiving input focus.
DoExitprotectedOnExit event dispatcher.
DoGestureprotectedProcesses the unhandled gesturing events.
DoMouseEnterprotectedOnMouseEnter event dispatcher.
DoPaintprotectedProcesses the painting of the control.
DoRealignprotectedPerforms the realignment of the children controls of the TScrollBox object within the object.
DoRealignContentprotectedChanges the bounding rectangle of the content of the control to the specified rectangle, and realigns its child controls accordingly.
DoSetHeight (deprecated)protected
DoSetWidth (deprecated)protected
DoStyleChangedprotectedIndicates that the control needs to update the style and calls Repaint.
DoUpdateAniCalculationsprotectedSets the default inertial scrolling properties for the current platform.
DragDropprotectedOnDragDrop event dispatcher.
DragEndprotectedOnDragEnd event dispatcher.
DragEnterprotectedOnDragEnter event dispatcher.
DragLeaveprotectedOnDragLeave event dispatcher.
DragOverprotectedOnDragOver event dispatcher.
EffectEnabledChangedprotectedExecuted right after the value of the Enabled property of an effect changes, and provides the new value of the property.
EnabledChangedprotectedExecuted right after the value of the Enabled property changes.
EndFunctionInvokepublicBlocks the caller until the specified ASyncResult completes.
EndInvokepublicBlocks the caller until the specified ASyncResult completes.
EndUpdatepublicMarks the end of an update session of the control and its children.
EnterChildrenprotectedChecks whether the input is taken by the control or by its parent.
EnumControls (deprecated)publicLoops through the controls that are children of this control, and runs the specified procedure once per control, with a different control as the first parameter in each call.
EnumObjectspublicLoops through the children of this object, and runs the specified procedure once per object as the first parameter in each call.
EqualspublicChecks whether the current instance and the Obj parameter are equal.
ExchangepublicExchanges two objects from the children list.
ExecuteActionpublicExecutes an action.
FieldAddresspublicReturns the address of a published object field.
FillTextFlagsprotectedReturns the filling direction of the control's text.
FindAndCloneStyleResourcepublicFinds the specified resource object and makes a copy.
FindComponentpublicIndicates whether a given component is owned by the component.
FindStyleResourcepublicFinds the linked resource object for the style specified by name.
FindTargetprotectedReturns the target control.
FreepublicDestroys an object and frees its associated memory, if necessary.
FreeInstancepublicDeallocates memory allocated by a previous call to the NewInstance method.
FreeOnReleasepublicFrees the interface reference for components that were created from COM classes.
GenerateStyleNameprotectedGenerates a style lookup name based on the provided AClassName.
GetAbsoluteEnabledprotectedGetter function for the AbsoluteEnabled property.
GetAbsoluteMatrixprotectedGetter function for the AbsoluteMatrix property.
GetAbsoluteOpacityprotectedGetter function for the AbsoluteOpacity property.
GetAbsoluteRectprotectedGetter function for the AbsoluteRect property.
GetAbsoluteScaleprotectedGetter function for the AbsoluteScale property.
GetAcceptsControlsprotectedGetter function for the AcceptsControls property.
GetAlignprotectedGetter function for the Align property.
GetAllowAlignprotectedGetter function for the AllowAlign property.
GetAnchorMoveprotectedGetter function for the AnchorMove property.
GetAnchorOriginprotectedGetter function for the AnchorOrigin property.
GetAnchorRulesprotectedGetter function for the AnchorRules property.
GetAnchorsprotectedGetter function for the Anchors property.
GetBackIndexprotectedGets the index of TStyledControl.
GetBoundsRectprotectedGetter function for the BoundsRect property.
GetChildOwnerprotectedReturns the owner of a child component being read from a stream.
GetChildParentprotectedReturns the parent or, if there is no parent, returns the owner of a child component being read from a stream.
GetChildrenMatrixprotectedReturns the children transformation matrix.
GetChildrenRectprotectedGetter function for the ChildrenRect property.
GetClipRectprotectedGetter function for the ClipRect property.
GetContainerHeightprotectedGetter function for the ContainerHeight property.
GetContainerWidthprotectedGetter function for the ContainerWidth property.
GetContentBoundsprotectedReturns the boundaries of the rectangle that defines the scrolling area.
GetDataprotectedProtected getter implementation for the Data property.
GetDefaultSizeprotectedGetter of DefaultSize.
GetDefaultStyleLookupNameprotectedProtected getter implementation for the DefaultStyleLookupName property.
GetDesignInteractiveprotectedGetter function for the DesignInteractive property.
GetDisposedprotectedGetter for the Disposed property.
GetDragModeprotectedGetter function for the DragMode property.
GetEffectsRectprotectedReturns the rectangle occupied by the effects applied over the control.
GetEnumeratorpublicReturns a TComponent enumerator.
GetHashCodepublicReturns an integer containing the hash code.
GetHeightprotectedGetter function for the Height property.
GetHintObjectprotectedReturns the custom hint object that manages the hint display.
GetHintStringprotectedReturns the text of the hint.
GetHitTestprotectedGetter function for the HitTest property.
GetIDsOfNamesprotectedMaps a single member and an optional set of argument names to a corresponding set of integer dispatch identifiers (dispIDs).
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.
GetLeftprotectedGetter function for the Left property.
GetLocalRectprotectedGetter function for the LocalRect property.
GetLockedprotectedGetter function for the Locked property.
GetMarginsprotectedGetter function for the Margins property.
GetNamePathpublicReturns a string used by the Object Inspector.
GetObjectprotectedReturns the current control as a TFmxObject.
GetObserversprotectedGetter of Observers.
GetOriginalParentSizeprotectedGetter function for the OriginalParentSize property.
GetOwnerprotectedReturns the owner of a component.
GetPaddingprotectedGetter function for the Padding property.
GetParentClassStyleLookupNameprotectedGetter for the ParentClassStyleLookupName property.
GetParentComponentpublicReturns the containing component.
GetParentedRect (deprecated)protectedGetter function for the ParentedRect property.
GetParentedVisibleprotectedReturns the value of the ParentedVisible property.
GetResourceControlprotectedReturns the style resource for this control as TControl.
GetResourceLinkprotectedReturns the style resource for this control as TFmxObject.
GetStyleContextprotectedReturns context for behavior manager.
GetStyleObjectprotectedGets the style resource object linked to TStyledControl.
GetTopprotectedGetter function for the Top property.
GetTypeInfoprotectedRetrieves the type information for an object.
GetTypeInfoCountprotectedReturns the number of type information interfaces that an object provides (either 0 or 1).
GetUpdateRectprotectedGetter function for the UpdateRect property.
GetVisibleprotectedGetter function for the Visible property.
GetWidthprotectedGetter function for the Width property.
HandleSizeChangedprotectedExecuted right after the value of the Size property changes.
HasHintprotectedReturns True if the control has an available hint to display.
HasParentpublicVerifies whether the component has a parent.
HitTestChangedprotectedExecuted right after the value of the HitTest property changes.
HScrollBarValueprotectedReturns the position of the horizontal scroll bar.
HScrollChangeprotectedInternally called when the horizontal scroll bar changes position.
InheritsFrompublicDetermines the relationship of two object types.
InitiateActionprotectedCalls the action link's Update method if the control is associated with an action link.
InitInstancepublicInitializes a newly allocated object instance to all zeros and initializes the instance's virtual method table pointer.
InsertComponentpublicEstablishes the component as the owner of a specified component.
InsertObjectpublicAdds the object provided in the parameter to the FChildren TList of this object (self), at the specified position (index).
InstanceSizepublicReturns the size in bytes of each instance of the object type.
InvalidateRectpublicAdds a rectangle to the update region of the scene.
InViewRectpublicInternally used.
InvokeprotectedProvides access to Automation properties and methods when the component wraps an Automation object.
IsChildpublicReturns True if the specified object is a child.
IsControlRectEmptyprotectedReturns True if the control rect is empty.
IsHeightStored (deprecated)protected
IsHelpContextStoredprotectedSpecifies whether HelpContext is stored.
IsImplementorOfpublicIndicates whether the component implements a specified interface.
IsOpaqueprotectedIndicates if the control should update effects when you scroll content.
IsUpdatingpublicReturns True if this control is in the middle of one or more update sessions.
IsWidthStored (deprecated)protected
KeyDownprotectedProvides a response when a key is pressed down while the control has the keyboard focus.
KeyUpprotectedOnKeyUp event dispatcher.
LocalToAbsolutepublicTransforms and returns a specified point from the local perspective to the absolute perspective.
LocalToAbsoluteVectorpublicTransforms and returns a specified vector from the local perspective to the absolute perspective.
LocalToScreenpublicTransforms and returns a specified point from the local perspective to the screen perspective.
LockpublicLocks the current control, so it cannot be changed at design time.
LookupStyleObjectpublicLooks for the style resource object linked to the TStyledControl.
MakeScreenshotpublicTakes and returns a screenshot of the control.
MethodAddresspublicReturns the address of a class method by name.
MethodNamepublicReturns the name of a class method by address.
MouseClickprotectedCalls Click and starts the animation by calling StartTriggerAnimation.
MouseDownprotectedInternally executed while a mouse button is pressed over the surface of this scroll box.
MouseMoveprotectedInternally executed while the mouse is moved over the surface of this scroll box.
MouseUpprotectedInternally executed while a mouse button is released over the surface of this scroll box.
MouseWheelprotectedInternally executed while the mouse wheel is used over the surface of this scroll box.
NeedStyleLookuppublicCall this procedure to indicate that this control requires to get and apply its style lookup.
NewInstancepublicAllocates memory for an instance of an object type and returns a pointer to that new instance.
ObjectAtPointprotectedReturns the control in which a specified point can be found.
ObjectState (deprecated)publicDescribes the current state of the object.
operator ()publicC++ conversion into an interface.
PaddingChangedprotectedApplies the padding
PaintprotectedRenders the control's surface.
PaintChildrenprotectedRenders the child controls.
PaintTopublicPaints the current control to a specified canvas.
ParentChangedprotectedExecuted right after the value of the Parent property changes.
PointInObjectpublicChecks whether the point, specified by the absolute coordinates, belongs to the control area.
PointInObjectLocalpublicChecks whether the point specified by local coordinates belongs to the control area.
QualifiedClassNamepublicReturns the qualified name of the class.
QueryInterfaceprotectedReturns a reference to a specified interface if the current component supports that interface.
ReadStateprotectedReads the state of the component.
RealignprotectedPerforms the realignment of the control's children within itself.
RealignContentpublicRealigns the children controls of this scroll box in the scrolling area of this scroll box.
RecalcAbsolutepublicForces the current control to recalculate the AbsoluteMatrix property.
RecalcAbsoluteNowpublicRecalculates AbsoluteMatrix.
RecalcEnabledpublicForces the current control to recalculate its enabled state.
RecalcHasClipParentpublicForces the current control to recalculate its HasClipParent property.
RecalcHasEffectpublicForces the current control to recalculate its HasEffect property.
RecalcOpacitypublicForces the current control to recalculate its Opacity property.
RecalcUpdateRectpublicForces the current control to recalculate its UpdateRect property.
ReferenceInterfacepublicEstablishes or removes internal links that cause this component to be notified when the implementer of a specified interface is destroyed.
ReleasepublicMarks this TFmxObject object for delayed deletion.
ReleaseCaptureprotectedPrevents the control from currently capturing all the mouse messages.
Released (deprecated)publicReturns True if this object has been released from memory.
RemoveComponentpublicRemoves a specified component specified from the component's Components list.
RemoveFreeNotificationpublicDisables the destruction notification that was enabled by FreeNotification.
RemoveFreeNotificationsprotectedNotifies all owned components of the owner component's imminent destruction.
RemoveFreeNotifypublicRemoves the given object from the free notifications list.
RemoveObjectpublicRemoves a children object from its parent.
RepaintpublicForces the control to repaint its image on the screen.
RepaintJointAreaclass protected
RequestStyleDataprotectedRequests the value of the StylesData property of the style object.
ResetFocuspublicRemoves the focus from a control
ResizeprotectedOnResize event dispatcher.
SafeCallExceptionpublicHandles exceptions in methods declared using the safecall calling convention.
ScreenToLocalpublicTransforms and returns a specified point from the screen perspective to the local perspective.
ScrollBypublicScrolls the view according to the given Dx and Dy offsets (relative to the current position) in the TScrollBox control.
ScrollTo (deprecated)publicScrollTo simply calls ScrollBy.
SendToBackpublicSends this FMX visual object to the background letting other overlapping visual controls that are on the same form to be on top of it.
SetAcceptsControlsprotectedSetter function for the AcceptsControls property.
SetAlignprotectedSetter function for the Align property.
SetAncestorprotectedClears or sets csAncestor state in the component's ComponentState property.
SetAnchorMoveprotectedSetter function for the AnchorMove property.
SetAnchorsprotectedSetter function for the Anchors property.
SetBoundspublicSets the boundaries of the current control.
SetBoundsRectprotectedSetter function for the BoundsRect property.
SetChildOrderprotectedSets the visual ordering of a child control.
SetDataprotectedProtected setter implementation for the Data property.
SetDesignpublicSets the csDesigning in TComponentState. Used internally by the IDE.
SetDesigningprotectedEnsures that components inserted at design time have their design-mode flag set.
SetDesignInstanceprotectedEnsures that components inserted at design time have their design-mode flag set.
SetDragModeprotectedSetter function for the DragMode property.
SetEnabledprotectedSetter of Enabled.
SetFocuspublicSets the focus to the current control, if CanFocus is True.
SetHeightprotectedSetter function for the Height property.
SetHelpContextprotectedSetter method for the HelpContext property.
SetHelpKeywordprotectedSetter method for the HelpKeyword property.
SetHintprotectedSetter for the Hint property.
SetInlineprotectedSets the csInline bit of the component's ComponentState property.
SetInPaintToprotectedSets the InPaintTo property.
SetLeftprotectedSetter function for the Left property.
SetNameprotectedSets the value of the Name property.
SetNewScenepublicSets a new Scene for the current control.
SetParentprotectedProtected setter implementation for the Parent property.
SetPopupMenuprotectedSetter function for the PopupMenu property.
SetRootpublicSets the Root property of each child in the children list.
SetSubComponentpublicIdentifies whether the component is a subcomponent.
SetTopprotectedSetter function for the Top property.
SetVisibleprotectedSetter function for the Visible property.
SetWidthprotectedSetter function for the Width property.
ShouldTestMouseHitspublicIndicates whether a control should be ignored in ObjectAtPoint.
ShowContextMenuprotectedDisplays the PopupMenu context menu of this control on the specified ScreenPosition screen point.
SortpublicSorts components of the layout based on the comparison function Compare.
StopPropertyAnimationpublicStops the animation of the specified property of this FMX object.
TapprotectedCalled when the Tap gesture on the style presentation is recognized.
ToStringpublicReturns a string containing the class name.
UnitNamepublicReturns the name of the unit where the class is defined.
UnitScopepublicReturns the class's unit scope.
UpdateActionpublicUpdates the state of an action.
UpdateAniCalculationsprotectedInitializes the inertial scrolling and sets its properties.
UpdateEffectspublicUpdates the effects of the current control and of the control's parent.
UpdateExplicitBoundsprotectedUpdates the explicit bounds' properties of the control.
UpdateRegistryprotectedProvides the interface for a method that adds type library and version information to the Registry on components that implement COM interfaces.
UpdatingprotectedSets the csUpdating state in the component's ComponentState property.
ValidateContainerprotectedDetermines whether an object can be inserted into a container.
ValidateInsertprotectedProvides the interface for a method that validates a child component before it is inserted.
ValidateRenameprotectedEnsures that renaming an owned component does not create a name conflict.
ViewportPositionChangeprotectedExecuted when the viewport position changes.
VisibleChangedprotectedExecuted right after the value of the Visible property changes.
VisibleStoredprotectedReturns True when the Visible property needs to be stored in the fmx-file.
VScrollBarValueprotectedReturns the position of the vertical scroll bar.
VScrollChangeprotectedInternally called when the vertical scroll bar changes position.
WriteStateprotectedWrites the state of the component.