LinksControlOptions elements
TFS 2017 | TFS 2015 | TFS 2013
Important
This article applies to customization for the On-premises XML process model for the old web form. For the new web form and TFS 2017 and later versions, see LinksControlOptions XML elements. For an overview of process models, see Customize your work tracking experience.
You use the LinksControlOptions element to define the options for controlling what links can be added to a work item and the default columns that you want to appear for the list of links in a work item. When you add a links control to a work item form, you can specify filters that restrict the types of links that users can be view and create and the types of work items to which users can create links. Specifically, you use the following elements as indicated:
WorkItemLinkFilters: Use to restrict the types of links between work items in the current project.ExternalLinkFilters: Use to restrict the types of links that can be created between work items and other objects, such as changesets, hyperlinks, or version controlled files.WorkItemTypeFilters: Use to restrict the link relationships that users can create based on work item type and whether the work item is defined in the current project.
In each of these elements, you can specify Filter elements to specify the link types or work item types that you want to include or exclude. For more information about how to use these elements, see Define link controls to restrict link relationships.
The LinksControlOptions element is a child element of the CONTROL element.
Syntax
<LinksControlOptions>
<WorkItemLinkFilters FilterType="include | exclude | includeAll | excludeAll">
<Filter LinkType="linkTypeRefName" FilterOn="reversename | forwardname" />
</WorkItemLinkFilters>
<ExternalLinkFilters FilterType ="include | exclude | includeAll | excludeAll">
<Filter LinkType="externalLinkName"/>
</ExternalLinkFilters>
<WorkItemTypeFilters Scope=" project | all" FilterType=" include | exclude | includeAll" />
<Filter WorkItemType="workItemTypeReferenceName"/>
</WorkItemTypeFilters>
<LinkColumns>
<LinkColumn RefName="reference name" | LinkAttribute="link attribute name"/>
</LinkColumns>
</LinksControlOptions>
Attributes and elements
The following sections describe attributes, child elements, and parent elements.
Child elements and attributes
| Element | Attribute | Description |
|---|---|---|
LinksControlOptions |
Optional Control element when type="LinksControl".Provides a container for elements that define what links can be added to a work item and the default columns to appear for the list of link relationships in a work item. |
|
WorkItemLinkFilters |
Optional LinksControlOptions element.Provides a container for one or more Filter elements that specify the link filter criteria to use for link types that are defined for the project collection and that create relationships between work items. |
|
FilterType |
Required WorkItemLinkFilters attribute.Defines the method used to filter the set of link types provided in the set of Filter elements. Valid values that you can use are: - exclude: Use to disallow links to be created from those link types listed in the Filter elements.- excludeAll: Use to disallow all link types.- include: Use to allow only those link types listed in the Filter elements.- includeAll: Use to allow links to be created from all link types. |
|
Filter |
Required WorkItemLinkFilters element when the FilterType is exclude or include.When the FilterType is excludeAll or includeAll, no Filter elements should be specified.Specifies the types of links that are to be included or excluded from the set of links that can be created for the work item. |
|
LinkType |
Required Filter attribute.Specifies the reference name for a type of link. Valid types include the following system defined link types: - Storyboard- System.LinkTypes.Dependency - System.LinkTypes.Hierarchy - System.LinkTypes.Related In addition, you can specify the reference name for custom link types defined for the project collection. For more information, see LinkTypes. |
|
FilterOn |
Optional Filter attribute.Specifies the type of filter to apply to the link type. Valid values are: - forwardname: Use to filter on the forward name defined for a type of link.- reversename: Use to filter on the reverse name defined for a type of link.If unspecified, then both the forward and reverse names are used to filter the link type. Note: If the link type topology is Network, the forward and reverse names are the same. For more information, see LinkTypes. |
|
ExternalLinkFilters |
Optional LinksControlOptions element.Provides a container for one or more Filter elements that specify the link types that users can specify to create relationships to objects that are not work items, such as changesets, hyperlinks, and files under version control. |
|
FilterType |
Optional ExternalLinkFilters attribute.Defines the method that is used to filter the list of link types provided in the set of Filter elements.You can use the following values: - exclude: Use to disallow links to be created from those link types that appear in the Filter elements.- excludeAll: Use to disallow all link types.- include: Use to allow only those link types listed in the Filter elements.- includeAll: Use to allow links to be created from all link types.If unspecified, all links to external work items are excluded. |
|
Filter |
Required ExternalLinkFilters element when the FilterType is exclude or include.When the FilterType is excludeAll or includeAll, no Filter elements should be specified.Specifies the name of the link types that will be included or excluded from the set of links that users can create for the work item. |
|
LinkType |
Required Filter attribute.Specifies the reference name for a type of link to exclude or include. You can specify the following link types: - Fixed in Changeset - Result Attachment - Source Code File - Test Result - Workitem Hyperlink |
|
WorkItemTypeFilters |
Optional LinksControlOptions element.Provides a container for one or more Filter elements that specify the filter criteria to apply to work item types. |
|
Scope |
Optional WorkItemTypeFilters attribute.Defines the scope of the filter applied to the set of work item types provided in the set of Filter elements.Valid values that you can use are: - all: Use to allow links to be created to all work item types specified in the Filter tags.- project: Use to allow links to be created only to those work item types that are defined for the current project.If unspecified, links to all types of work items are allowed. |
|
FilterType |
Required WorkItemTypeFilters attribute.Defines the method that is used to filter the set of work item types provided in the set of Filter elements.You can use the following values: - exclude: Use to disallow the work item types in the Filter elements.- excludeAll: Use to disallow all work item types.- include: Use to allow the work item types in the Filter elements.- includeAll: Use to allow all work item types.If you do not specify any of these values, links to all work item types are allowed. |
|
Filter |
Optional WorkItemTypeFilters element when the FilterType is exclude or include.When the FilterType is excludeAll or includeAll, you should not specify any Filter elements.Specifies the types of work items that are to be included or excluded from the set of work item types that can be linked to. |
|
WorkItemType |
Required Filter attribute.Specifies the reference name of a work item type to be filtered. The attribute type is: typelib:NonEmptyPlainConstant.Minimum length: 1; maximum length: 255. Pattern value: ^[^\\]*$ Pattern value example: Task |
|
LinkColumns |
Optional LinksControlOptions element.Provides a container for one or more LinkColumn elements. |
|
LinkColumn |
Required LinkColumns element.Specifies the work item fields and link type attributes displayed for the list of links defined for a work item. This column list is the default display. The user can add and remove columns from the link list. The order in which the LinkColumn elements are listed defines the order in which the column fields are displayed in the work item form. |
|
RefName |
Optional LinkColumn attribute. Specify RefName or LinkAttribute, but not both.Specifies the reference name corresponding to a valid work item field for the project collection. The attribute type is typelib:ReferenceFieldName. |
|
LinkAttribute |
Optional LinkColumn attribute. Specify RefName or LinkAttribute, but not both.Specifies the reference name corresponding to any attribute for a valid link type for the project collection. The attribute type is typelib:ReferenceFieldName. |
Parent Elements
| Element | Description |
|---|---|
| Control | Required. Defines a field, text, hyperlink, or other control element to appear on the work item form. |
Remarks
LinksControlOptions is an optional child element of Control element where ControlType="LinksControl". You can use the LinksControlOptions element to support the following actions:
- Specify the restrictions that govern the creation of relationships to other work items based on the link type and, optionally, the forward and reverse names of the link types.
- Specify the restrictions that govern the creation of relationships to objects other than work items, such as changeset, hyperlink, and so on, based on external link types.
- Specify the restrictions that govern the creation of relationships to other work items based on work item type and, optionally, the project where those work items are defined.
- Specify the default column fields that you want to display information for the link list.
Example
The following example specifies how to enable the creation of links whose type is Microsoft.VSTS.Common.TestedBy and show the Forward Name for this link type. The filter options disallow creation of links to all external link types. In addition, displayed default column fields for the listed links correspond to the following friendly names: ID, Work Item Type, Title, Assigned To, State, and the Comment field defined for the link. For more examples, see Define link controls to restrict link relationships.
<Control Type="LinksControl" Name="TestedBy" Label="&Work items testing this bug:" LabelPosition="Top">
<LinksControlOptions>
<WorkItemLinkFilters FilterType="include">
<Filter LinkType="Microsoft.VSTS.Common.TestedBy" FilterOn="forwardname" />
</WorkItemLinkFilters>
<WorkItemTypeFilters FilterType="include">
<Filter WorkItemType="Test Case" />
</WorkItemTypeFilters>
<ExternalLinkFilters FilterType="excludeAll"/>
<LinkColumns>
<LinkColumn RefName="System.ID" />
<LinkColumn RefName="System.WorkItemType" />
<LinkColumn RefName="System.Title" />
<LinkColumn RefName="System.AssignedTo" />
<LinkColumn RefName="System.State" />
<LinkColumn LinkAttribute="System.Links.Comment" />
</LinkColumns>
</LinksControlOptions>
</Control>
LinksControl toolbar buttons
Each Control element of Type=LinksControl provides a toolbar, which contains the buttons shown in the next illustration:
These buttons become available only after you perform a specific action:
- The button to create a work item that is linked to the open work item (
) becomes available only after you save the open work item. - The buttons to open the list of work items in a query (
) and in a Microsoft Office client (
) become available only when at least one work item is listed in the links control tab. - The buttons to open a work item (
), edit a link (
), and delete a link (
) become available only after you click one or more work items listed in the links control tab.
The links control that is displayed is the same for both the web portal and Team Explorer, except when it is configured to only render Storyboard links. In that case, the toolbar only contains those controls to add a new link, open the linked item, and delete the link. Also, the web portal version displays the Start Storyboarding link within the control menu.
