CanSetTime Method (MapMember)

In This Topic

Gets if the mapMember supports time filtering and if the specified time parameters are valid. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

C#
Visual Basic (Declaration)

public virtual bool CanSetTime( 
   TimeParameters timeParams
)

Public Overridable Function CanSetTime( _
   ByVal timeParams As TimeParameters _
) As Boolean

Parameters

timeParams: The time parameters to set.

Return Value

True if the mapMember supports time filtering and the are valid. False otherwise.

Exceptions

Exception	Description
ArcGIS.Core.CalledOnWrongThreadException	This method or property must be called within the lambda passed to QueuedTask.Run.

Remarks

You should use this method before calling the SetTime method.

The following outlines some of the rules for determining validity of the time parameters with respect to the mapMember

- The rules as specified in TimeParameters.IsValid.

- if a StartTimeFieldName is specified it must exist and not be of type ArcGIS.Core.Data.FieldType.TimeOnly.

- if a EndTimeFieldName is specified it must exist and not be of type ArcGIS.Core.Data.FieldType.TimeOnly.

- if both StartTimeFieldName and EndTimeFieldName are specified and StartTimeFieldName is of type ArcGIS.Core.Data.FieldType.DateOnly then EndTimeFieldName must also be ArcGIS.Core.Data.FieldType.DateOnly.

- if both StartTimeFieldName and EndTimeFieldName are specified and StartTimeFieldName is of type ArcGIS.Core.Data.FieldType.TimestampOffset then EndTimeFieldName must also be ArcGIS.Core.Data.FieldType.TimestampOffset.

- if both StartTimeFieldName and EndTimeFieldName are specified and StartTimeFieldName is of type ArcGIS.Core.Data.FieldType.Date then EndTimeFieldName must not be of type ArcGIS.Core.Data.FieldType.DateOnly or ArcGIS.Core.Data.FieldType.TimestampOffset.

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3.1 or higher.

Reference

MapMember Class
MapMember Members

Send feedback