C# Class SIL.FieldWorks.FDO.DomainImpl.RnGenericRec

Mostra file Open project: sillsdev/FieldWorks Class Usage Examples

Private Properties

Property Type Description
CheckNotNull void
DateModifiedSideEffects void
FormatNumberOfParent ITsString
NoteSubrecordOfChanges void
RegisterAllSubrecordIndexTSSChanged void
SetDefaultValuesInConstruction void
SubrecordIndexTSS ITsString
TitleSideEffects void
ValidateConclusionsOA void
ValidateDescriptionOA void
ValidateDiscussionOA void
ValidateExternalMaterialsOA void
ValidateFurtherQuestionsOA void
ValidateHypothesisOA void
ValidatePersonalNotesOA void
ValidateResearchPlanOA void
ValidateVersionHistoryOA void

Public Methods

Method Description
MakeDefaultRoledParticipant ( ) : IRnRoledPartic

Make a default RoledParticipant. This is where we put participants unless the user chooses to divide them into roles. Many users just list participants and are not aware of the intervening RoledParticipant object.

ReferenceTargetOwner ( int flid ) : ICmObject

Gets the object which, for the indicated property of the recipient, the user is most likely to want to edit if the ReferenceTargetCandidates do not include the target he wants. The canonical example, supported by the default implementation of ReferenceTargetCandidates, is a possibility list, where the targets are the items. Subclasses which have reference properties edited by the simple list chooser should generally override either this or ReferenceTargetCandidates or both. The implementations of the two should naturally be consistent.

SubrecordOfKey ( bool sortedFromEnd ) : string

A sort key which sorts first by root record title, then by subrecord position. It achieves the sort we want for the SubrecordOf property. Note: called by reflection as a sortmethod for browse columns. Note that we don't support sorting this from the end; the parameter is currently required by the code in SortMethodFinder.CallSortMethod which invokes the sort method.

Protected Methods

Method Description
AddObjectSideEffectsInternal ( AddObjectEventArgs e ) : void
RemoveObjectSideEffectsInternal ( RemoveObjectEventArgs e ) : void

Private Methods

Method Description
CheckNotNull ( IStText newObjValue ) : void
DateModifiedSideEffects ( System.DateTime originalValue, System.DateTime newValue ) : void
FormatNumberOfParent ( string pattern ) : ITsString
NoteSubrecordOfChanges ( RnGenericRec parent, int indexOfFirstChildToNote ) : void

Register a PropChanged for the SubrecordOf property of all your subrecords (after and including the one at indexOfFirstChildToNote) and their children

RegisterAllSubrecordIndexTSSChanged ( IFdoOwningSequence subs, int flid, ITsString dummy ) : void
SetDefaultValuesInConstruction ( ) : void

Initialize the DateCreated and DateModified values in the constructor.

SubrecordIndexTSS ( ITsStrBldr bldr ) : ITsString
TitleSideEffects ( ITsString originalValue, ITsString newValue ) : void
ValidateConclusionsOA ( IStText &newObjValue ) : void
ValidateDescriptionOA ( IStText &newObjValue ) : void
ValidateDiscussionOA ( IStText &newObjValue ) : void
ValidateExternalMaterialsOA ( IStText &newObjValue ) : void
ValidateFurtherQuestionsOA ( IStText &newObjValue ) : void
ValidateHypothesisOA ( IStText &newObjValue ) : void
ValidatePersonalNotesOA ( IStText &newObjValue ) : void
ValidateResearchPlanOA ( IStText &newObjValue ) : void
ValidateVersionHistoryOA ( IStText &newObjValue ) : void

Method Details

AddObjectSideEffectsInternal() protected method

protected AddObjectSideEffectsInternal ( AddObjectEventArgs e ) : void
e SIL.FieldWorks.FDO.Infrastructure.AddObjectEventArgs
return void

MakeDefaultRoledParticipant() public method

Make a default RoledParticipant. This is where we put participants unless the user chooses to divide them into roles. Many users just list participants and are not aware of the intervening RoledParticipant object.
public MakeDefaultRoledParticipant ( ) : IRnRoledPartic
return IRnRoledPartic

ReferenceTargetOwner() public method

Gets the object which, for the indicated property of the recipient, the user is most likely to want to edit if the ReferenceTargetCandidates do not include the target he wants. The canonical example, supported by the default implementation of ReferenceTargetCandidates, is a possibility list, where the targets are the items. Subclasses which have reference properties edited by the simple list chooser should generally override either this or ReferenceTargetCandidates or both. The implementations of the two should naturally be consistent.
public ReferenceTargetOwner ( int flid ) : ICmObject
flid int
return ICmObject

RemoveObjectSideEffectsInternal() protected method

protected RemoveObjectSideEffectsInternal ( RemoveObjectEventArgs e ) : void
e SIL.FieldWorks.FDO.Infrastructure.RemoveObjectEventArgs
return void

SubrecordOfKey() public method

A sort key which sorts first by root record title, then by subrecord position. It achieves the sort we want for the SubrecordOf property. Note: called by reflection as a sortmethod for browse columns. Note that we don't support sorting this from the end; the parameter is currently required by the code in SortMethodFinder.CallSortMethod which invokes the sort method.
public SubrecordOfKey ( bool sortedFromEnd ) : string
sortedFromEnd bool
return string