LayoutDefinitions Schema Custom Properties

  • Article

Applies to: SharePoint Server 2010

Descriptions of Custom Properties for the LayoutDefinitions Schema

Custom Properties for the Container Element

The following is an example of a Container element with Height and Width custom properties. Table 1 lists all supported custom properties for the Container and provides their descriptions.

<Container ContainerType="Stack" 
           xmlns="https://schemas.microsoft.com/office/2009/05/BusinessApplications/Layout"
           xmlns:loc="https://schemas.microsoft.com/office/2009/05/BusinessApplications/Localization">
  <CustomProperties>
    <CustomProperty Name="Height" Value="530" />
    <CustomProperty Name="Width" Value="530" />
  </CustomProperties>
  <Children>
    <OBPart ...=""
    </OBPart>
  </Children>
</Container>

Table 1. Descriptions of Container custom properties

Property Name

Data Type

Description

Default value

Height

System.Int32

Specifies the height of the container.

400

Width

System.Int32

Specifies the width of the container.

400

Custom Properties for External Data Parts of Type "List"

The following example shows how to add a custom property for a List external data part. The name and value of the custom property given in this example are placeholders and should be replaced by valid values from Table 2. Table 2 lists all supported custom properties for the List external data part and provides their descriptions.

<?xml version="1.0" encoding="utf-8" ?>
<Container ContainerType="Stack" 
           xmlns="https://schemas.microsoft.com/office/2009/05/BusinessApplications/Layout" 
           xmlns:loc="https://schemas.microsoft.com/office/2009/05/BusinessApplications/Localization">
  <Children>
    <OBPart PartType="List" DataSourceName="DataSourceName" QualifiedTypeName="" >
      <CustomProperties >
        <CustomProperty Name="CustomPropertyName" Value="CustomPropertyValue" />
      </CustomProperties>
    </OBPart>
  </Children>
</Container>

Table 2. Descriptions of List external data part custom properties

Property Name

Data Type

Description

Default value

Accepted Values

AutoCollapseNewGroups

System.Boolean

Specifies whether Groups are collapsed after they are created in the List external data part.

false

ColumnHeadersVisible

System.Boolean

Specifies whether to display the List external data part column headers.

true

ColumnSizingMode

System.String

Specifies whether the sizing of the columns is fixed or dynamic.

Set this property to Dynamic if you are specifying the columns to display in the ColumnsXml property.

Fixed

Dynamic, Fixed

ColumnsXml

An XML string

Specifies which columns to display in the List external data part.

Example:

<CustomProperty Name="ColumnsXml" Value="&lt;Columns&gt;
  &lt;Column DisplayName=&quot; &quot; Name=&quot;$SyncState$&quot; /&gt;
  &lt;Column DisplayName=&quot;Field 1 Display Name&quot; Name=
  &quot;Field 1 Name in Entity View&quot; /&gt;&lt;Column DisplayName=
  &quot;Field 2 Display Name&quot; Name=&quot;Field 2 Name in Entity View
  &quot; Width=&quot;100&quot; /&gt;&lt;Columns&gt;" />

ConsumerPartName

System.String

Specifies the external data part name that the selected item uses to set the data source.

ContentAlignment

System.String

Specifies the alignment of the cell in the List external data part.

TopLeft

BottomCenter, BottomLeft, BottomRight, MiddleCenter, MiddleLeft, MiddleRight, TopCenter, TopLeft, TopRight

DataMemberName

System.String

Specifies the external content type Finder instance or the association name that is used to populate the List external data part.

DataSourceMode

System.String

Specifies whether to populate List external data part based on a Finder for the entity (List value) or to populate the List external data part based on an association between entities (AssociationList value).

List, AssociationList

DefaultActionName

System.String

Specifies the name of the action that is triggered when double-clicking the item in the List external data part.

DefaultActionSource

System.String

Use with DefaultActionName to indicate where the action is defined in the oir.config file. A value of OfficeContext specifies that the action is defined in the Office context; a value of TargetContext specifies that the action is defined in the EntityView context.

OfficeContext, TargetContext

DefaultColumnCount

System.Int32

Specifies how many columns to display in the List external data part. A value of 0 shows all external content type fields.

The first three columns from the Entity View.

DisplayName

System.String

Specifies the caption to display in the column header of the List external data part.

FilterValue

System.String

Specifies the default filter value for a column.

Example:

Column DisplayName=&quot;IssueStatus&quot; Name=&quot;IssueStatus&quot; FilterValue=&quot;New&quot;

FormatString

System.String

.NET format string. For more information, see String.Format.

The following example shows how to specify a format string for the .NET DateTime and number format types.

 Column FormatString=&quot;#.00&quot; DisplayName=&quot;Total Due&quot; Name=&quot;TotalDue&quot;

Height

System.Int32

Specifies the height of the external data part.

400

IsRefreshButtonVisible

System.Boolean

Specifies whether to display the Refresh Data button in the List external data part.

true

IsTargetContextActionsVisible

System.Boolean

Specifies whether to display actions defined in the EntityView context in the List external data part.

true

LobSystemInstanceName

System.String

Specifies the name of the external system instance. Use in multiple LobSystemInstance association scenarios.

The external system instance name of the current Outlook item.

MaximumVisibleRowCount

System.Int32

Specifies the maximum row of the List external data part. Use to adjust the height of the List external data part.

10

Name

System.String

Specifies the name of the external content type view.

The following example shows how to specify the name in a column for the sync start part.

Column DisplayName=&quot; &quot; Name=&quot;$SyncState$&quot;

SortDirection

System.String

Specifies the sort direction.

Ascending

Ascending, Descending

SortedColumnName

System.String

Specifies the name of the column that is used by default for sorting.

First column.

Width

System.Int32

Specifies the width of the external data part.

400

Width

System.Int32

Specifies the default width of a column.

WrapCellText

System.Boolean

Specifies whether to wrap the cell text.

false

Custom Properties for External Data Parts of Type "InfoPath"

The following is an example of an InfoPath external data part with the Name, FormLocation, IsReadOnly, and Height custom properties. Table 3 lists all supported custom properties for the InfoPath external data part and provides their descriptions.

<?xml version="1.0" encoding="utf-8" ?>
<Container ContainerType="Stack" 
           xmlns="https://schemas.microsoft.com/office/2009/05/BusinessApplications/Layout" 
           xmlns:loc="https://schemas.microsoft.com/office/2009/05/BusinessApplications/Localization">
  <Children>
    <OBPart PartType="InfoPath" DataSourceName="PrimaryEntityNameInContext">
      <CustomProperties>
        <CustomProperty Name="Name" Value="IPOBP" />
        <CustomProperty Name="FormLocation" Value="Template.xsn" />
        <CustomProperty Name="IsReadOnly" Value="True" />
        <CustomProperty Name="Height" Value="640" />
      </CustomProperties>
    </OBPart>
  </Children>
</Container>

Table 3. Descriptions of InfoPath external data part custom properties

Property Name

Data Type

Description

Default value

FormIntroductionText

System.String

Specifies the text that is shown below the title bar and above the form; this text helps the user fill out the form.

FormLocation

System.String

Specifies the name of the InfoPath file.

Height

System.String

Specifies the height of the InfoPath external data part.

400

IsCancelButtonVisible

System.Boolean

Specifies whether to display the Cancel button.

false

IsReadOnly

System.Boolean

Specifies whether the Infopath external data part is read-only.

false

IsSaveButtonVisible

System.Boolean

Specifies whether to display the Save button.

false

IsViewSwitcherVisible

System.Boolean

Specifies whether to display a drop-down list to show the list of the views within the InfoPath form.

false

SubscriptionName

System.String

Specifies the name of the subscription for which the created item is added in the cache.

ViewName

System.String

Specifies the name of the InfoPath form view to show by default.

Width

System.String

Specifies the width of the InfoPath external data part.

400