THelpContents Members

The following tables list the members exposed by THelpContents.

	Name	Description
	OnChange	Occurs when one of the action's properties changes.

Protected Fields

	Name	Description
	FClients	This is FClients, a member of class TBasicAction.
	FComponentStyle	This is FComponentStyle, a member of class TComponent.
	FImage	This is FImage, a member of class TCustomAction.
	FMask	This is FMask, a member of class TCustomAction.

Protected Methods

	Name	Description
	_AddRef	Called when an application uses a component interface.
	_Release	Called when an application releases a component interface.
	AssignTo	Copies the properties of this action to a destination object.
	AssignTo	Copies the properties of an object to a destination object.
	Change	Generates an OnChange event.
	ChangeName	Sets the private, internal storage for the Name property to the string passed in NewName.
	DefineProperties	Designates methods for storing an object's unpublished data on a stream such as a form file.
	DefineProperties	Provides an interface for a method that reads and writes otherwise unpublished data.
	GetChildOwner	Returns the owner of a child component being read from a stream.
	GetChildParent	Returns the parent, or if there is no parent, returns the owner of a child component being read from a stream.
	GetChildren	This is GetChildren, a member of class TComponent.
	GetIDsOfNames	Maps a single member and an optional set of argument names to a corresponding set of integer dispatch identifiers (dispIDs).
	GetOwner	Returns the owner of a component.
	GetOwner	Returns the owner of an object.
	GetTypeInfo	Retrieves the type information for an object.
	GetTypeInfoCount	Returns the number of type information interfaces that an object provides (either 0 or 1).
	HandleShortCut	Executes the action when the user types on of its short cuts.
	Invoke	Provides access to Automation properties and methods when the component wraps an Automation object.
	Loaded	Initializes the component after the form file has been read into memory.
	Notification	Responds when components are created or destroyed.
	Notification	Forwards notification messages to all owned components.
	PaletteCreated	Responds when the component is created from the component palette.
	QueryInterface	Returns a reference to a specified interface if the object supports that interface.
	ReadState	This is ReadState, a member of class TContainedAction.
	ReadState	This is ReadState, a member of class TComponent.
	SetAncestor	This is SetAncestor, a member of class TComponent.
	SetChildOrder	This is SetChildOrder, a member of class TComponent.
	SetDesigning	Ensures that components inserted at design time have their design-mode flag set.
	SetDesignInstance	Ensures that components inserted at design time have their design-mode flag set.
	SetHelpContext	This is SetHelpContext, a member of class TCustomAction.
	SetHelpKeyword	This is SetHelpKeyword, a member of class TCustomAction.
	SetInline	Sets the csInline bit of the component's ComponentState property
	SetName	Sets the value of the Name property.
	SetName	Sets the value of the Name property.
	SetOnExecute	Assigns an OnExecute event handler.
	SetParentComponent	This is SetParentComponent, a member of class TContainedAction.
	SetParentComponent	This is SetParentComponent, a member of class TComponent.
	Updated	Clears the csUpdating state in the component's ComponentState property when the component finishes updating.
	UpdateRegistry	Provides the interface for a method that adds type library and version information to the Registry on components that implement COM interfaces.
	Updating	Sets the csUpdating state in the component's ComponentState property.
	ValidateContainer	Determines whether an object can be inserted into a container.
	ValidateInsert	Provides the interface for a method that validates an child component before it is inserted.
	ValidateRename	Ensures that renaming an owned component does not create name conflict.
	WriteState	This is WriteState, a member of class TComponent.

Protected Properties

	Name	Description
	SavedEnabledState	Saves the value of the Enabled property when the action is suspended.

Public Events

	Name	Description
	OnExecute	Occurs when the client event that is linked to it fires.
	OnHint	Occurs when the mouse pauses over a client control or menu item.
	OnUpdate	Occurs when the application is idle or when the action list updates.

Public Methods

	Name	Description
	_AddRef	Increments the reference count for this interface.
	_Release	Decrements the reference count for this interface.
	AfterConstruction	Responds after the last constructor has executed.
	Assign	Copies the contents of another, similar object.
	BeforeDestruction	Performs any necessary actions before the first destructor is called.
	BeforeDestruction	Responds before the first destructor executes.
	ClassInfo	Returns a pointer to the runtime type information (RTTI) table for the object type.
	ClassName	Returns a string indicating the type of the object instance (as opposed to the type of the variable passed as an argument).
	ClassNameIs	Determines whether an object is of a specific type.
	ClassParent	Returns the type of the immediate ancestor of a class.
	ClassType	Returns the class reference for the object's class.
	CleanupInstance	Performs finalization on long strings, variants, and interface variables within a class.
	Create	Creates and initializes a TAction object.
	Create	Instantiates and initializes a TCustomAction object.
	Create	Instantiates and initializes a TBasicAction object.
	Create	Allocates memory and constructs a safely initialized instance of a component.
	Create	Creates and initializes a TAction object.
	Create	Constructs an object and initializes its data before the object is first used.
	DefaultHandler	Provides the interface for a method that processes message records.
	Destroy	Destroys the instance of the contained action.
	Destroy	Frees an instance of TCustomAction.
	Destroy	Disposes of an instance of a TBasicAction object.
	Destroy	Disposes of the component and its owned components.
	Destroy	Destroys the TPersistent instance and frees its memory.
	Destroy	Disposes of an object instance.
	DestroyComponents	Destroys all owned components.
	Destroying	Indicates that the component and its owned components are about to be destroyed.
	Dispatch	Calls message-handling methods for the object, based on the contents of the Message parameter.
	DoHint	Generates an OnHint event.
	Execute	Responds when the client control "fires".
	Execute	Responds when a client control "fires".
	Execute	Generates an OnExecute event.
	ExecuteAction	This is ExecuteAction, a member of class TComponent.
	ExecuteTarget	Displays a dialog that lists the help topics.
	FieldAddress	Returns the address of a published object field.
	FindComponent	Indicates whether a given component is owned by the component.
	Free	Destroys an object and frees its associated memory, if necessary.
	FreeInstance	Deallocates memory allocated by a previous call to the System::TObject::NewInstance method.
	FreeNotification	Ensures that AComponent is notified that the component is going to be destroyed.
	FreeOnRelease	Frees the interface reference for components that were created from COM classes.
	GetComponent	Returns a reference to the component associated by the implementing class.
	GetEnumerator	Returns a TComponent enumerator.
	GetInterface	Retrieves a specified interface.
	GetInterfaceEntry	Returns the entry for a specific interface implemented in a class.
	GetInterfaceTable	Returns a pointer to a structure containing all of the interfaces implemented by a given class.
	GetNamePath	Returns a string used by the Object Inspector.
	GetNamePath	Returns the name of the object as it appears in the Object Inspector.
	GetParentComponent	Returns the action list or action manager that contains the action.
	GetParentComponent	Returns the containing Component.
	HandlesTarget	Introduces an interface for verifying that the type, and state, of a target component or control are appropriate for the action.
	HandlesTarget	Indicates whether the action can execute its function.
	HasParent	Indicates whether the action is contained in an action list or action manager.
	HasParent	This is HasParent, a member of class TComponent.
	InheritsFrom	Determines the relationship of two object types.
	InitInstance	Initializes a newly allocated object instance to all zeros and initializes the instance's virtual method table pointer.
	InsertComponent	Establishes the component as the owner of a specified component.
	InstanceSize	Returns the size in bytes of each instance of the object type.
	IsImplementorOf	Indicates whether the component implements a specified interface.
	MethodAddress	This is MethodAddress, a member of class TObject.
	MethodName	This is MethodName, a member of class TObject.
	NewInstance	Allocates memory for an instance of an object type and returns a pointer to that new instance.
	QueryInterface	Returns a reference to a specified interface if the object supports that interface.
	ReferenceInterface	Establishes or removes internal links that cause this component to be notified when the implementer of a specified interface is destroyed.
	RegisterChanges	Associates the action with an action link.
	RemoveComponent	Removes a specified component specified from the component's Components list.
	RemoveFreeNotification	Disables destruction notification that was enabled by FreeNotification
	SafeCallException	Handles exceptions in methods declared using the safecall calling convention.
	SafeCallException	Handles exceptions in methods declared using the safecall calling convention.
	SetSubComponent	Identifies whether the component is a subcomponent.
	UnRegisterChanges	Breaks the association between the action and the action link.
	Update	Indicates whether the action updates itself.
	Update	Provides an opportunity to execute centralized code when an application is idle.
	UpdateAction	This is UpdateAction, a member of class TComponent.
	UpdateTarget	Introduces an interface for a method of notifying a client when the action updates itself.
	UpdateTarget	Enables or disables the action, depending on the availability of the Application object.

Public Properties

	Name	Description
	ActionComponent	Indicates the client component that caused this action to execute.
	ActionList	Indicates the action list or action manager that contains the action.
	AutoCheck	Controls whether the Checked property toggles when the action executes.
	Caption	Represents the caption of client controls and menu items.
	Checked	Indicates whether client controls and menu items appear checked.
	ComObject	Specifies the interface reference implemented by the component.
	ComponentCount	Indicates the number of components owned by the component.
	ComponentIndex	Indicates the position of the component in its owner's Components property array.
	Components	Lists all components owned by the component.
	ComponentState	Describes the current state of the component, indicating when a component needs to avoid certain actions.
	ComponentStyle	Governs the behavior of the component.
	DesignInfo	Contains information used by the Form designer.
	DisableIfNoHandler	Indicates whether client components should be disabled if no handler is found.
	Enabled	Indicates whether client controls and menu items are enabled.
	GroupIndex	Indicates whether the action acts like a radio button with other actions in the same action list.
	HelpContext	Indicates the help context ID for client controls and menu items.
	HelpKeyword	Indicates the help keyword for client controls and menu items.
	HelpType	Indicates the mechanism for client controls and menu items to use when invoking help.
	Hint	Indicates the Help hint for client controls and menu items.
	ImageIndex	Indicates the ImageIndex property for client controls and menu items.
	Index	Specifies the index of the action in its action list or action manager.
	Owner	Indicates the component that is responsible for streaming and freeing this component.
	SecondaryShortCuts	Specifies the short cuts (in addition to ShortCut) for triggering clients.
	ShortCut	Specifies the ShortCut property for client menu items.
	VCLComObject	Represents information used internally by components that support COM.
	Visible	Specifies the Visible property for client controls and menu items.

Published Events

	Name	Description
	OnExecute	Occurs when the client event that is linked to it fires.
	OnHint	Occurs when the mouse pauses over a client control or menu item.
	OnUpdate	Occurs when the application is idle or when the action list updates.

Published Properties

	Name	Description
	AutoCheck	Controls whether the Checked property toggles when the action executes.
	Caption	Represents the caption of client controls and menu items.
	Category	Specifies the category under which the action appears in its action list or action manager.
	Checked	Indicates whether client controls and menu items appear checked.
	Enabled	Indicates whether client controls and menu items are enabled.
	GroupIndex	Indicates whether the action acts like a radio button with other actions in the same action list.
	HelpContext	Indicates the help context ID for client controls and menu items.
	HelpKeyword	Indicates the help keyword for client controls and menu items.
	HelpType	Indicates the mechanism for client controls and menu items to use when invoking help.
	Hint	Indicates the Help hint for client controls and menu items.
	ImageIndex	Indicates the ImageIndex property for client controls and menu items.
	Name	Specifies the name of the component as referenced in code.
	SecondaryShortCuts	Specifies the short cuts (in addition to ShortCut) for triggering clients.
	ShortCut	Specifies the ShortCut property for client menu items.
	Tag	Stores an integer value as part of a component.
	Visible	Specifies the Visible property for client controls and menu items.

What do you think about this topic? Send feedback!