MetaForeignKeyColumn Class

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Represents a database foreign-key field that is used by ASP.NET Dynamic Data.

Namespace:   System.Web.DynamicData
Assembly:  System.Web.DynamicData (in System.Web.DynamicData.dll)

System.Object
  System.Web.DynamicData.MetaColumn
    System.Web.DynamicData.MetaForeignKeyColumn

public class MetaForeignKeyColumn : MetaColumn

NameDescription
System_CAPS_pubmethodMetaForeignKeyColumn(MetaTable, ColumnProvider)

Initializes a new instance of the MetaForeignKeyColumn class.

NameDescription
System_CAPS_pubpropertyAllowInitialValue

Gets or sets a value that specifies whether a column enables a value to be inserted.(Inherited from MetaColumn.)

System_CAPS_pubpropertyApplyFormatInEditMode

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.)

System_CAPS_pubpropertyAttributes

Gets the collection of metadata attributes that apply to the data field represented by the MetaColumn object.(Inherited from MetaColumn.)

System_CAPS_pubpropertyColumnType

Gets the data field type.(Inherited from MetaColumn.)

System_CAPS_pubpropertyConvertEmptyStringToNull

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.)

System_CAPS_pubpropertyDataFormatString

Gets the string that specifies the display format for the field value.(Inherited from MetaColumn.)

System_CAPS_pubpropertyDataTypeAttribute

Gets the DataTypeAttribute attribute that is applied to the data field.(Inherited from MetaColumn.)

System_CAPS_pubpropertyDefaultValue

Gets the default value for the data field.(Inherited from MetaColumn.)

System_CAPS_pubpropertyDescription

Gets the description for the data field.(Inherited from MetaColumn.)

System_CAPS_pubpropertyDisplayName

Gets the display name for the data field.(Inherited from MetaColumn.)

System_CAPS_pubpropertyEntityTypeProperty

Gets an object that contains attributes of the property that represents the data field in the entity type.(Inherited from MetaColumn.)

System_CAPS_pubpropertyFilterUIHint

Gets the FilterUIHint value that is used for the column.(Inherited from MetaColumn.)

System_CAPS_pubpropertyForeignKeyNames

Gets a collection that contains the names of the foreign keys in the association that represents a database relationship.

System_CAPS_pubpropertyHtmlEncode

Gets a value that indicates whether field values are HTML-encoded before they are displayed in a data-bound control.(Inherited from MetaColumn.)

System_CAPS_pubpropertyIsBinaryData

Gets a value that indicates whether the data field contains binary data.(Inherited from MetaColumn.)

System_CAPS_pubpropertyIsCustomProperty

Gets a value that indicates whether the data field exists in the database.(Inherited from MetaColumn.)

System_CAPS_pubpropertyIsFloatingPoint

Gets a value that indicates whether the data field is a floating-point type.(Inherited from MetaColumn.)

System_CAPS_pubpropertyIsForeignKeyComponent

Gets a value that indicates whether the data field is part of a foreign key.(Inherited from MetaColumn.)

System_CAPS_pubpropertyIsGenerated

Gets a value that indicates whether the data field value is automatically generated in the database.(Inherited from MetaColumn.)

System_CAPS_pubpropertyIsInteger

Gets a value that indicates whether the data field type is an integer type.(Inherited from MetaColumn.)

System_CAPS_pubpropertyIsLongString

Gets a value that indicates whether the data field type can contain long strings.(Inherited from MetaColumn.)

System_CAPS_pubpropertyIsPrimaryKey

Gets a value that indicates whether the data field is part of the table's primary key.(Inherited from MetaColumn.)

System_CAPS_pubpropertyIsPrimaryKeyInThisTable

Gets a value that indicates whether the foreign-key field is part of the primary key of the table.

System_CAPS_pubpropertyIsReadOnly

Gets a value that indicates whether the data field is read-only.(Inherited from MetaColumn.)

System_CAPS_pubpropertyIsRequired

Gets a value that indicates whether the data field requires a value.(Inherited from MetaColumn.)

System_CAPS_pubpropertyIsString

Gets a value that indicates whether the data field type is a string type.(Inherited from MetaColumn.)

System_CAPS_pubpropertyMaxLength

Gets a value that indicates the maximum length of data that can be stored in the data field.(Inherited from MetaColumn.)

System_CAPS_pubpropertyModel

Gets the MetaModel object that represents the data model that this data field belongs to.(Inherited from MetaColumn.)

System_CAPS_pubpropertyName

Gets the name of the data field.(Inherited from MetaColumn.)

System_CAPS_pubpropertyNullDisplayText

Gets the caption that is displayed for a field when the field's value is null.(Inherited from MetaColumn.)

System_CAPS_pubpropertyParentTable

Gets the parent table of the foreign-key field.

System_CAPS_pubpropertyPrompt

Gets a value that can be used as a watermark in the UI that is bound to data in the column.(Inherited from MetaColumn.)

System_CAPS_pubpropertyProvider

Gets the abstraction provider object that is used to generate the MetaColumn object.(Inherited from MetaColumn.)

System_CAPS_pubpropertyRequiredErrorMessage

Gets the error message that is displayed when the data field requires a value but its value is empty.(Inherited from MetaColumn.)

System_CAPS_pubpropertyScaffold

Gets a value that indicates whether the data field should be displayed.(Inherited from MetaColumn.)

System_CAPS_pubpropertyShortDisplayName

Gets the short name for the column.(Inherited from MetaColumn.)

System_CAPS_pubpropertySortExpression

Gets the expression that is used to determine the sort order for the data field.(Inherited from MetaColumn.)

System_CAPS_pubpropertyTable

Gets the MetaTable object that represents the table that the data field belongs to.(Inherited from MetaColumn.)

System_CAPS_pubpropertyTypeCode

Gets the type of the data field.(Inherited from MetaColumn.)

System_CAPS_pubpropertyUIHint

Gets the name of the field template specified for the data field.(Inherited from MetaColumn.)

NameDescription
System_CAPS_protmethodBuildAttributeCollection()

Gets the attribute collection.(Inherited from MetaColumn.)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_pubmethodExtractForeignKey(IDictionary, String)

Saves the value of a foreign key in the specified dictionary.

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetFilterExpression(String)

Returns the alternate name that is mapped to a foreign key.

System_CAPS_pubmethodGetForeignKeyDetailsPath(Object)

Gets the path for the details action page of the parent table of the specified foreign-key field.

System_CAPS_pubmethodGetForeignKeyPath(String, Object)

Gets the path for the specified action page of the parent table of the specified foreign-key field.

System_CAPS_pubmethodGetForeignKeyPath(String, Object, String)

Gets the path for the specified action page of the parent table of the specified foreign-key field.

System_CAPS_pubmethodGetForeignKeyString(Object)

Retrieves a comma-separated list of values that represent the foreign-key for the specified row.

System_CAPS_pubmethodGetForeignKeyValues(Object)

Retrieves a collection of values that represent the foreign keys for the specified row.

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodInitialize()

Initializes data that may not be available when the constructor is called.(Overrides MetaColumn.Initialize().)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodResetMetadata()

Clears cached column metadata.(Inherited from MetaColumn.)

System_CAPS_pubmethodToString()

Gets the data field name.(Inherited from MetaColumn.)

NameDescription
System_CAPS_pubmethodConvertEditedValue(String)

Returns the value provided by a user for a control that is being validated.(Defined by DynamicDataExtensions.)

System_CAPS_pubmethodFormatEditValue(Object)

Formats the specified field value by using the specified formatting options.(Defined by DynamicDataExtensions.)

System_CAPS_pubmethodFormatValue(Object)

Formats the specified field value by using the specified formatting options.(Defined by DynamicDataExtensions.)

System_CAPS_pubmethodGetEnumType()

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.

.NET Framework
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.

Return to top
Show: