Skip to content

Commit 198fb8c

Browse files
Linda CaputoVesaJuvonen
Linda Caputo
authored and
VesaJuvonen
committed
Attempt to fix table (SharePoint#3638)
Table is not rendering correctly at https://docs.microsoft.com/en-us/sharepoint/dev/schema/field-element-field-types.
1 parent 66d91e3 commit 198fb8c

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

‎docs/schema/field-element-field-types.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Field element (Field Types)
33
manager: soliver
4-
ms.date: 3/9/2015
4+
ms.date: 3/20/2019
55
ms.audience: Developer
66
ms.topic: reference
77
ms.prod: office-online-server
@@ -30,7 +30,7 @@ The following sections describe attributes, child elements, and parent elements.
3030

3131
### Attributes
3232

33-
|**Attribute**|**Description**|
33+
|Attribute|Description|
3434
|:-----|:-----|
3535
|**Name** <br/> |Required **Text**. A string that represents the name of the specific aspect of the field type that the **Field** element represents. The value must be one of the strings listed in the table under **Remarks**. <br/> |
3636

@@ -50,25 +50,25 @@ Each **FieldType** element has several required and optional **Field** elements
5050

5151
<br/>
5252

53-
|**Value of Field Element's Name Attribute**|**Description**|
53+
|Value of Field Element's Name Attribute|Description|
5454
|:-----|:-----|
55-
|**AllowBaseTypeRendering** <br/> |Optional **Boolean**. The default is **FALSE**. Specifies whether a client application renders the field as its base type (also called the **ParentType**), if the client application cannot determine how to properly render the custom field type. If set to **TRUE**, and the client application cannot properly render the custom field type, the client application renders the field as the default SharePoint Foundation parent field type from which it inherits. <br/> |
56-
|**CAMLRendering** <br/> |Optional **Boolean**. The default is **FALSE**. Specifies whether the field is rendered on list views using the CAML markup in a **RenderPattern** element elsewhere within the parent **FieldType** element. The default **FALSE** means that the field is rendered on list views by an XSL transform in a fldtypes\*.xsl file, which is the standard system for field rendering on list views. (However, this element has no effect on field rendering on Display, New, and Edit forms. A **RenderPattern** would still be the standard way of rendering the field on a Display form.) <br/> |
57-
|**FieldTypeClass** <br/> |Optional **String**, *but required for all your custom field types*. Represents the strong name of the field type class library. **FieldTypeClass** includes the class name and assembly name with **Version**, **Culture**, and **PublicKeyToken**; for example:<br/> `<Field Name="FieldTypeClass">CustomFieldTypes.RegularExpression.RegularExpressionField, CustomFieldTypes.RegularExpression, Version=1.0.0.0, Culture=neutral, PublicKeyToken=57e55365ec0ce80a</Field>`<br/><br/> Only the fully qualified class name is included for field types built into SharePoint Foundation. <br/> |
58-
|**FieldEditorUserControl** <br/> |Optional **String**. Represents the relative path to a *field_type* FieldEditor.ascx file that defines a control that appears in SharePoint Foundation in the **Additional Column Settings** section on the **New Site Column** page. The control enables column creators to set, for a particular column, the variable properties of the field type.<br/><br/>For example:<br/> `"/_controltemplates/RegularExpressionFieldEditor.ascx"`.<br/><br/>If there is no `<Field Name="FieldEditorUserControl">` element, the special properties of the field type are rendered by the [PropertySchema element (Field Types)](propertyschema-element-field-types.md) element.<br/><br/>**FieldEditorUserControl** should be a fixed, nonlocalizable string. <br/> |
59-
|**Filterable** <br/> |Required **Boolean**. Represents whether a list with a column that is based on this field type can be filtered according to the value of the column that uses this type. If set to **TRUE**, the header of the column is a control that users can use to filter the list. <br/> |
60-
|**InternalType** <br/> |Optional **String**. Represents an internal base type. Do not use a `<Field Name="InternalType">` element in your custom field type definitions. <br/> |
61-
|**ParentType** <br/> |Required **String** (but can be an empty string). Represents the name of the type from which the field class is derived. The possible values are exactly the same as the possible values for the **Type** attribute of the [Field element (List)](field-element-list.md) element. If the field type is not derived from another type, the value is an empty string: <br/> `<Field Name="ParentType"> </Field>`. It must never be empty in your custom field types. All custom types inherit from another type.<br/><br/>In the SharePoint Foundation object model, **ParentType** is called [BaseRenderingTypeName](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPFieldTypeDefinition.BaseRenderingTypeName.aspx). <br/> |
62-
|**ShowOnListAuthoringPages** <br/> |Optional **Boolean**. The default is **TRUE**. Represents whether this field type is displayed for inclusion on lists. If set to **TRUE**, SharePoint Foundation displays this field type on list authoring pages so that users can include the field type on their lists.<br/><br/>In the SharePoint Foundation object model, **ShowOnListAuthoringPages** is called [ShowOnListCreate](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPFieldTypeDefinition.ShowOnListCreate.aspx). <br/> |
63-
|**ShowOnDocumentLibraryAuthoringPages** <br/> |Optional **Boolean**. The default is **TRUE**. Represents whether this field type is displayed for inclusion in document libraries. If set to **TRUE**, SharePoint Foundation displays this field type on document library authoring pages so that users can include the field type in their document libraries. <br/><br/>In the SharePoint Foundation object model, **ShowOnDocumentLibraryAuthoringPages** is called [ShowOnDocumentLibraryCreate](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPFieldTypeDefinition.ShowOnDocumentLibraryCreate.aspx). <br/> |
64-
|**ShowOnSurveyAuthoringPages** <br/> |Optional **Boolean**. The default is **TRUE**. Represents whether this field type is displayed for inclusion on surveys. If set to **TRUE**, SharePoint Foundation displays this field type on survey authoring pages so that users can include the field type in their surveys.<br/><br/>In the SharePoint Foundation object model, **ShowOnSurveyAuthoringPages** is called [ShowOnSurveyCreate](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPFieldTypeDefinition.ShowOnSurveyCreate.aspx). <br/> |
65-
|**ShowOnColumnTemplateAuthoringPages** <br/> |Optional **Boolean**. The default is **TRUE**. Represents whether this field type should be displayed as a column template field type. If set to **TRUE**, SharePoint Foundation displays this field type on column template authoring pages so that users can select to create a column template of this field type.<br/><br/>In the SharePoint Foundation object model, **ShowOnColumnTemplateAuthoringPages** is called [ShowOnColumnTemplateCreate](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPFieldTypeDefinition.ShowOnColumnTemplateCreate.aspx). <br/> |
66-
|**SQLType** <br/> |Optional **String**. Represents the SQL data type that is used to store the data in the content database. Do not use a `<Field Name="SQLType">` element in your custom field type definitions. <br/> |
67-
|**Sortable** <br/> |Required **Boolean**. Represents whether a list with a column that is based on this field type can be sorted on the column that uses this type. If set to **TRUE**, the header of the column is a control that users can use to sort the list. <br/> |
68-
|**TypeDisplayName** <br/> |Required **String**. Represents the display name of the field type in the user interface (UI). In SharePoint Foundation, it appears in the **Type** column on the **Customize** [list] page (listedit.aspx). It is also used in place of **TypeShortDescription** if the latter is not present.<br/><br/>**TypeDisplayName** should be a localizable string. <br/> |
69-
|**TypeName** <br/> |Required **String**. Represents the name of the field type. This must be unique among all field type names on the SharePoint server farm.<br/><br/>**TypeName** should be a fixed, nonlocalizable string. <br/> |
70-
|**TypeShortDescription** <br/> |Optional **String**. Represents the short description of the field type that is displayed in the UI. In SharePoint Foundation, it appears with a radio button in the **Name and Type** section of the **New Site Column** and **Create Column** pages and in the **Type** column of the **Site Column Gallery**. If there is no `<Field Name="TypeShortDescription">` element, **TypeDisplayName** is used.<br/><br/>**TypeShortDescription** should be a localizable string. <br/> |
71-
|**UserCreatable** <br/> |Optional **Boolean**. The default is **TRUE**, which enables users to add fields of this field type to lists. Setting the value to **FALSE** allows use of the field type in list schemas, but hides the field type from users on the **Name and Type** section of the **New Site Column** and **Create Column** pages. <br/> |
55+
|**AllowBaseTypeRendering** |Optional **Boolean**. The default is **FALSE**. Specifies whether a client application renders the field as its base type (also called the **ParentType**), if the client application cannot determine how to properly render the custom field type. If set to **TRUE**, and the client application cannot properly render the custom field type, the client application renders the field as the default SharePoint Foundation parent field type from which it inherits.|
56+
|**CAMLRendering** |Optional **Boolean**. The default is **FALSE**. Specifies whether the field is rendered on list views using the CAML markup in a **RenderPattern** element elsewhere within the parent **FieldType** element. The default **FALSE** means that the field is rendered on list views by an XSL transform in a fldtypes\*.xsl file, which is the standard system for field rendering on list views. (However, this element has no effect on field rendering on Display, New, and Edit forms. A **RenderPattern** would still be the standard way of rendering the field on a Display form.)|
57+
|**FieldTypeClass** |Optional **String**, *but required for all your custom field types*. Represents the strong name of the field type class library. **FieldTypeClass** includes the class name and assembly name with **Version**, **Culture**, and **PublicKeyToken**; for example:<br/>`<Field Name="FieldTypeClass">CustomFieldTypes.RegularExpression.RegularExpressionField, CustomFieldTypes.RegularExpression, Version=1.0.0.0, Culture=neutral, PublicKeyToken=57e55365ec0ce80a</Field>`<br/><br/>Only the fully qualified class name is included for field types built into SharePoint Foundation.|
58+
|**FieldEditorUserControl** |Optional **String**. Represents the relative path to a *field_type* FieldEditor.ascx file that defines a control that appears in SharePoint Foundation in the **Additional Column Settings** section on the **New Site Column** page. The control enables column creators to set, for a particular column, the variable properties of the field type.<br/><br/>For example:<br/>`"/_controltemplates/RegularExpressionFieldEditor.ascx"`.<br/><br/>If there is no `<Field Name="FieldEditorUserControl">` element, the special properties of the field type are rendered by the [PropertySchema element (Field Types)](propertyschema-element-field-types.md) element.<br/><br/>**FieldEditorUserControl** should be a fixed, nonlocalizable string.|
59+
|**Filterable** |Required **Boolean**. Represents whether a list with a column that is based on this field type can be filtered according to the value of the column that uses this type. If set to **TRUE**, the header of the column is a control that users can use to filter the list.|
60+
|**InternalType** |Optional **String**. Represents an internal base type. Do not use a `<Field Name="InternalType">` element in your custom field type definitions.|
61+
|**ParentType** |Required **String** (but can be an empty string). Represents the name of the type from which the field class is derived. The possible values are exactly the same as the possible values for the **Type** attribute of the [Field element (List)](field-element-list.md) element. If the field type is not derived from another type, the value is an empty string:<br/>`<Field Name="ParentType"> </Field>`. It must never be empty in your custom field types. All custom types inherit from another type.<br/><br/>In the SharePoint Foundation object model, **ParentType** is called [BaseRenderingTypeName](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPFieldTypeDefinition.BaseRenderingTypeName.aspx).|
62+
|**ShowOnListAuthoringPages** |Optional **Boolean**. The default is **TRUE**. Represents whether this field type is displayed for inclusion on lists. If set to **TRUE**, SharePoint Foundation displays this field type on list authoring pages so that users can include the field type on their lists.<br/><br/>In the SharePoint Foundation object model, **ShowOnListAuthoringPages** is called [ShowOnListCreate](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPFieldTypeDefinition.ShowOnListCreate.aspx).|
63+
|**ShowOnDocumentLibraryAuthoringPages** |Optional **Boolean**. The default is **TRUE**. Represents whether this field type is displayed for inclusion in document libraries. If set to **TRUE**, SharePoint Foundation displays this field type on document library authoring pages so that users can include the field type in their document libraries.<br/><br/>In the SharePoint Foundation object model, **ShowOnDocumentLibraryAuthoringPages** is called [ShowOnDocumentLibraryCreate](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPFieldTypeDefinition.ShowOnDocumentLibraryCreate.aspx).|
64+
|**ShowOnSurveyAuthoringPages** |Optional **Boolean**. The default is **TRUE**. Represents whether this field type is displayed for inclusion on surveys. If set to **TRUE**, SharePoint Foundation displays this field type on survey authoring pages so that users can include the field type in their surveys.<br/><br/>In the SharePoint Foundation object model, **ShowOnSurveyAuthoringPages** is called [ShowOnSurveyCreate](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPFieldTypeDefinition.ShowOnSurveyCreate.aspx).|
65+
|**ShowOnColumnTemplateAuthoringPages** |Optional **Boolean**. The default is **TRUE**. Represents whether this field type should be displayed as a column template field type. If set to **TRUE**, SharePoint Foundation displays this field type on column template authoring pages so that users can select to create a column template of this field type.<br/><br/>In the SharePoint Foundation object model, **ShowOnColumnTemplateAuthoringPages** is called [ShowOnColumnTemplateCreate](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPFieldTypeDefinition.ShowOnColumnTemplateCreate.aspx).|
66+
|**SQLType** |Optional **String**. Represents the SQL data type that is used to store the data in the content database. Do not use a `<Field Name="SQLType">` element in your custom field type definitions. |
67+
|**Sortable** |Required **Boolean**. Represents whether a list with a column that is based on this field type can be sorted on the column that uses this type. If set to **TRUE**, the header of the column is a control that users can use to sort the list.|
68+
|**TypeDisplayName** |Required **String**. Represents the display name of the field type in the user interface (UI). In SharePoint Foundation, it appears in the **Type** column on the **Customize** [list] page (listedit.aspx). It is also used in place of **TypeShortDescription** if the latter is not present.<br/><br/>**TypeDisplayName** should be a localizable string.|
69+
|**TypeName** |Required **String**. Represents the name of the field type. This must be unique among all field type names on the SharePoint server farm.<br/><br/>**TypeName** should be a fixed, nonlocalizable string.|
70+
|**TypeShortDescription** |Optional **String**. Represents the short description of the field type that is displayed in the UI. In SharePoint Foundation, it appears with a radio button in the **Name and Type** section of the **New Site Column** and **Create Column** pages and in the **Type** column of the **Site Column Gallery**. If there is no `<Field Name="TypeShortDescription">` element, **TypeDisplayName** is used.<br/><br/>**TypeShortDescription** should be a localizable string.|
71+
|**UserCreatable** |Optional **Boolean**. The default is **TRUE**, which enables users to add fields of this field type to lists. Setting the value to **FALSE** allows use of the field type in list schemas, but hides the field type from users on the **Name and Type** section of the **New Site Column** and **Create Column** pages.|
7272

7373
## Example
7474

@@ -77,7 +77,7 @@ The following example defines a custom field type.
7777
> [!IMPORTANT]
7878
> The **RenderPattern** is obsolete. It is shown here solely to assist in the debugging of custom fields that were originally developed against earlier versions of SharePoint Foundation.
7979
80-
```XML
80+
```xml
8181
<FieldType>
8282
<Field Name="TypeName">SocialSecurityNumber</Field>
8383
<Field Name="ParentType">Text</Field>

0 commit comments

Comments
 (0)