Clean up

Change-Id: Ia5fb27d9058f83e3ab1fcfa35ba7158e47bb8a88

Author: papeh

Src/Common/Controls/XMLViews/XMLViewsTests/XmlBrowseViewBaseVcTests.cs

@@ -178,7 +178,7 @@ public void GetHeaderLabels_ReturnsColumnSpecLabels()
 			CollectionAssert.AreEqual(new List<string> { "Ref", "Occurrence" }, columnLabels);
 		}
 
-		[Test]
+		/// <remarks>TODO (Hasso) 2025.11: This test needs further setup to find the layout XmlNode in the LayoutCache</remarks>
 		public void IsValidColumnSpec_HasLayout_TODO()
 		{
 			var vc = new XmlBrowseViewBaseVc { PossibleColumnSpecs = new List<XmlNode>(), ListItemsClass = -1 /* can't be 0 */ };
@@ -207,8 +207,13 @@ public void IsValidColumnSpec_HasLayout_TODO()
 			}
 		}
 
+		/// <summary>
+		/// Tests that IsValidColumnSpec can identify valid columns based on their labels or originalLabels.
+		/// Artificially skips the layout check because that requires a more complex setup.
+		/// LT-22265: Invalid columns should not be displayed.
+		/// </summary>
 		[Test]
-		public void IsValidColumnSpec_ValidReturnsTrue()
+		public void IsValidColumnSpec_MatchesLabels()
 		{
 			var vc = new XmlBrowseViewBaseVc { PossibleColumnSpecs = new List<XmlNode>(), ListItemsClass = -1 /* can't be 0 */ };
 			var possibleColumns = new XmlDocument();
@@ -218,30 +223,18 @@ public void IsValidColumnSpec_ValidReturnsTrue()
 				vc.PossibleColumnSpecs.Add(node);
 			}
 
-			var savedColumns = new XmlDocument();
-			savedColumns.LoadXml("<root><column label='Ref'/><column label='Other (Best Ana)' originalLabel='Other'/></root>");
+			var validColumns = new XmlDocument();
+			validColumns.LoadXml("<root><column label='Ref'/><column label='Other (Best Ana)' originalLabel='Other'/></root>");
 
 			// SUT
-			foreach (XmlNode node in savedColumns.DocumentElement.GetElementsByTagName("column"))
+			foreach (XmlNode node in validColumns.DocumentElement.GetElementsByTagName("column"))
 			{
 				Assert.IsTrue(vc.IsValidColumnSpec(node), $"Should have found this node to be valid: {node.OuterXml}");
 			}
-		}
-
-		[Test]
-		public void IsValidColumnSpec_InvalidReturnsFalse()
-		{
-			var vc = new XmlBrowseViewBaseVc { PossibleColumnSpecs = new List<XmlNode>(), ListItemsClass = -1 /* can't be 0 */ };
-			var possibleColumns = new XmlDocument();
-			possibleColumns.LoadXml("<columns><column label='Ref'/><column label='Other'/></columns>");
-			foreach (XmlNode node in possibleColumns.DocumentElement.GetElementsByTagName("column"))
-			{
-				vc.PossibleColumnSpecs.Add(node);
-			}
 
-			var savedColumns = new XmlDocument();
-			savedColumns.LoadXml("<root><column label='DoesNotExist' originalLabel='MayHaveExistedBefore'/></root>");
-			var invalidColumn = savedColumns.DocumentElement.SelectSingleNode("column");
+			var invalidColumns = new XmlDocument();
+			invalidColumns.LoadXml("<root><column label='DoesNotExist' originalLabel='MayHaveExistedBefore'/></root>");
+			var invalidColumn = invalidColumns.DocumentElement.SelectSingleNode("column");
 
 			// SUT
 			Assert.IsFalse(vc.IsValidColumnSpec(invalidColumn), $"Should have found this node to be invalid: {invalidColumn.OuterXml}");

Src/Common/Controls/XMLViews/XmlBrowseViewBaseVc.cs

@@ -224,7 +224,6 @@ public XmlBrowseViewBaseVc(XmlNode xnSpec, int fakeFlid, XmlBrowseViewBase xbv)
 				var newPossibleColumns = new List<XmlNode>(PossibleColumnSpecs);
 				foreach (XmlNode node in doc.DocumentElement.SelectNodes("//column"))
 				{
-
 					// if there is a corresponding possible column, remove it from the newPossibleColumns list.
 					var possible = newPossibleColumns.Find(n =>
 						XmlUtils.GetOptionalAttributeValue(n, "label", "") ==
@@ -586,20 +585,21 @@ internal int ListItemsClass
 		}
 
 		/// <summary>
-		/// check to see if column spec is still valid.
+		/// Check to see if column spec is still valid. If it is a custom field, update the label if necessary.
 		/// </summary>
-		/// <returns>True if we can't prove the column is invalid</returns>
 		internal bool IsValidColumnSpec(XmlNode colSpec)
 		{
 			if (GetPartFromParentNode(colSpec, ListItemsClass) == null)
-				return false;   // invalid node, don't add.
-			// If it is a Custom Field, check that it is valid and has the correct label
+			{
+				return false;
+			}
+			// If it is a Custom Field, check that it is valid and has the correct label.
 			if (IsCustomField(colSpec, out var isValid))
 			{
 				return isValid;
 			}
 			// In the simple case, `node`s label should match a label in PossibleColumnSpecs. There may be more complicated cases.
-			// TODO (Hasso) 2025.11: 'layout' (madatory?) and 'field' (optional) would be better attributes to match.
+			// ENHANCE (Hasso) 2025.11: 'layout' (mandatory?) and 'field' (optional) would be better attributes to match, but that would require more test setup.
 			var label = XmlUtils.GetLocalizedAttributeValue(colSpec, "label", null) ??
 						XmlUtils.GetMandatoryAttributeValue(colSpec, "label");
 			var originalLabel = XmlUtils.GetLocalizedAttributeValue(colSpec, "originalLabel", null) ??