IBackupRestoreTreeFormatter.PreChildren Method
Formats a string that will mark the beginning of a list of child nodes.
Namespace: Microsoft.SharePoint.Administration.Backup
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Syntax
'Declaration
Function PreChildren ( _
obj As SPBackupRestoreObject, _
depth As Integer _
) As String
'Usage
Dim instance As IBackupRestoreTreeFormatter
Dim obj As SPBackupRestoreObject
Dim depth As Integer
Dim returnValue As String
returnValue = instance.PreChildren(obj, _
depth)
string PreChildren(
SPBackupRestoreObject obj,
int depth
)
Parameters
obj
Type: Microsoft.SharePoint.Administration.Backup.SPBackupRestoreObjectThe component for the current node.
depth
Type: System.Int32The depth in the tree of the current node.
Return Value
Type: System.String
A String that represents the beginning of a list of peer nodes that are each immediate children of obj.
Remarks
Typically, an implementation of PreChildren just returns an empty String. Every child is also and object an so the PreObject method will be adding annotations that apply to every object.
If your implementation does return a non-empty String, consider using depth as the measure of how far to indent the String.
Examples
The following code shows a typical implementation of PreChildren.
public String PreChildren(SPBackupRestoreObject obj, int depth)
{
return String.Empty;
}
Public Function PreChildren(ByVal obj As SPBackupRestoreObject, ByVal depth As Integer) As String
Return String.Empty
End Function
See Also
Reference
IBackupRestoreTreeFormatter Interface