Export (0) Print
Expand All

SPFieldLookup members

Represents a lookup field.

The SPFieldLookup type exposes the following members.

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

  Name Description
Public property AggregationFunction Gets or sets the aggregation function for the field. (Inherited from SPField.)
Public property AllowDeletion Gets or sets a Boolean value that specifies whether the field can be deleted. (Inherited from SPField.)
Public property AllowMultipleValues Gets or sets a Boolean value that specifies whether multiple values can be used in the lookup field.
Public property AuthoringInfo Gets the descriptive string that is used in pages for editing fields to identify the field and its purpose. (Inherited from SPField.)
Public property CalloutMenu Gets or sets an indication of whether the field shows a link to the callout menu. (Inherited from SPField.)
Public property CalloutMenuAllowed Gets or sets an indication of whether showing the callout menu in the field is allowed, prohibited, or is optional and determined by the CalloutMenu property. (Inherited from SPField.)
Public property CanBeDeleted Gets a Boolean value that indicates whether the field can be deleted. (Inherited from SPField.)
Public property CanBeDisplayedInEditForm A read-only property indicating whether or not the field can be displayed in an edit form. (Inherited from SPField.)
Public property CanToggleHidden Gets a Boolean value that indicates whether the column can be hidden through the user interface. (Inherited from SPField.)
Public property CompositeIndexable Indicates whether and in what capacity the field can participate in a composite index. (Inherited from SPField.)
Public property 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.
Public property DefaultFormula Gets or sets the default formula for a calculated field. (Inherited from SPField.)
Public property 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.)
Public property DefaultValue Gets or sets the default value for a field. (Inherited from SPField.)
Public property DefaultValueTyped Gets the default value object based on the field type. (Inherited from SPField.)
Public property Description Gets or sets the description for a field. (Inherited from SPField.)
Public property DescriptionResource Gets an SPUserResource object that represents the translations for the description of the field. (Inherited from SPField.)
Public property Direction Gets or sets the direction of the reading order for the field. (Inherited from SPField.)
Public property DisplaySize Gets or sets the display size for the field. (Inherited from SPField.)
Public property EnforceUniqueValues Gets or sets a Boolean value that specifies whether to enforce uniqueness in column values. The default is false. (Inherited from SPField.)
Public property EntityPropertyName Gets the name of the entity property for the list item entity that uses this field. (Inherited from SPField.)
Public property FieldReferences Gets a string array that contains the internal names of fields that are referenced in a computed field. (Inherited from SPField.)
Public property FieldRenderingControl Gets the control that is used to render the field on a form page. (Overrides SPField.FieldRenderingControl.)
Public property FieldRenderingMobileControl Obsolete. Gets the mobile control that is used to render the field on a form page. (Overrides SPField.FieldRenderingMobileControl.)
Public property FieldRenderingMobileWebControl Gets the mobile field type control that is used to render the field in Display, Edit, and New forms, data form Web Parts, or any pages that use field controls. (Overrides SPField.FieldRenderingMobileWebControl.)
Public property FieldTypeDefinition Gets an SPFieldTypeDefinition object that represents the field type definition for the field. (Inherited from SPField.)
Public property FieldValueType Gets the value type of the lookup field. (Overrides SPField.FieldValueType.)
Public property Filterable Gets a Boolean value that indicates whether the field can be filtered. (Inherited from SPField.)
Public property 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.)
Public property FromBaseType Gets a Boolean value that indicates whether the field derives from a base field type. (Inherited from SPField.)
Public property Group Gets or sets the column group to which the field belongs. (Inherited from SPField.)
Public property Hidden Gets or sets a Boolean value that specifies whether the field is displayed in the list. (Inherited from SPField.)
Public property Id Gets the GUID of the field. (Inherited from SPField.)
Public property 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.)
Public property Indexable Read-only property indicating whether the field can be indexed or not. (Inherited from SPField.)
Public property Indexed Sets a Boolean value that specifies whether the field is indexed. (Overrides SPField.Indexed.)
Public property InternalName Gets the internal name that is used for the field. (Inherited from SPField.)
Public property 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.
Public property 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.
Public property JSLink Gets or sets the name of an external JavaScript file that contains any client rendering logic for fields of this type. (Overrides SPField.JSLink.)
Public property 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.)
Public property LinkToItem Gets or sets an indication of whether the field should show a link to the list item's display form when displayed in a list view. (Inherited from SPField.)
Public property LinkToItemAllowed Gets or sets an indication of whether the field, in List View, can show a link to the list item's display form. (Inherited from SPField.)
Public property ListItemMenu Gets or sets an indication of whether the field should show a link to the list item's drop down menu when displayed in a list view. (Inherited from SPField.)
Public property ListItemMenuAllowed Gets or sets an indication of whether the field, in List View, can show a link to the list item's drop down menu. (Inherited from SPField.)
Public property LookupField Gets or sets the internal name of the field in a related list that is the source of this field's value.
Public property LookupList Gets or sets the string representation of the GUID that identifies the list that is the source of this field's value.
Public property LookupWebId Gets or sets the ID of the Web site that contains the list that is the source of this field's value.
Public property NoCrawl Gets or sets a Boolean value that specifies whether the field can be crawled by a search engine. (Inherited from SPField.)
Public property ParentList Gets the parent list that contains the field. (Inherited from SPField.)
Public property 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.)
Public property 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.)
Public property 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.
Public property 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.)
Public property PrimaryFieldId Gets or sets a string representation of the GUID that identifies the primary lookup field if the field is a dependent lookup field.
Public property 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.)
Public property 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.)
Public property 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.)
Public property ReadOnlyField Gets or sets a Boolean value that specifies whether values in the field can be modified. (Inherited from SPField.)
Public property RelatedField Gets or sets the internal name of a field to which the current field is related. (Inherited from SPField.)
Public property RelationshipDeleteBehavior Gets or sets the delete behavior of the lookup field.
Public property Reorderable Gets a Boolean value that indicates whether values in the field can be reordered. (Inherited from SPField.)
Public property 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.)
Public property SchemaXml Gets or sets the schema that defines the field. (Inherited from SPField.)
Public property SchemaXmlWithResourceTokens Gets the schema that defines the field and includes resource tokens. (Inherited from SPField.)
Public property Scope Gets the Web site-relative path to the list in which the field collection is used. (Inherited from SPField.)
Public property 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.)
Public property ShowInDisplayForm Gets or sets a Boolean value that specifies whether the field is displayed in the form for displaying list items. (Inherited from SPField.)
Public property 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.)
Public property ShowInListSettings Gets or sets a Boolean value that specifies whether the field is displayed in the page for customizing list settings. (Inherited from SPField.)
Public property 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.)
Public property 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.)
Public property 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.)
Public property Sortable Gets a Boolean value that determines whether the field can be sorted. (Inherited from SPField.)
Public property 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.)
Public property StaticName Gets or sets a static name for the field. (Inherited from SPField.)
Public property Title Gets or sets the display name for the field. (Inherited from SPField.)
Public property TitleResource Gets the resource object associated with the field’s display name. (Inherited from SPField.)
Public property TranslationXml Document content that has been stored in a multilingual database for display as an XML document. (Inherited from SPField.)
Public property Type Gets or sets the type of the field. (Inherited from SPField.)
Public property TypeAsString Gets the type of the field as a string value. (Inherited from SPField.)
Public property TypeDisplayName Gets the display name of the field type. (Inherited from SPField.)
Public property TypeShortDescription Gets the description of the field. (Inherited from SPField.)
Public property UnlimitedLengthInDocumentLibrary Gets or sets a Boolean value that specifies whether to allow values with unlimited text in the lookup field.
Public property 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.)
Public property ValidationEcmaScript Gets an ECMAScript function that corresponds to the field’s validation formula. (Inherited from SPField.)
Public property ValidationFormula Indicates the formula referenced by the field and is evaluated when a list item is added or updated. (Inherited from SPField.)
Public property ValidationMessage Gets or sets a message to display to the user if validation fails for this field. (Inherited from SPField.)
Public property Version Gets the version of the field. (Inherited from SPField.)
Public property XPath Gets or sets the XPath expression to the field. (Inherited from SPField.)
Top

  Name Description
Public method AnnotateField Adds attributes to the specified XML node and assigns them values from the properties of this SPField object. (Overrides SPField.AnnotateField(XmlNode).)
Public method Delete Deletes the field. (Inherited from SPField.)
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetCustomProperty Gets the value of custom property with the specified name. (Inherited from SPField.)
Public method GetDependentLookupInternalNames Returns the internal names of all secondary lookup fields that are dependent on a primary lookup field.
Public method GetFieldValue Converts the specified field value into a field type value. (Overrides SPField.GetFieldValue(String).)
Public method GetFieldValueAsHtml Gets the field value in HTML format in order to render the field value directly on the page. (Overrides SPField.GetFieldValueAsHtml(Object).)
Public method GetFieldValueAsText Converts the field type value into text for use in Display mode. (Overrides SPField.GetFieldValueAsText(Object).)
Public method GetFieldValueForClientRender Converts the field type value into object for use in client Display, Edit and New item forms. (Overrides SPField.GetFieldValueForClientRender(SPItem, SPControlMode).)
Public method GetFieldValueForEdit Gets the field value that is rendered in Edit mode in Edit and New forms. (Inherited from SPField.)
Public method GetHashCode (Inherited from Object.)
Public method GetJsonClientFormFieldSchema Gets an object containing information from the field's schema that is useful for client rendering of the field in forms. (Overrides SPField.GetJsonClientFormFieldSchema(SPControlMode).)
Public method GetProperty Gets the value of the specified property. (Inherited from SPField.)
Public method GetType (Inherited from Object.)
Public method GetValidatedString Validates and converts the field value into a serialized form. (Inherited from SPField.)
Protected method HasValue This member is reserved for internal use and is not intended to be used directly from your code. (Overrides SPField.HasValue(Object).)
Public method ListsFieldUsedIn Returns information about the Web sites and lists in which the current field is used. (Inherited from SPField.)
Protected method MemberwiseClone (Inherited from Object.)
Public method OnAdded Handles the event that occurs after a field is added. (Inherited from SPField.)
Public method OnAddingToContentType Handles the event that occurs when a field is added to a specified content type. (Inherited from SPField.)
Public method OnDeleting Handles the event that occurs when a field is being deleted. (Inherited from SPField.)
Public method OnDeletingFromContentType Handles the event that occurs when a field is deleted from a specified content type. (Inherited from SPField.)
Protected method OnInitFieldNode This member is reserved for internal use and is not intended to be used directly from your code. (Overrides SPField.OnInitFieldNode().)
Public method OnUpdated Handles the event that occurs after changes are made to a field. (Overrides SPField.OnUpdated().)
Public method ParseAndSetValue When overridden in a derived class, sets the specified field item to the specified value. (Inherited from SPField.)
Public method ParseValue When overridden in a derived class, parses a potential value of the field and returns an object that can be assigned as the value of the field. (Inherited from SPField.)
Public method RenderFieldValueAsJson Returns the specified value in JSON format. (Overrides SPField.RenderFieldValueAsJson(Object).)
Public method RevertCustomizations Reverts customizations made to the field schema. (Inherited from SPField.)
Public method SetCustomProperty Sets a value for the specified property. (Inherited from SPField.)
Public method ToString Returns the title of the field. (Inherited from SPField.)
Public method Update() Updates the database with changes that are made to the field. (Inherited from SPField.)
Public method 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.)
Public method ValidateAndParseValue Validates and parses the input value and returns a valid object that can be the value of the field. (Overrides SPField.ValidateAndParseValue(SPListItem, String).)
Public method ValidateParseAndSetValue Calls ValidateAndParseValue(SPListItem, String) and assigns the returned object as the value of the field. (Inherited from SPField.)
Top
Show:
© 2014 Microsoft