Writing & StyleStyle guide

Choosing nameWithType and fullName in Microsoft Learn XRef Display Text

Choosing nameWithType and fullName in Microsoft Learn XRef Display Text records a distinct Microsoft Learn XRef authoring decision and consolidates tightly coupled syntax choices so the public guide stays useful without fragmenting one task into thin pages.

Quick answer

Use `displayProperty=nameWithType` when you need the documented fully qualified XRef display form; use `fullName` cautiously because member display text can become longer than intended.

Key details

Core Issuechoosing namewithtype and fullname in microsoft learn xref display text
RegisterMicrosoft Learn technical documentation

Important caveats

Scope Boundary

This page chooses between documented XRef display properties; it does not replace custom Markdown-style XRef link text when an author needs fully controlled wording.

Further guidance

Content

Microsoft Learn documents `displayProperty=nameWithType` and `fullName`; for classes they can behave similarly, while `fullName` on members can produce namespace-and-type-qualified member text.

Purpose

Keep Microsoft Learn API-reference links maintainable and predictable while following the current contributor-platform XRef conventions.

Sources and evidence

Sources are shown with the role they play in this guide. Historical or style-sensitive claims are kept within the evidence boundary described above.

  1. Use links in documentation — Contributor guide (opens in a new tab)Microsoft · Current Microsoft Learn contributor guidance for documentation links, including file-relative and site-relative paths, split-article YML targets, bookmarks, XRef API links, reference-style links, explicit-anchor boundaries, and secure link requirements.

Related guides

Writing & Style

Escaping Underscores in Microsoft Learn Image Alt Text

Escaping Underscores in Microsoft Learn Image Alt Text records a distinct Microsoft Learn authoring convention and keeps it scoped to that documentation environment rather than presenting it as a universal writing rule.

Writing & Style

Finding and Preserving Microsoft Learn XRef UIDs

Finding and Preserving Microsoft Learn XRef UIDs records a distinct Microsoft Learn XRef authoring decision and consolidates tightly coupled syntax choices so the public guide stays useful without fragmenting one task into thin pages.

Writing & Style

Linking to Microsoft Learn XRef Method Pages and Overloads

Linking to Microsoft Learn XRef Method Pages and Overloads records a distinct Microsoft Learn XRef authoring decision and consolidates tightly coupled syntax choices so the public guide stays useful without fragmenting one task into thin pages.

Writing & Style

Avoiding HTML Tables in Microsoft Learn Markdown

Avoiding HTML Tables in Microsoft Learn Markdown records a distinct Microsoft Learn authoring convention and keeps it scoped to that documentation environment rather than presenting it as a universal writing rule.

Writing & Style

Avoiding Inline HTML in Microsoft Learn

Avoiding Inline HTML in Microsoft Learn records a distinct Microsoft Learn authoring convention and keeps it scoped to that documentation environment rather than presenting it as a universal writing rule.

Writing & Style

Limiting Alerts in Microsoft Learn Articles

Limiting Alerts in Microsoft Learn Articles records a distinct Microsoft Learn authoring convention and keeps it scoped to that documentation environment rather than presenting it as a universal writing rule.

Writing & Style

Using Capitalized INCLUDE Syntax in Microsoft Learn

Using Capitalized INCLUDE Syntax in Microsoft Learn records a distinct Microsoft Learn authoring convention and keeps it scoped to that documentation environment rather than presenting it as a universal writing rule.

Explore the topic