updated comments with standard text

This commit is contained in:
Nikola Metulev 2017-10-10 22:43:33 -07:00
Родитель 1da6f19bae
Коммит d82f272d43
67 изменённых файлов: 301 добавлений и 239 удалений

Просмотреть файл

@ -26,7 +26,7 @@ namespace Microsoft.Toolkit.Services
public abstract class DataProviderBase<TConfig>
{
/// <summary>
/// Constructor
/// Initializes a new instance of the <see cref="DataProviderBase{TConfig}"/> class.
/// </summary>
public DataProviderBase()
{
@ -71,7 +71,7 @@ namespace Microsoft.Toolkit.Services
private static HttpClient httpClient;
/// <summary>
/// Static instance of HttpClient.
/// Gets or sets static instance of HttpClient.
/// </summary>
public static HttpClient HttpClient
{

Просмотреть файл

@ -60,7 +60,7 @@ namespace Microsoft.Toolkit.Uwp.DeveloperTools
private TextBlock controlFirstParentWithName;
/// <summary>
/// Gets or sets a boolean indicating whether the tracker is running or not.
/// Gets or sets a value indicating whether the tracker is running or not.
/// </summary>
public bool IsActive
{

Просмотреть файл

@ -22,7 +22,10 @@ namespace Microsoft.Toolkit.Uwp.Notifications
public sealed class AdaptiveGroup : ITileBindingContentAdaptiveChild, IAdaptiveChild, IToastBindingGenericChild
{
/// <summary>
/// The only valid children of groups are <see cref="AdaptiveSubgroup"/>. Each subgroup is displayed as a separate vertical column. Note that you must include at least one subgroup in your group, otherwise an <see cref="InvalidOperationException"/> will be thrown when you try to retrieve the XML for the notification.
/// Gets the only valid children of groups are <see cref="AdaptiveSubgroup"/>.
/// Each subgroup is displayed as a separate vertical column. Note that you must
/// include at least one subgroup in your group, otherwise an <see cref="InvalidOperationException"/>
/// will be thrown when you try to retrieve the XML for the notification.
/// </summary>
public IList<AdaptiveSubgroup> Children { get; private set; } = new List<AdaptiveSubgroup>();

Просмотреть файл

@ -25,24 +25,30 @@ namespace Microsoft.Toolkit.Uwp.Notifications
IAdaptiveSubgroupChild
{
/// <summary>
/// Control the desired cropping of the image. Supported on Tiles since RTM. Supported on Toast since Anniversary Update.
/// Gets or sets the desired cropping of the image.
/// Supported on Tiles since RTM. Supported on Toast since Anniversary Update.
/// </summary>
public AdaptiveImageCrop HintCrop { get; set; }
/// <summary>
/// By default, images have an 8px margin around them. You can remove this margin by setting this property to true. Supported on Tiles since RTM. Supported on Toast since Anniversary Update.
/// Gets or sets a value whether a margin is removed. images have an 8px margin around them.
/// You can remove this margin by setting this property to true.
/// Supported on Tiles since RTM. Supported on Toast since Anniversary Update.
/// </summary>
public bool? HintRemoveMargin { get; set; }
/// <summary>
/// The horizontal alignment of the image. For Toast, this is only supported when inside an <see cref="AdaptiveSubgroup"/>.
/// Gets or sets the horizontal alignment of the image.
/// For Toast, this is only supported when inside an <see cref="AdaptiveSubgroup"/>.
/// </summary>
public AdaptiveImageAlign HintAlign { get; set; }
private string _source;
/// <summary>
/// Required. The URI of the image. Can be from your application package, application data, or the internet. Internet images must be less than 200 KB in size.
/// Gets or sets the URI of the image (Required).
/// Can be from your application package, application data, or the internet.
/// Internet images must be less than 200 KB in size.
/// </summary>
public string Source
{
@ -51,12 +57,17 @@ namespace Microsoft.Toolkit.Uwp.Notifications
}
/// <summary>
/// A description of the image, for users of assistive technologies.
/// Gets or sets a description of the image, for users of assistive technologies.
/// </summary>
public string AlternateText { get; set; }
/// <summary>
/// Set to true to allow Windows to append a query string to the image URI supplied in the Tile notification. Use this attribute if your server hosts images and can handle query strings, either by retrieving an image variant based on the query strings or by ignoring the query string and returning the image as specified without the query string. This query string specifies scale, contrast setting, and language.
/// Gets or sets set to true to allow Windows to append a query string to the image URI
/// supplied in the Tile notification. Use this attribute if your server hosts
/// images and can handle query strings, either by retrieving an image variant based
/// on the query strings or by ignoring the query string and returning the image
/// as specified without the query string. This query string specifies scale,
/// contrast setting, and language.
/// </summary>
public bool? AddImageQuery { get; set; }

Просмотреть файл

@ -64,7 +64,7 @@ namespace Microsoft.Toolkit.Uwp.Notifications
ValueStringOverride { get; set; }
/// <summary>
/// Required. Gets or sets a status string, which is displayed underneath the progress bar. This string should reflect the status of the operation, like "Downloading..." or "Installing..."
/// Gets or sets a status string (Required), which is displayed underneath the progress bar. This string should reflect the status of the operation, like "Downloading..." or "Installing..."
/// </summary>
public
#if WINRT

Просмотреть файл

@ -25,12 +25,12 @@ namespace Microsoft.Toolkit.Uwp.Notifications
public double Value { get; set; }
/// <summary>
/// Gets or sets whether the progress bar is indeterminate.
/// Gets or sets a value indicating whether the progress bar is indeterminate.
/// </summary>
public bool IsIndeterminate { get; set; }
/// <summary>
/// Private constructor
/// Initializes a new instance of the <see cref="AdaptiveProgressBarValue"/> class.
/// </summary>
private AdaptiveProgressBarValue()
{
@ -47,7 +47,7 @@ namespace Microsoft.Toolkit.Uwp.Notifications
}
/// <summary>
/// Returns an indeterminate progress bar value.
/// Gets an indeterminate progress bar value.
/// </summary>
public static AdaptiveProgressBarValue Indeterminate
{

Просмотреть файл

@ -22,14 +22,14 @@ namespace Microsoft.Toolkit.Uwp.Notifications
public sealed class AdaptiveSubgroup
{
/// <summary>
/// <see cref="AdaptiveText"/> and <see cref="AdaptiveImage"/> are valid children of subgroups.
/// Gets a list of Children. <see cref="AdaptiveText"/> and <see cref="AdaptiveImage"/> are valid children of subgroups.
/// </summary>
public IList<IAdaptiveSubgroupChild> Children { get; private set; } = new List<IAdaptiveSubgroupChild>();
private int? _hintWeight;
/// <summary>
/// Control the width of this subgroup column by specifying the weight, relative to the other subgroups.
/// Gets or sets the width of this subgroup column by specifying the weight, relative to the other subgroups.
/// </summary>
public int? HintWeight
{
@ -47,7 +47,7 @@ namespace Microsoft.Toolkit.Uwp.Notifications
}
/// <summary>
/// Control the vertical alignment of this subgroup's content.
/// Gets or sets the vertical alignment of this subgroup's content.
/// </summary>
public AdaptiveSubgroupTextStacking HintTextStacking { get; set; } = Element_AdaptiveSubgroup.DEFAULT_TEXT_STACKING;

Просмотреть файл

@ -34,7 +34,8 @@ namespace Microsoft.Toolkit.Uwp.Notifications
#endif
/// <summary>
/// The text to display. Data binding support added in Creators Update, only works for toast top-level text elements.
/// Gets or sets the text to display. Data binding support added in Creators Update,
/// only works for toast top-level text elements.
/// </summary>
public
#if WINRT
@ -45,24 +46,35 @@ namespace Microsoft.Toolkit.Uwp.Notifications
Text { get; set; }
/// <summary>
/// The target locale of the XML payload, specified as a BCP-47 language tags such as "en-US" or "fr-FR". The locale specified here overrides any other specified locale, such as that in binding or visual. If this value is a literal string, this attribute defaults to the user's UI language. If this value is a string reference, this attribute defaults to the locale chosen by Windows Runtime in resolving the string.
/// Gets or sets the target locale of the XML payload, specified as a BCP-47 language tags
/// such as "en-US" or "fr-FR". The locale specified here overrides any other specified
/// locale, such as that in binding or visual. If this value is a literal string,
/// this attribute defaults to the user's UI language. If this value is a string reference,
/// this attribute defaults to the locale chosen by Windows Runtime in resolving the string.
/// </summary>
public string Language { get; set; }
/// <summary>
/// The style controls the text's font size, weight, and opacity. Note that for Toast, the style will only take effect if the text is inside an <see cref="AdaptiveSubgroup"/>.
/// Gets or sets the style that controls the text's font size, weight, and opacity.
/// Note that for Toast, the style will only take effect if the text is inside an <see cref="AdaptiveSubgroup"/>.
/// </summary>
public AdaptiveTextStyle HintStyle { get; set; }
/// <summary>
/// Set this to true to enable text wrapping. For Tiles, this is false by default. For Toasts, this is true on top-level text elements, and false inside an <see cref="AdaptiveSubgroup"/>. Note that for Toast, setting wrap will only take effect if the text is inside an <see cref="AdaptiveSubgroup"/> (you can use HintMaxLines = 1 to prevent top-level text elements from wrapping).
/// Gets or sets a value whether text wrapping is enabled. For Tiles, this is false by default.
/// For Toasts, this is true on top-level text elements, and false inside an <see cref="AdaptiveSubgroup"/>.
/// Note that for Toast, setting wrap will only take effect if the text is inside an
/// <see cref="AdaptiveSubgroup"/> (you can use HintMaxLines = 1 to prevent top-level text elements from wrapping).
/// </summary>
public bool? HintWrap { get; set; }
private int? _hintMaxLines;
/// <summary>
/// The maximum number of lines the text element is allowed to display. For Tiles, this is infinity by default. For Toasts, top-level text elements will have varying max line amounts (and in the Anniversary Update you can change the max lines). Text on a Toast inside an <see cref="AdaptiveSubgroup"/> will behave identically to Tiles (default to infinity).
/// Gets or sets the maximum number of lines the text element is allowed to display.
/// For Tiles, this is infinity by default. For Toasts, top-level text elements will
/// have varying max line amounts (and in the Anniversary Update you can change the max lines).
/// Text on a Toast inside an <see cref="AdaptiveSubgroup"/> will behave identically to Tiles (default to infinity).
/// </summary>
public int? HintMaxLines
{
@ -85,7 +97,8 @@ namespace Microsoft.Toolkit.Uwp.Notifications
private int? _hintMinLines;
/// <summary>
/// The minimum number of lines the text element must display. Note that for Toast, this property will only take effect if the text is inside an <see cref="AdaptiveSubgroup"/>.
/// Gets or sets the minimum number of lines the text element must display.
/// Note that for Toast, this property will only take effect if the text is inside an <see cref="AdaptiveSubgroup"/>.
/// </summary>
public int? HintMinLines
{
@ -106,7 +119,8 @@ namespace Microsoft.Toolkit.Uwp.Notifications
}
/// <summary>
/// The horizontal alignment of the text. Note that for Toast, this property will only take effect if the text is inside an <see cref="AdaptiveSubgroup"/>.
/// Gets or sets the horizontal alignment of the text. Note that for Toast, this property will
/// only take effect if the text is inside an <see cref="AdaptiveSubgroup"/>.
/// </summary>
public AdaptiveTextAlign HintAlign { get; set; }

Просмотреть файл

@ -21,7 +21,7 @@ namespace Microsoft.Toolkit.Uwp.Notifications
public sealed class BindableProgressBarValue
{
/// <summary>
/// Raw value is used for the implicit converter case, where dev provided a raw double. We store the raw value,
/// Gets raw value used for the implicit converter case, where dev provided a raw double. We store the raw value,
/// so that later on when generating the XML, we can provide this value rather than binding syntax.
/// </summary>
internal AdaptiveProgressBarValue RawValue { get; private set; }
@ -29,12 +29,13 @@ namespace Microsoft.Toolkit.Uwp.Notifications
internal bool RawIsIndeterminate { get; private set; }
/// <summary>
/// The name that maps to your binding data value.
/// Gets or sets the name that maps to your binding data value.
/// </summary>
public string BindingName { get; set; }
/// <summary>
/// Initializes a new binding for a double value, with the required binding value name. Do NOT include surrounding {} brackets.
/// Initializes a new instance of the <see cref="BindableProgressBarValue"/> class.
/// A new binding for a double value, with the required binding value name. Do NOT include surrounding {} brackets.
/// </summary>
/// <param name="bindingName">The name that maps to your binding data value.</param>
public BindableProgressBarValue(string bindingName)
@ -43,6 +44,7 @@ namespace Microsoft.Toolkit.Uwp.Notifications
}
/// <summary>
/// Initializes a new instance of the <see cref="BindableProgressBarValue"/> class.
/// Private constructor used by the implicit converter to assign the raw value.
/// </summary>
private BindableProgressBarValue()

Просмотреть файл

@ -23,12 +23,13 @@ namespace Microsoft.Toolkit.Uwp.Notifications
internal string RawValue { get; private set; }
/// <summary>
/// The name that maps to your binding data value.
/// Gets or sets the name that maps to your binding data value.
/// </summary>
public string BindingName { get; set; }
/// <summary>
/// Initializes a new binding for a string value, with the required binding name. Do NOT include surrounding {} brackets.
/// Initializes a new instance of the <see cref="BindableString"/> class.
/// A new binding for a string value, with the required binding name. Do NOT include surrounding {} brackets.
/// </summary>
/// <param name="bindingName">The name that maps to your data binding value.</param>
public BindableString(string bindingName)
@ -37,6 +38,7 @@ namespace Microsoft.Toolkit.Uwp.Notifications
}
/// <summary>
/// Initializes a new instance of the <see cref="BindableString"/> class.
/// Private constructor used by the implicit converter to assign the raw value.
/// </summary>
private BindableString()

Просмотреть файл

@ -18,17 +18,17 @@ namespace Microsoft.Toolkit.Uwp.Notifications
public interface IBaseImage
{
/// <summary>
/// The URI of the image. Can be from your application package, application data, or the internet. Internet images must be less than 200 KB in size.
/// Gets or sets the URI of the image. Can be from your application package, application data, or the internet. Internet images must be less than 200 KB in size.
/// </summary>
string Source { get; set; }
/// <summary>
/// A description of the image, for users of assistive technologies.
/// Gets or sets a description of the image, for users of assistive technologies.
/// </summary>
string AlternateText { get; set; }
/// <summary>
/// Set to true to allow Windows to append a query string to the image URI supplied in the Tile notification. Use this attribute if your server hosts images and can handle query strings, either by retrieving an image variant based on the query strings or by ignoring the query string and returning the image as specified without the query string. This query string specifies scale, contrast setting, and language.
/// Gets or sets a value whether Windows should append a query string to the image URI supplied in the Tile notification. Use this attribute if your server hosts images and can handle query strings, either by retrieving an image variant based on the query strings or by ignoring the query string and returning the image as specified without the query string. This query string specifies scale, contrast setting, and language.
/// </summary>
bool? AddImageQuery { get; set; }
}

Просмотреть файл

@ -18,12 +18,12 @@ namespace Microsoft.Toolkit.Uwp.Notifications
public interface IBaseText
{
/// <summary>
/// The text to display.
/// Gets or sets the text to display.
/// </summary>
string Text { get; set; }
/// <summary>
/// The target locale of the XML payload, specified as a BCP-47 language tags such as "en-US" or "fr-FR". The locale specified here overrides any other specified locale, such as that in binding or visual. If this value is a literal string, this attribute defaults to the user's UI language. If this value is a string reference, this attribute defaults to the locale chosen by Windows Runtime in resolving the string.
/// Gets or sets the target locale of the XML payload, specified as a BCP-47 language tags such as "en-US" or "fr-FR". The locale specified here overrides any other specified locale, such as that in binding or visual. If this value is a literal string, this attribute defaults to the user's UI language. If this value is a string reference, this attribute defaults to the locale chosen by Windows Runtime in resolving the string.
/// </summary>
string Language { get; set; }
}

Просмотреть файл

@ -23,6 +23,7 @@ namespace Microsoft.Toolkit.Uwp.Notifications
public sealed class BadgeGlyphContent : INotificationContent
{
/// <summary>
/// Initializes a new instance of the <see cref="BadgeGlyphContent"/> class.
/// Default constructor to create a glyph badge content object.
/// </summary>
public BadgeGlyphContent()
@ -30,6 +31,7 @@ namespace Microsoft.Toolkit.Uwp.Notifications
}
/// <summary>
/// Initializes a new instance of the <see cref="BadgeGlyphContent"/> class.
/// Constructor to create a glyph badge content object with a glyph.
/// </summary>
/// <param name="glyph">The glyph to be displayed on the badge.</param>
@ -39,7 +41,7 @@ namespace Microsoft.Toolkit.Uwp.Notifications
}
/// <summary>
/// The glyph to be displayed on the badge.
/// Gets or sets the glyph to be displayed on the badge.
/// </summary>
public BadgeGlyphValue Glyph
{

Просмотреть файл

@ -22,6 +22,7 @@ namespace Microsoft.Toolkit.Uwp.Notifications
public sealed class BadgeNumericContent : INotificationContent
{
/// <summary>
/// Initializes a new instance of the <see cref="BadgeNumericContent"/> class.
/// Default constructor to create a numeric badge content object.
/// </summary>
public BadgeNumericContent()
@ -29,6 +30,7 @@ namespace Microsoft.Toolkit.Uwp.Notifications
}
/// <summary>
/// Initializes a new instance of the <see cref="BadgeNumericContent"/> class.
/// Constructor to create a numeric badge content object with a number.
/// </summary>
/// <param name="number">
@ -41,7 +43,7 @@ namespace Microsoft.Toolkit.Uwp.Notifications
}
/// <summary>
/// The number that will appear on the badge. If the number is 0, the badge
/// Gets or sets the number that will appear on the badge. If the number is 0, the badge
/// will be removed.
/// </summary>
public uint Number

Просмотреть файл

@ -31,7 +31,7 @@ namespace Microsoft.Toolkit.Uwp.Notifications
public TileTemplateNameV3 Template { get; private set; }
/// <summary>
/// Set to true to allow Windows to append a query string to the image URI supplied in the Tile notification. Use this attribute if your server hosts images and can handle query strings, either by retrieving an image variant based on the query strings or by ignoring the query string and returning the image as specified without the query string. This query string specifies scale, contrast setting, and language; for instance, a value of
/// Gets or sets a value whether Windows should append a query string to the image URI supplied in the Tile notification. Use this attribute if your server hosts images and can handle query strings, either by retrieving an image variant based on the query strings or by ignoring the query string and returning the image as specified without the query string. This query string specifies scale, contrast setting, and language; for instance, a value of
///
/// "www.website.com/images/hello.png"
///
@ -43,19 +43,19 @@ namespace Microsoft.Toolkit.Uwp.Notifications
public bool? AddImageQuery { get; set; }
/// <summary>
/// A default base URI that is combined with relative URIs in image source attributes.
/// Gets or sets a default base URI that is combined with relative URIs in image source attributes.
/// </summary>
[NotificationXmlAttribute("baseUri")]
public Uri BaseUri { get; set; }
/// <summary>
/// The form that the Tile should use to display the app's brand.
/// Gets or sets the form that the Tile should use to display the app's brand.
/// </summary>
[NotificationXmlAttribute("branding", DEFAULT_BRANDING)]
public TileBranding Branding { get; set; } = DEFAULT_BRANDING;
/// <summary>
/// Set to a sender-defined string that uniquely identifies the content of the notification. This prevents duplicates in the situation where a large Tile template is displaying the last three wide Tile notifications.
/// Gets or sets a sender-defined string that uniquely identifies the content of the notification. This prevents duplicates in the situation where a large Tile template is displaying the last three wide Tile notifications.
///
/// Required: NO
/// </summary>
@ -63,13 +63,13 @@ namespace Microsoft.Toolkit.Uwp.Notifications
public string ContentId { get; set; }
/// <summary>
/// An optional string to override the Tile's display name while showing this notification.
/// Gets or sets an optional string to override the Tile's display name while showing this notification.
/// </summary>
[NotificationXmlAttribute("displayName")]
public string DisplayName { get; set; }
/// <summary>
/// The target locale of the XML payload, specified as a BCP-47 language tags such as "en-US" or "fr-FR". The locale specified here overrides that in visual, but can be overriden by that in text. If this value is a literal string, this attribute defaults to the user's UI language. If this value is a string reference, this attribute defaults to the locale chosen by Windows Runtime in resolving the string. See Remarks for when this value isn't specified.
/// Gets or sets the target locale of the XML payload, specified as a BCP-47 language tags such as "en-US" or "fr-FR". The locale specified here overrides that in visual, but can be overriden by that in text. If this value is a literal string, this attribute defaults to the user's UI language. If this value is a string reference, this attribute defaults to the locale chosen by Windows Runtime in resolving the string. See Remarks for when this value isn't specified.
/// </summary>
[NotificationXmlAttribute("lang")]
public string Language { get; set; }

Просмотреть файл

@ -18,12 +18,12 @@ namespace Microsoft.Toolkit.Uwp.Notifications
public sealed class TileBindingContentContact : ITileBindingContent
{
/// <summary>
/// The image to display.
/// Gets or sets the image to display.
/// </summary>
public TileBasicImage Image { get; set; }
/// <summary>
/// A line of text that is displayed. Not displayed on Small Tile.
/// Gets or sets a line of text that is displayed. Not displayed on Small Tile.
/// </summary>
public TileBasicText Text { get; set; }

Просмотреть файл

@ -20,7 +20,7 @@ namespace Microsoft.Toolkit.Uwp.Notifications
public sealed class TileBindingContentIconic : ITileBindingContent
{
/// <summary>
/// At minimum, to support both Desktop and Phone, Small and Medium tiles, provide a square aspect ratio image with a resolution of 200x200, PNG format, with transparency and no color other than white. For more info see: http://blogs.msdn.com/b/tiles_and_toasts/archive/2015/07/31/iconic-tile-template-for-windows-10.aspx
/// Gets or sets, at minimum, to support both Desktop and Phone, Small and Medium tiles, a square aspect ratio image with a resolution of 200x200, PNG format, with transparency and no color other than white. For more info see: http://blogs.msdn.com/b/tiles_and_toasts/archive/2015/07/31/iconic-tile-template-for-windows-10.aspx
/// </summary>
public TileBasicImage Icon { get; set; }

Просмотреть файл

@ -21,7 +21,7 @@ namespace Microsoft.Toolkit.Uwp.Notifications
public sealed class TileBindingContentPeople : ITileBindingContent
{
/// <summary>
/// Images that will roll around as circles.
/// Gets images that will roll around as circles.
/// </summary>
public IList<TileBasicImage> Images { get; private set; } = new List<TileBasicImage>();

Просмотреть файл

@ -20,7 +20,7 @@ namespace Microsoft.Toolkit.Uwp.Notifications
public sealed class TileBindingContentPhotos : ITileBindingContent
{
/// <summary>
/// Up to 12 images can be provided (Mobile will only display up to 9), which will be used for the slideshow. Adding more than 12 will throw an exception.
/// Gets the collection of slideshow images. Up to 12 images can be provided (Mobile will only display up to 9), which will be used for the slideshow. Adding more than 12 will throw an exception.
/// </summary>
public IList<TileBasicImage> Images { get; private set; } = new LimitedList<TileBasicImage>(12);

Просмотреть файл

@ -22,7 +22,7 @@ namespace Microsoft.Toolkit.Uwp.Notifications
private string _source;
/// <summary>
/// The URI of the image. Can be from your application package, application data, or the internet. Internet images must be less than 200 KB in size.
/// Gets or sets the URI of the image. Can be from your application package, application data, or the internet. Internet images must be less than 200 KB in size.
/// </summary>
public string Source
{
@ -31,19 +31,19 @@ namespace Microsoft.Toolkit.Uwp.Notifications
}
/// <summary>
/// A description of the image, for users of assistive technologies.
/// Gets or sets a description of the image, for users of assistive technologies.
/// </summary>
public string AlternateText { get; set; }
/// <summary>
/// Set to true to allow Windows to append a query string to the image URI supplied in the Tile notification. Use this attribute if your server hosts images and can handle query strings, either by retrieving an image variant based on the query strings or by ignoring the query string and returning the image as specified without the query string. This query string specifies scale, contrast setting, and language.
/// Gets or sets a value whether Windows should append a query string to the image URI supplied in the Tile notification. Use this attribute if your server hosts images and can handle query strings, either by retrieving an image variant based on the query strings or by ignoring the query string and returning the image as specified without the query string. This query string specifies scale, contrast setting, and language.
/// </summary>
public bool? AddImageQuery { get; set; }
private int? _hintOverlay;
/// <summary>
/// A black overlay on the background image. This value controls the opacity of the black overlay, with 0 being no overlay and 100 being completely black. Defaults to 20.
/// Gets or sets a black overlay on the background image. This value controls the opacity of the black overlay, with 0 being no overlay and 100 being completely black. Defaults to 20.
/// </summary>
public int? HintOverlay
{
@ -64,7 +64,7 @@ namespace Microsoft.Toolkit.Uwp.Notifications
}
/// <summary>
/// New in 1511: Control the desired cropping of the image.
/// Gets or sets the desired cropping of the image.
/// Previously for RTM: Did not exist, value will be ignored and background image will be displayed without any cropping.
/// </summary>
public TileBackgroundImageCrop HintCrop { get; set; }

Просмотреть файл

@ -22,7 +22,7 @@ namespace Microsoft.Toolkit.Uwp.Notifications
private string _source;
/// <summary>
/// The URI of the image. Can be from your application package, application data, or the internet. Internet images must be less than 200 KB in size.
/// Gets or sets the URI of the image. Can be from your application package, application data, or the internet. Internet images must be less than 200 KB in size.
/// </summary>
public string Source
{
@ -31,12 +31,12 @@ namespace Microsoft.Toolkit.Uwp.Notifications
}
/// <summary>
/// A description of the image, for users of assistive technologies.
/// Gets or sets a description of the image, for users of assistive technologies.
/// </summary>
public string AlternateText { get; set; }
/// <summary>
/// Set to true to allow Windows to append a query string to the image URI supplied in the Tile notification. Use this attribute if your server hosts images and can handle query strings, either by retrieving an image variant based on the query strings or by ignoring the query string and returning the image as specified without the query string. This query string specifies scale, contrast setting, and language.
/// Gets or sets a value whether Windows should append a query string to the image URI supplied in the Tile notification. Use this attribute if your server hosts images and can handle query strings, either by retrieving an image variant based on the query strings or by ignoring the query string and returning the image as specified without the query string. This query string specifies scale, contrast setting, and language.
/// </summary>
public bool? AddImageQuery { get; set; }

Просмотреть файл

@ -20,12 +20,12 @@ namespace Microsoft.Toolkit.Uwp.Notifications
public sealed class TileBasicText
{
/// <summary>
/// The text value that will be shown in the text field.
/// Gets or sets the text value that will be shown in the text field.
/// </summary>
public string Text { get; set; }
/// <summary>
/// The target locale of the XML payload, specified as a BCP-47 language tags such as "en-US" or "fr-FR". The locale specified here overrides any other specified locale, such as that in binding or visual. If this value is a literal string, this attribute defaults to the user's UI language. If this value is a string reference, this attribute defaults to the locale chosen by Windows Runtime in resolving the string.
/// Gets or sets the target locale of the XML payload, specified as a BCP-47 language tags such as "en-US" or "fr-FR". The locale specified here overrides any other specified locale, such as that in binding or visual. If this value is a literal string, this attribute defaults to the user's UI language. If this value is a string reference, this attribute defaults to the locale chosen by Windows Runtime in resolving the string.
/// </summary>
public string Lang { get; set; }

Просмотреть файл

@ -20,22 +20,22 @@ namespace Microsoft.Toolkit.Uwp.Notifications
public sealed class TileBinding
{
/// <summary>
/// The target locale of the XML payload, specified as a BCP-47 language tags such as "en-US" or "fr-FR". The locale specified here overrides that in visual, but can be overriden by that in text. If this value is a literal string, this attribute defaults to the user's UI language. If this value is a string reference, this attribute defaults to the locale chosen by Windows Runtime in resolving the string. See Remarks for when this value isn't specified.
/// Gets or sets the target locale of the XML payload, specified as a BCP-47 language tags such as "en-US" or "fr-FR". The locale specified here overrides that in visual, but can be overriden by that in text. If this value is a literal string, this attribute defaults to the user's UI language. If this value is a string reference, this attribute defaults to the locale chosen by Windows Runtime in resolving the string. See Remarks for when this value isn't specified.
/// </summary>
public string Language { get; set; }
/// <summary>
/// A default base URI that is combined with relative URIs in image source attributes. Defaults to null.
/// Gets or sets a default base URI that is combined with relative URIs in image source attributes. Defaults to null.
/// </summary>
public Uri BaseUri { get; set; }
/// <summary>
/// The form that the Tile should use to display the app's brand..
/// Gets or sets the form that the Tile should use to display the app's brand..
/// </summary>
public TileBranding Branding { get; set; } = Element_TileBinding.DEFAULT_BRANDING;
/// <summary>
/// Defaults to false. Set to true to allow Windows to append a query string to the image URI supplied in the Tile notification. Use this attribute if your server hosts images and can handle query strings, either by retrieving an image variant based on the query strings or by ignoring the query string and returning the image as specified without the query string. This query string specifies scale, contrast setting, and language; for instance, a value of
/// Gets or sets a value whether Windows is allowed to append a query string to the image URI supplied in the Tile notification. Use this attribute if your server hosts images and can handle query strings, either by retrieving an image variant based on the query strings or by ignoring the query string and returning the image as specified without the query string. This query string specifies scale, contrast setting, and language; for instance, a value of
///
/// "www.website.com/images/hello.png"
///
@ -46,22 +46,25 @@ namespace Microsoft.Toolkit.Uwp.Notifications
public bool? AddImageQuery { get; set; }
/// <summary>
/// Set to a sender-defined string that uniquely identifies the content of the notification. This prevents duplicates in the situation where a large Tile template is displaying the last three wide Tile notifications.
/// Gets or sets a sender-defined string that uniquely identifies the content of the notification. This prevents duplicates in the situation where a large Tile template is displaying the last three wide Tile notifications.
/// </summary>
public string ContentId { get; set; }
/// <summary>
/// An optional string to override the Tile's display name while showing this notification.
/// Gets or sets an optional string to override the Tile's display name while showing this notification.
/// </summary>
public string DisplayName { get; set; }
/// <summary>
/// New in Anniversary Update: App-defined data that is passed back to your app via the TileActivatedInfo property on LaunchActivatedEventArgs when the user launches your app from the Live Tile. This allows you to know which Tile notifications your user saw when they tapped your Live Tile. On devices without the Anniversary Update, this will simply be ignored.
/// Gets or sets an app-defined data that is passed back to your app via the TileActivatedInfo property on
/// LaunchActivatedEventArgs when the user launches your app from the Live Tile. This allows you to know
/// which Tile notifications your user saw when they tapped your Live Tile. On devices without the Anniversary Update,
/// this will simply be ignored.
/// </summary>
public string Arguments { get; set; }
/// <summary>
/// The actual content to be displayed. One of <see cref="TileBindingContentAdaptive"/>, <see cref="TileBindingContentIconic"/>, <see cref="TileBindingContentContact"/>, <see cref="TileBindingContentPeople"/>, or <see cref="TileBindingContentPhotos"/>
/// Gets or sets the actual content to be displayed. One of <see cref="TileBindingContentAdaptive"/>, <see cref="TileBindingContentIconic"/>, <see cref="TileBindingContentContact"/>, <see cref="TileBindingContentPeople"/>, or <see cref="TileBindingContentPhotos"/>
/// </summary>
public ITileBindingContent Content { get; set; }

Просмотреть файл

@ -21,22 +21,22 @@ namespace Microsoft.Toolkit.Uwp.Notifications
public sealed class TileBindingContentAdaptive : ITileBindingContent
{
/// <summary>
/// <see cref="AdaptiveText"/>, <see cref="AdaptiveImage"/>, and <see cref="AdaptiveGroup"/> objects can be added as children. The children are displayed in a vertical StackPanel fashion.
/// Gets <see cref="AdaptiveText"/>, <see cref="AdaptiveImage"/>, and <see cref="AdaptiveGroup"/> objects that can be added as children. The children are displayed in a vertical StackPanel fashion.
/// </summary>
public IList<ITileBindingContentAdaptiveChild> Children { get; private set; } = new List<ITileBindingContentAdaptiveChild>();
/// <summary>
/// An optional background image that gets displayed behind all the Tile content, full bleed.
/// Gets or sets an optional background image that gets displayed behind all the Tile content, full bleed.
/// </summary>
public TileBackgroundImage BackgroundImage { get; set; }
/// <summary>
/// An optional peek image that animates in from the top of the Tile.
/// Gets or sets an optional peek image that animates in from the top of the Tile.
/// </summary>
public TilePeekImage PeekImage { get; set; }
/// <summary>
/// Controls the text stacking (vertical alignment) of the entire binding element.
/// Gets or sets the text stacking (vertical alignment) of the entire binding element.
/// </summary>
public TileTextStacking TextStacking { get; set; } = Element_TileBinding.DEFAULT_TEXT_STACKING;

Просмотреть файл

@ -23,7 +23,7 @@ namespace Microsoft.Toolkit.Uwp.Notifications
public sealed class TileContent
{
/// <summary>
/// The visual element is required.
/// Gets or sets the visual element. Required.
/// </summary>
public TileVisual Visual { get; set; }

Просмотреть файл

@ -22,7 +22,7 @@ namespace Microsoft.Toolkit.Uwp.Notifications
private string _source;
/// <summary>
/// The URI of the image. Can be from your application package, application data, or the internet. Internet images must be less than 200 KB in size.
/// Gets or sets the URI of the image. Can be from your application package, application data, or the internet. Internet images must be less than 200 KB in size.
/// </summary>
public string Source
{
@ -31,19 +31,19 @@ namespace Microsoft.Toolkit.Uwp.Notifications
}
/// <summary>
/// A description of the image, for users of assistive technologies.
/// Gets or sets a description of the image, for users of assistive technologies.
/// </summary>
public string AlternateText { get; set; }
/// <summary>
/// Set to true to allow Windows to append a query string to the image URI supplied in the Tile notification. Use this attribute if your server hosts images and can handle query strings, either by retrieving an image variant based on the query strings or by ignoring the query string and returning the image as specified without the query string. This query string specifies scale, contrast setting, and language.
/// Gets or sets set a value whether Windows is allowed to append a query string to the image URI supplied in the Tile notification. Use this attribute if your server hosts images and can handle query strings, either by retrieving an image variant based on the query strings or by ignoring the query string and returning the image as specified without the query string. This query string specifies scale, contrast setting, and language.
/// </summary>
public bool? AddImageQuery { get; set; }
private int? _hintOverlay;
/// <summary>
/// New in 1511: A black overlay on the peek image. This value controls the opacity of the black overlay, with 0 being no overlay and 100 being completely black. Defaults to 0.
/// Gets or sets a black overlay on the peek image. This value controls the opacity of the black overlay, with 0 being no overlay and 100 being completely black. Defaults to 0.
/// Previously for RTM: Did not exist, value will be ignored and peek image will be displayed with 0 overlay.
/// </summary>
public int? HintOverlay
@ -65,7 +65,7 @@ namespace Microsoft.Toolkit.Uwp.Notifications
}
/// <summary>
/// New in 1511: Control the desired cropping of the image.
/// Gets or sets the desired cropping of the image.
/// Previously for RTM: Did not exist, value will be ignored and peek image will be displayed without any cropping.
/// </summary>
public TilePeekImageCrop HintCrop { get; set; }

Просмотреть файл

@ -22,22 +22,22 @@ namespace Microsoft.Toolkit.Uwp.Notifications
public sealed class TileVisual
{
/// <summary>
/// The target locale of the XML payload, specified as a BCP-47 language tags such as "en-US" or "fr-FR". This locale is overridden by any locale specified in binding or text. If this value is a literal string, this attribute defaults to the user's UI language. If this value is a string reference, this attribute defaults to the locale chosen by Windows Runtime in resolving the string.
/// Gets or sets the target locale of the XML payload, specified as a BCP-47 language tags such as "en-US" or "fr-FR". This locale is overridden by any locale specified in binding or text. If this value is a literal string, this attribute defaults to the user's UI language. If this value is a string reference, this attribute defaults to the locale chosen by Windows Runtime in resolving the string.
/// </summary>
public string Language { get; set; }
/// <summary>
/// A default base URI that is combined with relative URIs in image source attributes.
/// Gets or sets a default base URI that is combined with relative URIs in image source attributes.
/// </summary>
public Uri BaseUri { get; set; }
/// <summary>
/// The form that the Tile should use to display the app's brand.
/// Gets or sets the form that the Tile should use to display the app's brand.
/// </summary>
public TileBranding Branding { get; set; } = Element_TileVisual.DEFAULT_BRANDING;
/// <summary>
/// Defaults to false. Set to true to allow Windows to append a query string to the image URI supplied in the Tile notification. Use this attribute if your server hosts images and can handle query strings, either by retrieving an image variant based on the query strings or by ignoring the query string and returning the image as specified without the query string. This query string specifies scale, contrast setting, and language; for instance, a value of
/// Gets or sets a value whether Windows is allowed to append a query string to the image URI supplied in the Tile notification. Use this attribute if your server hosts images and can handle query strings, either by retrieving an image variant based on the query strings or by ignoring the query string and returning the image as specified without the query string. This query string specifies scale, contrast setting, and language; for instance, a value of
///
/// "www.website.com/images/hello.png"
///
@ -48,52 +48,55 @@ namespace Microsoft.Toolkit.Uwp.Notifications
public bool? AddImageQuery { get; set; }
/// <summary>
/// Set to a sender-defined string that uniquely identifies the content of the notification. This prevents duplicates in the situation where a large Tile template is displaying the last three wide Tile notifications.
/// Gets or sets a sender-defined string that uniquely identifies the content of the notification. This prevents duplicates in the situation where a large Tile template is displaying the last three wide Tile notifications.
/// </summary>
public string ContentId { get; set; }
/// <summary>
/// An optional string to override the Tile's display name while showing this notification.
/// Gets or sets an optional string to override the Tile's display name while showing this notification.
/// </summary>
public string DisplayName { get; set; }
/// <summary>
/// If you specify this, you must also provide a Wide Tile binding. This is the first line of text that will be displayed on the lock screen if the user has selected your Tile as their detailed status app.
/// Gets or sets the first line of text that will be displayed on the lock screen if the user has selected
/// your Tile as their detailed status app. Ff you specify this, you must also provide a Wide Tile binding.
/// </summary>
public string LockDetailedStatus1 { get; set; }
/// <summary>
/// If you specify this, you must also provide a Wide Tile binding. This is the second line of text that will be displayed on the lock screen if the user has selected your Tile as their detailed status app.
/// Gets or sets the second line of text that will be displayed on the lock screen if the user has selected
/// your Tile as their detailed status app. If you specify this, you must also provide a Wide Tile binding.
/// </summary>
public string LockDetailedStatus2 { get; set; }
/// <summary>
/// If you specify this, you must also provide a Wide Tile binding. This is the third line of text that will be displayed on the lock screen if the user has selected your Tile as their detailed status app.
/// Gets or sets the third line of text that will be displayed on the lock screen if the user has selected your
/// Tile as their detailed status app. If you specify this, you must also provide a Wide Tile binding.
/// </summary>
public string LockDetailedStatus3 { get; set; }
/// <summary>
/// New in Anniversary Update: App-defined data that is passed back to your app via the TileActivatedInfo property on LaunchActivatedEventArgs when the user launches your app from the Live Tile. This allows you to know which Tile notifications your user saw when they tapped your Live Tile. On devices without the Anniversary Update, this will simply be ignored.
/// Gets or sets app-defined data that is passed back to your app via the TileActivatedInfo property on LaunchActivatedEventArgs when the user launches your app from the Live Tile. This allows you to know which Tile notifications your user saw when they tapped your Live Tile. On devices without the Anniversary Update, this will simply be ignored.
/// </summary>
public string Arguments { get; set; }
/// <summary>
/// Provide an optional small binding to specify content for the small Tile size.
/// Gets or sets an optional small binding to specify content for the small Tile size.
/// </summary>
public TileBinding TileSmall { get; set; }
/// <summary>
/// Provide an optional medium binding to specify content for the medium Tile size.
/// Gets or sets an optional medium binding to specify content for the medium Tile size.
/// </summary>
public TileBinding TileMedium { get; set; }
/// <summary>
/// Provide an optional wide binding to specify content for the wide Tile size.
/// Gets or sets an optional wide binding to specify content for the wide Tile size.
/// </summary>
public TileBinding TileWide { get; set; }
/// <summary>
/// Desktop-only. Provide an optional large binding to specify content for the large Tile size.
/// Gets or sets an optional large binding to specify content for the large Tile size. Desktop-only
/// </summary>
public TileBinding TileLarge { get; set; }

Просмотреть файл

@ -20,13 +20,13 @@ namespace Microsoft.Toolkit.Uwp.Notifications
internal const Element_ToastActionPlacement DEFAULT_PLACEMENT = Element_ToastActionPlacement.Inline;
/// <summary>
/// The text to be displayed on the button.
/// Gets or sets the text to be displayed on the button.
/// </summary>
[NotificationXmlAttribute("content")]
public string Content { get; set; }
/// <summary>
/// The arguments attribute describes the app-defined data that the app can later retrieve once it is activated from user taking this action.
/// Gets or sets the arguments attribute describing the app-defined data that the app can later retrieve once it is activated from user taking this action.
/// </summary>
[NotificationXmlAttribute("arguments")]
public string Arguments { get; set; }
@ -41,13 +41,13 @@ namespace Microsoft.Toolkit.Uwp.Notifications
public ToastAfterActivationBehavior AfterActivationBehavior { get; set; } = DEFAULT_AFTER_ACTIVATION_BEHAVIOR;
/// <summary>
/// imageUri is optional and is used to provide an image icon for this action to display inside the button alone with the text content.
/// Gets or sets optional value to provide an image icon for this action to display inside the button alone with the text content.
/// </summary>
[NotificationXmlAttribute("imageUri")]
public string ImageUri { get; set; }
/// <summary>
/// This is specifically used for the quick reply scenario.
/// Gets or sets value used for the quick reply scenario.
/// </summary>
[NotificationXmlAttribute("hint-inputId")]
public string InputId { get; set; }

Просмотреть файл

@ -21,7 +21,7 @@ namespace Microsoft.Toolkit.Uwp.Notifications
internal const bool DEFAULT_SILENT = false;
/// <summary>
/// The media file to play in place of the default sound. This can either be a ms-winsoundevent value, or a custom ms-appx:/// or ms-appdata:/// file, or null for the default sound.
/// Gets or sets the media file to play in place of the default sound. This can either be a ms-winsoundevent value, or a custom ms-appx:/// or ms-appdata:/// file, or null for the default sound.
/// </summary>
[NotificationXmlAttribute("src")]
public Uri Src { get; set; }
@ -30,7 +30,7 @@ namespace Microsoft.Toolkit.Uwp.Notifications
public bool Loop { get; set; } = DEFAULT_LOOP;
/// <summary>
/// True to mute the sound; false to allow the Toast notification sound to play.
/// Gets or sets a value indicating whether the sound is muted; false to allow the Toast notification sound to play.
/// </summary>
[NotificationXmlAttribute("silent", DEFAULT_SILENT)]
public bool Silent { get; set; } = DEFAULT_SILENT;

Просмотреть файл

@ -27,7 +27,7 @@ namespace Microsoft.Toolkit.Uwp.Notifications
public ToastTemplateType Template { get; private set; }
/// <summary>
/// Set to true to allow Windows to append a query string to the image URI supplied in the Tile notification. Use this attribute if your server hosts images and can handle query strings, either by retrieving an image variant based on the query strings or by ignoring the query string and returning the image as specified without the query string. This query string specifies scale, contrast setting, and language; for instance, a value of
/// Gets or sets a value whether Windows should append a query string to the image URI supplied in the Tile notification. Use this attribute if your server hosts images and can handle query strings, either by retrieving an image variant based on the query strings or by ignoring the query string and returning the image as specified without the query string. This query string specifies scale, contrast setting, and language; for instance, a value of
///
/// "www.website.com/images/hello.png"
///
@ -39,13 +39,13 @@ namespace Microsoft.Toolkit.Uwp.Notifications
public bool? AddImageQuery { get; set; }
/// <summary>
/// A default base URI that is combined with relative URIs in image source attributes.
/// Gets or sets a default base URI that is combined with relative URIs in image source attributes.
/// </summary>
[NotificationXmlAttribute("baseUri")]
public Uri BaseUri { get; set; }
/// <summary>
/// The target locale of the XML payload, specified as a BCP-47 language tags such as "en-US" or "fr-FR". The locale specified here overrides that in visual, but can be overriden by that in text. If this value is a literal string, this attribute defaults to the user's UI language. If this value is a string reference, this attribute defaults to the locale chosen by Windows Runtime in resolving the string. See Remarks for when this value isn't specified.
/// Gets or sets the target locale of the XML payload, specified as a BCP-47 language tags such as "en-US" or "fr-FR". The locale specified here overrides that in visual, but can be overriden by that in text. If this value is a literal string, this attribute defaults to the user's UI language. If this value is a string reference, this attribute defaults to the locale chosen by Windows Runtime in resolving the string. See Remarks for when this value isn't specified.
/// </summary>
[NotificationXmlAttribute("lang")]
public string Language { get; set; }

Просмотреть файл

@ -18,7 +18,7 @@ namespace Microsoft.Toolkit.Uwp.Notifications
internal sealed class Element_ToastInput : IElement_ToastActionsChild
{
/// <summary>
/// The id attribute is required and is for developers to retrieve user inputs once the app is activated (in the foreground or background).
/// Gets or sets the required attributes for developers to retrieve user inputs once the app is activated (in the foreground or background).
/// </summary>
[NotificationXmlAttribute("id")]
public string Id { get; set; }
@ -27,19 +27,19 @@ namespace Microsoft.Toolkit.Uwp.Notifications
public ToastInputType Type { get; set; }
/// <summary>
/// The title attribute is optional and is for developers to specify a title for the input for shells to render when there is affordance.
/// Gets or sets the optional title attribute and is for developers to specify a title for the input for shells to render when there is affordance.
/// </summary>
[NotificationXmlAttribute("title")]
public string Title { get; set; }
/// <summary>
/// The placeholderContent attribute is optional and is the grey-out hint text for text input type. This attribute is ignored when the input type is not <20>text<78>.
/// Gets or sets the optional placeholderContent attribute and is the grey-out hint text for text input type. This attribute is ignored when the input type is not <20>text<78>.
/// </summary>
[NotificationXmlAttribute("placeHolderContent")]
public string PlaceholderContent { get; set; }
/// <summary>
/// The defaultInput attribute is optional and it allows developer to provide a default input value.
/// Gets or sets the optional defaultInput attribute and it allows developer to provide a default input value.
/// </summary>
[NotificationXmlAttribute("defaultInput")]
public string DefaultInput { get; set; }

Просмотреть файл

@ -16,13 +16,13 @@ namespace Microsoft.Toolkit.Uwp.Notifications
internal sealed class Element_ToastSelection : IElement_ToastInputChild
{
/// <summary>
/// The id attribute is required and it is for apps to retrieve back the user selected input after the app is activated.
/// Gets or sets the id attribute for apps to retrieve back the user selected input after the app is activated. Required
/// </summary>
[NotificationXmlAttribute("id")]
public string Id { get; set; }
/// <summary>
/// The text to display for this selection element.
/// Gets or sets the text to display for this selection element.
/// </summary>
[NotificationXmlAttribute("content")]
public string Content { get; set; }

Просмотреть файл

@ -20,7 +20,7 @@ namespace Microsoft.Toolkit.Uwp.Notifications
public interface IToastActions
{
/// <summary>
/// New in Anniversary Update: Custom context menu items, providing additional actions when the user right clicks the Toast notification.
/// Gets custom context menu items, providing additional actions when the user right clicks the Toast notification. New in Anniversary Update
/// </summary>
IList<ToastContextMenuItem> ContextMenuItems { get; }
}

Просмотреть файл

@ -21,17 +21,19 @@ namespace Microsoft.Toolkit.Uwp.Notifications
public sealed class ToastActionsCustom : IToastActions
{
/// <summary>
/// Inputs like <see cref="ToastTextBox"/> and <see cref="ToastSelectionBox"/> can be added to the Toast. Only up to 5 inputs can be added; after that, an exception is thrown.
/// Gets inputs like <see cref="ToastTextBox"/> and <see cref="ToastSelectionBox"/>. Only up to 5 inputs can be added; after that, an exception is thrown.
/// </summary>
public IList<IToastInput> Inputs { get; private set; } = new LimitedList<IToastInput>(5);
/// <summary>
/// Buttons are displayed after all the inputs (or adjacent to inputs if used as quick reply buttons). Only up to 5 buttons can be added (or fewer if you are also including context menu items). After that, an exception is thrown. You can add <see cref="ToastButton"/>, <see cref="ToastButtonSnooze"/>, or <see cref="ToastButtonDismiss"/>
/// Gets buttons displayed after all the inputs (or adjacent to inputs if used as quick reply buttons). Only up to 5 buttons can be added (or fewer if you are also including context menu items). After that, an exception is thrown. You can add <see cref="ToastButton"/>, <see cref="ToastButtonSnooze"/>, or <see cref="ToastButtonDismiss"/>
/// </summary>
public IList<IToastButton> Buttons { get; private set; } = new LimitedList<IToastButton>(5);
/// <summary>
/// New in Anniversary Update: Custom context menu items, providing additional actions when the user right clicks the Toast notification. You can only have up to 5 buttons and context menu items *combined*. Thus, if you have one context menu item, you can only have four buttons, etc.
/// Gets custom context menu items, providing additional actions when the user right clicks the Toast notification.
/// You can only have up to 5 buttons and context menu items *combined*. Thus, if you have one context menu item,
/// you can only have four buttons, etc. New in Anniversary Update:
/// </summary>
public IList<ToastContextMenuItem> ContextMenuItems { get; private set; } = new List<ToastContextMenuItem>();

Просмотреть файл

@ -21,7 +21,8 @@ namespace Microsoft.Toolkit.Uwp.Notifications
public sealed class ToastActionsSnoozeAndDismiss : IToastActions
{
/// <summary>
/// New in Anniversary Update: Custom context menu items, providing additional actions when the user right clicks the Toast notification. You can only have up to 5 items.
/// Gets custom context menu items, providing additional actions when the user right clicks the Toast notification.
/// You can only have up to 5 items. New in Anniversary Update
/// </summary>
public IList<ToastContextMenuItem> ContextMenuItems { get; private set; } = new List<ToastContextMenuItem>();

Просмотреть файл

@ -20,12 +20,14 @@ namespace Microsoft.Toolkit.Uwp.Notifications
public sealed class ToastActivationOptions
{
/// <summary>
/// If you are using <see cref="ToastActivationType.Protocol"/>, you can optionally specify the target PFN, so that regardless of whether multiple apps are registered to handle the same protocol uri, your desired app will always be launched.
/// Gets or sets the target PFN if you are using <see cref="ToastActivationType.Protocol"/>. You can optionally specify, so that regardless of whether multiple apps are registered to handle the same protocol uri, your desired app will always be launched.
/// </summary>
public string ProtocolActivationTargetApplicationPfn { get; set; }
/// <summary>
/// New in Fall Creators Update: Specifies the behavior that the toast should use when the user invokes this action. Note that this option only works on <see cref="ToastButton"/> and <see cref="ToastContextMenuItem"/>. Desktop-only, supported in builds 16251 or higher.
/// Gets or sets the behavior that the toast should use when the user invokes this action.
/// Note that this option only works on <see cref="ToastButton"/> and <see cref="ToastContextMenuItem"/>.
/// Desktop-only, supported in builds 16251 or higher. New in Fall Creators Update
/// </summary>
public ToastAfterActivationBehavior AfterActivationBehavior { get; set; } = ToastAfterActivationBehavior.Default;

Просмотреть файл

@ -20,17 +20,17 @@ namespace Microsoft.Toolkit.Uwp.Notifications
public sealed class ToastAudio
{
/// <summary>
/// The media file to play in place of the default sound.
/// Gets or sets the media file to play in place of the default sound.
/// </summary>
public Uri Src { get; set; }
/// <summary>
/// Set to true if the sound should repeat as long as the Toast is shown; false to play only once (default).
/// Gets or sets a value indicating whether sound should repeat as long as the Toast is shown; false to play only once (default).
/// </summary>
public bool Loop { get; set; } = Element_ToastAudio.DEFAULT_LOOP;
/// <summary>
/// True to mute the sound; false to allow the Toast notification sound to play (default).
/// Gets or sets a value indicating whether sound is muted; false to allow the Toast notification sound to play (default).
/// </summary>
public bool Silent { get; set; } = Element_ToastAudio.DEFAULT_SILENT;

Просмотреть файл

@ -22,37 +22,48 @@ namespace Microsoft.Toolkit.Uwp.Notifications
public sealed class ToastBindingGeneric
{
/// <summary>
/// The contents of the body of the Toast, which can include <see cref="AdaptiveText"/>, <see cref="AdaptiveImage"/>, and <see cref="AdaptiveGroup"/> (added in Anniversary Update). Also, <see cref="AdaptiveText"/> elements must come before any other elements. If an <see cref="AdaptiveText"/> element is placed after any other element, an exception will be thrown when you try to retrieve the Toast XML content. And finally, certain <see cref="AdaptiveText"/> properties like HintStyle aren't supported on the root children text elements, and only work inside an <see cref="AdaptiveGroup"/>. If you use <see cref="AdaptiveGroup"/> on devices without the Anniversary Update, the group content will simply be dropped.
/// Gets the contents of the body of the Toast, which can include <see cref="AdaptiveText"/>, <see cref="AdaptiveImage"/>,
/// and <see cref="AdaptiveGroup"/> (added in Anniversary Update). Also, <see cref="AdaptiveText"/> elements must come
/// before any other elements. If an <see cref="AdaptiveText"/> element is placed after any other element, an exception
/// will be thrown when you try to retrieve the Toast XML content. And finally, certain <see cref="AdaptiveText"/> properties
/// like HintStyle aren't supported on the root children text elements, and only work inside an <see cref="AdaptiveGroup"/>.
/// If you use <see cref="AdaptiveGroup"/> on devices without the Anniversary Update, the group content will simply be dropped.
/// </summary>
public IList<IToastBindingGenericChild> Children { get; private set; } = new List<IToastBindingGenericChild>();
/// <summary>
/// An optional override of the logo displayed on the Toast notification.
/// Gets or sets an optional override of the logo displayed on the Toast notification.
/// </summary>
public ToastGenericAppLogo AppLogoOverride { get; set; }
/// <summary>
/// New in Anniversary Update: An optional hero image (a visually impactful image displayed on the Toast notification). On devices without the Anniversary Update, the hero image will simply be ignored.
/// Gets or sets an optional hero image (a visually impactful image displayed on the Toast notification).
/// On devices without the Anniversary Update, the hero image will simply be ignored.
/// </summary>
public ToastGenericHeroImage HeroImage { get; set; }
/// <summary>
/// New in Anniversary Update: An optional text element that is displayed as attribution text. On devices without the Anniversary Update, this text will appear as if it's another <see cref="AdaptiveText"/> element at the end of your Children list.
/// Gets or sets an optional text element that is displayed as attribution text. On devices without
/// the Anniversary Update, this text will appear as if it's another <see cref="AdaptiveText"/>
/// element at the end of your Children list.
/// </summary>
public ToastGenericAttributionText Attribution { get; set; }
/// <summary>
/// The target locale of the XML payload, specified as BCP-47 language tags such as "en-US" or "fr-FR". This locale is overridden by any locale specified in binding or text. If this value is a literal string, this attribute defaults to the user's UI language. If this value is a string reference, this attribute defaults to the locale chosen by Windows Runtime in resolving the string.
/// Gets or sets the target locale of the XML payload, specified as BCP-47 language tags such as "en-US"
/// or "fr-FR". This locale is overridden by any locale specified in binding or text. If this value is
/// a literal string, this attribute defaults to the user's UI language. If this value is a string reference,
/// this attribute defaults to the locale chosen by Windows Runtime in resolving the string.
/// </summary>
public string Language { get; set; }
/// <summary>
/// A default base URI that is combined with relative URIs in image source attributes.
/// Gets or sets a default base URI that is combined with relative URIs in image source attributes.
/// </summary>
public Uri BaseUri { get; set; }
/// <summary>
/// Set to "true" to allow Windows to append a query string to the image URI supplied in the Toast notification. Use this attribute if your server hosts images and can handle query strings, either by retrieving an image variant based on the query strings or by ignoring the query string and returning the image as specified without the query string. This query string specifies scale, contrast setting, and language.
/// Gets or sets a value whether Windows is allowed to append a query string to the image URI supplied in the Toast notification. Use this attribute if your server hosts images and can handle query strings, either by retrieving an image variant based on the query strings or by ignoring the query string and returning the image as specified without the query string. This query string specifies scale, contrast setting, and language.
/// </summary>
public bool? AddImageQuery { get; set; }

Просмотреть файл

@ -20,7 +20,7 @@ namespace Microsoft.Toolkit.Uwp.Notifications
public sealed class ToastButton : IToastButton
{
/// <summary>
/// Initializes a Toast button with the required properties.
/// Initializes a new instance of the <see cref="ToastButton"/> class.
/// </summary>
/// <param name="content">The text to display on the button.</param>
/// <param name="arguments">App-defined string of arguments that the app can later retrieve once it is activated when the user clicks the button.</param>
@ -41,32 +41,34 @@ namespace Microsoft.Toolkit.Uwp.Notifications
}
/// <summary>
/// Required. The text to display on the button.
/// Gets the text to display on the button. Required
/// </summary>
public string Content { get; private set; }
/// <summary>
/// Required. App-defined string of arguments that the app can later retrieve once it is activated when the user clicks the button.
/// Gets app-defined string of arguments that the app can later retrieve once it is
/// activated when the user clicks the button. Required
/// </summary>
public string Arguments { get; private set; }
/// <summary>
/// Controls what type of activation this button will use when clicked. Defaults to Foreground.
/// Gets or sets what type of activation this button will use when clicked. Defaults to Foreground.
/// </summary>
public ToastActivationType ActivationType { get; set; } = ToastActivationType.Foreground;
/// <summary>
/// New in Creators Update: Additional options relating to activation of the toast button.
/// Gets or sets additional options relating to activation of the toast button. New in Creators Update
/// </summary>
public ToastActivationOptions ActivationOptions { get; set; }
/// <summary>
/// An optional image icon for the button to display (required for buttons adjacent to inputs like quick reply).
/// Gets or sets an optional image icon for the button to display (required for buttons adjacent to inputs like quick reply).
/// </summary>
public string ImageUri { get; set; }
/// <summary>
/// Specify the ID of an existing <see cref="ToastTextBox"/> in order to have this button display to the right of the input, achieving a quick reply scenario.
/// Gets or sets the ID of an existing <see cref="ToastTextBox"/> in order to have this button display
/// to the right of the input, achieving a quick reply scenario.
/// </summary>
public string TextBoxId { get; set; }

Просмотреть файл

@ -20,23 +20,24 @@ namespace Microsoft.Toolkit.Uwp.Notifications
public sealed class ToastButtonDismiss : IToastButton
{
/// <summary>
/// Custom text displayed on the button that overrides the default localized "Dismiss" text.
/// Gets custom text displayed on the button that overrides the default localized "Dismiss" text.
/// </summary>
public string CustomContent { get; private set; }
/// <summary>
/// An optional image icon for the button to display.
/// Gets or sets an optional image icon for the button to display.
/// </summary>
public string ImageUri { get; set; }
/// <summary>
/// Initializes a system-handled dismiss button that displays localized "Dismiss" text on the button.
/// Initializes a new instance of the <see cref="ToastButtonDismiss"/> class.
/// </summary>
public ToastButtonDismiss()
{
}
/// <summary>
/// Initializes a new instance of the <see cref="ToastButtonDismiss"/> class.
/// Constructs a system-handled dismiss button that displays your text on the button.
/// </summary>
/// <param name="customContent">The text you want displayed on the button.</param>

Просмотреть файл

@ -20,28 +20,35 @@ namespace Microsoft.Toolkit.Uwp.Notifications
public sealed class ToastButtonSnooze : IToastButton
{
/// <summary>
/// Custom text displayed on the button that overrides the default localized "Snooze" text.
/// Gets custom text displayed on the button that overrides the default localized "Snooze" text.
/// </summary>
public string CustomContent { get; private set; }
/// <summary>
/// An optional image icon for the button to display.
/// Gets or sets an optional image icon for the button to display.
/// </summary>
public string ImageUri { get; set; }
/// <summary>
/// Optionally specify the ID of an existing <see cref="ToastSelectionBox"/> in order to allow the user to pick a custom snooze time. The ID's of the <see cref="ToastSelectionBoxItem"/>s inside the selection box must represent the snooze interval in minutes. For example, if the user selects an item that has an ID of "120", then the notification will be snoozed for 2 hours. When the user clicks this button, if you specified a SelectionBoxId, the system will parse the ID of the selected item and snooze by that amount of minutes. If you didn't specify a SelectionBoxId, the system will snooze by the default system snooze time.
/// Gets or sets the ID of an existing <see cref="ToastSelectionBox"/> in order to allow the
/// user to pick a custom snooze time. Optional. The ID's of the <see cref="ToastSelectionBoxItem"/>s
/// inside the selection box must represent the snooze interval in minutes. For example,
/// if the user selects an item that has an ID of "120", then the notification will be snoozed
/// for 2 hours. When the user clicks this button, if you specified a SelectionBoxId, the system
/// will parse the ID of the selected item and snooze by that amount of minutes. If you didn't specify
/// a SelectionBoxId, the system will snooze by the default system snooze time.
/// </summary>
public string SelectionBoxId { get; set; }
/// <summary>
/// Initializes a system-handled snooze button that displays localized "Snooze" text on the button and automatically handles snoozing.
/// Initializes a new instance of the <see cref="ToastButtonSnooze"/> class.
/// </summary>
public ToastButtonSnooze()
{
}
/// <summary>
/// Initializes a new instance of the <see cref="ToastButtonSnooze"/> class.
/// Initializes a system-handled snooze button that displays your text on the button and automatically handles snoozing.
/// </summary>
/// <param name="customContent">The text you want displayed on the button.</param>

Просмотреть файл

@ -24,52 +24,60 @@ namespace Microsoft.Toolkit.Uwp.Notifications
public sealed class ToastContent : INotificationContent
{
/// <summary>
/// The visual element is required.
/// Gets or sets the visual element (Required).
/// </summary>
public ToastVisual Visual { get; set; }
/// <summary>
/// Specify custom audio options.
/// Gets or sets custom audio options.
/// </summary>
public ToastAudio Audio { get; set; }
/// <summary>
/// Optionally create custom actions with buttons and inputs (using <see cref="ToastActionsCustom"/>) or optionally use the system-default snooze/dismiss controls (with <see cref="ToastActionsSnoozeAndDismiss"/>).
/// Gets or sets optional custom actions with buttons and inputs (using <see cref="ToastActionsCustom"/>)
/// or optionally use the system-default snooze/dismiss controls (with <see cref="ToastActionsSnoozeAndDismiss"/>).
/// </summary>
public IToastActions Actions { get; set; }
/// <summary>
/// New in Creators Update: Gets or sets an optional header for the toast notification.
/// Gets or sets an optional header for the toast notification. Requires Creators Update
/// </summary>
public ToastHeader Header { get; set; }
/// <summary>
/// Specify the scenario, to make the Toast behave like an alarm, reminder, or more.
/// Gets or sets the scenario, to make the Toast behave like an alarm, reminder, or more.
/// </summary>
public ToastScenario Scenario { get; set; }
/// <summary>
/// The amount of time the Toast should display. You typically should use the Scenario attribute instead, which impacts how long a Toast stays on screen.
/// Gets or sets the amount of time the Toast should display. You typically should use the
/// Scenario attribute instead, which impacts how long a Toast stays on screen.
/// </summary>
public ToastDuration Duration { get; set; }
/// <summary>
/// A string that is passed to the application when it is activated by the Toast. The format and contents of this string are defined by the app for its own use. When the user taps or clicks the Toast to launch its associated app, the launch string provides the context to the app that allows it to show the user a view relevant to the Toast content, rather than launching in its default way.
/// Gets or sets a string that is passed to the application when it is activated by the Toast.
/// The format and contents of this string are defined by the app for its own use. When the user
/// taps or clicks the Toast to launch its associated app, the launch string provides the context
/// to the app that allows it to show the user a view relevant to the Toast content, rather than
/// launching in its default way.
/// </summary>
public string Launch { get; set; }
/// <summary>
/// Specifies what activation type will be used when the user clicks the body of this Toast.
/// Gets or sets what activation type will be used when the user clicks the body of this Toast.
/// </summary>
public ToastActivationType ActivationType { get; set; }
/// <summary>
/// New in Creators Update: Additional options relating to activation of the toast notification.
/// Gets or sets additional options relating to activation of the toast notification. Requires Creators Updated
/// </summary>
public ToastActivationOptions ActivationOptions { get; set; }
/// <summary>
/// New in Creators Update: An optional custom time to use for the notification's timestamp, visible within Action Center. If provided, this date/time will be used on the notification instead of the date/time that the notification was received.
/// Gets or sets new an optional custom time to use for the notification's timestamp, visible within Action Center.
/// If provided, this date/time will be used on the notification instead of the date/time that the notification was received.
/// Requires Creators Update
/// </summary>
public DateTimeOffset? DisplayTimestamp { get; set; }

Просмотреть файл

@ -20,7 +20,8 @@ namespace Microsoft.Toolkit.Uwp.Notifications
public sealed class ToastContextMenuItem
{
/// <summary>
/// Initializes a Toast context menu item with the required properties.
/// Initializes a new instance of the <see cref="ToastContextMenuItem"/> class.
/// A Toast context menu item with the required properties.
/// </summary>
/// <param name="content">The text to display on the menu item.</param>
/// <param name="arguments">App-defined string of arguments that the app can later retrieve once it is activated when the user clicks the menu item.</param>
@ -41,22 +42,22 @@ namespace Microsoft.Toolkit.Uwp.Notifications
}
/// <summary>
/// Required. The text to display on the menu item.
/// Gets the text to display on the menu item. Required
/// </summary>
public string Content { get; private set; }
/// <summary>
/// Required. App-defined string of arguments that the app can later retrieve once it is activated when the user clicks the menu item.
/// Gets app-defined string of arguments that the app can later retrieve once it is activated when the user clicks the menu item. Required
/// </summary>
public string Arguments { get; private set; }
/// <summary>
/// Controls what type of activation this menu item will use when clicked. Defaults to Foreground.
/// Gets or sets what type of activation this menu item will use when clicked. Defaults to Foreground.
/// </summary>
public ToastActivationType ActivationType { get; set; } = ToastActivationType.Foreground;
/// <summary>
/// New in Creators Update: Additional options relating to activation of the toast context menu item.
/// Gets or sets additional options relating to activation of the toast context menu item. New in Creators Update
/// </summary>
public ToastActivationOptions ActivationOptions { get; set; }

Просмотреть файл

@ -20,7 +20,8 @@ namespace Microsoft.Toolkit.Uwp.Notifications
public sealed class ToastGenericAppLogo : IBaseImage
{
/// <summary>
/// Initializes a logo that is displayed on your Toast notification.
/// Initializes a new instance of the <see cref="ToastGenericAppLogo"/> class,
/// a logo that is displayed on your Toast notification.
/// </summary>
public ToastGenericAppLogo()
{
@ -29,7 +30,7 @@ namespace Microsoft.Toolkit.Uwp.Notifications
private string _source;
/// <summary>
/// The URI of the image. Can be from your application package, application data, or the internet. Internet images must be less than 200 KB in size.
/// Gets or sets the URI of the image. Can be from your application package, application data, or the internet. Internet images must be less than 200 KB in size.
/// </summary>
public string Source
{
@ -38,17 +39,17 @@ namespace Microsoft.Toolkit.Uwp.Notifications
}
/// <summary>
/// A description of the image, for users of assistive technologies.
/// Gets or sets a description of the image, for users of assistive technologies.
/// </summary>
public string AlternateText { get; set; }
/// <summary>
/// Set to true to allow Windows to append a query string to the image URI supplied in the Tile notification. Use this attribute if your server hosts images and can handle query strings, either by retrieving an image variant based on the query strings or by ignoring the query string and returning the image as specified without the query string. This query string specifies scale, contrast setting, and language.
/// Gets or sets set a value whether Windows is allowed to append a query string to the image URI supplied in the Tile notification. Use this attribute if your server hosts images and can handle query strings, either by retrieving an image variant based on the query strings or by ignoring the query string and returning the image as specified without the query string. This query string specifies scale, contrast setting, and language.
/// </summary>
public bool? AddImageQuery { get; set; }
/// <summary>
/// Specify how you would like the image to be cropped.
/// Gets or sets specify how the image should be cropped.
/// </summary>
public ToastGenericAppLogoCrop HintCrop { get; set; }

Просмотреть файл

@ -20,19 +20,20 @@ namespace Microsoft.Toolkit.Uwp.Notifications
public sealed class ToastGenericAttributionText : IBaseText
{
/// <summary>
/// Initializes an attribution text element to be displayed on the Toast notification.
/// Initializes a new instance of the <see cref="ToastGenericAttributionText"/> class.
/// An attribution text element to be displayed on the Toast notification.
/// </summary>
public ToastGenericAttributionText()
{
}
/// <summary>
/// The text to display.
/// Gets or sets the text to display.
/// </summary>
public string Text { get; set; }
/// <summary>
/// The target locale of the XML payload, specified as a BCP-47 language tags such as "en-US" or "fr-FR". The locale specified here overrides any other specified locale, such as that in binding or visual. If this value is a literal string, this attribute defaults to the user's UI language. If this value is a string reference, this attribute defaults to the locale chosen by Windows Runtime in resolving the string.
/// Gets or sets the target locale of the XML payload, specified as a BCP-47 language tags such as "en-US" or "fr-FR". The locale specified here overrides any other specified locale, such as that in binding or visual. If this value is a literal string, this attribute defaults to the user's UI language. If this value is a string reference, this attribute defaults to the locale chosen by Windows Runtime in resolving the string.
/// </summary>
public string Language { get; set; }

Просмотреть файл

@ -20,7 +20,8 @@ namespace Microsoft.Toolkit.Uwp.Notifications
public sealed class ToastGenericHeroImage : IBaseImage
{
/// <summary>
/// Initializes a hero image for the Toast notification.
/// Initializes a new instance of the <see cref="ToastGenericHeroImage"/> class.
/// A hero image for the Toast notification.
/// </summary>
public ToastGenericHeroImage()
{
@ -29,7 +30,7 @@ namespace Microsoft.Toolkit.Uwp.Notifications
private string _source;
/// <summary>
/// The URI of the image. Can be from your application package, application data, or the internet. Internet images must be less than 200 KB in size.
/// Gets or sets the URI of the image. Can be from your application package, application data, or the internet. Internet images must be less than 200 KB in size.
/// </summary>
public string Source
{
@ -38,12 +39,12 @@ namespace Microsoft.Toolkit.Uwp.Notifications
}
/// <summary>
/// A description of the image, for users of assistive technologies.
/// Gets or sets a description of the image, for users of assistive technologies.
/// </summary>
public string AlternateText { get; set; }
/// <summary>
/// Set to true to allow Windows to append a query string to the image URI supplied in the Tile notification. Use this attribute if your server hosts images and can handle query strings, either by retrieving an image variant based on the query strings or by ignoring the query string and returning the image as specified without the query string. This query string specifies scale, contrast setting, and language.
/// Gets or sets a value whether Windows is allowed to append a query string to the image URI supplied in the Tile notification. Use this attribute if your server hosts images and can handle query strings, either by retrieving an image variant based on the query strings or by ignoring the query string and returning the image as specified without the query string. This query string specifies scale, contrast setting, and language.
/// </summary>
public bool? AddImageQuery { get; set; }

Просмотреть файл

@ -20,6 +20,7 @@ namespace Microsoft.Toolkit.Uwp.Notifications
public sealed class ToastHeader
{
/// <summary>
/// Initializes a new instance of the <see cref="ToastHeader"/> class.
/// Constructs a toast header with all the required properties.
/// </summary>
/// <param name="id">A developer-created identifier that uniquely identifies this header. If two notifications have the same header id, they will be displayed underneath the same header in Action Center.</param>
@ -93,7 +94,7 @@ namespace Microsoft.Toolkit.Uwp.Notifications
}
/// <summary>
/// New in Creators Update: Additional options relating to activation of the toast header.
/// Gets or sets additional options relating to activation of the toast header. New in Creators Update
/// </summary>
public ToastActivationOptions ActivationOptions { get; set; }

Просмотреть файл

@ -21,36 +21,32 @@ namespace Microsoft.Toolkit.Uwp.Notifications
public sealed class ToastSelectionBox : IToastInput
{
/// <summary>
/// Initializes a new Toast SelectionBox input control with the required elements.
/// Initializes a new instance of the <see cref="ToastSelectionBox"/> class.
/// A Toast SelectionBox input control with the required elements.
/// </summary>
/// <param name="id">Developer-provided ID that the developer uses later to retrieve input when the Toast is interacted with.</param>
public ToastSelectionBox(string id)
{
if (id == null)
{
throw new ArgumentNullException(nameof(id));
}
Id = id;
Id = id ?? throw new ArgumentNullException(nameof(id));
}
/// <summary>
/// The ID property is required, and is used so that developers can retrieve user input once the app is activated.
/// Gets the required ID property used so that developers can retrieve user input once the app is activated.
/// </summary>
public string Id { get; private set; }
/// <summary>
/// Title text to display above the SelectionBox.
/// Gets or sets title text to display above the SelectionBox.
/// </summary>
public string Title { get; set; }
/// <summary>
/// This controls which item is selected by default, and refers to the Id property of <see cref="ToastSelectionBoxItem"/>. If you do not provide this, the default selection will be empty (user sees nothing).
/// Gets or sets which item is selected by default, and refers to the Id property of <see cref="ToastSelectionBoxItem"/>. If you do not provide this, the default selection will be empty (user sees nothing).
/// </summary>
public string DefaultSelectionBoxItemId { get; set; }
/// <summary>
/// The selection items that the user can pick from in this SelectionBox. Only 5 items can be added.
/// Gets the selection items that the user can pick from in this SelectionBox. Only 5 items can be added.
/// </summary>
public IList<ToastSelectionBoxItem> Items { get; private set; } = new LimitedList<ToastSelectionBoxItem>(5);

Просмотреть файл

@ -20,33 +20,24 @@ namespace Microsoft.Toolkit.Uwp.Notifications
public sealed class ToastSelectionBoxItem
{
/// <summary>
/// Initializes a new instance of the <see cref="ToastSelectionBoxItem"/> class.
/// Constructs a new Toast SelectionBoxItem with the required elements.
/// </summary>
/// <param name="id">Developer-provided ID that the developer uses later to retrieve input when the Toast is interacted with.</param>
/// <param name="content">String that is displayed on the selection item. This is what the user sees.</param>
public ToastSelectionBoxItem(string id, string content)
{
if (id == null)
{
throw new ArgumentNullException(nameof(id));
}
if (content == null)
{
throw new ArgumentNullException(nameof(content));
}
Id = id;
Content = content;
Id = id ?? throw new ArgumentNullException(nameof(id));
Content = content ?? throw new ArgumentNullException(nameof(content));
}
/// <summary>
/// The ID property is required, and is used so that developers can retrieve user input once the app is activated.
/// Gets the required ID property used so that developers can retrieve user input once the app is activated.
/// </summary>
public string Id { get; private set; }
/// <summary>
/// The Content property is required, and is a string that is displayed on the selection item.
/// Gets the required string that is displayed on the selection item.
/// </summary>
public string Content { get; private set; }

Просмотреть файл

@ -20,36 +20,32 @@ namespace Microsoft.Toolkit.Uwp.Notifications
public sealed class ToastTextBox : IToastInput
{
/// <summary>
/// Initializes a new Toast TextBox input control with the required elements.
/// Initializes a new instance of the <see cref="ToastTextBox"/> class.
/// A new Toast TextBox input control with the required elements.
/// </summary>
/// <param name="id">Developer-provided ID that the developer uses later to retrieve input when the Toast is interacted with.</param>
public ToastTextBox(string id)
{
if (id == null)
{
throw new ArgumentNullException(nameof(id));
}
Id = id;
Id = id ?? throw new ArgumentNullException(nameof(id));
}
/// <summary>
/// The ID property is required, and is used so that developers can retrieve user input once the app is activated.
/// Gets the required ID property so that developers can retrieve user input once the app is activated.
/// </summary>
public string Id { get; private set; }
/// <summary>
/// Title text to display above the text box.
/// Gets or sets title text to display above the text box.
/// </summary>
public string Title { get; set; }
/// <summary>
/// Placeholder text to be displayed on the text box when the user hasn't typed any text yet.
/// Gets or sets placeholder text to be displayed on the text box when the user hasn't typed any text yet.
/// </summary>
public string PlaceholderContent { get; set; }
/// <summary>
/// The initial text to place in the text box. Leave this null for a blank text box.
/// Gets or sets the initial text to place in the text box. Leave this null for a blank text box.
/// </summary>
public string DefaultInput { get; set; }

Просмотреть файл

@ -20,22 +20,22 @@ namespace Microsoft.Toolkit.Uwp.Notifications
public sealed class ToastVisual
{
/// <summary>
/// The target locale of the XML payload, specified as BCP-47 language tags such as "en-US" or "fr-FR". This locale is overridden by any locale specified in binding or text. If this value is a literal string, this attribute defaults to the user's UI language. If this value is a string reference, this attribute defaults to the locale chosen by Windows Runtime in resolving the string.
/// Gets or sets the target locale of the XML payload, specified as BCP-47 language tags such as "en-US" or "fr-FR". This locale is overridden by any locale specified in binding or text. If this value is a literal string, this attribute defaults to the user's UI language. If this value is a string reference, this attribute defaults to the locale chosen by Windows Runtime in resolving the string.
/// </summary>
public string Language { get; set; }
/// <summary>
/// A default base URI that is combined with relative URIs in image source attributes.
/// Gets or sets a default base URI that is combined with relative URIs in image source attributes.
/// </summary>
public Uri BaseUri { get; set; }
/// <summary>
/// Set to "true" to allow Windows to append a query string to the image URI supplied in the Toast notification. Use this attribute if your server hosts images and can handle query strings, either by retrieving an image variant based on the query strings or by ignoring the query string and returning the image as specified without the query string. This query string specifies scale, contrast setting, and language.
/// Gets or sets a value whether Windows is allowed to append a query string to the image URI supplied in the Toast notification. Use this attribute if your server hosts images and can handle query strings, either by retrieving an image variant based on the query strings or by ignoring the query string and returning the image as specified without the query string. This query string specifies scale, contrast setting, and language.
/// </summary>
public bool? AddImageQuery { get; set; }
/// <summary>
/// The generic Toast binding, which can be rendered on all devices. This binding is required and cannot be null.
/// Gets or sets the generic Toast binding, which can be rendered on all devices. This binding is required and cannot be null.
/// </summary>
public ToastBindingGeneric BindingGeneric { get; set; }

Просмотреть файл

@ -37,7 +37,7 @@ namespace Microsoft.Toolkit.Uwp.UI.Controls
private Carousel carouselControl;
/// <summary>
/// The constructor for the <see cref="CarouselPanel"/>
/// Initializes a new instance of the <see cref="CarouselPanel"/> class.
/// </summary>
public CarouselPanel()
{
@ -496,27 +496,27 @@ namespace Microsoft.Toolkit.Uwp.UI.Controls
public struct Proj
{
/// <summary>
/// Position of an item
/// Gets or sets the position of an item
/// </summary>
public double Position { get; set; }
/// <summary>
/// Depth of an item
/// Gets or sets the depth of an item
/// </summary>
public double Depth { get; set; }
/// <summary>
/// Rotation around the X axis
/// Gets or sets the rotation around the X axis
/// </summary>
public double RotationX { get; set; }
/// <summary>
/// Rotation around the Y axis
/// Gets or sets the rotation around the Y axis
/// </summary>
public double RotationY { get; set; }
/// <summary>
/// Rotation around the Z axis
/// Gets or sets the rotation around the Z axis
/// </summary>
public double RotationZ { get; set; }
}

Просмотреть файл

@ -35,7 +35,7 @@ namespace Microsoft.Toolkit.Uwp.UI.Controls
public partial class Expander : ContentControl
{
/// <summary>
/// Default constructor for the Expander control
/// Initializes a new instance of the <see cref="Expander"/> class.
/// </summary>
public Expander()
{

Просмотреть файл

@ -65,17 +65,17 @@ namespace Microsoft.Toolkit.Uwp.UI.Controls
protected const string FailedState = "Failed";
/// <summary>
/// The backing image object
/// Gets the backing image object
/// </summary>
protected object Image { get; private set; }
/// <summary>
/// backing object for the ProgressRing
/// Gets backing object for the ProgressRing
/// </summary>
protected ProgressRing Progress { get; private set; }
/// <summary>
/// Object used for lock
/// Gets object used for lock
/// </summary>
protected object LockObj { get; private set; }

Просмотреть файл

@ -30,7 +30,7 @@ namespace Microsoft.Toolkit.Uwp.UI.Controls
protected const string PartImageRectangle = "ImageRectangle";
/// <summary>
/// The root rectangle of the image
/// Gets the root rectangle of the image
/// </summary>
protected Rectangle ImageRectangle { get; private set; }

Просмотреть файл

@ -23,7 +23,7 @@ namespace Microsoft.Toolkit.Uwp.UI.Controls.TextToolbarFormats
public abstract class Formatter
{
/// <summary>
/// Constructor for the <see cref="Formatter"/> class
/// Initializes a new instance of the <see cref="Formatter"/> class.
/// </summary>
/// <param name="model">The <see cref="TextToolbar"/>where Formatter is used</param>
public Formatter(TextToolbar model)

Просмотреть файл

@ -20,7 +20,7 @@ namespace Microsoft.Toolkit.Uwp.UI.Controls.TextToolbarFormats.MarkDown
public class MarkDownButtonActions : ButtonActions
{
/// <summary>
/// Constructor for the <see cref="MarkDownButtonActions"/>
/// Initializes a new instance of the <see cref="MarkDownButtonActions"/> class.
/// </summary>
/// <param name="formatter">The Formatter to use</param>
public MarkDownButtonActions(MarkDownFormatter formatter)

Просмотреть файл

@ -28,7 +28,7 @@ namespace Microsoft.Toolkit.Uwp.UI.Controls.TextToolbarFormats.MarkDown
public class MarkDownFormatter : Formatter
{
/// <summary>
/// Constructor for the <see cref="MarkDownFormatter"/>
/// Initializes a new instance of the <see cref="MarkDownFormatter"/> class.
/// </summary>
/// <param name="model"><see cref="TextToolbar"/> where formatter will be used</param>
public MarkDownFormatter(TextToolbar model)

Просмотреть файл

@ -21,7 +21,7 @@ namespace Microsoft.Toolkit.Uwp.UI.Controls.TextToolbarFormats.RichText
public class RichTextButtonActions : ButtonActions
{
/// <summary>
/// Constructor for the <see cref="RichTextButtonActions"/>
/// Initializes a new instance of the <see cref="RichTextButtonActions"/> class.
/// </summary>
/// <param name="formatter">The <see cref="RichTextFormatter"/></param>
public RichTextButtonActions(RichTextFormatter formatter)
@ -166,7 +166,7 @@ namespace Microsoft.Toolkit.Uwp.UI.Controls.TextToolbarFormats.RichText
}
/// <summary>
/// The <see cref="RichTextFormatter"/>
/// Gets the <see cref="RichTextFormatter"/>
/// </summary>
public RichTextFormatter Formatter { get; }
}

Просмотреть файл

@ -24,7 +24,7 @@ namespace Microsoft.Toolkit.Uwp.UI.Controls.TextToolbarFormats.RichText
public class RichTextFormatter : Formatter
{
/// <summary>
/// Constructor for the <see cref="RichTextFormatter"/>
/// Initializes a new instance of the <see cref="RichTextFormatter"/> class.
/// </summary>
/// <param name="model">The <see cref="TextToolbar"/></param>
public RichTextFormatter(TextToolbar model)
@ -158,7 +158,7 @@ namespace Microsoft.Toolkit.Uwp.UI.Controls.TextToolbarFormats.RichText
}
/// <summary>
/// Format used for formatting selection in editor
/// Gets or sets format used for formatting selection in editor
/// </summary>
public ITextCharacterFormat SelectionFormat
{

Просмотреть файл

@ -21,7 +21,7 @@ namespace Microsoft.Toolkit.Uwp.UI.Controls
public class ShortcutKeyRequestArgs
{
/// <summary>
/// Constructor for the <see cref="ShortcutKeyRequestArgs"/>
/// Initializes a new instance of the <see cref="ShortcutKeyRequestArgs"/> class.
/// </summary>
/// <param name="key"><see cref="VirtualKey"/> pressed</param>
/// <param name="shiftKeyHeld">value indicating if the SHIFT key was pressed</param>

Просмотреть файл

@ -18,7 +18,7 @@ namespace Microsoft.Toolkit.Uwp.UI.Controls.TextToolbarSymbols
public class List : Symbol
{
/// <summary>
/// Constructor for the List Icon
/// Initializes a new instance of the <see cref="List"/> class.
/// </summary>
public List()
{

Просмотреть файл

@ -18,7 +18,7 @@ namespace Microsoft.Toolkit.Uwp.UI.Controls.TextToolbarSymbols
public class NumberedList : Symbol
{
/// <summary>
/// Constructor for the Numbered List Icon
/// Initializes a new instance of the <see cref="NumberedList"/> class.
/// </summary>
public NumberedList()
{

Просмотреть файл

@ -36,7 +36,7 @@ namespace Microsoft.Toolkit.Uwp.UI.Controls
internal const string HeadersElement = "Headers";
/// <summary>
/// Constructor for the <see cref="TextToolbar"/>
/// Initializes a new instance of the <see cref="TextToolbar"/> class.
/// </summary>
public TextToolbar()
{

Просмотреть файл

@ -49,7 +49,7 @@ namespace Microsoft.Toolkit.Uwp.UI.Controls.TextToolbarButtons
DependencyProperty.Register(nameof(ShortcutFancyName), typeof(string), typeof(ToolbarButton), new PropertyMetadata(null));
/// <summary>
/// Constructor for <see cref="ToolbarButton"/>
/// Initializes a new instance of the <see cref="ToolbarButton"/> class.
/// </summary>
public ToolbarButton()
{
@ -177,7 +177,7 @@ namespace Microsoft.Toolkit.Uwp.UI.Controls.TextToolbarButtons
}
/// <summary>
/// Gets or sets whether the <see cref="ToolbarButton"/> is Toggled
/// Gets or sets a value indicating whether the <see cref="ToolbarButton"/> is Toggled
/// </summary>
public bool IsToggled
{

Просмотреть файл

@ -20,7 +20,7 @@ namespace Microsoft.Toolkit.Uwp.UI.Controls.TextToolbarButtons
public class ToolbarSeparator : AppBarSeparator, IToolbarItem
{
/// <summary>
/// The Constructor for <see cref="ToolbarSeparator"/>
/// Initializes a new instance of the <see cref="ToolbarSeparator"/> class.
/// </summary>
public ToolbarSeparator()
{

Просмотреть файл

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<RuleSet Name="Microsoft Managed Recommended Rules" Description="These rules focus on the most critical problems in your code, including potential security holes, application crashes, and other important logic and design errors. It is recommended to include this rule set in any custom rule set you create for your projects." ToolsVersion="10.0">
<RuleSet Name="Microsoft Managed Recommended Rules" Description="These rules focus on the most critical problems in your code, including potential security holes, application crashes, and other important logic and design errors. It is recommended to include this rule set in any custom rule set you create for your projects." ToolsVersion="15.0">
<Localization ResourceAssembly="Microsoft.VisualStudio.CodeAnalysis.RuleSets.Strings.dll" ResourceBaseName="Microsoft.VisualStudio.CodeAnalysis.RuleSets.Strings.Localized">
<Name Resource="MinimumRecommendedRules_Name" />
<Description Resource="MinimumRecommendedRules_Description" />
@ -69,21 +69,19 @@
<Rule Id="CA2242" Action="Warning" />
</Rules>
<Rules AnalyzerId="StyleCop.Analyzers" RuleNamespace="StyleCop.Analyzers">
<Rule Id="SA1011" Action="None" />
<Rule Id="SA1101" Action="None" />
<Rule Id="SA1633" Action="None" />
<Rule Id="SA1118" Action="None" />
<Rule Id="SA1200" Action="None" />
<Rule Id="SA1201" Action="None" />
<Rule Id="SA1202" Action="None" />
<Rule Id="SA1309" Action="None" />
<Rule Id="SA1310" Action="None" />
<Rule Id="SA1600" Action="None" />
<Rule Id="SA1602" Action="None" />
<Rule Id="SA1611" Action="None" />
<Rule Id="SA1633" Action="None" />
<Rule Id="SA1634" Action="None" />
<Rule Id="SA1652" Action="None" />
<Rule Id="SA1011" Action="None" />
<Rule Id="SA1202" Action="None" />
<Rule Id="SA1600" Action="None" />
<Rule Id="SA1611" Action="None" />
<Rule Id="SA1602" Action="None" />
<Rule Id="SA1118" Action="None" />
<Rule Id="SA1310" Action="None" />
<Rule Id="SA1623" Action="None" />
<Rule Id="SA1642" Action="None" />
</Rules>
</RuleSet>