SPFieldLookup Members

Include Protected Members
Include Inherited Members

Represents a lookup field.

The SPFieldLookup type exposes the following members.

Constructors

	Name	Description
	SPFieldLookup(SPFieldCollection, String)	Initializes a new instance of the SPFieldLookup class based on the specified field collection and name.
	SPFieldLookup(SPFieldCollection, String, String)	Initializes a new instance of the SPFieldLookup class based on the specified field collection, type name, and display name.

Top

Properties

	Name	Description
	AggregationFunction	Gets or sets the aggregation function for the field. (Inherited from SPField.)
	AllowDeletion	Gets or sets a Boolean value that specifies whether the field can be deleted. (Inherited from SPField.)
	AllowMultipleValues	Gets or sets a Boolean value that specifies whether multiple values can be used in the lookup field.
	AuthoringInfo	Gets the descriptive string that is used in pages for editing fields to identify the field and its purpose. (Inherited from SPField.)
	CanBeDeleted	Gets a Boolean value that indicates whether the field can be deleted. (Inherited from SPField.)
	CanBeDisplayedInEditForm	A read-only property indicating whether or not the field can be displayed in an edit form. (Inherited from SPField.)
	CanToggleHidden	Gets a Boolean value that indicates whether the column can be hidden through the user interface. (Inherited from SPField.)
	CompositeIndexable	Indicates whether and in what capacity the field can participate in a composite index. (Inherited from SPField.)
	CountRelated	Gets or sets a Boolean value that specifies whether to display the count of items in the lookup list that look up to the current list item.
	DefaultFormula	Gets or sets the default formula for a calculated field. (Inherited from SPField.)
	DefaultListField	Gets a value that indicates whether to show the properties form of a file when it is uploaded to a document library. (Inherited from SPField.)
	DefaultValue	Gets or sets the default value for a field. (Inherited from SPField.)
	DefaultValueTyped	Gets the default value object based on the field type. (Inherited from SPField.)
	Description	Gets or sets the description for a field. (Inherited from SPField.)
	DescriptionResource	Gets an SPUserResource object that represents the translations for the description of the field. (Inherited from SPField.)
	Direction	Gets or sets the direction of the reading order for the field. (Inherited from SPField.)
	DisplaySize	Gets or sets the display size for the field. (Inherited from SPField.)
	EnforceUniqueValues	Gets or sets a Boolean value that specifies whether to enforce uniqueness in column values. The default is false. (Inherited from SPField.)
	FieldReferences	Gets a string array that contains the internal names of fields that are referenced in a computed field. (Inherited from SPField.)
	FieldRenderingControl	Gets the control that is used to render the field on a form page. (Overrides SPField.FieldRenderingControl.)
	FieldRenderingMobileControl	Gets the mobile control that is used to render the field on a form page. (Overrides SPField.FieldRenderingMobileControl.)
	FieldTypeDefinition	Gets an SPFieldTypeDefinition object that represents the field type definition for the field. (Inherited from SPField.)
	FieldValueType	Gets the value type of the lookup field. (Overrides SPField.FieldValueType.)
	Filterable	Gets a Boolean value that indicates whether the field can be filtered. (Inherited from SPField.)
	FilterableNoRecurrence	Gets a Boolean value that indicates whether a filter can be created on a field in a view that does not expand recurring events. (Inherited from SPField.)
	FromBaseType	Gets a Boolean value that indicates whether the field derives from a base field type. (Inherited from SPField.)
	Group	Gets or sets the column group to which the field belongs. (Inherited from SPField.)
	Hidden	Gets or sets a Boolean value that specifies whether the field is displayed in the list. (Inherited from SPField.)
	Id	Gets the GUID of the field. (Inherited from SPField.)
	IMEMode	Gets or sets the Input Method Editor (IME) mode bias to use for the field. The IME enables conversion of keystrokes between languages when one writing system has more characters than can be encoded for the given keyboard. (Inherited from SPField.)
	Indexable	Read-only property indicating whether the field can be indexed or not. (Inherited from SPField.)
	Indexed	Sets a Boolean value that specifies whether the field is indexed. (Overrides SPField.Indexed.)
	InternalName	Gets the internal name that is used for the field. (Inherited from SPField.)
	IsDependentLookup	Gets a Boolean value that indicates whether the field is a secondary lookup field that depends on a primary field for its relationship with the lookup list.
	IsRelationship	Gets or sets a Boolean value that indicates whether the lookup field is discoverable from the list to which it looks for its value.
	JumpToField	Gets the name of a field that represents the next question to which users are taken in a survey, which is dependent on the answer they give to the current question. (Inherited from SPField.)
	LinkToItem	Indicates whether the field should show the link to the display form when displayed in an [XsltListView]. This value can only be set if this object’s LinkToItemAllowed is set to Allowed. (Inherited from SPField.)
	LinkToItemAllowed	Represents whether or not the LinkToItem must be shown, must be hidden, or can be turned on/off via the LinkToItem setting. (Inherited from SPField.)
	ListItemMenu	Indicates whether the field should show the drop down menu when displayed in an XsltListView. (Inherited from SPField.)
	ListItemMenuAllowed	Indicates whether or not the ListItemMenu must be shown, must be hidden, or can be turned on or off via the ListItemMenu setting. (Inherited from SPField.)
	LookupField	Gets or sets the internal name of the field in a related list that is the source of this field's value.
	LookupList	Gets or sets the string representation of the GUID that identifies the list that is the source of this field's value.
	LookupWebId	Gets or sets the ID of the Web site that contains the list that is the source of this field's value.
	NoCrawl	Gets or sets a value that specifies whether the field can be crawled by a search engine. (Inherited from SPField.)
	ParentList	Gets the parent list that contains the field. (Inherited from SPField.)
	PIAttribute	Gets or sets the attribute in the document processing instruction (specified by the PITarget property) that is used as the column value for property promotion and demotion in XML documents. (Inherited from SPField.)
	PITarget	Gets or sets the document processing instruction in which the column value is stored in documents of the specified content type, which is used for property promotion and demotion in XML documents. (Inherited from SPField.)
	PrependId	Gets or sets a Boolean value that specifies whether to add item IDs to the beginning of items listed in selection boxes on forms.
	PreviewValueTyped	Gets a preview value of field data for a design-time view of the field control in Display and Edit modes when there is no list item data associated with the field. (Inherited from SPField.)
	PrimaryFieldId	Gets or sets a string representation of the GUID that identifies the primary lookup field if the field is a dependent lookup field.
	PrimaryPIAttribute	Gets or sets an alternate attribute in the document processing instruction, specified by the PrimaryPITarget property, that is used as the column value in property promotion and demotion in XML documents. (Inherited from SPField.)
	PrimaryPITarget	Gets or sets an alternative document processing instruction in which the column value is stored for documents of the specified content type. (Inherited from SPField.)
	PushChangesToLists	Gets or sets a Boolean value that specifies whether to propagate changes that are made in the field template to lists that implement the field. (Inherited from SPField.)
	ReadOnlyField	Gets or sets a Boolean value that specifies whether values in the field can be modified. (Inherited from SPField.)
	RelatedField	Gets or sets the internal name of a field to which the current field is related. (Inherited from SPField.)
	RelationshipDeleteBehavior	Gets or sets the delete behavior of the lookup field.
	Reorderable	Gets a Boolean value that indicates whether values in the field can be reordered. (Inherited from SPField.)
	Required	Gets or sets a Boolean value that determines whether users must enter a value for the field on New and Edit forms. (Inherited from SPField.)
	SchemaXml	Gets or sets the schema that defines the field. (Inherited from SPField.)
	SchemaXmlWithResourceTokens	Gets the schema that defines the field and includes resource tokens. (Inherited from SPField.)
	Scope	Gets the Web site-relative path to the list in which the field collection is used. (Inherited from SPField.)
	Sealed	Gets a value that indicates whether Microsoft SharePoint Foundation field type (as specified in the Type property) can be the parent of a custom derived field type. (Inherited from SPField.)
	ShowInDisplayForm	Gets or sets a Boolean value that specifies whether the field is displayed in the form for displaying list items. (Inherited from SPField.)
	ShowInEditForm	Gets or sets a Boolean value that specifies whether the field is displayed in the form that is used to edit list items. (Inherited from SPField.)
	ShowInListSettings	Gets or sets a Boolean value that specifies whether the field is displayed in the page for customizing list settings. (Inherited from SPField.)
	ShowInNewForm	Gets or sets a Boolean value that specifies whether the field is displayed in the form that is used to create list items. (Inherited from SPField.)
	ShowInVersionHistory	Gets or sets a Boolean value that specifies whether the field is displayed in the page for viewing list item versions. (Inherited from SPField.)
	ShowInViewForms	Gets or sets a Boolean value that specifies whether the field is displayed in pages that are used to view list data. (Inherited from SPField.)
	Sortable	Gets a Boolean value that determines whether the field can be sorted. (Inherited from SPField.)
	SourceId	Gets either the namespace that defines a built-in field or, if it a custom field, the GUID that identifies the list or Web site where it was created. (Inherited from SPField.)
	StaticName	Gets or sets a static name for the field. (Inherited from SPField.)
	Title	Gets or sets the display name for the field. (Inherited from SPField.)
	TitleResource	Gets the resource object associated with the field’s display name. (Inherited from SPField.)
	TranslationXml	Document content that has been stored in a multilingual database for display as an XML document. (Inherited from SPField.)
	Type	Gets or sets the type of the field. (Inherited from SPField.)
	TypeAsString	Gets the type of the field as a string value. (Inherited from SPField.)
	TypeDisplayName	Gets the display name of the field type. (Inherited from SPField.)
	TypeShortDescription	Gets the description of the field. (Inherited from SPField.)
	UnlimitedLengthInDocumentLibrary	Gets or sets a Boolean value that specifies whether to allow values with unlimited text in the lookup field.
	UsedInWebContentTypes	Gets a Boolean value that indicates whether the field is implemented in any content type that is used in the site collection. (Inherited from SPField.)
	ValidationEcmaScript	Gets an ECMAScript function that corresponds to the field’s validation formula. (Inherited from SPField.)
	ValidationFormula	Indicates the formula referenced by the field and is evaluated when a list item is added or updated. (Inherited from SPField.)
	ValidationMessage	Gets or sets a message to display to the user if validation fails for this field. (Inherited from SPField.)
	Version	Gets the version of the field. (Inherited from SPField.)
	XPath	Gets or sets the XPath expression to the field. (Inherited from SPField.)

Top

Methods

	Name	Description
	Delete	Deletes the field. (Inherited from SPField.)
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GetCustomProperty	Gets the value of custom property with the specified name. (Inherited from SPField.)
	GetDependentLookupInternalNames	Returns the internal names of all secondary lookup fields that are dependent on a primary lookup field.
	GetFieldValue	Converts the specified field value into a field type value. (Overrides SPField.GetFieldValue(String).)
	GetFieldValueAsHtml	Gets the field value in HTML format in order to render the field value directly on the page. (Overrides SPField.GetFieldValueAsHtml(Object).)
	GetFieldValueAsText	Converts the field type value into text for use in Display mode. (Overrides SPField.GetFieldValueAsText(Object).)
	GetFieldValueForEdit	Gets the field value that is rendered in Edit mode in Edit and New forms. (Inherited from SPField.)
	GetHashCode	(Inherited from Object.)
	GetProperty	Gets the value of the specified property. (Inherited from SPField.)
	GetType	(Inherited from Object.)
	GetValidatedString	Validates and converts the field value into a serialized form. (Inherited from SPField.)
	HasValue	This member is reserved for internal use and is not intended to be used directly from your code. (Overrides SPField.HasValue(Object).)
	ListsFieldUsedIn	Returns information about the Web sites and lists in which the current field is used. (Inherited from SPField.)
	MemberwiseClone	(Inherited from Object.)
	OnAdded	Handles the event that occurs after a field is added. (Inherited from SPField.)
	OnAddingToContentType	Handles the event that occurs when a field is added to a specified content type. (Inherited from SPField.)
	OnDeleting	Handles the event that occurs when a field is being deleted. (Inherited from SPField.)
	OnDeletingFromContentType	Handles the event that occurs when a field is deleted from a specified content type. (Inherited from SPField.)
	OnInitFieldNode	This member is reserved for internal use and is not intended to be used directly from your code. (Overrides SPField.OnInitFieldNode().)
	OnUpdated	Handles the event that occurs after changes are made to a field. (Overrides SPField.OnUpdated().)
	ParseAndSetValue	Sets the specified field item to the specified value. (Inherited from SPField.)
	SetCustomProperty	Sets a value for the specified property. (Inherited from SPField.)
	ToString	Returns the title of the field. (Inherited from SPField.)
	Update()	Updates the database with changes that are made to the field. (Inherited from SPField.)
	Update(Boolean)	Updates the database with changes that are made to the field and optionally propagates the changes to lists that implement the field. (Inherited from SPField.)

Top

See Also

Reference

SPFieldLookup Class

Microsoft.SharePoint Namespace