Classes.TComponent Methods

From RAD Studio VCL Reference
Jump to: navigation, search

Delphi Information

procedure ChangeName(const NewName: TComponentName);

Sets the private, internal storage for the Name property to the string passed in NewName.

procedure GetChildren(Proc: TGetChildProc; Root: TComponent); dynamic;

Enumerates all child components.

function GetChildOwner(): TComponent; dynamic;

Returns the owner of a child component being read from a stream.

function GetChildParent(): TComponent; dynamic;

Returns the parent, or if there is no parent, returns the owner of a child component being read from a stream.

procedure Loaded virtual;

Initializes the component after the form file has been read into memory.

procedure Notification(AComponent: TComponent; Operation: TOperation); virtual;

Forwards notification messages to all owned components.

procedure PaletteCreated dynamic;

Responds when the component is created from the component palette.

procedure ReadState(Reader: TReader); virtual;

Reads the state of the component.

procedure SetAncestor(Value: Boolean);

Clears or sets csAncestor state in the component's ComponentState property.

procedure SetDesigning(Value: Boolean; SetChildren: Boolean = True);

Ensures that components inserted at design time have their design-mode flag set.

procedure SetInline(Value: Boolean);

Sets the csInline bit of the component's ComponentState property

procedure SetDesignInstance(Value: Boolean);

Ensures that components inserted at design time have their design-mode flag set.

procedure SetName(const NewName: TComponentName); virtual;

Sets the value of the Name property.

procedure SetChildOrder(Child: TComponent; Order: Integer); dynamic;

Sets the visual ordering of a child control.

procedure SetParentComponent(Value: TComponent); dynamic;

Sets the parent component.

procedure Updating dynamic;

Sets the csUpdating state in the component's ComponentState property.

procedure Updated dynamic;

Clears the csUpdating state in the component's ComponentState property when the component finishes updating.

class procedure UpdateRegistry(Register: Boolean; const ClassID: string; const ProgID: string); virtual;

Provides the interface for a method that adds type library and version information to the Registry on components that implement COM interfaces.

procedure ValidateRename(AComponent: TComponent; const CurName: string; const NewName: string); virtual;

Ensures that renaming an owned component does not create name conflict.

procedure ValidateContainer(AComponent: TComponent); dynamic;

Determines whether an object can be inserted into a container.

procedure ValidateInsert(AComponent: TComponent); dynamic;

Provides the interface for a method that validates an child component before it is inserted.

procedure WriteState(Writer: TWriter); virtual;

Writes the state of the component.

procedure RemoveFreeNotifications

Notifies all owned components of the owner component's imminent destruction.

function QueryInterface(const IID: TGUID; out Obj): HRESULT; virtual;

Returns a reference to a specified interface if the object supports that interface.

function _AddRef(): Integer;

Called when an application uses a component interface.

function _Release(): Integer;

Called when an application releases a component interface.

function GetTypeInfoCount(out Count: Integer): HRESULT;

Returns the number of type information interfaces that an object provides (either 0 or 1).

function GetTypeInfo(Index: Integer;

LocaleID: Integer;

out TypeInfo): HRESULT;

Retrieves the type information for an object.

function GetIDsOfNames(const IID: TGUID;

Names: Pointer; NameCount: Integer; LocaleID: Integer;

DispIDs: Pointer): HRESULT;

Maps a single member and an optional set of argument names to a corresponding set of integer dispatch identifiers (dispIDs).

function Invoke(DispID: Integer;

const IID: TGUID; LocaleID: Integer; Flags: Word; var Params; VarResult: Pointer; ExcepInfo: Pointer;

ArgErr: Pointer): HRESULT;

Provides access to Automation properties and methods when the component wraps an Automation object.

procedure DestroyComponents

Destroys all owned components.

procedure Destroying

Indicates that the component and its owned components are about to be destroyed.

function ExecuteAction(Action: TBasicAction): Boolean; dynamic;

Executes an action.

function FindComponent(const AName: string): TComponent;

Indicates whether a given component is owned by the component.

procedure FreeNotification(AComponent: TComponent);

Ensures that AComponent is notified that the component is going to be destroyed.

procedure RemoveFreeNotification(AComponent: TComponent);

Disables destruction notification that was enabled by FreeNotification

procedure FreeOnRelease

Frees the interface reference for components that were created from COM classes.

function GetEnumerator(): TComponentEnumerator;

Returns a TComponent enumerator.

function GetParentComponent(): TComponent; dynamic;

Returns the containing Component.

function HasParent(): Boolean; dynamic;

Verifies whether the component has a parent.

procedure InsertComponent(AComponent: TComponent);

Establishes the component as the owner of a specified component.

procedure RemoveComponent(AComponent: TComponent);

Removes a specified component specified from the component's Components list.

procedure SetSubComponent(IsSubComponent: Boolean);

Identifies whether the component is a subcomponent.

function UpdateAction(Action: TBasicAction): Boolean; virtual;

Updates the state of an action.

function IsImplementorOf(const I: IInterface): Boolean;

Indicates whether the component implements a specified interface.

function ReferenceInterface(const I: IInterface; Operation: TOperation): Boolean;

Establishes or removes internal links that cause this component to be notified when the implementer of a specified interface is destroyed.


Unit: Classes

Type: method

Visibility: public

Member Of: TComponent

C++ Information

void __fastcall ChangeName(System::UnicodeString NewName);

Sets the private, internal storage for the Name property to the string passed in NewName.

dynamic virtual void __fastcall GetChildren(TGetChildProc Proc, Classes::TComponent * Root);

Enumerates all child components.

dynamic virtual Classes::TComponent * __fastcall GetChildOwner(void);

Returns the owner of a child component being read from a stream.

dynamic virtual Classes::TComponent * __fastcall GetChildParent(void);

Returns the parent, or if there is no parent, returns the owner of a child component being read from a stream.

virtual void __fastcall Loaded(void);

Initializes the component after the form file has been read into memory.

virtual void __fastcall Notification(Classes::TComponent * AComponent, Classes::TOperation Operation);

Forwards notification messages to all owned components.

dynamic virtual void __fastcall PaletteCreated(void);

Responds when the component is created from the component palette.

virtual void __fastcall ReadState(Classes::TReader * Reader);

Reads the state of the component.

void __fastcall SetAncestor(bool Value);

Clears or sets csAncestor state in the component's ComponentState property.

void __fastcall SetDesigning(bool Value, bool SetChildren);

Ensures that components inserted at design time have their design-mode flag set.

void __fastcall SetInline(bool Value);

Sets the csInline bit of the component's ComponentState property

void __fastcall SetDesignInstance(bool Value);

Ensures that components inserted at design time have their design-mode flag set.

virtual void __fastcall SetName(System::UnicodeString NewName);

Sets the value of the Name property.

dynamic virtual void __fastcall SetChildOrder(Classes::TComponent * Child, int Order);

Sets the visual ordering of a child control.

dynamic virtual void __fastcall SetParentComponent(Classes::TComponent * Value);

Sets the parent component.

dynamic virtual void __fastcall Updating(void);

Sets the csUpdating state in the component's ComponentState property.

dynamic virtual void __fastcall Updated(void);

Clears the csUpdating state in the component's ComponentState property when the component finishes updating.

virtual __classmethod void __fastcall UpdateRegistry(bool Register, System::UnicodeString ClassID, System::UnicodeString ProgID);

Provides the interface for a method that adds type library and version information to the Registry on components that implement COM interfaces.

virtual void __fastcall ValidateRename(Classes::TComponent * AComponent, System::UnicodeString CurName, System::UnicodeString NewName);

Ensures that renaming an owned component does not create name conflict.

dynamic virtual void __fastcall ValidateContainer(Classes::TComponent * AComponent);

Determines whether an object can be inserted into a container.

dynamic virtual void __fastcall ValidateInsert(Classes::TComponent * AComponent);

Provides the interface for a method that validates an child component before it is inserted.

virtual void __fastcall WriteState(Classes::TWriter * Writer);

Writes the state of the component.

void __fastcall RemoveFreeNotifications(void);

Notifies all owned components of the owner component's imminent destruction.

virtual long __fastcall QueryInterface(const _GUID & IID, void * Obj);

Returns a reference to a specified interface if the object supports that interface.

int __fastcall _AddRef(void);

Called when an application uses a component interface.

int __fastcall _Release(void);

Called when an application releases a component interface.

long __fastcall GetTypeInfoCount(int & Count);

Returns the number of type information interfaces that an object provides (either 0 or 1).

long __fastcall GetTypeInfo(int Index, int LocaleID, void * TypeInfo);

Retrieves the type information for an object.

long __fastcall GetIDsOfNames(const _GUID & IID,

void * Names, int NameCount, int LocaleID,

void * DispIDs);

Maps a single member and an optional set of argument names to a corresponding set of integer dispatch identifiers (dispIDs).

long __fastcall Invoke(int DispID,

const _GUID & IID, int LocaleID, unsigned short Flags, void * Params, void * VarResult, void * ExcepInfo,

void * ArgErr);

Provides access to Automation properties and methods when the component wraps an Automation object.

void __fastcall DestroyComponents(void);

Destroys all owned components.

void __fastcall Destroying(void);

Indicates that the component and its owned components are about to be destroyed.

dynamic virtual bool __fastcall ExecuteAction(Classes::TBasicAction * Action);

Executes an action.

Classes::TComponent * __fastcall FindComponent(System::UnicodeString AName);

Indicates whether a given component is owned by the component.

void __fastcall FreeNotification(Classes::TComponent * AComponent);

Ensures that AComponent is notified that the component is going to be destroyed.

void __fastcall RemoveFreeNotification(Classes::TComponent * AComponent);

Disables destruction notification that was enabled by FreeNotification

void __fastcall FreeOnRelease(void);

Frees the interface reference for components that were created from COM classes.

Classes::TComponentEnumerator * __fastcall GetEnumerator(void);

Returns a TComponent enumerator.

dynamic virtual Classes::TComponent * __fastcall GetParentComponent(void);

Returns the containing Component.

dynamic virtual bool __fastcall HasParent(void);

Verifies whether the component has a parent.

void __fastcall InsertComponent(Classes::TComponent * AComponent);

Establishes the component as the owner of a specified component.

void __fastcall RemoveComponent(Classes::TComponent * AComponent);

Removes a specified component specified from the component's Components list.

void __fastcall SetSubComponent(bool IsSubComponent);

Identifies whether the component is a subcomponent.

virtual bool __fastcall UpdateAction(Classes::TBasicAction * Action);

Updates the state of an action.

bool __fastcall IsImplementorOf(System::DelphiInterface<System::IInterface> I);

Indicates whether the component implements a specified interface.

bool __fastcall ReferenceInterface(System::DelphiInterface<System::IInterface> I, Classes::TOperation Operation);

Establishes or removes internal links that cause this component to be notified when the implementer of a specified interface is destroyed.

Classes::IInterfaceComponentReference * __fastcall operator ()(void);


Unit: Classes

Type: method

Visibility: public

Member Of: TComponent


Description

Embarcadero Technologies does not currently have any additional information. Please help us document this topic by using the Discussion page!

Personal tools
Translations
Newest Version