MetaForeignKeyColumn Class
Represents a database foreign-key field that is used by ASP.NET Dynamic Data.
Assembly: System.Web.DynamicData (in System.Web.DynamicData.dll)
| Name | Description | |
|---|---|---|
 | MetaForeignKeyColumn(MetaTable^, ColumnProvider^) | Initializes a new instance of the MetaForeignKeyColumn class. |
| Name | Description | |
|---|---|---|
 | AllowInitialValue | Gets or sets a value that specifies whether a column enables a value to be inserted.(Inherited from MetaColumn.) |
| ApplyFormatInEditMode | Gets a value that indicates whether the formatting string specified by the DataFormatString property is applied to field values when the data-bound control that contains the data field that is represented by the MetaColumn object is in edit mode.(Inherited from MetaColumn.) |
| Attributes | Gets the collection of metadata attributes that apply to the data field represented by the MetaColumn object.(Inherited from MetaColumn.) |
| ColumnType | Gets the data field type.(Inherited from MetaColumn.) |
| ConvertEmptyStringToNull | Gets a value that indicates whether empty string values ("") are automatically converted to null values when the data field is updated in the data source.(Inherited from MetaColumn.) |
| DataFormatString | Gets the string that specifies the display format for the field value.(Inherited from MetaColumn.) |
| DataTypeAttribute | Gets the DataTypeAttribute attribute that is applied to the data field.(Inherited from MetaColumn.) |
| DefaultValue | Gets the default value for the data field.(Inherited from MetaColumn.) |
| Description | Gets the description for the data field.(Inherited from MetaColumn.) |
| DisplayName | Gets the display name for the data field.(Inherited from MetaColumn.) |
| EntityTypeProperty | Gets an object that contains attributes of the property that represents the data field in the entity type.(Inherited from MetaColumn.) |
| FilterUIHint | Gets the FilterUIHint value that is used for the column.(Inherited from MetaColumn.) |
| ForeignKeyNames | Gets a collection that contains the names of the foreign keys in the association that represents a database relationship. |
| HtmlEncode | Gets a value that indicates whether field values are HTML-encoded before they are displayed in a data-bound control.(Inherited from MetaColumn.) |
| IsBinaryData | Gets a value that indicates whether the data field contains binary data.(Inherited from MetaColumn.) |
| IsCustomProperty | Gets a value that indicates whether the data field exists in the database.(Inherited from MetaColumn.) |
| IsFloatingPoint | Gets a value that indicates whether the data field is a floating-point type.(Inherited from MetaColumn.) |
| IsForeignKeyComponent | Gets a value that indicates whether the data field is part of a foreign key.(Inherited from MetaColumn.) |
| IsGenerated | Gets a value that indicates whether the data field value is automatically generated in the database.(Inherited from MetaColumn.) |
| IsInteger | Gets a value that indicates whether the data field type is an integer type.(Inherited from MetaColumn.) |
| IsLongString | Gets a value that indicates whether the data field type can contain long strings.(Inherited from MetaColumn.) |
| IsPrimaryKey | Gets a value that indicates whether the data field is part of the table's primary key.(Inherited from MetaColumn.) |
| IsPrimaryKeyInThisTable | Gets a value that indicates whether the foreign-key field is part of the primary key of the table. |
| IsReadOnly | Gets a value that indicates whether the data field is read-only.(Inherited from MetaColumn.) |
| IsRequired | Gets a value that indicates whether the data field requires a value.(Inherited from MetaColumn.) |
| IsString | Gets a value that indicates whether the data field type is a string type.(Inherited from MetaColumn.) |
| MaxLength | Gets a value that indicates the maximum length of data that can be stored in the data field.(Inherited from MetaColumn.) |
| Model | Gets the MetaModel object that represents the data model that this data field belongs to.(Inherited from MetaColumn.) |
| Name | Gets the name of the data field.(Inherited from MetaColumn.) |
| NullDisplayText | Gets the caption that is displayed for a field when the field's value is null.(Inherited from MetaColumn.) |
| ParentTable | Gets the parent table of the foreign-key field. |
| Prompt | Gets a value that can be used as a watermark in the UI that is bound to data in the column.(Inherited from MetaColumn.) |
| Provider | Gets the abstraction provider object that is used to generate the MetaColumn object.(Inherited from MetaColumn.) |
| RequiredErrorMessage | Gets the error message that is displayed when the data field requires a value but its value is empty.(Inherited from MetaColumn.) |
| Scaffold | Gets a value that indicates whether the data field should be displayed.(Inherited from MetaColumn.) |
| ShortDisplayName | Gets the short name for the column.(Inherited from MetaColumn.) |
| SortExpression | Gets the expression that is used to determine the sort order for the data field.(Inherited from MetaColumn.) |
| Table | Gets the MetaTable object that represents the table that the data field belongs to.(Inherited from MetaColumn.) |
| TypeCode | Gets the type of the data field.(Inherited from MetaColumn.) |
| UIHint | Gets the name of the field template specified for the data field.(Inherited from MetaColumn.) |
| Name | Description | |
|---|---|---|
 | BuildAttributeCollection() | Gets the attribute collection.(Inherited from MetaColumn.) |
| Equals(Object^) | Determines whether the specified object is equal to the current object.(Inherited from Object.) |
| ExtractForeignKey(IDictionary^, String^) | Saves the value of a foreign key in the specified dictionary. |
| Finalize() | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.) |
| GetFilterExpression(String^) | Returns the alternate name that is mapped to a foreign key. |
| GetForeignKeyDetailsPath(Object^) | Gets the path for the details action page of the parent table of the specified foreign-key field. |
| GetForeignKeyPath(String^, Object^) | Gets the path for the specified action page of the parent table of the specified foreign-key field. |
| GetForeignKeyPath(String^, Object^, String^) | Gets the path for the specified action page of the parent table of the specified foreign-key field. |
| GetForeignKeyString(Object^) | Retrieves a comma-separated list of values that represent the foreign-key for the specified row. |
| GetForeignKeyValues(Object^) | Retrieves a collection of values that represent the foreign keys for the specified row. |
| GetHashCode() | Serves as the default hash function. (Inherited from Object.) |
| GetType() | |
| Initialize() | Initializes data that may not be available when the constructor is called.(Overrides MetaColumn::Initialize().) |
| MemberwiseClone() | |
| ResetMetadata() | Clears cached column metadata.(Inherited from MetaColumn.) |
| ToString() | Gets the data field name.(Inherited from MetaColumn.) |
| Name | Description | |
|---|---|---|
| ConvertEditedValue(String^) | Returns the value provided by a user for a control that is being validated.(Defined by DynamicDataExtensions.) |
| FormatEditValue(Object^) | Formats the specified field value by using the specified formatting options.(Defined by DynamicDataExtensions.) |
| FormatValue(Object^) | Formats the specified field value by using the specified formatting options.(Defined by DynamicDataExtensions.) |
| GetEnumType() | Gets the type of the enumeration that represents the column.(Defined by DynamicDataExtensions.) |
In ASP.NET Dynamic Data applications, the MetaForeignKeyColumn class represents a database column that denotes a one-to-one relationship.
The MetaForeignKeyColumn class represents the column in the table that contains the foreign-key field. However, you can access the parent table object by using the ParentTable property. You can determine if the foreign-key field is a primary key in the table that contains it by using the IsPrimaryKeyInThisTable property.
Available since 3.5
Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.