Elemento field (Tipos de Campo)
Aplica-se a: SharePoint 2016 | SharePoint Foundation 2013 | | do SharePoint Online SharePoint Server 2013
Representa uma característica do tipo de campo.
<Field Name="Text"></Field>
Elementos e atributos
As seções a seguir descrevem os atributos, os elementos filhos e os elementos pai.
Atributos
| Atributo | Descrição |
|---|---|
| Nome | Texto obrigatório. Uma cadeia de caracteres que representa o nome do aspecto específico do tipo de campo que o elemento Field representa. O valor deve ser uma das cadeias de caracteres listadas na tabela em Comentários. |
Elementos filho
Nenhum
Elementos pai
Comentários
Os filhos do elemento de campo dos elementos FieldType são configurados em fldtypes*.xml arquivos em %ProgramFiles%\Common Files\Microsoft Shared\Web server extensions\15\TEMPLATE\XML.
Cada elemento FieldType tem vários elementos de campo obrigatórios e opcionais diferenciados pelo atributo Name . A tabela a seguir descreve esses elementos. No modelo de objeto, um tipo de campo é representado pela classe SPFieldTypeDefinition . A última classe tem uma propriedade somente leitura correspondente a todas, exceto duas das linhas da tabela (as exceções são InternalType e SQLType). Exceto quando observado caso contrário, os nomes da propriedade correspondem ao valor do atributo Name correspondente.
Valor do atributo do elemento de Name campo |
Descrição |
|---|---|
| AllowBaseTypeRendering | Booliano opcional. O padrão é FALSE. Especifica se um aplicativo cliente renderiza o campo como seu tipo base (também chamado de ParentType), se o aplicativo cliente não puder determinar como renderizar corretamente o tipo de campo personalizado. Se definido como TRUE, e o aplicativo cliente não puder renderizar corretamente o tipo de campo personalizado, o aplicativo cliente renderizará o campo como o tipo de campo pai padrão do SharePoint Foundation do qual herda. |
| CAMLRendering | Booliano opcional. O padrão é FALSE. Especifica se o campo é renderizado em exibições de lista usando a marcação CAML em um elemento RenderPattern em outro lugar dentro do elemento FieldType pai. O FALSE padrão significa que o campo é renderizado em exibições de lista por uma transformação XSL em um arquivo fldtypes*.xsl, que é o sistema padrão para renderização de campo em exibições de lista. (No entanto, esse elemento não tem efeito na renderização de campo nos formulários Exibir, Novo e Editar. Um RenderPattern ainda seria a maneira padrão de renderizar o campo em um formulário de exibição.) |
| FieldTypeClass | Cadeia de caracteres opcional, mas necessária para todos os tipos de campo personalizados. Representa o nome forte da biblioteca de classes de tipo de campo. FieldTypeClass inclui o nome da classe e o nome do assembly com Versão, Cultura e PublicKeyToken; por exemplo:<Field Name="FieldTypeClass">CustomFieldTypes.RegularExpression.RegularExpressionField, CustomFieldTypes.RegularExpression, Version=1.0.0.0, Culture=neutral, PublicKeyToken=57e55365ec0ce80a</Field>Somente o nome da classe totalmente qualificado está incluído para tipos de campo integrados ao SharePoint Foundation. |
| FieldEditorUserControl | Cadeia de caracteres opcional. Representa o caminho relativo para um arquivo field_type FieldEditor.ascx que define um controle que aparece no SharePoint Foundation na seção Configurações adicionais de coluna na página Nova Coluna do Site . O controle permite que os criadores de coluna definam, para uma coluna específica, as propriedades variáveis do tipo de campo. Por exemplo: "/_controltemplates/RegularExpressionFieldEditor.ascx".Se não houver nenhum <Field Name="FieldEditorUserControl"> elemento, as propriedades especiais do tipo de campo serão renderizadas pelo elemento PropertySchema (Tipos de Campo).FieldEditorUserControl deve ser uma cadeia de caracteres fixa e nãocalizável. |
| Filtráveis | Booleano obrigatório. Representa se uma lista com uma coluna baseada nesse tipo de campo pode ser filtrada de acordo com o valor da coluna que usa esse tipo. Se definido como TRUE, o cabeçalho da coluna é um controle que os usuários podem usar para filtrar a lista. |
| InternalType | Cadeia de caracteres opcional. Representa um tipo de base interno. Não use um <Field Name="InternalType"> elemento em suas definições de tipo de campo personalizado. |
| Parenttype | Cadeia de caracteres necessária (mas pode ser uma cadeia de caracteres vazia). Representa o nome do tipo do qual a classe de campo é derivada. Os valores possíveis são exatamente os mesmos que os valores possíveis para o atributo Type do elemento Field (List). Se o tipo de campo não for derivado de outro tipo, o valor será uma cadeia de caracteres vazia:<Field Name="ParentType"> </Field>. Ele nunca deve estar vazio em seus tipos de campo personalizados. Todos os tipos personalizados herdam de outro tipo.No modelo de objeto do SharePoint Foundation, ParentType é chamado BaseRenderingTypeName. |
| ShowOnListAuthoringPages | Booliano opcional. O padrão é TRUE. Representa se esse tipo de campo é exibido para inclusão em listas. Se definido como TRUE, o SharePoint Foundation exibirá esse tipo de campo em páginas de criação de lista para que os usuários possam incluir o tipo de campo em suas listas. No modelo de objeto do SharePoint Foundation, ShowOnListAuthoringPages se chama ShowOnListCreate. |
| ShowOnDocumentLibraryAuthoringPages | Booliano opcional. O padrão é TRUE. Representa se esse tipo de campo é exibido para inclusão em bibliotecas de documentos. Se definido como TRUE, o SharePoint Foundation exibirá esse tipo de campo em páginas de criação da biblioteca de documentos para que os usuários possam incluir o tipo de campo em suas bibliotecas de documentos. No modelo de objeto do SharePoint Foundation, ShowOnDocumentLibraryAuthoringPages se chama ShowOnDocumentLibraryCreate. |
| ShowOnSurveyAuthoringPages | Booliano opcional. O padrão é TRUE. Representa se esse tipo de campo é exibido para inclusão em pesquisas. Se definido como TRUE, o SharePoint Foundation exibirá esse tipo de campo em páginas de criação de pesquisa para que os usuários possam incluir o tipo de campo em suas pesquisas. No modelo de objeto do SharePoint Foundation, ShowOnSurveyAuthoringPages se chama ShowOnSurveyCreate. |
| ShowOnColumnTemplateAuthoringPages | Booliano opcional. O padrão é TRUE. Representa se esse tipo de campo deve ser exibido como um tipo de campo de modelo de coluna. Se definido como TRUE, o SharePoint Foundation exibirá esse tipo de campo em páginas de criação de modelo de coluna para que os usuários possam selecionar para criar um modelo de coluna desse tipo de campo. No modelo de objeto do SharePoint Foundation, ShowOnColumnTemplateAuthoringPages se chama ShowOnColumnTemplateCreate. |
| Sqltype | Cadeia de caracteres opcional. Representa o tipo de dados SQL usado para armazenar os dados no banco de dados de conteúdo. Não use um <Field Name="SQLType"> elemento em suas definições de tipo de campo personalizado. |
| Ordenável | Booleano obrigatório. Representa se uma lista com uma coluna baseada nesse tipo de campo pode ser classificada na coluna que usa esse tipo. Se definido como TRUE, o cabeçalho da coluna é um controle que os usuários podem usar para classificar a lista. |
| TypeDisplayName | String necessário. Representa o nome de exibição do tipo de campo na interface do usuário (interface do usuário). No SharePoint Foundation, ele aparece na coluna Tipo na página Personalizar [lista] (listedit.aspx). Ele também será usado no lugar de TypeShortDescription se este não estiver presente. TypeDisplayName deve ser uma cadeia de caracteres localizável. |
| TypeName | String necessário. Representa o nome do tipo de campo. Isso deve ser exclusivo entre todos os nomes de tipo de campo no farm de servidores do SharePoint. TypeName deve ser uma cadeia de caracteres fixa e nãocalizável. |
| TypeShortDescription | Cadeia de caracteres opcional. Representa a breve descrição do tipo de campo exibido na interface do usuário. No SharePoint Foundation, ele aparece com um botão de rádio na seção Nome e Tipo das páginas Nova Coluna do Site e Criar Coluna e na coluna Tipo da Galeria de Colunas do Site. Se não houver nenhum <Field Name="TypeShortDescription"> elemento, TypeDisplayName será usado.TypeShortDescription deve ser uma cadeia de caracteres localizável. |
| UserCreatable | Booliano opcional. O padrão é TRUE, que permite que os usuários adicionem campos desse tipo de campo às listas. Definir o valor como FALSE permite o uso do tipo de campo em esquemas de lista, mas oculta o tipo de campo dos usuários na seção Nome e Tipo das páginas Nova Coluna do Site e Criar Coluna . |
Exemplo
O exemplo a seguir define um tipo de campo personalizado.
Importante
O RenderPattern é obsoleto. Ele é mostrado aqui apenas para ajudar na depuração de campos personalizados que foram originalmente desenvolvidos em relação a versões anteriores do SharePoint Foundation.
<FieldType>
<Field Name="TypeName">SocialSecurityNumber</Field>
<Field Name="ParentType">Text</Field>
<Field Name="TypeDisplayName">Social Security Number</Field>
<Field Name="TypeShortDescription">Social Security Number (123456789, 123-45-6789)</Field>
<Field Name="AllowBaseTypeRendering">TRUE</Field>
<Field Name="FieldTypeClass">
AdventureWorks.FieldTypes.SPFieldSSN, AdventureWorks.FieldTypes.SPFieldSSN,
Version=1.0.0.0,Culture=neutral,PublicKeyToken=90734cc53324b79c
</Field>
<RenderPattern Name="DisplayPattern">
<Column HTMLEncode="TRUE" />
<Column HTMLEncode="TRUE" UseRelatedField="TRUE"/>
</RenderPattern>
</FieldType>