Sandcastle Help File Builder Documentation
Syntax
This is used to write a string followed by an optional line break if needed (the writer position is
past the maximum position afterwards).
Definition
Namespace: Sandcastle.Core.BuildAssembler.SyntaxGenerator
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2024.9.12.0
True if a new line was written, false if not
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2024.9.12.0
C#
public static bool WriteWithLineBreakIfNeeded(
SyntaxWriter writer,
string text,
string indent
)VB
Public Shared Function WriteWithLineBreakIfNeeded (
writer As SyntaxWriter,
text As String,
indent As String
) As BooleanC++
public:
static bool WriteWithLineBreakIfNeeded(
SyntaxWriter^ writer,
String^ text,
String^ indent
)F#
static member WriteWithLineBreakIfNeeded :
writer : SyntaxWriter *
text : string *
indent : string -> bool Parameters
- writer SyntaxWriter
- The syntax writer to use
- text String
- An optional text string to write before the new line
- indent String
- An optional indent to write after the line break
Return Value
BooleanTrue if a new line was written, false if not