PlaceInfo
PlaceInfo
PlaceInfo
PlaceInfo
Class
Definition
Some information relates to pre-released product which may be substantially modified before it’s commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Prerelease APIs are identified by a Prerelease label.
[Contains prerelease APIs.]
Displays a map location and information that describes that location in a light-dismissible window which closes automatically when the user clicks outside of the window.
public : sealed class PlaceInfo : IPlaceInfopublic sealed class PlaceInfo : IPlaceInfoPublic NotInheritable Class PlaceInfo Implements IPlaceInfo// You can use this class in JavaScript.
- Attributes
| Device family |
Windows 10 Insider Preview (introduced v10.0.16257.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v5)
|
Properties
DisplayAddress DisplayAddress DisplayAddress DisplayAddress
Prerelease. Gets the address associated with the PlaceInfo.
public : PlatForm::String DisplayAddress { get; }public string DisplayAddress { get; }Public ReadOnly Property DisplayAddress As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The address associated with the PlaceInfo.
DisplayName DisplayName DisplayName DisplayName
Prerelease. Gets the display name associated with the PlaceInfo.
public : PlatForm::String DisplayName { get; }public string DisplayName { get; }Public ReadOnly Property DisplayName As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The display name associated with the PlaceInfo.
Geoshape Geoshape Geoshape Geoshape
Prerelease. Gets the geographical shape associated with the PlaceInfo.
public : IGeoshape Geoshape { get; }public IGeoshape Geoshape { get; }Public ReadOnly Property Geoshape As IGeoshape// You can use this property in JavaScript.
Identifier Identifier Identifier Identifier
Prerelease. Gets the identifier associated with the PlaceInfo.
public : PlatForm::String Identifier { get; }public string Identifier { get; }Public ReadOnly Property Identifier As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
Gets the identifier associated with the PlaceInfo.
IsShowSupported IsShowSupported IsShowSupported IsShowSupported
Prerelease. Gets a value that indicates whether your app can show a light-dismissible window that contains a map location and related information given the current context.
public : static PlatForm::Boolean IsShowSupported { get; }public static bool IsShowSupported { get; }Public Static ReadOnly Property IsShowSupported As bool// You can use this property in JavaScript.
- Value
- PlatForm::Boolean bool bool bool
true if your app can show a light-dismissible window that contains a map location and related information given the current context; otherwise, false.
Methods
Create(Geopoint) Create(Geopoint) Create(Geopoint) Create(Geopoint)
Prerelease. Creates a PlaceInfo instance.
public : static PlaceInfo Create(Geopoint referencePoint)public static PlaceInfo Create(Geopoint referencePoint)Public Static Function Create(referencePoint As Geopoint) As PlaceInfo// You can use this method in JavaScript.
The geographic map location that you want to show in a light-dismissible window.
Create(Geopoint, PlaceInfoCreateOptions) Create(Geopoint, PlaceInfoCreateOptions) Create(Geopoint, PlaceInfoCreateOptions) Create(Geopoint, PlaceInfoCreateOptions)
Prerelease. Creates a PlaceInfo instance.
public : static PlaceInfo Create(Geopoint referencePoint, PlaceInfoCreateOptions options)public static PlaceInfo Create(Geopoint referencePoint, PlaceInfoCreateOptions options)Public Static Function Create(referencePoint As Geopoint, options As PlaceInfoCreateOptions) As PlaceInfo// You can use this method in JavaScript.
The geographic map location that you want to show in a light-dismissible window.
The optional information that describes this location. This information will appear in the light-dismissible window.
CreateFromIdentifier(String) CreateFromIdentifier(String) CreateFromIdentifier(String) CreateFromIdentifier(String)
Prerelease. Creates a PlaceInfo instance.
public : static PlaceInfo CreateFromIdentifier(PlatForm::String identifier)public static PlaceInfo CreateFromIdentifier(String identifier)Public Static Function CreateFromIdentifier(identifier As String) As PlaceInfo// You can use this method in JavaScript.
- identifier
- PlatForm::String String String String
The identifier of the location.
CreateFromIdentifier(String, Geopoint, PlaceInfoCreateOptions) CreateFromIdentifier(String, Geopoint, PlaceInfoCreateOptions) CreateFromIdentifier(String, Geopoint, PlaceInfoCreateOptions) CreateFromIdentifier(String, Geopoint, PlaceInfoCreateOptions)
Prerelease. Creates a PlaceInfo instance.
public : static PlaceInfo CreateFromIdentifier(PlatForm::String identifier, Geopoint defaultPoint, PlaceInfoCreateOptions options)public static PlaceInfo CreateFromIdentifier(String identifier, Geopoint defaultPoint, PlaceInfoCreateOptions options)Public Static Function CreateFromIdentifier(identifier As String, defaultPoint As Geopoint, options As PlaceInfoCreateOptions) As PlaceInfo// You can use this method in JavaScript.
- identifier
- PlatForm::String String String String
The identifier of the location.
The geographic map location that you want to show in a light-dismissible window.
Note
This value is used only if the identifier is invalid, the device is offline, or the details of the place can't be obtained by using the identifier.
The optional information that describes this location. This information will appear in the light-dismissible window.
Note
This value is used only if the identifier is invalid, the device is offline, or the details of the place can't be obtained by using the identifier.
CreateFromMapLocation(MapLocation) CreateFromMapLocation(MapLocation) CreateFromMapLocation(MapLocation) CreateFromMapLocation(MapLocation)
Prerelease. Creates a PlaceInfo instance.
public : static PlaceInfo CreateFromMapLocation(MapLocation location)public static PlaceInfo CreateFromMapLocation(MapLocation location)Public Static Function CreateFromMapLocation(location As MapLocation) As PlaceInfo// You can use this method in JavaScript.
- location
- MapLocation MapLocation MapLocation MapLocation
The geographic map location that you want to show in a light-dismissible window.
Remarks
You can get a MapLocation object by using any of the methods in the MapLocationFinder class.
Show(Rect) Show(Rect) Show(Rect) Show(Rect)
Prerelease. Shows in a pop-up window, the map location and related information that is described in the PlaceInfo.
public : void Show(Rect selection)public void Show(Rect selection)Public Function Show(selection As Rect) As void// You can use this method in JavaScript.
The Rect is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the light-dismissible window, not within that rectangular area. For example, if an app uses a button to show the place, pass the Rect of the button so the light-dismissible window displays around the button, not overlapping it.
Remarks
By default, this window appears below the selection rectangle. If you want to specify a different placement for this window, use the overloaded version of this method that accepts a Placement value as a parameter. This method closes any place card UIs that are already visible.
Show(Rect, Placement) Show(Rect, Placement) Show(Rect, Placement) Show(Rect, Placement)
Prerelease. Shows in a light-dismissible window, the map location and related information that is described in the PlaceInfo.
public : void Show(Rect selection, Placement preferredPlacement)public void Show(Rect selection, Placement preferredPlacement)Public Function Show(selection As Rect, preferredPlacement As Placement) As void// You can use this method in JavaScript.
The Rect is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the light-dismissible window, not within that rectangular area. For example, if an app uses a button to show the place, pass the Rect of the button so the light-dismissible window displays around the button, not overlapping it.
The preferred placement of the light-dismissible window relative to the rectangle.
Remarks
This method closes any place card UIs that are already visible.