TDataSetAdapterField Members

The following tables list the members exposed by TDataSetAdapterField.

	Name	Description
	FComponentStyle	FComponentStyle is the field of the ComponentStyle read-only property.

Protected Methods

	Name	Description
	_AddRef	Called when an application uses a component interface.
	_Release	Called when an application releases a component interface.
	AsFormatted	Returns text used to generate a representation of the adapter field value.
	AssignTo	Copies the properties of an object to a destination object.
	ChangeName	Sets the private, internal storage for the Name property to the string passed in NewName.
	CheckModifyAccess	Checks end-user rights to modify the adapter field value.
	CheckOrigValue	Ensures that the current value of this field is the same as the original value.
	CheckValueChange	Indicates whether the current value of this field is the same as the original value.
	CheckViewAccess	Checks end-user rights to view the adapter field value.
	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.
	FullyQualifyInputName	Indicates whether references to this field in HTML forms must be qualified with the name of the parent adapter.
	FullyQualifyInputName	Indicates whether the HTML input names must be qualified with the name of the adapter.
	GetAdapter	Returns the value of the Adapter property.
	GetAdapter	GetAdapter returns the parent adapter component.
	GetAdapterValuesList	Returns the value of the ValuesList property.
	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	Enumerates all child components.
	GetContainerList	Returns the TWebComponentList object that the Web parent uses to manage this and its other Web items.
	GetDataSet	Returns the dataset associated with this field's parent adapter.
	GetDataSetFieldValue	Returns the value of the associated dataset field.
	GetDefaultDisplayLabel	Provides the default display label for this adapter field.
	GetDefaultFieldName	Gets the default name used to reference this adapter field with server-side script.
	GetDisplayLabel	Returns the suggested display label for this adapter field.
	GetDisplayStyle	Returns a string value that suggests an HTML display style for this adapter field.
	GetDisplayStyleType	Returns the HTML display style type for this adapter field.
	GetDisplayWidth	Returns the suggested display width for this adapter field.
	GetEchoActionFieldValue	Returns the value of the echo flag.
	GetIDsOfNames	Maps a single member and an optional set of argument names to a corresponding set of integer dispatch identifiers (dispIDs).
	GetInputName	Identifies the name to use when generating an HTML input for this adapter field.
	GetInputStyle	Returns a string value that suggests an HTML editing style for this adapter field.
	GetInputStyleType	Returns the style of the HTML control to use for editing this adapter field.
	GetInputStyleType	Returns the default style of the HTML control to use for editing this adapter field.
	GetKeyName	Returns the name of the associated dataset field if it appears in the index (key) that the parent dataset adapter uses.
	GetKeyParams	Returns a list of fields that the parent dataset adapter uses to locate records, along with their current values in that adapter's dataset.
	GetMaxLength	Returns the maximum length, in characters, that the user should be allowed to enter when entering a value for this adapter field.
	GetNeedPrevValue	Indicates whether an HTML form should include a hidden field that stores this field's value so that generated requests include the previous field value.
	GetOwner	Returns the owner of a component.
	GetOwner	Returns the owner of an object.
	GetPrevValue	Returns the value of this field, as it should appear in a hidden field in an HTML form.
	GetReadOnly	Indicates whether the adapter field represents a read-only database field.
	GetRequired	Indicates whether the end-user must enter a value for this adapter field.
	GetTypeInfo	Retrieves the type information for an object.
	GetTypeInfoCount	Returns the number of type information interfaces that an object provides (either 0 or 1).
	GetValue	Gets the value of this adapter field as a Variant.
	GetVariableName	Gets the name used to reference this adapter field with server-side script.
	GetViewMode	Returns a string value that indicates what function a control that represents this field should perform.
	GetViewModeType	Returns the view mode for the function a control that represents this field should perform.
	GetVisible	Indicates whether the value of this adapter field should be displayed to the end-user.
	GetWebSnapObjClass	Returns the class type for this adapter field.
	HasModifyAccess	Checks the end-user's right to modify this adapter field.
	HasViewAccess	Checks the end-user's right to view this adapter field.
	ImplAsFormatted	Provides the underlying implementation for the AsFormatted method.
	ImplAsFormatted	Returns text used to generate a representation of the adapter field value.
	ImplCheckOrigValue	Provides the underlying implementation for the CheckOrigValue method.
	ImplCheckOrigValue	Provides the underlying implementation for the CheckOrigValue method.
	ImplCheckValueChange	Provides the underlying implementation for the CheckValueChange method.
	ImplCheckValueChange	Provides the underlying implementation for the CheckValueChange method.
	ImplGetDisplayLabel	Provides the underlying implementation for the GetDisplayLabel method.
	ImplGetDisplayLabel	Returns the suggested display label for this adapter field.
	ImplGetDisplayWidth	Provides the underlying implementation for the GetDisplayWidth method.
	ImplGetDisplayWidth	Returns the suggested display width for this adapter field.
	ImplGetEchoActionFieldValue	Provides the underlying implementation for the GetEchoActionFieldValue method.
	ImplGetEchoActionFieldValue	Returns the value of the echo flag.
	ImplGetInputName	Identifies the name to use when generating the HTML input for this adapter field.
	ImplGetMaxLength	Returns the maximum length, in characters, that the user should be allowed to enter when entering a value for this adapter field.
	ImplGetNeedPrevValue	Provides the underlying implementation for the GetNeedPrevValue method.
	ImplGetPrevValue	Provides the underlying implementation of the GetPrevValue method.
	ImplGetRequired	Provides the underlying implementation for the GetRequired method.
	ImplGetRequired	Indicates whether the end-user must enter a value for this adapter field.
	ImplGetValue	Provides the underlying implementation for the GetValue method.
	ImplGetValue	Provides the underlying implementation for the GetValue method.
	ImplGetValue	Gets the value of this adapter field as a Variant.
	ImplGetVariableName	Gets the name used to reference this adapter field with server-side script.
	ImplGetVisible	Provides the underlying implementation for the GetVisible method.
	ImplGetVisible	Indicates whether the value of this adapter field should be displayed to the end-user.
	ImplHasModifyAccess	Checks the end-user's right to modify this adapter field.
	ImplHasViewAccess	Checks the end-user's right to view this adapter field.
	ImplSetEchoActionFieldValue	Provides the underlying implementation for the SetEchoActionFieldValue method.
	ImplSetEchoActionFieldValue	Sets the echo flag for this adapter field.
	ImplSetFieldName	Provides the underlying implementation for the SetFieldName method.
	ImplSetFieldName	Sets the name that is used to reference this adapter field with server-side script.
	ImplUpdateValue	Provides the underlying implementation for the UpdateValue method.
	ImplUpdateValue	Provides the underlying implementation for the UpdateValue method.
	ImplValidateValue	Provides the underlying implementation for the ValidateValue method.
	Invoke	Provides access to Automation properties and methods when the component wraps an Automation object.
	IsDefaultField	Indicates whether this component represents a Web item that is used by default when the parent's set of Web items is not explicitly assigned.
	Loaded	Initializes the component after the form file has been read into memory.
	Notification	Forwards notification messages to all owned components.
	Notification	Forwards notification messages to all owned components.
	Notification	Responds when components are added to or deleted from the WebSnap application.
	PaletteCreated	Responds when the component is created from the component palette.
	ParentChanged	Handles movement of the component to a different parent.
	ParentChanged	Responds when the WebParent property changes.
	PrepareDataSet	Responds when the parent dataset adapter prepares its dataset.
	QueryInterface	Returns a reference to a specified interface if the object supports that interface.
	ReadState	Reads the state of the component.
	ReadState	Reads the component's published properties, stored data, and owned components from a reader object.
	SetAncestor	Clears or sets csAncestor state in the component's ComponentState property.
	SetChildOrder	Sets the visual ordering of a child control.
	SetDataSetField	Sets the value of the DataSetField property.
	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.
	SetEchoActionFieldValue	Sets the echo flag for this adapter field.
	SetFieldName	Sets the name that is used to reference this adapter field with server-side script.
	SetInline	Sets the csInline bit of the component's ComponentState property
	SetName	Sets the value of the Name property.
	SetParentComponent	Sets the parent component.
	SetParentComponent	Sets the WebParent property to be the same as this component's parent.
	SetWebParent	Sets the value of the WebParent property.
	TestValueChange	Checks whether a new value matches the current value of this field.
	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.
	UpdateValue	Updates the adapter field when the user assigns a new value.
	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.
	ValidateValue	Validates a new value for this field that appears in the current request.
	WriteState	Writes the state of the component.

Protected Properties

	Name	Description
	Adapter	Indicates the dataset adapter that uses this object to represent one of its fields.
	Adapter	Returns the parent adapter component.
	WebContainedComponentHelper	Provides access to the helper object that implements the IWebComponent interface for this contained component.
	WebParent	Indicates the component that uses this TWebContainedComponent as one of its Web items.

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.
	AsFormatted	This is AsFormatted, a member of class IAsFormatted.
	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.
	CheckOrigValue	This is CheckOrigValue, a member of class ICheckOrigValue.
	CheckValueChange	This is CheckValueChange, a member of class ICheckValueChange.
	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	Allocates memory and constructs a safely initialized instance of a component.
	Create	Creates and initializes an instance of TBaseDataSetAdapterField.
	Create	Constructs an object and initializes its data before the object is first used.
	Create	Creates and initializes an instance of TWebContainedComponent.
	DefaultHandler	Provides the interface for a method that processes message records.
	Destroy	Disposes of the component and its owned components.
	Destroy	Destroys the TPersistent instance and frees its memory.
	Destroy	Disposes of an object instance.
	Destroy	Frees an instance of TWebContainedComponent.
	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.
	Equals	Checks if the current instance and the parameter are equal.
	ExecuteAction	Executes an action.
	FieldAddress	This is the overview for the FieldAddress method overload.
	FindComponent	Indicates whether a given component is owned by the component.
	FindField	Returns the dataset field whose value this adapter field represents.
	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.
	GetAdapterValuesList	This is GetAdapterValuesList, a member of class IGetAdapterValuesList.
	GetComponent	Returns a reference to the component associated by the implementing class.
	GetContainer	Returns the value of the Container property.
	GetDisplayLabel	This is GetDisplayLabel, a member of class IWebGetDisplayLabel.
	GetDisplayStyle	Returns the preferred display style for an adapter field or adapter action.
	GetDisplayWidth	This is GetDisplayWidth, a member of class IWebGetDisplayWidth.
	GetEchoActionFieldValue	This is GetEchoActionFieldValue, a member of class IEchoActionFieldValue.
	GetEnumerator	Returns a TComponent enumerator.
	GetFieldName	This is GetFieldName, a member of class IWebGetFieldName.
	GetHashCode	Returns an integer containing the hash code.
	GetIndex	Returns the value of the Index property.
	GetInputName	This is GetInputName, a member of class IWebInputName.
	GetInputStyle	Returns the preferred editing style for an adapter field.
	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.
	GetKeyName	This is GetKeyName, a member of class IGetDataSetKeyName.
	GetMaxLength	This is GetMaxLength, a member of class IWebGetMaxLength.
	GetNamePath	Returns a string used by the Object Inspector.
	GetNamePath	Returns the name of the object as it appears in the Object Inspector.
	GetNeedPrevValue	This is GetNeedPrevValue, a member of class IWebGetFieldPrevValue.
	GetParentComponent	Returns the containing Component.
	GetParentComponent	Returns the object that uses this component to generate HTML.
	GetPrevValue	This is GetPrevValue, a member of class IWebGetFieldPrevValue.
	GetRequired	This is GetRequired, a member of class IAdapterFieldAttributes.
	GetValue	This is GetValue, a member of class IWebGetFieldValue.
	GetVariableName	This is GetVariableName, a member of class IWebVariableName.
	GetViewMode	Returns the preferred mode of an adapter field.
	GetVisible	This is GetVisible, a member of class IAdapterFieldAttributes.
	HasModifyAccess	This is HasModifyAccess, a member of class IAdapterFieldAccess.
	HasParent	Verifies whether the component has a parent.
	HasParent	Indicates whether this component appears in another component's list of Web items.
	HasViewAccess	This is HasViewAccess, a member of class IAdapterFieldAccess.
	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 the overview for the MethodAddress method overload.
	MethodName	Returns the name of a class method by address.
	NewInstance	Allocates memory for an instance of an object type and returns a pointer to that new instance.
	PrepareDataSet	This is PrepareDataSet, a member of class IPrepareDataSet.
	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.
	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.
	SetComponentList	Sets the value of the ComponentList property.
	SetContainer	Sets the value of the Container property.
	SetEchoActionFieldValue	This is SetEchoActionFieldValue, a member of class IEchoActionFieldValue.
	SetFieldName	This is SetFieldName, a member of class IWebSetFieldName.
	SetIndex	Sets the value of the Index property.
	SetSubComponent	Identifies whether the component is a subcomponent.
	ToString	Returns a string containing the class name.
	UnitName	Returns a string containing the unit name.
	UpdateAction	Updates the state of an action.
	UpdateValue	This is UpdateValue, a member of class IUpdateValue.
	ValidateValue	This is ValidateValue, a member of class IValidateValue.

Public Properties

	Name	Description
	ActionOrigValue	Retrieve the original value of this adapter field.
	ActionValue	Retrieve the value for this adapter field entered by the end-user.
	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.
	ComponentList	Indicates the component list that contains the Web item.
	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.
	Container	Specifies the component that uses content generated by this Web item.
	DesignInfo	Contains information used by the Form designer.
	EchoActionFieldValue	This is EchoActionFieldValue, a member of class IEchoActionFieldValue.
	EchoActionFieldValue	Used to echo the value(s) entered by the end-user when generating an HTML form.
	FieldName	This is FieldName, a member of class IWebGetFieldName.
	FieldName	Identifies the name of this field when using server-side script.
	Index	Indicates where the Web item appears in the Web component list's array of Web items.
	InputName	This is InputName, a member of class IWebInputName.
	KeyName	This is KeyName, a member of class IGetDataSetKeyName.
	NeedPrevValue	This is NeedPrevValue, a member of class IWebGetFieldPrevValue.
	Owner	Indicates the component that is responsible for streaming and freeing this component.
	PrevValue	This is PrevValue, a member of class IWebGetFieldPrevValue.
	Required	This is Required, a member of class IAdapterFieldAttributes.
	Value	This is Value, a member of class IWebGetFieldValue.
	Value	Provides the value of an adapter field as a variant.
	VariableName	This is VariableName, a member of class IWebVariableName.
	VCLComObject	Represents information used internally by components that support COM.
	Visible	This is Visible, a member of class IAdapterFieldAttributes.

Published Events

	Name	Description
	OnGetDisplayText	Occurs when the adapter field needs to supply its formatted value as a string that can appear in HTML forms.
	OnGetValue	Occurs when the adapter field needs to supply its value as a Variant.
	OnValidateValue	Occurs when the parent adapter wants to validate the new value for this field.

Published Properties

	Name	Description
	DataSetField	Specifies the name of the dataset field that this adapter field represents.
	FieldFlags	Indicates various attributes of the adapter field.
	FieldModes	Indicates what dataset adapter modes this field supports.
	ModifyAccess	Identifies the rights required to update this field.
	Name	Specifies the name of the component as referenced in code.
	OnUpdateValue	Occurs when the WebSnap application updates this adapter field's value based on in incoming request.
	Tag	Stores an integer value as part of a component.
	ValuesList	Specifies the interface of an object that lists the possible values for this field.
	ViewAccess	Identifies the rights required to view this field.

What do you think about this topic? Send feedback!