[ROOT]  doc  DocFrag  SELECT Assembly, DocFragType, Description.FirstLine()   <  SKIP 329  >   <  TAKE 125  >   

125 items

DocFragIdAssemblyDocFragTypeDescription.FirstLine()
ARCCore.PKRelAttribute.EnforceReferentialIntegrityARCCoreClassMemberSee -EnforceReferentialIntegrity-.
ARCQuery.FunctionKeyDate.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCCore.PKRelAttribute.IsDefaultARCCoreClassMemberDoes not have a corresponding -BaseAttributeP- since all attributes relevant for querying (for instance in the documentation) will be IsDefault = FALSE anyway. (if we had included it in -BaseAttributeP- it would just have led to a lot of confusing IsDefault = FALSE key-values showing up.)
ARCQuery.FunctionKeyDate.SyntaxHelpARCQueryClassMember'Date()'
ARCCore.PKTypeAttributeARCCoreClassContains the most basic essential information about a property key, like its description, -Type-, -Cardinality-, -IsObligatory- and -DefaultValue-.
ARCQuery.FunctionKeyDayOfWeekARCQueryClassExtracts DayOfWeek from field like 'Monday', 'Tuesday' and so on.
ARCCore.PKTypeAttribute.InitializeARCCoreClassMemberTo be overridden in sub-classes, but do note that sub-classes are supposed to call base.Initialize() at end of their own initialization.
ARCQuery.FunctionKeyDayOfWeek.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCCore.PKTypeAttribute.StandardValidatorAndParserARCCoreClassMemberReturns validator and parser for well known types like string, int, long, bool, DateTime, TimeSpan, Type, Uri.
ARCQuery.FunctionKeyDayOfWeek.SyntaxHelpARCQueryClassMember'DayOfWeek()'
ARCCore.PKTypeAttribute.StandardCleanerARCCoreClassMemberReturns a cleaner for well known types like bool
ARCQuery.FunctionKeyDoubleARCQueryClassConverts an integer to a double (decimal value).
ARCCore.PKTypeAttribute.TryRemovePARCCoreClassMemberShould probably never be used.
ARCQuery.FunctionKeyDouble.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCCore.PKTypeAttribute.TypeARCCoreClassMemberSee -Type-.
ARCQuery.FunctionKeyDouble.SyntaxHelpARCQueryClassMember'Double()'
ARCCore.PKTypeAttribute.CardinalityARCCoreClassMemberSee -Cardinality-.
ARCQuery.FunctionKeyFirstLineARCQueryClassExtracts first line from string of text.
ARCCore.PKTypeAttribute.DefaultValueARCCoreClassMemberSee -DefaultValue-.
ARCQuery.FunctionKeyFirstLine.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCCore.PKTypeAttribute.IsObligatoryARCCoreClassMemberSee -IsObligatory-.
ARCQuery.FunctionKeyFirstLine.SyntaxHelpARCQueryClassMember'FirstLine()'
ARCCore.PKTypeAttribute.IsDefaultARCCoreClassMemberDoes not have a corresponding -BaseAttributeP- since all attributes relevant for querying (for instance in the documentation) will be IsDefault = FALSE anyway. (if we had included it in -BaseAttributeP- it would just have led to a lot of confusing IsDefault = FALSE key-values showing up.)
ARCQuery.FunctionKeyVeryShortARCQueryClassReturns the -ToStringVeryShort- representation of the given type.
ARCCore.IPARCCoreClassIP = IProperty.
ARCQuery.FunctionKeyVeryShort.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCCore.IP.TryGetV Overload2ARCCoreClassMemberThe actual value of the property. Mostly relevant for single-value properties like -PValue-.
ARCQuery.FunctionKeyVeryShort.SyntaxHelpARCQueryClassMember'VeryShort()'
ARCCore.IP.IncARCCoreClassMemberIncrements given property key by 1. Sets to 1 if not found. Uses long, not integer.
ARCQuery.FunctionKeyHourMinuteARCQueryClassFormats a timespan with only the hour and minute part. Uses format hh:mm.
ARCCore.IP.DecARCCoreClassMemberDecrements given property key by 1. Sets to -1 if not found. Uses long, not integer.
ARCQuery.FunctionKeyHourMinute.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCCore.IP.LogARCCoreClassMemberThe 'final' overload of -Log- that is called by the other overloads.
ARCQuery.FunctionKeyHourMinute.SyntaxHelpARCQueryClassMember'HourMinute()'
ARCCore.IP.LogExecuteTimeARCCoreClassMemberTimes the execution of the given function and logs details about elapsed time.
ARCQuery.FunctionKeyIntARCQueryClassRounds a double value to the nearest integer (uses .NET data type Int64 (long)).
ARCCore.IP.HandleExceptionARCCoreClassMemberNote that most relevant to use for -PConcurrent-.
ARCQuery.FunctionKeyInt.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCCore.IP.TryParseDtrARCCoreClassMemberParses a PropertyStreamLine- beginning with -dtr-.
ARCQuery.FunctionKeyInt.SyntaxHelpARCQueryClassMember'Int()'
ARCCore.IP.InitializeARCCoreClassMemberNote that has a default implementation (doing nothing).
ARCQuery.FunctionKeyLengthARCQueryClassReturns length of (string) value of field, like 4 for 'John'.
ARCCore.IP.AssertIntegrityARCCoreClassMemberSee -TryAssertIntegrity-.
ARCQuery.FunctionKeyLength.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCCore.IP.TryAssertIntegrityARCCoreClassMemberAsserts the integrity of this entity.
ARCQuery.FunctionKeyLength.SyntaxHelpARCQueryClassMember'Length()'
ARCCore.IP.ToStringARCCoreClassMemberThe ToString()-implementation in the classes implementing this interface is supposed to give a short concise representation of the object for debugging and logging purposes, that is, intended for human consumption. The most 'important' implementation is probably the one in -PRich- (-ToString-) because that one is often the basis for your entity classes like 'Customer', 'Order' and so on
ARCQuery.FunctionKeyMonthARCQueryClassExtracts month component from field like '2020-12-09' becoming '12'.
ARCCore.IP.TrySetPPARCCoreClassMemberSetPP = set property of property. Sets property of entity contained within this class.
ARCQuery.FunctionKeyMonth.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCCore.IP.GetKeysEqualToValueARCCoreClassMemberReturns properties which themselves again have key and value equal to the given key and value.
ARCQuery.FunctionKeyMonth.SyntaxHelpARCQueryClassMember'Month()'
ARCCore.IP.OnTrySetPARCCoreClassMemberEvent handler to be called by -TrySetP- before it changes a property value (but AFTER it has done any validity checks, that is, after it has 'decided' to return TRUE, in other words, event handler should be called when change is guaranteed to go through, but before it actually has been done).
ARCQuery.FunctionKeyQuarterARCQueryClassExtracts quarter component from datetime field like '2020-12-09' becoming 'Q4'.
ARCCore.IP.TryGetPARCCoreClassMemberGets a single property for this object
ARCQuery.FunctionKeyQuarter.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCCore.IP.ToPropertyStreamARCCoreClassMemberTurns object into a -PropertyStream-
ARCQuery.FunctionKeyQuarter.SyntaxHelpARCQueryClassMember'Quarter()'
ARCCore.IP.ToJSONSerializeableARCCoreClassMemberPrepares the data into a format acceptable for System.Text.Json.JsonSerializer.Serialize.
ARCQuery.FunctionKeyShortARCQueryClass'Smart' way of showing time. Removes unnecessary information.
ARCCore.IP.GetValueForJSONSerializerARCCoreClassMemberPractical approach to serializing of -IP- based values to JSON.
ARCQuery.FunctionKeyShort.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCCore.IP.TrySetPARCCoreClassMemberSet property regardless of whether exists or not.
ARCQuery.FunctionKeyShort.SyntaxHelpARCQueryClassMember'Short()'
ARCCore.IP.TryGetV Overload1ARCCoreClassMemberThe actual 'unpacking' of the object.
ARCQuery.FunctionKeyTMBARCQueryClassTMB = Thousands, Millions, Billions.
ARCCore.IP.DeepCopyARCCoreClassMemberCreates a deep copy of this object instance, that is, a copy with all new object instances (except for immutable objects).
ARCQuery.FunctionKeyTMB.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCCore.IP.AddPV Overload2ARCCoreClassMemberNOTE: The different AddPV / AddP overloads should only be used if you want an assertion against the
ARCQuery.FunctionKeyTMB.SyntaxHelpARCQueryClassMember'TMB()'
ARCCore.IP.AddPV Overload1ARCCoreClassMemberAdds a property value (as a -PValue-) for this objectThrows -KeyAlreadyExistsException- when relevant.
ARCQuery.FunctionKeyTotalHoursARCQueryClassConverts a timespan to total hours (as an integer).
ARCCore.IP.AddPARCCoreClassMemberAdds a property for this object.
ARCQuery.FunctionKeyTotalHours.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCCore.IP.AddOrUpdatePARCCoreClassMemberDuplicates functionality of SetP.
ARCQuery.FunctionKeyTotalHours.SyntaxHelpARCQueryClassMember'TotalHours()'
ARCCore.IP.GetOrAddPVARCCoreClassMemberGets value. If not set then value will be added
ARCQuery.FunctionKeyTotalMinutesARCQueryClassConverts a timespan to total minutes (as an integer).
ARCCore.IP.GetPVARCCoreClassMemberGets a single property's value for this object. Returns default value if not successful.
ARCQuery.FunctionKeyTotalMinutes.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCCore.IP.TryGetPVARCCoreClassMemberGets a single property's value for the given property key.
ARCQuery.FunctionKeyTotalMinutes.SyntaxHelpARCQueryClassMember'TotalMinutes()'
ARCCore.IP.IsValidARCCoreClassMemberNote that by default all properties are 'valid' but because of -NoRealDeletion-, we must have a mechanism for invalidating properties. This property returns FALSE if property has been invalidated and timestamp for invalidation is not '0001-01-01'.
ARCQuery.FunctionKeyTypeARCQueryClassReturns the type of a property.
ARCCore.IP.ItemARCCoreClassMemberOffers string-based direct indexing.
ARCQuery.FunctionKeyType.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCCore.IP.KeysARCCoreClassMemberReturns all the keys for this instance.
ARCQuery.FunctionKeyType.SyntaxHelpARCQueryClassMember'Type()'
ARCCore.IP.ValuesARCCoreClassMemberReturns all the values (all the properties) for this instance.
ARCQuery.FunctionKeyWeekARCQueryClassExtract week-number from field according to ISO 8601.
ARCCore.IP.LoggerARCCoreClassMemberDescribes a logger.
ARCQuery.FunctionKeyWeek.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCCore.IP.AllIPDerivedTypesARCCoreClassMemberAll relevant -IP--derived types for the whole application.
ARCQuery.FunctionKeyWeek.SyntaxHelpARCQueryClassMember'Week()'
ARCCore.IP.AllIPDerivedTypesWithPKEnumARCCoreClassMemberAll relevant -IP--derived types for the whole application for which the also is defined a -PropertyKeyEnum-.
ARCQuery.FunctionKeyYearARCQueryClassExtracts Year-component from field.
ARCCore.IP.AllIPDerivedTypesWithPKEnumApplicationSpecificARCCoreClassMemberAll relevant -IP--derived types for the -ApplicationSpecificCode- part of the application for which also is defined a -PropertyKeyEnum-.
ARCQuery.FunctionKeyYear.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCCore.IP.AllIPDerivedEntityCollectionClassesDictARCCoreClassMemberAll -IP--derived types for which is found a corresponding class with name like '{EntityType}Collection'
ARCQuery.FunctionKeyYear.SyntaxHelpARCQueryClassMember'Year()'
ARCCore.IP.AllIPDerivedTypesInludingGenericAndAbstractARCCoreClassMemberAll relevant -IP--derived types (except the interface -IP- itself) known to the application.
ARCQuery.FunctionKeyYearMonthARCQueryClassExtracts Year + Month component from field like 2020-06.
ARCCore.IP.AllIPDerivedTypesDictARCCoreClassMemberProvides lookup of a type in -AllIPDerivedTypes- given its string representation.
ARCQuery.FunctionKeyYearMonth.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCCore.IP.AllIPDerivedTypesDictIKTypeARCCoreClassMemberSame as -AllIPDerivedTypesDict- except that value is -IKType-, not string.
ARCQuery.FunctionKeyYearMonth.SyntaxHelpARCQueryClassMember'YearMonth()'
ARCCore.PARCCoreClass'Dummy'-class, not necessarily in use. See -PP- for more information. Created because of the concept of CorrespondingClass which is strictly enforced
ARCQuery.FunctionKeyYearQuarterARCQueryClassExtracts Year + Quarter component from field like 2020Q1.
ARCCore.P.TryGetPARCCoreClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCQuery.FunctionKeyYearQuarter.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCCore.P.TryGetVARCCoreClassMemberNote that 'normally' this method would be irrelevant for a -PRich- object because we will usually be an entity object (like 'Customer') not having an intrinsic value ourselves per se (because we will instead be containing a list of values).
ARCQuery.FunctionKeyYearQuarter.SyntaxHelpARCQueryClassMember'YearQuarter()'
ARCCore.P.ToStringARCCoreClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCQuery.FunctionKeyYearWeekARCQueryClassExtract year and week number from field according to ISO 8601 like '2021-51'
ARCCore.ICreatedARCCoreClassA dummy interface signifying that implementing class has the ability to store (in-memory) metadata -Created-
ARCQuery.FunctionKeyYearWeek.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCCore.PCollectionARCCoreClassA class useful for storing a collection of entities (a table in RDBMS-terms) because it implements -Indexing-.
ARCQuery.FunctionKeyYearWeek.SyntaxHelpARCQueryClassMember'YearWeek()'
ARCCore.PCollection.TrySetPPARCCoreClassMemberReplaces default interface method -TrySetPP-.
ARCQuery.NewKeyARCQueryClassA function creating new keys (new fields) that can be used against all object types in AgoRapide (against all entities).
ARCCore.PCollection.GetKeysEqualToValueARCCoreClassMemberReturns properties which themselves again have key and value equal to the given key and value.
ARCQuery.NewKey.AddParserARCQueryClassMemberAdds an -ApplicationSpecificCode- parser.
ARCCore.PCollection.TryGetPARCCoreClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCQuery.NewKey.TryParseARCQueryClassMemberFind parsers from -Parsers- based on first word in query.
ARCCore.PCollection.TryGetVARCCoreClassMemberNote that 'normally' this method would be irrelevant for a -PRich- object because we will usually be an entity object (like 'Customer') not having an intrinsic value ourselves per se (because we will instead be containing a list of values).

Generated 2025-12-04 14:48:16.379 UTC