namespace Tizen.Maps
{
/// <summary>
- /// Marker map object
+ /// The marker map object.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class Marker : MapObject, IDisposable
{
internal Interop.MarkerHandle handle;
}
/// <summary>
- /// Gets or sets clicked event handlers.
+ /// Gets or sets the clicked event handlers.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandler Clicked;
/// <summary>
- /// Gets or sets marker's visibility.
+ /// Gets or sets the marker's visibility.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public override bool IsVisible
{
get
}
/// <summary>
- /// Gets or sets geographical coordinates for this marker.
+ /// Gets or sets the geographical coordinates for this marker.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public Geocoordinates Coordinates
{
get
}
/// <summary>
- /// Gets or sets a string representing image file path for this marker.
+ /// Gets or sets a string representing the image file path for this marker.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public string ImagePath
{
get
}
/// <summary>
- /// Gets or sets screen size for this marker.
+ /// Gets or sets the screen size for this marker.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public Size MarkerSize
{
get
}
/// <summary>
- /// Gets or sets z-order for this marker.
+ /// Gets or sets the z-order for this marker.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <value>The integer value is 0 in default, and must be in range of from -100 to 100.</value>
+ /// <since_tizen> 3 </since_tizen>
+ /// <value>The integer value is 0 by default, and must be in the range of -100 to 100.</value>
public int ZOrder
{
get
}
/// <summary>
- /// Changes marker size.
+ /// Changes the marker size.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="newSize">New size</param>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="newSize">New size.</param>
public void Resize(Size newSize)
{
MarkerSize = newSize;
}
/// <summary>
- /// Changes marker coordinates.
+ /// Changes the marker coordinates.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="newPosition">New position for marker</param>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="newPosition">New position for the marker.</param>
public void Move(Geocoordinates newPosition)
{
Coordinates = newPosition;
}
/// <summary>
- /// Releases all resources used by this object.
+ /// Releases all the resources used by this object.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
Dispose(true);
}
/// <summary>
- /// Pin type marker map object
+ /// Pin type the marker map object.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class Pin : Marker
{
private const string defaultImagePath = "/usr/share/dotnet.tizen/framework/res/maps_marker_pin_48.png";
/// <summary>
- /// Creates a Pin type marker.
+ /// Creates a pin type marker.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="coordinates">Marker coordinates</param>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="coordinates">Marker coordinates.</param>
/// <exception cref="System.ArgumentException">Thrown when input coordinates are invalid.</exception>
public Pin(Geocoordinates coordinates)
: base(coordinates, defaultImagePath, Interop.ViewMarkerType.Pin)
}
/// <summary>
- /// Creates a Pin type marker.
+ /// Creates a pin type marker.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="coordinates">Marker coordinates</param>
- /// <param name="imagePath">Image file path for Marker</param>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="coordinates">Marker coordinates.</param>
+ /// <param name="imagePath">Image file path for the Marker.</param>
/// <remarks>
- /// http://tizen.org/privilege/mediastorage is needed if the file path are relevant to media storage.
- /// http://tizen.org/privilege/externalstorage is needed if the file path are relevant to external storage.
+ /// http://tizen.org/privilege/mediastorage is needed if the file path is relevant to media storage.
+ /// http://tizen.org/privilege/externalstorage is needed if the file path is relevant to external storage.
/// </remarks>
/// <exception cref="System.NotSupportedException">Thrown when the required feature is not supported.</exception>
/// <exception cref="System.UnauthorizedAccessException">Thrown when application does not have some privilege to access this method.</exception>
- /// <exception cref="System.ArgumentException">Thrown when input coordinates or imagePath are invalid.</exception>
+ /// <exception cref="System.ArgumentException">Thrown when the input coordinates or imagePath is invalid.</exception>
public Pin(Geocoordinates coordinates, string imagePath)
: base(coordinates, imagePath, Interop.ViewMarkerType.Pin)
{
}
/// <summary>
- /// Sticker type marker map object
+ /// Sticker type marker map object.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class Sticker : Marker
{
private const string defaultImagePath = "/usr/share/dotnet.tizen/framework/res/maps_marker_sticker_48.png";
/// <summary>
- /// Creates a Sticker type marker.
+ /// Creates a sticker type marker.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="coordinates">Marker coordinates</param>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="coordinates">Marker coordinates.</param>
/// <exception cref="System.ArgumentException">Thrown when input coordinates are invalid.</exception>
public Sticker(Geocoordinates coordinates)
: base(coordinates, defaultImagePath, Interop.ViewMarkerType.Sticker)
}
/// <summary>
- /// Creates a Sticker type marker.
+ /// Creates a sticker type marker.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="coordinates">Marker coordinates</param>
- /// <param name="imagePath">Image file path for Marker</param>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="coordinates">Marker coordinates.</param>
+ /// <param name="imagePath">Image file path for Marker.</param>
/// <remarks>
- /// http://tizen.org/privilege/mediastorage is needed if input or output path are relevant to media storage.
- /// http://tizen.org/privilege/externalstorage is needed if input or output path are relevant to external storage.
+ /// http://tizen.org/privilege/mediastorage is needed if the input or output path are relevant to media storage.
+ /// http://tizen.org/privilege/externalstorage is needed if the input or output path are relevant to external storage.
/// </remarks>
/// <exception cref="System.NotSupportedException">Thrown when the required feature is not supported.</exception>
/// <exception cref="System.UnauthorizedAccessException">Thrown when application does not have some privilege to access this method.</exception>
- /// <exception cref="System.ArgumentException">Thrown when input coordinates or imagePath are invalid.</exception>
+ /// <exception cref="System.ArgumentException">Thrown when the input coordinates or imagePath is invalid.</exception>
public Sticker(Geocoordinates coordinates, string imagePath)
: base(coordinates, imagePath, Interop.ViewMarkerType.Sticker)
{